@appsemble/utils 0.27.10 → 0.27.12

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.10/config/assets/logo.svg) Appsemble Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.12/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.27.10/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.10)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.12/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.12)
 [![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.27.10/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.12/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/api/components/parameters/$skip.d.ts

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

package/api/components/parameters/$skip.js

@@ -0,0 +1,7 @@
+export const $skip = {
+    name: '$skip',
+    in: 'query',
+    description: 'Start the query from an offset.',
+    schema: { type: 'integer', minimum: 0 },
+};
+//# sourceMappingURL=$skip.js.map

package/api/components/parameters/$top.js

@@ -2,7 +2,6 @@ export const $top = {
     name: '$top',
     in: 'query',
     description: 'Limit the number of entities returned.',
-    // XXX The type should be integer. This doesn’t work due to an upstream bug in Koas.
-    schema: { type: 'string' },
+    schema: { type: 'integer', minimum: 0 },
 };
 //# sourceMappingURL=$top.js.map

package/api/components/parameters/appVariableId.d.ts

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

package/api/components/parameters/appVariableId.js

@@ -0,0 +1,8 @@
+export const appVariableId = {
+    name: 'appVariableId',
+    in: 'path',
+    description: 'The id of the app variable on which to perform an operation',
+    required: true,
+    schema: { type: 'string' },
+};
+//# sourceMappingURL=appVariableId.js.map

package/api/components/parameters/index.d.ts

@@ -3,6 +3,7 @@ export * from './$orderby.js';
 export * from './$select.js';
 export * from './$team.js';
 export * from './$top.js';
+export * from './$skip.js';
 export * from './appId.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
@@ -17,6 +18,7 @@ export * from './resourceType.js';
 export * from './screenshotId.js';
 export * from './readmeId.js';
 export * from './appServiceId.js';
+export * from './appVariableId.js';
 export * from './view.js';
 export * from './trainingId.js';
 export * from './trainingBlockId.js';

package/api/components/parameters/index.js

@@ -3,6 +3,7 @@ export * from './$orderby.js';
 export * from './$select.js';
 export * from './$team.js';
 export * from './$top.js';
+export * from './$skip.js';
 export * from './appId.js';
 export * from './appOAuth2SecretId.js';
 export * from './appSamlSecretId.js';
@@ -17,6 +18,7 @@ export * from './resourceType.js';
 export * from './screenshotId.js';
 export * from './readmeId.js';
 export * from './appServiceId.js';
+export * from './appVariableId.js';
 export * from './view.js';
 export * from './trainingId.js';
 export * from './trainingBlockId.js';

package/api/components/schemas/App.js

@@ -77,7 +77,7 @@ This doesn’t affect whether or not the app can be accessed on its own domain.
             description: `
 A long description for the app.
 
-The long desciption will be rendered on the app details page. Markdown content is supported.
+The long description will be rendered on the app details page. Markdown content is supported.
 `,
         },
         definition: { $ref: '#/components/schemas/AppDefinition' },

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

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

package/api/components/schemas/AppVariable.js

@@ -0,0 +1,22 @@
+export const AppVariable = {
+    type: 'object',
+    description: 'App variable',
+    required: ['name'],
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'number',
+            description: 'An autogenerated ID.',
+            readOnly: true,
+        },
+        name: {
+            type: 'string',
+            description: 'The name of the variable, that will be accessible from clients.',
+        },
+        value: {
+            description: 'The value of the variable.',
+            anyOf: [{ type: 'string' }, { type: 'boolean' }, { type: 'number' }],
+        },
+    },
+};
+//# sourceMappingURL=AppVariable.js.map

package/api/components/schemas/BlockDefinition.js

@@ -32,7 +32,13 @@ will remain the same until it is manually updated.
 `,
         },
         layout: {
-            description: 'An override of the block’s default.',
+            description: `An override of the block’s default layout.
+
+\`float\` sets the block position to float on the page and does not collide with other blocks.
+Layout float can be combined with the \`position\` property to place the block on the desired location.
+\`grow\` adds space between blocks so the page is filled.
+\`static\` on the contrary, does not add extra space between blocks.
+`,
             enum: ['float', 'grow', 'static'],
         },
         header: {
@@ -50,7 +56,7 @@ If a user does not have the right role, the block is not rendered.
             },
         },
         position: {
-            description: 'For floating blocks this propert defines where the block should float.',
+            description: 'For floating blocks this property defines where the block should float.',
             default: 'bottom right',
             enum: [
                 'top left',

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

@@ -12,6 +12,7 @@ export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
 export * from './AppsembleMessages.js';
 export * from './AppServiceSecret.js';
+export * from './AppVariable.js';
 export * from './ArrayRemapperDefinition.js';
 export * from './Asset.js';
 export * from './BlockDefinition.js';

package/api/components/schemas/index.js

@@ -12,6 +12,7 @@ export * from './AppMessages.js';
 export * from './AppOAuth2Secret.js';
 export * from './AppsembleMessages.js';
 export * from './AppServiceSecret.js';
+export * from './AppVariable.js';
 export * from './ArrayRemapperDefinition.js';
 export * from './Asset.js';
 export * from './BlockDefinition.js';

package/api/paths/appOAuth2Secrets.js

@@ -11,7 +11,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
             responses: {
                 201: {
                     description: 'A list of the OAuth2 secrets for the app.',
@@ -41,6 +41,16 @@ export const paths = {
                 },
             },
         },
+        delete: {
+            tags: ['secret'],
+            operationId: 'deleteAppOAuth2Secrets',
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
+            responses: {
+                204: {
+                    description: 'The deleted app OAuth2 secrets.',
+                },
+            },
+        },
     },
     '/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}': {
         parameters: [

package/api/paths/appSSLSecrets.js

@@ -32,7 +32,7 @@ export const paths = {
                     $ref: '#/components/schemas/SSLSecret',
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
         },
     },
 };

package/api/paths/appSamlSecrets.js

@@ -11,7 +11,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
             responses: {
                 201: {
                     description: 'A list of the SAML secrets for the app.',
@@ -41,6 +41,16 @@ export const paths = {
                 },
             },
         },
+        delete: {
+            tags: ['secret'],
+            operationId: 'deleteAppSamlSecrets',
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
+            responses: {
+                204: {
+                    description: 'The deleted app saml secrets.',
+                },
+            },
+        },
     },
     '/api/apps/{appId}/secrets/saml/{appSamlSecretId}': {
         parameters: [

package/api/paths/appScimSecrets.js

@@ -28,7 +28,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
             responses: {
                 200: {
                     description: 'The app SCIM configuration',

package/api/paths/appServiceSecrets.js

@@ -3,7 +3,7 @@ export const paths = {
         parameters: [{ $ref: '#/components/parameters/appId' }],
         post: {
             tags: ['secret'],
-            operationId: 'addAppServiceSecret',
+            operationId: 'createAppServiceSecret',
             requestBody: {
                 content: {
                     'application/json': {
@@ -11,7 +11,7 @@ export const paths = {
                     },
                 },
             },
-            security: [{ studio: [] }],
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
             responses: {
                 201: {
                     description: 'The created app service secret.',
@@ -41,6 +41,16 @@ export const paths = {
                 },
             },
         },
+        delete: {
+            tags: ['secret'],
+            operationId: 'deleteAppServiceSecrets',
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
+            responses: {
+                204: {
+                    description: 'The deleted app service secrets.',
+                },
+            },
+        },
     },
     '/api/apps/{appId}/secrets/service/{appServiceId}': {
         parameters: [

package/api/paths/appVariables.d.ts

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

package/api/paths/appVariables.js

@@ -0,0 +1,93 @@
+export const paths = {
+    '/api/apps/{appId}/variables': {
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        post: {
+            tags: ['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' },
+                        },
+                    },
+                },
+            },
+        },
+        get: {
+            tags: ['variable'],
+            operationId: 'getAppVariables',
+            responses: {
+                200: {
+                    description: 'The list of app variables.',
+                    content: {
+                        'application/json': {
+                            schema: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/AppVariable' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        delete: {
+            tags: ['variable'],
+            operationId: 'deleteAppVariables',
+            security: [{ studio: [] }, { cli: ['apps:write'] }],
+            responses: {
+                204: {
+                    description: 'The deleted app variables.',
+                },
+            },
+        },
+    },
+    '/api/apps/{appId}/variables/{appVariableId}': {
+        parameters: [
+            { $ref: '#/components/parameters/appId' },
+            { $ref: '#/components/parameters/appVariableId' },
+        ],
+        put: {
+            tags: ['secret'],
+            operationId: 'updateAppVariable',
+            requestBody: {
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppVariable' },
+                    },
+                },
+            },
+            security: [{ studio: [] }],
+            responses: {
+                200: {
+                    description: 'The updated app variable.',
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/AppVariable' },
+                        },
+                    },
+                },
+            },
+        },
+        delete: {
+            tags: ['secret'],
+            operationId: 'deleteAppVariable',
+            security: [{ studio: [] }],
+            responses: {
+                204: {
+                    description: 'The deleted app variable.',
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=appVariables.js.map

package/api/paths/assets.js

@@ -66,7 +66,10 @@ export const paths = {
             tags: ['asset'],
             description: 'Get all of the app’s assets.',
             operationId: 'getAssets',
-            parameters: [{ $ref: '#/components/parameters/$top' }],
+            parameters: [
+                { $ref: '#/components/parameters/$skip' },
+                { $ref: '#/components/parameters/$top' },
+            ],
             responses: {
                 200: {
                     description: 'The assets associated with the app.',

package/api/paths/index.js

@@ -10,6 +10,7 @@ import { paths as appScimSecrets } from './appScimSecrets.js';
 import { paths as appsembleMessages } from './appsembleMessages.js';
 import { paths as appServiceSecrets } from './appServiceSecrets.js';
 import { paths as appSSLSecrets } from './appSSLSecrets.js';
+import { paths as appVariables } from './appVariables.js';
 import { paths as assets } from './assets.js';
 import { paths as blocks } from './blocks.js';
 import { paths as emails } from './emails.js';
@@ -33,6 +34,7 @@ export const paths = {
     ...scimEndpoints,
     ...appsembleMessages,
     ...appSSLSecrets,
+    ...appVariables,
     ...appCollections,
     ...appQuotas,
     ...assets,

package/api/paths/resources.js

@@ -87,6 +87,7 @@ export const paths = {
                 { $ref: '#/components/parameters/$filter' },
                 { $ref: '#/components/parameters/$orderby' },
                 { $ref: '#/components/parameters/$select' },
+                { $ref: '#/components/parameters/$skip' },
                 { $ref: '#/components/parameters/$top' },
                 { $ref: '#/components/parameters/$team' },
             ],

package/api/paths/templates.js

@@ -68,6 +68,14 @@ export const paths = {
                                     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',
                                 },

package/constants/patterns.d.ts

@@ -35,3 +35,7 @@ export declare const uuid4Pattern: RegExp;
  * A pattern which matches a JSON web token.
  */
 export declare const jwtPattern: RegExp;
+/**
+ * A pattern which matches an ISO 8601 datetime string.
+ */
+export declare const ISODateTimePattern: RegExp;

package/constants/patterns.js

@@ -35,4 +35,8 @@ export const uuid4Pattern = /^[\d[a-f]{8}-[\da-f]{4}-4[\da-f]{3}-[\da-f]{4}-[\d[
  * A pattern which matches a JSON web token.
  */
 export const jwtPattern = /^[\w-]+(?:\.[\w-]+){2}$/;
+/**
+ * A pattern which matches an ISO 8601 datetime string.
+ */
+export const ISODateTimePattern = /\d{4}(.\d{2}){2}(\s|T)(\d{2}.){2}\d{2}/;
 //# sourceMappingURL=patterns.js.map

package/examples.js

@@ -279,6 +279,12 @@ export const examples = {
         result: {},
         skip: true,
     },
+    variable: {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
     'date.add': {
         input: '2023-06-30T14:50:19.601Z',
         remapper: [
@@ -649,6 +655,7 @@ export function schemaExample(remapper, options) {
 export function createExampleContext(url, lang, userInfo, history) {
     return {
         getMessage: ({ defaultMessage }) => new IntlMessageFormat(defaultMessage, lang, undefined),
+        getVariable: () => null,
         url: String(url),
         appUrl: `${url.protocol}//example-app.example-organization.${url.host}`,
         userInfo: userInfo !== null && userInfo !== void 0 ? userInfo : {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.27.10",
+  "version": "0.27.12",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.27.10",
+    "@appsemble/types": "0.27.12",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/config.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const configRemappers: Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject>;

package/reference-schemas/remappers/config.js

@@ -0,0 +1,7 @@
+export const configRemappers = {
+    variable: {
+        type: 'string',
+        description: 'Get a predefined app variable by name',
+    },
+};
+//# sourceMappingURL=config.js.map

package/reference-schemas/remappers/index.d.ts

@@ -7,3 +7,4 @@ export * from './objects.js';
 export * from './randoms.js';
 export * from './strings.js';
 export * from './unsorted.js';
+export * from './config.js';

package/reference-schemas/remappers/index.js

@@ -7,4 +7,5 @@ export * from './objects.js';
 export * from './randoms.js';
 export * from './strings.js';
 export * from './unsorted.js';
+export * from './config.js';
 //# sourceMappingURL=index.js.map

package/remap.d.ts

@@ -1,4 +1,4 @@
-import { type AppMember, type Remapper, type UserInfo } from '@appsemble/types';
+import { type AppMember, type Remapper, type UserInfo, type ValueFromProcess } from '@appsemble/types';
 import { type IntlMessageFormat } from 'intl-messageformat';
 export interface IntlMessage {
     id?: string;
@@ -11,6 +11,7 @@ export interface IntlMessage {
  * @returns A message format instance.
  */
 export type MessageGetter = (msg: IntlMessage) => IntlMessageFormat;
+export type AppConfigEntryGetter = (name: string) => ValueFromProcess;
 export interface RemapperContext {
     /**
      * The id of the app whose context the remapper is run in.
@@ -28,6 +29,10 @@ export interface RemapperContext {
      * @see MessageGetter
      */
     getMessage: MessageGetter;
+    /**
+     * @see VariableGetter
+     */
+    getVariable: AppConfigEntryGetter;
     /**
      * The history stack containing the states before an action was called.
      */

package/remap.js

@@ -84,6 +84,12 @@ const mapperImplementations = {
         }
         return result !== null && result !== void 0 ? result : null;
     },
+    variable(name, input, context) {
+        if (context.getVariable) {
+            return context.getVariable(name);
+        }
+        return { variable: name };
+    },
     equals(mappers, input, context) {
         if (mappers.length <= 1) {
             return true;

package/remap.test.js

@@ -3,9 +3,10 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { createExampleContext, examples } from './examples.js';
 import { remap } from './remap.js';
 function runTests(tests) {
-    it.each(Object.entries(tests))('should %s', (name, { context, expected, history, input, mappers, messages, userInfo }) => {
+    it.each(Object.entries(tests))('should %s', (name, { context, expected, history, input, mappers, messages, userInfo, variables }) => {
         const result = remap(mappers, input, {
             getMessage: ({ defaultMessage, id }) => { var _a, _b; return new IntlMessageFormat((_b = (_a = messages === null || messages === void 0 ? void 0 : messages.messageIds) === null || _a === void 0 ? void 0 : _a[id]) !== null && _b !== void 0 ? _b : defaultMessage); },
+            getVariable: (variableName) => { var _a; return (_a = variables.find((variable) => variable.name === variableName)) === null || _a === void 0 ? void 0 : _a.value; },
             url: 'https://example.com/en/example',
             appUrl: 'https://example.com',
             userInfo,
@@ -120,6 +121,22 @@ describe('context', () => {
         },
     });
 });
+describe('variable', () => {
+    runTests({
+        'get a variable': {
+            input: {},
+            mappers: { variable: 'my-variable' },
+            expected: 'my-variable-value',
+            variables: [{ id: 0, name: 'my-variable', value: 'my-variable-value' }],
+        },
+        'get an undefined variable': {
+            input: {},
+            mappers: { variable: 'my-variable' },
+            expected: undefined,
+            variables: [],
+        },
+    });
+});
 describe('date.now', () => {
     beforeEach(() => {
         vi.useFakeTimers({ now: 0 });
@@ -210,7 +227,7 @@ describe('log', () => {
         vi.spyOn(console, 'warn').mockImplementation(null);
     });
     function runLogTests(tests) {
-        it.each(Object.entries(tests))('should %s', (name, { context, expected: expectedInput, history, input, mappers, messages, userInfo }) => {
+        it.each(Object.entries(tests))('should %s', (name, { context, expected: expectedInput, history, input, mappers, messages, userInfo, variables, }) => {
             const expected = JSON.stringify({
                 input: expectedInput,
                 context: {
@@ -228,6 +245,7 @@ describe('log', () => {
             }, null, 2);
             remap(mappers, input, {
                 getMessage: ({ defaultMessage, id }) => { var _a, _b; return new IntlMessageFormat((_b = (_a = messages === null || messages === void 0 ? void 0 : messages.messageIds) === null || _a === void 0 ? void 0 : _a[id]) !== null && _b !== void 0 ? _b : defaultMessage); },
+                getVariable: (variableName) => variables.find((variable) => variable.name === variableName).value,
                 url: 'https://example.com/en/example',
                 appUrl: 'https://example.com',
                 userInfo,