@appsemble/utils 0.25.2 → 0.27.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.25.2/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.0/config/assets/logo.svg) Appsemble Utilities
 
 > Internal utility functions used across multiple Appsemble projects.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/utils)](https://www.npmjs.com/package/@appsemble/utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.25.2/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.25.2)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.25.2/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/schemas/App.js

@@ -72,10 +72,6 @@ This doesn’t affect whether or not the app can be accessed on its own domain.
             type: 'boolean',
             description: 'Determines whether this app should be used in demo mode.',
         },
-        seed: {
-            type: 'boolean',
-            description: 'Determines whether this app should be seeded in demo mode.',
-        },
         longDescription: {
             type: 'string',
             description: `

package/api/components/schemas/ResourceDefinition.js

@@ -67,10 +67,6 @@ Example: 1d 8h 30m
             type: 'boolean',
             description: 'Whether the resource should be able to be transferred when cloning the app it belongs to',
         },
-        ephemeral: {
-            type: 'boolean',
-            description: 'Whether the resource should be cleaned up regularly.',
-        },
         schema: {
             $ref: '#/components/schemas/JSONSchemaRoot',
             description: 'JSON schema definitions that may be used by the app.',

package/api/paths/appCollections.js

@@ -349,7 +349,7 @@ export const paths = {
                     description: 'The app was added to the app collection',
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
         },
     },
     '/api/appCollections/{appCollectionId}/apps/{appId}': {

package/api/paths/apps.js

@@ -35,9 +35,6 @@ export const paths = {
                                 demoMode: {
                                     $ref: '#/components/schemas/App/properties/demoMode',
                                 },
-                                seed: {
-                                    $ref: '#/components/schemas/App/properties/seed',
-                                },
                                 longDescription: {
                                     $ref: '#/components/schemas/App/properties/longDescription',
                                 },
@@ -187,9 +184,6 @@ export const paths = {
                                 demoMode: {
                                     $ref: '#/components/schemas/App/properties/demoMode',
                                 },
-                                seed: {
-                                    $ref: '#/components/schemas/App/properties/seed',
-                                },
                                 longDescription: {
                                     $ref: '#/components/schemas/App/properties/longDescription',
                                 },
@@ -345,6 +339,12 @@ export const paths = {
                     description: 'Whether to include resources for an app.',
                     in: 'query',
                 },
+                {
+                    name: 'assets',
+                    schema: { type: 'boolean' },
+                    description: 'Whether to include assets in the export file',
+                    in: 'query',
+                },
             ],
             responses: {
                 200: {

package/api/paths/assets.js

@@ -1,5 +1,65 @@
 import { normalized } from '../../constants/index.js';
 export const paths = {
+    '/api/apps/{appId}/seed-assets': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        post: {
+            tags: ['asset'],
+            description: 'Upload a new seed asset.',
+            operationId: 'seedAsset',
+            requestBody: {
+                description: 'The asset to upload.',
+                content: {
+                    'multipart/form-data': {
+                        schema: {
+                            type: 'object',
+                            description: 'The request body for creating an asset.',
+                            additionalProperties: false,
+                            required: ['file'],
+                            properties: {
+                                file: {
+                                    type: 'string',
+                                    format: 'binary',
+                                    writeOnly: true,
+                                    description: 'The binary data of the asset. This may include a filename.',
+                                },
+                                name: {
+                                    type: 'string',
+                                    pattern: normalized.source,
+                                    description: 'The given name of the asset. Assets may be referenced by their name or ID in the API.',
+                                },
+                                clonable: {
+                                    type: 'boolean',
+                                    description: 'Whether the asset should be transferable when cloning the app they are in.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            responses: {
+                201: {
+                    description: 'The asset that was created.',
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/Asset' },
+                        },
+                    },
+                },
+            },
+            security: [{ studio: [] }, {}, { cli: ['assets:write'] }],
+        },
+        delete: {
+            tags: ['asset'],
+            description: 'Delete all app seed assets.',
+            operationId: 'deleteSeedAssets',
+            responses: {
+                204: {
+                    description: 'The app assets have been deleted successfully.',
+                },
+            },
+            security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+        },
+    },
     '/api/apps/{appId}/assets': {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         get: {

package/api/paths/oauth2Login.js

@@ -108,7 +108,7 @@ export const paths = {
                 { in: 'query', name: 'authorizationUrl', required: true, schema: { type: 'string' } },
             ],
             responses: {
-                204: {
+                201: {
                     description: 'The account was unlinked successfully.',
                 },
             },

package/api/paths/resources.js

@@ -1,4 +1,78 @@
 export const paths = {
+    '/api/apps/{appId}/seed-resources/{resourceType}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/resourceType' },
+        ],
+        post: {
+            tags: ['resource'],
+            description: 'Create a new seed resource for this app.',
+            operationId: 'seedResource',
+            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'] }, {}],
+        },
+    },
+    '/api/apps/{appId}/seed-resources': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        delete: {
+            tags: ['resource'],
+            description: 'Delete all app seed resources.',
+            operationId: 'deleteSeedResources',
+            responses: {
+                204: {
+                    description: 'The app seed resources have been deleted successfully.',
+                },
+            },
+            security: [{ cli: ['resources:write'] }, {}],
+        },
+    },
     '/api/apps/{appId}/resources/{resourceType}': {
         parameters: [
             { $ref: '#/components/parameters/appId' },

package/examples.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" resolution-mode="require"/>
+import { type Remappers, type UserInfo } from '@appsemble/types';
+import { type RemapperContext } from './remap.js';
+export interface RemapperExample {
+    input: unknown;
+    remapper: unknown;
+    result: unknown;
+    skip?: boolean;
+}
+type CustomRemapperKeys = 'app.id' | 'app.locale' | 'app.url' | 'array.map.1' | 'if.else' | 'if.then' | 'None';
+export type RemapperExampleKeys = CustomRemapperKeys | Exclude<keyof Remappers, 'app' | 'if'>;
+export declare const examples: Record<RemapperExampleKeys, RemapperExample>;
+/**
+ * @param remapper The remapper example to use.
+ * @param options The options specifying how to display the example.
+ * @returns Example based on the input options.
+ */
+export declare function schemaExample(remapper: keyof typeof examples, options?: {
+    input?: 'inline' | 'pretty';
+    result?: 'inline' | 'pretty';
+    exclude?: ('input' | 'remapper' | 'result')[];
+}): string;
+export declare function createExampleContext(url: URL, lang: string, userInfo?: UserInfo, history?: []): RemapperContext;
+export {};