@appsemble/utils 0.33.5 → 0.33.7

package/api/components/schemas/JSONSchemaRemapper.js

@@ -1,19 +0,0 @@
-import { BaseJSONSchema } from './BaseJSONSchema.js';
-import { extendJSONSchema } from './utils.js';
-// Allow remappers without specifying a type.
-export const JSONSchemaRemapper = extendJSONSchema(BaseJSONSchema, {
-    type: 'object',
-    description: 'A JSON schema which allows a format of remapper without a type.',
-    additionalProperties: false,
-    required: ['format'],
-    properties: {
-        format: {
-            enum: ['remapper'],
-            description: 'Allow a remapper definition. This is supported for blocks only.',
-        },
-        default: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-    },
-});
-//# sourceMappingURL=JSONSchemaRemapper.js.map

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

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

package/api/components/schemas/JSONSchemaRoot.js

@@ -1,21 +0,0 @@
-import { JSONSchemaObject } from './JSONSchemaObject.js';
-import { extendJSONSchema } from './utils.js';
-export const JSONSchemaRoot = extendJSONSchema(JSONSchemaObject, {
-    type: 'object',
-    description: 'A top level JSON schema.',
-    additionalProperties: false,
-    properties: {
-        definitions: {
-            description: 'This property may be used to store JSON schemas that may be referenced from other places.',
-            additionalProperties: {
-                $ref: '#/components/schemas/JSONSchema',
-            },
-        },
-        $schema: {
-            description: 'The JSON schema meta schema. You probably don’t need to specify this explicitly.',
-            enum: ['http://json-schema.org/draft-04/schema#', 'http://json-schema.org/draft-07/schema#'],
-            default: 'http://json-schema.org/draft-07/schema#',
-        },
-    },
-});
-//# sourceMappingURL=JSONSchemaRoot.js.map

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

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

package/api/components/schemas/JSONSchemaString.js

@@ -1,107 +0,0 @@
-import { BaseJSONSchema } from './BaseJSONSchema.js';
-import { extendJSONSchema } from './utils.js';
-export const JSONSchemaString = extendJSONSchema(BaseJSONSchema, {
-    type: 'object',
-    description: 'A JSON schema for a string.',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['string'],
-            description: 'The type of the JSON schema. A string is the technical term for a piece of text.',
-        },
-        examples: {
-            type: 'array',
-            items: {
-                type: 'string',
-                description: 'An example string which is valid according to this schema.',
-            },
-        },
-        default: {
-            type: 'string',
-            description: 'The default value which is used if no value is supplied.',
-        },
-        enum: {
-            type: 'array',
-            description: 'If an enum is specified, the type can be safely removed.',
-            items: {
-                type: 'string',
-            },
-        },
-        const: {
-            type: 'string',
-            description: 'If const is specified, the type can be safely removed.',
-        },
-        format: {
-            // https://json-schema.org/understanding-json-schema/reference/string.html#built-in-formats
-            enum: [
-                // https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times
-                'date-time',
-                'time',
-                'date',
-                'duration',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#email-addresses
-                'email',
-                'idn-email',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#hostnames
-                'hostname',
-                'idn-hostname',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#ip-addresses
-                'ipv4',
-                'ipv6',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#resource-identifiers
-                'uuid',
-                'uri',
-                'uri-reference',
-                'iri',
-                'iri-reference',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#uri-template
-                'uri-template',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#json-pointer
-                'json-pointer',
-                'relative-json-pointer',
-                // https://json-schema.org/understanding-json-schema/reference/string.html#index-12
-                'regex',
-                // Custom
-                'action',
-                'binary',
-                'event-emitter',
-                'event-listener',
-                'fontawesome',
-            ],
-            description: 'The format values should adhere to.',
-        },
-        minLength: {
-            type: 'integer',
-            description: 'The minimum length of the string.',
-            minimum: 1,
-        },
-        maxLength: {
-            type: 'integer',
-            description: `The maximum length of the string.
-
-It’s highly recommended to set this property, even if it’s a big number. For example 5000 characters
-is plenty for most larger input fields. Not doing so may result in extremely large user input, which
-results in a bad user experience.
-`,
-            minimum: 1,
-            example: 5000,
-        },
-        pattern: {
-            type: 'string',
-            description: `A regular expression to describe user input.
-
-Regular expressions are a powerful way to enforce proper user input, but the learning curve is high.
-If you don’t know what this is, we recommend to omit this field for now.
-`,
-            minLength: 1,
-            format: 'regex',
-        },
-        multiline: {
-            type: 'boolean',
-            description: 'If true, Appsemble renders a textarea in the graphical JSON editor.',
-            default: false,
-        },
-    },
-});
-//# sourceMappingURL=JSONSchemaString.js.map

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

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

package/api/components/schemas/LinkActionDefinition.js

@@ -1,29 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const LinkActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'to'],
-    properties: {
-        type: {
-            enum: ['link'],
-            description: 'The link action can be used to redirect the user to other pages or absolute URLs.',
-        },
-        to: {
-            anyOf: [
-                {
-                    type: 'string',
-                },
-                {
-                    type: 'array',
-                    items: { type: 'string' },
-                },
-                {
-                    $ref: '#/components/schemas/RemapperDefinition',
-                },
-            ],
-            description: 'The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage.',
-        },
-    },
-});
-//# sourceMappingURL=LinkActionDefinition.js.map

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

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

package/api/components/schemas/LinkBackActionDefinition.js

@@ -1,14 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const LinkBackActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['link.back'],
-            description: 'Link back to the previous page in the browser history.',
-        },
-    },
-});
-//# sourceMappingURL=LinkBackActionDefinition.js.map

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

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

package/api/components/schemas/LinkNextActionDefinition.js

@@ -1,14 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const LinkNextActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['link.next'],
-            description: 'Link to the next page in the browser history.',
-        },
-    },
-});
-//# sourceMappingURL=LinkNextActionDefinition.js.map

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

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

package/api/components/schemas/LogActionDefinition.js

@@ -1,22 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const LogActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['log'],
-            description: `Output the result of the action into the console.
-
-This is mostly useful for debugging blocks during development.
-`,
-        },
-        level: {
-            enum: ['error', 'info', 'warn'],
-            default: 'info',
-            description: 'The logging level on which to log.',
-        },
-    },
-});
-//# sourceMappingURL=LogActionDefinition.js.map

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

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

package/api/components/schemas/LoopPageActionsDefinition.js

@@ -1,24 +0,0 @@
-export const LoopPageActionsDefinition = {
-    type: 'object',
-    description: 'These actions are fired on a loop page.',
-    required: ['onLoad'],
-    additionalProperties: false,
-    properties: {
-        onLoad: {
-            $ref: '#/components/schemas/ActionDefinition',
-            description: 'This action is used to define the data to pass onto the loop type array',
-        },
-        onFlowCancel: {
-            $ref: '#/components/schemas/ActionDefinition',
-            description: 'This action gets triggered when `flow.cancel` gets called.',
-        },
-        onFlowFinish: {
-            $ref: '#/components/schemas/ActionDefinition',
-            description: `This action gets triggered when a flow is finished.
-
-A flow is finished when \`flow.finish\` gets called, or when \`flow.next\` gets called on the final
-subpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.`,
-        },
-    },
-};
-//# sourceMappingURL=LoopPageActionsDefinition.js.map

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

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

package/api/components/schemas/LoopPageDefinition.js

@@ -1,32 +0,0 @@
-import { BasePageDefinition } from './BasePageDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const LoopPageDefinition = extendJSONSchema(BasePageDefinition, {
-    type: 'object',
-    description: 'Generates sub pages dynamically based on data and display in a flow page.',
-    required: ['type', 'foreach', 'actions'],
-    additionalProperties: false,
-    properties: {
-        type: {
-            enum: ['loop'],
-        },
-        actions: {
-            $ref: '#/components/schemas/LoopPageActionsDefinition',
-        },
-        foreach: {
-            $ref: '#/components/schemas/SubPage',
-        },
-        progress: {
-            description: 'The method that should be used to display the status of flow pages.',
-            enum: ['corner-dots', 'hidden'],
-        },
-        retainFlowData: {
-            type: 'boolean',
-            description: `Whether to retain the flow data when navigating away to another page outside the flow.
-
-By default the flow page retains it's data after navigating once. Set to false to clear it.
-`,
-            default: true,
-        },
-    },
-});
-//# sourceMappingURL=LoopPageDefinition.js.map

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

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

package/api/components/schemas/MatchActionDefinition.js

@@ -1,35 +0,0 @@
-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.d.ts

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

package/api/components/schemas/MessageActionDefinition.js

@@ -1,40 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const MessageActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'body'],
-    properties: {
-        type: {
-            enum: ['message'],
-            description: `Display a message to the user.
-
-This is useful in combination with action chaining to notify users they have performed a certain action.
-`,
-        },
-        body: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The body of the message.',
-        },
-        color: {
-            enum: ['dark', 'primary', 'link', 'success', 'info', 'warning', 'danger'],
-            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.',
-        },
-        timeout: {
-            type: 'integer',
-            default: 5000,
-            description: 'The time in milliseconds how long the message should be visible.',
-        },
-    },
-});
-//# sourceMappingURL=MessageActionDefinition.js.map

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

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

package/api/components/schemas/NoopActionDefinition.js

@@ -1,17 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const NoopActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['noop'],
-            description: `Do nothing when this action is triggered.
-
-This is the default action for block actions that are not required.
-`,
-        },
-    },
-});
-//# sourceMappingURL=NoopActionDefinition.js.map

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

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

package/api/components/schemas/NotificationHookDataDefinition.js

@@ -1,24 +0,0 @@
-export const NotificationHookDataDefinition = {
-    type: 'object',
-    description: 'The data used to display the content of the notification.',
-    additionalProperties: true,
-    minProperties: 1,
-    properties: {
-        title: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The title of the notification.',
-        },
-        content: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The body of the notification.',
-        },
-        link: {
-            type: 'string',
-            description: `The URL of the page the user gets redirected to after being clicked.
-
-If the URL is relative, it will be relative to the app.
-`,
-        },
-    },
-};
-//# sourceMappingURL=NotificationHookDataDefinition.js.map

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

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

package/api/components/schemas/NotificationHookDefinition.js

@@ -1,32 +0,0 @@
-export const NotificationHookDefinition = {
-    type: 'object',
-    description: 'The strategy used to notify users.',
-    additionalProperties: false,
-    minProperties: 1,
-    properties: {
-        to: {
-            type: 'array',
-            description: `The list of roles to notify.
-
-Aside from roles, \`$author\` can also be used to notify the author of the resource.
-`,
-            minItems: 1,
-            items: {
-                type: 'string',
-            },
-        },
-        subscribe: {
-            description: `If set, allows users to manually subscribe for notifications for this resource regardless of roles.
-
-The following values are allowed:
-- \`all\`: Allows users to be notified about actions on all of the resources of this type.
-- \`single\`: Allows users to be notified about actions a single instance of a resource of this
-  type.
-- \`both\`: Allows users to be notified about all resources or a single resource of this type.
-`,
-            enum: ['all', 'single', 'both'],
-        },
-        data: { $ref: '#/components/schemas/NotificationHookDataDefinition' },
-    },
-};
-//# sourceMappingURL=NotificationHookDefinition.js.map

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

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

package/api/components/schemas/NotifyActionDefinition.js

@@ -1,32 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const NotifyActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'title', 'body', 'to'],
-    properties: {
-        type: {
-            enum: ['notify'],
-            description: 'Send notifications to one or all the users of an app.',
-        },
-        title: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The title of the notification.',
-        },
-        body: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The description of the notification.',
-        },
-        to: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `To whom the notification should be sent.
-
-Use \`all\` to send the notification to all app subscribed users.
-Or notify specific users by passing either a single user id or an array of user ids.
-
-Nothing is sent if the value is **not** a valid user id.
-`,
-        },
-    },
-});
-//# sourceMappingURL=NotifyActionDefinition.js.map

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

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

package/api/components/schemas/ObjectRemapperDefinition.js

@@ -1,17 +0,0 @@
-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
-
-Object based remappers may only define 1 key. The allowed value depends on the remapper.
-`,
-    minProperties: 1,
-    maxProperties: 1,
-    additionalProperties: false,
-    properties: remapperList,
-};
-//# sourceMappingURL=ObjectRemapperDefinition.js.map

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

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

package/api/components/schemas/PageActionsDefinition.js

@@ -1,12 +0,0 @@
-export const PageActionsDefinition = {
-    type: 'object',
-    description: 'Action fired on page events',
-    additionalProperties: false,
-    properties: {
-        onLoad: {
-            $ref: '#/components/schemas/ActionDefinition',
-            description: 'This action is fired when a page loads, highly helpful in loading data for the page',
-        },
-    },
-};
-//# sourceMappingURL=PageActionsDefinition.js.map

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

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

package/api/components/schemas/PageDefinition.js

@@ -1,26 +0,0 @@
-import { BasePageDefinition } from './BasePageDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const PageDefinition = extendJSONSchema(BasePageDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    description: `The list of blocks that are displayed on the page.
-
-Each page requires at least one block. Blocks are displayed in the order that they are defined in
-the list.
-`,
-    required: ['blocks'],
-    properties: {
-        blocks: {
-            type: 'array',
-            minItems: 1,
-            description: 'The blocks that make up a page.',
-            items: {
-                $ref: '#/components/schemas/BlockDefinition',
-            },
-        },
-        actions: {
-            $ref: '#/components/schemas/PageActionsDefinition',
-        },
-    },
-});
-//# sourceMappingURL=PageDefinition.js.map

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

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

package/api/components/schemas/RemapperDefinition.js

@@ -1,27 +0,0 @@
-export const RemapperDefinition = {
-    anyOf: [
-        {
-            type: 'boolean',
-            description: 'A boolean remapper is always returned directly.',
-        },
-        {
-            enum: [null],
-            description: 'A null remapper is always returned directly.',
-        },
-        {
-            type: 'number',
-            description: 'A numeric remapper is always returned directly.',
-        },
-        {
-            type: 'string',
-            description: 'A string remapper is always returned directly.',
-        },
-        {
-            $ref: '#/components/schemas/ObjectRemapperDefinition',
-        },
-        {
-            $ref: '#/components/schemas/ArrayRemapperDefinition',
-        },
-    ],
-};
-//# sourceMappingURL=RemapperDefinition.js.map

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

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