@appsemble/utils 0.20.9 → 0.20.12

package/api/components/schemas/BlockVersion.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockVersion = void 0;
+const constants_1 = require("../../../constants");
+exports.BlockVersion = {
+    type: 'object',
+    description: `A version of a block definition
+
+Block versions can’t be updated or deleted. This ensures apps that use a block version can never
+be broken by alterations of block definitions.
+`,
+    required: ['name', 'version', 'files'],
+    additionalProperties: false,
+    properties: {
+        name: {
+            type: 'string',
+            readOnly: true,
+            description: `The name of a block.
+
+This uses the same form as scoped npm packages. For example, \`@appsemble/form\`.
+`,
+            pattern: `^@${constants_1.partialNormalized.source}/${constants_1.partialNormalized.source}$`,
+        },
+        description: {
+            type: 'string',
+            description: 'The description of the block.',
+            maxLength: 160,
+        },
+        longDescription: {
+            type: 'string',
+            description: 'The long description of the block.',
+        },
+        icon: {
+            type: 'string',
+            format: 'binary',
+            description: 'An icon to represent the block in Appsemble studio.',
+        },
+        iconUrl: {
+            type: 'string',
+            format: 'uri',
+            description: 'The relative URL on which the icon is served',
+            readOnly: true,
+        },
+        version: {
+            type: 'string',
+            pattern: constants_1.semver.source,
+            description: 'A [semver](https://semver.org) representation of the block version.',
+        },
+        visibility: {
+            enum: ['public', 'unlisted'],
+            default: 'public',
+            description: `Whether the block should be listed publicly for users who aren’t part of the block’s organization.
+
+- **\`public\`**: The block is visible for everyone.
+- **\`unlisted\`**: The block will only be visible if the user is logged in and is part of the block’s organization.`,
+        },
+        layout: {
+            description: `How the block will be displayed on the screen.
+
+- **\`float\`**: The block will float somewhere on the screen.
+- **\`grow\`**: The block will be positioned in the main page. It will grow to fill up remaining
+  space on the page.
+- **\`static\`**: The block will be positioned in the main page. It will take up a fixed amount of
+  space.
+- **\`hidden\`**: The block will not be rendered at all.
+`,
+            default: 'grow',
+            enum: ['float', 'grow', 'static', 'hidden'],
+        },
+        actions: {
+            type: 'object',
+            description: `An object which describes the actions a block can trigger.
+
+This will be used to validate app definitions.
+`,
+            additionalProperties: true,
+        },
+        parameters: {
+            $ref: '#/components/schemas/JSONSchemaRoot',
+            description: `A draft 7 JSON schema to use for block parameter validation.
+
+If the parameters of a block definition don’t conform to this schema, the app definition will be
+considered invalid.
+`,
+        },
+        events: {
+            type: 'object',
+            description: 'An object describing the names of the events the block can listen and emit to.',
+            additionalProperties: false,
+            properties: {
+                listen: {
+                    type: 'object',
+                    description: 'A mapping of events this block may listen on',
+                    additionalProperties: {
+                        description: 'A mapping of events this block may listen on',
+                        type: 'object',
+                        additionalProperties: false,
+                        properties: { description: { type: 'string' } },
+                    },
+                },
+                emit: {
+                    type: 'object',
+                    description: 'A mapping of events this block may emit',
+                    additionalProperties: {
+                        description: 'A mapping of events this block may emit',
+                        type: 'object',
+                        additionalProperties: false,
+                        properties: { description: { type: 'string' } },
+                    },
+                },
+            },
+        },
+        resources: {
+            type: 'object',
+            description: 'deprecated',
+            additionalProperties: true,
+        },
+        messages: {
+            type: 'object',
+            description: `The translated messages for the block.
+
+English (\`en\`) messages are required.
+`,
+            required: ['en'],
+            properties: {
+                en: {
+                    type: 'object',
+                    description: 'A mapping of language IDs to their English translation',
+                    additionalProperties: {
+                        type: 'string',
+                        description: 'The default translations to use.',
+                        minLength: 1,
+                    },
+                },
+            },
+            additionalProperties: {
+                type: 'object',
+                description: 'A mapping of language IDs to their internationalized translation',
+                additionalProperties: {
+                    type: 'string',
+                    description: 'The translated messages for this language.',
+                },
+            },
+        },
+        files: {
+            type: 'array',
+            description: 'A list of file assets that belong to the app version.',
+            minLength: 1,
+            items: {
+                type: 'string',
+                format: 'binary',
+            },
+        },
+        examples: {
+            type: 'array',
+            description: 'A list of exmples how the block can be used within an app definition.',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+};
+//# sourceMappingURL=BlockVersion.js.map

package/api/components/schemas/BlockVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlockVersion.js","sourceRoot":"","sources":["BlockVersion.ts"],"names":[],"mappings":";;;AAEA,kDAA+D;AAElD,QAAA,YAAY,GAAmC;IAC1D,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE;;;;CAId;IACC,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;IACtC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE;;;CAGlB;YACK,OAAO,EAAE,KAAK,6BAAiB,CAAC,MAAM,IAAI,6BAAiB,CAAC,MAAM,GAAG;SACtE;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;YAC5C,SAAS,EAAE,GAAG;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;SAClD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,qDAAqD;SACnE;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,8CAA8C;YAC3D,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAM,CAAC,MAAM;YACtB,WAAW,EAAE,qEAAqE;SACnF;QACD,UAAU,EAAE;YACV,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;YAC5B,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE;;;qHAGkG;SAChH;QACD,MAAM,EAAE;YACN,WAAW,EAAE;;;;;;;;CAQlB;YACK,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;SAC5C;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;YACK,oBAAoB,EAAE,IAAI;SAC3B;QACD,UAAU,EAAE;YACV,IAAI,EAAE,qCAAqC;YAC3C,WAAW,EAAE;;;;CAIlB;SACI;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gFAAgF;YAC7F,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,8CAA8C;oBAC3D,oBAAoB,EAAE;wBACpB,WAAW,EAAE,8CAA8C;wBAC3D,IAAI,EAAE,QAAQ;wBACd,oBAAoB,EAAE,KAAK;wBAC3B,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;qBAChD;iBACF;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,yCAAyC;oBACtD,oBAAoB,EAAE;wBACpB,WAAW,EAAE,yCAAyC;wBACtD,IAAI,EAAE,QAAQ;wBACd,oBAAoB,EAAE,KAAK;wBAC3B,UAAU,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;qBAChD;iBACF;aACF;SACF;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,YAAY;YACzB,oBAAoB,EAAE,IAAI;SAC3B;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;YACK,QAAQ,EAAE,CAAC,IAAI,CAAC;YAChB,UAAU,EAAE;gBACV,EAAE,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wDAAwD;oBACrE,oBAAoB,EAAE;wBACpB,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,kCAAkC;wBAC/C,SAAS,EAAE,CAAC;qBACb;iBACF;aACF;YACD,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,kEAAkE;gBAC/E,oBAAoB,EAAE;oBACpB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4CAA4C;iBAC1D;aACF;SACF;QACD,KAAK,EAAE;YACL,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,uDAAuD;YACpE,SAAS,EAAE,CAAC;YACZ,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;aACjB;SACF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,uEAAuE;YACpF,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC"}

package/api/components/schemas/BlockVersion.ts

@@ -0,0 +1,162 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+import { partialNormalized, semver } from '../../../constants';
+
+export const BlockVersion: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: `A version of a block definition
+
+Block versions can’t be updated or deleted. This ensures apps that use a block version can never
+be broken by alterations of block definitions.
+`,
+  required: ['name', 'version', 'files'],
+  additionalProperties: false,
+  properties: {
+    name: {
+      type: 'string',
+      readOnly: true,
+      description: `The name of a block.
+
+This uses the same form as scoped npm packages. For example, \`@appsemble/form\`.
+`,
+      pattern: `^@${partialNormalized.source}/${partialNormalized.source}$`,
+    },
+    description: {
+      type: 'string',
+      description: 'The description of the block.',
+      maxLength: 160,
+    },
+    longDescription: {
+      type: 'string',
+      description: 'The long description of the block.',
+    },
+    icon: {
+      type: 'string',
+      format: 'binary',
+      description: 'An icon to represent the block in Appsemble studio.',
+    },
+    iconUrl: {
+      type: 'string',
+      format: 'uri',
+      description: 'The relative URL on which the icon is served',
+      readOnly: true,
+    },
+    version: {
+      type: 'string',
+      pattern: semver.source,
+      description: 'A [semver](https://semver.org) representation of the block version.',
+    },
+    visibility: {
+      enum: ['public', 'unlisted'],
+      default: 'public',
+      description: `Whether the block should be listed publicly for users who aren’t part of the block’s organization.
+
+- **\`public\`**: The block is visible for everyone.
+- **\`unlisted\`**: The block will only be visible if the user is logged in and is part of the block’s organization.`,
+    },
+    layout: {
+      description: `How the block will be displayed on the screen.
+
+- **\`float\`**: The block will float somewhere on the screen.
+- **\`grow\`**: The block will be positioned in the main page. It will grow to fill up remaining
+  space on the page.
+- **\`static\`**: The block will be positioned in the main page. It will take up a fixed amount of
+  space.
+- **\`hidden\`**: The block will not be rendered at all.
+`,
+      default: 'grow',
+      enum: ['float', 'grow', 'static', 'hidden'],
+    },
+    actions: {
+      type: 'object',
+      description: `An object which describes the actions a block can trigger.
+
+This will be used to validate app definitions.
+`,
+      additionalProperties: true,
+    },
+    parameters: {
+      $ref: '#/components/schemas/JSONSchemaRoot',
+      description: `A draft 7 JSON schema to use for block parameter validation.
+
+If the parameters of a block definition don’t conform to this schema, the app definition will be
+considered invalid.
+`,
+    },
+    events: {
+      type: 'object',
+      description: 'An object describing the names of the events the block can listen and emit to.',
+      additionalProperties: false,
+      properties: {
+        listen: {
+          type: 'object',
+          description: 'A mapping of events this block may listen on',
+          additionalProperties: {
+            description: 'A mapping of events this block may listen on',
+            type: 'object',
+            additionalProperties: false,
+            properties: { description: { type: 'string' } },
+          },
+        },
+        emit: {
+          type: 'object',
+          description: 'A mapping of events this block may emit',
+          additionalProperties: {
+            description: 'A mapping of events this block may emit',
+            type: 'object',
+            additionalProperties: false,
+            properties: { description: { type: 'string' } },
+          },
+        },
+      },
+    },
+    resources: {
+      type: 'object',
+      description: 'deprecated',
+      additionalProperties: true,
+    },
+    messages: {
+      type: 'object',
+      description: `The translated messages for the block.
+
+English (\`en\`) messages are required.
+`,
+      required: ['en'],
+      properties: {
+        en: {
+          type: 'object',
+          description: 'A mapping of language IDs to their English translation',
+          additionalProperties: {
+            type: 'string',
+            description: 'The default translations to use.',
+            minLength: 1,
+          },
+        },
+      },
+      additionalProperties: {
+        type: 'object',
+        description: 'A mapping of language IDs to their internationalized translation',
+        additionalProperties: {
+          type: 'string',
+          description: 'The translated messages for this language.',
+        },
+      },
+    },
+    files: {
+      type: 'array',
+      description: 'A list of file assets that belong to the app version.',
+      minLength: 1,
+      items: {
+        type: 'string',
+        format: 'binary',
+      },
+    },
+    examples: {
+      type: 'array',
+      description: 'A list of exmples how the block can be used within an app definition.',
+      items: {
+        type: 'string',
+      },
+    },
+  },
+};

package/api/components/schemas/ConditionActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConditionActionDefinition.js","sourceRoot":"","sources":["ConditionActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,yBAAyB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC9E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC;IACxB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,WAAW,EAAE,mDAAmD;SACjE;QACD,EAAE,EAAE;YACF,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE;;;;CAIlB;SACI;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,mEAAmE;YAChF,IAAI,EAAE,uCAAuC;SAC9C;QACD,IAAI,EAAE;YACJ,WAAW,EAAE,kEAAkE;YAC/E,IAAI,EAAE,uCAAuC;SAC9C;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/ConditionActionDefinition.ts

@@ -0,0 +1,30 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const ConditionActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'if'],
+  properties: {
+    type: {
+      enum: ['condition'],
+      description: 'Run another action if a certain contition is met.',
+    },
+    if: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: `A remapper to determine the condition to check.
+
+If this yields a truthy value, the \`then\` action is called. Otherwise the \`else\` action is
+called.
+`,
+    },
+    then: {
+      description: 'This action is called if the `if` remapper yields a truthy value.',
+      $ref: '#/components/schemas/ActionDefinition',
+    },
+    else: {
+      description: 'This action is called if the `if` remapper yields a falsy value.',
+      $ref: '#/components/schemas/ActionDefinition',
+    },
+  },
+});

package/api/components/schemas/CronDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CronDefinition.js","sourceRoot":"","sources":["CronDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAmC;IAC5D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,WAAW,EAAE,mFAAmF;IAChG,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,WAAW,EAAE;;;CAGlB;YACK,IAAI,EAAE,QAAQ;SACf;QACD,MAAM,EAAE;YACN,WAAW,EAAE,kDAAkD;YAC/D,IAAI,EAAE,uCAAuC;SAC9C;KACF;CACF,CAAC"}

package/api/components/schemas/CronDefinition.ts

@@ -0,0 +1,21 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const CronDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  required: ['schedule'],
+  description: 'A cron definition defines tasks that Appsemble will run periodically for the app.',
+  additionalProperties: false,
+  properties: {
+    schedule: {
+      description: `A crontab string to define when the action should be run.
+
+See [Crontab guru](https://crontab.guru) for details
+`,
+      type: 'string',
+    },
+    action: {
+      description: 'The action to run when the cronjob is triggered.',
+      $ref: '#/components/schemas/ActionDefinition',
+    },
+  },
+};

package/api/components/schemas/CustomFontDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFontDefinition.js","sourceRoot":"","sources":["CustomFontDefinition.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAmC;IAClE,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,2BAA2B;IACxC,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC9B,UAAU,EAAE;QACV,MAAM,EAAE;YACN,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,CAAC,QAAQ,CAAC;SACjB;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC"}

package/api/components/schemas/CustomFontDefinition.ts

@@ -0,0 +1,21 @@
+import { OpenAPIV3 } from 'openapi-types';
+
+export const CustomFontDefinition: OpenAPIV3.NonArraySchemaObject = {
+  type: 'object',
+  description: 'A custom font definition.',
+  additionalProperties: false,
+  required: ['source', 'family'],
+  properties: {
+    source: {
+      description: 'Use a custom font.',
+      enum: ['custom'],
+    },
+    family: {
+      type: 'string',
+      description: `The font family to use in the app.
+
+Make sure the font is available using custom CSS.
+`,
+    },
+  },
+};

package/api/components/schemas/DialogActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DialogActionDefinition.js","sourceRoot":"","sources":["DialogActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,sBAAsB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC3E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,WAAW,EAAE;;;;;CAKlB;SACI;QACD,KAAK,EAAE;YACL,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,yCAAyC;SAChD;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACT,iGAAiG;SACpG;QACD,UAAU,EAAE;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACT,2FAA2F;SAC9F;QACD,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,EAAE,IAAI,EAAE,sCAAsC,EAAE;SACxD;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/DialogActionDefinition.ts

@@ -0,0 +1,40 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const DialogActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'blocks'],
+  properties: {
+    type: {
+      enum: ['dialog'],
+      description: `This action opens a pop-up dialog that can be used to seamlessly transition to a new set of blocks temporarily.
+
+Dialogs can be closed by calling the [\`dialog.ok\`](#DialogOkActionDefinition) or
+[\`dialog.error\`](#DialogErrorActionDefinition). Users can still manually close dialogs, which
+should be supported by the app.
+`,
+    },
+    title: {
+      description: 'An optional title to set in the dialog header.',
+      $ref: '#/components/schemas/RemapperDefinition',
+    },
+    closable: {
+      type: 'boolean',
+      default: true,
+      description:
+        'Whether users are allowed to close the dialog by clicking outside of it or on the close button.',
+    },
+    fullscreen: {
+      type: 'boolean',
+      default: false,
+      description:
+        'Whether the dialog should be displayed full screen as if it’s a new page, or as a pop-up.',
+    },
+    blocks: {
+      type: 'array',
+      description: 'A list of blocks to display in the dialog.',
+      items: { $ref: '#/components/schemas/BlockDefinition' },
+    },
+  },
+});

package/api/components/schemas/DialogErrorActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DialogErrorActionDefinition.js","sourceRoot":"","sources":["DialogErrorActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,2BAA2B,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAChF,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,cAAc,CAAC;YACtB,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/DialogErrorActionDefinition.ts

@@ -0,0 +1,17 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const DialogErrorActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['dialog.error'],
+      description: `Close an open dialog.
+
+The dialog action that opened the dialog will be rejected with the data passed to this action.
+`,
+    },
+  },
+});

package/api/components/schemas/DialogOkActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DialogOkActionDefinition.js","sourceRoot":"","sources":["DialogOkActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,wBAAwB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC7E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,WAAW,EAAE;;;CAGlB;SACI;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/DialogOkActionDefinition.ts

@@ -0,0 +1,17 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const DialogOkActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type'],
+  properties: {
+    type: {
+      enum: ['dialog.ok'],
+      description: `Close an open dialog.
+
+The dialog action that opened the dialog will be rejected with the data passed to this action.
+`,
+    },
+  },
+});

package/api/components/schemas/DownloadActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadActionDefinition.js","sourceRoot":"","sources":["DownloadActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,wBAAwB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC7E,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,WAAW,EAAE,8BAA8B;SAC5C;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uEAAuE;YACpF,OAAO,EAAE,KAAK;SACf;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/DownloadActionDefinition.ts

@@ -0,0 +1,19 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const DownloadActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  required: ['type', 'filename'],
+  additionalProperties: false,
+  properties: {
+    type: {
+      enum: ['download'],
+      description: 'Download the data as a file.',
+    },
+    filename: {
+      type: 'string',
+      description: 'The filename to save the file as. This must include a file extension.',
+      pattern: '\\.',
+    },
+  },
+});

package/api/components/schemas/EmailActionDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EmailActionDefinition.js","sourceRoot":"","sources":["EmailActionDefinition.ts"],"names":[],"mappings":";;;AAAA,iEAA8D;AAC9D,mCAA2C;AAE9B,QAAA,qBAAqB,GAAG,IAAA,wBAAgB,EAAC,2CAAoB,EAAE;IAC1E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC;IACrC,UAAU,EAAE;QACV,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,WAAW,EAAE;;;CAGlB;SACI;QACD,EAAE,EAAE;YACF,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EACT,8HAA8H;SACjI;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,sCAAsC;SACpD;QACD,EAAE,EAAE;YACF,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EACT,2JAA2J;SAC9J;QACD,GAAG,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EACT,4JAA4J;SAC/J;QACD,OAAO,EAAE;YACP,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,2BAA2B;SACzC;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EACT,gGAAgG;SACnG;QACD,WAAW,EAAE;YACX,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE;;;;;;;;;iEAS8C;SAC5D;KACF;CACF,CAAC,CAAC"}

package/api/components/schemas/EmailActionDefinition.ts

@@ -0,0 +1,58 @@
+import { BaseActionDefinition } from './BaseActionDefinition';
+import { extendJSONSchema } from './utils';
+
+export const EmailActionDefinition = extendJSONSchema(BaseActionDefinition, {
+  type: 'object',
+  additionalProperties: false,
+  required: ['type', 'subject', 'body'],
+  properties: {
+    type: {
+      enum: ['email'],
+      description: `The email action can be used to send emails via the Appsemble server.
+
+If \`to\`, \`cc\`, and \`bcc\` all end up being empty, no emails will be sent but the action will still continue as normal.
+`,
+    },
+    to: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description:
+        'The address the email should be sent to. Can be either in the format of `test@example.com`, or `John Doe <test@example.com>`',
+    },
+    from: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The name of the sender of the email.',
+    },
+    cc: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description:
+        'The list of additional email addresses email should be sent to. Uses the same format as `to`. Every email address in the CC is visible to all recipients.',
+    },
+    bcc: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description:
+        'The list of additional email addresses email should be sent to. Uses the same format as `to`. Email addresses in the BCC are hidden from other recipients.',
+    },
+    subject: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: 'The subject of the email.',
+    },
+    body: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description:
+        'The body of the email. The content of the body is converted to HTML using the Markdown syntax.',
+    },
+    attachments: {
+      $ref: '#/components/schemas/RemapperDefinition',
+      description: `The attachments to include in the email.
+
+The remapper must resolve to an object containing the following properties:
+
+- \`target\`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with \`content\`.
+- \`content\`: The raw content to include as the file content. This is mutually exclusive with \`target\`.
+- \`filename\`: The filename to include the attachment as.
+- \`accept\` If the target is a URL, this will be set as the HTTP \`Accept\` header when downloading the file.
+
+If the attachment is a string, it will be treated as the target.`,
+    },
+  },
+});

package/api/components/schemas/Error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.js","sourceRoot":"","sources":["Error.ts"],"names":[],"mappings":";;;AAEa,QAAA,KAAK,GAAmC;IACnD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,+DAA+D;IAC5E,QAAQ,EAAE,IAAI;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE,GAAG;SACb;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+CAA+C;YAC5D,OAAO,EAAE,WAAW;SACrB;QACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iCAAiC;YAC9C,OAAO,EAAE,kBAAkB;SAC5B;KACF;CACF,CAAC"}