@appsemble/utils 0.29.11 → 0.30.2

package/api/paths/apps/appId/reseed.js

@@ -0,0 +1,12 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app'],
+        operationId: 'reseedDemoApp',
+        responses: {
+            200: { description: 'The app has successfully been reseeded.' },
+        },
+        security: [{ studio: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=reseed.js.map

package/api/paths/apps/appId/resources/resourceType/count.d.ts

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

package/api/paths/apps/appId/resources/resourceType/count.js

@@ -0,0 +1,30 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Get a count of all resources of this app.',
+        operationId: 'countAppResources',
+        parameters: [
+            { $ref: '#/components/parameters/$filter' },
+            { $ref: '#/components/parameters/$own' },
+        ],
+        responses: {
+            200: {
+                description: 'The count of all this app’s resources of this type.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'number',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+};
+//# sourceMappingURL=count.js.map

package/api/paths/apps/appId/resources/resourceType/resourceId/subscriptions.d.ts

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

package/api/paths/apps/appId/resources/resourceType/resourceId/subscriptions.js

@@ -0,0 +1,31 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+        { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource', 'subscription'],
+        description: 'Get the subscription status of a resource.',
+        operationId: 'getAppResourceSubscription',
+        responses: {
+            200: {
+                description: 'The subscription status of the resource that matches the given id.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                id: { type: 'number' },
+                                update: { type: 'boolean' },
+                                delete: { type: 'boolean' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=subscriptions.js.map

package/api/paths/apps/appId/resources/resourceType/resourceId.d.ts

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

package/api/paths/apps/appId/resources/resourceType/resourceId.js

@@ -0,0 +1,74 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        parameters: [
+            { $ref: '#/components/parameters/view' },
+            {
+                name: '$own',
+                schema: { type: 'boolean' },
+                description: 'If the resources created by the authenticated app member should be included',
+                in: 'query',
+            },
+        ],
+        description: 'Get a single app resource.',
+        operationId: 'getAppResourceById',
+        responses: {
+            200: {
+                description: 'The resource that matches the given id.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    put: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Update an existing app resource.',
+        operationId: 'updateAppResource',
+        requestBody: {
+            required: true,
+            $ref: '#/components/requestBodies/resource',
+        },
+        responses: {
+            200: {
+                description: 'The updated resource.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    patch: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Patch an existing app resource.',
+        operationId: 'patchAppResource',
+        requestBody: {
+            required: true,
+            $ref: '#/components/requestBodies/resource',
+        },
+        responses: {
+            200: {
+                description: 'The patched resource.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Delete an existing app resource.',
+        operationId: 'deleteAppResource',
+        responses: {
+            204: {
+                description: 'The app resource has been deleted successfully.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resourceId.js.map

package/api/paths/apps/appId/resources/resourceType/subscriptions.d.ts

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

package/api/paths/apps/appId/resources/resourceType/subscriptions.js

@@ -0,0 +1,26 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource', 'subscription'],
+        description: 'Get the current subscription status of this resource.',
+        operationId: 'getAppResourceTypeSubscription',
+        responses: {
+            200: {
+                description: 'The subscription status for this resource.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/ResourceSubscription',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['openid'] }, {}],
+    },
+};
+//# sourceMappingURL=subscriptions.js.map

package/api/paths/apps/appId/resources/resourceType.d.ts

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

package/api/paths/apps/appId/resources/resourceType.js

@@ -0,0 +1,171 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Get all resources of this app.',
+        operationId: 'queryAppResources',
+        parameters: [
+            { $ref: '#/components/parameters/view' },
+            { $ref: '#/components/parameters/$filter' },
+            { $ref: '#/components/parameters/$orderby' },
+            { $ref: '#/components/parameters/$select' },
+            { $ref: '#/components/parameters/$skip' },
+            { $ref: '#/components/parameters/$top' },
+            { $ref: '#/components/parameters/$own' },
+        ],
+        responses: {
+            200: {
+                description: 'The list of all this app’s resources of this type.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/Resource',
+                            },
+                        },
+                    },
+                    'text/csv': {
+                        schema: {
+                            type: 'string',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    post: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Create a new resource for this app.',
+        operationId: 'createAppResource',
+        requestBody: {
+            required: true,
+            description: 'The resource to create',
+            content: {
+                'application/json': {
+                    schema: {
+                        anyOf: [
+                            { $ref: '#/components/schemas/Resource' },
+                            { type: 'array', items: { $ref: '#/components/schemas/Resource' } },
+                        ],
+                    },
+                },
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        required: ['resource'],
+                        description: 'A `multipart/form-data` representation of a resource.',
+                        additionalProperties: false,
+                        properties: {
+                            resource: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Resource' },
+                            },
+                            assets: {
+                                type: 'array',
+                                description: 'A list of assets that should be linked to the resource.',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                        },
+                    },
+                },
+                'text/csv': {
+                    schema: {
+                        type: 'array',
+                        items: { type: 'object', additionalProperties: { type: 'string' } },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The resource that was created.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    put: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Update existing app resources.',
+        operationId: 'updateAppResources',
+        requestBody: {
+            required: true,
+            description: 'The resources to update',
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        items: { $ref: '#/components/schemas/Resource' },
+                    },
+                },
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        required: ['resource'],
+                        description: 'A `multipart/form-data` representation of a resource.',
+                        additionalProperties: false,
+                        properties: {
+                            resource: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Resource' },
+                            },
+                            assets: {
+                                type: 'array',
+                                description: 'A list of assets that should be linked to the resources.',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                        },
+                    },
+                },
+                'text/csv': {
+                    schema: {
+                        type: 'array',
+                        items: { type: 'object', additionalProperties: { type: 'string' } },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The updated resources.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Delete multiple app resources.',
+        operationId: 'deleteAppResources',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        description: 'An array of resource IDs to remove.',
+                        items: { $ref: '#/components/schemas/Resource/properties/id' },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The app resources have been deleted successfully.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resourceType.js.map

package/api/paths/apps/appId/resources/versions.d.ts

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

package/api/paths/apps/appId/resources/versions.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'resource', 'version'],
+        description: 'Get the known history of a resource',
+        operationId: 'getAppResourceVersions',
+        responses: {
+            200: {
+                description: 'The resource that matches the given id.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/responses/resource',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=versions.js.map

package/api/paths/apps/appId/resources.d.ts

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

package/api/paths/apps/appId/resources.js

@@ -0,0 +1,15 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    delete: {
+        tags: ['main', 'app', 'resource'],
+        description: 'Delete all app seed resources.',
+        operationId: 'deleteAppSeedResources',
+        responses: {
+            204: {
+                description: 'The app resources have been deleted successfully.',
+            },
+        },
+        security: [{ cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resources.js.map

package/api/paths/apps/appId/saml/secretId/acs.d.ts

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

package/api/paths/apps/appId/saml/secretId/acs.js

@@ -0,0 +1,35 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    post: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'assertAppSamlConsumerService',
+        security: [{ studio: [] }, {}],
+        requestBody: {
+            content: {
+                'application/x-www-form-urlencoded': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            RelayState: { type: 'string' },
+                            SAMLResponse: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            302: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=acs.js.map

package/api/paths/apps/appId/saml/secretId/authn.d.ts

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

package/api/paths/apps/appId/saml/secretId/authn.js

@@ -0,0 +1,37 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    post: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'createAppSamlAuthnRequest',
+        security: [{ studio: [] }, {}],
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            redirectUri: { type: 'string' },
+                            scope: { type: 'string' },
+                            state: { type: 'string' },
+                            timezone: { enum: Intl.supportedValuesOf('timeZone') },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=authn.js.map

package/api/paths/apps/appId/saml/secretId/metadata.d.ts

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

package/api/paths/apps/appId/saml/secretId/metadata.js

@@ -0,0 +1,21 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'getAppSamlEntityId',
+        responses: {
+            200: {
+                description: 'Get the SAML entity ID metadata',
+                content: {
+                    'application/xml': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=metadata.js.map

package/api/paths/apps/appId/scim/resource-types/resourceTypeId.d.ts

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

package/api/paths/apps/appId/scim/resource-types/resourceTypeId.js

@@ -0,0 +1,25 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { name: 'resourceTypeId', in: 'path', schema: { type: 'string' } },
+    ],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimResourceType',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                        // XXX
+                        // $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=resourceTypeId.js.map

package/api/paths/apps/appId/scim/resource-types.d.ts

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

package/api/paths/apps/appId/scim/resource-types.js

@@ -0,0 +1,22 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimResourceTypes',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                        // XXX
+                        // $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=resource-types.js.map

package/api/paths/apps/appId/scim/schemas/schemaId.d.ts

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

package/api/paths/apps/appId/scim/schemas/schemaId.js

@@ -0,0 +1,24 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { name: 'schemaId', in: 'path', schema: { type: 'string' } },
+    ],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimSchema',
+        responses: {
+            200: {
+                description: 'The SCIM Schema',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=schemaId.js.map

package/api/paths/apps/appId/scim/schemas.d.ts

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

package/api/paths/apps/appId/scim/schemas.js

@@ -0,0 +1,21 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimSchemas',
+        responses: {
+            200: {
+                description: 'The SCIM Schema',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=schemas.js.map

package/api/paths/apps/appId/scim/service-provider-config.d.ts

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