@appsemble/utils 0.29.10 → 0.30.1

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

@@ -0,0 +1,53 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app', 'variable'],
+        operationId: 'getAppVariables',
+        responses: {
+            200: {
+                description: 'The list of app variables.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: { $ref: '#/components/schemas/AppVariable' },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    post: {
+        tags: ['main', 'app', 'variable'],
+        operationId: 'createAppVariable',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/AppVariable' },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            201: {
+                description: 'The created app variable.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppVariable' },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'variable'],
+        operationId: 'deleteAppVariables',
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            204: {
+                description: 'The deleted app variables.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=variables.js.map

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

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

package/api/paths/apps/appId.js

@@ -0,0 +1,175 @@
+import { hexColor } from '../../../constants/index.js';
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app'],
+        parameters: [
+            {
+                name: 'language',
+                schema: { type: 'string' },
+                description: 'The language to include the translations of, if available',
+                in: 'query',
+            },
+        ],
+        description: 'Get a single app',
+        operationId: 'getAppById',
+        responses: {
+            200: {
+                description: 'The app that matches the given id.',
+                $ref: '#/components/responses/app',
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+    patch: {
+        tags: ['main', 'app'],
+        description: 'Update parts of an existing app',
+        operationId: 'patchApp',
+        requestBody: {
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            domain: {
+                                $ref: '#/components/schemas/App/properties/domain',
+                            },
+                            path: {
+                                $ref: '#/components/schemas/App/properties/path',
+                            },
+                            visibility: {
+                                $ref: '#/components/schemas/App/properties/visibility',
+                            },
+                            template: {
+                                $ref: '#/components/schemas/App/properties/template',
+                            },
+                            demoMode: {
+                                $ref: '#/components/schemas/App/properties/demoMode',
+                            },
+                            force: {
+                                type: 'boolean',
+                                description: 'Whether the locked property should be ignored.',
+                            },
+                            yaml: {
+                                type: 'string',
+                                description: 'The original YAML definition used to define the app.',
+                            },
+                            icon: {
+                                type: 'string',
+                                format: 'binary',
+                                description: 'The app icon.',
+                            },
+                            maskableIcon: {
+                                type: 'string',
+                                format: 'binary',
+                                description: 'The app icon.',
+                            },
+                            iconBackground: {
+                                type: 'string',
+                                pattern: hexColor.source,
+                            },
+                            coreStyle: {
+                                type: 'string',
+                                description: 'The custom style to apply to the core app.',
+                            },
+                            sharedStyle: {
+                                type: 'string',
+                                description: 'The custom style to apply to all parts of app.',
+                            },
+                            screenshots: {
+                                type: 'array',
+                                description: 'Screenshots to showcase in the store',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                            readmes: {
+                                type: 'array',
+                                description: 'Readmes to showcase in the store',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                            controllerCode: {
+                                type: 'string',
+                                description: 'Custom app logic as a JavaScript string',
+                            },
+                            controllerImplementations: {
+                                type: 'string',
+                                description: 'Appsemble SDK interfaces implementations',
+                            },
+                            showAppsembleLogin: {
+                                type: 'boolean',
+                                description: 'Whether the Appsemble login method should be shown.',
+                            },
+                            showAppsembleOAuth2Login: {
+                                type: 'boolean',
+                                description: 'Whether the Appsemble OAuth2 login method should be shown.',
+                            },
+                            enableSelfRegistration: {
+                                type: 'boolean',
+                                description: 'Whether new users should be able to register themselves.',
+                            },
+                            emailName: {
+                                type: 'string',
+                                description: 'The name used for emails.',
+                            },
+                            emailHost: {
+                                type: 'string',
+                                description: 'The hostname of the SMTP server.',
+                            },
+                            emailPassword: {
+                                type: 'string',
+                                description: 'The password to use for SMTP authentication. This gets encrypted when stored.',
+                            },
+                            emailUser: {
+                                type: 'string',
+                                description: 'The username used to authenticate against the SMTP server.',
+                            },
+                            emailPort: {
+                                type: 'string',
+                                description: 'The port used for the SMTP server.',
+                            },
+                            emailSecure: {
+                                type: 'boolean',
+                                description: 'Whether TLS is being used.',
+                            },
+                            containers: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/ContainerDefinition' },
+                            },
+                        },
+                    },
+                    encoding: {
+                        coreStyle: { contentType: 'text/css' },
+                        sharedStyle: { contentType: 'text/css' },
+                        icon: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The updated app.',
+                $ref: '#/components/responses/app',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+    delete: {
+        tags: ['main', 'app'],
+        description: 'Delete an existing app',
+        operationId: 'deleteApp',
+        responses: {
+            204: {
+                description: 'The app was successfully deleted.',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:delete'] }],
+    },
+};
+//# sourceMappingURL=appId.js.map

package/api/paths/apps.d.ts

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