@warlock.js/sitemap 5.15.0 → 5.16.0

package/esm/sitemap-connector.mjs

@@ -1,117 +0,0 @@
-import { collectSitemapEntries, mergeSitemapEntries, withDefaults } from "./collect-entries.mjs";
-import { describeUnresolvedDynamicRoutes } from "./diagnostic.mjs";
-import { resolveOrigin } from "./url.mjs";
-import { buildSitemapXml } from "./xml.mjs";
-
-//#region ../sitemap/src/sitemap-connector.ts
-/** Default path when `src/config/sitemap.ts` does not set one. */
-const DEFAULT_SITEMAP_PATH = "/sitemap.xml";
-/**
-* Boots after the HTTP connector (`ConnectorPriority.HTTP` is `5`) and after
-* web (`5.5`, `web-connector-factory.ts`) — the route it registers has to
-* land on the same router web's pages already share, and `listRoutablePages`
-* only has a page graph to read once web has scanned it.
-*/
-const SITEMAP_CONNECTOR_PRIORITY = 5.6;
-/**
-* Raised at `boot()` when the sitemap is enabled but has no way to produce
-* entries: `@warlock.js/web` is not installed, so there is no page registry
-* for `listRoutablePages()` to read, AND no `entries` option was supplied.
-* Refuses to boot rather than registering a route that would silently serve
-* an empty `<urlset>` — the same reasoning as {@link MissingPublicUrlError}:
-* a sitemap that looks complete while producing nothing is worse than one
-* that never started.
-*/
-var NoPageRegistryError = class extends Error {
-	constructor() {
-		super("Sitemap is enabled but has no source of entries: `@warlock.js/web` is not installed, so there is no page registry to read, and no `entries` option was supplied either. Fix this by installing `@warlock.js/web`, or by passing `sitemapConnector({ entries: async () => [...] })` with your own supplier.");
-		this.name = "NoPageRegistryError";
-	}
-};
-/** Adapts one `listRoutablePages()` result into the package's own minimal `RoutablePage` shape. */
-function toRoutablePage(page) {
-	const metadata = page.metadata;
-	const robots = metadata !== null && typeof metadata === "object" && "robots" in metadata ? metadata.robots : void 0;
-	return {
-		routeName: page.routeName,
-		routePath: page.routePath,
-		robots: typeof robots === "string" ? robots : void 0,
-		sitemap: page.sitemap
-	};
-}
-/**
-* Construct the sitemap connector.
-*
-* At `boot()`: reads the `sitemap` config (a no-op when `enabled` is not
-* `true`), resolves the public origin ONCE — failing loud via
-* {@link resolveOrigin}'s {@link MissingPublicUrlError} rather than falling
-* back to a request-derived host — and registers `GET <config.path>`.
-*
-* The route itself re-reads the page graph on every request via
-* `listRoutablePages()`, not once at boot: the registry can change under
-* `warlock dev`, and a sitemap that only reflects the app's shape at the
-* moment it booted is stale in exactly the way that made `2ede40cf`-class
-* defects expensive.
-*
-* @example
-* // warlock.config.ts
-* import { sitemapConnector } from "@warlock.js/sitemap";
-*
-* export default defineConfig({ connectors: [sitemapConnector()] });
-*/
-function sitemapConnector(options = {}) {
-	let active = false;
-	const connector = {
-		name: "sitemap",
-		priority: SITEMAP_CONNECTOR_PRIORITY,
-		lifecyclePhase: "late",
-		isActive: () => active,
-		async boot() {
-			const { config, router } = await import("@warlock.js/core");
-			const sitemapConfig = options.config ?? config.get("sitemap");
-			if (!sitemapConfig?.enabled) return;
-			const origin = resolveOrigin({
-				publicUrl: config.get("app")?.publicUrl,
-				env: process.env
-			});
-			const path = sitemapConfig.path || "/sitemap.xml";
-			let listRoutablePages;
-			try {
-				({listRoutablePages} = await import("@warlock.js/web/build"));
-			} catch {
-				listRoutablePages = void 0;
-			}
-			if (!listRoutablePages && !options.entries) throw new NoPageRegistryError();
-			router.get(path, async ({ response }) => {
-				const { entries: pageEntries, unresolvedDynamicRoutes } = await collectSitemapEntries(listRoutablePages ? (await listRoutablePages({ appRoot: process.cwd() })).map(toRoutablePage) : [], { defaults: sitemapConfig.defaults });
-				const entries = mergeSitemapEntries(pageEntries, options.entries ? (await options.entries()).map((entry) => withDefaults(entry, sitemapConfig.defaults)) : []);
-				if (process.env.NODE_ENV !== "production") {
-					const diagnostic = describeUnresolvedDynamicRoutes(unresolvedDynamicRoutes);
-					if (diagnostic) console.warn(diagnostic);
-				}
-				const xml = buildSitemapXml(entries, origin);
-				return response.setContentType("application/xml").send(xml);
-			});
-			active = true;
-		},
-		async start() {},
-		async restart() {
-			await connector.shutdown();
-			await connector.boot();
-		},
-		async shutdown() {
-			active = false;
-		},
-		shouldRestart(changedFiles) {
-			return changedFiles.some((file) => {
-				const normalized = file.replace(/\\/g, "/");
-				return normalized === "src/config/sitemap.ts" || normalized.endsWith("/src/config/sitemap.ts");
-			});
-		}
-	};
-	return connector;
-}
-
-//#endregion
-export { DEFAULT_SITEMAP_PATH, NoPageRegistryError, SITEMAP_CONNECTOR_PRIORITY, sitemapConnector };
-//# sourceMappingURL=sitemap-connector.mjs.map

package/esm/sitemap-connector.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sitemap-connector.mjs","names":[],"sources":["../../../../../../sitemap/src/sitemap-connector.ts"],"sourcesContent":["/**\n * `sitemapConnector()` — the ONE thing `warlock.config.ts` imports from\n * `@warlock.js/sitemap`, and the connector `warlock add sitemap` registers.\n *\n * Deliberately a plain object with TYPE-ONLY imports from core, same\n * reasoning as `queueConnector()`/`webConnector()`: the config file that\n * constructs it must not drag core's runtime graph in at config-load time.\n * `@warlock.js/core` and `@warlock.js/web` are imported lazily, inside\n * `boot()`, where the app has already loaded both.\n */\nimport type { Connector, ConnectorLifecyclePhase, HttpContext } from \"@warlock.js/core\";\nimport { collectSitemapEntries, mergeSitemapEntries, withDefaults } from \"./collect-entries\";\nimport { describeUnresolvedDynamicRoutes } from \"./diagnostic\";\nimport type { RoutablePage } from \"./routable-page\";\nimport type { SitemapConfig, SitemapEntries } from \"./types\";\nimport { resolveOrigin } from \"./url\";\nimport { buildSitemapXml } from \"./xml\";\n\n/** Default path when `src/config/sitemap.ts` does not set one. */\nexport const DEFAULT_SITEMAP_PATH = \"/sitemap.xml\";\n\n/**\n * Boots after the HTTP connector (`ConnectorPriority.HTTP` is `5`) and after\n * web (`5.5`, `web-connector-factory.ts`) — the route it registers has to\n * land on the same router web's pages already share, and `listRoutablePages`\n * only has a page graph to read once web has scanned it.\n */\nexport const SITEMAP_CONNECTOR_PRIORITY = 5.6;\n\nexport type SitemapConnectorOptions = {\n  /** Supply the configuration directly instead of reading the `sitemap` config key (`src/config/sitemap.ts`). */\n  config?: SitemapConfig;\n  /**\n   * App-supplied entries — the only source of entries in a Warlock **API-only**\n   * project, which has no `@warlock.js/web` page registry for `listRoutablePages()`\n   * to read. When `@warlock.js/web` IS installed, these are ADDED to the\n   * page-derived entries (see {@link mergeSitemapEntries}), not substituted, so an\n   * app with both pages and extra URLs (e.g. rows a database holds) gets both.\n   */\n  entries?: SitemapEntries;\n};\n\n/**\n * Raised at `boot()` when the sitemap is enabled but has no way to produce\n * entries: `@warlock.js/web` is not installed, so there is no page registry\n * for `listRoutablePages()` to read, AND no `entries` option was supplied.\n * Refuses to boot rather than registering a route that would silently serve\n * an empty `<urlset>` — the same reasoning as {@link MissingPublicUrlError}:\n * a sitemap that looks complete while producing nothing is worse than one\n * that never started.\n */\nexport class NoPageRegistryError extends Error {\n  public constructor() {\n    super(\n      \"Sitemap is enabled but has no source of entries: `@warlock.js/web` is not installed, \" +\n        \"so there is no page registry to read, and no `entries` option was supplied either. \" +\n        \"Fix this by installing `@warlock.js/web`, or by passing \" +\n        \"`sitemapConnector({ entries: async () => [...] })` with your own supplier.\",\n    );\n    this.name = \"NoPageRegistryError\";\n  }\n}\n\n/** Adapts one `listRoutablePages()` result into the package's own minimal `RoutablePage` shape. */\nfunction toRoutablePage(page: {\n  routeName: string;\n  routePath: string;\n  metadata?: unknown;\n  sitemap?: unknown;\n}): RoutablePage {\n  const metadata = page.metadata;\n  const robots =\n    metadata !== null && typeof metadata === \"object\" && \"robots\" in metadata\n      ? (metadata as { robots?: unknown }).robots\n      : undefined;\n\n  return {\n    routeName: page.routeName,\n    routePath: page.routePath,\n    robots: typeof robots === \"string\" ? robots : undefined,\n    sitemap: page.sitemap as RoutablePage[\"sitemap\"],\n  };\n}\n\n/**\n * Construct the sitemap connector.\n *\n * At `boot()`: reads the `sitemap` config (a no-op when `enabled` is not\n * `true`), resolves the public origin ONCE — failing loud via\n * {@link resolveOrigin}'s {@link MissingPublicUrlError} rather than falling\n * back to a request-derived host — and registers `GET <config.path>`.\n *\n * The route itself re-reads the page graph on every request via\n * `listRoutablePages()`, not once at boot: the registry can change under\n * `warlock dev`, and a sitemap that only reflects the app's shape at the\n * moment it booted is stale in exactly the way that made `2ede40cf`-class\n * defects expensive.\n *\n * @example\n * // warlock.config.ts\n * import { sitemapConnector } from \"@warlock.js/sitemap\";\n *\n * export default defineConfig({ connectors: [sitemapConnector()] });\n */\nexport function sitemapConnector(options: SitemapConnectorOptions = {}): Connector {\n  let active = false;\n\n  const connector: Connector = {\n    name: \"sitemap\",\n    priority: SITEMAP_CONNECTOR_PRIORITY,\n    // Core's `ConnectorLifecyclePhase.Late`; spelled out so this module stays\n    // free of a runtime import of core, same as `queueConnector()`.\n    lifecyclePhase: \"late\" as ConnectorLifecyclePhase,\n    isActive: () => active,\n    async boot() {\n      const { config, router } = await import(\"@warlock.js/core\");\n\n      const sitemapConfig = options.config ?? config.get<SitemapConfig | undefined>(\"sitemap\");\n\n      if (!sitemapConfig?.enabled) {\n        return;\n      }\n\n      const appConfig = config.get<{ publicUrl?: string } | undefined>(\"app\");\n      const origin = resolveOrigin({ publicUrl: appConfig?.publicUrl, env: process.env });\n      const path = sitemapConfig.path || DEFAULT_SITEMAP_PATH;\n\n      // Checked once, at boot: `@warlock.js/web`'s presence can't change per\n      // request, and failing here — before the route is even registered —\n      // surfaces a misconfigured app at startup instead of on its first hit.\n      let listRoutablePages: typeof import(\"@warlock.js/web/build\").listRoutablePages | undefined;\n      try {\n        ({ listRoutablePages } = await import(\"@warlock.js/web/build\"));\n      } catch {\n        listRoutablePages = undefined;\n      }\n\n      if (!listRoutablePages && !options.entries) {\n        throw new NoPageRegistryError();\n      }\n\n      router.get(path, async ({ response }: HttpContext) => {\n        const pages = listRoutablePages\n          ? (await listRoutablePages({ appRoot: process.cwd() })).map(toRoutablePage)\n          : [];\n\n        const { entries: pageEntries, unresolvedDynamicRoutes } = await collectSitemapEntries(pages, {\n          defaults: sitemapConfig.defaults,\n        });\n\n        const appEntries = options.entries\n          ? (await options.entries()).map((entry) => withDefaults(entry, sitemapConfig.defaults))\n          : [];\n\n        const entries = mergeSitemapEntries(pageEntries, appEntries);\n\n        if (process.env.NODE_ENV !== \"production\") {\n          const diagnostic = describeUnresolvedDynamicRoutes(unresolvedDynamicRoutes);\n          if (diagnostic) console.warn(diagnostic);\n        }\n\n        const xml = buildSitemapXml(entries, origin);\n\n        return response.setContentType(\"application/xml\").send(xml);\n      });\n\n      active = true;\n    },\n    async start() {\n      // Nothing to start: the route is registered at boot, once the HTTP\n      // connector has built its server but before it listens — the same\n      // window `queueConnector()`'s dashboard mount uses.\n    },\n    async restart() {\n      await connector.shutdown();\n      await connector.boot();\n    },\n    async shutdown() {\n      active = false;\n    },\n    shouldRestart(changedFiles: string[]) {\n      return changedFiles.some((file) => {\n        const normalized = file.replace(/\\\\/g, \"/\");\n\n        return normalized === \"src/config/sitemap.ts\" || normalized.endsWith(\"/src/config/sitemap.ts\");\n      });\n    },\n  };\n\n  return connector;\n}\n"],"mappings":";;;;;;;AAmBA,MAAa,uBAAuB;;;;;;;AAQpC,MAAa,6BAA6B;;;;;;;;;;AAwB1C,IAAa,sBAAb,cAAyC,MAAM;CAC7C,AAAO,cAAc;EACnB,MACE,4SAIF;EACA,KAAK,OAAO;CACd;AACF;;AAGA,SAAS,eAAe,MAKP;CACf,MAAM,WAAW,KAAK;CACtB,MAAM,SACJ,aAAa,QAAQ,OAAO,aAAa,YAAY,YAAY,WAC5D,SAAkC,SACnC;CAEN,OAAO;EACL,WAAW,KAAK;EAChB,WAAW,KAAK;EAChB,QAAQ,OAAO,WAAW,WAAW,SAAS;EAC9C,SAAS,KAAK;CAChB;AACF;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,iBAAiB,UAAmC,CAAC,GAAc;CACjF,IAAI,SAAS;CAEb,MAAM,YAAuB;EAC3B,MAAM;EACN,UAAU;EAGV,gBAAgB;EAChB,gBAAgB;EAChB,MAAM,OAAO;GACX,MAAM,EAAE,QAAQ,WAAW,MAAM,OAAO;GAExC,MAAM,gBAAgB,QAAQ,UAAU,OAAO,IAA+B,SAAS;GAEvF,IAAI,CAAC,eAAe,SAClB;GAIF,MAAM,SAAS,cAAc;IAAE,WADb,OAAO,IAAwC,KACf,CAAC,EAAE;IAAW,KAAK,QAAQ;GAAI,CAAC;GAClF,MAAM,OAAO,cAAc;GAK3B,IAAI;GACJ,IAAI;IACF,CAAC,CAAE,qBAAsB,MAAM,OAAO;GACxC,QAAQ;IACN,oBAAoB;GACtB;GAEA,IAAI,CAAC,qBAAqB,CAAC,QAAQ,SACjC,MAAM,IAAI,oBAAoB;GAGhC,OAAO,IAAI,MAAM,OAAO,EAAE,eAA4B;IAKpD,MAAM,EAAE,SAAS,aAAa,4BAA4B,MAAM,sBAJlD,qBACT,MAAM,kBAAkB,EAAE,SAAS,QAAQ,IAAI,EAAE,CAAC,EAAC,CAAE,IAAI,cAAc,IACxE,CAAC,GAEwF,EAC3F,UAAU,cAAc,SAC1B,CAAC;IAMD,MAAM,UAAU,oBAAoB,aAJjB,QAAQ,WACtB,MAAM,QAAQ,QAAQ,EAAC,CAAE,KAAK,UAAU,aAAa,OAAO,cAAc,QAAQ,CAAC,IACpF,CAAC,CAEsD;IAE3D,IAAI,QAAQ,IAAI,aAAa,cAAc;KACzC,MAAM,aAAa,gCAAgC,uBAAuB;KAC1E,IAAI,YAAY,QAAQ,KAAK,UAAU;IACzC;IAEA,MAAM,MAAM,gBAAgB,SAAS,MAAM;IAE3C,OAAO,SAAS,eAAe,iBAAiB,CAAC,CAAC,KAAK,GAAG;GAC5D,CAAC;GAED,SAAS;EACX;EACA,MAAM,QAAQ,CAId;EACA,MAAM,UAAU;GACd,MAAM,UAAU,SAAS;GACzB,MAAM,UAAU,KAAK;EACvB;EACA,MAAM,WAAW;GACf,SAAS;EACX;EACA,cAAc,cAAwB;GACpC,OAAO,aAAa,MAAM,SAAS;IACjC,MAAM,aAAa,KAAK,QAAQ,OAAO,GAAG;IAE1C,OAAO,eAAe,2BAA2B,WAAW,SAAS,wBAAwB;GAC/F,CAAC;EACH;CACF;CAEA,OAAO;AACT"}