@appsemble/utils 0.28.9 → 0.28.11

package/README.md

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

package/api/components/schemas/SubPage.js

@@ -5,10 +5,8 @@ export const SubPage = {
     additionalProperties: false,
     properties: {
         name: {
-            type: 'string',
+            $ref: '#/components/schemas/RemapperDefinition',
             description: 'The name of the sub page.',
-            minLength: 1,
-            maxLength: 50,
         },
         roles: {
             type: 'array',

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

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

package/api/components/schemas/TabsPageActionsDefinition.js

@@ -0,0 +1,12 @@
+export const TabsPageActionsDefinition = {
+    type: 'object',
+    description: 'Action fired on page events',
+    additionalProperties: false,
+    properties: {
+        onLoad: {
+            $ref: '#/components/schemas/ActionDefinition',
+            description: '',
+        },
+    },
+};
+//# sourceMappingURL=TabsPageActionsDefinition.js.map

package/api/components/schemas/TabsPageDefinition.js

@@ -3,7 +3,14 @@ import { extendJSONSchema } from './utils.js';
 export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
     type: 'object',
     description: 'This describes what a page will look like in the app.',
-    required: ['type', 'tabs'],
+    oneOf: [
+        {
+            required: ['type', 'tabs'],
+        },
+        {
+            required: ['type', 'definition'],
+        },
+    ],
     additionalProperties: true,
     properties: {
         type: {
@@ -17,6 +24,23 @@ export const TabsPageDefinition = extendJSONSchema(BasePageDefinition, {
                 $ref: '#/components/schemas/SubPage',
             },
         },
+        definition: {
+            type: 'object',
+            additionalProperties: false,
+            description: 'Generate tabs dynamically',
+            required: ['events', 'foreach'],
+            properties: {
+                events: {
+                    $ref: '#/components/schemas/EventsDefinition',
+                },
+                foreach: {
+                    $ref: '#/components/schemas/SubPage',
+                },
+            },
+        },
+        actions: {
+            $ref: '#/components/schemas/TabsPageActionsDefinition',
+        },
     },
 });
 //# sourceMappingURL=TabsPageDefinition.js.map

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

@@ -129,5 +129,6 @@ export * from './UserQueryActionDefinition.js';
 export * from './UserRemoveActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
+export * from './TabsPageActionsDefinition.js';
 export * from './UsersDefinition.js';
 export * from './UserPropertyDefinition.js';

package/api/components/schemas/index.js

@@ -129,6 +129,7 @@ export * from './UserQueryActionDefinition.js';
 export * from './UserRemoveActionDefinition.js';
 export * from './LoopPageDefinition.js';
 export * from './LoopPageActionsDefinition.js';
+export * from './TabsPageActionsDefinition.js';
 export * from './UsersDefinition.js';
 export * from './UserPropertyDefinition.js';
 //# sourceMappingURL=index.js.map

package/api/index.test.js

@@ -66,6 +66,7 @@ describe('schemas', () => {
         it.each(entries.filter(([, schema]) => schema.type === 'object'))('%s', (path, schema) => {
             // Action descriptions are defined on the type property.
             const descriptionSchema = path.endsWith('ActionDefinition') ? schema.properties.type : schema;
+            const isTabsPageDefinition = path.endsWith('TabsPageDefinition');
             expect(schema).not.toHaveProperty('additionalItems');
             expect(schema).toHaveProperty('additionalProperties');
             expect(schema).not.toHaveProperty('allOf');
@@ -85,7 +86,10 @@ describe('schemas', () => {
             expect(schema).not.toHaveProperty('minItems');
             expect(schema).not.toHaveProperty('minLength');
             expect(schema).not.toHaveProperty('multipleOf');
-            expect(schema).not.toHaveProperty('oneOf');
+            if (!isTabsPageDefinition) {
+                // eslint-disable-next-line vitest/no-conditional-expect
+                expect(schema).not.toHaveProperty('oneOf');
+            }
             expect(schema).not.toHaveProperty('then');
             expect(schema).not.toHaveProperty('uniqueItems');
             if (schema.required && !schema.additionalProperties) {

package/appMessages.js

@@ -93,14 +93,16 @@ export function extractAppMessages(app, onBlock) {
             var _a, _b;
             const prefix = `pages.${normalize(page.name)}`;
             messages.app[prefix] = page.name;
-            if (page.type === 'tabs') {
+            if (page.type === 'tabs' && Array.isArray(page.tabs)) {
                 for (const [index, tab] of page.tabs.entries()) {
-                    messages.app[`${prefix}.tabs.${index}`] = (_a = tab.name) !== null && _a !== void 0 ? _a : '';
+                    messages.app[`${prefix}.tabs.${index}`] =
+                        (_a = (typeof tab.name === 'string' ? tab.name : '')) !== null && _a !== void 0 ? _a : '';
                 }
             }
             if (page.type === 'flow') {
                 for (const [index, step] of page.steps.entries()) {
-                    messages.app[`${prefix}.steps.${index}`] = (_b = step.name) !== null && _b !== void 0 ? _b : '';
+                    messages.app[`${prefix}.steps.${index}`] =
+                        (_b = (typeof step.name === 'string' ? step.name : '')) !== null && _b !== void 0 ? _b : '';
                 }
             }
             if (page.type === 'loop') {

package/examples.js

@@ -598,6 +598,12 @@ export const examples = {
         result: {},
         skip: true,
     },
+    'tab.name': {
+        input: null,
+        remapper: {},
+        result: {},
+        skip: true,
+    },
     'string.case': {
         input: 'Patrick',
         remapper: {

package/iterApp.js

@@ -102,7 +102,14 @@ export function iterPage(page, callbacks, prefix = []) {
         return (result ||
             (page.type === 'flow'
                 ? page.steps.some((step, index) => iterBlockList(step.blocks, callbacks, [...prefix, 'steps', index, 'blocks']))
-                : page.tabs.some((tab, index) => iterBlockList(tab.blocks, callbacks, [...prefix, 'tabs', index, 'blocks']))));
+                : page.tabs
+                    ? page.tabs.some((tab, index) => iterBlockList(tab.blocks, callbacks, [...prefix, 'tabs', index, 'blocks']))
+                    : iterBlockList(page.definition.foreach.blocks, callbacks, [
+                        ...prefix,
+                        'tabs',
+                        0,
+                        'blocks',
+                    ])));
     }
     if (page.type === 'loop') {
         let result = false;

package/package.json

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

package/reference-schemas/remappers/data.js

@@ -90,6 +90,30 @@ Result:
   "title": "Most influential bands of all time",
   "content": ...
 }
+\`\`\`
+    `,
+    },
+    'tab.name': {
+        enum: [null],
+        description: `
+
+Returns the name of the current tab in a \`tabs\` page.
+
+\`\`\`yaml
+name: Example Page A
+type: tabs
+  tabs:
+    - name: Tab2
+      blocks:
+        - type: action-button
+          version: "0.27.12"
+          parameters:
+            icon: chevron-right
+          actions:
+            onClick:
+              type: log
+              remapBefore:
+                { tab.name: null }
 \`\`\`
     `,
     },

package/remap.d.ts

@@ -68,6 +68,9 @@ interface InternalContext extends RemapperContext {
     stepRef?: {
         current: Record<string, any>;
     };
+    tabRef?: {
+        current: Record<string, any>;
+    };
 }
 export declare function remap(remapper: Remapper, input: unknown, context: InternalContext | RemapperContext): unknown;
 export {};

package/remap.js

@@ -107,6 +107,9 @@ const mapperImplementations = {
     step(mapper, input, context) {
         return context.stepRef.current[mapper];
     },
+    'tab.name'(mapper, input, context) {
+        return context.tabRef.current.name;
+    },
     gt: ([left, right], input, context) => remap(left, input, context) > remap(right, input, context),
     lt: ([left, right], input, context) => remap(left, input, context) < remap(right, input, context),
     ics(mappers, input, context) {

package/validation.js

@@ -619,7 +619,7 @@ function validateActions(definition, report) {
                     ]);
                     return;
                 }
-                if (toPage.type === 'tabs' && toSub) {
+                if (toPage.type === 'tabs' && toSub && Array.isArray(toPage.tabs)) {
                     const subPage = toPage.tabs.find(({ name }) => name === toSub);
                     if (!subPage) {
                         report(toSub, 'refers to a tab that doesn’t exist', [...path, 'to', 1]);
@@ -705,6 +705,21 @@ function validateEvents(definition, blockVersions, report) {
                 collect([...path, 'waitFor'], action.waitFor, false);
             }
         },
+        onPage(page, path) {
+            if (!(page.type === 'tabs') || page.tabs) {
+                return;
+            }
+            if (page.definition.events.emit) {
+                for (const [prefix, name] of Object.entries(page.definition.events.emit)) {
+                    collect([...path, 'events', 'emit', prefix], name, true);
+                }
+            }
+            if (page.definition.events.listen) {
+                for (const [prefix, name] of Object.entries(page.definition.events.listen)) {
+                    collect([...path, 'events', 'listen', prefix], name, false);
+                }
+            }
+        },
         onBlock(block, path) {
             if (!block.events) {
                 return;