@appsemble/utils 0.20.10 → 0.20.11

package/appMessages.test.ts

@@ -0,0 +1,432 @@
+import { extractAppMessages, findMessageIds } from './appMessages';
+
+describe('findMessageIds', () => {
+  it('should ignore null', () => {
+    const result = findMessageIds(null);
+    expect(result).toStrictEqual({});
+  });
+
+  it('should ignore non-object values', () => {
+    const result = findMessageIds('A string');
+    expect(result).toStrictEqual({});
+  });
+
+  it('should find message ids from a string.format remapper', () => {
+    const result = findMessageIds({ 'string.format': { messageId: 'foo' } });
+    expect(result).toStrictEqual({ foo: '' });
+  });
+
+  it('should return the message template', () => {
+    const result = findMessageIds({ 'string.format': { messageId: 'foo', template: 'bar' } });
+    expect(result).toStrictEqual({ foo: 'bar' });
+  });
+
+  it('should ignore non-string message ids', () => {
+    const result = findMessageIds({ 'string.format': { messageId: 12 } });
+    expect(result).toStrictEqual({});
+  });
+
+  it('should missing message ids', () => {
+    const result = findMessageIds({ 'string.format': {} });
+    expect(result).toStrictEqual({});
+  });
+
+  it('should recurse into arrays', () => {
+    const result = findMessageIds([
+      { 'string.format': { messageId: 'foo' } },
+      { 'string.format': { messageId: 'bar' } },
+    ]);
+    expect(result).toStrictEqual({ foo: '', bar: '' });
+  });
+
+  it('should recurse into objects', () => {
+    const result = findMessageIds({
+      foo: { 'string.format': { messageId: 'fooz' } },
+      bar: { 'string.format': { messageId: 'baz' } },
+    });
+    expect(result).toStrictEqual({ fooz: '', baz: '' });
+  });
+
+  it('should extract string.format remapper values', () => {
+    const result = findMessageIds({
+      'string.format': { messageId: 'foo', values: { translate: 'bar' } },
+    });
+    expect(result).toStrictEqual({ foo: '', bar: '' });
+  });
+});
+
+describe('extractAppMessages', () => {
+  it('should extract page prefixes', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        { name: 'First Page', blocks: [] },
+        { name: 'Second Page', blocks: [] },
+      ],
+    });
+    expect(result).toMatchObject({
+      app: { 'pages.first-page': 'First Page', 'pages.second-page': 'Second Page' },
+    });
+  });
+
+  it('should extract block header remappers', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            { type: 'test', version: '1.2.3', header: { 'string.format': { messageId: 'foo' } } },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({ messageIds: { foo: '' }, app: { 'pages.page': 'Page' } });
+  });
+
+  it('should extract remappers from block parameters', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              parameters: { foo: { 'string.format': { messageId: 'foo' } } },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({ messageIds: { foo: '' }, app: { 'pages.page': 'Page' } });
+  });
+
+  it('should extract action remap', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'noop',
+                  remap: { 'string.format': { messageId: 'onClickMessageId' } },
+                  onError: {
+                    type: 'noop',
+                    remap: { 'string.format': { messageId: 'onErrorMessageId' } },
+                  },
+                  onSuccess: {
+                    type: 'noop',
+                    remap: { 'string.format': { messageId: 'onSuccessMessageId' } },
+                  },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { onClickMessageId: '', onErrorMessageId: '', onSuccessMessageId: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract condition action if', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'condition',
+                  if: { translate: 'ifCondition' },
+                  then: { type: 'noop' },
+                  else: { type: 'noop' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { ifCondition: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract dialog action title', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'dialog',
+                  title: { translate: 'dialogTitle' },
+                  blocks: [],
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { dialogTitle: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract email action remappers', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'email',
+                  attachments: { translate: 'attachments' },
+                  bcc: { translate: 'bcc' },
+                  body: { translate: 'body' },
+                  cc: { translate: 'cc' },
+                  subject: { translate: 'subject' },
+                  to: { translate: 'to' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { attachments: '', bcc: '', body: '', cc: '', subject: '', to: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract flow.to action step', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'flow.to',
+                  step: { translate: 'toPage' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { toPage: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract message action body', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'message',
+                  body: { translate: 'messageBody' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { messageBody: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract request action remappers', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onRequest: {
+                  type: 'request',
+                  body: { translate: 'requestBody' },
+                  query: { translate: 'requestQuery' },
+                  url: { translate: 'requestUrl' },
+                },
+                onResourceCount: {
+                  type: 'resource.count',
+                  resource: 'test',
+                  body: { translate: 'resourceCountBody' },
+                  query: { translate: 'resourceCountQuery' },
+                  url: { translate: 'resourceCountUrl' },
+                },
+                onResourceCreate: {
+                  type: 'resource.create',
+                  resource: 'test',
+                  body: { translate: 'resourceCreateBody' },
+                  query: { translate: 'resourceCreateQuery' },
+                  url: { translate: 'resourceCreateUrl' },
+                },
+                onResourceDelete: {
+                  type: 'resource.delete',
+                  resource: 'test',
+                  body: { translate: 'resourceDeleteBody' },
+                  query: { translate: 'resourceDeleteQuery' },
+                  url: { translate: 'resourceDeleteUrl' },
+                },
+                onResourceGet: {
+                  type: 'resource.get',
+                  resource: 'test',
+                  body: { translate: 'resourceGetBody' },
+                  query: { translate: 'resourceGetQuery' },
+                  url: { translate: 'resourceGetUrl' },
+                },
+                onResourceQuery: {
+                  type: 'resource.query',
+                  resource: 'test',
+                  body: { translate: 'resourceQueryBody' },
+                  query: { translate: 'resourceQueryQuery' },
+                  url: { translate: 'resourceQueryUrl' },
+                },
+                onResourceUpdate: {
+                  type: 'resource.update',
+                  resource: 'test',
+                  body: { translate: 'resourceUpdateBody' },
+                  query: { translate: 'resourceUpdateQuery' },
+                  url: { translate: 'resourceUpdateUrl' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: {
+        requestBody: '',
+        requestQuery: '',
+        requestUrl: '',
+        resourceCountBody: '',
+        resourceCountQuery: '',
+        resourceCountUrl: '',
+        resourceCreateBody: '',
+        resourceCreateQuery: '',
+        resourceCreateUrl: '',
+        resourceDeleteBody: '',
+        resourceDeleteQuery: '',
+        resourceDeleteUrl: '',
+        resourceGetBody: '',
+        resourceGetQuery: '',
+        resourceGetUrl: '',
+        resourceQueryBody: '',
+        resourceQueryQuery: '',
+        resourceQueryUrl: '',
+        resourceUpdateBody: '',
+        resourceUpdateQuery: '',
+        resourceUpdateUrl: '',
+      },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract share action remappers', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Page',
+          blocks: [
+            {
+              type: 'test',
+              version: '1.2.3',
+              actions: {
+                onClick: {
+                  type: 'share',
+                  text: { translate: 'shareText' },
+                  title: { translate: 'shareTitle' },
+                  url: { translate: 'shareUrl' },
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+    expect(result).toMatchObject({
+      messageIds: { shareText: '', shareTitle: '', shareUrl: '' },
+      app: { 'pages.page': 'Page' },
+    });
+  });
+
+  it('should extract names from tabs pages', () => {
+    const result = extractAppMessages({
+      defaultPage: '',
+      pages: [
+        {
+          name: 'Tabs',
+          type: 'tabs',
+          tabs: [{ name: 'Tab', blocks: [] }],
+        },
+      ],
+    });
+    expect(result).toMatchObject({ app: { 'pages.tabs': 'Tabs', 'pages.tabs.tabs.0': 'Tab' } });
+  });
+
+  it('should append any messages returned by onBlock', () => {
+    const onBlock = jest.fn().mockReturnValue({ foo: 'bar' });
+    const result = extractAppMessages(
+      {
+        defaultPage: '',
+        pages: [{ name: 'Page', blocks: [{ type: '', version: '' }] }],
+      },
+      onBlock,
+    );
+    expect(onBlock).toHaveBeenCalledWith({ type: '', version: '' }, ['pages', 'page', 'blocks', 0]);
+    expect(result).toMatchObject({ app: { 'pages.page': 'Page' } });
+  });
+});

package/appMessages.ts

@@ -0,0 +1,145 @@
+import { AppDefinition, AppsembleMessages, BlockDefinition } from '@appsemble/types';
+
+import { iterApp, Prefix } from '.';
+import { normalize } from './normalize';
+
+/**
+ * Recursively find `string.format` remapper message IDs.
+ *
+ * @param obj The object to search.
+ * @returns All message IDs found
+ */
+export function findMessageIds(obj: unknown): Record<string, string> {
+  if (!obj || typeof obj !== 'object') {
+    return {};
+  }
+  if (Array.isArray(obj)) {
+    return Object.assign({}, ...obj.map((item) => findMessageIds(item)));
+  }
+  const entries = Object.entries(obj);
+  // Remappers throw if multiple keys are defined, so this means it’s not a remapper.
+  if (entries.length === 1) {
+    const [[key, value]] = entries;
+    if (key === 'string.format' && typeof value?.messageId === 'string') {
+      return { [value.messageId]: value.template ?? '', ...findMessageIds(value.values) };
+    }
+    if (key === 'translate') {
+      return { [value]: '' };
+    }
+  }
+  return Object.assign({}, ...entries.map(([, value]) => findMessageIds(value)));
+}
+
+/**
+ * Extract translatable message IDs from an app definition.
+ *
+ * @param app The app definition to extract nessage IDs from
+ * @param onBlock A function to extract block messages. This is needed, because block messages may
+ * be extracted based on different contexts.
+ * @returns A list of message IDs
+ */
+export function extractAppMessages(
+  app: AppDefinition,
+  onBlock?: (block: BlockDefinition, prefix: Prefix) => void,
+): Pick<AppsembleMessages, 'app' | 'messageIds'> {
+  const messages: Pick<AppsembleMessages, 'app' | 'messageIds'> = {
+    app: {
+      name: app.name,
+      description: app.description,
+      ...Object.fromEntries(
+        Object.entries(app.security?.roles ?? {}).flatMap(([role, roleDefinition]) => [
+          [`app.roles.${role}`, role],
+          [`app.roles.${role}.description`, roleDefinition.description],
+        ]),
+      ),
+    },
+    messageIds: {},
+  };
+
+  iterApp(app, {
+    onBlock(block, prefix) {
+      Object.assign(
+        messages.messageIds,
+        findMessageIds(block.header),
+        findMessageIds(block.parameters),
+      );
+
+      if (onBlock) {
+        const normalizedPrefix = prefix.map((entry, index) =>
+          index === 1 ? normalize(app.pages[entry as number].name) : entry,
+        );
+        onBlock(block, normalizedPrefix);
+      }
+    },
+    onAction(action) {
+      Object.assign(messages.messageIds, findMessageIds(action.remap));
+
+      switch (action.type) {
+        case 'condition':
+          Object.assign(messages.messageIds, findMessageIds(action.if));
+          break;
+        case 'dialog':
+          Object.assign(messages.messageIds, findMessageIds(action.title));
+          break;
+        case 'email':
+          Object.assign(
+            messages.messageIds,
+            findMessageIds(action.attachments),
+            findMessageIds(action.bcc),
+            findMessageIds(action.body),
+            findMessageIds(action.cc),
+            findMessageIds(action.subject),
+            findMessageIds(action.to),
+          );
+          break;
+        case 'flow.to':
+          Object.assign(messages.messageIds, findMessageIds(action.step));
+          break;
+        case 'message':
+          Object.assign(messages.messageIds, findMessageIds(action.body));
+          break;
+        case 'request':
+        case 'resource.count':
+        case 'resource.create':
+        case 'resource.delete':
+        case 'resource.get':
+        case 'resource.query':
+        case 'resource.update':
+          Object.assign(
+            messages.messageIds,
+            findMessageIds(action.body),
+            findMessageIds(action.query),
+            findMessageIds(action.url),
+          );
+          break;
+        case 'share':
+          Object.assign(
+            messages.messageIds,
+            findMessageIds(action.text),
+            findMessageIds(action.title),
+            findMessageIds(action.url),
+          );
+          break;
+        default:
+      }
+    },
+    onPage(page) {
+      const prefix = `pages.${normalize(page.name)}`;
+      messages.app[prefix] = page.name;
+
+      if (page.type === 'tabs') {
+        for (const [index, tab] of page.tabs.entries()) {
+          messages.app[`${prefix}.tabs.${index}`] = tab.name ?? '';
+        }
+      }
+
+      if (page.type === 'flow') {
+        for (const [index, step] of page.steps.entries()) {
+          messages.app[`${prefix}.steps.${index}`] = step.name ?? '';
+        }
+      }
+    },
+  });
+
+  return messages;
+}

package/appSecurity.d.ts

@@ -0,0 +1,9 @@
+import { AppDefinition, RoleDefinition } from '@appsemble/types';
+/**
+ * Resolve role security inheritance based on priority.
+ *
+ * @param app The app to resolve role priority for.
+ * @param role The role to resolve
+ * @returns A list of tuples of role name and role definition. The roles are sorted by priority.
+ */
+export declare function resolveRoleInheritance(app: Pick<AppDefinition, 'security'>, role: string): [roleName: string, roleDefinition: RoleDefinition][];

package/appSecurity.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveRoleInheritance = void 0;
+const has_1 = require("./has");
+/**
+ * Resolve role security inheritance based on priority.
+ *
+ * @param app The app to resolve role priority for.
+ * @param role The role to resolve
+ * @returns A list of tuples of role name and role definition. The roles are sorted by priority.
+ */
+function resolveRoleInheritance(app, role) {
+    var _a;
+    const rolesDefinition = (_a = app === null || app === void 0 ? void 0 : app.security) === null || _a === void 0 ? void 0 : _a.roles;
+    const roleNames = [];
+    const roles = [];
+    const resolveRoles = (r) => {
+        if (!r) {
+            // No role was specified.
+            return;
+        }
+        if (!(0, has_1.has)(rolesDefinition, r)) {
+            // The specified role is unknown, so it’s skipped.
+            return;
+        }
+        if (roleNames.includes(r)) {
+            // The role has already been processed higher up the priority.
+            return;
+        }
+        const roleDefinition = rolesDefinition[r];
+        roleNames.push(r);
+        roles.push(roleDefinition);
+        if (roleDefinition.inherits) {
+            for (const inherits of roleDefinition.inherits) {
+                resolveRoles(inherits);
+            }
+        }
+    };
+    if (rolesDefinition) {
+        resolveRoles(role);
+    }
+    return roles.map((r, index) => [roleNames[index], r]);
+}
+exports.resolveRoleInheritance = resolveRoleInheritance;
+//# sourceMappingURL=appSecurity.js.map

package/appSecurity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appSecurity.js","sourceRoot":"","sources":["appSecurity.ts"],"names":[],"mappings":";;;AAEA,+BAA4B;AAE5B;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,GAAoC,EACpC,IAAY;;IAEZ,MAAM,eAAe,GAAG,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,0CAAE,KAAK,CAAC;IAC7C,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAqB,EAAE,CAAC;IAEnC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAQ,EAAE;QACvC,IAAI,CAAC,CAAC,EAAE;YACN,yBAAyB;YACzB,OAAO;SACR;QACD,IAAI,CAAC,IAAA,SAAG,EAAC,eAAe,EAAE,CAAC,CAAC,EAAE;YAC5B,kDAAkD;YAClD,OAAO;SACR;QACD,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YACzB,8DAA8D;YAC9D,OAAO;SACR;QACD,MAAM,cAAc,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1C,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,IAAI,cAAc,CAAC,QAAQ,EAAE;YAC3B,KAAK,MAAM,QAAQ,IAAI,cAAc,CAAC,QAAQ,EAAE;gBAC9C,YAAY,CAAC,QAAQ,CAAC,CAAC;aACxB;SACF;IACH,CAAC,CAAC;IAEF,IAAI,eAAe,EAAE;QACnB,YAAY,CAAC,IAAI,CAAC,CAAC;KACpB;IAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AApCD,wDAoCC"}

package/appSecurity.test.d.ts

@@ -0,0 +1 @@
+export {};