@apimatic/cli 1.4.0 → 2.0.0-beta.1

package/lib/types/portal/code-samples.js

@@ -0,0 +1,67 @@
+import { languageLabel } from '../sdk/generate.js';
+import { isJsonObject } from '../../utils/json-utils.js';
+import { Endpoint } from './endpoint.js';
+export class CodeSampleCatalog {
+    samplesByEndpoint;
+    constructor(samplesByEndpoint) {
+        this.samplesByEndpoint = samplesByEndpoint;
+    }
+    static fromJson(language, json) {
+        if (!isJsonObject(json) || !isJsonObject(json.paths)) {
+            return undefined;
+        }
+        const samplesByEndpoint = new Map();
+        for (const [path, methods] of Object.entries(json.paths)) {
+            if (!isJsonObject(methods)) {
+                return undefined;
+            }
+            for (const [method, sources] of Object.entries(methods)) {
+                if (!isSources(sources)) {
+                    return undefined;
+                }
+                const endpoint = new Endpoint(method, path);
+                samplesByEndpoint.set(`${endpoint}`, { endpoint, sample: toCodeSample(language, sources) });
+            }
+        }
+        return new CodeSampleCatalog(samplesByEndpoint);
+    }
+    sampleFor(endpoint) {
+        return this.samplesByEndpoint.get(`${endpoint}`)?.sample;
+    }
+    endpoints() {
+        return [...this.samplesByEndpoint.values()].map(({ endpoint }) => endpoint);
+    }
+}
+export class CodeSampleCatalogs {
+    catalogs;
+    constructor(catalogs) {
+        this.catalogs = catalogs;
+    }
+    isEmpty() {
+        return this.catalogs.length === 0;
+    }
+    samplesFor(endpoint) {
+        return this.catalogs.flatMap((catalog) => catalog.sampleFor(endpoint) ?? []);
+    }
+    unplacedIn(documented) {
+        const names = new Set(documented.map(String));
+        return [...new Set(this.endpoints().map(String))].filter((endpoint) => !names.has(endpoint));
+    }
+    toJson() {
+        const json = {};
+        for (const endpoint of this.endpoints()) {
+            json[endpoint.path] = { ...json[endpoint.path], [endpoint.method]: this.samplesFor(endpoint) };
+        }
+        return json;
+    }
+    endpoints() {
+        return this.catalogs.flatMap((catalog) => catalog.endpoints());
+    }
+}
+function toCodeSample(language, sources) {
+    return { lang: language, label: languageLabel(language), sources };
+}
+function isSources(value) {
+    return isJsonObject(value) && Object.values(value).every((source) => typeof source === 'string');
+}
+//# sourceMappingURL=code-samples.js.map

package/lib/types/portal/code-samples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-samples.js","sourceRoot":"","sources":["../../../src/types/portal/code-samples.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAkBzC,MAAM,OAAO,iBAAiB;IACS,iBAAiB;IAAtD,YAAqC,iBAA4C;iCAA5C,iBAAiB;IAA8B,CAAC;IAE9E,MAAM,CAAC,QAAQ,CAAC,QAAkB,EAAE,IAAa;QACtD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAwB,CAAC;QAC1D,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC3B,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACxD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;oBACxB,OAAO,SAAS,CAAC;gBACnB,CAAC;gBACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBAC5C,iBAAiB,CAAC,GAAG,CAAC,GAAG,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;QACD,OAAO,IAAI,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAClD,CAAC;IAEM,SAAS,CAAC,QAAkB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC;IAC3D,CAAC;IAEM,SAAS;QACd,OAAO,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC9E,CAAC;CACF;AAED,MAAM,OAAO,kBAAkB;IACA,QAAQ;IAArC,YAA6B,QAA6B;wBAA7B,QAAQ;IAAwB,CAAC;IAEvD,OAAO;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC;IACpC,CAAC;IAEM,UAAU,CAAC,QAAkB;QAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/E,CAAC;IAEM,UAAU,CAAC,UAAsB;QACtC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/F,CAAC;IAEM,MAAM;QACX,MAAM,IAAI,GAA0B,EAAE,CAAC;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,SAAS;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAED,SAAS,YAAY,CAAC,QAAkB,EAAE,OAAgB;IACxD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;AACrE,CAAC;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC;AACnG,CAAC"}

package/lib/types/portal/config/ai-config.d.ts

@@ -0,0 +1,15 @@
+import { Parsed } from './fields.js';
+export declare class AiConfig {
+    private readonly pageActions;
+    private constructor();
+    static readonly defaults: AiConfig;
+    static parse(value: unknown, path: string): Parsed<AiConfig>;
+    /**
+     * Whether each page offers to open itself in an external AI assistant. A portal published
+     * under someone else's brand carries that endorsement, so it can be turned off.
+     */
+    offersPageActions(): boolean;
+    toJSON(): {
+        pageActions: boolean;
+    };
+}

package/lib/types/portal/config/ai-config.js

@@ -0,0 +1,26 @@
+import { Result } from 'neverthrow';
+import { allOf, namespace, optionalBoolean, unknownKeys } from './fields.js';
+const KNOWN = ['pageActions'];
+export class AiConfig {
+    pageActions;
+    constructor(pageActions) {
+        this.pageActions = pageActions;
+    }
+    static defaults = new AiConfig(true);
+    static parse(value, path) {
+        return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([
+            optionalBoolean(data.pageActions, `${path}.pageActions`, AiConfig.defaults.pageActions)
+        ])).map(([pageActions]) => new AiConfig(pageActions)));
+    }
+    /**
+     * Whether each page offers to open itself in an external AI assistant. A portal published
+     * under someone else's brand carries that endorsement, so it can be turned off.
+     */
+    offersPageActions() {
+        return this.pageActions;
+    }
+    toJSON() {
+        return { pageActions: this.pageActions };
+    }
+}
+//# sourceMappingURL=ai-config.js.map

package/lib/types/portal/config/ai-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/ai-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAErF,MAAM,KAAK,GAAG,CAAC,aAAa,CAAC,CAAC;AAE9B,MAAM,OAAO,QAAQ;IACkB,WAAW;IAAhD,YAAqC,WAAoB;2BAApB,WAAW;IAAY,CAAC;IAEtD,MAAM,CAAU,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE9C,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B,MAAM,CAAC,oBAAoB,CAAC;YAC1B,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,cAAc,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;SACxF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC,CACpD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;IAC3C,CAAC;CACF"}

package/lib/types/portal/config/brand-config.d.ts

@@ -0,0 +1,55 @@
+import { Color } from './color.js';
+import { Parsed } from './fields.js';
+import { StaticAsset } from './static-asset.js';
+export declare const COLOR_MODES: readonly ['light', 'dark', 'both'];
+export type ColorMode = (typeof COLOR_MODES)[number];
+export declare class Logo {
+    private readonly images;
+    private constructor();
+    static parse(value: unknown, path: string): Parsed<Logo>;
+    light(): StaticAsset;
+    dark(): StaticAsset;
+    files(): StaticAsset[];
+    toJSON(): string | {
+        light: string;
+        dark: string;
+    };
+}
+export declare class BrandColors {
+    private readonly primary;
+    private constructor();
+    static readonly defaults: BrandColors;
+    static parse(value: unknown, path: string): Parsed<BrandColors>;
+    /** The primary for each mode, or null when the theme's own applies. */
+    primaryColors(): {
+        light: Color;
+        dark: Color;
+    } | null;
+    toJSON(): {
+        primary?: string | {
+            light: string;
+            dark: string;
+        };
+    };
+    private static parseColor;
+}
+export declare class BrandConfig {
+    private readonly logo;
+    private readonly favicon;
+    private readonly colors;
+    private readonly colorMode;
+    private constructor();
+    static readonly defaults: BrandConfig;
+    static parse(value: unknown, path: string): Parsed<BrandConfig>;
+    logoImages(): Logo | null;
+    faviconImage(): StaticAsset | null;
+    brandColors(): BrandColors;
+    mode(): ColorMode;
+    files(): StaticAsset[];
+    toJSON(): {
+        logo?: ReturnType<Logo['toJSON']>;
+        favicon?: string;
+        colors: ReturnType<BrandColors['toJSON']>;
+        colorMode: ColorMode;
+    };
+}

package/lib/types/portal/config/brand-config.js

@@ -0,0 +1,105 @@
+import { err, ok, Result } from 'neverthrow';
+import { Color } from './color.js';
+import { allOf, lightDark, namespace, oneOf, optional, unknownKeys } from './fields.js';
+import { StaticAsset } from './static-asset.js';
+export const COLOR_MODES = ['light', 'dark', 'both'];
+const KNOWN = ['logo', 'favicon', 'colors', 'colorMode'];
+const KNOWN_COLORS = ['primary'];
+export class Logo {
+    images;
+    constructor(images) {
+        this.images = images;
+    }
+    static parse(value, path) {
+        return lightDark(value, path, StaticAsset.parse).map((images) => new Logo(images));
+    }
+    light() {
+        return this.images.light;
+    }
+    dark() {
+        return this.images.dark;
+    }
+    files() {
+        return this.images.light.isEqual(this.images.dark) ? [this.images.light] : [this.images.light, this.images.dark];
+    }
+    toJSON() {
+        const { light, dark, single } = this.images;
+        return single ? light.toJSON() : { light: light.toJSON(), dark: dark.toJSON() };
+    }
+}
+export class BrandColors {
+    primary;
+    constructor(primary) {
+        this.primary = primary;
+    }
+    static defaults = new BrandColors(null);
+    static parse(value, path) {
+        return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN_COLORS, path), Result.combineWithAllErrors([
+            optional(data.primary, (primary) => lightDark(primary, `${path}.primary`, BrandColors.parseColor))
+        ])).map(([primary]) => new BrandColors(primary)));
+    }
+    /** The primary for each mode, or null when the theme's own applies. */
+    primaryColors() {
+        return this.primary === null ? null : { light: this.primary.light, dark: this.primary.dark };
+    }
+    toJSON() {
+        if (this.primary === null) {
+            return {};
+        }
+        const { light, dark, single } = this.primary;
+        return { primary: single ? light.toString() : { light: light.toString(), dark: dark.toString() } };
+    }
+    static parseColor(value, path) {
+        const color = typeof value === 'string' ? Color.create(value) : undefined;
+        return color === undefined
+            ? err([`'${path}' must be a colour written as ${Color.formats}, for example '#1d4ed8'.`])
+            : ok(color);
+    }
+}
+export class BrandConfig {
+    logo;
+    favicon;
+    colors;
+    colorMode;
+    constructor(logo, favicon, colors, colorMode) {
+        this.logo = logo;
+        this.favicon = favicon;
+        this.colors = colors;
+        this.colorMode = colorMode;
+    }
+    static defaults = new BrandConfig(null, null, BrandColors.defaults, 'both');
+    static parse(value, path) {
+        return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([
+            optional(data.logo, (logo) => Logo.parse(logo, `${path}.logo`)),
+            optional(data.favicon, (favicon) => StaticAsset.parse(favicon, `${path}.favicon`)),
+            BrandColors.parse(data.colors, `${path}.colors`),
+            oneOf(data.colorMode, `${path}.colorMode`, COLOR_MODES, BrandConfig.defaults.colorMode)
+        ])).map(([logo, favicon, colors, colorMode]) => new BrandConfig(logo, favicon, colors, colorMode)));
+    }
+    logoImages() {
+        return this.logo;
+    }
+    faviconImage() {
+        return this.favicon ?? this.logo?.light() ?? null;
+    }
+    brandColors() {
+        return this.colors;
+    }
+    mode() {
+        return this.colorMode;
+    }
+    files() {
+        const logos = this.logo?.files() ?? [];
+        const favicon = this.favicon;
+        return favicon === null || logos.some((logo) => logo.isEqual(favicon)) ? logos : [...logos, favicon];
+    }
+    toJSON() {
+        return {
+            ...(this.logo === null ? {} : { logo: this.logo.toJSON() }),
+            ...(this.favicon === null ? {} : { favicon: this.favicon.toJSON() }),
+            colors: this.colors.toJSON(),
+            colorMode: this.colorMode
+        };
+    }
+}
+//# sourceMappingURL=brand-config.js.map

package/lib/types/portal/config/brand-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/brand-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAa,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAI9D,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AAEzD,MAAM,YAAY,GAAG,CAAC,SAAS,CAAC,CAAC;AAEjC,MAAM,OAAO,IAAI;IACsB,MAAM;IAA3C,YAAqC,MAA8B;sBAA9B,MAAM;IAA2B,CAAC;IAEhE,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnH,CAAC;IAEM,MAAM;QACX,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5C,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IAClF,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IACe,OAAO;IAA5C,YAAqC,OAAgC;uBAAhC,OAAO;IAA4B,CAAC;IAElE,MAAM,CAAU,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAEjD,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,EACrC,MAAM,CAAC,oBAAoB,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,UAAU,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;SACnG,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAC/C,CAAC;IACJ,CAAC;IAED,uEAAuE;IAChE,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC/F,CAAC;IAEM,MAAM;QACX,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YAC1B,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC;IACrG,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,KAAc,EAAE,IAAY;QACpD,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1E,OAAO,KAAK,KAAK,SAAS;YACxB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,iCAAiC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;YACzF,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;CACF;AAED,MAAM,OAAO,WAAW;IAEH,IAAI;IACJ,OAAO;IACP,MAAM;IACN,SAAS;IAJ5B,YACmB,IAAiB,EACjB,OAA2B,EAC3B,MAAmB,EACnB,SAAoB;oBAHpB,IAAI;uBACJ,OAAO;sBACP,MAAM;yBACN,SAAS;IACzB,CAAC;IAEG,MAAM,CAAU,QAAQ,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAErF,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B,MAAM,CAAC,oBAAoB,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;YAC/D,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,UAAU,CAAC,CAAC;YAClF,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC;YAChD,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;SACxF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CACjG,CAAC;IACJ,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC;IACpD,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,KAAK;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,OAAO,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAEM,MAAM;QAMX,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAC3D,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YACpE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAC5B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/config/color.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Hex only, which is how brand guidelines give a colour: the foreground laid over the primary is
+ * chosen by contrast, which needs the colour's channels.
+ */
+export declare class Color {
+    private readonly written;
+    private readonly rgb;
+    private constructor();
+    static readonly formats = "#rgb or #rrggbb";
+    /** The two foregrounds the neutral preset pairs with its own primaries. */
+    private static readonly light;
+    private static readonly dark;
+    static create(value: string): Color | undefined;
+    /** WCAG 2 relative luminance. */
+    luminance(): number;
+    contrastWith(other: Color): number;
+    foreground(): Color;
+    toString(): string;
+}

package/lib/types/portal/config/color.js

@@ -0,0 +1,43 @@
+const HEX = /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/i;
+/**
+ * Hex only, which is how brand guidelines give a colour: the foreground laid over the primary is
+ * chosen by contrast, which needs the colour's channels.
+ */
+export class Color {
+    written;
+    rgb;
+    constructor(written, rgb) {
+        this.written = written;
+        this.rgb = rgb;
+    }
+    static formats = '#rgb or #rrggbb';
+    /** The two foregrounds the neutral preset pairs with its own primaries. */
+    static light = new Color('hsl(0, 0%, 98%)', { red: 0.98, green: 0.98, blue: 0.98 });
+    static dark = new Color('hsl(0, 0%, 9%)', { red: 0.09, green: 0.09, blue: 0.09 });
+    static create(value) {
+        const text = value.trim();
+        if (!HEX.test(text)) {
+            return undefined;
+        }
+        const digits = text.slice(1);
+        const pairs = digits.length === 3 ? [...digits].map((digit) => digit + digit) : digits.match(/../g) ?? [];
+        const [red, green, blue] = pairs.map((pair) => Number.parseInt(pair, 16) / 255);
+        return new Color(text, { red, green, blue });
+    }
+    /** WCAG 2 relative luminance. */
+    luminance() {
+        const linear = (channel) => channel <= 0.04045 ? channel / 12.92 : Math.pow((channel + 0.055) / 1.055, 2.4);
+        return 0.2126 * linear(this.rgb.red) + 0.7152 * linear(this.rgb.green) + 0.0722 * linear(this.rgb.blue);
+    }
+    contrastWith(other) {
+        const [lighter, darker] = [this.luminance(), other.luminance()].sort((a, b) => b - a);
+        return (lighter + 0.05) / (darker + 0.05);
+    }
+    foreground() {
+        return this.contrastWith(Color.light) >= this.contrastWith(Color.dark) ? Color.light : Color.dark;
+    }
+    toString() {
+        return this.written;
+    }
+}
+//# sourceMappingURL=color.js.map

package/lib/types/portal/config/color.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"color.js","sourceRoot":"","sources":["../../../../src/types/portal/config/color.ts"],"names":[],"mappings":"AAOA,MAAM,GAAG,GAAG,iCAAiC,CAAC;AAE9C;;;GAGG;AACH,MAAM,OAAO,KAAK;IACqB,OAAO;IAA2B,GAAG;IAA1E,YAAqC,OAAe,EAAmB,GAAQ;uBAA1C,OAAO;mBAA2B,GAAG;IAAQ,CAAC;IAE5E,MAAM,CAAU,OAAO,GAAG,iBAAiB,CAAC;IAEnD,2EAA2E;IACnE,MAAM,CAAU,KAAK,GAAG,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7F,MAAM,CAAU,IAAI,GAAG,IAAI,KAAK,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5F,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1G,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC;QAChF,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,iCAAiC;IAC1B,SAAS;QACd,MAAM,MAAM,GAAG,CAAC,OAAe,EAAE,EAAE,CACjC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC;QAClF,OAAO,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1G,CAAC;IAEM,YAAY,CAAC,KAAY;QAC9B,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IACpG,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF"}

package/lib/types/portal/config/fields.d.ts

@@ -0,0 +1,23 @@
+import { Result } from 'neverthrow';
+export type Parsed<T> = Result<T, string[]>;
+export declare function isWebAddress(text: string): boolean;
+export declare function namespace(value: unknown, path: string): Parsed<Record<string, unknown>>;
+export declare function unknownKeys(data: Record<string, unknown>, known: readonly string[], path: string): string[];
+/**
+ * Every error at once, unknown keys first, so one edit fixes the file. `fields` is what
+ * `Result.combineWithAllErrors` makes of the field parsers.
+ */
+export declare function allOf<T>(unknown: string[], fields: Result<T, string[][]>): Parsed<T>;
+export interface LightDark<T> {
+    light: T;
+    dark: T;
+    /** Written once for both modes, which is how it serialises back. */
+    single: boolean;
+}
+export declare function lightDark<T>(value: unknown, path: string, parse: (present: unknown, path: string) => Parsed<T>): Parsed<LightDark<T>>;
+export declare function optional<T>(value: unknown, parse: (present: unknown) => Parsed<T>): Parsed<T | null>;
+export declare function optionalBoolean(value: unknown, path: string, fallback: boolean): Parsed<boolean>;
+export declare function oneOf<T extends string>(value: unknown, path: string, allowed: readonly T[], fallback: T): Parsed<T>;
+/** Each value in quotes, listed as a sentence lists them. */
+export declare function quotedList(values: readonly string[], joiner?: 'and' | 'or'): string;
+export declare function nonEmptyString(value: unknown, path: string): Parsed<string>;

package/lib/types/portal/config/fields.js

@@ -0,0 +1,67 @@
+import { err, ok, Result } from 'neverthrow';
+import { isJsonObject } from '../../../utils/json-utils.js';
+import { listedInProse } from '../../../utils/string-utils.js';
+import { UrlPath } from '../../file/urlPath.js';
+import { unknownFieldErrors } from '../unknown-fields.js';
+// The URL parser also takes `https:example.com`, which a browser on an https site reads as a
+// path of that site.
+export function isWebAddress(text) {
+    return /^https?:\/\//i.test(text) && UrlPath.create(text) !== undefined;
+}
+export function namespace(value, path) {
+    if (value === undefined) {
+        return ok({});
+    }
+    return isJsonObject(value) ? ok(value) : err([`'${path}' must be a JSON object.`]);
+}
+export function unknownKeys(data, known, path) {
+    return unknownFieldErrors(data, new Set(known), (key) => `'${path}.${key}' is not a 'portal' setting.`);
+}
+/**
+ * Every error at once, unknown keys first, so one edit fixes the file. `fields` is what
+ * `Result.combineWithAllErrors` makes of the field parsers.
+ */
+export function allOf(unknown, fields) {
+    if (fields.isErr()) {
+        return err([...unknown, ...fields.error.flat()]);
+    }
+    return unknown.length > 0 ? err(unknown) : ok(fields.value);
+}
+export function lightDark(value, path, parse) {
+    if (typeof value === 'string') {
+        return parse(value, path).map((both) => ({ light: both, dark: both, single: true }));
+    }
+    if (!isJsonObject(value)) {
+        return err([`'${path}' must be a string, or an object with 'light' and 'dark'.`]);
+    }
+    const mode = (name) => value[name] === undefined ? err([`'${path}.${name}' is required.`]) : parse(value[name], `${path}.${name}`);
+    return allOf(unknownKeys(value, ['light', 'dark'], path), Result.combineWithAllErrors([mode('light'), mode('dark')])).map(([light, dark]) => ({ light, dark, single: false }));
+}
+export function optional(value, parse) {
+    return value === undefined ? ok(null) : parse(value);
+}
+export function optionalBoolean(value, path, fallback) {
+    if (value === undefined) {
+        return ok(fallback);
+    }
+    return typeof value === 'boolean' ? ok(value) : err([`'${path}' must be true or false.`]);
+}
+export function oneOf(value, path, allowed, fallback) {
+    if (value === undefined) {
+        return ok(fallback);
+    }
+    if (typeof value === 'string' && allowed.includes(value)) {
+        return ok(value);
+    }
+    return err([`'${path}' must be one of ${quotedList(allowed, 'or')}.`]);
+}
+/** Each value in quotes, listed as a sentence lists them. */
+export function quotedList(values, joiner = 'and') {
+    return listedInProse(values.map((value) => `'${value}'`), joiner);
+}
+export function nonEmptyString(value, path) {
+    return typeof value === 'string' && value.trim().length > 0
+        ? ok(value.trim())
+        : err([`'${path}' must be a non-empty string.`]);
+}
+//# sourceMappingURL=fields.js.map

package/lib/types/portal/config/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/types/portal/config/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI1D,6FAA6F;AAC7F,qBAAqB;AACrB,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc,EAAE,IAAY;IACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,0BAA0B,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAA6B,EAAE,KAAwB,EAAE,IAAY;IAC/F,OAAO,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,IAAI,IAAI,GAAG,8BAA8B,CAAC,CAAC;AAC1G,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB,EAAE,MAA6B;IACvE,IAAI,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;QACnB,OAAO,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AASD,MAAM,UAAU,SAAS,CACvB,KAAc,EACd,IAAY,EACZ,KAAoD;IAEpD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,2DAA2D,CAAC,CAAC,CAAC;IACpF,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,IAAsB,EAAa,EAAE,CACjD,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;IAC9G,OAAO,KAAK,CACV,WAAW,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAC3C,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAC3D,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAI,KAAc,EAAE,KAAsC;IAChF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAc,EAAE,IAAY,EAAE,QAAiB;IAC7E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,0BAA0B,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,KAAK,CAAmB,KAAc,EAAE,IAAY,EAAE,OAAqB,EAAE,QAAW;IACtG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAK,OAA6B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAChF,OAAO,EAAE,CAAC,KAAU,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,oBAAoB,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,UAAU,CAAC,MAAyB,EAAE,MAAM,GAAiB,KAAK;IAChF,OAAO,aAAa,CAClB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,EACnC,MAAM,CACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAc,EAAE,IAAY;IACzD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;QACzD,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,+BAA+B,CAAC,CAAC,CAAC;AACrD,CAAC"}

package/lib/types/portal/config/link.d.ts

@@ -0,0 +1,18 @@
+import { Parsed } from './fields.js';
+/** A labelled link in the portal's header. */
+export declare class Link {
+    private readonly label;
+    private readonly url;
+    private readonly external;
+    private constructor();
+    static parse(value: unknown, path: string): Parsed<Link>;
+    text(): string;
+    href(): string;
+    isExternal(): boolean;
+    toJSON(): {
+        label: string;
+        url: string;
+    };
+    private static validUrl;
+    private static pageOfThePortal;
+}

package/lib/types/portal/config/link.js

@@ -0,0 +1,72 @@
+import { err, ok, Result } from 'neverthrow';
+import { isJsonObject } from '../../../utils/json-utils.js';
+import { allOf, isWebAddress, nonEmptyString, unknownKeys } from './fields.js';
+const KNOWN = ['label', 'url'];
+/** Stands in for the portal's own address, which is not known here; `.invalid` never resolves (RFC 6761). */
+const PORTAL_ORIGIN = 'https://portal.invalid';
+/** A labelled link in the portal's header. */
+export class Link {
+    label;
+    url;
+    external;
+    constructor(label, url, external) {
+        this.label = label;
+        this.url = url;
+        this.external = external;
+    }
+    static parse(value, path) {
+        if (!isJsonObject(value)) {
+            return err([`'${path}' must be a JSON object with 'label' and 'url'.`]);
+        }
+        return allOf(unknownKeys(value, KNOWN, path), Result.combineWithAllErrors([
+            nonEmptyString(value.label, `${path}.label`),
+            Link.validUrl(value.url, `${path}.url`)
+        ])).map(([label, url]) => new Link(label, url.url, url.external));
+    }
+    text() {
+        return this.label;
+    }
+    href() {
+        return this.url;
+    }
+    isExternal() {
+        return this.external;
+    }
+    toJSON() {
+        return { label: this.label, url: this.url };
+    }
+    // A page of the portal by its path, or another site by its full address. Anything else
+    // renders as a link that goes nowhere useful: `docs/x` resolves against whichever page it
+    // sits on, and a `mailto:` or `javascript:` address is not somewhere a header link belongs.
+    static validUrl(url, path) {
+        const text = typeof url === 'string' ? url.trim() : '';
+        const page = text.startsWith('/') ? Link.pageOfThePortal(text) : undefined;
+        if (page !== undefined) {
+            return ok({ url: page, external: false });
+        }
+        if (isWebAddress(text)) {
+            return ok({ url: text, external: true });
+        }
+        return err([
+            `'${path}' must be a page of the portal starting with '/', or an address starting with 'https://' or 'http://'.`
+        ]);
+    }
+    static pageOfThePortal(text) {
+        // An empty segment as a browser reads it leads to another site: `//host`, `/\host`, and `/.//host` once resolved.
+        const path = text
+            .replace(/[\t\n\r]/g, '')
+            .replaceAll('\\', '/')
+            .split(/[?#]/)[0];
+        if (path.includes('//')) {
+            return undefined;
+        }
+        try {
+            const resolved = new URL(text, PORTAL_ORIGIN);
+            return resolved.origin === PORTAL_ORIGIN ? `${resolved.pathname}${resolved.search}${resolved.hash}` : undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+}
+//# sourceMappingURL=link.js.map

package/lib/types/portal/config/link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.js","sourceRoot":"","sources":["../../../../src/types/portal/config/link.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,cAAc,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAEvF,MAAM,KAAK,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAE/B,6GAA6G;AAC7G,MAAM,aAAa,GAAG,wBAAwB,CAAC;AAE/C,8CAA8C;AAC9C,MAAM,OAAO,IAAI;IAEI,KAAK;IACL,GAAG;IACH,QAAQ;IAH3B,YACmB,KAAa,EACb,GAAW,EACX,QAAiB;qBAFjB,KAAK;mBACL,GAAG;wBACH,QAAQ;IACxB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,iDAAiD,CAAC,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,KAAK,CACV,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAC/B,MAAM,CAAC,oBAAoB,CAAC;YAC1B,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC;SACxC,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;IAC9C,CAAC;IAED,uFAAuF;IACvF,0FAA0F;IAC1F,4FAA4F;IACpF,MAAM,CAAC,QAAQ,CAAC,GAAY,EAAE,IAAY;QAChD,MAAM,IAAI,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,GAAG,CAAC;YACT,IAAI,IAAI,wGAAwG;SACjH,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,IAAY;QACzC,kHAAkH;QAClH,MAAM,IAAI,GAAG,IAAI;aACd,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;aACxB,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;aACrB,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YAC9C,OAAO,QAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;CACF"}

package/lib/types/portal/config/navigation-config.d.ts

@@ -0,0 +1,13 @@
+import { Parsed } from './fields.js';
+import { Link } from './link.js';
+export declare class NavigationConfig {
+    private readonly links;
+    private constructor();
+    static readonly defaults: NavigationConfig;
+    static parse(value: unknown, path: string): Parsed<NavigationConfig>;
+    headerLinks(): Link[];
+    toJSON(): {
+        links: ReturnType<Link['toJSON']>[];
+    };
+    private static parseLinks;
+}

package/lib/types/portal/config/navigation-config.js

@@ -0,0 +1,30 @@
+import { err, ok, Result } from 'neverthrow';
+import { allOf, namespace, unknownKeys } from './fields.js';
+import { Link } from './link.js';
+const KNOWN = ['links'];
+export class NavigationConfig {
+    links;
+    constructor(links) {
+        this.links = links;
+    }
+    static defaults = new NavigationConfig([]);
+    static parse(value, path) {
+        return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([NavigationConfig.parseLinks(data.links, `${path}.links`)])).map(([links]) => new NavigationConfig(links)));
+    }
+    headerLinks() {
+        return [...this.links];
+    }
+    toJSON() {
+        return { links: this.links.map((link) => link.toJSON()) };
+    }
+    static parseLinks(value, path) {
+        if (value === undefined) {
+            return ok([]);
+        }
+        if (!Array.isArray(value)) {
+            return err([`'${path}' must be a list of links.`]);
+        }
+        return Result.combineWithAllErrors(value.map((link, index) => Link.parse(link, `${path}[${index}]`))).mapErr((errors) => errors.flat());
+    }
+}
+//# sourceMappingURL=navigation-config.js.map

package/lib/types/portal/config/navigation-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/navigation-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC;AAExB,MAAM,OAAO,gBAAgB;IACU,KAAK;IAA1C,YAAqC,KAAa;qBAAb,KAAK;IAAW,CAAC;IAE/C,MAAM,CAAU,QAAQ,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAEpD,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,OAAO,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CACH,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,EAC9B,MAAM,CAAC,oBAAoB,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,CACxF,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAChD,CAAC;IACJ,CAAC;IAEM,WAAW;QAChB,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,MAAM;QACX,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;IAC5D,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,KAAc,EAAE,IAAY;QACpD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,4BAA4B,CAAC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,MAAM,CAAC,oBAAoB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAC1G,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAC1B,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/config/site-config.d.ts

@@ -0,0 +1,32 @@
+import { UrlPath } from '../../file/urlPath.js';
+import { Parsed } from './fields.js';
+/** What a specification says about itself, which is what a portal is called until the block says otherwise. */
+export interface SuggestedSite {
+    name: string;
+    description: string | null;
+}
+export declare const PLACEHOLDER_SITE: Readonly<SuggestedSite>;
+export declare class SiteConfig {
+    private readonly name;
+    private readonly url;
+    private readonly description;
+    private constructor();
+    /**
+     * `suggested` fills what the block leaves out. It is the only specification's own, or null
+     * when there are several, since no one of them speaks for the portal.
+     */
+    static parse(value: unknown, path: string, suggested: SuggestedSite | null): Parsed<SiteConfig>;
+    static suggested(site: SuggestedSite): SiteConfig;
+    siteName(): string;
+    siteDescription(): string | null;
+    origin(): UrlPath | null;
+    toJSON(): {
+        name: string;
+        url?: string;
+        description?: string;
+    };
+    private static validName;
+    private static validDescription;
+    private static validUrl;
+    private static parseOrigin;
+}