@appsemble/utils 0.40.3-test.4 → 0.40.4

package/README.md

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

package/appMessages.js

@@ -1,4 +1,4 @@
-import { iterApp, } from '@appsemble/lang-sdk';
+import { getRouteMessageId, iterApp, translatableRoutes, } from '@appsemble/lang-sdk';
 import { normalize } from './normalize.js';
 /**
  * Recursively find `string.format` remapper message IDs.
@@ -43,6 +43,7 @@ export function extractAppMessages(app, onBlock) {
                 [`app.roles.${role}`, role],
                 [`app.roles.${role}.description`, roleDefinition.description],
             ])),
+            ...Object.fromEntries(translatableRoutes.map((name) => [getRouteMessageId(name), name])),
         },
         messageIds: {},
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/utils",
-  "version": "0.40.3-test.4",
+  "version": "0.40.4",
   "description": "Utility functions used in Appsemble internally",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/lang-sdk": "0.40.3-test.4",
-    "@appsemble/types": "0.40.3-test.4",
+    "@appsemble/lang-sdk": "0.40.4",
+    "@appsemble/types": "0.40.4",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "axios": "^1.0.0",
     "langmap": "^0.0.16",

package/validateAppMessages.d.ts

@@ -4,3 +4,17 @@ export declare class AppMessageValidationError extends Error {
     constructor(message: string);
 }
 export declare function validateMessages(messages: AppsembleMessages, app: AppDefinition): void;
+/**
+ * Validate the URL segments an app serves in a language.
+ *
+ * The app messages of the language are the extracted defaults of the definition, overlaid by each
+ * layer in order. An empty string in a layer keeps the value below it. A page's segment is its
+ * normalized translated name, or the normalized page name when the translated name has no Latin
+ * letters or digits. A route's segment is its `routes.<Name>` message as written.
+ *
+ * @param app The app definition the messages belong to.
+ * @param language The language the layers are served as, used in the error message.
+ * @param layers The stored messages that make up the language, lowest layer first: the base
+ *   language row, then the regional row.
+ */
+export declare function validateMessageSlugs(app: AppDefinition, language: string, layers: Partial<AppsembleMessages>[]): void;

package/validateAppMessages.js

@@ -1,6 +1,8 @@
-import { normalizeBlockName } from '@appsemble/lang-sdk';
+import { getPageMessageId, getRouteMessageId, normalizeBlockName, translatableRoutes, } from '@appsemble/lang-sdk';
 import { extractAppMessages } from './appMessages.js';
 import { has } from './miscellaneous.js';
+import { normalize } from './normalize.js';
+const routeSegmentPattern = /^[A-Z][\dA-Za-z-]*$/;
 export class AppMessageValidationError extends Error {
     constructor(message) {
         super(message);
@@ -70,4 +72,64 @@ This block version is not used in the app`);
         }
     }
 }
+function collectPages(pages) {
+    return pages.flatMap((page) => page.type === 'container' ? [page, ...collectPages(page.pages)] : [page]);
+}
+/**
+ * Validate the URL segments an app serves in a language.
+ *
+ * The app messages of the language are the extracted defaults of the definition, overlaid by each
+ * layer in order. An empty string in a layer keeps the value below it. A page's segment is its
+ * normalized translated name, or the normalized page name when the translated name has no Latin
+ * letters or digits. A route's segment is its `routes.<Name>` message as written.
+ *
+ * @param app The app definition the messages belong to.
+ * @param language The language the layers are served as, used in the error message.
+ * @param layers The stored messages that make up the language, lowest layer first: the base
+ *   language row, then the regional row.
+ */
+export function validateMessageSlugs(app, language, layers) {
+    const appMessages = { ...extractAppMessages(app).app };
+    for (const layer of layers) {
+        for (const [key, value] of Object.entries(layer.app ?? {})) {
+            if (typeof value === 'string' && value) {
+                appMessages[key] = value;
+            }
+        }
+    }
+    const pages = collectPages(app.pages ?? []);
+    const canonicalSegments = new Map(pages.map((page) => [normalize(page.name), page]));
+    const translatedSegments = new Map();
+    for (const page of pages) {
+        const canonical = normalize(page.name);
+        // A translated name without Latin letters or digits keeps the canonical segment.
+        const segment = normalize(appMessages[getPageMessageId(page.name)]) || canonical;
+        if (segment !== canonical) {
+            if (segment === 'debug') {
+                throw new AppMessageValidationError(`Language “${language}”: the translated name of page “${page.name}” has the reserved URL segment “debug”`);
+            }
+            const other = translatedSegments.get(segment) ?? canonicalSegments.get(segment);
+            if (other) {
+                throw new AppMessageValidationError(`Language “${language}”: pages “${other.name}” and “${page.name}” share the URL segment “${segment}”`);
+            }
+        }
+        translatedSegments.set(segment, page);
+    }
+    const routeSegments = translatableRoutes.map((name) => [name, appMessages[getRouteMessageId(name)]]);
+    for (const [name, segment] of routeSegments) {
+        if (segment === name) {
+            continue;
+        }
+        if (!routeSegmentPattern.test(segment)) {
+            throw new AppMessageValidationError(`Language “${language}”: the URL segment “${segment}” of route “${name}” must start with an uppercase letter and may only contain letters, digits and hyphens`);
+        }
+        if (segment === 'Callback' || segment.toLowerCase() === 'debug') {
+            throw new AppMessageValidationError(`Language “${language}”: the URL segment “${segment}” of route “${name}” is reserved`);
+        }
+        const other = routeSegments.find(([otherName, otherSegment]) => otherName !== name && (segment === otherName || segment === otherSegment));
+        if (other) {
+            throw new AppMessageValidationError(`Language “${language}”: routes “${name}” and “${other[0]}” share the URL segment “${segment}”`);
+        }
+    }
+}
 //# sourceMappingURL=validateAppMessages.js.map