@lukoweb/apitogo 0.2.31 → 0.2.34

package/src/config/v2/home-redirect.ts

@@ -1,98 +1,104 @@
-import path from "node:path";
-import { glob } from "glob";
-import globParent from "glob-parent";
-import { readFrontmatter } from "../../lib/util/readFrontmatter.js";
-
-export type HomeRedirect = { from: string; to: string };
-
-const IGNORED = ["**/node_modules/**", "**/dist/**", "**/.git/**"];
-
-/**
- * The routes the docs plugin gives the pages these globs match: the path inside the glob's folder, without the
- * extension. Missing folders and negated globs are fine, they just match nothing.
- */
-export async function docRoutes(
-  patterns: string[],
-  options: { includeDrafts?: boolean } = {},
-): Promise<string[]> {
-  const excluded = patterns
-    .filter((pattern) => pattern.startsWith("!"))
-    .map((pattern) => pattern.slice(1));
-  const included = patterns.filter((pattern) => !pattern.startsWith("!"));
-
-  const routes = await Promise.all(
-    included.map(async (pattern) => {
-      const files = await glob(pattern, {
-        absolute: true,
-        posix: true,
-        ignore: [...IGNORED, ...excluded],
-      });
-      const parent = globParent(pattern);
-      // The docs plugin leaves draft pages out of a production build, so the routes must too.
-      const published = options.includeDrafts
-        ? files
-        : (
-            await Promise.all(
-              files.map(async (file) => ({
-                file,
-                draft: (await readFrontmatter(file)).data.draft === true,
-              })),
-            )
-          )
-            .filter(({ draft }) => !draft)
-            .map(({ file }) => file);
-      return published.map(
-        (file) =>
-          `/${path.posix.relative(parent, file).replace(/\.mdx?$/, "")}`,
-      );
-    }),
-  );
-  return [...new Set(routes.flat())].sort();
-}
-
-/** The page a visitor lands on when the site has no home page: the top-most page, then the first by name. */
-export function pickLandingRoute(routes: string[]): string | undefined {
-  const depth = (route: string) => route.split("/").length;
-  return [...routes].sort(
-    (a, b) => depth(a) - depth(b) || a.localeCompare(b),
-  )[0];
-}
-
-export type HomeRedirectInput = {
-  /** APItoGo builds the docs pages. */
-  hostsDocs: boolean;
-  /** Routes of those pages (see `docRoutes`). */
-  docRoutes: string[];
-  /** Where the docs live when someone else hosts them. */
-  externalDocsUrl?: string;
-  /** The portal has an API reference page, at this path. */
-  apiReferencePath?: string;
-  /** The portal has console pages (sign-in, keys, plans). */
-  userPanel: boolean;
-};
-
-/**
- * Where `/` should go when the portal has no page of its own there. Without this a visitor of the home page sees
- * "Page not found".
- *
- * - Hosted docs without an index page: the first page, so the team's own docs never need an extra file.
- * - Hosted docs without any page: the API reference, when there is one.
- * - External docs and no console: the external docs site, as the portal has nothing else to show.
- */
-export function homeRedirect(
-  input: HomeRedirectInput,
-): HomeRedirect | undefined {
-  if (input.hostsDocs) {
-    if (input.docRoutes.some((route) => route === "/" || route === "/index"))
-      return undefined;
-    const landing = pickLandingRoute(input.docRoutes);
-    if (landing) return { from: "/", to: landing };
-    return input.apiReferencePath
-      ? { from: "/", to: input.apiReferencePath }
-      : undefined;
-  }
-  if (input.externalDocsUrl && !input.userPanel) {
-    return { from: "/", to: input.externalDocsUrl };
-  }
-  return undefined;
-}
+import path from "node:path";
+import { glob } from "glob";
+import globParent from "glob-parent";
+import { readFrontmatter } from "../../lib/util/readFrontmatter.js";
+import { toGlobPath } from "./resolve.js";
+
+export type HomeRedirect = { from: string; to: string };
+
+const IGNORED = ["**/node_modules/**", "**/dist/**", "**/.git/**"];
+
+/**
+ * The routes the docs plugin gives the pages these globs match: the path inside the glob's folder, without the
+ * extension. Missing folders and negated globs are fine, they just match nothing.
+ */
+export async function docRoutes(
+  patterns: string[],
+  options: { includeDrafts?: boolean } = {},
+): Promise<string[]> {
+  // Windows paths use backslashes, which the glob library reads as escapes.
+  const globs = patterns.map(toGlobPath);
+  const excluded = globs
+    .filter((pattern) => pattern.startsWith("!"))
+    .map((pattern) => pattern.slice(1));
+  const included = globs.filter((pattern) => !pattern.startsWith("!"));
+
+  const routes = await Promise.all(
+    included.map(async (pattern) => {
+      const files = await glob(pattern, {
+        absolute: true,
+        posix: true,
+        ignore: [...IGNORED, ...excluded],
+      });
+      const parent = globParent(pattern);
+      // The docs plugin leaves draft pages out of a production build, so the routes must too.
+      const published = options.includeDrafts
+        ? files
+        : (
+            await Promise.all(
+              files.map(async (file) => ({
+                file,
+                draft: (await readFrontmatter(file)).data.draft === true,
+              })),
+            )
+          )
+            .filter(({ draft }) => !draft)
+            .map(({ file }) => file);
+      // On Windows the glob library answers with the extended form `//?/C:/...`, which would not relate to `parent`.
+      return published.map(
+        (file) =>
+          `/${path.posix
+            .relative(parent, file.replace(/^\/\/\?\//, ""))
+            .replace(/\.mdx?$/, "")}`,
+      );
+    }),
+  );
+  return [...new Set(routes.flat())].sort();
+}
+
+/** The page a visitor lands on when the site has no home page: the top-most page, then the first by name. */
+export function pickLandingRoute(routes: string[]): string | undefined {
+  const depth = (route: string) => route.split("/").length;
+  return [...routes].sort(
+    (a, b) => depth(a) - depth(b) || a.localeCompare(b),
+  )[0];
+}
+
+export type HomeRedirectInput = {
+  /** APItoGo builds the docs pages. */
+  hostsDocs: boolean;
+  /** Routes of those pages (see `docRoutes`). */
+  docRoutes: string[];
+  /** Where the docs live when someone else hosts them. */
+  externalDocsUrl?: string;
+  /** The portal has an API reference page, at this path. */
+  apiReferencePath?: string;
+  /** The portal has console pages (sign-in, keys, plans). */
+  userPanel: boolean;
+};
+
+/**
+ * Where `/` should go when the portal has no page of its own there. Without this a visitor of the home page sees
+ * "Page not found".
+ *
+ * - Hosted docs without an index page: the first page, so the team's own docs never need an extra file.
+ * - Hosted docs without any page: the API reference, when there is one.
+ * - External docs and no console: the external docs site, as the portal has nothing else to show.
+ */
+export function homeRedirect(
+  input: HomeRedirectInput,
+): HomeRedirect | undefined {
+  if (input.hostsDocs) {
+    if (input.docRoutes.some((route) => route === "/" || route === "/index"))
+      return undefined;
+    const landing = pickLandingRoute(input.docRoutes);
+    if (landing) return { from: "/", to: landing };
+    return input.apiReferencePath
+      ? { from: "/", to: input.apiReferencePath }
+      : undefined;
+  }
+  if (input.externalDocsUrl && !input.userPanel) {
+    return { from: "/", to: input.externalDocsUrl };
+  }
+  return undefined;
+}

package/src/config/v2/index.ts

@@ -1,126 +1,127 @@
-export { ConfigError, type ConfigIssue, formatConfigIssue } from "./errors.js";
-export {
-  applyInitPlan,
-  formatInitPlan,
-  InitError,
-  type InitOptions,
-  type InitPlan,
-  type InitResult,
-  type PlannedEntry,
-  planInit,
-} from "./init.js";
-export {
-  type DocsCandidate,
-  detectExistingDocs,
-  detectLayout,
-  ensureStateDir,
-  type LayoutDetection,
-} from "./layout.js";
-export { type LoadedConfigV2, loadConfigV2 } from "./load.js";
-export {
-  BUILD_DIR,
-  GENERATED_DIR,
-  layoutRoot,
-  STATE_FILE,
-  type StatePaths,
-  stateDirFor,
-  statePathsFor,
-} from "./paths.js";
-export { parseConfigV2 } from "./parse.js";
-export {
-  type CheckContext,
-  type CheckReport,
-  checkConfigV2,
-  collectSecretRefs,
-} from "./rules.js";
-export {
-  type ResolvedConfigV2,
-  type ResolvedGateway,
-  type ResolvedIdentity,
-  type ResolvedPlans,
-  type ResolvedPortal,
-  resolveConfigV2,
-} from "./resolve.js";
-export {
-  CONFIG_VERSION,
-  type ConfigV2,
-  ConfigV2Schema,
-  type Layout,
-} from "./schema.js";
-export { type PortalProfile, portalProfile } from "./portal-profile.js";
-export {
-  hasCapability,
-  type ManifestServiceName,
-  missingManifestServices,
-  parseManifest,
-  readManifest,
-  removeServicesFromManifest,
-  requiredServices,
-  SUPPORTED_MANIFEST_SCHEMA,
-  type ServiceManifest,
-  serviceReady,
-  stubManifest,
-  withGatewayEntry,
-  withIdentityEntry,
-  withPlansEntry,
-  withPortalEntry,
-  writeManifest,
-} from "./manifest.js";
-export { MANIFEST_FILE, manifestPathFor } from "./paths.js";
-export {
-  buildReferenceSpec,
-  DEFAULT_KEY_HEADER,
-  type ReferenceOptions,
-  ReferenceSpecError,
-  referenceOptions,
-  renderReferenceSpec,
-} from "./gateway-reference.js";
-export {
-  type DerivedCorsSite,
-  derivedCorsSites,
-  type GatewayConfigBody,
-  gatewayConfigBody,
-  stableJson,
-} from "./gateway-request.js";
-export {
-  consoleLinks,
-  planPortal,
-  publishedManifest,
-  type PortalPlan,
-  type PreparedPortal,
-  type PrepareMode,
-  preparePortal,
-  renderWrapper,
-  requiredPackages,
-  WRAPPER_FILE,
-} from "./wrapper.js";
-export { materializeWorkspace, portalArtifactHash } from "./workspace.js";
-export {
-  type AddOptions,
-  applyServiceEdit,
-  formatServiceEdit,
-  isServiceName,
-  planAddService,
-  planRemoveService,
-  SERVICES,
-  clearProjectId,
-  ServiceEditError,
-  setProjectId,
-  type ServiceEdit,
-  type ServiceName,
-} from "./services.js";
-export { checkDependencies } from "./rules.js";
-export {
-  clearServices,
-  emptyLedger,
-  type Ledger,
-  LEDGER_VERSION,
-  LedgerError,
-  type PipelineStep,
-  readLedger,
-  runPipeline,
-  type StepOutcome,
-  type StepRecord,
-  stepOf,
-  writeLedger,
-} from "./ledger.js";
+export { ConfigError, type ConfigIssue, formatConfigIssue } from "./errors.js";
+export {
+  applyInitPlan,
+  formatInitPlan,
+  InitError,
+  type InitOptions,
+  type InitPlan,
+  type InitResult,
+  type PlannedEntry,
+  planInit,
+} from "./init.js";
+export {
+  type DocsCandidate,
+  detectExistingDocs,
+  detectLayout,
+  ensureStateDir,
+  type LayoutDetection,
+} from "./layout.js";
+export { type LoadedConfigV2, loadConfigV2 } from "./load.js";
+export {
+  BUILD_DIR,
+  GENERATED_DIR,
+  layoutRoot,
+  STATE_FILE,
+  type StatePaths,
+  stateDirFor,
+  statePathsFor,
+} from "./paths.js";
+export { parseConfigV2 } from "./parse.js";
+export {
+  type CheckContext,
+  type CheckReport,
+  checkConfigV2,
+  collectSecretRefs,
+} from "./rules.js";
+export {
+  type ResolvedConfigV2,
+  type ResolvedGateway,
+  type ResolvedIdentity,
+  type ResolvedPlans,
+  type ResolvedPortal,
+  resolveConfigV2,
+} from "./resolve.js";
+export {
+  CONFIG_VERSION,
+  type ConfigV2,
+  ConfigV2Schema,
+  type Layout,
+} from "./schema.js";
+export { type PortalProfile, portalProfile } from "./portal-profile.js";
+export {
+  hasCapability,
+  type ManifestServiceName,
+  missingManifestServices,
+  parseManifest,
+  readManifest,
+  removeServicesFromManifest,
+  requiredServices,
+  SUPPORTED_MANIFEST_SCHEMA,
+  type ServiceManifest,
+  serviceReady,
+  stubManifest,
+  withGatewayEntry,
+  withIdentityEntry,
+  withPlansEntry,
+  withPortalEntry,
+  writeManifest,
+} from "./manifest.js";
+export { MANIFEST_FILE, manifestPathFor } from "./paths.js";
+export {
+  buildReferenceSpec,
+  DEFAULT_KEY_HEADER,
+  type ReferenceOptions,
+  ReferenceSpecError,
+  referenceOptions,
+  renderReferenceSpec,
+} from "./gateway-reference.js";
+export {
+  type DerivedCorsSite,
+  derivedCorsSites,
+  type GatewayConfigBody,
+  gatewayConfigBody,
+  stableJson,
+} from "./gateway-request.js";
+export {
+  consoleLinks,
+  planPortal,
+  publishedManifest,
+  type PortalPlan,
+  type PreparedPortal,
+  type PrepareMode,
+  preparePortal,
+  renderWrapper,
+  requiredPackages,
+  WRAPPER_FILE,
+} from "./wrapper.js";
+export { materializeWorkspace, portalArtifactHash } from "./workspace.js";
+export {
+  type AddOptions,
+  type Asker,
+  applyServiceEdit,
+  formatServiceEdit,
+  isServiceName,
+  planAddService,
+  planRemoveService,
+  SERVICES,
+  clearProjectId,
+  ServiceEditError,
+  setProjectId,
+  type ServiceEdit,
+  type ServiceName,
+} from "./services.js";
+export { checkDependencies } from "./rules.js";
+export {
+  clearServices,
+  emptyLedger,
+  type Ledger,
+  LEDGER_VERSION,
+  LedgerError,
+  type PipelineStep,
+  readLedger,
+  runPipeline,
+  type StepOutcome,
+  type StepRecord,
+  stepOf,
+  writeLedger,
+} from "./ledger.js";