@appsemble/utils 0.20.37 → 0.20.39

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.37/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.39/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.37/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.37)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.37/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.39/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.39)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.39/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Installation
@@ -21,5 +21,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.37/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.39/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/ActionDefinition.js

@@ -42,6 +42,7 @@ export const ActionDefinition = {
                 { $ref: '#/components/schemas/LinkBackActionDefinition' },
                 { $ref: '#/components/schemas/LinkNextActionDefinition' },
                 { $ref: '#/components/schemas/LogActionDefinition' },
+                { $ref: '#/components/schemas/MatchActionDefinition' },
                 { $ref: '#/components/schemas/MessageActionDefinition' },
                 { $ref: '#/components/schemas/NoopActionDefinition' },
                 { $ref: '#/components/schemas/NotifyActionDefinition' },

package/api/components/schemas/ArrayRemapperDefinition.d.ts

@@ -0,0 +1,2 @@
+import { OpenAPIV3 } from 'openapi-types';
+export declare const ArrayRemapperDefinition: OpenAPIV3.ArraySchemaObject;

package/api/components/schemas/ArrayRemapperDefinition.js

@@ -0,0 +1,22 @@
+export const ArrayRemapperDefinition = {
+    type: 'array',
+    description: `If a remapper is an array, it represents a chain of remappers.
+
+Each item represents a remapper which is called with the result of the remapper before it.
+
+If an array is nested, it will be flattened. This allows you to create reusable remappers and
+reference them using YAML anchors.
+`,
+    minItems: 1,
+    items: {
+        anyOf: [
+            {
+                $ref: '#/components/schemas/ObjectRemapperDefinition',
+            },
+            {
+                $ref: '#/components/schemas/ArrayRemapperDefinition',
+            },
+        ],
+    },
+};
+//# sourceMappingURL=ArrayRemapperDefinition.js.map

package/api/components/schemas/MatchActionDefinition.d.ts

@@ -0,0 +1 @@
+export declare const MatchActionDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/MatchActionDefinition.js

@@ -0,0 +1,35 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const MatchActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'match'],
+    properties: {
+        type: {
+            enum: ['match'],
+            description: `Run another action if one of the cases is true.
+
+Only the first case that equals true is called.`,
+        },
+        match: {
+            type: 'array',
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                required: ['case', 'action'],
+                description: '',
+                properties: {
+                    case: {
+                        $ref: '#/components/schemas/RemapperDefinition',
+                        description: 'The case to be matched.',
+                    },
+                    action: {
+                        $ref: '#/components/schemas/ActionDefinition',
+                        description: 'Action to be called if the case equals true.',
+                    },
+                },
+            },
+        },
+    },
+});
+//# sourceMappingURL=MatchActionDefinition.js.map

package/api/components/schemas/MessageActionDefinition.js

@@ -21,6 +21,11 @@ This is useful in combination with action chaining to notify users they have per
             default: 'info',
             description: 'The Bulma color to apply to the message.',
         },
+        layout: {
+            enum: ['bottom', 'top'],
+            default: 'bottom',
+            description: 'The position of the message on the screen.',
+        },
         dismissable: {
             type: 'boolean',
             description: 'Boolean value indicating whether the user is able to dismiss the message manually.',

package/api/components/schemas/RemapperDefinition.js

@@ -20,14 +20,7 @@ export const RemapperDefinition = {
             $ref: '#/components/schemas/ObjectRemapperDefinition',
         },
         {
-            type: 'array',
-            description: `If a remapper is an array, it represents a chain of remappers.
-
-Each item represents a remapper which is called with the result of the remapper before it.
-`,
-            items: {
-                $ref: '#/components/schemas/ObjectRemapperDefinition',
-            },
+            $ref: '#/components/schemas/ArrayRemapperDefinition',
         },
     ],
 };

package/api/components/schemas/ResourceUpdateActionDefinition.js

@@ -11,7 +11,7 @@ export const ResourceUpdateActionDefinition = extendJSONSchema(RequestActionDefi
         },
         resource: {
             type: 'string',
-            description: 'The type of the resource to query.',
+            description: 'The type of the resource to update.',
         },
     },
 }, ['url']);

package/api/components/schemas/index.d.ts

@@ -7,6 +7,7 @@ export * from './AppLayoutDefinition.js';
 export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
 export * from './AppsembleMessages.js';
+export * from './ArrayRemapperDefinition.js';
 export * from './Asset.js';
 export * from './BlockDefinition.js';
 export * from './BlockVersion.js';
@@ -52,6 +53,7 @@ export * from './LinkBackActionDefinition.js';
 export * from './LinkNextActionDefinition.js';
 export * from './LogActionDefinition.js';
 export * from './Member.js';
+export * from './MatchActionDefinition.js';
 export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
 export * from './NotificationHookDataDefinition.js';

package/api/components/schemas/index.js

@@ -7,6 +7,7 @@ export * from './AppLayoutDefinition.js';
 export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
 export * from './AppsembleMessages.js';
+export * from './ArrayRemapperDefinition.js';
 export * from './Asset.js';
 export * from './BlockDefinition.js';
 export * from './BlockVersion.js';
@@ -52,6 +53,7 @@ export * from './LinkBackActionDefinition.js';
 export * from './LinkNextActionDefinition.js';
 export * from './LogActionDefinition.js';
 export * from './Member.js';
+export * from './MatchActionDefinition.js';
 export * from './MessageActionDefinition.js';
 export * from './NoopActionDefinition.js';
 export * from './NotificationHookDataDefinition.js';

package/appMessages.js

@@ -90,7 +90,7 @@ export function extractAppMessages(app, onBlock) {
             }
         },
         onPage(page) {
-            var _a, _b, _c;
+            var _a, _b;
             const prefix = `pages.${normalize(page.name)}`;
             messages.app[prefix] = page.name;
             if (page.type === 'tabs') {
@@ -104,7 +104,9 @@ export function extractAppMessages(app, onBlock) {
                 }
             }
             if (page.type === 'loop') {
-                messages.app[`${prefix}.step`] = (_c = page.foreach.name) !== null && _c !== void 0 ? _c : '';
+                messages.app[`${prefix}.steps.first`] = 'first';
+                messages.app[`${prefix}.steps`] = 'step';
+                messages.app[`${prefix}.steps.last`] = 'last';
             }
         },
     });

package/iterApp.js

@@ -95,7 +95,12 @@ export function iterPage(page, callbacks, prefix = []) {
                 : page.tabs.some((tab, index) => iterBlockList(tab.blocks, callbacks, [...prefix, 'tabs', index, 'blocks']))));
     }
     if (page.type === 'loop') {
-        return iterBlockList(page.foreach.blocks, callbacks, [...prefix, 'blocks']);
+        let result = false;
+        if ('actions' in page) {
+            result = Object.entries(page.actions).some(([key, action]) => iterAction(action, callbacks, [...prefix, 'actions', key]));
+        }
+        return (result ||
+            ['steps.first', 'steps', 'steps.last'].some((suffix) => iterBlockList(page.foreach.blocks, callbacks, [...prefix, suffix, 'blocks'])));
     }
     return iterBlockList(page.blocks, callbacks, [...prefix, 'blocks']);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.20.37",
+  "version": "0.20.39",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -31,12 +31,12 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "dependencies": {
-    "@appsemble/types": "0.20.37",
+    "@appsemble/types": "0.20.39",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",
     "fast-deep-equal": "^3.0.0",
-    "ics": "^2.0.0",
+    "ics": "^3.0.0",
     "intl-messageformat": "^10.0.0",
     "jsonschema": "^1.0.0",
     "langmap": "^0.0.16",

package/remap.js

@@ -21,7 +21,10 @@ export function remap(remapper, input, context) {
         return remapper;
     }
     let result = input;
-    const remappers = Array.isArray(remapper) ? remapper : [remapper];
+    // Workaround for ts(2589) Type instantiation is excessively deep and possibly infinite
+    const remappers = Array.isArray(remapper)
+        ? remapper.flat(Number.POSITIVE_INFINITY)
+        : [remapper];
     for (const mapper of remappers) {
         const entries = Object.entries(mapper);
         if (entries.length !== 1) {

package/remap.test.js

@@ -35,6 +35,15 @@ describe('Primitive values', () => {
         },
     });
 });
+describe('Nested arrays', () => {
+    runTests({
+        'flatten remappers': {
+            input: { value: 123 },
+            mappers: [[[[[{ prop: 'value' }]]]]],
+            expected: 123,
+        },
+    });
+});
 describe('app', () => {
     runTests({
         'return the app id': {