@appsemble/utils 0.33.5 → 0.33.7

package/api/components/schemas/RequestActionDefinition.js

@@ -1,75 +0,0 @@
-import { BaseActionDefinition } from './BaseActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const RequestActionDefinition = extendJSONSchema(BaseActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'url'],
-    properties: {
-        type: {
-            enum: ['request'],
-            description: `Performs an HTTP request.
-
-This can be used to call the Appsemble API or an external API in order to fetch data or send data.
-When sending \`POST\`, \`PUT\`, \`DELETE\` and \`PATCH\` calls the data that is currently available
-in the block gets passed through.
-
-If the content type of the request is \`text/xml\` or \`application/xml\`, the data will be
-converted to JSON.
-`,
-        },
-        url: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `A remapper that results in the URL to send the request to.
-
-Can be a relative URL (E.g. \`/api/health\`) for usage with the Appsemble API, or an absolute URL
-(E.g. \`https://example.com\`) for usage with external sites.`,
-        },
-        method: {
-            enum: ['delete', 'get', 'patch', 'post', 'put'],
-            default: 'get',
-            description: 'The type of request to make.',
-        },
-        query: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: 'A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.',
-        },
-        body: {
-            $ref: '#/components/schemas/RemapperDefinition',
-            description: `remapper that results in the request body to send.
-
-If not specified, the raw input data is used.
-`,
-        },
-        proxy: {
-            type: 'boolean',
-            default: true,
-            description: `By default requests will be proxied through the Appsemble API.
-
-This allows to protect user data and ensures
-[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
-disabled by setting this to \`false\`
-`,
-        },
-        schema: {
-            description: 'The name of the schema to validate against before submitting data.',
-            $ref: '#/components/schemas/JSONSchema',
-        },
-        headers: {
-            type: 'object',
-            description: 'The headers to be set for the outgoing request',
-            additionalProperties: false,
-            properties: {
-                'Content-Type': {
-                    description: 'Content type for the outgoing request',
-                    enum: [
-                        'application/xml',
-                        'text/plain',
-                        'application/x-www-form-urlencoded',
-                        'multipart/form-data',
-                    ],
-                },
-            },
-        },
-    },
-});
-//# sourceMappingURL=RequestActionDefinition.js.map

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

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

package/api/components/schemas/ResourceCountActionDefinition.js

@@ -1,22 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceCountActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.count'],
-            description: 'Count the number of resources a similar `resource.query` action would return.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to count.',
-        },
-        own: {
-            type: 'boolean',
-            description: 'If only the resources created by the authenticated app member should be included',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceCountActionDefinition.js.map

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

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

package/api/components/schemas/ResourceCreateActionDefinition.js

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

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

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

package/api/components/schemas/ResourceDefinition.js

@@ -1,263 +0,0 @@
-const query = {
-    type: 'object',
-    description: 'The query parameters to use in the request.',
-    additionalProperties: { type: 'string' },
-};
-const referenceActionTrigger = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'Defines the type of trigger and the cascading strategy for it',
-    required: ['type'],
-    properties: {
-        type: {
-            enum: ['create', 'update', 'delete'],
-        },
-        cascade: {
-            description: `Defines the cascading strategy.
-
-If 'update' is specified, the referencing property of the referencing resource is set to null.
-
-If 'delete' is specified, the referencing resource is deleted.
-
-If not specified, the referenced resource cannot be deleted
-without deleting the referencing resource first.`,
-            enum: ['update', 'delete'],
-        },
-    },
-};
-const referenceAction = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'Defines what happens when the specified action is executed on the referenced resource.',
-    properties: {
-        triggers: {
-            type: 'array',
-            items: referenceActionTrigger,
-            minItems: 1,
-            uniqueItems: true,
-        },
-    },
-};
-export const ResourceDefinition = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'A definition of how this resource works.',
-    required: ['schema'],
-    properties: {
-        expires: {
-            type: 'string',
-            description: `A time string representing when a resource should expire.
-
-Example: 1d 8h 30m
-`,
-            pattern: /^(\d+(y|yr|years))?\s*(\d+months)?\s*(\d+(w|wk|weeks))?\s*(\d+(d|days))?\s*(\d+(h|hr|hours))?\s*(\d+(m|min|minutes))?\s*(\d+(s|sec|seconds))?$/
-                .source,
-        },
-        clonable: {
-            type: 'boolean',
-            description: 'Whether the resource should be able to be transferred when cloning the app it belongs to',
-        },
-        schema: {
-            $ref: '#/components/schemas/JSONSchemaRoot',
-            description: 'JSON schema definitions that may be used by the app.',
-        },
-        references: {
-            type: 'object',
-            description: `References to other resources.
-
-The key is the property that references the other resource. The value is an object describing the
-name of the resource and how it should behave.
-`,
-            minProperties: 1,
-            additionalProperties: {
-                type: 'object',
-                description: 'A reference to between two resource types.',
-                additionalProperties: false,
-                properties: {
-                    resource: { type: 'string' },
-                    create: referenceAction,
-                    patch: referenceAction,
-                    update: referenceAction,
-                    delete: referenceAction,
-                },
-            },
-        },
-        positioning: {
-            type: 'boolean',
-            default: false,
-            description: 'Whether to enable position column for the instances of this resource. This is used for keeping an ordered list to enable custom sorting of the data using drag and drop features.',
-        },
-        enforceOrderingGroupByFields: {
-            type: 'array',
-            pattern: '^[a-zA-Z0-9]*$',
-            description: 'Group resources by fields when handling resource positions',
-            items: {
-                type: 'string',
-            },
-            minItems: 1,
-        },
-        url: {
-            type: 'string',
-            default: '/api/apps/{appId}/{resource}',
-            description: 'URL to use if not otherwise specified.',
-        },
-        id: {
-            type: 'string',
-            default: 'id',
-            description: 'Name of the field used when accessing singular entities.',
-        },
-        history: {
-            description: 'A definition of how versioning should happen for instances of this resource.',
-            default: false,
-            oneOf: [
-                {
-                    type: 'boolean',
-                    description: 'Setting this to `true` is the same as using an object with the property `data` set to `true`.',
-                },
-                { $ref: '#/components/schemas/ResourceHistoryDefinition' },
-            ],
-        },
-        query: {
-            type: 'object',
-            description: "Overrides for 'query' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'GET',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}',
-                    description: 'URL to use for this type of request.',
-                },
-            },
-        },
-        get: {
-            type: 'object',
-            description: "Overrides for 'get' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'GET',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/{id}',
-                    description: 'URL to use for this type of request.',
-                },
-            },
-        },
-        count: {
-            type: 'object',
-            description: "Overrides for 'count' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'GET',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/$count',
-                    description: 'URL to use for this type of request.',
-                },
-            },
-        },
-        create: {
-            type: 'object',
-            description: "Overrides for 'create' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'POST',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/{id}',
-                    description: 'URL to use for this type of request.',
-                },
-                hooks: {
-                    $ref: '#/components/schemas/ResourceHooksDefinition',
-                },
-            },
-        },
-        patch: {
-            type: 'object',
-            description: "Overrides for 'patch' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'PATCH',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/{id}',
-                    description: 'URL to use for this type of request.',
-                },
-                hooks: {
-                    $ref: '#/components/schemas/ResourceHooksDefinition',
-                },
-            },
-        },
-        update: {
-            type: 'object',
-            description: "Overrides for 'update' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'PUT',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/{id}',
-                    description: 'URL to use for this type of request.',
-                },
-                hooks: {
-                    $ref: '#/components/schemas/ResourceHooksDefinition',
-                },
-            },
-        },
-        delete: {
-            type: 'object',
-            description: "Overrides for 'delete' requests.",
-            additionalProperties: false,
-            properties: {
-                query,
-                method: {
-                    type: 'string',
-                    default: 'DELETE',
-                    description: 'HTTP method to use for this type of request.',
-                },
-                url: {
-                    type: 'string',
-                    default: '/api/apps/{appId}/{resource}/{id}',
-                    description: 'URL to use for this type of request.',
-                },
-                hooks: {
-                    $ref: '#/components/schemas/ResourceHooksDefinition',
-                },
-            },
-        },
-        views: {
-            $ref: '#/components/schemas/ResourceViewDefinition',
-        },
-    },
-};
-//# sourceMappingURL=ResourceDefinition.js.map

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

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

package/api/components/schemas/ResourceDeleteActionDefinition.js

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

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

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

package/api/components/schemas/ResourceDeleteAllActionDefinition.js

@@ -1,21 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceDeleteAllActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.delete.all'],
-            description: `Delete all instances of a resource.
-> **Warning!**
->
-> Use this action with caution to avoid losing precious data!`,
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to delete.',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceDeleteAllActionDefinition.js.map

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

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

package/api/components/schemas/ResourceDeleteBulkActionDefinition.js

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

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

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

package/api/components/schemas/ResourceGetActionDefinition.js

@@ -1,25 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceGetActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.get'],
-            description: 'Get a single resource.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to get.',
-        },
-        view: {
-            type: 'string',
-            description: 'The view to use for the resource.',
-        },
-        id: {
-            $ref: '#/components/schemas/RemapperDefinition',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceGetActionDefinition.js.map

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

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

package/api/components/schemas/ResourceHistoryDefinition.js

@@ -1,14 +0,0 @@
-export const ResourceHistoryDefinition = {
-    type: 'object',
-    additionalProperties: false,
-    description: 'A definition of how versioning works for instances of this resource',
-    required: ['data'],
-    properties: {
-        data: {
-            type: 'boolean',
-            default: true,
-            description: 'If set to `false`, edits are still tracked, but exactly what changed is lost.',
-        },
-    },
-};
-//# sourceMappingURL=ResourceHistoryDefinition.js.map

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

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

package/api/components/schemas/ResourceHistoryGetActionDefinition.js

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

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

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

package/api/components/schemas/ResourceHooksDefinition.js

@@ -1,10 +0,0 @@
-export const ResourceHooksDefinition = {
-    type: 'object',
-    description: 'Hooks that are triggered upon calling a resource action.',
-    additionalProperties: false,
-    minProperties: 1,
-    properties: {
-        notification: { $ref: '#/components/schemas/NotificationHookDefinition' },
-    },
-};
-//# sourceMappingURL=ResourceHooksDefinition.js.map

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

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

package/api/components/schemas/ResourcePatchActionDefinition.js

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

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

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

package/api/components/schemas/ResourceQueryActionDefinition.js

@@ -1,26 +0,0 @@
-import { RequestActionDefinition } from './RequestActionDefinition.js';
-import { extendJSONSchema } from './utils.js';
-export const ResourceQueryActionDefinition = extendJSONSchema(RequestActionDefinition, {
-    type: 'object',
-    additionalProperties: false,
-    required: ['type', 'resource'],
-    properties: {
-        type: {
-            enum: ['resource.query'],
-            description: 'Query a list of resources.',
-        },
-        resource: {
-            type: 'string',
-            description: 'The type of the resource to query.',
-        },
-        view: {
-            type: 'string',
-            description: 'The view to use for the resource.',
-        },
-        own: {
-            type: 'boolean',
-            description: 'If only the resources created by the authenticated app member should be included',
-        },
-    },
-}, ['url', 'method']);
-//# sourceMappingURL=ResourceQueryActionDefinition.js.map

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

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

package/api/components/schemas/ResourceSubscriptionStatusActionDefinition.js

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

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

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

package/api/components/schemas/ResourceSubscriptionSubscribeActionDefinition.js

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