@appsemble/lang-sdk 0.40.3-test.4 → 0.40.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/lang-sdk",
-  "version": "0.40.3-test.4",
+  "version": "0.40.3",
   "description": "Language SDK for Appsemble",
   "keywords": [
     "app",

package/pageUtils.d.ts

@@ -1,10 +1,44 @@
 import { type MessageGetter } from './remap.js';
 import { type PageDefinition } from './types/index.js';
 type NamedPage = Pick<PageDefinition, 'name'>;
+/**
+ * The built-in routes whose URL segment an app may translate through a `routes.<Name>` message.
+ */
+export declare const translatableRoutes: readonly ["Login", "Register", "Settings", "Reset-Password", "Edit-Password", "Verify", "Group-Invite", "App-Invite", "Feedback"];
+export type TranslatableRoute = (typeof translatableRoutes)[number];
 export declare function getPageMessageId(pageName: string): string;
-export declare function getPagePathSegment(page: string | NamedPage): string;
+export declare function getRouteMessageId(name: TranslatableRoute): string;
 export declare function getPageDisplayName(page: NamedPage, getAppMessage: MessageGetter): string;
-export declare function findPageById(pages: PageDefinition[], normalizedPageId: string, appMessageIds: string[], getAppMessage: MessageGetter): PageDefinition | null;
+/**
+ * Get the URL segment of a page in the current language.
+ *
+ * @param page The page to get the segment of.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The normalized translated page name. It equals the canonical segment
+ *   `normalize(page.name)` when the page name is untranslated, or when the translated name has no
+ *   Latin letters or digits to build a segment from.
+ */
+export declare function getPagePathSegment(page: NamedPage, getAppMessage: MessageGetter): string;
+/**
+ * Get the URL segment of a built-in route in the current language.
+ *
+ * @param name The English name of the built-in route.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The `routes.<name>` message as written, falling back to the English name.
+ */
+export declare function getRouteSegment(name: TranslatableRoute, getAppMessage: MessageGetter): string;
+/**
+ * Find a page by the `:pageId` URL segment.
+ *
+ * Translated segments are matched before canonical ones, so a link generated in the current
+ * language always resolves to the page it was generated for. The canonical segment is an alias.
+ *
+ * @param pages The pages of the app, containers included.
+ * @param normalizedPageId The normalized `:pageId` URL segment.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The matching page, or null if no page has the segment.
+ */
+export declare function findPageById(pages: PageDefinition[], normalizedPageId: string, getAppMessage: MessageGetter): PageDefinition | null;
 /**
  * Collect the pages a page sits under, by following `parent` upwards.
  *

package/pageUtils.js

@@ -1,10 +1,24 @@
 import { findPageByName } from './findPageByName.js';
 import { normalize } from './normalize.js';
+/**
+ * The built-in routes whose URL segment an app may translate through a `routes.<Name>` message.
+ */
+export const translatableRoutes = [
+    'Login',
+    'Register',
+    'Settings',
+    'Reset-Password',
+    'Edit-Password',
+    'Verify',
+    'Group-Invite',
+    'App-Invite',
+    'Feedback',
+];
 export function getPageMessageId(pageName) {
     return `pages.${normalize(pageName)}`;
 }
-export function getPagePathSegment(page) {
-    return normalize(typeof page === 'string' ? page : page.name);
+export function getRouteMessageId(name) {
+    return `routes.${name}`;
 }
 export function getPageDisplayName(page, getAppMessage) {
     return getAppMessage({
@@ -12,23 +26,35 @@ export function getPageDisplayName(page, getAppMessage) {
         defaultMessage: page.name,
     }).format();
 }
-function matchesPageId(page, normalizedPageId, appMessageIds, getAppMessage) {
-    if (getPagePathSegment(page) === normalizedPageId) {
-        return true;
-    }
-    const pageMessageId = getPageMessageId(page.name);
-    if (!appMessageIds.includes(pageMessageId)) {
-        return false;
-    }
-    return normalize(getPageDisplayName(page, getAppMessage)) === normalizedPageId;
+/**
+ * Get the URL segment of a page in the current language.
+ *
+ * @param page The page to get the segment of.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The normalized translated page name. It equals the canonical segment
+ *   `normalize(page.name)` when the page name is untranslated, or when the translated name has no
+ *   Latin letters or digits to build a segment from.
+ */
+export function getPagePathSegment(page, getAppMessage) {
+    return normalize(getPageDisplayName(page, getAppMessage)) || normalize(page.name);
+}
+/**
+ * Get the URL segment of a built-in route in the current language.
+ *
+ * @param name The English name of the built-in route.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The `routes.<name>` message as written, falling back to the English name.
+ */
+export function getRouteSegment(name, getAppMessage) {
+    return getAppMessage({ id: getRouteMessageId(name), defaultMessage: name }).format();
 }
-export function findPageById(pages, normalizedPageId, appMessageIds, getAppMessage) {
+function findPage(pages, matches) {
     for (const page of pages) {
-        if (matchesPageId(page, normalizedPageId, appMessageIds, getAppMessage)) {
+        if (matches(page)) {
             return page;
         }
         if (page.type === 'container') {
-            const foundPage = findPageById(page.pages, normalizedPageId, appMessageIds, getAppMessage);
+            const foundPage = findPage(page.pages, matches);
             if (foundPage) {
                 return foundPage;
             }
@@ -36,6 +62,21 @@ export function findPageById(pages, normalizedPageId, appMessageIds, getAppMessa
     }
     return null;
 }
+/**
+ * Find a page by the `:pageId` URL segment.
+ *
+ * Translated segments are matched before canonical ones, so a link generated in the current
+ * language always resolves to the page it was generated for. The canonical segment is an alias.
+ *
+ * @param pages The pages of the app, containers included.
+ * @param normalizedPageId The normalized `:pageId` URL segment.
+ * @param getAppMessage The app message getter of the current language.
+ * @returns The matching page, or null if no page has the segment.
+ */
+export function findPageById(pages, normalizedPageId, getAppMessage) {
+    return (findPage(pages, (page) => getPagePathSegment(page, getAppMessage) === normalizedPageId) ??
+        findPage(pages, (page) => normalize(page.name) === normalizedPageId));
+}
 /**
  * Resolve which parent page applies to a member.
  *

package/validation.d.ts

@@ -1,6 +1,7 @@
 import { type ValidatorResult } from 'jsonschema';
 import { type Promisable } from 'type-fest';
 import { type IdentifiableBlock } from './blockUtils.js';
+import { type TranslatableRoute } from './pageUtils.js';
 import { type AppDefinition, type BlockManifest, type ProjectImplementations, type Remapper } from './types/index.js';
 /**
  * Check whether or not the given link represents a link related to the Appsemble core.
@@ -8,7 +9,7 @@ import { type AppDefinition, type BlockManifest, type ProjectImplementations, ty
  * @param link The link to check
  * @returns Whether or not the given link represents a link related to the Appsemble core.
  */
-export declare function isAppLink(link: Remapper | string[] | string): boolean;
+export declare function isAppLink(link: Remapper | string[] | string): link is `/${TranslatableRoute}`;
 export type BlockVersionsGetter = (blockMap: IdentifiableBlock[]) => Promisable<BlockManifest[]>;
 /**
  * Validate an app definition.