@appsemble/utils 0.30.1 → 0.30.3

package/README.md

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

package/api/components/schemas/BasePageDefinition.js

@@ -83,6 +83,10 @@ instructed to contact the app owner to get permissions.
         theme: {
             $ref: '#/components/schemas/Theme',
         },
+        badgeCount: {
+            $ref: '#/components/schemas/RemapperDefinition',
+            description: 'A Remapper that resolves to a number to be visibile in the side-menu.',
+        },
     },
 };
 //# sourceMappingURL=BasePageDefinition.js.map

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

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

package/api/components/schemas/{TabsPageActionsDefinition.js → PageActionsDefinition.js}

@@ -1,4 +1,4 @@
-export const TabsPageActionsDefinition = {
+export const PageActionsDefinition = {
     type: 'object',
     description: 'Action fired on page events',
     additionalProperties: false,
@@ -9,4 +9,4 @@ export const TabsPageActionsDefinition = {
         },
     },
 };
-//# sourceMappingURL=TabsPageActionsDefinition.js.map
+//# sourceMappingURL=PageActionsDefinition.js.map

package/api/components/schemas/PageDefinition.js

@@ -18,6 +18,9 @@ the list.
                 $ref: '#/components/schemas/BlockDefinition',
             },
         },
+        actions: {
+            $ref: '#/components/schemas/PageActionsDefinition',
+        },
     },
 });
 //# sourceMappingURL=PageDefinition.js.map

package/api/components/schemas/TabsPageDefinition.js

@@ -39,7 +39,7 @@ export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
             },
         },
         actions: {
-            $ref: '#/components/schemas/TabsPageActionsDefinition',
+            $ref: '#/components/schemas/PageActionsDefinition',
         },
     },
 });

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

@@ -136,8 +136,8 @@ export * from './AppMemberPropertiesPatchActionDefinition.js';
 export * from './AppMemberRoleUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
-export * from './TabsPageActionsDefinition.js';
 export * from './AppMembersDefinition.js';
 export * from './AppMemberPropertyDefinition.js';
 export * from './GroupMember.js';
 export * from './AppAccount.js';
+export * from './PageActionsDefinition.js';

package/api/components/schemas/index.js

@@ -136,9 +136,9 @@ export * from './AppMemberPropertiesPatchActionDefinition.js';
 export * from './AppMemberRoleUpdateActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
-export * from './TabsPageActionsDefinition.js';
 export * from './AppMembersDefinition.js';
 export * from './AppMemberPropertyDefinition.js';
 export * from './GroupMember.js';
 export * from './AppAccount.js';
+export * from './PageActionsDefinition.js';
 //# sourceMappingURL=index.js.map

package/api/paths/apps.js

@@ -121,11 +121,11 @@ export const pathItems = {
                 in: 'query',
             },
         ],
-        description: 'Get all existing apps.',
+        description: 'Get all publically available apps.',
         operationId: 'queryApps',
         responses: {
             200: {
-                description: 'The list of all apps.',
+                description: 'The list of all public apps.',
                 content: {
                     'application/json': {
                         schema: {

package/api/paths/users/current/apps.js

@@ -9,11 +9,11 @@ export const pathItems = {
                 in: 'query',
             },
         ],
-        description: 'Get all apps that are editable by the user.',
+        description: 'Get all apps from organizations that the user is in.',
         operationId: 'queryCurrentUserApps',
         responses: {
             200: {
-                description: 'The list of all editable apps.',
+                description: 'The list of all apps the user is in.',
                 content: {
                     'application/json': {
                         schema: {

package/authorization.js

@@ -27,7 +27,7 @@ function checkAppPermissions(acquiredPermissions, requiredPermissions) {
 }
 export function getAppInheritedRoles(appSecurityDefinition, roles, accumulatedRoles = []) {
     var _a;
-    if (!appSecurityDefinition) {
+    if (!appSecurityDefinition || !roles) {
         return [];
     }
     for (const role of roles) {

package/examples.js

@@ -33,6 +33,11 @@ export const examples = {
         result: {},
         skip: true,
     },
+    type: {
+        input: [1, 2, 3],
+        remapper: { type: null },
+        result: 'array',
+    },
     array: {
         input: ['a', 'b', 'c'],
         remapper: {
@@ -112,6 +117,30 @@ export const examples = {
             },
         ],
     },
+    'array.filter': {
+        input: [
+            {
+                name: 'Peter',
+            },
+            {
+                name: 'Louis',
+            },
+            {
+                name: 'Brian',
+            },
+        ],
+        remapper: {
+            'array.filter': {
+                equals: [
+                    {
+                        prop: 'name',
+                    },
+                    'Louis',
+                ],
+            },
+        },
+        result: [{ name: 'Louis' }],
+    },
     'array.find': {
         input: [
             {

package/package.json

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

package/reference-schemas/remappers/arrays.js

@@ -100,6 +100,37 @@ remapper is a filtered list:
     "age": 20
   }
 ]
+\`\`\`
+    `,
+    },
+    'array.filter': {
+        $ref: '#/components/schemas/RemapperDefinition',
+        description: `
+Filters out values based on the input conditions provided.
+
+For example:
+
+${schemaExample('array.filter')}
+
+Example of how it can be used to filter a number array.
+
+Input:
+
+\`\`\`json
+[1,2,1,3,4,1,5]
+\`\`\`
+
+\`\`\`yaml
+array.filter:
+  equals:
+    - array: item
+    - 1
+\`\`\`
+
+Result:
+
+\`\`\`json
+[1,1,1]
 \`\`\`
     `,
     },

package/reference-schemas/remappers/unsorted.js

@@ -145,6 +145,24 @@ object will be checked. The result looks like this:
             },
         ],
     },
+    type: {
+        enum: [null],
+        description: `Returns the type of the input object
+
+For example, with the following input value:
+\`\`\`json
+[0, 5, 7, 8]
+\`\`\`
+\`\`\`yaml
+type: null
+\`\`\`
+
+The result will be:
+\`\`\`json
+"array"
+\`\`\`
+    `,
+    },
     log: {
         enum: ['info', 'warn', 'error'],
         description: `Logs in the browser's console and returns the incoming data and the remapper function's context.

package/remap.js

@@ -194,6 +194,16 @@ const mapperImplementations = {
         }
         return result;
     },
+    type(args, input) {
+        // eslint-disable-next-line eqeqeq
+        if (input === null) {
+            return null;
+        }
+        if (Array.isArray(input)) {
+            return 'array';
+        }
+        return typeof input;
+    },
     'array.map': (mapper, input, context) => {
         var _a;
         return (_a = input === null || input === void 0 ? void 0 : input.map((item, index) => remap(mapper, item, {
@@ -221,6 +231,19 @@ const mapperImplementations = {
         });
     },
     array: (prop, input, context) => { var _a; return (_a = context.array) === null || _a === void 0 ? void 0 : _a[prop]; },
+    'array.filter'(mapper, input, context) {
+        if (!Array.isArray(input)) {
+            console.error(`${input} is not an array!`);
+            return null;
+        }
+        return input === null || input === void 0 ? void 0 : input.filter((item, index) => {
+            const remapped = remap(mapper, item, {
+                ...context,
+                array: { index, length: input.length, item },
+            });
+            return remapped;
+        });
+    },
     'array.find'(mapper, input, context) {
         var _a;
         if (!Array.isArray(input)) {
@@ -296,7 +319,10 @@ const mapperImplementations = {
             }
         }
         else if (typeof prop === 'number' || typeof prop === 'string') {
-            result = result[prop];
+            result =
+                Array.isArray(result) && typeof prop === 'number' && prop < 0
+                    ? result[result.length + prop]
+                    : result[prop];
         }
         return result;
     },

package/remap.test.js

@@ -723,6 +723,43 @@ describe('object.assign', () => {
         },
     });
 });
+describe('type', () => {
+    runTests({
+        'input array, type remapper test': {
+            input: [
+                { firstName: 'John', lastName: 'Doe' },
+                { firstName: 'Jane', lastName: 'Smith' },
+            ],
+            mappers: { type: null },
+            expected: 'array',
+        },
+        'input object, type remapper test': {
+            input: { firstName: 'John', lastName: 'Doe' },
+            mappers: { type: null },
+            expected: 'object',
+        },
+        'input number, type remapper test': {
+            input: 1,
+            mappers: { type: null },
+            expected: 'number',
+        },
+        'input string, type remapper test': {
+            input: 'I am a string',
+            mappers: { type: null },
+            expected: 'string',
+        },
+        'null input type remapper test': {
+            input: null,
+            mappers: { type: null },
+            expected: null,
+        },
+        'undefined input type remapper test': {
+            input: undefined,
+            mappers: { type: null },
+            expected: 'undefined',
+        },
+    });
+});
 describe('array.map', () => {
     runTests({
         'apply remappers to each array item': {
@@ -877,6 +914,40 @@ describe('array', () => {
         },
     });
 });
+describe('array.filter', () => {
+    runTests({
+        'return a new array containing the object with specified value from array': {
+            input: [{ name: 'Craig' }, { name: 'Joey' }, { name: 'Stuart' }],
+            mappers: [{ 'array.filter': { equals: [{ prop: 'name' }, 'Craig'] } }],
+            expected: [{ name: 'Craig' }],
+        },
+        'return a new array containing the 2 objects with specified value from array': {
+            input: [{ name: 'Craig' }, { name: 'Joey' }, { name: 'Stuart' }, { name: 'Craig' }],
+            mappers: [{ 'array.filter': { equals: [{ prop: 'name' }, 'Craig'] } }],
+            expected: [{ name: 'Craig' }, { name: 'Craig' }],
+        },
+        'return a new array containing a single value when the array does not include objects': {
+            input: ['Craig', 'Joey', 'Stuart'],
+            mappers: [{ 'array.filter': { equals: [{ array: 'item' }, 'Craig'] } }],
+            expected: ['Craig'],
+        },
+        'return an empty array when condition doesn’t match anything': {
+            input: ['Craig', 'Joey', 'Stuart'],
+            mappers: [{ 'array.filter': { equals: [{ array: 'item' }, 'Peter'] } }],
+            expected: [],
+        },
+        'it should filter arrays with mixed content type(string)': {
+            input: ['Craig', 5, 'Joey', 7, 'Stuart'],
+            mappers: [{ 'array.filter': { equals: [{ array: 'item' }, 'Stuart'] } }],
+            expected: ['Stuart'],
+        },
+        'it should filter arrays with mixed content type based on type of the item': {
+            input: ['Craig', 5, 'Joey', 7, 'Stuart'],
+            mappers: [{ 'array.filter': { equals: [{ type: { array: 'item' } }, 'number'] } }],
+            expected: [5, 7],
+        },
+    });
+});
 describe('array.find', () => {
     runTests({
         'return object with specified value from array': {
@@ -1018,6 +1089,16 @@ describe('prop', () => {
             mappers: { prop: 'foo' },
             expected: null,
         },
+        'handle array input': {
+            input: ['one', 'two', 'three', 'four'],
+            mappers: { prop: 1 },
+            expected: 'two',
+        },
+        'handle array input and negative index': {
+            input: ['one', 'two', 'three', 'four'],
+            mappers: { prop: -3 },
+            expected: 'two',
+        },
     });
 });
 describe('random.choice', () => {

package/validation.js

@@ -1150,6 +1150,7 @@ export async function validateAppDefinition(definition, getBlockVersions, contro
         result = validator.validate(definition, {});
     }
     if (!definition) {
+        result.addError('App definition can not be null');
         return result;
     }
     const blocks = getAppBlocks(definition);

package/validation.test.js

@@ -2001,20 +2001,26 @@ describe('validateAppDefinition', () => {
             new ValidationError('there is no-one in the app, who has permissions to use this action', 'resource.get', undefined, ['controller', 'actions', 'onWhatever', 'resource']),
         ]);
     });
-    it('should ignore if an app is null', async () => {
+    it('should throw if an app is null', async () => {
         const result = await validateAppDefinition(null, () => []);
-        expect(result.valid).toBe(true);
-        expect(result.errors).toStrictEqual([]);
-    });
-    it('should if app pages are not an array', async () => {
-        const result = await validateAppDefinition(null, () => []);
-        expect(result.valid).toBe(true);
-        expect(result.errors).toStrictEqual([]);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            expect.objectContaining({
+                message: 'App definition can not be null',
+                instance: null,
+                schema: {},
+            }),
+        ]);
     });
-    it('should report an error if app validation fails for an unexpected reason', async () => {
-        const result = await validateAppDefinition(null, () => []);
-        expect(result.valid).toBe(true);
-        expect(result.errors).toStrictEqual([]);
+    it('should report an error if the defaultPage does not exist', async () => {
+        const result = await validateAppDefinition({ name: 'Test App', pages: [], defaultPage: 'Test Page' }, () => []);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            expect.objectContaining({
+                instance: 'Test Page',
+                message: 'does not refer to an existing page',
+            }),
+        ]);
     });
     it('should handle if an unexpected error occurs', async () => {
         const result = await validateAppDefinition({

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

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