@lukoweb/apitogo 0.2.22 → 0.2.24

package/src/config/v2/gateway-request.ts

@@ -1,123 +1,123 @@
-import type { ResolvedGateway } from "./resolve.js";
-
-/**
- * The body of `PUT /gateway/config`: the wanted state of the gateway (Gateway design doc, 8.9 and 8.12).
- * Only names of secrets are in it, never values.
- */
-export type GatewayConfigBody = {
-  provider: string;
-  origin: {
-    mode: "managed" | "proxy";
-    url?: string;
-    healthPath?: string;
-    timeoutSeconds?: number;
-    auth?: { type: string; name?: string; value?: string };
-  };
-  auth?: {
-    mode: string;
-    metadataUrl?: string;
-    issuers?: string[];
-    audiences?: string[];
-  };
-  export?: { access?: string };
-  /** Sites of this project that call the gateway from a browser. The platform adds them to the allowed origins. */
-  corsDerived?: DerivedCorsSite[];
-  policies?: {
-    access?: {
-      jwt?: boolean;
-      apiKey?: boolean;
-      apiKeyHeader?: string;
-      bindKeyToToken?: boolean;
-    };
-    rateLimit?: { calls: number; periodSeconds: number; scope?: string };
-    quota?: { calls: number; periodDays: number; scope?: string };
-    cors?: string[];
-    operations?: { public?: string[]; deny?: string[] };
-  };
-};
-
-export type DerivedCorsSite = { origin: string; source: "portal" | "docs" };
-
-/**
- * The browser origins of this project's own sites: the portal (from `services.json`) and an external docs site
- * (from the config). Only the origin is kept, never a path. Sorted, so the same sites always give the same body.
- */
-export function derivedCorsSites(sites: {
-  portalUrl?: string;
-  docsUrl?: string;
-}): DerivedCorsSite[] {
-  const originOf = (url?: string) => {
-    if (!url) return undefined;
-    try {
-      const { protocol, origin } = new URL(url);
-      return protocol === "https:" ? origin : undefined;
-    } catch {
-      return undefined;
-    }
-  };
-  const found = [
-    { origin: originOf(sites.docsUrl), source: "docs" as const },
-    { origin: originOf(sites.portalUrl), source: "portal" as const },
-  ].flatMap((site) => (site.origin ? [{ ...site, origin: site.origin }] : []));
-  const seen = new Set<string>();
-  return found
-    .filter((site) => !seen.has(site.origin) && seen.add(site.origin))
-    .sort((a, b) => (a.origin < b.origin ? -1 : a.origin > b.origin ? 1 : 0));
-}
-
-const defined = <T extends Record<string, unknown>>(value: T): T =>
-  Object.fromEntries(
-    Object.entries(value).filter(([, item]) => item !== undefined),
-  ) as T;
-
-/**
- * Turns the resolved `gateway` section into the request body. The spec files are not part of it: they are uploaded
- * with `PUT /gateway/spec`. Fields the platform fills with defaults are left out when the config does not set them,
- * so the same config always gives the same body (and the same hash).
- */
-export function gatewayConfigBody(
-  gateway: ResolvedGateway,
-  derivedCors: DerivedCorsSite[] = [],
-): GatewayConfigBody {
-  const { origin, auth, policies } = gateway;
-  const body: GatewayConfigBody = {
-    provider: gateway.provider,
-    origin: defined({
-      mode: origin.mode,
-      url: origin.url,
-      healthPath: origin.healthPath,
-      timeoutSeconds: origin.timeoutSeconds,
-      auth: origin.auth ? defined({ ...origin.auth }) : undefined,
-    }),
-  };
-  if (auth) body.auth = defined({ ...auth });
-  if (gateway.export) body.export = defined({ ...gateway.export });
-  if (derivedCors.length > 0) body.corsDerived = derivedCors;
-  if (Object.keys(policies).length > 0) {
-    body.policies = defined({
-      access: policies.access ? defined({ ...policies.access }) : undefined,
-      rateLimit: policies.rateLimit
-        ? defined({ ...policies.rateLimit })
-        : undefined,
-      quota: policies.quota ? defined({ ...policies.quota }) : undefined,
-      cors: policies.cors,
-      operations: policies.operations
-        ? defined({ ...policies.operations })
-        : undefined,
-    });
-  }
-  return body;
-}
-
-/** Stable JSON text of a value: object keys sorted, so equal content gives equal text. */
-export function stableJson(value: unknown): string {
-  return JSON.stringify(value, (_key, item) =>
-    item && typeof item === "object" && !Array.isArray(item)
-      ? Object.fromEntries(
-          Object.entries(item as Record<string, unknown>).sort(([a], [b]) =>
-            a < b ? -1 : a > b ? 1 : 0,
-          ),
-        )
-      : item,
-  );
-}
+import type { ResolvedGateway } from "./resolve.js";
+
+/**
+ * The body of `PUT /gateway/config`: the wanted state of the gateway (Gateway design doc, 8.9 and 8.12).
+ * Only names of secrets are in it, never values.
+ */
+export type GatewayConfigBody = {
+  provider: string;
+  origin: {
+    mode: "managed" | "proxy";
+    url?: string;
+    healthPath?: string;
+    timeoutSeconds?: number;
+    auth?: { type: string; name?: string; value?: string };
+  };
+  auth?: {
+    mode: string;
+    metadataUrl?: string;
+    issuers?: string[];
+    audiences?: string[];
+  };
+  export?: { access?: string };
+  /** Sites of this project that call the gateway from a browser. The platform adds them to the allowed origins. */
+  corsDerived?: DerivedCorsSite[];
+  policies?: {
+    access?: {
+      jwt?: boolean;
+      apiKey?: boolean;
+      apiKeyHeader?: string;
+      bindKeyToToken?: boolean;
+    };
+    rateLimit?: { calls: number; periodSeconds: number; scope?: string };
+    quota?: { calls: number; periodDays: number; scope?: string };
+    cors?: string[];
+    operations?: { public?: string[]; deny?: string[] };
+  };
+};
+
+export type DerivedCorsSite = { origin: string; source: "portal" | "docs" };
+
+/**
+ * The browser origins of this project's own sites: the portal (from `services.json`) and an external docs site
+ * (from the config). Only the origin is kept, never a path. Sorted, so the same sites always give the same body.
+ */
+export function derivedCorsSites(sites: {
+  portalUrl?: string;
+  docsUrl?: string;
+}): DerivedCorsSite[] {
+  const originOf = (url?: string) => {
+    if (!url) return undefined;
+    try {
+      const { protocol, origin } = new URL(url);
+      return protocol === "https:" ? origin : undefined;
+    } catch {
+      return undefined;
+    }
+  };
+  const found = [
+    { origin: originOf(sites.docsUrl), source: "docs" as const },
+    { origin: originOf(sites.portalUrl), source: "portal" as const },
+  ].flatMap((site) => (site.origin ? [{ ...site, origin: site.origin }] : []));
+  const seen = new Set<string>();
+  return found
+    .filter((site) => !seen.has(site.origin) && seen.add(site.origin))
+    .sort((a, b) => (a.origin < b.origin ? -1 : a.origin > b.origin ? 1 : 0));
+}
+
+const defined = <T extends Record<string, unknown>>(value: T): T =>
+  Object.fromEntries(
+    Object.entries(value).filter(([, item]) => item !== undefined),
+  ) as T;
+
+/**
+ * Turns the resolved `gateway` section into the request body. The spec files are not part of it: they are uploaded
+ * with `PUT /gateway/spec`. Fields the platform fills with defaults are left out when the config does not set them,
+ * so the same config always gives the same body (and the same hash).
+ */
+export function gatewayConfigBody(
+  gateway: ResolvedGateway,
+  derivedCors: DerivedCorsSite[] = [],
+): GatewayConfigBody {
+  const { origin, auth, policies } = gateway;
+  const body: GatewayConfigBody = {
+    provider: gateway.provider,
+    origin: defined({
+      mode: origin.mode,
+      url: origin.url,
+      healthPath: origin.healthPath,
+      timeoutSeconds: origin.timeoutSeconds,
+      auth: origin.auth ? defined({ ...origin.auth }) : undefined,
+    }),
+  };
+  if (auth) body.auth = defined({ ...auth });
+  if (gateway.export) body.export = defined({ ...gateway.export });
+  if (derivedCors.length > 0) body.corsDerived = derivedCors;
+  if (Object.keys(policies).length > 0) {
+    body.policies = defined({
+      access: policies.access ? defined({ ...policies.access }) : undefined,
+      rateLimit: policies.rateLimit
+        ? defined({ ...policies.rateLimit })
+        : undefined,
+      quota: policies.quota ? defined({ ...policies.quota }) : undefined,
+      cors: policies.cors,
+      operations: policies.operations
+        ? defined({ ...policies.operations })
+        : undefined,
+    });
+  }
+  return body;
+}
+
+/** Stable JSON text of a value: object keys sorted, so equal content gives equal text. */
+export function stableJson(value: unknown): string {
+  return JSON.stringify(value, (_key, item) =>
+    item && typeof item === "object" && !Array.isArray(item)
+      ? Object.fromEntries(
+          Object.entries(item as Record<string, unknown>).sort(([a], [b]) =>
+            a < b ? -1 : a > b ? 1 : 0,
+          ),
+        )
+      : item,
+  );
+}

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

@@ -1,98 +1,98 @@
-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";
+
+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;
+}