@skillcdn/console 0.4.0 → 0.4.2

package/dist/plugin/args.js

@@ -0,0 +1,369 @@
+// The arguments of a plugin's commands and queries (docs/specs/plugins.md, "The server module"):
+// each defined once, as data the console parses command lines against, writes help from and draws
+// forms from, and as a type the command's `run` receives. A definer yields a plain object; what
+// crosses from the plugin's thread to the console is exactly that object.
+import { PluginDefinitionError } from "./definition-error.js";
+import { MAX_PLUGIN_ABOUT_LENGTH, MAX_PLUGIN_OPTIONS } from "./limits.js";
+import { PLUGIN_KEY_PATTERN } from "./manifest.js";
+export const ARG_TYPES = [
+    "text",
+    "markdown",
+    "day",
+    "number",
+    "boolean",
+    "enum",
+    "person",
+    "project",
+    "record",
+    "list",
+    "file",
+];
+function common(options) {
+    const about = options?.about;
+    if (about !== undefined &&
+        (about.length === 0 || about.length > MAX_PLUGIN_ABOUT_LENGTH || /[\r\n]/.test(about))) {
+        throw new PluginDefinitionError([
+            `an argument's about is one line of 1 to ${MAX_PLUGIN_ABOUT_LENGTH} characters`,
+        ]);
+    }
+    return {
+        ...(about === undefined ? {} : { about }),
+        optional: (options?.optional ?? false),
+        positional: options?.positional ?? false,
+    };
+}
+function bound(name, value, integer) {
+    if (value !== undefined && (!Number.isFinite(value) || (integer && !Number.isInteger(value)))) {
+        throw new PluginDefinitionError([`${name} is not a ${integer ? "whole " : ""}number`]);
+    }
+}
+/** The definers: `arg.text({ max: 200 })`, `arg.day({ positional: true })`, `arg.list(arg.person())`. */
+export const arg = {
+    /** A line of text, up to `max` characters; `secret` hides it in the event the command leaves. */
+    text(options) {
+        bound("max", options?.max, true);
+        return {
+            type: "text",
+            ...common(options),
+            ...(options?.max === undefined ? {} : { max: options.max }),
+            ...(options?.secret === true ? { secret: true } : {}),
+        };
+    },
+    /** Markdown, with its line breaks, up to `max` characters. */
+    markdown(options) {
+        bound("max", options?.max, true);
+        return {
+            type: "markdown",
+            ...common(options),
+            ...(options?.max === undefined ? {} : { max: options.max }),
+        };
+    },
+    /** A day as `YYYY-MM-DD`. */
+    day(options) {
+        return { type: "day", ...common(options) };
+    },
+    /** A number, within `min` and `max`, whole where `integer`. */
+    number(options) {
+        bound("min", options?.min, false);
+        bound("max", options?.max, false);
+        if (options?.min !== undefined && options.max !== undefined && options.min > options.max) {
+            throw new PluginDefinitionError(["min is above max"]);
+        }
+        return {
+            type: "number",
+            ...common(options),
+            ...(options?.min === undefined ? {} : { min: options.min }),
+            ...(options?.max === undefined ? {} : { max: options.max }),
+            ...(options?.integer === true ? { integer: true } : {}),
+        };
+    },
+    /** `true` or `false`; on the command line, `--<name>` alone is `true`. */
+    boolean(options) {
+        return { type: "boolean", ...common(options) };
+    },
+    /** One of the words given. */
+    enum(values, options) {
+        if (values.length === 0 ||
+            values.length > MAX_PLUGIN_OPTIONS ||
+            new Set(values).size !== values.length) {
+            throw new PluginDefinitionError([`an enum takes 1 to ${MAX_PLUGIN_OPTIONS} different words`]);
+        }
+        for (const value of values) {
+            if (value.length === 0 || value.length > 64 || /\s/.test(value)) {
+                throw new PluginDefinitionError([
+                    `the enum word "${value}" is not one word of up to 64 characters`,
+                ]);
+            }
+        }
+        return { type: "enum", ...common(options), options: [...values] };
+    },
+    /** A person: a login or `me` on the command line, resolved by the console to one the caller may see. */
+    person(options) {
+        return { type: "person", ...common(options) };
+    },
+    /** A project: a key the caller may see. */
+    project(options) {
+        return { type: "project", ...common(options) };
+    },
+    /** The id of a record of the collection named, one of this plugin's. */
+    record(collection, options) {
+        if (!PLUGIN_KEY_PATTERN.test(collection)) {
+            throw new PluginDefinitionError([
+                `arg.record names the collection "${collection}", which is not a key`,
+            ]);
+        }
+        return { type: "record", ...common(options), collection };
+    },
+    /** Several of the inner argument: the flag repeated, or commas between; up to `max` items. */
+    list(of, options) {
+        if (of.type === "list" || of.type === "file" || of.type === "markdown") {
+            throw new PluginDefinitionError([`a list of ${of.type} is not an argument`]);
+        }
+        if (of.optional || of.positional) {
+            throw new PluginDefinitionError([
+                "the items of a list are neither optional nor positional themselves",
+            ]);
+        }
+        bound("max", options?.max, true);
+        return {
+            type: "list",
+            ...common(options),
+            ...(options?.max === undefined ? {} : { max: options.max }),
+            of,
+        };
+    },
+    /** A file: what `--file <path>` or `-` carried, uploaded first and handed as a handle. */
+    file(options) {
+        return { type: "file", ...common(options) };
+    },
+};
+const DAY = /^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$/;
+const DEFAULT_TEXT_MAX = 2000;
+const DEFAULT_MARKDOWN_MAX = 20_000;
+const DEFAULT_LIST_MAX = 100;
+/**
+ * The problem with a value for an argument, as it arrives on the wire before the console
+ * resolves it: a person is a login or `me`, a project a key, a record an id, a file a handle, each
+ * a string. Nothing when the value fits.
+ */
+export function argProblem(name, description, value) {
+    if (value === undefined) {
+        return description.optional ? undefined : `${name} is required`;
+    }
+    switch (description.type) {
+        case "text":
+        case "markdown": {
+            if (typeof value !== "string") {
+                return `${name} is not text`;
+            }
+            const max = description.max ?? (description.type === "text" ? DEFAULT_TEXT_MAX : DEFAULT_MARKDOWN_MAX);
+            if (value.length > max) {
+                return `${name} is over ${max} characters`;
+            }
+            if (description.type === "text" && /[\r\n]/.test(value)) {
+                return `${name} is one line`;
+            }
+            return undefined;
+        }
+        case "day":
+            return typeof value === "string" && DAY.test(value)
+                ? undefined
+                : `${name} is not a day as YYYY-MM-DD`;
+        case "number": {
+            if (typeof value !== "number" || !Number.isFinite(value)) {
+                return `${name} is not a number`;
+            }
+            if (description.integer === true && !Number.isInteger(value)) {
+                return `${name} is not a whole number`;
+            }
+            if (description.min !== undefined && value < description.min) {
+                return `${name} is below ${description.min}`;
+            }
+            if (description.max !== undefined && value > description.max) {
+                return `${name} is above ${description.max}`;
+            }
+            return undefined;
+        }
+        case "boolean":
+            return typeof value === "boolean" ? undefined : `${name} is true or false`;
+        case "enum":
+            return typeof value === "string" && (description.options ?? []).includes(value)
+                ? undefined
+                : `${name} is one of ${(description.options ?? []).join(", ")}`;
+        case "person":
+        case "project":
+        case "record":
+        case "file":
+            return typeof value === "string" && value.length > 0 && value.length <= 254
+                ? undefined
+                : `${name} is not valid`;
+        case "list": {
+            if (!Array.isArray(value)) {
+                return `${name} is a list`;
+            }
+            const max = description.max ?? DEFAULT_LIST_MAX;
+            if (value.length > max) {
+                return `${name} has more than ${max} items`;
+            }
+            const of = description.of;
+            if (of === undefined) {
+                return `${name} has no item type`;
+            }
+            for (const [index, item] of value.entries()) {
+                const problem = argProblem(`${name}[${index}]`, of, item);
+                if (problem !== undefined) {
+                    return problem;
+                }
+            }
+            return undefined;
+        }
+        default:
+            return `${name} has a type the console does not know`;
+    }
+}
+/** The first problem with a set of values against their definitions, unknown names included; nothing when all fit. */
+export function argsProblem(definitions, values) {
+    for (const name of Object.keys(values)) {
+        if (!(name in definitions)) {
+            return `${name} is not an argument of this command`;
+        }
+    }
+    for (const [name, description] of Object.entries(definitions)) {
+        const problem = argProblem(name, description, values[name]);
+        if (problem !== undefined) {
+            return problem;
+        }
+    }
+    return undefined;
+}
+/**
+ * A word from the command line as the value an argument takes: a number read, a boolean read,
+ * a list split at commas; text as it is. Nothing the word cannot be is a problem `argProblem`
+ * then names.
+ */
+export function argValueFromWord(description, word) {
+    switch (description.type) {
+        case "number": {
+            const trimmed = word.trim();
+            return /^-?\d+(?:\.\d+)?$/.test(trimmed) ? Number(trimmed) : word;
+        }
+        case "boolean":
+            return word === "true" || word === "" ? true : word === "false" ? false : word;
+        case "list": {
+            const of = description.of;
+            return word
+                .split(",")
+                .map((item) => item.trim())
+                .filter((item) => item.length > 0)
+                .map((item) => (of === undefined ? item : argValueFromWord(of, item)));
+        }
+        default:
+            return word;
+    }
+}
+/**
+ * The words of a command line as the arguments of a command or a query, by its definitions
+ * (docs/specs/plugins.md, "The command"): the positional arguments in declaration order, one word
+ * each, among the flags, `--name value` or `--name=value`; a boolean flag alone means true; a
+ * list is a flag given again, or commas between its items; `--` ends the flags. An argument of
+ * type `file` takes the handles of the files the command uploaded, one each in declaration
+ * order, where none is named. The values are then checked with `argsProblem`.
+ */
+export function parseArgv(definitions, argv, files = []) {
+    const values = {};
+    const positionals = Object.entries(definitions).filter(([, description]) => description.positional);
+    let position = 0;
+    let flagsEnded = false;
+    const put = (name, description, word) => {
+        const value = argValueFromWord(description, word);
+        if (description.type === "list") {
+            const current = values[name];
+            values[name] = Array.isArray(current) ? [...current, ...value] : value;
+            return undefined;
+        }
+        if (Object.hasOwn(values, name)) {
+            return `${name} is given more than once`;
+        }
+        values[name] = value;
+        return undefined;
+    };
+    for (let index = 0; index < argv.length; index += 1) {
+        const word = argv[index] ?? "";
+        if (!flagsEnded && word === "--") {
+            flagsEnded = true;
+            continue;
+        }
+        if (!flagsEnded && word.startsWith("--") && word.length > 2) {
+            const equals = word.indexOf("=");
+            const name = equals < 0 ? word.slice(2) : word.slice(2, equals);
+            const description = Object.hasOwn(definitions, name) ? definitions[name] : undefined;
+            if (description === undefined) {
+                return { problem: `--${name} is not an argument of this command` };
+            }
+            let given;
+            if (equals >= 0) {
+                given = word.slice(equals + 1);
+            }
+            else if (description.type === "boolean") {
+                given = "";
+            }
+            else {
+                const next = argv[index + 1];
+                if (next === undefined) {
+                    return { problem: `--${name} needs a value` };
+                }
+                given = next;
+                index += 1;
+            }
+            const problem = put(name, description, given);
+            if (problem !== undefined) {
+                return { problem };
+            }
+            continue;
+        }
+        const slot = positionals[position];
+        if (slot === undefined) {
+            return {
+                problem: positionals.length === 0
+                    ? `${JSON.stringify(word)} is one word too many: the command takes no positional argument, only flags`
+                    : `${JSON.stringify(word)} is one word too many: the command takes ${positionals.length} positional argument${positionals.length === 1 ? "" : "s"}`,
+            };
+        }
+        const problem = put(slot[0], slot[1], word);
+        if (problem !== undefined) {
+            return { problem };
+        }
+        position += 1;
+    }
+    let taken = 0;
+    let slots = 0;
+    for (const [name, description] of Object.entries(definitions)) {
+        if (description.type !== "file") {
+            continue;
+        }
+        slots += 1;
+        if (!Object.hasOwn(values, name) && taken < files.length) {
+            values[name] = files[taken];
+            taken += 1;
+        }
+    }
+    if (taken < files.length) {
+        return {
+            problem: slots === 0
+                ? "the command takes no file"
+                : `the command takes ${slots} file${slots === 1 ? "" : "s"}, not ${files.length}`,
+        };
+    }
+    return { values };
+}
+/** The usage of an argument, as help prints it: `<from>` for a positional, `--to <day>` for a flag, in brackets where optional. */
+export function argUsage(name, description) {
+    const placeholder = description.type === "list" ? `${description.of?.type ?? "item"},...` : description.type;
+    const form = description.type === "boolean" && !description.positional
+        ? `--${name}`
+        : description.positional
+            ? `<${name}>`
+            : `--${name} <${placeholder}>`;
+    return description.optional ? `[${form}]` : form;
+}
+//# sourceMappingURL=args.js.map

package/dist/plugin/args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"args.js","sourceRoot":"","sources":["../../src/plugin/args.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,kGAAkG;AAClG,gGAAgG;AAChG,0EAA0E;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,MAAM;IACN,UAAU;IACV,KAAK;IACL,QAAQ;IACR,SAAS;IACT,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,MAAM;IACN,MAAM;CACE,CAAC;AAgGX,SAAS,MAAM,CACb,OAAqC;IAMrC,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,CAAC;IAC7B,IACE,KAAK,KAAK,SAAS;QACnB,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,uBAAuB,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EACtF,CAAC;QACD,MAAM,IAAI,qBAAqB,CAAC;YAC9B,2CAA2C,uBAAuB,aAAa;SAChF,CAAC,CAAC;IACL,CAAC;IACD,OAAO;QACL,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,IAAI,KAAK,CAAM;QAC3C,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,KAAK;KACzC,CAAC;AACJ,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,KAAyB,EAAE,OAAgB;IACtE,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9F,MAAM,IAAI,qBAAqB,CAAC,CAAC,GAAG,IAAI,aAAa,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;IACzF,CAAC;AACH,CAAC;AAED,yGAAyG;AACzG,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,iGAAiG;IACjG,IAAI,CACF,OAAiF;QAEjF,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,GAAG,MAAM,CAAC,OAAO,CAAC;YAClB,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3D,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtD,CAAC;IACJ,CAAC;IACD,8DAA8D;IAC9D,QAAQ,CACN,OAAsD;QAEtD,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,GAAG,MAAM,CAAC,OAAO,CAAC;YAClB,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;SAC5D,CAAC;IACJ,CAAC;IACD,6BAA6B;IAC7B,GAAG,CAA4B,OAA0B;QACvD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7C,CAAC;IACD,+DAA+D;IAC/D,MAAM,CACJ,OAIC;QAED,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,IAAI,OAAO,EAAE,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YACzF,MAAM,IAAI,qBAAqB,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,GAAG,MAAM,CAAC,OAAO,CAAC;YAClB,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3D,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3D,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxD,CAAC;IACJ,CAAC;IACD,0EAA0E;IAC1E,OAAO,CAA4B,OAA0B;QAC3D,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACjD,CAAC;IACD,8BAA8B;IAC9B,IAAI,CACF,MAAS,EACT,OAA0B;QAE1B,IACE,MAAM,CAAC,MAAM,KAAK,CAAC;YACnB,MAAM,CAAC,MAAM,GAAG,kBAAkB;YAClC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EACtC,CAAC;YACD,MAAM,IAAI,qBAAqB,CAAC,CAAC,sBAAsB,kBAAkB,kBAAkB,CAAC,CAAC,CAAC;QAChG,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChE,MAAM,IAAI,qBAAqB,CAAC;oBAC9B,kBAAkB,KAAK,0CAA0C;iBAClE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC;IACpE,CAAC;IACD,wGAAwG;IACxG,MAAM,CAA4B,OAA0B;QAC1D,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAChD,CAAC;IACD,2CAA2C;IAC3C,OAAO,CACL,OAA0B;QAE1B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACjD,CAAC;IACD,wEAAwE;IACxE,MAAM,CACJ,UAAkB,EAClB,OAA0B;QAE1B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,qBAAqB,CAAC;gBAC9B,oCAAoC,UAAU,uBAAuB;aACtE,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IAC5D,CAAC;IACD,8FAA8F;IAC9F,IAAI,CACF,EAAK,EACL,OAAsD;QAEtD,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YACvE,MAAM,IAAI,qBAAqB,CAAC,CAAC,aAAa,EAAE,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,EAAE,CAAC,QAAQ,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;YACjC,MAAM,IAAI,qBAAqB,CAAC;gBAC9B,oEAAoE;aACrE,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACjC,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,GAAG,MAAM,CAAC,OAAO,CAAC;YAClB,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;YAC3D,EAAE;SACH,CAAC;IACJ,CAAC;IACD,0FAA0F;IAC1F,IAAI,CACF,OAA8C;QAE9C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9C,CAAC;CACF,CAAC;AAEF,MAAM,GAAG,GAAG,mDAAmD,CAAC;AAChE,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,oBAAoB,GAAG,MAAM,CAAC;AACpC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,IAAY,EACZ,WAA2B,EAC3B,KAAc;IAEd,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,cAAc,CAAC;IAClE,CAAC;IACD,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU,EAAE,CAAC;YAChB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,GAAG,IAAI,cAAc,CAAC;YAC/B,CAAC;YACD,MAAM,GAAG,GACP,WAAW,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;YAC7F,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,IAAI,YAAY,GAAG,aAAa,CAAC;YAC7C,CAAC;YACD,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxD,OAAO,GAAG,IAAI,cAAc,CAAC;YAC/B,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,KAAK;YACR,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;gBACjD,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,GAAG,IAAI,6BAA6B,CAAC;QAC3C,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzD,OAAO,GAAG,IAAI,kBAAkB,CAAC;YACnC,CAAC;YACD,IAAI,WAAW,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7D,OAAO,GAAG,IAAI,wBAAwB,CAAC;YACzC,CAAC;YACD,IAAI,WAAW,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;gBAC7D,OAAO,GAAG,IAAI,aAAa,WAAW,CAAC,GAAG,EAAE,CAAC;YAC/C,CAAC;YACD,IAAI,WAAW,CAAC,GAAG,KAAK,SAAS,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;gBAC7D,OAAO,GAAG,IAAI,aAAa,WAAW,CAAC,GAAG,EAAE,CAAC;YAC/C,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,KAAK,SAAS;YACZ,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,mBAAmB,CAAC;QAC7E,KAAK,MAAM;YACT,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC7E,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpE,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS,CAAC;QACf,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM;YACT,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;gBACzE,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,GAAG,IAAI,eAAe,CAAC;QAC7B,KAAK,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,GAAG,IAAI,YAAY,CAAC;YAC7B,CAAC;YACD,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,IAAI,gBAAgB,CAAC;YAChD,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACvB,OAAO,GAAG,IAAI,kBAAkB,GAAG,QAAQ,CAAC;YAC9C,CAAC;YACD,MAAM,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC;YAC1B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,OAAO,GAAG,IAAI,mBAAmB,CAAC;YACpC,CAAC;YACD,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;gBAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;gBAC1D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,OAAO,OAAO,CAAC;gBACjB,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD;YACE,OAAO,GAAG,IAAI,uCAAuC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,WAAW,CACzB,WAAqD,EACrD,MAAyC;IAEzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,EAAE,CAAC;YAC3B,OAAO,GAAG,IAAI,qCAAqC,CAAC;QACtD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,WAA2B,EAAE,IAAY;IACxE,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACzB,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,OAAO,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpE,CAAC;QACD,KAAK,SAAS;YACZ,OAAO,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACjF,KAAK,MAAM,EAAE,CAAC;YACZ,MAAM,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI;iBACR,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;iBAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;iBACjC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC;AAOD;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,WAAqD,EACrD,IAAuB,EACvB,KAAK,GAAsB,EAAE;IAE7B,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACpD,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAC5C,CAAC;IACF,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,WAA2B,EAAE,IAAY,EAAsB,EAAE;QAC1F,MAAM,KAAK,GAAG,gBAAgB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAClD,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,EAAE,GAAI,KAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACtF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;YAChC,OAAO,GAAG,IAAI,0BAA0B,CAAC;QAC3C,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IACF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC/B,IAAI,CAAC,UAAU,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACjC,UAAU,GAAG,IAAI,CAAC;YAClB,SAAS;QACX,CAAC;QACD,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAChE,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACrF,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,qCAAqC,EAAE,CAAC;YACrE,CAAC;YACD,IAAI,KAAa,CAAC;YAClB,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;gBAChB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACjC,CAAC;iBAAM,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC1C,KAAK,GAAG,EAAE,CAAC;YACb,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;gBAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,gBAAgB,EAAE,CAAC;gBAChD,CAAC;gBACD,KAAK,GAAG,IAAI,CAAC;gBACb,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;YACD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,OAAO,EAAE,OAAO,EAAE,CAAC;YACrB,CAAC;YACD,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO;gBACL,OAAO,EACL,WAAW,CAAC,MAAM,KAAK,CAAC;oBACtB,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,6EAA6E;oBACtG,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,4CAA4C,WAAW,CAAC,MAAM,uBAAuB,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE;aACxJ,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAE,OAAO,EAAE,CAAC;QACrB,CAAC;QACD,QAAQ,IAAI,CAAC,CAAC;IAChB,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC9D,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAChC,SAAS;QACX,CAAC;QACD,KAAK,IAAI,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAC5B,KAAK,IAAI,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IACD,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO;YACL,OAAO,EACL,KAAK,KAAK,CAAC;gBACT,CAAC,CAAC,2BAA2B;gBAC7B,CAAC,CAAC,qBAAqB,KAAK,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,KAAK,CAAC,MAAM,EAAE;SACtF,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC;AAED,mIAAmI;AACnI,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,WAA2B;IAChE,MAAM,WAAW,GACf,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,IAAI,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;IAC3F,MAAM,IAAI,GACR,WAAW,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,WAAW,CAAC,UAAU;QACvD,CAAC,CAAC,KAAK,IAAI,EAAE;QACb,CAAC,CAAC,WAAW,CAAC,UAAU;YACtB,CAAC,CAAC,IAAI,IAAI,GAAG;YACb,CAAC,CAAC,KAAK,IAAI,KAAK,WAAW,GAAG,CAAC;IACrC,OAAO,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACnD,CAAC"}

package/dist/plugin/bridge.d.ts

@@ -0,0 +1,146 @@
+export declare const PLUGIN_BRIDGE_VERSION = 1;
+/** What the frame may ask the page to perform, each under `/api/v1/plugins/<key>/` and nothing else. */
+export declare const BRIDGE_METHODS: readonly ["command", "query", "records.list", "records.get", "records.versions", "files.get", "files.put"];
+export type BridgeMethod = (typeof BRIDGE_METHODS)[number];
+/** The kinds of `event` a frame may subscribe to: its plugin's records changed, a command ran, the plugin emitted. */
+export declare const BRIDGE_EVENT_KINDS: readonly ["records", "command", "plugin"];
+export type BridgeEventKind = (typeof BRIDGE_EVENT_KINDS)[number];
+export interface BridgePerson {
+    readonly id: string;
+    readonly login: string;
+    readonly name: string | null;
+    readonly language: string;
+    readonly admin: boolean;
+}
+/** What the page tells the frame once it is ready: who looks, at what, in which words and colours. */
+export interface BridgeInit {
+    readonly v: 1;
+    readonly t: "init";
+    readonly plugin: {
+        readonly key: string;
+        readonly version: string;
+    };
+    readonly page?: string;
+    readonly widget?: string;
+    readonly project: {
+        readonly key: string;
+        readonly name: string;
+    } | null;
+    readonly person: BridgePerson;
+    readonly roles: readonly string[];
+    /** What follows the page's key in the address. */
+    readonly path: string;
+    readonly language: string;
+    /** The console's computed design tokens, `--sc-*`. */
+    readonly theme: Readonly<Record<string, string>>;
+}
+export interface BridgeError {
+    readonly code: string;
+    readonly message: string;
+    readonly data?: unknown;
+}
+export interface BridgeResult {
+    readonly v: 1;
+    readonly t: "result";
+    readonly id: string;
+    readonly ok: boolean;
+    readonly value?: unknown;
+    readonly error?: BridgeError;
+}
+export interface BridgeEvent {
+    readonly v: 1;
+    readonly t: "event";
+    readonly kind: BridgeEventKind;
+    readonly data: unknown;
+}
+export interface BridgeTheme {
+    readonly v: 1;
+    readonly t: "theme";
+    readonly theme: Readonly<Record<string, string>>;
+}
+export interface BridgePath {
+    readonly v: 1;
+    readonly t: "path";
+    readonly path: string;
+}
+export type BridgeToFrame = BridgeInit | BridgeResult | BridgeEvent | BridgeTheme | BridgePath;
+export interface BridgeReady {
+    readonly v: 1;
+    readonly t: "ready";
+}
+export interface BridgeCall {
+    readonly v: 1;
+    readonly t: "call";
+    readonly id: string;
+    readonly method: BridgeMethod;
+    readonly params: unknown;
+}
+export interface BridgeNavigate {
+    readonly v: 1;
+    readonly t: "navigate";
+    readonly path: string;
+}
+export interface BridgeResize {
+    readonly v: 1;
+    readonly t: "resize";
+    readonly height: number;
+}
+export interface BridgeTitle {
+    readonly v: 1;
+    readonly t: "title";
+    readonly text: string;
+}
+export interface BridgeDownload {
+    readonly v: 1;
+    readonly t: "download";
+    readonly id: string;
+}
+export interface BridgeSubscribe {
+    readonly v: 1;
+    readonly t: "subscribe";
+    readonly kinds: readonly BridgeEventKind[];
+}
+export type BridgeToPage = BridgeReady | BridgeCall | BridgeNavigate | BridgeResize | BridgeTitle | BridgeDownload | BridgeSubscribe;
+/** A path of the console's, as `navigate` and `path` carry one: absolute, no scheme, no host, one line. */
+export declare const MAX_BRIDGE_PATH_LENGTH = 2048;
+export declare const MAX_BRIDGE_TITLE_LENGTH = 200;
+/** True for a path the page may follow: within the console, never a URL. */
+export declare function isBridgePath(value: unknown): value is string;
+/** True for a message the frame may act on, as the console's page sends them. */
+export declare function isBridgeToFrame(value: unknown): value is BridgeToFrame;
+/** True for a message the page may act on, as a frame sends them; anything else is dropped unread. */
+export declare function isBridgeToPage(value: unknown): value is BridgeToPage;
+/** The result of a command as the frame receives it, the same shape the command line prints from. */
+export interface BridgeCommandResult {
+    readonly kind: "command" | "query";
+    readonly text: string;
+    readonly data: unknown;
+    readonly waiting: string | null;
+}
+/** What `records.list` and `records.get` carry in `params`, as the page sends them on. */
+export interface BridgeRecordsListParams {
+    readonly collection: string;
+    readonly where?: Readonly<Record<string, unknown>>;
+    readonly order?: string;
+    readonly limit?: number;
+    readonly after?: string;
+    readonly q?: string;
+    readonly project?: string;
+}
+export interface BridgeRecordsGetParams {
+    readonly collection: string;
+    readonly id: string;
+    readonly version?: number;
+}
+export interface BridgeFilesPutParams {
+    readonly bytes: ArrayBuffer;
+    readonly name: string;
+    readonly type: string;
+}
+/** What `files.get` answers: the bytes, transferred, with the file's name and type. */
+export interface BridgeFile {
+    readonly name: string;
+    readonly type: string;
+    readonly bytes: ArrayBuffer;
+}
+//# sourceMappingURL=bridge.d.ts.map

package/dist/plugin/bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../../src/plugin/bridge.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC,wGAAwG;AACxG,eAAO,MAAM,cAAc,YACzB,SAAS,EACT,OAAO,EACP,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,WAAW,CACH,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,sHAAsH;AACtH,eAAO,MAAM,kBAAkB,YAAI,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAE5E,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAED,sGAAsG;AACtG,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACpE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACzE,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;AAE/F,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACd,QAAQ,CAAC,CAAC,EAAE,WAAW,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;CAC5C;AAED,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,UAAU,GACV,cAAc,GACd,YAAY,GACZ,WAAW,GACX,cAAc,GACd,eAAe,CAAC;AAEpB,2GAA2G;AAC3G,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAc3C,4EAA4E;AAC5E,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAQ5D;AAoBD,iFAAiF;AACjF,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAkDtE;AAED,sGAAsG;AACtG,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAsCpE;AAED,qGAAqG;AACrG,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,0FAA0F;AAC1F,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,uFAAuF;AACvF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B"}

package/dist/plugin/bridge.js

@@ -0,0 +1,125 @@
+// The messages between the console's page and a plugin's frame (docs/specs/plugins.md, "The
+// bridge"): every message `{ v: 1, t, ... }`, the page accepting the frame's window alone, the
+// frame the console's origin alone. The shapes and their guards, with no DOM in them, so that the
+// page's side and the frame's side read the same words and the tests need no browser.
+export const PLUGIN_BRIDGE_VERSION = 1;
+/** What the frame may ask the page to perform, each under `/api/v1/plugins/<key>/` and nothing else. */
+export const BRIDGE_METHODS = [
+    "command",
+    "query",
+    "records.list",
+    "records.get",
+    "records.versions",
+    "files.get",
+    "files.put",
+];
+/** The kinds of `event` a frame may subscribe to: its plugin's records changed, a command ran, the plugin emitted. */
+export const BRIDGE_EVENT_KINDS = ["records", "command", "plugin"];
+/** A path of the console's, as `navigate` and `path` carry one: absolute, no scheme, no host, one line. */
+export const MAX_BRIDGE_PATH_LENGTH = 2048;
+export const MAX_BRIDGE_TITLE_LENGTH = 200;
+const MAX_ID_LENGTH = 128;
+const MAX_THEME_TOKENS = 500;
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isLine(value, max) {
+    return (typeof value === "string" && value.length > 0 && value.length <= max && !/[\r\n]/.test(value));
+}
+/** True for a path the page may follow: within the console, never a URL. */
+export function isBridgePath(value) {
+    return (typeof value === "string" &&
+        value.length <= MAX_BRIDGE_PATH_LENGTH &&
+        value.startsWith("/") &&
+        !value.startsWith("//") &&
+        !/[\s\\]/.test(value));
+}
+function isTheme(value) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    const entries = Object.entries(value);
+    return (entries.length <= MAX_THEME_TOKENS &&
+        entries.every(([token, text]) => /^--sc-[a-z0-9-]+$/.test(token) && typeof text === "string" && text.length <= 200));
+}
+function isEnvelope(value) {
+    return isRecord(value) && value.v === PLUGIN_BRIDGE_VERSION && typeof value.t === "string";
+}
+/** True for a message the frame may act on, as the console's page sends them. */
+export function isBridgeToFrame(value) {
+    if (!isEnvelope(value)) {
+        return false;
+    }
+    switch (value.t) {
+        case "init":
+            return (isRecord(value.plugin) &&
+                isLine(value.plugin.key, 32) &&
+                isLine(value.plugin.version, 64) &&
+                (value.page === undefined || isLine(value.page, 32)) &&
+                (value.widget === undefined || isLine(value.widget, 32)) &&
+                (value.project === null ||
+                    (isRecord(value.project) &&
+                        isLine(value.project.key, 64) &&
+                        typeof value.project.name === "string")) &&
+                isRecord(value.person) &&
+                typeof value.person.id === "string" &&
+                typeof value.person.login === "string" &&
+                (value.person.name === null || typeof value.person.name === "string") &&
+                typeof value.person.language === "string" &&
+                typeof value.person.admin === "boolean" &&
+                Array.isArray(value.roles) &&
+                value.roles.every((role) => typeof role === "string") &&
+                typeof value.path === "string" &&
+                value.path.length <= MAX_BRIDGE_PATH_LENGTH &&
+                typeof value.language === "string" &&
+                isTheme(value.theme));
+        case "result":
+            return (isLine(value.id, MAX_ID_LENGTH) &&
+                typeof value.ok === "boolean" &&
+                (value.error === undefined ||
+                    (isRecord(value.error) &&
+                        typeof value.error.code === "string" &&
+                        typeof value.error.message === "string")));
+        case "event":
+            return (typeof value.kind === "string" &&
+                BRIDGE_EVENT_KINDS.includes(value.kind));
+        case "theme":
+            return isTheme(value.theme);
+        case "path":
+            return typeof value.path === "string" && value.path.length <= MAX_BRIDGE_PATH_LENGTH;
+        default:
+            return false;
+    }
+}
+/** True for a message the page may act on, as a frame sends them; anything else is dropped unread. */
+export function isBridgeToPage(value) {
+    if (!isEnvelope(value)) {
+        return false;
+    }
+    switch (value.t) {
+        case "ready":
+            return true;
+        case "call":
+            return (isLine(value.id, MAX_ID_LENGTH) &&
+                typeof value.method === "string" &&
+                BRIDGE_METHODS.includes(value.method) &&
+                isRecord(value.params));
+        case "navigate":
+            return isBridgePath(value.path);
+        case "resize":
+            return typeof value.height === "number" && Number.isFinite(value.height) && value.height >= 0;
+        case "title":
+            return (typeof value.text === "string" &&
+                value.text.length <= MAX_BRIDGE_TITLE_LENGTH &&
+                !/[\r\n]/.test(value.text));
+        case "download":
+            return isLine(value.id, MAX_ID_LENGTH);
+        case "subscribe":
+            return (Array.isArray(value.kinds) &&
+                value.kinds.length <= BRIDGE_EVENT_KINDS.length &&
+                value.kinds.every((kind) => typeof kind === "string" && BRIDGE_EVENT_KINDS.includes(kind)));
+        default:
+            return false;
+    }
+}
+//# sourceMappingURL=bridge.js.map