@appsemble/utils 0.20.44 → 0.21.0

package/iterApp.test.js

@@ -1,8 +1,8 @@
 import { iterAction, iterApp, iterBlock, iterBlockList, iterPage } from './iterApp.js';
 describe('iterAction', () => {
     it('should call the appropriate callbacks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -13,8 +13,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should abort if the onAction callback returns true', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockReturnValue(true);
+        const onBlockList = vi.fn();
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -25,8 +25,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call onAction for onSuccess', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onSuccess: {
@@ -40,10 +40,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return true if onAction returns true for onSuccess', () => {
-        const onAction = import.meta.jest
-            .fn()
-            .mockImplementation((a, [prefix]) => prefix === 'onSuccess');
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockImplementation((a, [prefix]) => prefix === 'onSuccess');
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onSuccess: {
@@ -57,8 +55,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call onAction for onError', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onError: {
@@ -72,10 +70,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return true if onAction returns true for onError', () => {
-        const onAction = import.meta.jest
-            .fn()
-            .mockImplementation((a, [prefix]) => prefix === 'onError');
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn().mockImplementation((a, [prefix]) => prefix === 'onError');
+        const onBlockList = vi.fn();
         const action = {
             type: 'noop',
             onError: {
@@ -89,7 +85,7 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should call then and else for conditional actions', () => {
-        const onAction = import.meta.jest.fn();
+        const onAction = vi.fn();
         const action = {
             type: 'condition',
             if: true,
@@ -103,8 +99,8 @@ describe('iterAction', () => {
         expect(result).toBe(false);
     });
     it('should return the return value of iterBlockList', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn();
+        const onBlockList = vi.fn().mockReturnValue(true);
         const action = {
             type: 'dialog',
             blocks: [{ type: 'list', version: '0.1.2' }],
@@ -118,8 +114,8 @@ describe('iterAction', () => {
         expect(result).toBe(true);
     });
     it('should not call iterBlockList if the action has no blocks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlockList = vi.fn();
         const action = {
             type: 'log',
         };
@@ -134,8 +130,8 @@ describe('iterAction', () => {
 });
 describe('iterBlock', () => {
     it('should call the appropriate callbacks', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlock = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onBlock = vi.fn();
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -151,8 +147,8 @@ describe('iterBlock', () => {
         expect(result).toBe(false);
     });
     it('should abort if onBlock returns true', () => {
-        const onAction = import.meta.jest.fn();
-        const onBlock = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn();
+        const onBlock = vi.fn().mockReturnValue(true);
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -168,8 +164,8 @@ describe('iterBlock', () => {
         expect(result).toBe(true);
     });
     it('should return the return value of onAction', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
-        const onBlock = import.meta.jest.fn();
+        const onAction = vi.fn().mockReturnValue(true);
+        const onBlock = vi.fn();
         const block = {
             type: 'list',
             version: '1.2.3',
@@ -187,8 +183,8 @@ describe('iterBlock', () => {
 });
 describe('iterBlockList', () => {
     it('should call the appropriate callbacks', () => {
-        const onBlock = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onBlock = vi.fn();
+        const onBlockList = vi.fn();
         const blocks = [
             {
                 type: 'list',
@@ -206,8 +202,8 @@ describe('iterBlockList', () => {
         expect(result).toBe(false);
     });
     it('should abort if onBlockList returns true', () => {
-        const onBlock = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn().mockReturnValue(true);
+        const onBlock = vi.fn();
+        const onBlockList = vi.fn().mockReturnValue(true);
         const blocks = [
             {
                 type: 'list',
@@ -227,8 +223,8 @@ describe('iterBlockList', () => {
 });
 describe('iterPage', () => {
     it('should iterate over a page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             blocks: [],
@@ -239,8 +235,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should abort if onPage returns true', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn().mockReturnValue(true);
+        const onBlockList = vi.fn();
+        const onPage = vi.fn().mockReturnValue(true);
         const page = {
             name: 'Page',
             blocks: [],
@@ -251,8 +247,8 @@ describe('iterPage', () => {
         expect(result).toBe(true);
     });
     it('should iterate a flow page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -269,8 +265,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should iterate a tabs page', () => {
-        const onBlockList = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'tabs',
@@ -287,8 +283,8 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should call onAction for page actions', () => {
-        const onAction = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onPage = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -305,9 +301,9 @@ describe('iterPage', () => {
         expect(result).toBe(false);
     });
     it('should call onAction and onBlockList for pages with actions and sub pages', () => {
-        const onAction = import.meta.jest.fn();
-        const onPage = import.meta.jest.fn();
-        const onBlockList = import.meta.jest.fn();
+        const onAction = vi.fn();
+        const onPage = vi.fn();
+        const onBlockList = vi.fn();
         const page = {
             name: 'Page',
             type: 'flow',
@@ -342,7 +338,7 @@ describe('iterPage', () => {
 });
 describe('iterApp', () => {
     it('should iterate over the page of an app', () => {
-        const onPage = import.meta.jest.fn();
+        const onPage = vi.fn();
         const app = {
             name: 'App',
             defaultPage: 'Page',
@@ -358,7 +354,7 @@ describe('iterApp', () => {
         expect(result).toBe(false);
     });
     it('should abort page iteration if a callback returns true', () => {
-        const onPage = import.meta.jest.fn().mockReturnValue(true);
+        const onPage = vi.fn().mockReturnValue(true);
         const app = {
             name: 'App',
             defaultPage: 'Page 1',
@@ -379,7 +375,7 @@ describe('iterApp', () => {
         expect(result).toBe(true);
     });
     it('should iterate over cron jobs', () => {
-        const onAction = import.meta.jest.fn();
+        const onAction = vi.fn();
         const app = {
             name: 'App',
             defaultPage: 'Page 1',
@@ -396,7 +392,7 @@ describe('iterApp', () => {
         expect(result).toBe(false);
     });
     it('should abort cron iteration if a callback returns true', () => {
-        const onAction = import.meta.jest.fn().mockReturnValue(true);
+        const onAction = vi.fn().mockReturnValue(true);
         const app = {
             name: 'App',
             defaultPage: 'Page 1',

package/jsonschema.test.js

@@ -161,7 +161,7 @@ describe('combineSchemas', () => {
 });
 describe('iterJSONSchema', () => {
     it('should handle properties', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'object',
             properties: {
@@ -174,7 +174,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.properties.foo);
     });
     it('should handle additionalProperties', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'object',
             additionalProperties: { description: 'foo' },
@@ -185,7 +185,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.additionalProperties);
     });
     it('should handle an items object', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             items: { description: 'foo' },
@@ -196,7 +196,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.items);
     });
     it('should handle an items array', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             items: [{ description: 'foo' }, { description: 'bar' }],
@@ -208,7 +208,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.items[1]);
     });
     it('should handle additionalItems', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             additionalItems: { description: 'foo' },
@@ -219,7 +219,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.additionalItems);
     });
     it('should handle anyOf', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             anyOf: [{ description: 'foo' }],
@@ -230,7 +230,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.anyOf[0]);
     });
     it('should handle oneOf', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             oneOf: [{ description: 'foo' }],
@@ -241,7 +241,7 @@ describe('iterJSONSchema', () => {
         expect(onSchema).toHaveBeenCalledWith(schema.oneOf[0]);
     });
     it('should handle allOf', () => {
-        const onSchema = import.meta.jest.fn();
+        const onSchema = vi.fn();
         const schema = {
             type: 'array',
             allOf: [{ description: 'foo' }],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.20.44",
+  "version": "0.21.0",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -28,10 +28,10 @@
   ],
   "scripts": {
     "prepack": "tsc --noEmit false",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest"
+    "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.20.44",
+    "@appsemble/types": "0.21.0",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/arrays.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const arrayRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;

package/reference-schemas/remappers/arrays.js

@@ -0,0 +1,334 @@
+export const arrayRemappers = {
+    'array.map': {
+        $ref: '#/components/schemas/RemapperDefinition',
+        description: `
+The remapper goes through the given array and applies the given remappers on each individual item.
+This can be very handy when sorting arrays by certain data. The remapper always returns an array.
+Output can be an empty array if the supplied data isn’t an array.
+
+For example, if you want to sort through a list of people and only get their occupations you can do
+the following:
+
+Input:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver"
+  },
+  {
+    "name": "Otto",
+    "occupation": "Scientist"
+  },
+  {
+    "name": "Harry",
+    "occupation": "CEO"
+  }
+]
+\`\`\`
+
+\`\`\`yaml
+array.map:
+  object.omit:
+    - name
+\`\`\`
+
+Result:
+
+\`\`\`json
+[{ "occupation": "Delivery driver" }, { "occupation": "Scientist" }, { "occupation": "CEO" }]
+\`\`\`
+
+Another great use for \`array.map\` is to combine it with the \`if\` remapper and sort your arrays on
+specific values.
+
+Using the same input data from the previous example, look at how you can change the code to get
+people from a specific occupation:
+
+\`\`\`yaml
+- array.map:
+    if:
+      condition: { equals: [{ prop: occupation }, Scientist] }
+      then:
+        object.from:
+          name:
+            prop: name
+          occupation:
+            prop: occupation
+      else: null
+- null.strip: null
+\`\`\`
+
+Result:
+
+\`\`\`json
+[
+  {
+    "name": "Otto",
+    "occupation": "Scientist"
+  }
+]
+\`\`\`
+
+Because \`array.map\` returns an array, every item has to return something. This is why we have to
+return the full object with the data we want in the \`then\` section. It’s also why we return \`null\`.
+This results in an array consisting of \`null\` values and objects with actual data in them. To solve
+this problem, we use the \`null.strip\` remapper to remove any null values which results in a clean
+array.
+`,
+    },
+    'array.unique': {
+        $ref: '#/components/schemas/RemapperDefinition',
+        description: `
+Filters out unique values from an array. The value Remapper is applied to each entry in the array
+using its result to determine uniqueness.
+
+If the value Remapper results in undefined or null, the entire entry is used for uniqueness.
+
+If the input is not an array, the input is returned without any modifications.
+
+Input:
+
+\`\`\`json
+[1, 1, 2, 3]
+\`\`\`
+
+\`\`\`yaml
+array.unique: null
+\`\`\`
+
+Result:
+
+\`\`\`json
+[1, 2, 3]
+\`\`\`
+
+You can also check for more complex values in arrays. The remapper accepts remappers as well, so you
+can also use entire objects to check for unique values.
+
+For this example, we have the following extended data with some duplicate values:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver",
+    "age": 19
+  },
+  {
+    "name": "Peter",
+    "occupation": "Photographer",
+    "age": 19
+  },
+  {
+    "name": "Otto",
+    "occupation": "Scientist",
+    "age": 50
+  },
+  {
+    "name": "Harry",
+    "occupation": "CEO",
+    "age": 20
+  }
+]
+\`\`\`
+
+We can be fairly sure in this list of people the first two Peters are the same person but with a
+different occupation. To get more complex unique values from here, we can do the following:
+
+\`\`\`yaml
+array.unique:
+  object.from:
+    name: { prop: name }
+    age: { prop: age }
+\`\`\`
+
+This then checks the array for unique values in both the \`name\` and \`age\` fields. The result of this
+remapper is a filtered list:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver",
+    "age": 19
+  },
+  {
+    "name": "Otto",
+    "occupation": "Scientist",
+    "age": 50
+  },
+  {
+    "name": "Harry",
+    "occupation": "CEO",
+    "age": 20
+  }
+]
+\`\`\`
+    `,
+    },
+    'array.from': {
+        type: 'array',
+        items: {
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        description: `
+Creates a new array based on a provided array of remappers. This array can also consist of static
+values.
+
+For example:
+
+\`\`\`yaml
+array.from:
+  - Peter
+  - Otto
+  - Harry
+\`\`\`
+
+\`\`\`json
+["Peter", "Otto", "Harry"]
+\`\`\`
+
+This remapper can also be used to convert given data into an array.
+
+Input:
+
+\`\`\`json
+{
+  "name": "Peter",
+  "occupation": "Delivery driver"
+}
+\`\`\`
+
+\`\`\`yaml
+array.from:
+  - root: null # Takes the data passed to this remapper, explained more in the 'Data' page
+\`\`\`
+
+Result:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver"
+  }
+]
+\`\`\`
+    `,
+    },
+    'array.append': {
+        type: 'array',
+        items: {
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        description: `
+Append new values to the end of an array. If the input is not an array an empty array is returned.
+
+Using the array from the previous example, we can add a new object on top of it using this remapper:
+
+\`\`\`yaml
+array.append:
+  - object.from:
+      name: James
+      occupation: News reporter
+\`\`\`
+
+Result:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver"
+  },
+  {
+    "name": "Otto",
+    "occupation": "Scientist"
+  },
+  {
+    "name": "Harry",
+    "occupation": "CEO"
+  },
+  {
+    "name": "James",
+    "occupation": "News reporter"
+  }
+]
+\`\`\`
+    `,
+    },
+    'array.omit': {
+        type: 'array',
+        items: {
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        description: `
+Remove values from an array. The input is expected to be the index(es) of the items to be deleted.
+Accepts an array of static or remapper values.
+
+With the previous example we added a new person to the list of people, so now we can remove that
+person. We already know the index of this person in the array is \`3\`, so it’s easy:
+
+\`\`\`yaml
+array.omit:
+  - 3
+\`\`\`
+
+Result:
+
+\`\`\`json
+[
+  {
+    "name": "Peter",
+    "occupation": "Delivery driver"
+  },
+  {
+    "name": "Otto",
+    "occupation": "Scientist"
+  },
+  {
+    "name": "Harry",
+    "occupation": "CEO"
+  }
+]
+\`\`\`
+
+However, usually we don’t know the exact index of the item we want to delete. Because the remapper
+accepts remappers as input we can get the desired item’s ID from another source as well. Take the
+following example:
+
+In this example we assume the data from the previous example is passed to this table block using a
+data loader’s emitting event called “people”. When the user clicks on one of the people in the
+table, it gets the list of people again. Using the index of this person, and the \`array.omit\`
+remapper, the person gets removed from the list.
+
+\`\`\`yaml
+type: table
+version: 0.20.38
+events:
+  listen:
+    data: people
+parameters:
+  fields:
+    - label: Name
+      value: { prop: name }
+      onClick: removePerson
+    - label: Occupation
+      value: { prop: occupation }
+actions:
+  removePerson:
+    type: resource.query
+    resource: citizensNYC
+    remapAfter:
+      array.omit:
+        - context: index # This gets the index of the item in the table, explained more in the 'Data' page.
+    onSuccess:
+      type: resource.update
+      resource: citizensNYC
+\`\`\`
+    `,
+    },
+};
+//# sourceMappingURL=arrays.js.map

package/reference-schemas/remappers/conditionals.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const conditionalRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;