@appsemble/lang-sdk 0.33.7

package/schemas/actions/EachActionDefinition.js

@@ -0,0 +1,26 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const EachActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'do'],
+    properties: {
+        type: {
+            enum: ['each'],
+            description: `Run an action for each entry in an array.
+
+The actions are run in parallel.
+
+If the input is not an array, the action will be applied to the input instead.`,
+        },
+        serial: {
+            description: 'Runs the action in series instead of parallel',
+            type: 'boolean',
+        },
+        do: {
+            description: 'This action is called for each item in the input array.',
+            $ref: '#/components/schemas/ActionDefinition',
+        },
+    },
+});
+//# sourceMappingURL=EachActionDefinition.js.map

package/schemas/actions/EmailActionDefinition.d.ts

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

package/schemas/actions/EmailActionDefinition.js

@@ -0,0 +1,54 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+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.`,
+        },
+    },
+});
+//# sourceMappingURL=EmailActionDefinition.js.map

package/schemas/actions/EventActionDefinition.d.ts

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

package/schemas/actions/EventActionDefinition.js

@@ -0,0 +1,27 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const EventActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'event'],
+    properties: {
+        type: {
+            enum: ['event'],
+            description: `This action allows for other blocks to emit data upon triggering the action.
+
+This can be used to make blocks interact with each other, such as triggering the \`data-loader\`
+block to refresh itself by sending an event action that matches the name of what the block is
+listening to.
+`,
+        },
+        event: {
+            type: 'string',
+            description: 'The name of the event to emit.',
+        },
+        waitFor: {
+            type: 'string',
+            description: 'If specified, the action will wait for this event to have been emitted and respond with its data.',
+        },
+    },
+});
+//# sourceMappingURL=EventActionDefinition.js.map

package/schemas/actions/FlowBackActionDefinition.d.ts

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

package/schemas/actions/FlowBackActionDefinition.js

@@ -0,0 +1,16 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const FlowBackActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['flow.back'],
+            description: `On [flow pages](#flow-page-definition-sub-pages), return to the previous page if
+it is present. If this is called on the first page, nothing happens.
+`,
+        },
+    },
+});
+//# sourceMappingURL=FlowBackActionDefinition.js.map

package/schemas/actions/FlowCancelActionDefinition.d.ts

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

package/schemas/actions/FlowCancelActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const FlowCancelActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['flow.cancel'],
+            description: "On [flow pages](../guides/page-types#flow-page), cancel the ongoing flow and invoke the page's [`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action.",
+        },
+    },
+});
+//# sourceMappingURL=FlowCancelActionDefinition.js.map

package/schemas/actions/FlowFinishActionDefinition.d.ts

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

package/schemas/actions/FlowFinishActionDefinition.js

@@ -0,0 +1,16 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const FlowFinishActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['flow.finish'],
+            description: `On [flow pages](../guides/page-types#flow-page), triggers the
+[\`onFlowFinish\`](#flow-page-actions-definition-on-flow-finish) action on the page.
+`,
+        },
+    },
+});
+//# sourceMappingURL=FlowFinishActionDefinition.js.map

package/schemas/actions/FlowNextActionDefinition.d.ts

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

package/schemas/actions/FlowNextActionDefinition.js

@@ -0,0 +1,17 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const FlowNextActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['flow.next'],
+            description: `On [flow pages](#flow-page-definition-sub-pages), proceed to the next page if it
+is present. Otherwise, the flow is considered to be complete and [\`flow.finish\`](#flowfinish) will
+be called instead.
+`,
+        },
+    },
+});
+//# sourceMappingURL=FlowNextActionDefinition.js.map

package/schemas/actions/FlowToActionDefinition.d.ts

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

package/schemas/actions/FlowToActionDefinition.js

@@ -0,0 +1,21 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const FlowToActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'step'],
+    properties: {
+        type: {
+            enum: ['flow.to'],
+            description: 'On [flow pages](#flow-page-definition-sub-pages), move to a specific step.',
+        },
+        step: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: `The name of the step to move to.
+
+This is a remapper which gets called with the action input and context.
+`,
+        },
+    },
+});
+//# sourceMappingURL=FlowToActionDefinition.js.map

package/schemas/actions/GroupMemberDeleteActionDefinition.d.ts

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

package/schemas/actions/GroupMemberDeleteActionDefinition.js

@@ -0,0 +1,18 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const GroupMemberDeleteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id'],
+    properties: {
+        type: {
+            enum: ['group.member.delete'],
+            description: 'Delete a group member from the group in which the invoking user is a member',
+        },
+        id: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'The id of the group member to delete',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberDeleteActionDefinition.js.map

package/schemas/actions/GroupMemberInviteActionDefinition.d.ts

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

package/schemas/actions/GroupMemberInviteActionDefinition.js

@@ -0,0 +1,26 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const GroupMemberInviteActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['group.member.invite'],
+            description: 'Invite an app member to join a group.',
+        },
+        id: {
+            description: 'The ID of the group to invite the app member to.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        email: {
+            description: 'The email address of the user to invite.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        role: {
+            description: 'The role to invite the user as.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberInviteActionDefinition.js.map

package/schemas/actions/GroupMemberQueryActionDefinition.d.ts

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

package/schemas/actions/GroupMemberQueryActionDefinition.js

@@ -0,0 +1,18 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const GroupMemberQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id'],
+    properties: {
+        type: {
+            enum: ['group.member.query'],
+            description: "Get a list of a group's members",
+        },
+        id: {
+            description: 'The ID of a specific group to get the members from',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberQueryActionDefinition.js.map

package/schemas/actions/GroupMemberRoleUpdateActionDefinition.d.ts

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

package/schemas/actions/GroupMemberRoleUpdateActionDefinition.js

@@ -0,0 +1,22 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const GroupMemberRoleUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type', 'id', 'role'],
+    properties: {
+        type: {
+            enum: ['group.member.role.update'],
+            description: 'Update the role of a group member.',
+        },
+        id: {
+            description: 'The id of the group member to update the role of.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+        role: {
+            description: 'The new role of the group member.',
+            $ref: '#/components/schemas/RemapperDefinition',
+        },
+    },
+});
+//# sourceMappingURL=GroupMemberRoleUpdateActionDefinition.js.map

package/schemas/actions/GroupQueryActionDefinition.d.ts

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

package/schemas/actions/GroupQueryActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.js';
+export const GroupQueryActionDefinition = extendJSONSchema(BaseActionDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    required: ['type'],
+    properties: {
+        type: {
+            enum: ['group.query'],
+            description: 'Get a list of all of the groups in an app.',
+        },
+    },
+});
+//# sourceMappingURL=GroupQueryActionDefinition.js.map

package/schemas/actions/LinkActionDefinition.d.ts

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

package/schemas/actions/LinkActionDefinition.js

@@ -0,0 +1,29 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/LinkBackActionDefinition.d.ts

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

package/schemas/actions/LinkBackActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/LinkNextActionDefinition.d.ts

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

package/schemas/actions/LinkNextActionDefinition.js

@@ -0,0 +1,14 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/LogActionDefinition.d.ts

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

package/schemas/actions/LogActionDefinition.js

@@ -0,0 +1,22 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/MatchActionDefinition.d.ts

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

package/schemas/actions/MatchActionDefinition.js

@@ -0,0 +1,35 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/MessageActionDefinition.d.ts

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

package/schemas/actions/MessageActionDefinition.js

@@ -0,0 +1,40 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/NoopActionDefinition.d.ts

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

package/schemas/actions/NoopActionDefinition.js

@@ -0,0 +1,17 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/NotifyActionDefinition.d.ts

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

package/schemas/actions/NotifyActionDefinition.js

@@ -0,0 +1,32 @@
+import { BaseActionDefinition } from './BaseActionDefinition.js';
+import { extendJSONSchema } from '../utils/extendJSONSchema.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/schemas/actions/RequestActionDefinition.d.ts

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