@apimatic/cli 1.5.0 → 2.0.0-beta.2

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

@@ -0,0 +1,105 @@
+import { err, ok, Result } from 'neverthrow';
+import { isJsonObject } from '../../utils/json-utils.js';
+import { UrlPath } from '../file/urlPath.js';
+import { AiConfig } from './config/ai-config.js';
+import { BrandConfig } from './config/brand-config.js';
+import { allOf, optional, unknownKeys } from './config/fields.js';
+import { NavigationConfig } from './config/navigation-config.js';
+import { SiteConfig } from './config/site-config.js';
+const BLOCK = 'portal';
+const NAMESPACES = ['site', 'brand', 'navigation', 'ai'];
+/** The one setting outside the namespaces, named as the portal artifacts endpoint reads it. */
+const PLUGIN_URL = 'pluginUrl';
+export class PortalConfig {
+    site;
+    brand;
+    navigation;
+    ai;
+    pluginAddress;
+    constructor(site, brand, navigation, ai, pluginAddress) {
+        this.site = site;
+        this.brand = brand;
+        this.navigation = navigation;
+        this.ai = ai;
+        this.pluginAddress = pluginAddress;
+    }
+    /** The block quickstart writes: the specification's own name and description, and every default spelled out. */
+    static scaffolded(site) {
+        return new PortalConfig(SiteConfig.suggested(site), BrandConfig.defaults, NavigationConfig.defaults, AiConfig.defaults, null);
+    }
+    /**
+     * `block` is whatever the file holds under `portal`. `suggested` is what the only specification
+     * says about itself, or null when there are several; it fills the site's name and description
+     * when the block leaves them out.
+     */
+    static fromBlock(block, suggested) {
+        if (block === undefined) {
+            return err([`'${BLOCK}' is required.`]);
+        }
+        if (!isJsonObject(block)) {
+            return err([`'${BLOCK}' must be a JSON object.`]);
+        }
+        // Each parser hands back the value it accepted, so the constructor is fed only what
+        // validation proved.
+        return allOf(unknownKeys(block, [...NAMESPACES, PLUGIN_URL], BLOCK), Result.combineWithAllErrors([
+            SiteConfig.parse(block.site, `${BLOCK}.site`, suggested),
+            BrandConfig.parse(block.brand, `${BLOCK}.brand`),
+            NavigationConfig.parse(block.navigation, `${BLOCK}.navigation`),
+            AiConfig.parse(block.ai, `${BLOCK}.ai`),
+            optional(block.pluginUrl, (value) => secureAddress(value, `${BLOCK}.${PLUGIN_URL}`))
+        ])).map((settings) => new PortalConfig(...settings));
+    }
+    siteTitle() {
+        return this.site.siteName();
+    }
+    /** Where the context plugin is hosted when it is not bundled into the portal, or null when it is. */
+    pluginUrl() {
+        return this.pluginAddress;
+    }
+    brandSettings() {
+        return this.brand;
+    }
+    staticFiles() {
+        return this.brand.files();
+    }
+    identity() {
+        const origin = this.site.origin();
+        const logo = this.brand.logoImages();
+        const favicon = this.brand.faviconImage();
+        return {
+            name: this.site.siteName(),
+            description: this.site.siteDescription(),
+            siteUrl: origin === null ? null : origin.toString(),
+            logo: logo === null ? null : { light: logo.light().siteUrl(), dark: logo.dark().siteUrl() },
+            favicon: favicon === null ? null : { url: favicon.siteUrl(), type: favicon.imageType() },
+            colorMode: this.brand.mode(),
+            links: this.navigation.headerLinks().map(portalLink),
+            pageActions: this.ai.offersPageActions()
+        };
+    }
+    /** Every namespace included, defaults and all, which is what quickstart writes. */
+    toJSON() {
+        return {
+            site: this.site.toJSON(),
+            brand: this.brand.toJSON(),
+            navigation: this.navigation.toJSON(),
+            ai: this.ai.toJSON(),
+            ...(this.pluginAddress === null ? {} : { pluginUrl: this.pluginAddress.toString() })
+        };
+    }
+}
+function portalLink(link) {
+    return { label: link.text(), url: link.href(), external: link.isExternal() };
+}
+const HTTPS_ADDRESS = /^https:\/\/\S+$/i;
+const PLUGIN_URL_EXAMPLE = 'https://example.com/acme-plugin.zip';
+// Parsed, so the quoted install command it goes into can hold no space or quote; https, as npx runs what it fetches.
+function secureAddress(value, path) {
+    const url = typeof value === 'string' && HTTPS_ADDRESS.test(value) ? UrlPath.create(value) : undefined;
+    return url === undefined
+        ? err([
+            `'${path}' must be an address starting with 'https://', with no spaces, for example '${PLUGIN_URL_EXAMPLE}'.`
+        ])
+        : ok(new UrlPath(new URL(`${url}`).href));
+}
+//# sourceMappingURL=portal-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portal-config.js","sourceRoot":"","sources":["../../../src/types/portal/portal-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAa,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAU,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,UAAU,EAAiB,MAAM,yBAAyB,CAAC;AA8BpE,MAAM,KAAK,GAAG,QAAQ,CAAC;AAEvB,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;AAEzD,+FAA+F;AAC/F,MAAM,UAAU,GAAG,WAAW,CAAC;AAE/B,MAAM,OAAO,YAAY;IAEJ,IAAI;IACJ,KAAK;IACL,UAAU;IACV,EAAE;IACF,aAAa;IALhC,YACmB,IAAgB,EAChB,KAAkB,EAClB,UAA4B,EAC5B,EAAY,EACZ,aAA6B;oBAJ7B,IAAI;qBACJ,KAAK;0BACL,UAAU;kBACV,EAAE;6BACF,aAAa;IAC7B,CAAC;IAEJ,gHAAgH;IACzG,MAAM,CAAC,UAAU,CAAC,IAAmB;QAC1C,OAAO,IAAI,YAAY,CACrB,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,EAC1B,WAAW,CAAC,QAAQ,EACpB,gBAAgB,CAAC,QAAQ,EACzB,QAAQ,CAAC,QAAQ,EACjB,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,KAAc,EAAE,SAA+B;QACrE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC,CAAC,IAAI,KAAK,0BAA0B,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,oFAAoF;QACpF,qBAAqB;QACrB,OAAO,KAAK,CACV,WAAW,CAAC,KAAK,EAAE,CAAC,GAAG,UAAU,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,EACtD,MAAM,CAAC,oBAAoB,CAAC;YAC1B,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,EAAE,SAAS,CAAC;YACxD,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,KAAK,QAAQ,CAAC;YAChD,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,KAAK,aAAa,CAAC;YAC/D,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,KAAK,KAAK,CAAC;YACvC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,UAAU,EAAE,CAAC,CAAC;SACrF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IACrD,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,qGAAqG;IAC9F,SAAS;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAEM,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QAC1C,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC1B,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YACxC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;YACnD,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE;YAC3F,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,EAAE;YACxF,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YAC5B,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC;YACpD,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,iBAAiB,EAAE;SACzC,CAAC;IACJ,CAAC;IAED,mFAAmF;IAC5E,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YAC1B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE;YACpB,GAAG,CAAC,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrF,CAAC;IACJ,CAAC;CACF;AAED,SAAS,UAAU,CAAC,IAAU;IAC5B,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;AAC/E,CAAC;AAED,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,MAAM,kBAAkB,GAAG,qCAAqC,CAAC;AAEjE,qHAAqH;AACrH,SAAS,aAAa,CAAC,KAAc,EAAE,IAAY;IACjD,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvG,OAAO,GAAG,KAAK,SAAS;QACtB,CAAC,CAAC,GAAG,CAAC;YACF,IAAI,IAAI,+EAA+E,kBAAkB,IAAI;SAC9G,CAAC;QACJ,CAAC,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9C,CAAC"}

package/lib/types/portal/portal-downloads.d.ts

@@ -0,0 +1,8 @@
+import { FileName } from '../file/fileName.js';
+export declare const DOWNLOADS_ADDRESS = "__downloads";
+export declare const SDK_DOWNLOADS_FOLDER = "sdk";
+export declare const PLUGIN_DOWNLOAD: FileName;
+/** Keyed by the delivered name rather than `Language`, as the artifacts are. */
+export declare function sdkDownload(language: string): FileName;
+export declare function sdkDownloadAddress(language: string): string;
+export declare const PLUGIN_DOWNLOAD_ADDRESS: string;

package/lib/types/portal/portal-downloads.js

@@ -0,0 +1,14 @@
+import { FileName } from '../file/fileName.js';
+// One place for the names both the pages' links and the laid-out downloads use, so the two agree.
+export const DOWNLOADS_ADDRESS = '__downloads';
+export const SDK_DOWNLOADS_FOLDER = 'sdk';
+export const PLUGIN_DOWNLOAD = new FileName('plugin.zip');
+/** Keyed by the delivered name rather than `Language`, as the artifacts are. */
+export function sdkDownload(language) {
+    return new FileName(`${language}.zip`);
+}
+export function sdkDownloadAddress(language) {
+    return `/${DOWNLOADS_ADDRESS}/${SDK_DOWNLOADS_FOLDER}/${sdkDownload(language)}`;
+}
+export const PLUGIN_DOWNLOAD_ADDRESS = `/${DOWNLOADS_ADDRESS}/${PLUGIN_DOWNLOAD}`;
+//# sourceMappingURL=portal-downloads.js.map

package/lib/types/portal/portal-downloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal-downloads.js","sourceRoot":"","sources":["../../../src/types/portal/portal-downloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,kGAAkG;AAClG,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAE/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC;AAE1C,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC;AAE1D,gFAAgF;AAChF,MAAM,UAAU,WAAW,CAAC,QAAgB;IAC1C,OAAO,IAAI,QAAQ,CAAC,GAAG,QAAQ,MAAM,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,QAAgB;IACjD,OAAO,IAAI,iBAAiB,IAAI,oBAAoB,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;AAClF,CAAC;AAED,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,iBAAiB,IAAI,eAAe,EAAE,CAAC"}

package/lib/types/portal/portal-languages.d.ts

@@ -0,0 +1,15 @@
+import { Result } from 'neverthrow';
+import { ConfigFinding } from '../apimatic-config/document.js';
+import { PortalSdk } from './portal-sdk.js';
+/**
+ * Read from the top-level `languages` block the plugin commands share. An entry without a
+ * `publishing` record counts: it is a language the project wants and has not published yet.
+ */
+export declare class PortalLanguages {
+    private readonly sdks;
+    private constructor();
+    /** `findings` already covers a block or an entry of the wrong shape, so neither is checked here. */
+    static fromBlock(block: Record<string, unknown> | undefined, findings: readonly ConfigFinding[]): Result<PortalLanguages, string[]>;
+    /** In the order the block lists them. */
+    listed(): PortalSdk[];
+}

package/lib/types/portal/portal-languages.js

@@ -0,0 +1,45 @@
+import { err, ok } from 'neverthrow';
+import { findingSentences } from '../apimatic-config/document.js';
+import { LANGUAGES_EXAMPLE } from '../apimatic-config/languages-block.js';
+import { Language, PORTAL_LANGUAGES } from '../sdk/generate.js';
+import { quotedList } from './config/fields.js';
+import { PortalSdk } from './portal-sdk.js';
+const KNOWN_LANGUAGES = Object.values(Language);
+const SUPPORTED_LANGUAGES = PORTAL_LANGUAGES;
+// Written out in full so the one-line fix is in the message: nothing in the portal's own
+// commands writes this block yet.
+const REQUIRED = `'languages' must name at least one SDK language, for example ${LANGUAGES_EXAMPLE}. ` +
+    `It is the project's one list of SDK languages, which the plugin commands read too, and ` +
+    `'apimatic sdk publish' adds to it.`;
+/**
+ * Read from the top-level `languages` block the plugin commands share. An entry without a
+ * `publishing` record counts: it is a language the project wants and has not published yet.
+ */
+export class PortalLanguages {
+    sdks;
+    constructor(sdks) {
+        this.sdks = sdks;
+    }
+    /** `findings` already covers a block or an entry of the wrong shape, so neither is checked here. */
+    static fromBlock(block, findings) {
+        const errors = findingSentences(findings);
+        const entries = Object.entries(block ?? {});
+        if (entries.length === 0 && findings.length === 0) {
+            errors.push(REQUIRED);
+        }
+        for (const [key] of entries.filter(([key]) => !SUPPORTED_LANGUAGES.includes(key))) {
+            errors.push(KNOWN_LANGUAGES.includes(key)
+                ? `'languages.${key}' is not available yet; the portal supports ${quotedList(SUPPORTED_LANGUAGES)} today.`
+                : `'languages.${key}' is not an SDK language; name one of ${quotedList(SUPPORTED_LANGUAGES, 'or')}.`);
+        }
+        if (errors.length > 0) {
+            return err(errors);
+        }
+        return ok(new PortalLanguages(entries.map(([key, entry]) => PortalSdk.fromEntry(key, entry))));
+    }
+    /** In the order the block lists them. */
+    listed() {
+        return [...this.sdks];
+    }
+}
+//# sourceMappingURL=portal-languages.js.map

package/lib/types/portal/portal-languages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal-languages.js","sourceRoot":"","sources":["../../../src/types/portal/portal-languages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAiB,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,eAAe,GAAsB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAEnE,MAAM,mBAAmB,GAAsB,gBAAgB,CAAC;AAEhE,yFAAyF;AACzF,kCAAkC;AAClC,MAAM,QAAQ,GACZ,gEAAgE,iBAAiB,IAAI;IACrF,yFAAyF;IACzF,oCAAoC,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,eAAe;IACW,IAAI;IAAzC,YAAqC,IAA0B;oBAA1B,IAAI;IAAyB,CAAC;IAEnE,oGAAoG;IAC7F,MAAM,CAAC,SAAS,CACrB,KAA0C,EAC1C,QAAkC;QAElC,MAAM,MAAM,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAC5C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAClF,MAAM,CAAC,IAAI,CACT,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAC3B,CAAC,CAAC,cAAc,GAAG,+CAA+C,UAAU,CAAC,mBAAmB,CAAC,SAAS;gBAC1G,CAAC,CAAC,cAAc,GAAG,yCAAyC,UAAU,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG,CACvG,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,GAAe,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED,yCAAyC;IAClC,MAAM;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;CACF"}

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

@@ -0,0 +1,65 @@
+import { Result } from 'neverthrow';
+/** The directory the reference is mounted at, which `content/api/` shares, and so the name someone guesses for it. */
+export declare const API_REFERENCE_NAME = "api";
+/** The page a folder below the content root links to, which is never one of its children. */
+export declare const INDEX_NAME = "index";
+/** A `(group)` folder, which a page's address leaves out and a folder's name leaves unbracketed. */
+export declare const GROUP_FOLDER: RegExp;
+export declare const NAVIGATION_FILE_NAME = "nav.json";
+/** Where a `nav.json` sits, and what its entries are allowed to address. */
+export interface NavigationContext {
+    /** The file's path relative to `src/`, as messages name it. */
+    label: string;
+    /** Every `apimatic:` token resolves to a node that lives at the content root. */
+    isContentRoot: boolean;
+    /** `content/api/`, where the reference is mounted, which is always a tab. */
+    isApiDirectory: boolean;
+    /**
+     * Whether this directory becomes a folder in the sidebar at all. A directory with no page
+     * anywhere beneath it does not, and the template drops the node Fumadocs builds for its
+     * `nav.json`, so a title here would name nothing.
+     */
+    becomesFolder: boolean;
+    /** Pages and subfolders in the same directory; page names carry no extension. */
+    childNames: string[];
+    /** Subdirectories with no page in them or below them, which are no folder in the sidebar. */
+    emptyFolders: string[];
+    /** Subfolders that serve the home page, as a `(group)` folder's index page can at the content root. */
+    homePageFolders: string[];
+}
+/** What a valid `nav.json` says about its directory. */
+export interface NavigationSettings {
+    /** The name it gives its folder, or at the content root the Home tab. */
+    title: string | undefined;
+    /** Its entries, trimmed; at the content root, each folder they name is a tab. */
+    pages: string[];
+}
+/**
+ * The rules of a `nav.json`, applied to one file. The template re-reads the file itself and
+ * orders the page tree from it, so nothing here travels into the build: this exists to
+ * refuse a file that would otherwise produce a quietly wrong sidebar. Fumadocs drops an
+ * entry it cannot resolve without a word, which is why the CLI validates instead.
+ */
+export declare class PortalNavigation {
+    static validate(json: string, context: NavigationContext): Result<NavigationSettings, string[]>;
+    private static entryErrors;
+    private static checkEntry;
+    private static checkToken;
+    private static parseObject;
+    /** Whether a page and a folder in this directory both answer to the name. */
+    private static isSharedName;
+    /**
+     * A folder is named after its directory, or after the title of its index page; `title`
+     * outranks both. At the content root it names the Home tab, which holds the pages there and
+     * the folders the file does not list.
+     */
+    private static titleErrors;
+    private static describeUnknownField;
+    /** A near miss is nearly always a typo or a forgotten extension, so name the candidate. */
+    private static suggestion;
+    /**
+     * The section an entry was most likely meant to position: one named after its address, or
+     * after the word its token ends in, which for the context plugin is not the same word.
+     */
+    private static sectionGuessed;
+}

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

@@ -0,0 +1,217 @@
+import { err, ok } from 'neverthrow';
+import { isJsonObject } from '../../utils/json-utils.js';
+import { quotedList } from './config/fields.js';
+import { GENERATED_SECTIONS } from './generated-pages.js';
+import { unknownFieldErrors } from './unknown-fields.js';
+const BYTE_ORDER_MARK = 0xfeff;
+/** Everything in this directory that no other entry names. */
+const REST_TOKEN = '...';
+/** The API reference, positioned as one node. */
+const API_REFERENCE_TOKEN = 'apimatic:api';
+const APIMATIC_PREFIX = 'apimatic:';
+/** Each generated section's tab, and the API reference. */
+const TOKENS = [...GENERATED_SECTIONS.map((section) => section.token), API_REFERENCE_TOKEN];
+/** The directory the reference is mounted at, which `content/api/` shares, and so the name someone guesses for it. */
+export const API_REFERENCE_NAME = 'api';
+/** The page a folder below the content root links to, which is never one of its children. */
+export const INDEX_NAME = 'index';
+/** A `(group)` folder, which a page's address leaves out and a folder's name leaves unbracketed. */
+export const GROUP_FOLDER = /^\((.+)\)$/;
+export const NAVIGATION_FILE_NAME = 'nav.json';
+// A misspelled field would otherwise be stripped by Fumadocs' own schema and leave the
+// sidebar in its default order with nothing said, so every unknown field is reported. The
+// file has so few settings that a misspelling is answered by listing them all rather than
+// guessing at the one it meant.
+const KNOWN_FIELDS = new Set(['pages', 'title']);
+/**
+ * The rules of a `nav.json`, applied to one file. The template re-reads the file itself and
+ * orders the page tree from it, so nothing here travels into the build: this exists to
+ * refuse a file that would otherwise produce a quietly wrong sidebar. Fumadocs drops an
+ * entry it cannot resolve without a word, which is why the CLI validates instead.
+ */
+export class PortalNavigation {
+    static validate(json, context) {
+        const document = PortalNavigation.parseObject(json, context);
+        if (document.isErr()) {
+            return err(document.error);
+        }
+        const unknownFields = unknownFieldErrors(document.value, KNOWN_FIELDS, (field) => PortalNavigation.describeUnknownField(field, context));
+        const settingErrors = [...unknownFields, ...PortalNavigation.titleErrors(document.value.title, context)];
+        const title = typeof document.value.title === 'string' ? document.value.title.trim() : undefined;
+        const pages = document.value.pages;
+        if (pages === undefined) {
+            // A file with no `pages` orders nothing, which is odd but not wrong. It may still name
+            // the folder, which is why the title is checked above rather than alongside the entries.
+            return settingErrors.length > 0 ? err(settingErrors) : ok({ title, pages: [] });
+        }
+        if (!Array.isArray(pages) || pages.some((entry) => typeof entry !== 'string')) {
+            return err([...settingErrors, `${context.label}: 'pages' must be an array of strings.`]);
+        }
+        const entries = pages.map((entry) => entry.trim());
+        // Every bad entry is reported at once rather than stopping at the first, so one edit
+        // fixes the file.
+        const errors = [...settingErrors, ...PortalNavigation.entryErrors(entries, context)];
+        return errors.length > 0 ? err(errors) : ok({ title, pages: entries });
+    }
+    static entryErrors(entries, context) {
+        const errors = [];
+        // Keyed by the node an entry positions rather than its text: `content/api` is where the
+        // reference is mounted, so at the content root the name and the token reach one node --
+        // a directory the user keeps there merges into it rather than making a second. Naming it
+        // twice would have the template honour whichever came first without a word.
+        const seen = new Map();
+        for (const entry of entries) {
+            const node = context.isContentRoot && entry === API_REFERENCE_NAME ? API_REFERENCE_TOKEN : entry;
+            const earlier = seen.get(node);
+            if (earlier !== undefined) {
+                errors.push(earlier === entry
+                    ? `${context.label}: '${entry}' is listed more than once.`
+                    : `${context.label}: '${earlier}' and '${entry}' both position the API reference; keep one of them.`);
+                continue;
+            }
+            seen.set(node, entry);
+            const checked = PortalNavigation.checkEntry(entry, context);
+            if (checked.isErr()) {
+                errors.push(checked.error);
+            }
+        }
+        return errors;
+    }
+    static checkEntry(entry, context) {
+        if (entry === REST_TOKEN) {
+            return ok(undefined);
+        }
+        if (entry.startsWith(APIMATIC_PREFIX)) {
+            return PortalNavigation.checkToken(entry, context);
+        }
+        if (entry.length === 0) {
+            return err(`${context.label}: 'pages' must not contain an empty entry.`);
+        }
+        // Naming a nested path would claim the node out of its folder and leave the folder
+        // behind as an empty one, so only direct children are addressable.
+        if (entry.includes('/') || entry.includes('\\')) {
+            return err(`${context.label}: '${entry}' addresses another directory. An entry names a page or ` +
+                `folder in this directory; order a subfolder's pages with its own ${NAVIGATION_FILE_NAME}.`);
+        }
+        // A page of the same name is what the entry names, since the template drops the empty folder.
+        if (!context.childNames.includes(entry) && context.emptyFolders.includes(entry)) {
+            return err(`${context.label}: '${entry}' is a folder with no page in it or below it, so it is not in the ` +
+                `sidebar. Add a page to it, or remove the entry.`);
+        }
+        if (!context.childNames.includes(entry)) {
+            return err(`${context.label}: '${entry}' is not a page or folder in this directory.${PortalNavigation.suggestion(entry, context)}`);
+        }
+        // A page and a folder of one name are both children, and an entry positions the folder,
+        // as it does in Fumadocs' own metadata. The page could then never be positioned, which
+        // is the quietly wrong sidebar this file exists to refuse.
+        if (PortalNavigation.isSharedName(entry, context)) {
+            // At the content root the folder of that name is the API reference, mounted there
+            // whether or not a directory exists to see. "Both a page and a folder" would send the
+            // user looking for one.
+            return err(context.isContentRoot && entry === API_REFERENCE_NAME
+                ? `${context.label}: '${entry}' is where the API reference is mounted, so the entry positions ` +
+                    `the reference rather than the page of that name. Rename the page to position it.`
+                : `${context.label}: '${entry}' is both a page and a folder in this directory, and the entry ` +
+                    `positions the folder. Rename the page to position it.`);
+        }
+        // Below the content root the index page is the folder's own, not one of the pages it orders.
+        if (entry === INDEX_NAME && !context.isContentRoot) {
+            return err(`${context.label}: '${INDEX_NAME}' is the page this folder opens on, so it cannot be positioned ` +
+                `among its pages. Remove the entry; the folder itself is positioned by the ${NAVIGATION_FILE_NAME} ` +
+                `one level up.`);
+        }
+        // Each folder the content root lists is a tab, and the home page is the Home tab's.
+        if (context.homePageFolders.includes(entry)) {
+            return err(`${context.label}: '${entry}' serves the home page, which belongs to the Home tab, so it cannot ` +
+                `be a tab of its own. Remove the entry, or move the page out of the folder.`);
+        }
+        return ok(undefined);
+    }
+    static checkToken(entry, context) {
+        if (!TOKENS.includes(entry)) {
+            return err(`${context.label}: '${entry}' is not a ${NAVIGATION_FILE_NAME} token. ` +
+                `The tokens are ${quotedList(TOKENS)}.`);
+        }
+        if (!context.isContentRoot) {
+            return err(`${context.label}: '${entry}' can only be used in the ${NAVIGATION_FILE_NAME} at the top ` +
+                `of the content directory, because that is where the node it positions lives.`);
+        }
+        return ok(undefined);
+    }
+    static parseObject(json, context) {
+        // Unlike `apimatic.json`, this file is not read by the CLI alone: the build reads it again
+        // from the content directory with a bare `JSON.parse`, which a byte-order mark breaks.
+        // Accepting the mark here would pass a file the build then refuses with an opaque error.
+        if (json.codePointAt(0) === BYTE_ORDER_MARK) {
+            return err([
+                `${context.label} starts with a byte-order mark, which the build cannot read. ` +
+                    `Save the file as UTF-8 without a BOM.`
+            ]);
+        }
+        let data;
+        try {
+            data = JSON.parse(json);
+        }
+        catch {
+            return err([`${context.label} is not valid JSON.`]);
+        }
+        if (!isJsonObject(data)) {
+            return err([`${context.label} must contain a JSON object.`]);
+        }
+        return ok(data);
+    }
+    /** Whether a page and a folder in this directory both answer to the name. */
+    static isSharedName(entry, context) {
+        return context.childNames.filter((name) => name === entry).length > 1;
+    }
+    /**
+     * A folder is named after its directory, or after the title of its index page; `title`
+     * outranks both. At the content root it names the Home tab, which holds the pages there and
+     * the folders the file does not list.
+     */
+    static titleErrors(title, context) {
+        if (title === undefined) {
+            return [];
+        }
+        // At the root it names the Home tab, which exists without a page; a folder without one does not.
+        if (!context.isContentRoot && !context.becomesFolder) {
+            return [
+                `${context.label}: 'title' names this folder, but a directory with no page in it or ` +
+                    `below it is no folder in the sidebar. Add a page, or remove the setting.`
+            ];
+        }
+        if (typeof title !== 'string' || title.trim().length === 0) {
+            return [`${context.label}: 'title' must be a non-empty string.`];
+        }
+        return [];
+    }
+    static describeUnknownField(field, context) {
+        // Listed from the same set the check uses, so a setting added later is named here too.
+        const settings = quotedList([...KNOWN_FIELDS]);
+        return `${context.label}: '${field}' is not a ${NAVIGATION_FILE_NAME} setting. The settings are ${settings}.`;
+    }
+    /** A near miss is nearly always a typo or a forgotten extension, so name the candidate. */
+    static suggestion(entry, context) {
+        const lowered = entry.toLowerCase();
+        const withoutExtension = lowered.replace(/\.mdx?$/i, '');
+        // Matched without the extension too, so `api.md` is answered like `api` rather than
+        // pointed at a name that is refused the moment they write it.
+        if (withoutExtension === API_REFERENCE_NAME && context.isContentRoot) {
+            return ` The API reference is positioned with '${API_REFERENCE_TOKEN}'.`;
+        }
+        const section = context.isContentRoot ? PortalNavigation.sectionGuessed(withoutExtension) : undefined;
+        if (section !== undefined) {
+            return ` '${section.token}' positions ${section.description}.`;
+        }
+        const candidate = context.childNames.find((name) => name.toLowerCase() === lowered || name.toLowerCase() === withoutExtension);
+        return candidate === undefined ? '' : ` Did you mean '${candidate}'?`;
+    }
+    /**
+     * The section an entry was most likely meant to position: one named after its address, or
+     * after the word its token ends in, which for the context plugin is not the same word.
+     */
+    static sectionGuessed(name) {
+        return GENERATED_SECTIONS.find((section) => name === section.folder || name === section.token.slice(APIMATIC_PREFIX.length));
+    }
+}
+//# sourceMappingURL=portal-navigation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"portal-navigation.js","sourceRoot":"","sources":["../../../src/types/portal/portal-navigation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAoB,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B,8DAA8D;AAC9D,MAAM,UAAU,GAAG,KAAK,CAAC;AACzB,iDAAiD;AACjD,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAE3C,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,2DAA2D;AAC3D,MAAM,MAAM,GAAG,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,mBAAmB,CAAC,CAAC;AAE5F,sHAAsH;AACtH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAExC,6FAA6F;AAC7F,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC;AAElC,oGAAoG;AACpG,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CAAC;AAEzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC;AAE/C,uFAAuF;AACvF,0FAA0F;AAC1F,0FAA0F;AAC1F,gCAAgC;AAChC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAgCjD;;;;;GAKG;AACH,MAAM,OAAO,gBAAgB;IACpB,MAAM,CAAC,QAAQ,CAAC,IAAY,EAAE,OAA0B;QAC7D,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;YACrB,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;QAED,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAC/E,gBAAgB,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CACtD,CAAC;QAEF,MAAM,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QACzG,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEjG,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;QACnC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,uFAAuF;YACvF,yFAAyF;YACzF,OAAO,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YAC9E,OAAO,GAAG,CAAC,CAAC,GAAG,aAAa,EAAE,GAAG,OAAO,CAAC,KAAK,wCAAwC,CAAC,CAAC,CAAC;QAC3F,CAAC;QACD,MAAM,OAAO,GAAI,KAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAEjE,qFAAqF;QACrF,kBAAkB;QAClB,MAAM,MAAM,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACrF,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,OAAiB,EAAE,OAA0B;QACtE,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,wFAAwF;QACxF,wFAAwF;QACxF,yFAAyF;QACzF,4EAA4E;QAC5E,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;QAEvC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,KAAK,kBAAkB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC;YACjG,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CACT,OAAO,KAAK,KAAK;oBACf,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,6BAA6B;oBAC1D,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,MAAM,OAAO,UAAU,KAAK,sDAAsD,CACvG,CAAC;gBACF,SAAS;YACX,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAEtB,MAAM,OAAO,GAAG,gBAAgB,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC5D,IAAI,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;gBACpB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,KAAa,EAAE,OAA0B;QACjE,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QAED,IAAI,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACtC,OAAO,gBAAgB,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,4CAA4C,CAAC,CAAC;QAC3E,CAAC;QAED,mFAAmF;QACnF,mEAAmE;QACnE,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,0DAA0D;gBACnF,oEAAoE,oBAAoB,GAAG,CAC9F,CAAC;QACJ,CAAC;QAED,8FAA8F;QAC9F,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAChF,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,oEAAoE;gBAC7F,iDAAiD,CACpD,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACxC,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,+CAA+C,gBAAgB,CAAC,UAAU,CACnG,KAAK,EACL,OAAO,CACR,EAAE,CACJ,CAAC;QACJ,CAAC;QAED,wFAAwF;QACxF,uFAAuF;QACvF,2DAA2D;QAC3D,IAAI,gBAAgB,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;YAClD,kFAAkF;YAClF,sFAAsF;YACtF,wBAAwB;YACxB,OAAO,GAAG,CACR,OAAO,CAAC,aAAa,IAAI,KAAK,KAAK,kBAAkB;gBACnD,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,kEAAkE;oBAC3F,kFAAkF;gBACtF,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,iEAAiE;oBAC1F,uDAAuD,CAC9D,CAAC;QACJ,CAAC;QAED,6FAA6F;QAC7F,IAAI,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YACnD,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,UAAU,iEAAiE;gBAC/F,6EAA6E,oBAAoB,GAAG;gBACpG,eAAe,CAClB,CAAC;QACJ,CAAC;QAED,oFAAoF;QACpF,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,sEAAsE;gBAC/F,4EAA4E,CAC/E,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC;IAEO,MAAM,CAAC,UAAU,CAAC,KAAa,EAAE,OAA0B;QACjE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,cAAc,oBAAoB,UAAU;gBACrE,kBAAkB,UAAU,CAAC,MAAM,CAAC,GAAG,CAC1C,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC3B,OAAO,GAAG,CACR,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,6BAA6B,oBAAoB,cAAc;gBACxF,8EAA8E,CACjF,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,OAA0B;QACjE,2FAA2F;QAC3F,uFAAuF;QACvF,yFAAyF;QACzF,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,eAAe,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;gBACT,GAAG,OAAO,CAAC,KAAK,+DAA+D;oBAC7E,uCAAuC;aAC1C,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,qBAAqB,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,8BAA8B,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,6EAA6E;IACrE,MAAM,CAAC,YAAY,CAAC,KAAa,EAAE,OAA0B;QACnE,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,WAAW,CAAC,KAAc,EAAE,OAA0B;QACnE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,iGAAiG;QACjG,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YACrD,OAAO;gBACL,GAAG,OAAO,CAAC,KAAK,qEAAqE;oBACnF,0EAA0E;aAC7E,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,uCAAuC,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,KAAa,EAAE,OAA0B;QAC3E,uFAAuF;QACvF,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;QAC/C,OAAO,GAAG,OAAO,CAAC,KAAK,MAAM,KAAK,cAAc,oBAAoB,8BAA8B,QAAQ,GAAG,CAAC;IAChH,CAAC;IAED,2FAA2F;IACnF,MAAM,CAAC,UAAU,CAAC,KAAa,EAAE,OAA0B;QACjE,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACzD,oFAAoF;QACpF,8DAA8D;QAC9D,IAAI,gBAAgB,KAAK,kBAAkB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACrE,OAAO,0CAA0C,mBAAmB,IAAI,CAAC;QAC3E,CAAC;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtG,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,KAAK,OAAO,CAAC,KAAK,eAAe,OAAO,CAAC,WAAW,GAAG,CAAC;QACjE,CAAC;QACD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CACvC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,KAAK,gBAAgB,CACpF,CAAC;QACF,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,kBAAkB,SAAS,IAAI,CAAC;IACxE,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,cAAc,CAAC,IAAY;QACxC,OAAO,kBAAkB,CAAC,IAAI,CAC5B,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,IAAI,IAAI,KAAK,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAC7F,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/portal-sdk.d.ts

@@ -0,0 +1,15 @@
+import { UrlPath } from '../file/urlPath.js';
+import { Language } from '../sdk/generate.js';
+import { PublishedPackage } from './published-package.js';
+/** One SDK language of the portal, with what `apimatic sdk publish` recorded about it. */
+export declare class PortalSdk {
+    readonly language: Language;
+    private readonly repository;
+    private readonly published;
+    private constructor();
+    /** The document checked the shapes down to `publishing`; a wrongly shaped field below it reads as not recorded. */
+    static fromEntry(language: Language, entry: unknown): PortalSdk;
+    sourceRepository(): UrlPath | null;
+    /** Null until a release is recorded, or when the configuration does not name the package. */
+    publishedPackage(): PublishedPackage | null;
+}

package/lib/types/portal/portal-sdk.js

@@ -0,0 +1,28 @@
+import { recordedPublishing } from '../apimatic-config/languages-block.js';
+import { UrlPath } from '../file/urlPath.js';
+import { publishedPackage } from './published-package.js';
+/** One SDK language of the portal, with what `apimatic sdk publish` recorded about it. */
+export class PortalSdk {
+    language;
+    repository;
+    published;
+    constructor(language, repository, published) {
+        this.language = language;
+        this.repository = repository;
+        this.published = published;
+    }
+    /** The document checked the shapes down to `publishing`; a wrongly shaped field below it reads as not recorded. */
+    static fromEntry(language, entry) {
+        const { repositoryUrl, version, packageConfiguration } = recordedPublishing(entry);
+        const hasRelease = (version?.trim() ?? '').length > 0;
+        return new PortalSdk(language, repositoryUrl === null ? null : UrlPath.create(repositoryUrl) ?? null, hasRelease ? publishedPackage(language, packageConfiguration) : null);
+    }
+    sourceRepository() {
+        return this.repository;
+    }
+    /** Null until a release is recorded, or when the configuration does not name the package. */
+    publishedPackage() {
+        return this.published;
+    }
+}
+//# sourceMappingURL=portal-sdk.js.map

package/lib/types/portal/portal-sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal-sdk.js","sourceRoot":"","sources":["../../../src/types/portal/portal-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAoB,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE5E,0FAA0F;AAC1F,MAAM,OAAO,SAAS;IAEF,QAAQ;IACP,UAAU;IACV,SAAS;IAH5B,YACkB,QAAkB,EACjB,UAA0B,EAC1B,SAAkC;wBAFnC,QAAQ;0BACP,UAAU;yBACV,SAAS;IACzB,CAAC;IAEJ,mHAAmH;IAC5G,MAAM,CAAC,SAAS,CAAC,QAAkB,EAAE,KAAc;QACxD,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAEtD,OAAO,IAAI,SAAS,CAClB,QAAQ,EACR,aAAa,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,IAAI,EACrE,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CACrE,CAAC;IACJ,CAAC;IAEM,gBAAgB;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,6FAA6F;IACtF,gBAAgB;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CACF"}