@appsemble/utils 0.29.9 → 0.29.11

package/README.md

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

package/api/components/schemas/AppDefinition.js

@@ -96,6 +96,7 @@ The most basic resource has a \`schema\` property and defines the minimal securi
                     { $ref: '#/components/schemas/TabsPageDefinition' },
                     { $ref: '#/components/schemas/FlowPageDefinition' },
                     { $ref: '#/components/schemas/LoopPageDefinition' },
+                    { $ref: '#/components/schemas/ContainerPageDefinition' },
                 ],
             },
         },

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

@@ -0,0 +1 @@
+export declare const ContainerPageDefinition: import("openapi-types").OpenAPIV3.SchemaObject;

package/api/components/schemas/ContainerPageDefinition.js

@@ -0,0 +1,55 @@
+import { BasePageDefinition } from './BasePageDefinition.js';
+import { extendJSONSchema } from './utils.js';
+export const ContainerPageDefinition = extendJSONSchema(BasePageDefinition, {
+    type: 'object',
+    additionalProperties: false,
+    description: `Use this page type to group pages in the menu, this doesn't actually group pages for now. Following is an example of how this can be used
+\`\`\`yaml
+pages:
+  - name: Page 1
+    type: container
+    pages:
+      - name: Contained page 1
+        blocks:
+          - type: action-button
+            version: 0.29.8
+            parameters:
+              icon: git-alt
+            actions:
+              onClick:
+                type: link
+                to: Contained page 2
+      - name: Contained page 2
+        blocks:
+          - type: action-button
+            version: 0.29.8
+            parameters:
+              icon: git-alt
+            actions:
+              onClick:
+                type: link
+                to: Contained page 1
+\`\`\`
+`,
+    required: ['type', 'pages'],
+    properties: {
+        type: {
+            enum: ['container'],
+        },
+        pages: {
+            type: 'array',
+            minItems: 1,
+            description: 'The pages of the app.',
+            items: {
+                anyOf: [
+                    { $ref: '#/components/schemas/PageDefinition' },
+                    { $ref: '#/components/schemas/TabsPageDefinition' },
+                    { $ref: '#/components/schemas/FlowPageDefinition' },
+                    { $ref: '#/components/schemas/LoopPageDefinition' },
+                    { $ref: '#/components/schemas/ContainerPageDefinition' },
+                ],
+            },
+        },
+    },
+});
+//# sourceMappingURL=ContainerPageDefinition.js.map

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

@@ -20,6 +20,7 @@ export * from './BlockVersion.js';
 export * from './ConditionActionDefinition.js';
 export * from './CronDefinition.js';
 export * from './ContainerDefinition.js';
+export * from './ContainerPageDefinition.js';
 export * from './CustomFontDefinition.js';
 export * from './DialogActionDefinition.js';
 export * from './DialogErrorActionDefinition.js';

package/api/components/schemas/index.js

@@ -20,6 +20,7 @@ export * from './BlockVersion.js';
 export * from './ConditionActionDefinition.js';
 export * from './CronDefinition.js';
 export * from './ContainerDefinition.js';
+export * from './ContainerPageDefinition.js';
 export * from './CustomFontDefinition.js';
 export * from './DialogActionDefinition.js';
 export * from './DialogErrorActionDefinition.js';

package/findPageByName.d.ts

@@ -0,0 +1,2 @@
+import { type PageDefinition } from '@appsemble/types';
+export declare function findPageByName(pages: PageDefinition[], name: string): PageDefinition | undefined;

package/findPageByName.js

@@ -0,0 +1,15 @@
+export function findPageByName(pages, name) {
+    for (const page of pages) {
+        if (page.name === name) {
+            return page;
+        }
+        if (page.type === 'container' && page.pages) {
+            const found = findPageByName(page.pages, name);
+            if (found) {
+                return found;
+            }
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=findPageByName.js.map

package/index.d.ts

@@ -31,3 +31,4 @@ export * from './serializeResource.js';
 export * from './convertToCsv.js';
 export * from './assets.js';
 export * from './validateAppMessages.js';
+export * from './findPageByName.js';

package/index.js

@@ -31,4 +31,5 @@ export * from './serializeResource.js';
 export * from './convertToCsv.js';
 export * from './assets.js';
 export * from './validateAppMessages.js';
+export * from './findPageByName.js';
 //# sourceMappingURL=index.js.map

package/iterApp.js

@@ -119,6 +119,13 @@ export function iterPage(page, callbacks, prefix = []) {
         return (result ||
             ['steps.first', 'steps', 'steps.last'].some((suffix) => iterBlockList(page.foreach.blocks, callbacks, [...prefix, suffix, 'blocks'])));
     }
+    if (page.type === 'container') {
+        let result = false;
+        for (const containerPage of page.pages) {
+            result = iterPage(containerPage, callbacks, prefix);
+        }
+        return result;
+    }
     return iterBlockList(page.blocks, callbacks, [...prefix, 'blocks']);
 }
 /**

package/iterApp.test.js

@@ -235,6 +235,33 @@ describe('iterPage', () => {
         expect(onPage).toHaveBeenCalledWith(page, []);
         expect(result).toBe(false);
     });
+    it('should iterate over a container page', () => {
+        const onBlockList = vi.fn();
+        const onPage = vi.fn();
+        const page = {
+            name: 'Container Page',
+            type: 'container',
+            pages: [
+                {
+                    name: 'Page 1',
+                    blocks: [],
+                },
+                {
+                    name: 'Page 2',
+                    blocks: [],
+                },
+            ],
+        };
+        const result = iterPage(page, { onBlockList, onPage });
+        expect(onBlockList).toHaveBeenCalledWith(page.pages[0].blocks, [
+            'blocks',
+        ]);
+        expect(onBlockList).toHaveBeenCalledWith(page.pages[1].blocks, [
+            'blocks',
+        ]);
+        expect(onPage).toHaveBeenCalledWith(page, []);
+        expect(result).toBe(false);
+    });
     it('should abort if onPage returns true', () => {
         const onBlockList = vi.fn();
         const onPage = vi.fn().mockReturnValue(true);

package/package.json

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

package/validateAppMessages.js

@@ -46,7 +46,7 @@ export function validateMessages(messages, app) {
     }
     const coreMessages = (_a = messages.core) !== null && _a !== void 0 ? _a : {};
     for (const [key, value] of Object.entries(coreMessages)) {
-        if (!value || typeof value !== 'string') {
+        if (typeof value !== 'string') {
             throw new AppMessageValidationError(`Invalid translation key: core.${key}`);
         }
     }

package/validation.js

@@ -3,7 +3,7 @@ import { ValidationError, Validator } from 'jsonschema';
 import languageTags from 'language-tags';
 import { getAppBlocks, normalizeBlockName } from './blockUtils.js';
 import { has } from './has.js';
-import { partialNormalized } from './index.js';
+import { findPageByName, normalize, partialNormalized } from './index.js';
 import { iterApp } from './iterApp.js';
 import { serverActions } from './serverActions.js';
 /**
@@ -34,6 +34,37 @@ function validateJSONSchema(schema, prefix, report) {
         }
     }
 }
+/**
+ * Validates the pages in the app definition to ensure there are no duplicate page names.
+ *
+ * @param definition The definition of the app
+ * @param report A function used to report a value.
+ */
+function validateUniquePageNames(definition, report) {
+    if (!definition.pages) {
+        return;
+    }
+    const pageNames = new Map();
+    function checkPages(pages, parentPath = []) {
+        for (const page of pages) {
+            const pageName = page.name;
+            const normalizedPageName = normalize(page.name);
+            const pagePath = [...parentPath, pageName];
+            if (pageNames.has(normalizedPageName)) {
+                const paths = pageNames.get(normalizedPageName);
+                paths.push(pagePath);
+                report(pageName, 'is a duplicate page name', pagePath);
+            }
+            else {
+                pageNames.set(normalizedPageName, [pagePath]);
+            }
+            if (page.type === 'container') {
+                checkPages(page.pages, pagePath);
+            }
+        }
+    }
+    checkPages(definition.pages);
+}
 function validateUsersSchema(definition, report) {
     var _a;
     if (!definition.users) {
@@ -462,7 +493,7 @@ function validateLanguage({ defaultLanguage }, report) {
     }
 }
 function validateDefaultPage({ defaultPage, pages }, report) {
-    const page = pages === null || pages === void 0 ? void 0 : pages.find((p) => p.name === defaultPage);
+    const page = findPageByName(pages, defaultPage);
     if (!page) {
         report(defaultPage, 'does not refer to an existing page', ['defaultPage']);
         return;
@@ -606,7 +637,7 @@ function validateActions(definition, report) {
                     return;
                 }
                 const [toBase, toSub] = [].concat(to);
-                const toPage = definition.pages.find(({ name }) => name === toBase);
+                const toPage = findPageByName(definition.pages, toBase);
                 if (!toPage) {
                     report(to, 'refers to a page that doesn’t exist', [...path, 'to']);
                     return;
@@ -833,6 +864,7 @@ export async function validateAppDefinition(definition, getBlockVersions, contro
         validateBlocks(definition, blockVersionMap, report);
         validateActions(definition, report);
         validateEvents(definition, blockVersionMap, report);
+        validateUniquePageNames(definition, report);
     }
     catch (error) {
         report(null, `Unexpected error: ${error instanceof Error ? error.message : error}`, []);

package/validation.test.js

@@ -43,6 +43,16 @@ function createTestApp() {
                     { name: 'Step B', blocks: [] },
                 ],
             },
+            {
+                name: 'Container Page 1',
+                type: 'container',
+                pages: [
+                    {
+                        name: 'Contained Page',
+                        blocks: [],
+                    },
+                ],
+            },
         ],
     };
 }
@@ -85,6 +95,24 @@ describe('validateAppDefinition', () => {
             ]),
         ]);
     });
+    it('should report duplicate page names', async () => {
+        const app = createTestApp();
+        app.pages.push({
+            name: 'Container Page',
+            type: 'container',
+            pages: [{ name: 'Test Page', blocks: [] }],
+        });
+        const result = await validateAppDefinition(app, () => [
+            { name: '@appsemble/test', version: '0.0.0', files: [], languages: [] },
+        ]);
+        expect(result.valid).toBe(false);
+        expect(result.errors).toStrictEqual([
+            new ValidationError('is a duplicate page name', 'Test Page', undefined, [
+                'Container Page',
+                'Test Page',
+            ]),
+        ]);
+    });
     it('should validate block parameters', async () => {
         const app = createTestApp();
         app.pages[0].blocks.push({
@@ -1445,6 +1473,10 @@ describe('validateAppDefinition', () => {
             ]),
         ]);
     });
+    it('should check if the default page exists inside contained page', async () => {
+        const result = await validateAppDefinition({ ...createTestApp(), defaultPage: 'Contained Page' }, () => []);
+        expect(result.valid).toBe(true);
+    });
     it('should validate the default page doesn’t specify parameters', async () => {
         const result = await validateAppDefinition({ ...createTestApp(), defaultPage: 'Page with parameters' }, () => []);
         expect(result.valid).toBe(false);