@appsemble/utils 0.20.9 → 0.20.12

package/appSecurity.test.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const appSecurity_1 = require("./appSecurity");
+describe('resolveRoleInheritance', () => {
+    it('should return an empty array if no security definition is defined', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({}, 'unknown');
+        expect(result).toStrictEqual([]);
+    });
+    it('should return an empty array for an unknown role', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'known' },
+                roles: {
+                    known: {},
+                },
+            },
+        }, 'unknown');
+        expect(result).toStrictEqual([]);
+    });
+    it('should resolve a non inherited role', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    user: {},
+                },
+            },
+        }, 'user');
+        expect(result).toStrictEqual([['user', {}]]);
+    });
+    it('should resolve shallow inheritance', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    admin: { inherits: ['user'] },
+                    user: {},
+                },
+            },
+        }, 'admin');
+        expect(result).toStrictEqual([
+            ['admin', { inherits: ['user'] }],
+            ['user', {}],
+        ]);
+    });
+    it('should resolve nested inheritance', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    superadmin: { inherits: ['admin'] },
+                    admin: { inherits: ['user'] },
+                    user: {},
+                },
+            },
+        }, 'superadmin');
+        expect(result).toStrictEqual([
+            ['superadmin', { inherits: ['admin'] }],
+            ['admin', { inherits: ['user'] }],
+            ['user', {}],
+        ]);
+    });
+    it('should resolve multiple inheritance', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    superadmin: { inherits: ['admin', 'user'] },
+                    admin: {},
+                    user: {},
+                },
+            },
+        }, 'superadmin');
+        expect(result).toStrictEqual([
+            ['superadmin', { inherits: ['admin', 'user'] }],
+            ['admin', {}],
+            ['user', {}],
+        ]);
+    });
+    it('should not include duplicates', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    superadmin: { inherits: ['admin', 'user'] },
+                    admin: { inherits: ['user'] },
+                    user: {},
+                },
+            },
+        }, 'superadmin');
+        expect(result).toStrictEqual([
+            ['superadmin', { inherits: ['admin', 'user'] }],
+            ['admin', { inherits: ['user'] }],
+            ['user', {}],
+        ]);
+    });
+    it('should resolve roles in order', () => {
+        const result = (0, appSecurity_1.resolveRoleInheritance)({
+            security: {
+                default: { role: 'user' },
+                roles: {
+                    superadmin: { inherits: ['user', 'admin'] },
+                    admin: { inherits: ['user'] },
+                    user: {},
+                },
+            },
+        }, 'superadmin');
+        expect(result).toStrictEqual([
+            ['superadmin', { inherits: ['user', 'admin'] }],
+            ['user', {}],
+            ['admin', { inherits: ['user'] }],
+        ]);
+    });
+});
+//# sourceMappingURL=appSecurity.test.js.map

package/appSecurity.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appSecurity.test.js","sourceRoot":"","sources":["appSecurity.test.ts"],"names":[],"mappings":";;AAAA,+CAAuD;AAEvD,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,MAAM,GAAG,IAAA,oCAAsB,EAAC,EAAE,EAAE,SAAS,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;gBAC1B,KAAK,EAAE;oBACL,KAAK,EAAE,EAAE;iBACV;aACF;SACF,EACD,SAAS,CACV,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,MAAM,CACP,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;oBAC7B,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,OAAO,CACR,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,CAAC,MAAM,EAAE,EAAE,CAAC;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE;oBACnC,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;oBAC7B,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,YAAY,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;YACvC,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,CAAC,MAAM,EAAE,EAAE,CAAC;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;oBAC3C,KAAK,EAAE,EAAE;oBACT,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,YAAY,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;YAC/C,CAAC,OAAO,EAAE,EAAE,CAAC;YACb,CAAC,MAAM,EAAE,EAAE,CAAC;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;oBAC3C,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;oBAC7B,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,YAAY,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;YAC/C,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,CAAC,MAAM,EAAE,EAAE,CAAC;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,IAAA,oCAAsB,EACnC;YACE,QAAQ,EAAE;gBACR,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;gBACzB,KAAK,EAAE;oBACL,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;oBAC3C,KAAK,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;oBAC7B,IAAI,EAAE,EAAE;iBACT;aACF;SACF,EACD,YAAY,CACb,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;YAC/C,CAAC,MAAM,EAAE,EAAE,CAAC;YACZ,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;SAClC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/appSecurity.test.ts

@@ -0,0 +1,141 @@
+import { resolveRoleInheritance } from './appSecurity';
+
+describe('resolveRoleInheritance', () => {
+  it('should return an empty array if no security definition is defined', () => {
+    const result = resolveRoleInheritance({}, 'unknown');
+    expect(result).toStrictEqual([]);
+  });
+
+  it('should return an empty array for an unknown role', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'known' },
+          roles: {
+            known: {},
+          },
+        },
+      },
+      'unknown',
+    );
+    expect(result).toStrictEqual([]);
+  });
+
+  it('should resolve a non inherited role', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            user: {},
+          },
+        },
+      },
+      'user',
+    );
+    expect(result).toStrictEqual([['user', {}]]);
+  });
+
+  it('should resolve shallow inheritance', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            admin: { inherits: ['user'] },
+            user: {},
+          },
+        },
+      },
+      'admin',
+    );
+    expect(result).toStrictEqual([
+      ['admin', { inherits: ['user'] }],
+      ['user', {}],
+    ]);
+  });
+
+  it('should resolve nested inheritance', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            superadmin: { inherits: ['admin'] },
+            admin: { inherits: ['user'] },
+            user: {},
+          },
+        },
+      },
+      'superadmin',
+    );
+    expect(result).toStrictEqual([
+      ['superadmin', { inherits: ['admin'] }],
+      ['admin', { inherits: ['user'] }],
+      ['user', {}],
+    ]);
+  });
+
+  it('should resolve multiple inheritance', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            superadmin: { inherits: ['admin', 'user'] },
+            admin: {},
+            user: {},
+          },
+        },
+      },
+      'superadmin',
+    );
+    expect(result).toStrictEqual([
+      ['superadmin', { inherits: ['admin', 'user'] }],
+      ['admin', {}],
+      ['user', {}],
+    ]);
+  });
+
+  it('should not include duplicates', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            superadmin: { inherits: ['admin', 'user'] },
+            admin: { inherits: ['user'] },
+            user: {},
+          },
+        },
+      },
+      'superadmin',
+    );
+    expect(result).toStrictEqual([
+      ['superadmin', { inherits: ['admin', 'user'] }],
+      ['admin', { inherits: ['user'] }],
+      ['user', {}],
+    ]);
+  });
+
+  it('should resolve roles in order', () => {
+    const result = resolveRoleInheritance(
+      {
+        security: {
+          default: { role: 'user' },
+          roles: {
+            superadmin: { inherits: ['user', 'admin'] },
+            admin: { inherits: ['user'] },
+            user: {},
+          },
+        },
+      },
+      'superadmin',
+    );
+    expect(result).toStrictEqual([
+      ['superadmin', { inherits: ['user', 'admin'] }],
+      ['user', {}],
+      ['admin', { inherits: ['user'] }],
+    ]);
+  });
+});

package/appSecurity.ts

@@ -0,0 +1,48 @@
+import { AppDefinition, RoleDefinition } from '@appsemble/types';
+
+import { has } from './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.
+ */
+export function resolveRoleInheritance(
+  app: Pick<AppDefinition, 'security'>,
+  role: string,
+): [roleName: string, roleDefinition: RoleDefinition][] {
+  const rolesDefinition = app?.security?.roles;
+  const roleNames: string[] = [];
+  const roles: RoleDefinition[] = [];
+
+  const resolveRoles = (r: string): void => {
+    if (!r) {
+      // No role was specified.
+      return;
+    }
+    if (!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]);
+}

package/blockUtils.d.ts

@@ -0,0 +1,31 @@
+import { AppDefinition, BlockDefinition } from '@appsemble/types';
+export declare type IdentifiableBlock = Pick<BlockDefinition, 'type' | 'version'>;
+/**
+ * Normalize a block name by prefixing it with `@appsemble` if necessary.
+ *
+ * @param name The input block name.
+ * @returns The normalized block name.
+ */
+export declare function normalizeBlockName(name: string): string;
+/**
+ * Return a block name without the organization prefix.
+ *
+ * @param name The input block name.
+ * @returns The prettified block name.
+ */
+export declare function stripBlockName(name: string): string;
+/**
+ * Parse a block name into a tuple of organization id and block id.
+ *
+ * @param name The block name to parse.
+ * @returns A tuple containing the organization id and block id.
+ */
+export declare function parseBlockName(name: string): [string, string];
+/**
+ * Find unique block types in an app.
+ *
+ * @param definition The app definition to find unique blocks for.
+ * @returns Partial unique blocks. Only the type and version are returned.
+ */
+export declare function getAppBlocks(definition: AppDefinition): IdentifiableBlock[];
+export declare function prefixBlockURL(block: IdentifiableBlock, url: string): string;

package/blockUtils.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prefixBlockURL = exports.getAppBlocks = exports.parseBlockName = exports.stripBlockName = exports.normalizeBlockName = void 0;
+const constants_1 = require("./constants");
+const iterApp_1 = require("./iterApp");
+const prefix = '@appsemble/';
+/**
+ * Normalize a block name by prefixing it with `@appsemble` if necessary.
+ *
+ * @param name The input block name.
+ * @returns The normalized block name.
+ */
+function normalizeBlockName(name) {
+    if (name.startsWith('@')) {
+        return name;
+    }
+    return `${prefix}${name}`;
+}
+exports.normalizeBlockName = normalizeBlockName;
+/**
+ * Return a block name without the organization prefix.
+ *
+ * @param name The input block name.
+ * @returns The prettified block name.
+ */
+function stripBlockName(name) {
+    if (name.startsWith(prefix)) {
+        return name.slice(prefix.length);
+    }
+    return name;
+}
+exports.stripBlockName = stripBlockName;
+/**
+ * Parse a block name into a tuple of organization id and block id.
+ *
+ * @param name The block name to parse.
+ * @returns A tuple containing the organization id and block id.
+ */
+function parseBlockName(name) {
+    const match = constants_1.blockNamePattern.exec(normalizeBlockName(name));
+    if (match) {
+        return match.slice(1, 3);
+    }
+}
+exports.parseBlockName = parseBlockName;
+/**
+ * Find unique block types in an app.
+ *
+ * @param definition The app definition to find unique blocks for.
+ * @returns Partial unique blocks. Only the type and version are returned.
+ */
+function getAppBlocks(definition) {
+    const visited = new Set();
+    const result = [];
+    (0, iterApp_1.iterApp)(definition, {
+        onBlock({ type, version }) {
+            const name = normalizeBlockName(type);
+            const asString = `${name}@${version}`;
+            if (!visited.has(asString)) {
+                result.push({ type: name, version });
+            }
+            visited.add(asString);
+        },
+    });
+    return result;
+}
+exports.getAppBlocks = getAppBlocks;
+function prefixBlockURL(block, url) {
+    return `/api/blocks/${normalizeBlockName(block.type)}/versions/${block.version}/${url}`;
+}
+exports.prefixBlockURL = prefixBlockURL;
+//# sourceMappingURL=blockUtils.js.map

package/blockUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockUtils.js","sourceRoot":"","sources":["blockUtils.ts"],"names":[],"mappings":";;;AAEA,2CAA+C;AAC/C,uCAAoC;AAIpC,MAAM,MAAM,GAAG,aAAa,CAAC;AAE7B;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IACD,OAAO,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC;AAC5B,CAAC;AALD,gDAKC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;KAClC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AALD,wCAKC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,KAAK,GAAG,4BAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,IAAI,KAAK,EAAE;QACT,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAqB,CAAC;KAC9C;AACH,CAAC;AALD,wCAKC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,UAAyB;IACpD,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC1B,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,IAAA,iBAAO,EAAC,UAAU,EAAE;QAClB,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE;YACvB,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,QAAQ,GAAG,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;aACtC;YACD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAhBD,oCAgBC;AAED,SAAgB,cAAc,CAAC,KAAwB,EAAE,GAAW;IAClE,OAAO,eAAe,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;AAC1F,CAAC;AAFD,wCAEC"}

package/blockUtils.test.d.ts

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

package/blockUtils.test.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const blockUtils_1 = require("./blockUtils");
+describe('normalizeBlockName', () => {
+    it('should prepend @appsemble if no organization is prepended', () => {
+        const blockName = 'form';
+        const result = (0, blockUtils_1.normalizeBlockName)(blockName);
+        expect(result).toBe(`@appsemble/${blockName}`);
+    });
+    it('should leave block name intact if organization is prepended', () => {
+        const blockName = '@example/test';
+        const result = (0, blockUtils_1.normalizeBlockName)(blockName);
+        expect(result).toBe(blockName);
+    });
+});
+describe('stripBlockName', () => {
+    it('should strip the @appsemble prefix from official blocks', () => {
+        const result = (0, blockUtils_1.stripBlockName)('@appsemble/table');
+        expect(result).toBe('table');
+    });
+    it('should keep other organization prefixes', () => {
+        const result = (0, blockUtils_1.stripBlockName)('@other/table');
+        expect(result).toBe('@other/table');
+    });
+    it('should support unprefixed block names', () => {
+        const result = (0, blockUtils_1.stripBlockName)('table');
+        expect(result).toBe('table');
+    });
+});
+describe('parseBlockName', () => {
+    it('should return a tuple of organization id and block id', () => {
+        const result = (0, blockUtils_1.parseBlockName)('@example/test');
+        expect(result).toStrictEqual(['example', 'test']);
+    });
+    it('should support numeric values', () => {
+        const result = (0, blockUtils_1.parseBlockName)('@123-foo/456-bar');
+        expect(result).toStrictEqual(['123-foo', '456-bar']);
+    });
+    it('should support official appsemble blocks', () => {
+        const result = (0, blockUtils_1.parseBlockName)('detail-viewer');
+        expect(result).toStrictEqual(['appsemble', 'detail-viewer']);
+    });
+    it('should return undefined for invalid values', () => {
+        const result = (0, blockUtils_1.parseBlockName)('FooBar');
+        expect(result).toBeUndefined();
+    });
+});
+describe('getAppBlocks', () => {
+    it('should find unique block types inside an app', () => {
+        const result = (0, blockUtils_1.getAppBlocks)({
+            name: '',
+            defaultPage: '',
+            pages: [
+                {
+                    name: '',
+                    blocks: [
+                        { type: 'foo', version: '0.0.0' },
+                        { type: '@appsemble/foo', version: '0.0.0' },
+                        { type: 'foo', version: '0.0.1' },
+                        { type: 'bar', version: '0.0.1' },
+                    ],
+                },
+            ],
+        });
+        expect(result).toStrictEqual([
+            { type: '@appsemble/foo', version: '0.0.0' },
+            { type: '@appsemble/foo', version: '0.0.1' },
+            { type: '@appsemble/bar', version: '0.0.1' },
+        ]);
+    });
+});
+describe('prefixBlockURL', () => {
+    it('should populate the API url with block properties', () => {
+        const result = (0, blockUtils_1.prefixBlockURL)({ type: '@appsemble/test', version: '1.0.0' }, 'test.css');
+        expect(result).toBe('/api/blocks/@appsemble/test/versions/1.0.0/test.css');
+    });
+});
+//# sourceMappingURL=blockUtils.test.js.map

package/blockUtils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blockUtils.test.js","sourceRoot":"","sources":["blockUtils.test.ts"],"names":[],"mappings":";;AAAA,6CAMsB;AAEtB,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,SAAS,GAAG,MAAM,CAAC;QACzB,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,SAAS,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,SAAS,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,SAAS,GAAG,eAAe,CAAC;QAClC,MAAM,MAAM,GAAG,IAAA,+BAAkB,EAAC,SAAS,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,cAAc,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,OAAO,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,eAAe,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,kBAAkB,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,eAAe,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,MAAM,GAAG,IAAA,yBAAY,EAAC;YAC1B,IAAI,EAAE,EAAE;YACR,WAAW,EAAE,EAAE;YACf,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE;wBACN,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;wBACjC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE;wBAC5C,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;wBACjC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;qBAClC;iBACF;aACF;SACF,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAC3B,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE;YAC5C,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE;YAC5C,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE;SAC7C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,MAAM,GAAG,IAAA,2BAAc,EAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QACzF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/blockUtils.test.ts

@@ -0,0 +1,94 @@
+import {
+  getAppBlocks,
+  normalizeBlockName,
+  parseBlockName,
+  prefixBlockURL,
+  stripBlockName,
+} from './blockUtils';
+
+describe('normalizeBlockName', () => {
+  it('should prepend @appsemble if no organization is prepended', () => {
+    const blockName = 'form';
+    const result = normalizeBlockName(blockName);
+
+    expect(result).toBe(`@appsemble/${blockName}`);
+  });
+
+  it('should leave block name intact if organization is prepended', () => {
+    const blockName = '@example/test';
+    const result = normalizeBlockName(blockName);
+
+    expect(result).toBe(blockName);
+  });
+});
+
+describe('stripBlockName', () => {
+  it('should strip the @appsemble prefix from official blocks', () => {
+    const result = stripBlockName('@appsemble/table');
+    expect(result).toBe('table');
+  });
+
+  it('should keep other organization prefixes', () => {
+    const result = stripBlockName('@other/table');
+    expect(result).toBe('@other/table');
+  });
+
+  it('should support unprefixed block names', () => {
+    const result = stripBlockName('table');
+    expect(result).toBe('table');
+  });
+});
+
+describe('parseBlockName', () => {
+  it('should return a tuple of organization id and block id', () => {
+    const result = parseBlockName('@example/test');
+    expect(result).toStrictEqual(['example', 'test']);
+  });
+
+  it('should support numeric values', () => {
+    const result = parseBlockName('@123-foo/456-bar');
+    expect(result).toStrictEqual(['123-foo', '456-bar']);
+  });
+
+  it('should support official appsemble blocks', () => {
+    const result = parseBlockName('detail-viewer');
+    expect(result).toStrictEqual(['appsemble', 'detail-viewer']);
+  });
+
+  it('should return undefined for invalid values', () => {
+    const result = parseBlockName('FooBar');
+    expect(result).toBeUndefined();
+  });
+});
+
+describe('getAppBlocks', () => {
+  it('should find unique block types inside an app', () => {
+    const result = getAppBlocks({
+      name: '',
+      defaultPage: '',
+      pages: [
+        {
+          name: '',
+          blocks: [
+            { type: 'foo', version: '0.0.0' },
+            { type: '@appsemble/foo', version: '0.0.0' },
+            { type: 'foo', version: '0.0.1' },
+            { type: 'bar', version: '0.0.1' },
+          ],
+        },
+      ],
+    });
+    expect(result).toStrictEqual([
+      { type: '@appsemble/foo', version: '0.0.0' },
+      { type: '@appsemble/foo', version: '0.0.1' },
+      { type: '@appsemble/bar', version: '0.0.1' },
+    ]);
+  });
+});
+
+describe('prefixBlockURL', () => {
+  it('should populate the API url with block properties', () => {
+    const result = prefixBlockURL({ type: '@appsemble/test', version: '1.0.0' }, 'test.css');
+    expect(result).toBe('/api/blocks/@appsemble/test/versions/1.0.0/test.css');
+  });
+});

package/blockUtils.ts

@@ -0,0 +1,75 @@
+import { AppDefinition, BlockDefinition } from '@appsemble/types';
+
+import { blockNamePattern } from './constants';
+import { iterApp } from './iterApp';
+
+export type IdentifiableBlock = Pick<BlockDefinition, 'type' | 'version'>;
+
+const prefix = '@appsemble/';
+
+/**
+ * Normalize a block name by prefixing it with `@appsemble` if necessary.
+ *
+ * @param name The input block name.
+ * @returns The normalized block name.
+ */
+export function normalizeBlockName(name: string): string {
+  if (name.startsWith('@')) {
+    return name;
+  }
+  return `${prefix}${name}`;
+}
+
+/**
+ * Return a block name without the organization prefix.
+ *
+ * @param name The input block name.
+ * @returns The prettified block name.
+ */
+export function stripBlockName(name: string): string {
+  if (name.startsWith(prefix)) {
+    return name.slice(prefix.length);
+  }
+  return name;
+}
+
+/**
+ * Parse a block name into a tuple of organization id and block id.
+ *
+ * @param name The block name to parse.
+ * @returns A tuple containing the organization id and block id.
+ */
+export function parseBlockName(name: string): [string, string] {
+  const match = blockNamePattern.exec(normalizeBlockName(name));
+  if (match) {
+    return match.slice(1, 3) as [string, string];
+  }
+}
+
+/**
+ * Find unique block types in an app.
+ *
+ * @param definition The app definition to find unique blocks for.
+ * @returns Partial unique blocks. Only the type and version are returned.
+ */
+export function getAppBlocks(definition: AppDefinition): IdentifiableBlock[] {
+  const visited = new Set();
+  const result: IdentifiableBlock[] = [];
+
+  iterApp(definition, {
+    onBlock({ type, version }) {
+      const name = normalizeBlockName(type);
+      const asString = `${name}@${version}`;
+      if (!visited.has(asString)) {
+        result.push({ type: name, version });
+      }
+      visited.add(asString);
+    },
+  });
+
+  return result;
+}
+
+export function prefixBlockURL(block: IdentifiableBlock, url: string): string {
+  return `/api/blocks/${normalizeBlockName(block.type)}/versions/${block.version}/${url}`;
+}