@appsemble/utils 0.29.11 → 0.30.2

package/api/paths/appCollections.js

@@ -1,466 +1,24 @@
-export const paths = {
-    '/api/organizations/{organizationId}/appCollections': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get a list of app collections for an organization',
-            operationId: 'queryOrganizationCollections',
-            parameters: [
-                {
-                    name: 'organizationId',
-                    in: 'path',
-                    description: 'The id of the organization',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/Organization/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'A list of app collections',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    $ref: '#/components/schemas/AppCollection',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-        post: {
-            tags: ['appCollection'],
-            description: 'Create an app collection',
-            operationId: 'createCollection',
-            parameters: [
-                {
-                    name: 'organizationId',
-                    in: 'path',
-                    description: 'The id of the organization to create the app collection in',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/Organization/properties/id',
-                    },
-                },
-            ],
-            requestBody: {
-                description: 'The app collection to create',
-                required: true,
-                content: {
-                    'multipart/form-data': {
-                        schema: {
-                            allOf: [
-                                { $ref: '#/components/schemas/AppCollectionDefinition' },
-                                { required: ['name', 'expertName', 'expertProfileImage', 'headerImage'] },
-                            ],
-                        },
-                        encoding: {
-                            expertProfileImage: {
-                                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
-                            },
-                            headerImage: {
-                                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
-                            },
-                        },
-                    },
-                },
-            },
-            responses: {
-                201: {
-                    description: 'The created app collection',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                $ref: '#/components/schemas/AppCollection',
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }],
-        },
-    },
-    '/api/appCollections': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get a list of app collections',
-            operationId: 'queryCollections',
-            responses: {
-                200: {
-                    description: 'A list of app collections',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    $ref: '#/components/schemas/AppCollection',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-    },
-    '/api/appCollections/{appCollectionId}': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get an app collection',
-            operationId: 'getCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'An app collection',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                $ref: '#/components/schemas/AppCollection',
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-        patch: {
-            tags: ['appCollection'],
-            description: 'Update an app collection',
-            operationId: 'updateCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            requestBody: {
-                description: 'The app collection to update',
-                required: true,
-                content: {
-                    'multipart/form-data': {
-                        schema: {
-                            $ref: '#/components/schemas/AppCollectionDefinition',
-                        },
-                        encoding: {
-                            expertProfileImage: {
-                                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
-                            },
-                            headerImage: {
-                                contentType: 'image/png,image/jpeg,image/tiff,image/webp',
-                            },
-                        },
-                    },
-                },
-            },
-            responses: {
-                200: {
-                    description: 'The updated app collection',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                $ref: '#/components/schemas/AppCollection',
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }],
-        },
-        delete: {
-            tags: ['appCollection'],
-            description: 'Delete an app collection',
-            operationId: 'deleteCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                204: {
-                    description: 'The app collection was deleted',
-                },
-            },
-            security: [{ studio: [] }],
-        },
-    },
-    '/api/appCollections/{appCollectionId}/headerImage': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get an app collection’s header image',
-            operationId: 'getCollectionHeaderImage',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'The app collection’s header image',
-                    content: {
-                        'image/png': {},
-                        'image/jpeg': {},
-                        'image/tiff': {},
-                        'image/webp': {},
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-    },
-    '/api/appCollections/{appCollectionId}/expert/profileImage': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get an app collection’s expert’s profile image',
-            operationId: 'getCollectionExpertProfileImage',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'The app collection’s expert’s profile image',
-                    content: {
-                        'image/png': {},
-                        'image/jpeg': {},
-                        'image/tiff': {},
-                        'image/webp': {},
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-    },
-    '/api/appCollections/{appCollectionId}/apps': {
-        get: {
-            tags: ['appCollection'],
-            description: 'Get a list of apps in an app collection',
-            operationId: 'queryCollectionApps',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-                {
-                    name: 'language',
-                    in: 'query',
-                    description: 'The language to include the translations of, if available',
-                    schema: {
-                        type: 'string',
-                    },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'A list of apps',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'array',
-                                items: {
-                                    allOf: [
-                                        { $ref: '#/components/schemas/App' },
-                                        {
-                                            type: 'object',
-                                            properties: {
-                                                pinned: {
-                                                    type: 'string',
-                                                    format: 'date-time',
-                                                    nullable: true,
-                                                },
-                                            },
-                                        },
-                                    ],
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            security: [{ studio: [] }, {}],
-        },
-        post: {
-            tags: ['appCollection'],
-            description: 'Add an app to an app collection',
-            operationId: 'addAppToCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            requestBody: {
-                description: 'The app to add to the app collection',
-                required: true,
+export const pathItems = {
+    get: {
+        tags: ['main', 'app-collection'],
+        description: 'Get a list of app collections',
+        operationId: 'queryAppCollections',
+        responses: {
+            200: {
+                description: 'A list of app collections',
                 content: {
                     'application/json': {
                         schema: {
-                            type: 'object',
-                            properties: {
-                                AppId: {
-                                    $ref: '#/components/schemas/App/properties/id',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-            responses: {
-                204: {
-                    description: 'The app was added to the app collection',
-                },
-            },
-            security: [{ studio: [] }, { cli: ['apps:write'] }],
-        },
-    },
-    '/api/appCollections/{appCollectionId}/apps/{appId}': {
-        delete: {
-            tags: ['appCollection'],
-            description: 'Remove an app from an app collection',
-            operationId: 'removeAppFromCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-                {
-                    name: 'appId',
-                    in: 'path',
-                    description: 'The id of the app',
-                    required: true,
-                    schema: {
-                        $ref: '#/components/schemas/AppCollection/properties/id',
-                    },
-                },
-            ],
-            responses: {
-                204: {
-                    description: 'The app was removed from the app collection',
-                },
-            },
-            security: [{ studio: [] }],
-        },
-    },
-    '/api/appCollections/{appCollectionId}/apps/{appId}/pinned': {
-        post: {
-            tags: ['appCollection'],
-            description: 'Pin an app to an app collection',
-            operationId: 'pinAppToCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection to pin the app to',
-                    required: true,
-                    schema: { $ref: '#/components/schemas/AppCollection/properties/id' },
-                },
-                {
-                    name: 'appId',
-                    in: 'path',
-                    description: 'The id of the app to pin',
-                    required: true,
-                    schema: { $ref: '#/components/schemas/App/properties/id' },
-                },
-            ],
-            responses: {
-                200: {
-                    description: 'The app was pinned to the app collection',
-                    content: {
-                        'application/json': {
-                            schema: {
-                                type: 'object',
-                                properties: {
-                                    pinned: {
-                                        type: 'string',
-                                        format: 'date-time',
-                                    },
-                                },
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/AppCollection',
                             },
                         },
                     },
                 },
             },
-            security: [{ studio: [] }],
-        },
-        delete: {
-            tags: ['appCollection'],
-            description: 'Unpin an app from an app collection',
-            operationId: 'unpinAppFromCollection',
-            parameters: [
-                {
-                    name: 'appCollectionId',
-                    in: 'path',
-                    description: 'The id of the app collection to unpin the app from',
-                    required: true,
-                    schema: { $ref: '#/components/schemas/AppCollection/properties/id' },
-                },
-                {
-                    name: 'appId',
-                    in: 'path',
-                    description: 'The id of the app to unpin',
-                    required: true,
-                    schema: { $ref: '#/components/schemas/App/properties/id' },
-                },
-            ],
-            responses: {
-                204: {
-                    description: 'The app was unpinned from the app collection',
-                },
-            },
-            security: [{ studio: [] }],
         },
+        security: [{ studio: [] }, {}],
     },
 };
 //# sourceMappingURL=appCollections.js.map

package/api/paths/appTemplates.d.ts

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

package/api/paths/appTemplates.js

@@ -0,0 +1,94 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app', 'template'],
+        description: 'Fetch a list of all available templates.',
+        operationId: 'getAppTemplates',
+        responses: {
+            200: {
+                description: 'The list of all available templates.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    template: {
+                                        type: 'string',
+                                        description: 'The name of the template.',
+                                    },
+                                    description: {
+                                        type: 'string',
+                                        description: 'The description of the template.',
+                                    },
+                                    resources: {
+                                        type: 'boolean',
+                                        description: 'Whether this template supports pre-made resources',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    post: {
+        tags: ['main', 'app', 'template'],
+        description: 'Register a new app using a template.',
+        operationId: 'createAppFromTemplate',
+        requestBody: {
+            description: 'The template to use for app creation.',
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['templateId', 'organizationId'],
+                        properties: {
+                            templateId: {
+                                type: 'number',
+                                description: 'The ID of the template.',
+                            },
+                            name: {
+                                $ref: '#/components/schemas/AppDefinition/properties/name',
+                            },
+                            description: {
+                                $ref: '#/components/schemas/AppDefinition/properties/description',
+                            },
+                            organizationId: {
+                                $ref: '#/components/schemas/Organization/properties/id',
+                            },
+                            resources: {
+                                type: 'boolean',
+                                description: 'Include example resources.',
+                            },
+                            assets: {
+                                type: 'boolean',
+                                description: 'Include example assets.',
+                            },
+                            variables: {
+                                type: 'boolean',
+                                description: 'Include example variables.',
+                            },
+                            secrets: {
+                                type: 'boolean',
+                                description: 'Include example secrets.',
+                            },
+                            visibility: {
+                                $ref: '#/components/schemas/App/properties/visibility',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                $ref: '#/components/responses/app',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=appTemplates.js.map

package/api/paths/apps/appId/actions/path.d.ts

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

package/api/paths/{action.js → apps/appId/actions/path.js}

@@ -1,6 +1,6 @@
 function proxy(method, body) {
     const operation = {
-        tags: ['proxy'],
+        tags: ['app', 'action'],
         description: `Proxy a ${method.toUpperCase()} request action`,
         operationId: `proxy${method}`,
         responses: {
@@ -53,23 +53,21 @@ function proxy(method, body) {
     }
     return operation;
 }
-export const paths = {
-    '/api/apps/{appId}/action/{path}': {
-        parameters: [
-            { $ref: '#/components/parameters/appId' },
-            {
-                in: 'path',
-                name: 'path',
-                description: 'The path to the action to execute.',
-                required: true,
-                schema: { type: 'string' },
-            },
-        ],
-        get: proxy('Get'),
-        delete: proxy('Delete'),
-        patch: proxy('Patch', true),
-        post: proxy('Post', true),
-        put: proxy('Put', true),
-    },
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        {
+            in: 'path',
+            name: 'path',
+            description: 'The path to the action to execute.',
+            required: true,
+            schema: { type: 'string' },
+        },
+    ],
+    get: proxy('Get'),
+    delete: proxy('Delete'),
+    patch: proxy('Patch', true),
+    post: proxy('Post', true),
+    put: proxy('Put', true),
 };
-//# sourceMappingURL=action.js.map
+//# sourceMappingURL=path.js.map

package/api/paths/apps/appId/assets/assetId.d.ts

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

package/api/paths/apps/appId/assets/assetId.js

@@ -0,0 +1,38 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/assetId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Get a single asset',
+        operationId: 'getAppAssetById',
+        responses: {
+            200: {
+                description: 'The asset that matches the given id.',
+            },
+        },
+    },
+    head: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Get the headers for a single asset',
+        operationId: 'getAppAssetHeadersById',
+        responses: {
+            200: {
+                description: 'The headers of the asset that matches the given id.',
+            },
+        },
+    },
+    delete: {
+        tags: ['common', 'app', 'asset'],
+        description: 'Remove an existing asset',
+        operationId: 'deleteAppAsset',
+        responses: {
+            204: {
+                description: 'The asset was successfully deleted.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }],
+    },
+};
+//# sourceMappingURL=assetId.js.map

package/api/paths/apps/appId/assets/count.d.ts

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