@adminiumjs/manifest 0.3.48 → 0.3.50

package/dist/app-requires.d.ts

@@ -0,0 +1,66 @@
+/**
+ * `apps.requires` — the other apps a self-made app needs on its database.
+ *
+ * ```json
+ * "apps": {
+ *   "requires": [{ "publisher": "adminium", "key": "point-of-sale", "range": ">=1.2.0",
+ *                  "tables": ["orders", "order_lines"] }]
+ * }
+ * ```
+ *
+ * A dashboard saved with pages on a catalogue app's tables never carries that
+ * app: it names it here, and the install needs it already installed on the
+ * same database, by the same publisher, at a version in `range` (any version
+ * when there is none). Publisher AND key: a key alone is matched by any file
+ * that says it is `pos`, a self-made one among them.
+ *
+ * `tables` names the app's own `requiredSchema.tables` that are the required
+ * app's, by the same ref. The install makes none of them: it uses the
+ * required app's tables and records its use of them, so the required app's
+ * uninstall never drops a table this app still reads.
+ *
+ * A self-made app (`publisher: local`) is never a requirement: `local` says
+ * where a file was made, not which app it is, so it proves nothing.
+ *
+ * Only a self-made app carries the block; the published catalogue never does.
+ */
+import { z } from 'zod';
+/** The most apps one app may require. */
+export declare const REQUIRED_APPS_MAX = 8;
+export declare const requiredAppSchema: z.ZodObject<{
+    publisher: z.ZodString;
+    key: z.ZodString;
+    range: z.ZodOptional<z.ZodString>;
+    tables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export type RequiredApp = z.infer<typeof requiredAppSchema>;
+export declare const appsBlockSchema: z.ZodObject<{
+    requires: z.ZodArray<z.ZodObject<{
+        publisher: z.ZodString;
+        key: z.ZodString;
+        range: z.ZodOptional<z.ZodString>;
+        tables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type AppsBlock = z.infer<typeof appsBlockSchema>;
+interface Issue {
+    path: (string | number)[];
+    message: string;
+}
+/** Everything wrong with an app's `apps` block that its shape alone cannot see. */
+export declare function requiredAppIssues(m: {
+    key: string;
+    publisher: {
+        id: string;
+    };
+    apps?: AppsBlock | undefined;
+    requiredSchema?: {
+        tables: readonly {
+            ref: string;
+        }[];
+    } | undefined;
+}): Issue[];
+/** This app's tables that are another app's, by ref, with the app they belong to. */
+export declare function requiredAppTables(apps: AppsBlock | undefined): Map<string, RequiredApp>;
+export {};
+//# sourceMappingURL=app-requires.d.ts.map

package/dist/app-requires.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-requires.d.ts","sourceRoot":"","sources":["../src/app-requires.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB,yCAAyC;AACzC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAQnC,eAAO,MAAM,iBAAiB;;;;;kBAUnB,CAAC;AACZ,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,eAAe;;;;;;;kBAIjB,CAAC;AACZ,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,UAAU,KAAK;IACb,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,mFAAmF;AACnF,wBAAgB,iBAAiB,CAAC,CAAC,EAAE;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC7B,cAAc,CAAC,EAAE;QAAE,MAAM,EAAE,SAAS;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,GAAG,SAAS,CAAC;CACrE,GAAG,KAAK,EAAE,CA4BV;AAED,qFAAqF;AACrF,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAIvF"}

package/dist/app-requires.js

@@ -0,0 +1,98 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+/**
+ * `apps.requires` — the other apps a self-made app needs on its database.
+ *
+ * ```json
+ * "apps": {
+ *   "requires": [{ "publisher": "adminium", "key": "point-of-sale", "range": ">=1.2.0",
+ *                  "tables": ["orders", "order_lines"] }]
+ * }
+ * ```
+ *
+ * A dashboard saved with pages on a catalogue app's tables never carries that
+ * app: it names it here, and the install needs it already installed on the
+ * same database, by the same publisher, at a version in `range` (any version
+ * when there is none). Publisher AND key: a key alone is matched by any file
+ * that says it is `pos`, a self-made one among them.
+ *
+ * `tables` names the app's own `requiredSchema.tables` that are the required
+ * app's, by the same ref. The install makes none of them: it uses the
+ * required app's tables and records its use of them, so the required app's
+ * uninstall never drops a table this app still reads.
+ *
+ * A self-made app (`publisher: local`) is never a requirement: `local` says
+ * where a file was made, not which app it is, so it proves nothing.
+ *
+ * Only a self-made app carries the block; the published catalogue never does.
+ */
+import { z } from 'zod';
+import { refSchema } from './refs.js';
+import { parseSemverRange } from './semver.js';
+const LOCAL_PUBLISHER_ID = 'local';
+/** The most apps one app may require. */
+export const REQUIRED_APPS_MAX = 8;
+const rangeSchema = z
+    .string()
+    .min(1)
+    .max(120)
+    .refine((range) => parseSemverRange(range) !== null, { message: 'a semver range such as ">=1.1.0" or "^1.1.0"' });
+export const requiredAppSchema = z
+    .object({
+    /** The publisher's id, as the required app's own manifest gives it. */
+    publisher: z.string().regex(/^[a-z][a-z0-9-]{1,39}$/, 'a publisher id'),
+    key: z.string().regex(/^[a-z][a-z0-9-]{1,79}$/, 'an app key'),
+    /** The versions that will do: any, when absent. */
+    range: rangeSchema.optional(),
+    /** This app's tables that are the required app's own, by the same ref. */
+    tables: z.array(refSchema).min(1).max(64).optional(),
+})
+    .strict();
+export const appsBlockSchema = z
+    .object({
+    requires: z.array(requiredAppSchema).min(1).max(REQUIRED_APPS_MAX),
+})
+    .strict();
+/** Everything wrong with an app's `apps` block that its shape alone cannot see. */
+export function requiredAppIssues(m) {
+    const out = [];
+    if (m.apps === undefined)
+        return out;
+    if (m.publisher.id !== LOCAL_PUBLISHER_ID) {
+        out.push({ path: ['apps'], message: `"apps" is carried only by a self-made app (publisher "${LOCAL_PUBLISHER_ID}")` });
+    }
+    const own = new Set((m.requiredSchema?.tables ?? []).map((table) => table.ref));
+    const keys = new Set();
+    const named = new Map();
+    m.apps.requires.forEach((need, n) => {
+        const at = ['apps', 'requires', n];
+        if (need.key === m.key)
+            out.push({ path: [...at, 'key'], message: 'an app does not require itself' });
+        if (keys.has(need.key))
+            out.push({ path: [...at, 'key'], message: `"${need.key}" is required twice` });
+        keys.add(need.key);
+        if (need.publisher === LOCAL_PUBLISHER_ID) {
+            out.push({
+                path: [...at, 'publisher'],
+                message: `a self-made app cannot be required: "${LOCAL_PUBLISHER_ID}" says where a file was made, not which app it is`,
+            });
+        }
+        (need.tables ?? []).forEach((ref, t) => {
+            if (!own.has(ref))
+                out.push({ path: [...at, 'tables', t], message: `"${ref}" is not one of the app's tables (requiredSchema.tables)` });
+            const earlier = named.get(ref);
+            if (earlier !== undefined)
+                out.push({ path: [...at, 'tables', t], message: `"${ref}" is already "${earlier}"'s table` });
+            named.set(ref, need.key);
+        });
+    });
+    return out;
+}
+/** This app's tables that are another app's, by ref, with the app they belong to. */
+export function requiredAppTables(apps) {
+    const out = new Map();
+    for (const need of apps?.requires ?? [])
+        for (const ref of need.tables ?? [])
+            out.set(ref, need);
+    return out;
+}
+//# sourceMappingURL=app-requires.js.map

package/dist/app-requires.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-requires.js","sourceRoot":"","sources":["../src/app-requires.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,MAAM,kBAAkB,GAAG,OAAO,CAAC;AAEnC,yCAAyC;AACzC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAEnC,MAAM,WAAW,GAAG,CAAC;KAClB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,GAAG,CAAC;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,OAAO,EAAE,8CAA8C,EAAE,CAAC,CAAC;AAEpH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,uEAAuE;IACvE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,EAAE,gBAAgB,CAAC;IACvE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,EAAE,YAAY,CAAC;IAC7D,mDAAmD;IACnD,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE;IAC7B,0EAA0E;IAC1E,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CACrD,CAAC;KACD,MAAM,EAAE,CAAC;AAGZ,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,CAAC;CACnE,CAAC;KACD,MAAM,EAAE,CAAC;AAQZ,mFAAmF;AACnF,MAAM,UAAU,iBAAiB,CAAC,CAKjC;IACC,MAAM,GAAG,GAAY,EAAE,CAAC;IACxB,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,GAAG,CAAC;IACrC,IAAI,CAAC,CAAC,SAAS,CAAC,EAAE,KAAK,kBAAkB,EAAE,CAAC;QAC1C,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,yDAAyD,kBAAkB,IAAI,EAAE,CAAC,CAAC;IACzH,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAChF,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QAClC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC,CAAC;QACtG,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,qBAAqB,EAAE,CAAC,CAAC;QACvG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,IAAI,IAAI,CAAC,SAAS,KAAK,kBAAkB,EAAE,CAAC;YAC1C,GAAG,CAAC,IAAI,CAAC;gBACP,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC;gBAC1B,OAAO,EAAE,wCAAwC,kBAAkB,mDAAmD;aACvH,CAAC,CAAC;QACL,CAAC;QACD,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,0DAA0D,EAAE,CAAC,CAAC;YACxI,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,KAAK,SAAS;gBAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,iBAAiB,OAAO,WAAW,EAAE,CAAC,CAAC;YACzH,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,iBAAiB,CAAC,IAA2B;IAC3D,MAAM,GAAG,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC3C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,QAAQ,IAAI,EAAE;QAAE,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjG,OAAO,GAAG,CAAC;AACb,CAAC"}