@appsemble/utils 0.33.5 → 0.33.9

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

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

package/api/components/schemas/ResourceSubscriptionToggleActionDefinition.js

@@ -1,23 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceSubscriptionToggleActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.subscription.toggle'],
-            description: 'Toggle whether or not to receive notifications on resource modifications.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to toggle the subscription state for.',
-        },
-        action: {
-            enum: ['create', 'delete', 'update'],
-            description: 'The resource action type to toggle the subscription state for.',
-            default: 'update',
-        },
-    },
-});
-//# sourceMappingURL=ResourceSubscriptionToggleActionDefinition.js.map

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

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

package/api/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition.js

@@ -1,23 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceSubscriptionUnsubscribeActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.subscription.unsubscribe'],
-            description: 'Unsubscribe from notifications on resource modifications.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to unsubscribe from.',
-        },
-        action: {
-            enum: ['create', 'delete', 'update'],
-            description: 'The resource action type to unsubscribe from.',
-            default: 'update',
-        },
-    },
-});
-//# sourceMappingURL=ResourceSubscriptionUnsubscribeActionDefinition.js.map

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

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

package/api/components/schemas/ResourceUpdateActionDefinition.js

@@ -1,18 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceUpdateActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.update'],
-            description: 'Update a resource.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to update.',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceUpdateActionDefinition.js.map

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

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

package/api/components/schemas/ResourceUpdatePositionsActionDefinition.js

@@ -1,21 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceUpdatePositionsActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.update.positions'],
-            description: 'Update the position of a resource.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to update.',
-        },
-        id: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceUpdatePositionsActionDefinition.js.map

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

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

package/api/components/schemas/ResourceViewDefinition.js

@@ -1,24 +0,0 @@
-export const ResourceViewDefinition = {
-    type: 'object',
-    minProperties: 1,
-    description: 'Alternative views of a resource that are modified using remappers and support different sets of roles.',
-    additionalProperties: {
-        type: 'object',
-        additionalProperties: false,
-        description: 'A custom view for a resource.',
-        properties: {
-            roles: {
-                type: 'array',
-                description: 'The list of roles that are allowed to use this view.',
-                items: {
-                    type: 'string',
-                },
-            },
-            remap: {
-                $ref: '#/components/schemas/RemapperDefinition',
-                description: 'The modified view.',
-            },
-        },
-    },
-};
-//# sourceMappingURL=ResourceViewDefinition.js.map

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

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

package/api/components/schemas/SecurityCronDefinition.js

@@ -1,26 +0,0 @@
-export const SecurityCronDefinition = {
-    type: 'object',
-    description: 'This describes the permissions that unauthenticated users have.',
-    additionalProperties: false,
-    properties: {
-        inherits: {
-            type: 'array',
-            minItems: 1,
-            description: `The name of the role to inherit from.
-
-Note that this role must exist.
-`,
-            items: {
-                type: 'string',
-            },
-        },
-        permissions: {
-            type: 'array',
-            description: 'Specific permissions within the app, which unauthenticated users should have',
-            items: {
-                type: 'string',
-            },
-        },
-    },
-};
-//# sourceMappingURL=SecurityCronDefinition.js.map

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

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

package/api/components/schemas/SecurityDefaultDefinition.js

@@ -1,34 +0,0 @@
-export const SecurityDefaultDefinition = {
-    type: 'object',
-    required: ['role'],
-    description: 'The default role to apply to members.',
-    additionalProperties: false,
-    properties: {
-        policy: {
-            enum: ['everyone', 'organization', 'invite'],
-            default: 'everyone',
-            description: `How the \`default\` role gets applied to users.
-
-The following values are allowed:
-- \`everyone\`: Every authenticated user gets the default role.
-- \`organization\`: Every authenticated user gets the default role if they are in the same organization as the app.
-- \`invite\`: The app member has to be invited to the app with a specific role.
-
-> **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the
-> app, you must set the policy to \`everyone\`. This will specifically allow every configured
-> authentication method on the secrets page to be used as login method. If you do not want other
-> Appsemble user accounts to be able to log in, you must \`disable\` the \`appsemble login\` options
-> (including the Appsemble OAuth2 option) in the secrets page. If this option is enabled, any
-> Appsemble user account is able to log in to the app and will receive the default role.
-`,
-        },
-        role: {
-            type: 'string',
-            description: `The default role to apply to members.
-
-This must match with one of the roles defined within the security definition.
-`,
-        },
-    },
-};
-//# sourceMappingURL=SecurityDefaultDefinition.js.map

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

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

package/api/components/schemas/SecurityDefinition.js

@@ -1,17 +0,0 @@
-export const SecurityDefinition = {
-    type: 'object',
-    description: 'This describes how the app is secured.',
-    additionalProperties: false,
-    properties: {
-        default: { $ref: '#/components/schemas/SecurityDefaultDefinition' },
-        guest: { $ref: '#/components/schemas/SecurityGuestDefinition' },
-        cron: { $ref: '#/components/schemas/SecurityCronDefinition' },
-        roles: {
-            type: 'object',
-            description: 'This property defines the app roles that are available within the app.',
-            minProperties: 1,
-            additionalProperties: { $ref: '#/components/schemas/SecurityRoleDefinition' },
-        },
-    },
-};
-//# sourceMappingURL=SecurityDefinition.js.map

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

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

package/api/components/schemas/SecurityGuestDefinition.js

@@ -1,26 +0,0 @@
-export const SecurityGuestDefinition = {
-    type: 'object',
-    description: 'This describes the permissions that unauthenticated users have.',
-    additionalProperties: false,
-    properties: {
-        inherits: {
-            type: 'array',
-            minItems: 1,
-            description: `The name of the role to inherit from.
-
-Note that this role must exist.
-`,
-            items: {
-                type: 'string',
-            },
-        },
-        permissions: {
-            type: 'array',
-            description: 'Specific permissions within the app, which unauthenticated users should have',
-            items: {
-                type: 'string',
-            },
-        },
-    },
-};
-//# sourceMappingURL=SecurityGuestDefinition.js.map

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

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

package/api/components/schemas/SecurityRoleDefinition.js

@@ -1,35 +0,0 @@
-export const SecurityRoleDefinition = {
-    type: 'object',
-    description: 'This describes a security role.',
-    additionalProperties: false,
-    properties: {
-        description: {
-            type: 'string',
-            description: 'The description of the role.',
-        },
-        defaultPage: {
-            type: 'string',
-            description: 'The default page to redirect users with this role to.',
-        },
-        inherits: {
-            type: 'array',
-            minItems: 1,
-            description: `The name of the role to inherit from.
-
-Note that this role must exist and can not inherit itself via this field or the \`inherits\` field
-of the referenced role.
-`,
-            items: {
-                type: 'string',
-            },
-        },
-        permissions: {
-            type: 'array',
-            description: 'Specific permissions within the app, which this role should have',
-            items: {
-                type: 'string',
-            },
-        },
-    },
-};
-//# sourceMappingURL=SecurityRoleDefinition.js.map

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

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

package/api/components/schemas/ShareActionDefinition.js

@@ -1,30 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ShareActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['share'],
-            description: `The \`share\` action can be used to display a prompt that allows the user to share something with others, primarily via social media.
-
-Depending on whether the user’s browser supports a native share function it will either display a
-native dialog for sharing links, or display a more limited fallback in a dialog.
-`,
-        },
-        url: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The url that is being shared.',
-        },
-        title: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The title that should be shared.',
-        },
-        text: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The main body that should be shared.',
-        },
-    },
-});
-//# sourceMappingURL=ShareActionDefinition.js.map

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

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

package/api/components/schemas/StaticActionDefinition.js

@@ -1,20 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StaticActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'value'],
-    properties: {
-        type: {
-            enum: ['static'],
-            description: `The \`static\` action returns static data defined in the action definition.
-
-This is useful for example for stubbing data.
-`,
-        },
-        value: {
-            description: 'The static value to return.',
-        },
-    },
-});
-//# sourceMappingURL=StaticActionDefinition.js.map

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

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

package/api/components/schemas/StorageAppendActionDefinition.js

@@ -1,43 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageAppendActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key', 'value'],
-    properties: {
-        type: {
-            enum: ['storage.append'],
-            description: `Append data to an existing array in storage.
-      If the storage entry is a single object, it turns it into an array to append the data on.
-
-For example:
-\`\`\`yaml
-type: storage.append
-key: temp
-value: { root }
-storage: localStorage
-remapBefore:
-  object.from:
-    text:
-      This is a new data item
-    value:
-      1
-\`\`\`
-`,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry.',
-        },
-        value: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The data to write on top of the storage entry.',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to store the data.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageAppendActionDefinition.js.map

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

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

package/api/components/schemas/StorageDeleteActionDefinition.js

@@ -1,31 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageDeleteActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key'],
-    properties: {
-        type: {
-            enum: ['storage.delete'],
-            description: `Delete the item that is stored at the specified key.
-
-For example:
-\`\`\`yaml
-type: storage.delete
-key: temp
-storage: localStorage
-\`\`\`
-      `,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry to remove.',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to remove the data from.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageDeleteActionDefinition.js.map

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

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

package/api/components/schemas/StorageReadActionDefinition.js

@@ -1,32 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageReadActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key'],
-    properties: {
-        type: {
-            enum: ['storage.read'],
-            description: `Read data from the app’s local storage.
-
-For example:
-\`\`\`yaml
-type: storage.read
-key: temp
-storage: localStorage
-\`\`\`
-
-      `,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry.',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to read the data from.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageReadActionDefinition.js.map

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

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

package/api/components/schemas/StorageSubtractActionDefinition.js

@@ -1,35 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageSubtractActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key'],
-    properties: {
-        type: {
-            enum: ['storage.subtract'],
-            description: `Subtract last item from a storage entry.
-
-If the entry consists of only one item, turns it into a singular object.
-
-If the entry is a single item, the entry is removed entirely.
-
-For example:
-\`\`\`yaml
-type: storage.subtract
-key: temp
-storage: localStorage
-\`\`\`
-        `,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry.',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to read the data from.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageSubtractActionDefinition.js.map

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

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

package/api/components/schemas/StorageUpdateActionDefinition.js

@@ -1,46 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageUpdateActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key', 'value'],
-    properties: {
-        type: {
-            enum: ['storage.update'],
-            description: `Update an existing item in storage, or update an item inside a stored array.
-
-For example:
-\`\`\`yaml
-type: storage.update
-key: temp
-item: 1
-value: { root }
-storage: localStorage
-remapBefore:
-  object.from:
-    text: { prop: text }
-    value: { prop: value }
-    newField: "New field"
-\`\`\`
-      `,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry.',
-        },
-        item: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the item in an array to update.',
-        },
-        value: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The data to update the specified item with.',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to store the data.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageUpdateActionDefinition.js.map

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

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

package/api/components/schemas/StorageWriteActionDefinition.js

@@ -1,46 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const StorageWriteActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'key', 'value'],
-    properties: {
-        type: {
-            enum: ['storage.write'],
-            description: `Write data to the app’s local storage.
-
-For example:
-\`\`\`yaml
-type: storage.write
-key: temp
-value: { root }
-storage: localStorage
-remapBefore:
-  object.from:
-    data:
-      cool data
-    value:
-      1
-\`\`\`
-      `,
-        },
-        key: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The key of the storage entry.',
-        },
-        value: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'The data to write to the storage entry.',
-        },
-        expiry: {
-            enum: ['1d', '3d', '7d', '12h'],
-            description: 'Set an expiry for your data, only works with the localStorage',
-        },
-        storage: {
-            enum: ['indexedDB', 'localStorage', 'sessionStorage', 'appStorage'],
-            description: 'The mechanism used to store the data.',
-            default: 'indexedDB',
-        },
-    },
-});
-//# sourceMappingURL=StorageWriteActionDefinition.js.map

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

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