Update example project for 1.18.0

riokritchie · CommonGuy · commit 439e7193c4ec · 2025-09-26T10:43:47.000+02:00
diff --git a/example-project/Kreya features/Auth/SayHello with Auth-request.json b/example-project/Kreya features/Auth/SayHello with Auth-request.json
@@ -1,7 +1,7 @@
 {
-  // A configured authentication can be selected in the "Auth" tab. 
+  // A configured authentication can be selected in the "Auth" tab.
   // It is also accessible via templating.
   // Send the operation and take a look at the "Trace" tab to see the sent authentication value.
   // Change the active environment and send the operation again to see the updated value.
   "name": "{{ auth.configs.myauth.name }}"
-}
+}
diff --git a/example-project/Kreya features/Script/Advanced script.js b/example-project/Kreya features/Script/Advanced script.js
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 
 kreya.variables.delete('messages');
 
-// Invoke operations and access variable set by them
+// Invoke operations and access variables set by them
 await kreya.invokeOperation('../Scripting/Advanced scripting example');
 kreya.test('messages should be set', () => {
   const messages = kreya.variables.get('messages');
@@ -12,9 +12,9 @@ kreya.test('messages should be set', () => {
 // Invoke operations multiple times
 for (let i = 0; i < 3; i++) {
   const result = await kreya.invokeOperation('../../REST/Get book');
-  
+
   if (!result.success) {
     // Stop the loop if an error occurs
     break;
   }
-}
+}
diff --git a/example-project/Kreya features/Script/Simple script.js b/example-project/Kreya features/Script/Simple script.js
@@ -3,4 +3,4 @@ await kreya.invokeOperation('../../REST/Delete book');
 
 await kreya.invokeOperation('../../gRPC/Say hello (unary call)');
 
-await kreya.invokeOperation('../../WebSocket/Echo');
+await kreya.invokeOperation('../../WebSocket/Echo');
diff --git a/example-project/Kreya features/Scripting/Advanced scripting example-request-0.json b/example-project/Kreya features/Scripting/Advanced scripting example-request-0.json
@@ -1,3 +1,3 @@
 {
   "message": "{{ vars.messages ? vars.messages[0] : 'no messages set' }}"
-}
+}
diff --git a/example-project/Kreya features/Scripting/Advanced scripting example-request-1.json b/example-project/Kreya features/Scripting/Advanced scripting example-request-1.json
@@ -1,3 +1,3 @@
 {
   "message": "{{ vars.messages ? vars.messages[1] : 'no messages set' }}"
-}
+}
diff --git a/example-project/Kreya features/Scripting/Advanced scripting example-request-2.json b/example-project/Kreya features/Scripting/Advanced scripting example-request-2.json
@@ -1,3 +1,3 @@
 {
   "message": "{{ vars.messages ? vars.messages[2] : 'no messages set' }}"
-}
+}
diff --git a/example-project/Kreya features/Scripting/Advanced scripting example.js b/example-project/Kreya features/Scripting/Advanced scripting example.js
@@ -6,13 +6,13 @@ const messages = ['first message', 'second message', 'third message'];
 // store the messages as a "user variable", which is persisted
 kreya.variables.set('messages', messages);
 
-kreyaGrpc.onResponse(msg => {
+kreya.grpc.onResponse(msg => {
   kreya.test('Should equal the sent message', () => expect(msg.content.message).to.eql(messages[msg.index]));
 });
 
-kreyaGrpc.onCallCompleted(call => {
+kreya.grpc.onCallCompleted(call => {
   kreya.test('Status should be ok', () => expect(call.status.code).to.equal(0));
 
   kreya.trace(`Got ${call.responseCount} responses`);
   kreya.test('Response count should match sent messages', () => expect(call.responseCount).to.eql(messages.length));
-});
+});
diff --git a/example-project/Kreya features/Scripting/File system access.js b/example-project/Kreya features/Scripting/File system access.js
@@ -3,8 +3,8 @@ import { expect } from 'chai';
 
 const expectedResponse = await readFile('book-1-expected-response.json', 'utf8');
 
-kreyaRest.onCallCompleted(call => {
+kreya.rest.onCallCompleted(call => {
   kreya.test('Response should match snapshot', () => {
     expect(call.response.rawContentText).to.eql(expectedResponse);
   });
-});
+});
diff --git a/example-project/Kreya features/Scripting/Preview/Scripting Preview HTML Chart.js b/example-project/Kreya features/Scripting/Preview/Scripting Preview HTML Chart.js
@@ -0,0 +1,34 @@
+kreya.rest.onCallCompleted(async ctx => {
+  const dates = ctx.response.content.days.map(d => d.date);
+  const quantities = ctx.response.content.days.map(d => d.quantity);
+  await kreya.preview.html(
+    `
+    <html>
+      <body>
+        <div id="chart" style="width: 100%; height: 100%;"></div>
+        <script src="https://cdn.jsdelivr.net/npm/echarts@5.6.0/dist/echarts.min.js"></script>
+        <script>
+          const chart = echarts.init(document.getElementById('chart'));
+          chart.setOption({
+              title: {
+                text: 'Sales of "${ctx.response.content.book.name}"'
+              },
+              animation: false,
+              xAxis: {
+                data: ${JSON.stringify(dates)}
+              },
+              yAxis: {},
+              series: [{
+                type: 'bar',
+                data: ${JSON.stringify(quantities)}
+              }]
+          });
+
+          window.addEventListener('resize', () => chart.resize());
+        </script>
+      </body>
+    </html>
+    `,
+    'Sales',
+  );
+});
diff --git a/example-project/Kreya features/Scripting/Preview/Scripting Preview HTML Chart.krop b/example-project/Kreya features/Scripting/Preview/Scripting Preview HTML Chart.krop
@@ -0,0 +1,23 @@
+{
+  "details": {
+    "path": "/v1/books/{id}/sales",
+    "method": "GET",
+    "pathParams": [
+      {
+        "key": "id",
+        "value": "1"
+      }
+    ]
+  },
+  "script": {
+    "src": "Scripting Preview HTML Chart.js"
+  },
+  "requests": [
+    {
+      "contentType": "none"
+    }
+  ],
+  "operationType": "unary",
+  "invokerName": "rest",
+  "typeHint": "GET"
+}
diff --git a/example-project/Kreya features/Scripting/Scripting REST.js b/example-project/Kreya features/Scripting/Scripting REST.js
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 
-kreyaRest.onCallCompleted(call => {
+kreya.rest.onCallCompleted(call => {
   kreya.trace('The REST call completed.');
 
   kreya.test('Status code', () => expect(call.status.code).to.equal(200));
@@ -10,4 +10,4 @@ kreyaRest.onCallCompleted(call => {
 
   const books = call.response.content;
   kreya.test('First book should have ID 1', () => expect(books[0].id).to.eq(1));
-});
+});
diff --git a/example-project/Kreya features/Scripting/Scripting WebSocket.js b/example-project/Kreya features/Scripting/Scripting WebSocket.js
@@ -2,13 +2,13 @@ import { expect } from 'chai';
 
 let responseCount = 0;
 
-kreyaWebSocket.onResponseMessage(response => {
+kreya.webSocket.onResponseMessage(response => {
   responseCount++;
   kreya.test('Response content', () => expect(response.content).to.contain(`Message ${responseCount}`));
 });
 
-kreyaWebSocket.onCallCompleted(call => {
+kreya.webSocket.onCallCompleted(call => {
   kreya.trace('The WebSocket call completed.');
 
   kreya.test('Status code', () => expect(call.status.code).to.equal(1000));
-});
+});
diff --git a/example-project/Kreya features/Scripting/Scripting gRPC-request.json b/example-project/Kreya features/Scripting/Scripting gRPC-request.json
@@ -1,3 +1,3 @@
 {
   "name": "fooBar"
-}
+}
diff --git a/example-project/Kreya features/Scripting/Scripting gRPC.js b/example-project/Kreya features/Scripting/Scripting gRPC.js
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 
-kreyaGrpc.onResponse(msg => {
+kreya.grpc.onResponse(msg => {
   kreya.test('Size should be ok', () => expect(msg.size).to.be.gt(10));
   kreya.test('Message should start with Hello', () => expect(msg.content.message.startsWith('Hello')).to.be.true);
-});
+});
diff --git a/example-project/Kreya features/Snapshots/Matched snapshot-request.json b/example-project/Kreya features/Snapshots/Matched snapshot-request.json
@@ -0,0 +1,3 @@
+{
+  "name": "doe"
+}
diff --git a/example-project/Kreya features/Snapshots/Matched snapshot.krop b/example-project/Kreya features/Snapshots/Matched snapshot.krop
@@ -0,0 +1,19 @@
+{
+  "details": {
+    "methodFqn": "kreya.ExampleService.SayHello",
+    "snapshots": {
+      "responses": true
+    }
+  },
+  "requests": [
+    {
+      "location": "Matched snapshot-request.json"
+    }
+  ],
+  "operationType": "unary",
+  "invokerName": "grpc",
+  "importStreamId": "463869a1-4cf8-470d-871d-c873192881c7",
+  "snapshots": {
+    "response": "Matched snapshot.response.snapshot.json"
+  }
+}
diff --git a/example-project/Kreya features/Snapshots/Matched snapshot.response.snapshot.json b/example-project/Kreya features/Snapshots/Matched snapshot.response.snapshot.json
@@ -0,0 +1,3 @@
+{
+  "message": "Hello doe"
+}
diff --git a/example-project/Kreya features/Snapshots/Mismatched snapshot-request.json b/example-project/Kreya features/Snapshots/Mismatched snapshot-request.json
@@ -0,0 +1,3 @@
+{
+  "name": "joe"
+}
diff --git a/example-project/Kreya features/Snapshots/Mismatched snapshot.krop b/example-project/Kreya features/Snapshots/Mismatched snapshot.krop
@@ -0,0 +1,19 @@
+{
+  "details": {
+    "methodFqn": "kreya.ExampleService.SayHello",
+    "snapshots": {
+      "responses": true
+    }
+  },
+  "requests": [
+    {
+      "location": "Mismatched snapshot-request.json"
+    }
+  ],
+  "operationType": "unary",
+  "invokerName": "grpc",
+  "importStreamId": "463869a1-4cf8-470d-871d-c873192881c7",
+  "snapshots": {
+    "response": "Mismatched snapshot.response.snapshot.json"
+  }
+}
diff --git a/example-project/Kreya features/Snapshots/Mismatched snapshot.response.snapshot.json b/example-project/Kreya features/Snapshots/Mismatched snapshot.response.snapshot.json
@@ -0,0 +1,3 @@
+{
+  "message": "Hello doe"
+}
diff --git a/example-project/Kreya features/Timing/Timing gRPC-request.json b/example-project/Kreya features/Timing/Timing gRPC-request.json
@@ -1,3 +1,3 @@
 {
   "name": "{{ faker.name.last_name }}"
-}
+}
diff --git a/example-project/Kreya features/UseCases/DeleteAll/Delete all.js b/example-project/Kreya features/UseCases/DeleteAll/Delete all.js
@@ -0,0 +1,7 @@
+await kreya.invokeOperation('./List books');
+
+const ids = kreya.variables.get('bookIds');
+for (var i = 0; i < ids.length; i++) {
+  kreya.variables.set('bookId', ids[i]);
+  await kreya.invokeOperation('./Delete book');
+}
diff --git a/example-project/Kreya features/UseCases/DeleteAll/Delete all.krjs b/example-project/Kreya features/UseCases/DeleteAll/Delete all.krjs
@@ -0,0 +1,3 @@
+{
+  "src": "Delete all.js"
+}
diff --git a/example-project/Kreya features/UseCases/DeleteAll/Delete book.krop b/example-project/Kreya features/UseCases/DeleteAll/Delete book.krop
@@ -0,0 +1,19 @@
+{
+  "details": {
+    "path": "/v1/books/{{ vars.bookId }}",
+    "method": "DELETE",
+    "importedOperationId": "DELETE /v1/books/{id}",
+    "headers": [],
+    "pathParams": [],
+    "inheritedHeadersIgnored": true
+  },
+  "requests": [
+    {
+      "contentType": "none"
+    }
+  ],
+  "operationType": "unary",
+  "invokerName": "rest",
+  "typeHint": "DELETE",
+  "importStreamId": "3173a966-56b1-435f-9a60-937058ec6c80"
+}
diff --git a/example-project/Kreya features/UseCases/DeleteAll/List books.js b/example-project/Kreya features/UseCases/DeleteAll/List books.js
@@ -0,0 +1,9 @@
+kreya.rest.onCallCompleted(ctx => {
+  if (!ctx.status.isSuccess || ctx.response.content.length == 0) {
+    kreya.variables.delete('bookIds');
+    return;
+  }
+
+  const bookIds = ctx.response.content.map(x => x.id);
+  kreya.variables.set('bookIds', bookIds);
+});
diff --git a/example-project/Kreya features/UseCases/DeleteAll/List books.krop b/example-project/Kreya features/UseCases/DeleteAll/List books.krop
@@ -0,0 +1,20 @@
+{
+  "details": {
+    "path": "/v1/books",
+    "method": "GET",
+    "importedOperationId": "GET /v1/books",
+    "pathParams": []
+  },
+  "requests": [
+    {
+      "contentType": "none"
+    }
+  ],
+  "operationType": "unary",
+  "invokerName": "rest",
+  "typeHint": "GET",
+  "importStreamId": "3173a966-56b1-435f-9a60-937058ec6c80",
+  "script": {
+    "src": "List books.js"
+  }
+}
diff --git a/example-project/REST/Create book-request.json b/example-project/REST/Create book-request.json
@@ -1,3 +1,3 @@
 {
   "name": "{{ faker.commerce.product_name }}"
-}
+}
diff --git a/example-project/REST/Update book-request.json b/example-project/REST/Update book-request.json
@@ -1,3 +1,3 @@
 {
   "name": "{{ faker.commerce.product_name }}"
-}
+}
diff --git a/example-project/example-project.krproj b/example-project/example-project.krproj
@@ -7,7 +7,9 @@
       "importerName": "GrpcServerReflection",
       "createMissingOperations": false,
       "options": {
-        "endpoint": "https://example-api.kreya.app:9090"
+        "endpoint": "{{ env.grpc_endpoint }}",
+        "disableServerCertificateValidation": false,
+        "disableCookies": false
       }
     },
     {
@@ -16,7 +18,11 @@
       "importerName": "OpenApiUrlImporter",
       "createMissingOperations": false,
       "options": {
-        "url": "https://example-api.kreya.app/swagger/v1/swagger.json"
+        "url": "{{ env.rest_endpoint }}/swagger/v1/swagger.json",
+        "disableAutoRedirect": false,
+        "disableServerCertificateValidation": false,
+        "disableCookies": false,
+        "infiniteTimeout": false
       }
     }
   ],
@@ -28,8 +34,12 @@
       "options": {
         "username": "my-user-name",
         "password": "{{ env.basic_auth_password }}"
+      },
+      "advancedOptions": {
+        "key": "Authorization",
+        "addToType": "header",
+        "headerPrefix": "Basic "
       }
     }
-  ],
-  "certificates": []
-}
+  ]
+}
diff --git a/example-project/gRPC/Echo (duplex streaming)-request-0.json b/example-project/gRPC/Echo (duplex streaming)-request-0.json
@@ -1,3 +1,3 @@
 {
   "message": "Message 1"
-}
+}
diff --git a/example-project/gRPC/Echo (duplex streaming)-request-1.json b/example-project/gRPC/Echo (duplex streaming)-request-1.json
@@ -1,3 +1,3 @@
 {
   "message": "Message 2"
-}
+}
diff --git a/example-project/gRPC/Echo (duplex streaming)-request-2.json b/example-project/gRPC/Echo (duplex streaming)-request-2.json
@@ -1,3 +1,3 @@
 {
   "message": "Message 3"
-}
+}
diff --git a/example-project/gRPC/Say hello (unary call)-request.json b/example-project/gRPC/Say hello (unary call)-request.json
diff --git a/example-project/gRPC/Split (server streaming)-request.json b/example-project/gRPC/Split (server streaming)-request.json
diff --git a/example-project/gRPC/Sum (client streaming)-request-0.json b/example-project/gRPC/Sum (client streaming)-request-0.json
diff --git a/example-project/gRPC/Sum (client streaming)-request-1.json b/example-project/gRPC/Sum (client streaming)-request-1.json
diff --git a/example-project/gRPC/Sum (client streaming)-request-2.json b/example-project/gRPC/Sum (client streaming)-request-2.json

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ await kreya.invokeOperation('../../REST/Delete book');`
`3`	`3`
`4`	`4`	`await kreya.invokeOperation('../../gRPC/Say hello (unary call)');`
`5`	`5`
`6`		`-await kreya.invokeOperation('../../WebSocket/Echo');`
	`6`	`+await kreya.invokeOperation('../../WebSocket/Echo');`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`	`2`	`"message": "{{ vars.messages ? vars.messages[0] : 'no messages set' }}"`
`3`		`-}`
	`3`	`+}`