@apimatic/cli 2.0.0-beta.4 → 2.0.0-beta.6

package/lib/types/plugin-config-context.js

@@ -1,9 +1,10 @@
-import { ResultAsync } from 'neverthrow';
+import { ok, ResultAsync } from 'neverthrow';
 import { FileService } from '../infrastructure/file-service.js';
 import { ApimaticConfigContext } from './apimatic-config-context.js';
 import { findingClause } from './apimatic-config/document.js';
 import { isPublished, languagesOf } from './apimatic-config/languages-block.js';
 import { DEFAULT_PLUGIN_LICENSE } from './plugin/plugin-config.js';
+import { PortalLanguages } from './portal/portal-languages.js';
 import { SOURCE_DIRECTORY_NAME } from './project-layout.js';
 import { SemVersion } from './publish/version.js';
 import { isAvailableLanguage } from './sdk/generate.js';
@@ -83,6 +84,18 @@ const recorded = (document, languages, keep) => {
 /** In the user's file a cleared language goes, unless its entry records where an SDK was published. */
 const keepsRecord = (language, entry) => !isAvailableLanguage(language) || isPublished(entry);
 const isUnavailableLanguage = (language) => !isAvailableLanguage(language);
+const namesNoLanguage = (document) => PortalLanguages.namesNone(document.languages(), document.findingsFor('languages'));
+const withMetadata = (document, metadata, author) => {
+    const plugin = (document.plugin() ?? {});
+    return document.with('plugin', {
+        ...plugin,
+        pluginId: metadata.pluginId,
+        pluginName: metadata.pluginName,
+        pluginVersion: metadata.pluginVersion,
+        ...(!plugin.author && author && { author }),
+        license: plugin.license ?? DEFAULT_PLUGIN_LICENSE
+    });
+};
 export class PluginConfigContext {
     sourceDirectory;
     configContext;
@@ -106,17 +119,25 @@ export class PluginConfigContext {
         return PluginConfig.create(PluginConfigContext.configOf(state.document));
     }
     async upsertMetadata(metadata, author) {
-        return await this.merge((document) => {
-            const plugin = (document.plugin() ?? {});
-            return document.with('plugin', {
-                ...plugin,
-                pluginId: metadata.pluginId,
-                pluginName: metadata.pluginName,
-                pluginVersion: metadata.pluginVersion,
-                ...(!plugin.author && author && { author }),
-                license: plugin.license ?? DEFAULT_PLUGIN_LICENSE
-            });
-        });
+        return await this.merge((document) => withMetadata(document, metadata, author));
+    }
+    // Merged against `plugin` alone: a file's `languages` is not what this write could spread or break.
+    async addMetadataIfMissing(metadata) {
+        const state = await this.configContext.read();
+        if (state.state === 'parsed' && state.document.has('plugin')) {
+            return ok(undefined);
+        }
+        const merged = await this.configContext.merge(['plugin'], (document) => withMetadata(document, metadata));
+        return merged.map(() => undefined);
+    }
+    async languagesMissing() {
+        const state = await this.configContext.read();
+        return state.state === 'parsed' && namesNoLanguage(state.document);
+    }
+    // Merged against `languages` alone, as `addMetadataIfMissing` is against `plugin`.
+    async addLanguagesIfMissing(languages) {
+        const merged = await this.configContext.merge(['languages'], (document) => namesNoLanguage(document) ? document.with('languages', recorded(document, languages, keepsRecord)) : document);
+        return merged.map(() => undefined);
     }
     // A published entry survives a cleared checkbox: only `sdk publish` can write that record.
     async recordLanguages(languages) {

package/lib/types/plugin-config-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-config-context.js","sourceRoot":"","sources":["../../src/types/plugin-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,WAAW,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAA8B,MAAM,8BAA8B,CAAC;AACjG,OAAO,EAA2C,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACvG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAwC,MAAM,sCAAsC,CAAC;AAGtH,OAAO,EACL,sBAAsB,EAKvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAY,MAAM,mBAAmB,CAAC;AASlE,MAAM,OAAO,YAAY;IAOJ,MAAM;IACN,OAAO;IACP,WAAW;IARd,KAAK,GAAG,SAAkB,CAAC;IAE3C,oEAAoE;IAC7D,MAAM,CAAU,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAEtE,YACmB,MAAwB,EACxB,OAAyD,EACzD,WAA8B;sBAF9B,MAAM;uBACN,OAAO;2BACP,WAAW;IAC3B,CAAC;IAEJ,2FAA2F;IACpF,MAAM,CAAC,MAAM,CAAC,MAAwB;QAC3C,MAAM,OAAO,GAA4C,EAAE,CAAC;QAC5D,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjE,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAkC,CAAC,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED,sDAAsD;IAC/C,iBAAiB;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,2FAA2F;IAC3F,2DAA2D;IACpD,WAAW;QAChB,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAC9F,OAAO,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5F,CAAC;IAED,sGAAsG;IAC/F,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC3D,CAAC;IAEM,UAAU;QACf,MAAM,QAAQ,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,QAAQ,KAAK,EAAE,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YACzC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAC3C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EACpC,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,QAAkB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC;IAChE,CAAC;CACF;AAID,MAAM,YAAY,GAA+B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,QAAQ,GAAG,CACf,QAAgC,EAChC,SAA8B,EAC9B,IAAqF,EAC5D,EAAE;IAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,SAAS,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IACpH,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAExG,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,KAAgD,EAAW,EAAE,CAClG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;AAEvD,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAW,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE5F,MAAM,OAAO,mBAAmB;IAID,eAAe;IAH3B,aAAa,CAAwB;IACrC,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IAEjD,YAA6B,eAA8B;+BAA9B,eAAe;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;YAClC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1F,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QACpF,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,QAAwB,EACxB,MAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAuB,CAAC;YAC/D,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAC7B,GAAG,MAAM;gBACT,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,aAAa,EAAE,QAAQ,CAAC,aAAa;gBACrC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;gBAC3C,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,sBAAsB;aAClD,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,eAAe,CAC1B,SAA8B;QAE9B,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CACtB,IAAmB,EACnB,SAA8B;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC5D,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC,CACjF,CAAC;QAEF,2FAA2F;QAC3F,6EAA6E;QAC7E,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAEO,KAAK,CAAC,KAAK,CACjB,KAAmE;QAEnE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,QAAgC;QACtD,OAAO;YACL,GAAI,QAAQ,CAAC,MAAM,EAAqC;YACxD,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC;SACjC,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"plugin-config-context.js","sourceRoot":"","sources":["../../src/types/plugin-config-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAU,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAA8B,MAAM,8BAA8B,CAAC;AACjG,OAAO,EAA2C,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACvG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAwC,MAAM,sCAAsC,CAAC;AAGtH,OAAO,EACL,sBAAsB,EAKvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAY,MAAM,mBAAmB,CAAC;AASlE,MAAM,OAAO,YAAY;IAOJ,MAAM;IACN,OAAO;IACP,WAAW;IARd,KAAK,GAAG,SAAkB,CAAC;IAE3C,oEAAoE;IAC7D,MAAM,CAAU,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAEtE,YACmB,MAAwB,EACxB,OAAyD,EACzD,WAA8B;sBAF9B,MAAM;uBACN,OAAO;2BACP,WAAW;IAC3B,CAAC;IAEJ,2FAA2F;IACpF,MAAM,CAAC,MAAM,CAAC,MAAwB;QAC3C,MAAM,OAAO,GAA4C,EAAE,CAAC;QAC5D,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACjE,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAkC,CAAC,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAEM,kBAAkB;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC9F,CAAC;IAED,sDAAsD;IAC/C,iBAAiB;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAEM,oBAAoB;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,2FAA2F;IAC3F,2DAA2D;IACpD,WAAW;QAChB,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;QAC9F,OAAO,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC5F,CAAC;IAED,sGAAsG;IAC/F,OAAO;QACZ,OAAO,IAAI,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC3D,CAAC;IAEM,UAAU;QACf,MAAM,QAAQ,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,MAAM,UAAU,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,QAAQ,KAAK,EAAE,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YACzC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,KAAK,CAC3C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EACpC,GAAG,EAAE,CAAC,SAAS,CAChB,CAAC;IACJ,CAAC;IAEM,qBAAqB,CAAC,QAAkB;QAC7C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC;IAChE,CAAC;CACF;AAID,MAAM,YAAY,GAA+B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,QAAQ,GAAG,CACf,QAAgC,EAChC,SAA8B,EAC9B,IAAqF,EAC5D,EAAE;IAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAS,SAAS,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;IACpH,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAExG,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,WAAW,GAAG,CAAC,QAAgB,EAAE,KAAgD,EAAW,EAAE,CAClG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;AAEvD,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAW,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAE5F,MAAM,eAAe,GAAG,CAAC,QAAgC,EAAW,EAAE,CACpE,eAAe,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,EAAE,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;AAErF,MAAM,YAAY,GAAG,CACnB,QAAgC,EAChC,QAAwB,EACxB,MAAqB,EACG,EAAE;IAC1B,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAuB,CAAC;IAC/D,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE;QAC7B,GAAG,MAAM;QACT,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,aAAa,EAAE,QAAQ,CAAC,aAAa;QACrC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3C,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,sBAAsB;KAClD,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,mBAAmB;IAID,eAAe;IAH3B,aAAa,CAAwB;IACrC,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;IAEjD,YAA6B,eAA8B;+BAA9B,eAAe;QAC1C,IAAI,CAAC,aAAa,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,oBAAoB;QAC/B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAC9B,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;YAClC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1F,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QACpF,CAAC;QACD,OAAO,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,QAAwB,EACxB,MAAqB;QAErB,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,oGAAoG;IAC7F,KAAK,CAAC,oBAAoB,CAAC,QAAwB;QACxD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7D,OAAO,EAAE,CAAC,SAAS,CAAC,CAAC;QACvB,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC1G,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,mFAAmF;IAC5E,KAAK,CAAC,qBAAqB,CAAC,SAA8B;QAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CACxE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAC9G,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2FAA2F;IACpF,KAAK,CAAC,eAAe,CAC1B,SAA8B;QAE9B,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CACtB,IAAmB,EACnB,SAA8B;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,WAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,EAAE,CAC5D,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC,CACjF,CAAC;QAEF,2FAA2F;QAC3F,6EAA6E;QAC7E,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAEO,KAAK,CAAC,KAAK,CACjB,KAAmE;QAEnE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,QAAgC;QACtD,OAAO;YACL,GAAI,QAAQ,CAAC,MAAM,EAAqC;YACxD,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC;SACjC,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/code-samples.d.ts

@@ -14,12 +14,14 @@ export declare class CodeSampleCatalog {
     static fromJson(language: Language, json: unknown): CodeSampleCatalog | undefined;
     sampleFor(endpoint: Endpoint): CodeSample | undefined;
     endpoints(): Endpoint[];
+    without(endpoints: Endpoint[]): CodeSampleCatalog;
 }
 export declare class CodeSampleCatalogs {
     private readonly catalogs;
     constructor(catalogs: CodeSampleCatalog[]);
     isEmpty(): boolean;
     samplesFor(endpoint: Endpoint): CodeSample[];
+    without(endpoints: Endpoint[]): CodeSampleCatalogs;
     unplacedIn(documented: Endpoint[]): string[];
     toJson(): CodeSamplesByEndpoint;
     private endpoints;

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

@@ -31,6 +31,10 @@ export class CodeSampleCatalog {
     endpoints() {
         return [...this.samplesByEndpoint.values()].map(({ endpoint }) => endpoint);
     }
+    without(endpoints) {
+        const left = new Set(endpoints.map(String));
+        return new CodeSampleCatalog(new Map([...this.samplesByEndpoint].filter(([key]) => !left.has(key))));
+    }
 }
 export class CodeSampleCatalogs {
     catalogs;
@@ -43,6 +47,9 @@ export class CodeSampleCatalogs {
     samplesFor(endpoint) {
         return this.catalogs.flatMap((catalog) => catalog.sampleFor(endpoint) ?? []);
     }
+    without(endpoints) {
+        return new CodeSampleCatalogs(this.catalogs.map((catalog) => catalog.without(endpoints)));
+    }
     unplacedIn(documented) {
         const names = new Set(documented.map(String));
         return [...new Set(this.endpoints().map(String))].filter((endpoint) => !names.has(endpoint));

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

@@ -1 +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"}
+{"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;IAEM,OAAO,CAAC,SAAqB;QAClC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,iBAAiB,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,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,OAAO,CAAC,SAAqB;QAClC,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5F,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/site-address.d.ts

@@ -0,0 +1,16 @@
+import { Parsed } from './fields.js';
+/** Where the portal is hosted: an origin, and the path it is served under there. */
+export declare class SiteAddress {
+    private readonly origin;
+    /** `''` at the root of the host, otherwise `/docs` or deeper, with no trailing slash. */
+    private readonly basePath;
+    private constructor();
+    static parse(value: unknown, path: string): Parsed<SiteAddress>;
+    /** Where the portal is served, in the form Vite's `base` takes: `/`, or `/docs/`. */
+    path(): string;
+    hasPath(): boolean;
+    /** A portal-relative path's address on the host: `/sitemap.xml` is `https://example.com/docs/sitemap.xml`. */
+    addressOf(portalPath: string): string;
+    /** The site address, with no trailing slash. */
+    toString(): string;
+}

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

@@ -0,0 +1,67 @@
+import { err, ok } from 'neverthrow';
+import { isWebAddress } from './fields.js';
+/** One spelling of the path everywhere: Vite's base, the router's prefix, the host's folder and canonical links. */
+const SEGMENT = /^[A-Za-z0-9._~-]+$/;
+/** The last part of a page's address, such as a home page's `index.html`, which the portal cannot be served under. */
+const PAGE = /\.html?$/i;
+const GIVE_THE_ADDRESS = "Give the address the portal is hosted at, for example 'https://example.com/docs'.";
+/** Where the portal is hosted: an origin, and the path it is served under there. */
+export class SiteAddress {
+    origin;
+    basePath;
+    constructor(origin, 
+    /** `''` at the root of the host, otherwise `/docs` or deeper, with no trailing slash. */
+    basePath) {
+        this.origin = origin;
+        this.basePath = basePath;
+    }
+    static parse(value, path) {
+        const text = typeof value === 'string' ? value.trim() : '';
+        const hostStart = text.indexOf('//') + 2;
+        const pathStart = text.indexOf('/', hostStart);
+        // Checked as written: the URL parser drops a tab from the host and reads past extra slashes before it.
+        const host = text.slice(hostStart, pathStart === -1 ? undefined : pathStart);
+        if (!isWebAddress(text) || !/^\S+$/.test(host)) {
+            return err([
+                `'${path}' must be the address the portal is hosted at, for example 'https://docs.example.com' or 'https://example.com/docs'.`
+            ]);
+        }
+        // Checked as written: the URL parser reads `\` as `/` and drops an empty query or fragment.
+        const character = ['?', '#', '\\'].find((candidate) => text.includes(candidate));
+        if (character !== undefined) {
+            return err([`'${path}' cannot contain '${character}'. ${GIVE_THE_ADDRESS}`]);
+        }
+        const basePath = pathStart === -1 ? '' : text.slice(pathStart).replace(/\/$/, '');
+        const segments = basePath.split('/').slice(1);
+        if (segments.includes('')) {
+            return err([`'${path}' has an empty part ('//') in its path.`]);
+        }
+        const invalid = segments.find((segment) => !SEGMENT.test(segment) || segment === '.' || segment === '..');
+        if (invalid !== undefined) {
+            return err([
+                `'${path}' has '${invalid}' in its path. Each part between '/'s can use only letters, digits, '.', '_', '~' and '-', and cannot be '.' or '..'.`
+            ]);
+        }
+        const page = segments.at(-1);
+        if (page !== undefined && PAGE.test(page)) {
+            return err([`'${path}' ends in '${page}', which names a page. ${GIVE_THE_ADDRESS}`]);
+        }
+        return ok(new SiteAddress(new URL(text).origin, basePath));
+    }
+    /** Where the portal is served, in the form Vite's `base` takes: `/`, or `/docs/`. */
+    path() {
+        return `${this.basePath}/`;
+    }
+    hasPath() {
+        return this.basePath !== '';
+    }
+    /** A portal-relative path's address on the host: `/sitemap.xml` is `https://example.com/docs/sitemap.xml`. */
+    addressOf(portalPath) {
+        return `${this.origin}${this.basePath}${portalPath}`;
+    }
+    /** The site address, with no trailing slash. */
+    toString() {
+        return `${this.origin}${this.basePath}`;
+    }
+}
+//# sourceMappingURL=site-address.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"site-address.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,YAAY,EAAU,MAAM,aAAa,CAAC;AAEnD,oHAAoH;AACpH,MAAM,OAAO,GAAG,oBAAoB,CAAC;AAErC,sHAAsH;AACtH,MAAM,IAAI,GAAG,WAAW,CAAC;AAEzB,MAAM,gBAAgB,GAAG,mFAAmF,CAAC;AAE7G,oFAAoF;AACpF,MAAM,OAAO,WAAW;IAEH,MAAM;IAEN,QAAQ;IAH3B,YACmB,MAAc;IAC/B,yFAAyF;IACxE,QAAgB;sBAFhB,MAAM;wBAEN,QAAQ;IACxB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,MAAM,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC/C,uGAAuG;QACvG,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/C,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,sHAAsH;aAC/H,CAAC,CAAC;QACL,CAAC;QACD,4FAA4F;QAC5F,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACjF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,SAAS,MAAM,gBAAgB,EAAE,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,QAAQ,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClF,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,yCAAyC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC;QAC1G,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,UAAU,OAAO,uHAAuH;aACjJ,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,cAAc,IAAI,0BAA0B,gBAAgB,EAAE,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,qFAAqF;IAC9E,IAAI;QACT,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC;IAC7B,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,8GAA8G;IACvG,SAAS,CAAC,UAAkB;QACjC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,GAAG,UAAU,EAAE,CAAC;IACvD,CAAC;IAED,gDAAgD;IACzC,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC1C,CAAC;CACF"}

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

@@ -1,5 +1,5 @@
-import { UrlPath } from '../../file/urlPath.js';
 import { Parsed } from './fields.js';
+import { SiteAddress } from './site-address.js';
 /** What a specification says about itself, which is what a portal is called until the block says otherwise. */
 export interface SuggestedSite {
     name: string;
@@ -8,7 +8,7 @@ export interface SuggestedSite {
 export declare const PLACEHOLDER_SITE: Readonly<SuggestedSite>;
 export declare class SiteConfig {
     private readonly name;
-    private readonly url;
+    private readonly address;
     private readonly description;
     private constructor();
     /**
@@ -19,7 +19,7 @@ export declare class SiteConfig {
     static suggested(site: SuggestedSite): SiteConfig;
     siteName(): string;
     siteDescription(): string | null;
-    origin(): UrlPath | null;
+    siteAddress(): SiteAddress | null;
     toJSON(): {
         name: string;
         url?: string;
@@ -27,6 +27,4 @@ export declare class SiteConfig {
     };
     private static validName;
     private static validDescription;
-    private static validUrl;
-    private static parseOrigin;
 }

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

@@ -1,15 +1,15 @@
 import { err, ok, Result } from 'neverthrow';
-import { UrlPath } from '../../file/urlPath.js';
-import { allOf, isWebAddress, namespace, nonEmptyString, unknownKeys } from './fields.js';
+import { allOf, namespace, nonEmptyString, optional, unknownKeys } from './fields.js';
+import { SiteAddress } from './site-address.js';
 export const PLACEHOLDER_SITE = Object.freeze({ name: 'My API', description: null });
 const KNOWN = ['name', 'url', 'description'];
 export class SiteConfig {
     name;
-    url;
+    address;
     description;
-    constructor(name, url, description) {
+    constructor(name, address, description) {
         this.name = name;
-        this.url = url;
+        this.address = address;
         this.description = description;
     }
     /**
@@ -19,9 +19,9 @@ export class SiteConfig {
     static parse(value, path, suggested) {
         return namespace(value, path).andThen((data) => allOf(unknownKeys(data, KNOWN, path), Result.combineWithAllErrors([
             SiteConfig.validName(data.name, `${path}.name`, suggested),
-            SiteConfig.validUrl(data.url, `${path}.url`),
+            optional(data.url, (url) => SiteAddress.parse(url, `${path}.url`)),
             SiteConfig.validDescription(data.description, `${path}.description`, suggested)
-        ])).map(([name, url, description]) => new SiteConfig(name, url, description)));
+        ])).map(([name, address, description]) => new SiteConfig(name, address, description)));
     }
     static suggested(site) {
         return new SiteConfig(site.name, null, site.description);
@@ -32,13 +32,13 @@ export class SiteConfig {
     siteDescription() {
         return this.description;
     }
-    origin() {
-        return this.url;
+    siteAddress() {
+        return this.address;
     }
     toJSON() {
         return {
             name: this.name,
-            ...(this.url === null ? {} : { url: this.url.toString() }),
+            ...(this.address === null ? {} : { url: this.address.toString() }),
             ...(this.description === null ? {} : { description: this.description })
         };
     }
@@ -61,28 +61,5 @@ export class SiteConfig {
         const trimmed = description.trim();
         return ok(trimmed.length > 0 ? trimmed : null);
     }
-    // Only the origin is accepted: the portal is hosted at the root of its host, so a path,
-    // query or fragment would produce canonical links that do not resolve.
-    static validUrl(url, path) {
-        if (url === undefined) {
-            return ok(null);
-        }
-        const origin = typeof url === 'string' ? SiteConfig.parseOrigin(url.trim()) : null;
-        return origin === null
-            ? err([
-                `'${path}' must be the address the portal is hosted at, without a path, for example 'https://docs.example.com'.`
-            ])
-            : ok(origin);
-    }
-    static parseOrigin(value) {
-        if (!isWebAddress(value)) {
-            return null;
-        }
-        const parsed = new URL(value);
-        if (parsed.pathname !== '/' || parsed.search !== '' || parsed.hash !== '') {
-            return null;
-        }
-        return new UrlPath(parsed.origin);
-    }
 }
 //# sourceMappingURL=site-config.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAQlG,MAAM,CAAC,MAAM,gBAAgB,GAA4B,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAE9G,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;AAE7C,MAAM,OAAO,UAAU;IAEF,IAAI;IACJ,GAAG;IACH,WAAW;IAH9B,YACmB,IAAY,EACZ,GAAmB,EACnB,WAA0B;oBAF1B,IAAI;mBACJ,GAAG;2BACH,WAAW;IAC3B,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,SAA+B;QAC/E,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,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,SAAS,CAAC;YAC1D,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC;YAC5C,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,cAAc,EAAE,SAAS,CAAC;SAChF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,CAC5E,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAmB;QACzC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC1D,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SACxE,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,IAAY,EAAE,SAA+B;QACnF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,KAAK,IAAI;YACvB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,8DAA8D,CAAC,CAAC;YAC/E,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,kFAAkF;IAC1E,MAAM,CAAC,gBAAgB,CAC7B,WAAoB,EACpB,IAAY,EACZ,SAA+B;QAE/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC,SAAS,EAAE,WAAW,IAAI,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,wFAAwF;IACxF,uEAAuE;IAC/D,MAAM,CAAC,QAAQ,CAAC,GAAY,EAAE,IAAY;QAChD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnF,OAAO,MAAM,KAAK,IAAI;YACpB,CAAC,CAAC,GAAG,CAAC;gBACF,IAAI,IAAI,wGAAwG;aACjH,CAAC;YACJ,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,KAAa;QACtC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,MAAM,CAAC,QAAQ,KAAK,GAAG,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;CACF"}
+{"version":3,"file":"site-config.js","sourceRoot":"","sources":["../../../../src/types/portal/config/site-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAU,WAAW,EAAE,MAAM,aAAa,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAQhD,MAAM,CAAC,MAAM,gBAAgB,GAA4B,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;AAE9G,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;AAE7C,MAAM,OAAO,UAAU;IAEF,IAAI;IACJ,OAAO;IACP,WAAW;IAH9B,YACmB,IAAY,EACZ,OAA2B,EAC3B,WAA0B;oBAF1B,IAAI;uBACJ,OAAO;2BACP,WAAW;IAC3B,CAAC;IAEJ;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,SAA+B;QAC/E,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,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,SAAS,CAAC;YAC1D,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC,CAAC;YAClE,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,IAAI,cAAc,EAAE,SAAS,CAAC;SAChF,CAAC,CACH,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CACpF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAmB;QACzC,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,eAAe;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;YAClE,GAAG,CAAC,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SACxE,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,IAAa,EAAE,IAAY,EAAE,SAA+B;QACnF,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,KAAK,IAAI;YACvB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,8DAA8D,CAAC,CAAC;YAC/E,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAED,kFAAkF;IAC1E,MAAM,CAAC,gBAAgB,CAC7B,WAAoB,EACpB,IAAY,EACZ,SAA+B;QAE/B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,CAAC,SAAS,EAAE,WAAW,IAAI,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,qBAAqB,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACF"}

package/lib/types/portal/config/static-asset.d.ts

@@ -13,10 +13,10 @@ export declare class StaticAsset {
     resolveIn(sourceDirectory: DirectoryPath): FilePath;
     settingPath(): string;
     /**
-     * The `static/` prefix is the site root. Each name is escaped, since a `#`, `?` or `%` in it
+     * The `static/` prefix is the portal's root. Each name is escaped, since a `#`, `?` or `%` in it
      * would otherwise end or alter the path.
      */
-    siteUrl(): string;
+    portalPath(): string;
     imageType(): string | null;
     isEqual(other: StaticAsset): boolean;
     toJSON(): string;

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

@@ -45,10 +45,10 @@ export class StaticAsset {
         return this.setting;
     }
     /**
-     * The `static/` prefix is the site root. Each name is escaped, since a `#`, `?` or `%` in it
+     * The `static/` prefix is the portal's root. Each name is escaped, since a `#`, `?` or `%` in it
      * would otherwise end or alter the path.
      */
-    siteUrl() {
+    portalPath() {
         return `/${this.relativePath.slice(STATIC_PREFIX.length).split('/').map(encodeURIComponent).join('/')}`;
     }
     imageType() {

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

@@ -1 +1 @@
-{"version":3,"file":"static-asset.js","sourceRoot":"","sources":["../../../../src/types/portal/config/static-asset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,MAAM,aAAa,GAAG,SAAS,CAAC;AAEhC,kGAAkG;AAClG,MAAM,WAAW,GAA2B;IAC1C,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,YAAY;CACtB,CAAC;AAEF,mGAAmG;AACnG,MAAM,OAAO,WAAW;IAGH,OAAO;IACP,YAAY;IAEZ,OAAO;IAL1B;IACE,uEAAuE;IACtD,OAAe,EACf,YAAoB;IACrC,0EAA0E;IACzD,OAAe;uBAHf,OAAO;4BACP,YAAY;uBAEZ,OAAO;IACvB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,+BAA+B,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,kFAAkF,aAAa,mBAAmB;aAC3H,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,SAAS,CAAC,eAA8B;QAC7C,OAAO,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1G,CAAC;IAEM,SAAS;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAEM,OAAO,CAAC,KAAkB;QAC/B,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAClD,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,YAAoB;QAC3C,OAAO,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,6FAA6F;IAC7F,sFAAsF;IAC9E,MAAM,CAAC,cAAc,CAAC,UAAkB;QAC9C,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,CACL,GAAG,KAAK,GAAG,KAAK,aAAa;YAC7B,KAAK,CAAC,MAAM,GAAG,CAAC;YAChB,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,CAC/E,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"static-asset.js","sourceRoot":"","sources":["../../../../src/types/portal/config/static-asset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,MAAM,aAAa,GAAG,SAAS,CAAC;AAEhC,kGAAkG;AAClG,MAAM,WAAW,GAA2B;IAC1C,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,YAAY;CACtB,CAAC;AAEF,mGAAmG;AACnG,MAAM,OAAO,WAAW;IAGH,OAAO;IACP,YAAY;IAEZ,OAAO;IAL1B;IACE,uEAAuE;IACtD,OAAe,EACf,YAAoB;IACrC,0EAA0E;IACzD,OAAe;uBAHf,OAAO;4BACP,YAAY;uBAEZ,OAAO;IACvB,CAAC;IAEG,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAY;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC,CAAC,IAAI,IAAI,+BAA+B,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,CAAC;gBACT,IAAI,IAAI,kFAAkF,aAAa,mBAAmB;aAC3H,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,SAAS,CAAC,eAA8B;QAC7C,OAAO,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,UAAU;QACf,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1G,CAAC;IAEM,SAAS;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAEM,OAAO,CAAC,KAAkB;QAC/B,OAAO,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,CAAC;IAClD,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,YAAoB;QAC3C,OAAO,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,6FAA6F;IAC7F,sFAAsF;IAC9E,MAAM,CAAC,cAAc,CAAC,UAAkB;QAC9C,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,OAAO,CACL,GAAG,KAAK,GAAG,KAAK,aAAa;YAC7B,KAAK,CAAC,MAAM,GAAG,CAAC;YAChB,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,CAC/E,CAAC;IACJ,CAAC;CACF"}

package/lib/types/portal/content-tree.d.ts

@@ -5,7 +5,14 @@ import { FilePath } from '../file/filePath.js';
 import { ContentNotices } from './content-notices.js';
 import { GeneratedPages } from './generated-pages.js';
 import { ParsedPage } from './page.js';
-import { ContentProblem, MissingImage, PortalSpec } from './portal-source.js';
+import { ContentProblem, MissingImage, PortalSpec, ReservedAddress } from './portal-source.js';
+/**
+ * The page the API playground's OAuth authorization returns through, which the template serves
+ * from a route of its own (`portal-template/src/lib/oauth-callback.ts`). That route wins over a
+ * content page at the address, so such a page would build and never be shown.
+ */
+export declare const OAUTH_CALLBACK_ADDRESS = "/oauth/callback";
+export declare const OAUTH_CALLBACK: ReservedAddress;
 /** Passed over by Vite's `import.meta.glob`, which the build reads the content through. */
 export declare const isSkippedByGlob: (name: string) => boolean;
 /** Whether the glob passes over `file` below `root`, which it does for a path with any such segment. */
@@ -81,9 +88,9 @@ export declare class ContentTree {
     private static addressProblems;
     /**
      * Pages served at a generated section's address or below it, whether or not `apimatic.json`
-     * calls for the section. Judged by the address, as the content source computes it, rather
-     * than by the directories as written: a page in a `(group)` folder is served as if the folder
-     * were not there, and a folder's index page at the folder's own address.
+     * calls for the section, and at the OAuth callback's. Judged by the address, as the content
+     * source computes it, rather than by the directories as written: a page in a `(group)` folder
+     * is served as if the folder were not there, and a folder's index page at the folder's own address.
      */
     private static reservedAddressPages;
     /** Addresses more than one page would be served at, each with its pages in the order walked. */

package/lib/types/portal/content-tree.js

@@ -6,11 +6,27 @@ import { FilePath } from '../file/filePath.js';
 import { GENERATED_SECTIONS } from './generated-pages.js';
 import { API_REFERENCE_NAME, GROUP_FOLDER, INDEX_NAME, isSameTabEntry, NAVIGATION_FILE_NAME, PortalNavigation } from './portal-navigation.js';
 import { sharedTabNames, untitledTabName } from './portal-tabs.js';
+import { shared } from './shared.js';
 const NAVIGATION_FILE = new FileName(NAVIGATION_FILE_NAME);
+/**
+ * The page the API playground's OAuth authorization returns through, which the template serves
+ * from a route of its own (`portal-template/src/lib/oauth-callback.ts`). That route wins over a
+ * content page at the address, so such a page would build and never be shown.
+ */
+export const OAUTH_CALLBACK_ADDRESS = '/oauth/callback';
+export const OAUTH_CALLBACK = {
+    address: OAUTH_CALLBACK_ADDRESS,
+    description: "the API playground's OAuth authorization"
+};
 /** Extensions the docs collection compiles, and so the ones an entry can address. */
 const PAGE_EXTENSIONS = ['.md', '.mdx'];
 /** Passed over by Vite's `import.meta.glob`, which the build reads the content through. */
 export const isSkippedByGlob = (name) => name.startsWith('.') || name === 'node_modules';
+/** The slugs the content source gives a page, and the address they make: a `(group)` folder adds none. */
+const servedAt = (segments) => {
+    const slugs = getSlugs(segments.join('/'));
+    return { slugs, address: `/${slugs.join('/')}` };
+};
 /** Whether the glob passes over `file` below `root`, which it does for a path with any such segment. */
 export const isSkippedWithin = (file, root) => file.relativeTo(root).split('/').some(isSkippedByGlob);
 /**
@@ -32,9 +48,7 @@ export class ContentTree {
     }
     /** The `nav.json` files the build reads, which its glob matches by code point. */
     navigationFiles() {
-        return this.tree
-            .getAllFiles()
-            .filter((file) => file.name().compare(NAVIGATION_FILE) === 0 && !this.isSkipped(file));
+        return this.tree.getAllFiles().filter((file) => file.name().isEqual(NAVIGATION_FILE) && !this.isSkipped(file));
     }
     /** Whether the build would read `file` as part of `content/`: below it, and not passed over. */
     holds(file) {
@@ -175,35 +189,32 @@ export class ContentTree {
             problems.push({ kind: 'reservedAddresses', pages: reserved });
         }
         // The build fails on two pages at one address, or moves an index page to `<folder>/index`.
-        const shared = ContentTree.sharedAddresses(addressed.filter(({ file }) => !reserved.some((page) => page.file.isEqual(file))));
-        if (shared.length > 0) {
-            problems.push({ kind: 'sharedAddresses', addresses: shared });
+        const sharing = ContentTree.sharedAddresses(addressed.filter(({ file }) => !reserved.some((page) => page.file.isEqual(file))));
+        if (sharing.length > 0) {
+            problems.push({ kind: 'sharedAddresses', addresses: sharing });
         }
         return problems;
     }
     /**
      * Pages served at a generated section's address or below it, whether or not `apimatic.json`
-     * calls for the section. Judged by the address, as the content source computes it, rather
-     * than by the directories as written: a page in a `(group)` folder is served as if the folder
-     * were not there, and a folder's index page at the folder's own address.
+     * calls for the section, and at the OAuth callback's. Judged by the address, as the content
+     * source computes it, rather than by the directories as written: a page in a `(group)` folder
+     * is served as if the folder were not there, and a folder's index page at the folder's own address.
      */
     static reservedAddressPages(pages) {
         return pages.flatMap(({ file, segments }) => {
-            const slugs = getSlugs(segments.join('/'));
+            const { slugs, address } = servedAt(segments);
+            if (address === OAUTH_CALLBACK.address)
+                return [{ file, address, keptFor: OAUTH_CALLBACK }];
             const section = GENERATED_SECTIONS.find((candidate) => candidate.folder === slugs[0]);
-            return section === undefined ? [] : [{ file, address: `/${slugs.join('/')}`, section }];
+            return section === undefined
+                ? []
+                : [{ file, address, keptFor: { address: `/${section.folder}`, description: section.description } }];
         });
     }
     /** Addresses more than one page would be served at, each with its pages in the order walked. */
     static sharedAddresses(pages) {
-        const byAddress = new Map();
-        for (const { file, segments } of pages) {
-            const address = `/${getSlugs(segments.join('/')).join('/')}`;
-            byAddress.set(address, [...(byAddress.get(address) ?? []), file]);
-        }
-        return [...byAddress]
-            .filter(([, files]) => files.length > 1)
-            .map(([address, files]) => ({ address, pages: files }));
+        return shared(pages.map(({ file, segments }) => ({ key: servedAt(segments).address, file })));
     }
     /**
      * Pages inside a specification's section, below `content/api/<slug>/`. The section and each
@@ -357,7 +368,7 @@ class NavigationWalk {
             else if (!isSkippedByGlob(item.fileName.toString())) {
                 const file = new FilePath(directory.directoryPath, item.fileName);
                 const page = pageName(item.fileName);
-                if (item.fileName.compare(NAVIGATION_FILE) === 0) {
+                if (item.fileName.isEqual(NAVIGATION_FILE)) {
                     listing.navigationFile = file;
                 }
                 else if (item.fileName.is(NAVIGATION_FILE_NAME)) {