@lukoweb/apitogo 0.2.58 → 0.2.60

package/dist/cli/cli.js

@@ -5931,11 +5931,23 @@ var PortalSchema = z.strictObject({
   landing: path3.optional(),
   /** The footer: a React component file shown under every page except the console's (API-129). */
   footer: path3.optional(),
-  /** The logo in the portal header: one image, or one per color scheme (API-129). */
-  logo: z.union([
-    path3,
-    z.strictObject({ light: path3, dark: path3, alt: z.string().optional() })
-  ]).optional(),
+  /**
+   * The logo in the portal header: one image, or one per color scheme (API-129). `dark` is optional; without it the
+   * light image is used in both.
+   */
+  logo: z.union(
+    [
+      path3,
+      z.strictObject({
+        light: path3,
+        dark: path3.optional(),
+        alt: z.string().optional()
+      })
+    ],
+    {
+      error: 'must be an image path or https address, or { "light": "...", "dark": "...", "alt": "..." } (dark and alt are optional)'
+    }
+  ).optional(),
   requireAuth: z.union([z.boolean(), z.strictObject({ exclude: pathList })], {
     error: 'must be true, false or { "exclude": ["/route", ...] }'
   }).optional(),
@@ -6507,7 +6519,11 @@ function resolveConfigV2(config2, configPath) {
           dark: logoSource(configDir, portal.logo)
         } : {
           light: logoSource(configDir, portal.logo.light),
-          dark: logoSource(configDir, portal.logo.dark),
+          // Without a dark image, the light one is used in both color schemes.
+          dark: logoSource(
+            configDir,
+            portal.logo.dark ?? portal.logo.light
+          ),
           ...portal.logo.alt ? { alt: portal.logo.alt } : {}
         }
       } : {},
@@ -7472,6 +7488,8 @@ var ServiceManifestSchema = z3.looseObject({
   services: z3.looseObject({
     portal: z3.looseObject({
       url: z3.string().optional(),
+      /** The portal's custom domain once it is ready, such as `https://docs.acme.com` (API-130). */
+      customDomain: z3.string().optional(),
       docs: z3.looseObject({ provider: z3.string(), url: z3.string().optional() }).optional(),
       console: z3.looseObject({ links: z3.record(z3.string(), z3.string()).optional() }).optional()
     }).optional(),
@@ -7643,6 +7661,20 @@ function withPortalEntry(existing, info) {
     }
   };
 }
+function withPortalCustomDomain(existing, customDomain) {
+  if (!existing) return void 0;
+  const portal = existing.services.portal;
+  if (portal?.customDomain === customDomain) return void 0;
+  if (!portal && customDomain === void 0) return void 0;
+  const { customDomain: _previous, ...rest } = portal ?? {};
+  return {
+    ...existing,
+    services: {
+      ...existing.services,
+      portal: customDomain === void 0 ? rest : { ...rest, customDomain }
+    }
+  };
+}
 function withGatewayEntry(existing, info) {
   const base = existing ?? parseManifest({
     schemaVersion: SUPPORTED_MANIFEST_SCHEMA,
@@ -7922,7 +7954,8 @@ function derivedCorsSites(sites) {
   };
   const found = [
     { origin: originOf(sites.docsUrl), source: "docs" },
-    { origin: originOf(sites.portalUrl), source: "portal" }
+    { origin: originOf(sites.portalUrl), source: "portal" },
+    { origin: originOf(sites.portalCustomDomain), source: "portal" }
   ].flatMap((site) => site.origin ? [{ ...site, origin: site.origin }] : []);
   const seen = /* @__PURE__ */ new Set();
   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);
@@ -8234,6 +8267,9 @@ function planPortal(profile, manifest) {
     preview: manifest.preview === true
   };
   if (!profile.enabled) return plan2;
+  if (profile.pipelines.search === "pagefind") plan2.search = "pagefind";
+  else if (profile.pipelines.search === "inkeep")
+    skip("search", "inkeep needs keys that portal.search cannot hold yet");
   if (profile.pipelines.openapi) {
     if (!gateway) skip("api reference", "services.json has no gateway entry");
     else if (!serviceReady(gateway))
@@ -8358,6 +8394,7 @@ function buildSiteConfig(resolved, plan2, theme, extras = {}) {
         )
       }
     } : {},
+    ...plan2.search ? { search: { type: plan2.search } } : {},
     ...plan2.apiReference ? {
       apis: [
         {
@@ -11166,7 +11203,7 @@ import {
 // package.json
 var package_default = {
   name: "@lukoweb/apitogo",
-  version: "0.2.58",
+  version: "0.2.60",
   type: "module",
   sideEffects: [
     "**/*.css",
@@ -16589,6 +16626,7 @@ async function addGatewayOnlineRules(report, resolved, args, deps) {
     deps.gateway,
     derivedCorsSites({
       portalUrl: manifest?.services.portal?.url,
+      portalCustomDomain: manifest?.services.portal?.customDomain,
       docsUrl: resolved.portal?.docs.provider === "external" ? resolved.portal.docs.url : void 0
     })
   );
@@ -27172,6 +27210,22 @@ init_invariant();
 import { createHash as createHash4 } from "node:crypto";
 import { readFile as readFile28 } from "node:fs/promises";
 init_invariant();
+
+// src/cli/deploy/custom-domain.ts
+async function readyCustomDomainOrigin(client, projectId) {
+  if (!client.getCustomDomain) return void 0;
+  let domain;
+  try {
+    domain = await client.getCustomDomain(projectId);
+  } catch {
+    return void 0;
+  }
+  const hostname = domain.hostname?.trim().toLowerCase();
+  if (domain.status?.toLowerCase() !== "ready" || !hostname) return null;
+  return `https://${hostname}`;
+}
+
+// src/cli/deploy/gateway.ts
 var GatewayDeployError = class extends ApitogoError {
   constructor(code, message, developerHint) {
     super(message, { developerHint, title: "Cannot deploy the gateway" });
@@ -27217,6 +27271,15 @@ async function readSpec(gateway) {
     );
   }
 }
+async function recordPortalCustomDomain(resolved, projectId, client) {
+  const origin = await readyCustomDomainOrigin(client, projectId);
+  if (origin === void 0) return;
+  const updated = withPortalCustomDomain(
+    await readManifest(resolved.state),
+    origin ?? void 0
+  );
+  if (updated) await writeManifest(resolved.state, updated);
+}
 async function gatewayDeployInputs(resolved, projectId) {
   const gateway = resolved.gateway;
   if (!gateway) throw new Error("gateway is not configured");
@@ -27226,6 +27289,7 @@ async function gatewayDeployInputs(resolved, projectId) {
     gateway,
     derivedCorsSites({
       portalUrl: manifest?.services.portal?.url,
+      portalCustomDomain: manifest?.services.portal?.customDomain,
       docsUrl: resolved.portal?.docs.provider === "external" ? resolved.portal.docs.url : void 0
     })
   );
@@ -27314,6 +27378,7 @@ function rejected(what, error) {
   throw error;
 }
 async function deployGateway(resolved, projectId, deps, options = {}) {
+  await recordPortalCustomDomain(resolved, projectId, deps.client);
   const { gateway, spec, body, specHash, configHash } = await gatewayDeployInputs(resolved, projectId);
   assertDeployable(gateway);
   const backend = await backendDeployInputs(gateway, projectId);
@@ -28130,16 +28195,9 @@ function identityBrandingBody(resolved) {
 var IDENTITY_BRANDING_STEP = "branding";
 var IDENTITY_PORTAL_ADDRESS_STEP = "portal-address";
 async function customDomainCallbackOf(client, projectId, portalUrl) {
-  if (!client.getCustomDomain) return void 0;
-  let domain;
-  try {
-    domain = await client.getCustomDomain(projectId);
-  } catch {
-    return void 0;
-  }
-  const hostname = domain.hostname?.trim().toLowerCase();
-  if (domain.status?.toLowerCase() !== "ready" || !hostname) return void 0;
-  const callback = `https://${hostname}${PORTAL_CALLBACK_PATH}`;
+  const origin = await readyCustomDomainOrigin(client, projectId);
+  if (!origin) return void 0;
+  const callback = `${origin}${PORTAL_CALLBACK_PATH}`;
   const current = `${portalUrl.replace(/\/+$/, "")}${PORTAL_CALLBACK_PATH}`;
   return callback.toLowerCase() === current.toLowerCase() ? void 0 : callback;
 }

package/docs/configuration/portal.md

@@ -79,7 +79,8 @@ An image in the portal's `public/` folder, or an `https://` address:
 "logo": "apitogo/portal/public/logo.svg"
 ```
 
-One image per color scheme, with the text read out by screen readers:
+One image per color scheme, with the text read out by screen readers. `dark` and `alt` are optional;
+without `dark` the light image is shown in both:
 
 ```json
 "logo": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lukoweb/apitogo",
-  "version": "0.2.58",
+  "version": "0.2.60",
   "type": "module",
   "sideEffects": [
     "**/*.css",

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

@@ -39,11 +39,13 @@ export type GatewayConfigBody = {
 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.
+ * The browser origins of this project's own sites: the portal and its custom domain (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;
+  /** The portal's custom domain, once it is ready (API-130). */
+  portalCustomDomain?: string;
   docsUrl?: string;
 }): DerivedCorsSite[] {
   const originOf = (url?: string) => {
@@ -58,6 +60,7 @@ export function derivedCorsSites(sites: {
   const found = [
     { origin: originOf(sites.docsUrl), source: "docs" as const },
     { origin: originOf(sites.portalUrl), source: "portal" as const },
+    { origin: originOf(sites.portalCustomDomain), source: "portal" as const },
   ].flatMap((site) => (site.origin ? [{ ...site, origin: site.origin }] : []));
   const seen = new Set<string>();
   return found

package/src/config/v2/index.ts

@@ -70,6 +70,7 @@ export {
   withGatewayEntry,
   withIdentityEntry,
   withPlansEntry,
+  withPortalCustomDomain,
   withPortalEntry,
   writeManifest,
 } from "./manifest.js";

package/src/config/v2/manifest.ts

@@ -29,6 +29,8 @@ const ServiceManifestSchema = z.looseObject({
       portal: z
         .looseObject({
           url: z.string().optional(),
+          /** The portal's custom domain once it is ready, such as `https://docs.acme.com` (API-130). */
+          customDomain: z.string().optional(),
           docs: z
             .looseObject({ provider: z.string(), url: z.string().optional() })
             .optional(),
@@ -291,6 +293,29 @@ export function withPortalEntry(
   };
 }
 
+/**
+ * Records the portal's custom domain (an https origin), or removes it when undefined (API-130). The gateway lets the
+ * browser call it from there, and `plan` reads it from here, so it agrees with deploy without asking the platform.
+ * Returns undefined when nothing changes, so an unchanged deploy leaves the file (and the portal's build hash) alone.
+ */
+export function withPortalCustomDomain(
+  existing: ServiceManifest | undefined,
+  customDomain: string | undefined,
+): ServiceManifest | undefined {
+  if (!existing) return undefined;
+  const portal = existing.services.portal;
+  if (portal?.customDomain === customDomain) return undefined;
+  if (!portal && customDomain === undefined) return undefined;
+  const { customDomain: _previous, ...rest } = portal ?? {};
+  return {
+    ...existing,
+    services: {
+      ...existing.services,
+      portal: customDomain === undefined ? rest : { ...rest, customDomain },
+    },
+  };
+}
+
 /**
  * Adds the gateway entry a gateway deploy learned. Only public values: the base URL and what the platform says the
  * gateway can do. Entries of other services are kept as they are.

package/src/config/v2/resolve.ts

@@ -169,7 +169,11 @@ export function resolveConfigV2(
                   }
                 : {
                     light: logoSource(configDir, portal.logo.light),
-                    dark: logoSource(configDir, portal.logo.dark),
+                    // Without a dark image, the light one is used in both color schemes.
+                    dark: logoSource(
+                      configDir,
+                      portal.logo.dark ?? portal.logo.light,
+                    ),
                     ...(portal.logo.alt ? { alt: portal.logo.alt } : {}),
                   },
           }

package/src/config/v2/schema.ts

@@ -49,12 +49,25 @@ export const PortalSchema = z.strictObject({
   landing: path.optional(),
   /** The footer: a React component file shown under every page except the console's (API-129). */
   footer: path.optional(),
-  /** The logo in the portal header: one image, or one per color scheme (API-129). */
+  /**
+   * The logo in the portal header: one image, or one per color scheme (API-129). `dark` is optional; without it the
+   * light image is used in both.
+   */
   logo: z
-    .union([
-      path,
-      z.strictObject({ light: path, dark: path, alt: z.string().optional() }),
-    ])
+    .union(
+      [
+        path,
+        z.strictObject({
+          light: path,
+          dark: path.optional(),
+          alt: z.string().optional(),
+        }),
+      ],
+      {
+        error:
+          'must be an image path or https address, or { "light": "...", "dark": "...", "alt": "..." } (dark and alt are optional)',
+      },
+    )
     .optional(),
   requireAuth: z
     .union([z.boolean(), z.strictObject({ exclude: pathList })], {

package/src/config/v2/wrapper.ts

@@ -71,6 +71,8 @@ const PLANS_CONSOLE_CAPABILITIES = [
 export type PortalPlan = {
   /** Docs pages, navigation and search APItoGo builds. */
   docs: boolean;
+  /** The search box the site shows; only for docs APItoGo hosts. Absent: the site has no search. */
+  search?: "pagefind";
   /** OpenAPI reference pages and playground, built from the gateway's OpenAPI file. */
   apiReference: boolean;
   /** Where the reference points its calls, and the header of the API key; set when `apiReference` is true. */
@@ -215,6 +217,12 @@ export function planPortal(
 
   if (!profile.enabled) return plan;
 
+  // The build already writes the Pagefind index for hosted docs; the site shows the search box only when its config
+  // names the search. Inkeep needs keys that `portal.search` cannot carry yet, so it is left out, not half-registered.
+  if (profile.pipelines.search === "pagefind") plan.search = "pagefind";
+  else if (profile.pipelines.search === "inkeep")
+    skip("search", "inkeep needs keys that portal.search cannot hold yet");
+
   // The API page is built from the gateway's OpenAPI file and calls the gateway, so it needs the gateway's address.
   if (profile.pipelines.openapi) {
     if (!gateway) skip("api reference", "services.json has no gateway entry");
@@ -390,6 +398,7 @@ export function buildSiteConfig(
           },
         }
       : {}),
+    ...(plan.search ? { search: { type: plan.search } } : {}),
     ...(plan.apiReference
       ? {
           apis: [