@lukoweb/apitogo 0.2.22 → 0.2.24

package/src/config/v2/portal-profile.ts

@@ -1,88 +1,88 @@
-import type { ResolvedConfigV2 } from "./resolve.js";
-
-/**
- * What the portal build has to do, derived from the resolved config. The generated wrapper (API-20) reads
- * this and nothing else, so "docs only", "console only" and "both" are decided in one place.
- */
-export type PortalProfile = {
-  /** False when `portal.enabled` is false or the config has no portal: nothing is built. */
-  enabled: boolean;
-  docs: {
-    enabled: boolean;
-    provider: "apitogo" | "external";
-    /** Absolute globs of pages APItoGo builds. Empty unless APItoGo hosts the docs. */
-    content: string[];
-    /** Where an external docs site lives; console links point at it. */
-    url?: string;
-  };
-  console: { enabled: boolean };
-  /** Build pipelines the portal needs. A pipeline that is false must not run, not just stay hidden. */
-  pipelines: {
-    /** Markdown and MDX pages, and the navigation made from them. */
-    markdown: boolean;
-    /** OpenAPI processing and the API reference pages. */
-    openapi: boolean;
-    /** Search index; only for docs APItoGo hosts. */
-    search: "pagefind" | "inkeep" | "none";
-  };
-  /** Built modules for the portal, in the module system's terms (`modules.docs`, `modules.userPanel`, ...). */
-  modules: { docs: boolean; userPanel: boolean };
-  /** What a portal whose docs live elsewhere still guarantees, so an external docs site can link to it. */
-  externalDocs?: {
-    url?: string;
-    /** The OpenAPI files the docs site can fetch. */
-    openapiExport: boolean;
-    /** The console answers cross-origin requests from the docs site. */
-    cors: boolean;
-    /** The portal manifest lists console links (sign-in, keys, usage, pricing) for the docs site to use. */
-    consoleLinksInManifest: boolean;
-    /** The console carries the project's theme and name, not APItoGo's. */
-    whiteLabelConsole: boolean;
-  };
-};
-
-const NOT_BUILT: PortalProfile = {
-  enabled: false,
-  docs: { enabled: false, provider: "apitogo", content: [] },
-  console: { enabled: false },
-  pipelines: { markdown: false, openapi: false, search: "none" },
-  modules: { docs: false, userPanel: false },
-};
-
-export function portalProfile(resolved: ResolvedConfigV2): PortalProfile {
-  const portal = resolved.portal;
-  if (!portal?.enabled) return NOT_BUILT;
-
-  const hostsDocs = portal.docs.enabled && portal.docs.provider === "apitogo";
-  const externalDocs =
-    portal.docs.enabled && portal.docs.provider === "external";
-  const gatewayOn = resolved.gateway?.enabled === true;
-
-  return {
-    enabled: true,
-    docs: {
-      enabled: portal.docs.enabled,
-      provider: portal.docs.provider,
-      content: hostsDocs ? portal.docs.content : [],
-      url: externalDocs ? portal.docs.url : undefined,
-    },
-    console: { enabled: portal.console.enabled },
-    pipelines: {
-      markdown: hostsDocs,
-      openapi: hostsDocs && gatewayOn,
-      search: hostsDocs ? portal.search : "none",
-    },
-    modules: { docs: hostsDocs, userPanel: portal.console.enabled },
-    ...(externalDocs
-      ? {
-          externalDocs: {
-            url: portal.docs.url,
-            openapiExport: gatewayOn,
-            cors: portal.console.enabled,
-            consoleLinksInManifest: portal.console.enabled,
-            whiteLabelConsole: portal.console.enabled,
-          },
-        }
-      : {}),
-  };
-}
+import type { ResolvedConfigV2 } from "./resolve.js";
+
+/**
+ * What the portal build has to do, derived from the resolved config. The generated wrapper (API-20) reads
+ * this and nothing else, so "docs only", "console only" and "both" are decided in one place.
+ */
+export type PortalProfile = {
+  /** False when `portal.enabled` is false or the config has no portal: nothing is built. */
+  enabled: boolean;
+  docs: {
+    enabled: boolean;
+    provider: "apitogo" | "external";
+    /** Absolute globs of pages APItoGo builds. Empty unless APItoGo hosts the docs. */
+    content: string[];
+    /** Where an external docs site lives; console links point at it. */
+    url?: string;
+  };
+  console: { enabled: boolean };
+  /** Build pipelines the portal needs. A pipeline that is false must not run, not just stay hidden. */
+  pipelines: {
+    /** Markdown and MDX pages, and the navigation made from them. */
+    markdown: boolean;
+    /** OpenAPI processing and the API reference pages. */
+    openapi: boolean;
+    /** Search index; only for docs APItoGo hosts. */
+    search: "pagefind" | "inkeep" | "none";
+  };
+  /** Built modules for the portal, in the module system's terms (`modules.docs`, `modules.userPanel`, ...). */
+  modules: { docs: boolean; userPanel: boolean };
+  /** What a portal whose docs live elsewhere still guarantees, so an external docs site can link to it. */
+  externalDocs?: {
+    url?: string;
+    /** The OpenAPI files the docs site can fetch. */
+    openapiExport: boolean;
+    /** The console answers cross-origin requests from the docs site. */
+    cors: boolean;
+    /** The portal manifest lists console links (sign-in, keys, usage, pricing) for the docs site to use. */
+    consoleLinksInManifest: boolean;
+    /** The console carries the project's theme and name, not APItoGo's. */
+    whiteLabelConsole: boolean;
+  };
+};
+
+const NOT_BUILT: PortalProfile = {
+  enabled: false,
+  docs: { enabled: false, provider: "apitogo", content: [] },
+  console: { enabled: false },
+  pipelines: { markdown: false, openapi: false, search: "none" },
+  modules: { docs: false, userPanel: false },
+};
+
+export function portalProfile(resolved: ResolvedConfigV2): PortalProfile {
+  const portal = resolved.portal;
+  if (!portal?.enabled) return NOT_BUILT;
+
+  const hostsDocs = portal.docs.enabled && portal.docs.provider === "apitogo";
+  const externalDocs =
+    portal.docs.enabled && portal.docs.provider === "external";
+  const gatewayOn = resolved.gateway?.enabled === true;
+
+  return {
+    enabled: true,
+    docs: {
+      enabled: portal.docs.enabled,
+      provider: portal.docs.provider,
+      content: hostsDocs ? portal.docs.content : [],
+      url: externalDocs ? portal.docs.url : undefined,
+    },
+    console: { enabled: portal.console.enabled },
+    pipelines: {
+      markdown: hostsDocs,
+      openapi: hostsDocs && gatewayOn,
+      search: hostsDocs ? portal.search : "none",
+    },
+    modules: { docs: hostsDocs, userPanel: portal.console.enabled },
+    ...(externalDocs
+      ? {
+          externalDocs: {
+            url: portal.docs.url,
+            openapiExport: gatewayOn,
+            cors: portal.console.enabled,
+            consoleLinksInManifest: portal.console.enabled,
+            whiteLabelConsole: portal.console.enabled,
+          },
+        }
+      : {}),
+  };
+}

package/src/config/v2/resolve.ts

@@ -1,188 +1,188 @@
-import path from "node:path";
-import { layoutRoot, type StatePaths, statePathsFor } from "./paths.js";
-import type { ConfigV2, Layout } from "./schema.js";
-
-export { layoutRoot };
-
-/** A path relative to the config file, made absolute. A leading `!` (negated glob) is preserved. */
-function fromConfig(configDir: string, value: string): string {
-  return value.startsWith("!")
-    ? `!${path.resolve(configDir, value.slice(1))}`
-    : path.resolve(configDir, value);
-}
-
-export type ResolvedPortal = {
-  enabled: boolean;
-  dir: string;
-  name: string;
-  docs: {
-    enabled: boolean;
-    provider: "apitogo" | "external";
-    /** Absolute globs. Empty for an external docs provider. */
-    content: string[];
-    url?: string;
-  };
-  console: { enabled: boolean };
-  theme: string;
-  requireAuth: boolean | { exclude: string[] };
-  search: "pagefind" | "inkeep" | "none";
-};
-
-export type ResolvedGateway = {
-  enabled: boolean;
-  provider: string;
-  origin: NonNullable<ConfigV2["gateway"]>["origin"];
-  /** Absolute paths. */
-  specs: string[];
-  auth?: NonNullable<ConfigV2["gateway"]>["auth"];
-  export?: NonNullable<ConfigV2["gateway"]>["export"];
-  policies: NonNullable<NonNullable<ConfigV2["gateway"]>["policies"]>;
-};
-
-export type ResolvedIdentity = {
-  enabled: boolean;
-  provider: "apitogo" | "oidc";
-  native: boolean;
-  connections: NonNullable<NonNullable<ConfigV2["identity"]>["connections"]>;
-  clients: NonNullable<NonNullable<ConfigV2["identity"]>["clients"]>;
-  issuer?: string;
-  clientId?: string;
-  providerOptions: NonNullable<
-    NonNullable<ConfigV2["identity"]>["providerOptions"]
-  >;
-};
-
-export type ResolvedPlans = {
-  enabled: boolean;
-  /** Absolute path of the plan catalog. */
-  file: string;
-  billing: {
-    provider: "stripe" | "none";
-    apiKey?: string;
-    webhookSecret?: string;
-    successUrl?: string;
-    cancelUrl?: string;
-  };
-};
-
-export type ResolvedConfigV2 = {
-  configPath: string;
-  configDir: string;
-  layout: Layout;
-  /** `<root>` of the layout: where `portal/`, `plans.json` and `apis/` live by default. */
-  root: string;
-  /** Default folder for OpenAPI files created by `init`. */
-  apisDir: string;
-  /** Generated and observed state (`state.json`, `generated/`, `build/`), ignored by git on its own. */
-  state: StatePaths;
-  project: { id?: string; name: string };
-  portal?: ResolvedPortal;
-  gateway?: ResolvedGateway;
-  identity?: ResolvedIdentity;
-  plans?: ResolvedPlans;
-};
-
-/**
- * Applies the documented defaults and makes every path absolute. Defaults for `portal.dir`, `plans.file`
- * and the spec folder derive from `<root>`, so a standalone config can omit them. A section that is present
- * without `enabled` is enabled.
- */
-export function resolveConfigV2(
-  config: ConfigV2,
-  configPath: string,
-): ResolvedConfigV2 {
-  const absoluteConfigPath = path.resolve(configPath);
-  const configDir = path.dirname(absoluteConfigPath);
-  const layout = config.layout ?? "standalone";
-  const root = layoutRoot(configDir, layout);
-  const projectName = config.project?.name ?? path.basename(configDir);
-
-  const resolved: ResolvedConfigV2 = {
-    configPath: absoluteConfigPath,
-    configDir,
-    layout,
-    root,
-    apisDir: path.join(root, "apis"),
-    state: statePathsFor(configDir, layout),
-    project: { id: config.project?.id, name: projectName },
-  };
-
-  const { portal, gateway, identity, plans } = config;
-
-  if (portal) {
-    const dir = portal.dir
-      ? path.resolve(configDir, portal.dir)
-      : path.join(root, "portal");
-    const provider = portal.docs?.provider ?? "apitogo";
-    resolved.portal = {
-      enabled: portal.enabled ?? true,
-      dir,
-      name: portal.name ?? projectName,
-      docs: {
-        enabled: portal.docs?.enabled ?? true,
-        provider,
-        content:
-          provider === "external"
-            ? []
-            : portal.docs?.content
-              ? portal.docs.content.map((glob) => fromConfig(configDir, glob))
-              : [path.join(dir, "pages", "**", "*.{md,mdx}")],
-        url: portal.docs?.url,
-      },
-      console: { enabled: portal.console?.enabled ?? true },
-      theme: portal.theme
-        ? path.resolve(configDir, portal.theme)
-        : path.join(dir, "theme.json"),
-      requireAuth: portal.requireAuth ?? false,
-      search: provider === "external" ? "none" : (portal.search ?? "pagefind"),
-    };
-  }
-
-  if (gateway) {
-    resolved.gateway = {
-      enabled: gateway.enabled ?? true,
-      provider: gateway.provider ?? "apitogo",
-      origin: {
-        ...gateway.origin,
-        source: gateway.origin.source
-          ? path.resolve(configDir, gateway.origin.source)
-          : undefined,
-      },
-      specs: gateway.specs.map((spec) => path.resolve(configDir, spec)),
-      auth: gateway.auth,
-      export: gateway.export,
-      policies: gateway.policies ?? {},
-    };
-  }
-
-  if (identity) {
-    resolved.identity = {
-      enabled: identity.enabled ?? true,
-      provider: identity.provider ?? "apitogo",
-      native: identity.native ?? true,
-      connections: identity.connections ?? [],
-      clients: identity.clients ?? [],
-      issuer: identity.issuer,
-      clientId: identity.clientId,
-      providerOptions: identity.providerOptions ?? {},
-    };
-  }
-
-  if (plans) {
-    resolved.plans = {
-      enabled: plans.enabled ?? true,
-      file: plans.file
-        ? path.resolve(configDir, plans.file)
-        : path.join(root, "plans.json"),
-      billing: {
-        provider: plans.billing?.provider ?? "stripe",
-        apiKey: plans.billing?.apiKey,
-        webhookSecret: plans.billing?.webhookSecret,
-        successUrl: plans.billing?.successUrl,
-        cancelUrl: plans.billing?.cancelUrl,
-      },
-    };
-  }
-
-  return resolved;
-}
+import path from "node:path";
+import { layoutRoot, type StatePaths, statePathsFor } from "./paths.js";
+import type { ConfigV2, Layout } from "./schema.js";
+
+export { layoutRoot };
+
+/** A path relative to the config file, made absolute. A leading `!` (negated glob) is preserved. */
+function fromConfig(configDir: string, value: string): string {
+  return value.startsWith("!")
+    ? `!${path.resolve(configDir, value.slice(1))}`
+    : path.resolve(configDir, value);
+}
+
+export type ResolvedPortal = {
+  enabled: boolean;
+  dir: string;
+  name: string;
+  docs: {
+    enabled: boolean;
+    provider: "apitogo" | "external";
+    /** Absolute globs. Empty for an external docs provider. */
+    content: string[];
+    url?: string;
+  };
+  console: { enabled: boolean };
+  theme: string;
+  requireAuth: boolean | { exclude: string[] };
+  search: "pagefind" | "inkeep" | "none";
+};
+
+export type ResolvedGateway = {
+  enabled: boolean;
+  provider: string;
+  origin: NonNullable<ConfigV2["gateway"]>["origin"];
+  /** Absolute paths. */
+  specs: string[];
+  auth?: NonNullable<ConfigV2["gateway"]>["auth"];
+  export?: NonNullable<ConfigV2["gateway"]>["export"];
+  policies: NonNullable<NonNullable<ConfigV2["gateway"]>["policies"]>;
+};
+
+export type ResolvedIdentity = {
+  enabled: boolean;
+  provider: "apitogo" | "oidc";
+  native: boolean;
+  connections: NonNullable<NonNullable<ConfigV2["identity"]>["connections"]>;
+  clients: NonNullable<NonNullable<ConfigV2["identity"]>["clients"]>;
+  issuer?: string;
+  clientId?: string;
+  providerOptions: NonNullable<
+    NonNullable<ConfigV2["identity"]>["providerOptions"]
+  >;
+};
+
+export type ResolvedPlans = {
+  enabled: boolean;
+  /** Absolute path of the plan catalog. */
+  file: string;
+  billing: {
+    provider: "stripe" | "none";
+    apiKey?: string;
+    webhookSecret?: string;
+    successUrl?: string;
+    cancelUrl?: string;
+  };
+};
+
+export type ResolvedConfigV2 = {
+  configPath: string;
+  configDir: string;
+  layout: Layout;
+  /** `<root>` of the layout: where `portal/`, `plans.json` and `apis/` live by default. */
+  root: string;
+  /** Default folder for OpenAPI files created by `init`. */
+  apisDir: string;
+  /** Generated and observed state (`state.json`, `generated/`, `build/`), ignored by git on its own. */
+  state: StatePaths;
+  project: { id?: string; name: string };
+  portal?: ResolvedPortal;
+  gateway?: ResolvedGateway;
+  identity?: ResolvedIdentity;
+  plans?: ResolvedPlans;
+};
+
+/**
+ * Applies the documented defaults and makes every path absolute. Defaults for `portal.dir`, `plans.file`
+ * and the spec folder derive from `<root>`, so a standalone config can omit them. A section that is present
+ * without `enabled` is enabled.
+ */
+export function resolveConfigV2(
+  config: ConfigV2,
+  configPath: string,
+): ResolvedConfigV2 {
+  const absoluteConfigPath = path.resolve(configPath);
+  const configDir = path.dirname(absoluteConfigPath);
+  const layout = config.layout ?? "standalone";
+  const root = layoutRoot(configDir, layout);
+  const projectName = config.project?.name ?? path.basename(configDir);
+
+  const resolved: ResolvedConfigV2 = {
+    configPath: absoluteConfigPath,
+    configDir,
+    layout,
+    root,
+    apisDir: path.join(root, "apis"),
+    state: statePathsFor(configDir, layout),
+    project: { id: config.project?.id, name: projectName },
+  };
+
+  const { portal, gateway, identity, plans } = config;
+
+  if (portal) {
+    const dir = portal.dir
+      ? path.resolve(configDir, portal.dir)
+      : path.join(root, "portal");
+    const provider = portal.docs?.provider ?? "apitogo";
+    resolved.portal = {
+      enabled: portal.enabled ?? true,
+      dir,
+      name: portal.name ?? projectName,
+      docs: {
+        enabled: portal.docs?.enabled ?? true,
+        provider,
+        content:
+          provider === "external"
+            ? []
+            : portal.docs?.content
+              ? portal.docs.content.map((glob) => fromConfig(configDir, glob))
+              : [path.join(dir, "pages", "**", "*.{md,mdx}")],
+        url: portal.docs?.url,
+      },
+      console: { enabled: portal.console?.enabled ?? true },
+      theme: portal.theme
+        ? path.resolve(configDir, portal.theme)
+        : path.join(dir, "theme.json"),
+      requireAuth: portal.requireAuth ?? false,
+      search: provider === "external" ? "none" : (portal.search ?? "pagefind"),
+    };
+  }
+
+  if (gateway) {
+    resolved.gateway = {
+      enabled: gateway.enabled ?? true,
+      provider: gateway.provider ?? "apitogo",
+      origin: {
+        ...gateway.origin,
+        source: gateway.origin.source
+          ? path.resolve(configDir, gateway.origin.source)
+          : undefined,
+      },
+      specs: gateway.specs.map((spec) => path.resolve(configDir, spec)),
+      auth: gateway.auth,
+      export: gateway.export,
+      policies: gateway.policies ?? {},
+    };
+  }
+
+  if (identity) {
+    resolved.identity = {
+      enabled: identity.enabled ?? true,
+      provider: identity.provider ?? "apitogo",
+      native: identity.native ?? true,
+      connections: identity.connections ?? [],
+      clients: identity.clients ?? [],
+      issuer: identity.issuer,
+      clientId: identity.clientId,
+      providerOptions: identity.providerOptions ?? {},
+    };
+  }
+
+  if (plans) {
+    resolved.plans = {
+      enabled: plans.enabled ?? true,
+      file: plans.file
+        ? path.resolve(configDir, plans.file)
+        : path.join(root, "plans.json"),
+      billing: {
+        provider: plans.billing?.provider ?? "stripe",
+        apiKey: plans.billing?.apiKey,
+        webhookSecret: plans.billing?.webhookSecret,
+        successUrl: plans.billing?.successUrl,
+        cancelUrl: plans.billing?.cancelUrl,
+      },
+    };
+  }
+
+  return resolved;
+}