@appsemble/utils 0.33.5 → 0.33.7

package/reference-schemas/actions/miscellaneous.js

@@ -1,43 +0,0 @@
-import { AnalyticsActionDefinition } from '../../api/components/schemas/AnalyticsActionDefinition.js';
-import { ConditionActionDefinition } from '../../api/components/schemas/ConditionActionDefinition.js';
-import { ControllerActionDefinition } from '../../api/components/schemas/ControllerActionDefinition.js';
-import { CsvParseActionDefinition } from '../../api/components/schemas/CsvParseActionDefinition.js';
-import { DialogActionDefinition } from '../../api/components/schemas/DialogActionDefinition.js';
-import { DialogErrorActionDefinition } from '../../api/components/schemas/DialogErrorActionDefinition.js';
-import { DialogOkActionDefinition } from '../../api/components/schemas/DialogOkActionDefinition.js';
-import { DownloadActionDefinition } from '../../api/components/schemas/DownloadActionDefinition.js';
-import { EachActionDefinition } from '../../api/components/schemas/EachActionDefinition.js';
-import { EmailActionDefinition } from '../../api/components/schemas/EmailActionDefinition.js';
-import { EventActionDefinition } from '../../api/components/schemas/EventActionDefinition.js';
-import { LogActionDefinition } from '../../api/components/schemas/LogActionDefinition.js';
-import { MatchActionDefinition } from '../../api/components/schemas/MatchActionDefinition.js';
-import { MessageActionDefinition } from '../../api/components/schemas/MessageActionDefinition.js';
-import { NoopActionDefinition } from '../../api/components/schemas/NoopActionDefinition.js';
-import { NotifyActionDefinition } from '../../api/components/schemas/NotifyActionDefinition.js';
-import { RequestActionDefinition } from '../../api/components/schemas/RequestActionDefinition.js';
-import { ShareActionDefinition } from '../../api/components/schemas/ShareActionDefinition.js';
-import { StaticActionDefinition } from '../../api/components/schemas/StaticActionDefinition.js';
-import { ThrowActionDefinition } from '../../api/components/schemas/ThrowActionDefinition.js';
-export const miscellaneousActions = {
-    analytics: AnalyticsActionDefinition,
-    condition: ConditionActionDefinition,
-    controller: ControllerActionDefinition,
-    'csv.parse': CsvParseActionDefinition,
-    download: DownloadActionDefinition,
-    dialog: DialogActionDefinition,
-    'dialog.ok': DialogOkActionDefinition,
-    'dialog.error': DialogErrorActionDefinition,
-    each: EachActionDefinition,
-    event: EventActionDefinition,
-    email: EmailActionDefinition,
-    log: LogActionDefinition,
-    match: MatchActionDefinition,
-    message: MessageActionDefinition,
-    noop: NoopActionDefinition,
-    notify: NotifyActionDefinition,
-    request: RequestActionDefinition,
-    share: ShareActionDefinition,
-    static: StaticActionDefinition,
-    throw: ThrowActionDefinition,
-};
-//# sourceMappingURL=miscellaneous.js.map

package/reference-schemas/actions/resources.d.ts

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

package/reference-schemas/actions/resources.js

@@ -1,19 +0,0 @@
-import { ResourceCountActionDefinition, ResourceCreateActionDefinition, ResourceDeleteActionDefinition, ResourceDeleteAllActionDefinition, ResourceDeleteBulkActionDefinition, ResourceGetActionDefinition, ResourceHistoryGetActionDefinition, ResourcePatchActionDefinition, ResourceQueryActionDefinition, ResourceSubscriptionStatusActionDefinition, ResourceSubscriptionSubscribeActionDefinition, ResourceSubscriptionToggleActionDefinition, ResourceSubscriptionUnsubscribeActionDefinition, ResourceUpdateActionDefinition, ResourceUpdatePositionsActionDefinition, } from '../../api/components/schemas/index.js';
-export const resourceActions = {
-    'resource.get': ResourceGetActionDefinition,
-    'resource.history.get': ResourceHistoryGetActionDefinition,
-    'resource.update.positions': ResourceUpdatePositionsActionDefinition,
-    'resource.query': ResourceQueryActionDefinition,
-    'resource.count': ResourceCountActionDefinition,
-    'resource.create': ResourceCreateActionDefinition,
-    'resource.update': ResourceUpdateActionDefinition,
-    'resource.patch': ResourcePatchActionDefinition,
-    'resource.delete': ResourceDeleteActionDefinition,
-    'resource.delete.all': ResourceDeleteAllActionDefinition,
-    'resource.delete.bulk': ResourceDeleteBulkActionDefinition,
-    'resource.subscription.subscribe': ResourceSubscriptionSubscribeActionDefinition,
-    'resource.subscription.unsubscribe': ResourceSubscriptionUnsubscribeActionDefinition,
-    'resource.subscription.toggle': ResourceSubscriptionToggleActionDefinition,
-    'resource.subscription.status': ResourceSubscriptionStatusActionDefinition,
-};
-//# sourceMappingURL=resources.js.map

package/reference-schemas/actions/storage.d.ts

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

package/reference-schemas/actions/storage.js

@@ -1,15 +0,0 @@
-import { StorageAppendActionDefinition } from '../../api/components/schemas/StorageAppendActionDefinition.js';
-import { StorageDeleteActionDefinition } from '../../api/components/schemas/StorageDeleteActionDefinition.js';
-import { StorageReadActionDefinition } from '../../api/components/schemas/StorageReadActionDefinition.js';
-import { StorageSubtractActionDefinition } from '../../api/components/schemas/StorageSubtractActionDefinition.js';
-import { StorageUpdateActionDefinition } from '../../api/components/schemas/StorageUpdateActionDefinition.js';
-import { StorageWriteActionDefinition } from '../../api/components/schemas/StorageWriteActionDefinition.js';
-export const storageActions = {
-    'storage.read': StorageReadActionDefinition,
-    'storage.write': StorageWriteActionDefinition,
-    'storage.append': StorageAppendActionDefinition,
-    'storage.subtract': StorageSubtractActionDefinition,
-    'storage.update': StorageUpdateActionDefinition,
-    'storage.delete': StorageDeleteActionDefinition,
-};
-//# sourceMappingURL=storage.js.map

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

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

package/reference-schemas/remappers/arrays.js

@@ -1,297 +0,0 @@
-import { schemaExample } from '../../examples.js';
-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:
-
-${schemaExample('array.map', { input: 'pretty' })}
-
-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:
-
-${schemaExample('array.map.1', { input: 'pretty', exclude: ['input'] })}
-
-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.
-
-${schemaExample('array.unique')}
-
-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.filter': {
-        $ref: '#/components/schemas/RemapperDefinition',
-        description: `
-Filters out values based on the input conditions provided.
-
-For example:
-
-${schemaExample('array.filter')}
-
-Example of how it can be used to filter a number array.
-
-Input:
-
-\`\`\`json
-[1,2,1,3,4,1,5]
-\`\`\`
-
-\`\`\`yaml
-array.filter:
-  equals:
-    - array: item
-    - 1
-\`\`\`
-
-Result:
-
-\`\`\`json
-[1,1,1]
-\`\`\`
-    `,
-    },
-    'array.find': {
-        $ref: '#/components/schemas/RemapperDefinition',
-        description: `
-Returns a single object or value from an array based on the given condition.
-
-For example:
-
-${schemaExample('array.find')}
-`,
-    },
-    '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:
-
-${schemaExample('array.from', { exclude: ['input'] })}
-
-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:
-
-${schemaExample('array.append', { result: 'pretty', exclude: ['input'] })}
-
-Extra example:
-
-array remapper can also be used in combination with different remappers as in the current example comes object remapper:
-
-Example object:
-\`\`\`json
-{
-  "names": ["Bart", "Bas", "Sam"]
-}
-\`\`\`
-
-Combination of object and array remapper:
-
-\`\`\`yaml
-object.assign:
-  names:
-  - { prop: Applicants }
-  - array.append:
-    - Kevin
-\`\`\`
-
-Result:
-\`\`\`json
-{
-  "names": ["Bart", "Bas", "Sam", "Kevin"]
-}
-\`\`\`
-\
-    `,
-    },
-    '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:
-
-${schemaExample('array.omit', { result: 'pretty', exclude: ['input'] })}
-
-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
-\`\`\`
-    `,
-    },
-    'array.flatten': {
-        $ref: '#/components/schemas/RemapperDefinition',
-        description: `
-Flatten an array. Accepts an array of static or remapper values.
-
-Say for example that each person has some pets. We could get an array of all pets like so:
-
-${schemaExample('array.flatten', { input: 'pretty', exclude: ['remapper'] })}
-`,
-    },
-    'array.contains': {
-        $ref: '#/components/schemas/RemapperDefinition',
-        description: `
-Checks if the input array includes the provided item.
-${schemaExample('array.contains')}
-`,
-    },
-};
-//# sourceMappingURL=arrays.js.map

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

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

package/reference-schemas/remappers/conditionals.js

@@ -1,167 +0,0 @@
-import { schemaExample } from '../../examples.js';
-export const conditionalRemappers = {
-    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\`.
-
-For example:
-
-${schemaExample('if.then')}
-
-${schemaExample('if.else', { exclude: ['remapper'] })}
-`,
-        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.',
-            },
-        },
-    },
-    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\`.
-
-In the following example, if the \`inputValue\` and \`expectedValue\` are of the same value, the
-condition will return \`true\` and the \`then\` remapper will fire.
-
-${schemaExample('equals')}
-`,
-    },
-    gt: {
-        type: 'array',
-        description: `**(gt = Greater than)**
-
-Compare the first computed remapper value with the second computed remapper value.
-
-Returns \`true\` if the first entry is greater than the second entry.
-
-For example, if \`stock\` is more than 5 here, it returns \`true\`.
-
-${schemaExample('gt')}
-`,
-        minItems: 2,
-        maxItems: 2,
-        items: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-    },
-    lt: {
-        type: 'array',
-        description: `**(lt = Lesser than)
-
-Compare the first computed remapper value with the second computed remapper value.
-
-Returns \`true\` if the first entry is lesser than the second entry.
-
-For example, if \`stock\` is less than 5 here, it returns \`true\`.
-
-${schemaExample('gt')}
-`,
-        minItems: 2,
-        maxItems: 2,
-        items: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-    },
-    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.
-
-If \`number\` in the following example is something other than 4, the condition returns \`true\`.
-
-${schemaExample('not')}
-`,
-    },
-    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.
-
-In the following example, let's say the \`Gem\` is a "Ruby". The match remapper then returns
-\`value: 75\`.
-
-${schemaExample('match')}
-`,
-        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',
-                },
-            },
-        },
-    },
-    and: {
-        type: 'array',
-        items: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-        description: `Compare all computed remapper values against each other.
-
-Returns \`true\` if all entries are equal to \`true\`, otherwise \`false\`.
-
-If only one remapper or none is passed, the remapper value gets computed.
-
-${schemaExample('and')}
-`,
-    },
-    or: {
-        type: 'array',
-        items: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-        description: `Compare all computed remapper values against each other.
-
-Returns \`false\` if all entries are equal to \`false\`, otherwise \`true\`.
-
-If only one remapper or none is passed, the remapper value gets computed.
-
-${schemaExample('or')}
-`,
-    },
-    defined: {
-        $ref: '#/components/schemas/RemapperDefinition',
-        description: `Check if a value is defined. Returns \`true\` if defined, \`false\` if not.
-
-Considers falsy values like \`0\`, \`""\` and \`false\` as defined.
-
-The \`null\` and \`undefined\` values are considered as not defined.
-
-${schemaExample('defined')}
-`,
-    },
-};
-//# sourceMappingURL=conditionals.js.map

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

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

package/reference-schemas/remappers/config.js

@@ -1,13 +0,0 @@
-import { schemaExample } from '../../examples.js';
-export const configRemappers = {
-    variable: {
-        type: 'string',
-        description: `Get a predefined app variable by name
-
-For example:
-
-${schemaExample('variable', { exclude: ['input'] })}
-`,
-    },
-};
-//# sourceMappingURL=config.js.map

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

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