@appsemble/utils 0.20.45 → 0.21.1

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.45/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.21.1/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.45/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.45)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.21.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.21.1)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.45/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.21.1/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/ObjectRemapperDefinition.js

@@ -1,3 +1,8 @@
+import * as remapperSchemas from '../../../reference-schemas/remappers/index.js';
+const remapperList = {};
+for (const section of Object.values(remapperSchemas)) {
+    Object.assign(remapperList, section);
+}
 export const ObjectRemapperDefinition = {
     type: 'object',
     description: `An object based remapper is defined by a specific implementation
@@ -7,509 +12,6 @@ Object based remappers may only define 1 key. The allowed value depends on the r
     minProperties: 1,
     maxProperties: 1,
     additionalProperties: false,
-    properties: {
-        app: {
-            enum: ['id', 'locale', 'url'],
-            description: `Get app metadata.
-
-Supported properties:
-
-- \`id\`: Get the app id.
-- \`locale\`: Get the current locale of the app.
-- \`url\`: Get the base URL of the app.
-`,
-        },
-        array: {
-            enum: ['index', 'length'],
-            description: `Get the current array.map’s index or length.
-
-Returns nothing when not in the context of \`array.map’s\`.
-`,
-        },
-        'array.map': {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `Build an array based on the given data and remappers.
-
-The remappers gets applied to each item in the array.
-
-Always returns an array, can be empty if supplied data isn’t an array.
-`,
-        },
-        'array.unique': {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `Filters out unique entries from an array.
-
-The value Remapper is applied to each entry in the array,
-using its result to determine uniqueness.
-
-If the value Remapper result 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.`,
-        },
-        'array.from': {
-            type: 'array',
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-            description: 'Create a new array with an array of predefined remappers.',
-        },
-        '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.`,
-        },
-        'array.omit': {
-            type: 'array',
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-            description: `Remove item(s) from an array given a predefined array of remappable indices.
-
-Only the remapped values that are turned into numbers are applied.
-
-If the input is not an array an empty array is returned.`,
-        },
-        context: {
-            type: 'string',
-            description: 'Get a property from the context.',
-        },
-        'date.add': {
-            type: 'string',
-            description: 'Add the specified value to a given date.',
-        },
-        'date.format': {
-            enum: [null],
-            description: 'Format a date according to rfc3339.',
-        },
-        'date.now': {
-            enum: [null],
-            description: 'Returns the current date.',
-        },
-        'date.parse': {
-            type: 'string',
-            description: `Convert a string to a date using a given format.
-
-For example:
-\`\`\`yaml
-  - static: 02/11/2014     # The date string to parse
-  - date.parse: MM/dd/yyyy # The given format to parse the date with
-               # => Tue Feb 11 2014 00:00:00
-\`\`\`
-
-See [date-fns](https://date-fns.org/v2.29.3/docs/parse) for the supported formats.
-
-Leaving the format empty will try to parse the date using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
-For example:
-\`\`\`yaml
-date.parse:
-  - static: 2014-02-11T11:30:30 # The date string to parse
-  - date.parse: ''              # The given format to parse the date with
-                        # => Tue Feb 11 2014 11:30:30
-\`\`\`
-
-`,
-        },
-        equals: {
-            type: 'array',
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-            description: `Compare all computed remapper values against each other.
-
-Returns \`true\` if all entries are equal, otherwise \`false\`.
-`,
-        },
-        not: {
-            type: 'array',
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-            description: `Compare all computed remapper values against the first.
-
-Returns \`false\` if all entries are equal to the first entry, otherwise \`true\`.
-
-If only one remapper or none is passed, the remapper value gets computed and then inverted.
-`,
-        },
-        step: {
-            type: 'string',
-            description: 'Get flow page step current data',
-        },
-        gt: {
-            type: 'array',
-            description: `Compare the first computed remapper value with the second computed remapper value.
-
-Returns \`true\` if the first entry is greater than the second entry.`,
-            minItems: 2,
-            maxItems: 2,
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-        },
-        ics: {
-            type: 'object',
-            description: 'Create a calendar event',
-            additionalProperties: false,
-            required: ['start', 'title'],
-            properties: {
-                start: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'The start of the icalendar event.',
-                },
-                end: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'The end of the icalendar event.',
-                },
-                duration: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'The duration of the event.',
-                    example: '1w 3d 10h 30m',
-                },
-                title: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'The title of the event.',
-                },
-                description: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'An optional description of the event.',
-                },
-                url: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'An optional link to attach to the event.',
-                },
-                location: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'An optional location description to attach to the event.',
-                },
-                coordinates: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: `An optional geolocation description to attach to the event.
-
-This must be an object with the properties \`lat\` or \`latitude\`, and \`lon\`, \`lng\` or \`longitude\`.`,
-                },
-            },
-        },
-        if: {
-            type: 'object',
-            description: `Check if condition results in a truthy value.
-
-Returns value of then if condition is truthy, otherwise it returns the value of else.
-`,
-            additionalProperties: false,
-            required: ['condition', 'then', 'else'],
-            properties: {
-                condition: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'The condition to check.',
-                },
-                then: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'This remapper is used if the condition returns true.',
-                },
-                else: {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                    description: 'This remapper is used if the condition returns false.',
-                },
-            },
-        },
-        match: {
-            type: 'array',
-            description: `Check if any case results in a truthy value.
-
-Returns the value of the first case where the condition equals true, otherwise returns null.
-`,
-            items: {
-                type: 'object',
-                additionalProperties: false,
-                required: ['case', 'value'],
-                description: '',
-                properties: {
-                    case: {
-                        $ref: '#/components/schemas/RemapperDefinition',
-                        description: 'The condition to check.',
-                    },
-                    value: {
-                        $ref: '#/components/schemas/RemapperDefinition',
-                        description: 'This remapper is used if the case is true',
-                    },
-                },
-            },
-        },
-        lt: {
-            type: 'array',
-            description: `Compare the first computed remapper value with the second computed remapper value.
-
-Returns \`true\` if the first entry is lesser than the second entry.`,
-            minItems: 2,
-            maxItems: 2,
-            items: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-        },
-        log: {
-            enum: ['info', 'warn', 'error'],
-            description: `Logs its input data (returns it) and its context.
-
-The value to set is the log level.`,
-        },
-        'null.strip': {
-            description: 'Strip all null, undefined, and empty array values from an object.',
-            anyOf: [
-                { enum: [null] },
-                {
-                    type: 'object',
-                    required: ['depth'],
-                    additionalProperties: false,
-                    description: 'Options for the null.strip remapper.',
-                    properties: {
-                        depth: {
-                            type: 'integer',
-                            minimum: 1,
-                            description: 'How deep to recurse into objects and arrays to remove null values.',
-                        },
-                    },
-                },
-            ],
-        },
-        'object.assign': {
-            description: 'Assign properties to an existing object given some predefined mapper keys.',
-            additionalProperties: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-        },
-        'object.from': {
-            description: 'Create a new object given some predefined mapper keys.',
-            additionalProperties: {
-                $ref: '#/components/schemas/RemapperDefinition',
-            },
-        },
-        'object.omit': {
-            description: `Remove properties from an existing object based on the given the object keys.
-
-Nested properties can be removed using arrays of keys.
-
-For example:
-\`\`\`yaml
-object.omit:
-  - foo   # Removes the property foo
-  - - bar # Removes the property baz inside of bar
-    - baz
-\`\`\`
-`,
-            type: 'array',
-            items: {
-                minItems: 1,
-                anyOf: [
-                    { type: 'string' },
-                    {
-                        type: 'array',
-                        minItems: 2,
-                        items: {
-                            type: 'string',
-                        },
-                    },
-                ],
-            },
-        },
-        page: {
-            enum: ['data', 'url'],
-            description: `Get page metadata.
-
-Supported properties:
-
-- \`data\`: Get the current page data.
-- \`url\`: Get the URL of the current page.
-`,
-        },
-        prop: {
-            anyOf: [
-                { type: 'string' },
-                { type: 'integer' },
-                { type: 'array', minItems: 1, items: { anyOf: [{ type: 'string' }, { type: 'integer' }] } },
-            ],
-            description: 'Get a property from an object.',
-        },
-        'random.choice': {
-            enum: [null],
-            description: 'Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.',
-        },
-        'random.integer': {
-            type: 'array',
-            maxItems: 2,
-            minItems: 2,
-            items: {
-                type: 'integer',
-            },
-            description: 'Pick and return a random integer between the provided lowest and highest values.',
-        },
-        'random.float': {
-            type: 'array',
-            maxItems: 2,
-            minItems: 2,
-            items: {
-                type: 'number',
-            },
-            description: 'Pick and return a random number between the provided lowest and highest values.',
-        },
-        'random.string': {
-            type: 'object',
-            required: ['choice', 'length'],
-            additionalProperties: false,
-            properties: {
-                choice: { type: 'string', minLength: 1 },
-                length: { type: 'integer', minimum: 1 },
-            },
-            description: 'Pick and return a random string from a given length using characters from a given input string.',
-        },
-        root: {
-            enum: [null],
-            description: 'Get the input data as it was initially passed to the remap function.',
-        },
-        history: {
-            type: 'integer',
-            description: `Get the data at a certain index from the history stack prior to an action.
-
-0 is the index of the first item in the history stack.`,
-        },
-        'from.history': {
-            type: 'object',
-            required: ['index', 'props'],
-            description: 'Create a new object with properties from the history stack at a certain index.',
-            additionalProperties: false,
-            properties: {
-                index: {
-                    type: 'integer',
-                    description: `The index of the history stack item to assign.
-
-0 is the index of the first item in the history stack.
-`,
-                },
-                props: {
-                    description: 'Predefined mapper keys to choose what properties to apply.',
-                    additionalProperties: {
-                        $ref: '#/components/schemas/RemapperDefinition',
-                    },
-                },
-            },
-        },
-        'assign.history': {
-            type: 'object',
-            required: ['index', 'props'],
-            description: 'Assign properties from the history stack at a certain index to an existing object.',
-            additionalProperties: false,
-            properties: {
-                index: {
-                    type: 'integer',
-                    description: `The index of the history stack item to assign.
-
-0 is the index of the first item in the history stack.
-`,
-                },
-                props: {
-                    description: 'Predefined mapper keys to choose what properties to assign.',
-                    additionalProperties: {
-                        $ref: '#/components/schemas/RemapperDefinition',
-                    },
-                },
-            },
-        },
-        'omit.history': {
-            type: 'object',
-            required: ['index', 'keys'],
-            description: 'Assign properties from the history stack at a certain index and exclude the unwanted properties.',
-            additionalProperties: false,
-            properties: {
-                index: {
-                    type: 'integer',
-                    description: `The index of the history stack item to assign.
-
-0 is the index of the first item in the history stack.
-`,
-                },
-                keys: {
-                    description: `Exclude properties from the history stack item, based on the given object keys.
-
-Nested properties can be excluded using arrays of keys.
-
-For example:
-\`\`\`yaml
-omit.history:
-  index: 0
-  keys:
-    - foo   # Excludes the property foo
-    - - bar # Excludes the property baz inside of bar
-      - baz
-\`\`\`
-`,
-                    type: 'array',
-                    items: {
-                        minItems: 1,
-                        anyOf: [
-                            { type: 'string' },
-                            {
-                                type: 'array',
-                                minItems: 2,
-                                items: {
-                                    type: 'string',
-                                },
-                            },
-                        ],
-                    },
-                },
-            },
-        },
-        static: {
-            description: 'Use a static value.',
-        },
-        'string.case': {
-            enum: ['lower', 'upper'],
-            description: 'Convert an input to lower or upper case.',
-        },
-        'string.format': {
-            type: 'object',
-            description: 'Format a string using remapped input variables.',
-            additionalProperties: false,
-            properties: {
-                messageId: {
-                    type: 'string',
-                    description: 'The message id pointing to the template string to format.',
-                },
-                template: {
-                    type: 'string',
-                    description: 'The template default string to format.',
-                },
-                values: {
-                    description: 'A set of remappers to convert the input to usable values.',
-                    additionalProperties: {
-                        $ref: '#/components/schemas/RemapperDefinition',
-                    },
-                },
-            },
-        },
-        'string.replace': {
-            type: 'object',
-            description: 'Match the content with the regex in the key, and replace it with its value.',
-            minProperties: 1,
-            maxProperties: 1,
-            additionalProperties: {
-                type: 'string',
-            },
-        },
-        translate: {
-            type: 'string',
-            description: `Translate using a messageID.
-
-This does not support parameters, for more nuanced translations use \`string.format\`.
-`,
-        },
-        user: {
-            enum: ['sub', 'name', 'email', 'email_verified', 'picture', 'profile', 'locale'],
-            description: 'Get a user property from the OpenID user info.',
-        },
-    },
+    properties: remapperList,
 };
 //# sourceMappingURL=ObjectRemapperDefinition.js.map

package/api/components/schemas/RequestActionDefinition.js

@@ -42,7 +42,7 @@ If not specified, the raw input data is used.
         },
         proxy: {
             type: 'boolean',
-            default: 'false',
+            default: true,
             description: `By default requests will be proxied through the Appsemble API.
 
 This allows to protect user data and ensures

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

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

package/api/components/schemas/ScimPatchOp.js

@@ -0,0 +1,47 @@
+export const ScimPatchOp = {
+    type: 'object',
+    description: 'A SCIM patch operation',
+    required: ['schemas', 'operations'],
+    additionalProperties: true,
+    properties: {
+        schemas: {
+            type: 'array',
+            maxItems: 1,
+            minItems: 1,
+            items: {
+                enum: ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
+            },
+        },
+        operations: {
+            type: 'array',
+            description: 'Patch operations to apply to the resource',
+            items: {
+                anyOf: [
+                    {
+                        type: 'object',
+                        description: 'A SCIM patch single replace operation',
+                        additionalProperties: false,
+                        required: ['op', 'path', 'value'],
+                        properties: {
+                            op: { enum: ['add', 'replace'] },
+                            name: { type: 'string' },
+                            path: { type: 'string' },
+                            value: {},
+                        },
+                    },
+                    {
+                        type: 'object',
+                        description: 'A SCIM patch bulk replace operation',
+                        additionalProperties: false,
+                        required: ['op', 'path'],
+                        properties: {
+                            op: { enum: ['remove'] },
+                            path: { type: 'string' },
+                        },
+                    },
+                ],
+            },
+        },
+    },
+};
+//# sourceMappingURL=ScimPatchOp.js.map

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

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

package/api/components/schemas/ScimSecret.js

@@ -0,0 +1,16 @@
+export const ScimSecret = {
+    type: 'object',
+    additionalProperties: false,
+    description: 'An app’s SCIM configuration.',
+    properties: {
+        enabled: {
+            type: 'boolean',
+            description: 'Whether or not SCIM is enabled for the app.',
+        },
+        token: {
+            type: 'string',
+            description: 'The secret SCIM token',
+        },
+    },
+};
+//# sourceMappingURL=ScimSecret.js.map

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

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

package/api/components/schemas/ScimUser.js

@@ -0,0 +1,60 @@
+export const ScimUser = {
+    type: 'object',
+    additionalProperties: true,
+    description: 'The definition of a user according to the SCIM documentation.',
+    required: ['emails', 'schemas', 'userName'],
+    properties: {
+        schemas: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        userName: {
+            type: 'string',
+            description: 'A unique identifier for the user (generally maps to the Azure AD user principal name)',
+        },
+        active: {
+            type: 'boolean',
+        },
+        meta: {
+            type: 'object',
+            additionalProperties: false,
+            description: 'Read-only metadata maintained by the service provider',
+            properties: {
+                resourceType: {
+                    type: 'string',
+                },
+                created: {
+                    type: 'string',
+                },
+                lastModified: {
+                    type: 'string',
+                },
+                location: {
+                    type: 'string',
+                },
+            },
+        },
+        emails: {
+            type: 'array',
+            minLength: 1,
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                description: "A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address",
+                required: ['primary', 'type', 'value'],
+                properties: {
+                    primary: {
+                        type: 'boolean',
+                    },
+                    type: {
+                        type: 'string',
+                    },
+                    value: {
+                        type: 'string',
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=ScimUser.js.map