@appsemble/utils 0.28.2 → 0.28.4

package/README.md

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

package/api/components/schemas/App.js

@@ -19,7 +19,8 @@ This value will be generated automatically by the API.
         path: {
             type: 'string',
             minLength: 1,
-            maxLength: 30,
+            // Max app name size + appended random data by [`setAppPath`](./packages/server/utils/app.ts)
+            maxLength: 41,
             pattern: normalized.source,
             description: `The URL path segment on which this app is reachable.
 

package/api/components/schemas/SubPage.js

@@ -10,6 +10,21 @@ export const SubPage = {
             minLength: 1,
             maxLength: 50,
         },
+        roles: {
+            type: 'array',
+            description: `The list of roles that are allowed to view this page.
+
+If the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty
+list can be used to specify that users need to log in but do not need a specific role.
+
+Users trying to visit a page without having the correct roles will be redirected to the first page
+that they are allowed to view. If there aren’t any accessible pages, the user will be logged out and
+instructed to contact the app owner to get permissions.
+`,
+            items: {
+                type: 'string',
+            },
+        },
         blocks: {
             type: 'array',
             minItems: 1,

package/api/paths/apps.js

@@ -162,6 +162,7 @@ export const paths = {
                     $ref: '#/components/responses/app',
                 },
             },
+            security: [{ studio: [] }, {}],
         },
     },
     '/api/apps/{appId}': {

package/examples.js

@@ -44,6 +44,9 @@ export const examples = {
                     length: {
                         array: 'length',
                     },
+                    item: {
+                        array: 'item',
+                    },
                 },
             },
         },
@@ -51,14 +54,17 @@ export const examples = {
             {
                 index: 0,
                 length: 3,
+                item: 'a',
             },
             {
                 index: 1,
                 length: 3,
+                item: 'b',
             },
             {
                 index: 2,
                 length: 3,
+                item: 'c',
             },
         ],
     },
@@ -281,8 +287,14 @@ export const examples = {
     },
     variable: {
         input: null,
-        remapper: {},
-        result: {},
+        remapper: { variable: 'MY_VARIABLE' },
+        result: 'variable value',
+        skip: true,
+    },
+    'number.parse': {
+        input: '42',
+        remapper: { 'number.parse': null },
+        result: 42,
         skip: true,
     },
     'date.add': {
@@ -655,7 +667,7 @@ export function schemaExample(remapper, options) {
 export function createExampleContext(url, lang, userInfo, history) {
     return {
         getMessage: ({ defaultMessage }) => new IntlMessageFormat(defaultMessage, lang, undefined),
-        getVariable: () => null,
+        getVariable: (name) => (name === 'MY_VARIABLE' ? 'variable value' : 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.28.2",
+  "version": "0.28.4",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -37,7 +37,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.28.2",
+    "@appsemble/types": "0.28.4",
     "axios": "^1.0.0",
     "cron-parser": "^4.0.0",
     "date-fns": "^2.0.0",

package/reference-schemas/remappers/config.js

@@ -1,7 +1,13 @@
+import { schemaExample } from '../../examples.js';
 export const configRemappers = {
     variable: {
         type: 'string',
-        description: 'Get a predefined app variable by name',
+        description: `Get a predefined app variable by name
+
+For example:
+
+${schemaExample('variable', { exclude: ['input'] })}
+`,
     },
 };
 //# sourceMappingURL=config.js.map

package/reference-schemas/remappers/data.js

@@ -1,8 +1,8 @@
 import { schemaExample } from '../../examples.js';
 export const dataRemappers = {
     array: {
-        enum: ['index', 'length'],
-        description: `Get the current array.map’s index or length.
+        enum: ['index', 'length', 'item'],
+        description: `Get the current array.map’s index, length or the current item.
 
 Returns nothing when not in the context of \`array.map’s\`.
 

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

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

package/reference-schemas/remappers/index.js

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

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

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

package/reference-schemas/remappers/numbers.js

@@ -0,0 +1,30 @@
+import { schemaExample } from '../../examples.js';
+export const numberRemappers = {
+    'number.parse': {
+        anyOf: [
+            { enum: [null] },
+            { type: 'string' },
+            { $ref: '#/components/schemas/ArrayRemapperDefinition' },
+            { $ref: '#/components/schemas/ObjectRemapperDefinition' },
+        ],
+        description: `Convert a string into a number.
+
+If there is no remapper passed and the input can be converted, this will return the converted input.
+
+If there is no remapper passed and the input is null, this will return 0.
+
+If there is no remapper passed and the input cannot be converted, this will return the input.
+
+If there is a remapper passed and the remapped value can be converted, this will return the converted remapped value.
+
+If there is a remapper passed and the remapped value is null, this will return 0.
+
+If there is a remapper passed and the remapped value cannot be converted, this will return the remapped value.
+
+For example:
+
+${schemaExample('number.parse')}
+`,
+    },
+};
+//# sourceMappingURL=numbers.js.map

package/remap.d.ts

@@ -63,6 +63,7 @@ interface InternalContext extends RemapperContext {
     array?: {
         index: number;
         length: number;
+        item: unknown;
     };
     stepRef?: {
         current: Record<string, any>;

package/remap.js

@@ -195,16 +195,19 @@ const mapperImplementations = {
         var _a;
         return (_a = input === null || input === void 0 ? void 0 : input.map((item, index) => remap(mapper, item, {
             ...context,
-            array: { index, length: input.length },
+            array: { index, length: input.length, item },
         }))) !== null && _a !== void 0 ? _a : [];
     },
     'array.unique'(mapper, input, context) {
         if (!Array.isArray(input)) {
             return input;
         }
-        const remapped = input.map((value, index) => mapper == null
-            ? value
-            : remap(mapper, value, { ...context, array: { index, length: input.length } }));
+        const remapped = input.map((item, index) => mapper == null
+            ? item
+            : remap(mapper, item, {
+                ...context,
+                array: { index, length: input.length, item },
+            }));
         return input.filter((value, index) => {
             for (let i = 0; i < index; i += 1) {
                 if (equal(remapped[index], remapped[i])) {
@@ -287,6 +290,21 @@ const mapperImplementations = {
         }
         return result;
     },
+    'number.parse'(remapper, input, context) {
+        if (!remapper) {
+            const inputConverted = Number(input);
+            if (!Number.isNaN(inputConverted)) {
+                return inputConverted;
+            }
+            return input;
+        }
+        const remapped = remap(remapper, input, context);
+        const remappedConverted = Number(remapped);
+        if (!Number.isNaN(remappedConverted)) {
+            return remappedConverted;
+        }
+        return remapped;
+    },
     'date.parse': (fmt, input) => (fmt ? parse(input, fmt, new Date()) : parseISO(input)),
     'date.now': () => new Date(),
     'date.add'(time, input) {

package/remap.test.js

@@ -137,6 +137,50 @@ describe('variable', () => {
         },
     });
 });
+describe('number.parse', () => {
+    runTests({
+        'return the parsed number': {
+            input: '42',
+            mappers: { 'number.parse': null },
+            expected: 42,
+        },
+        'return the parsed decimal number': {
+            input: '42.5',
+            mappers: { 'number.parse': null },
+            expected: 42.5,
+        },
+        'return 0 if there is no input': {
+            input: null,
+            mappers: { 'number.parse': null },
+            expected: 0,
+        },
+        'return the input if it can not be converted': {
+            input: 'test',
+            mappers: { 'number.parse': null },
+            expected: 'test',
+        },
+        'return the parsed integer from a remapper': {
+            input: { number: '42' },
+            mappers: { 'number.parse': { prop: 'number' } },
+            expected: 42,
+        },
+        'return the parsed decimal from a remapper': {
+            input: { number: '42.5' },
+            mappers: { 'number.parse': { prop: 'number' } },
+            expected: 42.5,
+        },
+        'return 0 if the remapped value is null': {
+            input: { number: null },
+            mappers: { 'number.parse': { prop: 'number' } },
+            expected: 0,
+        },
+        'return the remapped value if it can not be parsed': {
+            input: { number: 'test' },
+            mappers: { 'number.parse': { prop: 'number' } },
+            expected: 'test',
+        },
+    });
+});
 describe('date.now', () => {
     beforeEach(() => {
         vi.useFakeTimers({ now: 0 });
@@ -756,12 +800,13 @@ describe('array', () => {
                     'object.from': {
                         index: [{ array: 'index' }],
                         length: [{ array: 'length' }],
+                        item: [{ array: 'item' }],
                     },
                 },
             ],
-            expected: { index: undefined, length: undefined },
+            expected: { index: undefined, length: undefined, item: undefined },
         },
-        'return the index and length if in the context of array.map': {
+        'return the index, length and item if in the context of array.map': {
             input: { array: [{ value: 'a' }, { value: 'b' }, { value: 'c' }] },
             mappers: [
                 { prop: 'array' },
@@ -772,15 +817,16 @@ describe('array', () => {
                                 value: [{ prop: 'value' }],
                                 index: [{ array: 'index' }],
                                 length: [{ array: 'length' }],
+                                item: [{ array: 'item' }],
                             },
                         },
                     ],
                 },
             ],
             expected: [
-                { value: 'a', index: 0, length: 3 },
-                { value: 'b', index: 1, length: 3 },
-                { value: 'c', index: 2, length: 3 },
+                { value: 'a', index: 0, length: 3, item: { value: 'a' } },
+                { value: 'b', index: 1, length: 3, item: { value: 'b' } },
+                { value: 'c', index: 2, length: 3, item: { value: 'c' } },
             ],
         },
     });