@richie-router/server 0.1.1 → 0.1.3

package/dist/cjs/index.cjs

@@ -40,14 +40,15 @@ var __export = (target, all) => {
 var exports_src = {};
 __export(exports_src, {
   handleRequest: () => handleRequest,
+  handleHeadTagRequest: () => handleHeadTagRequest,
   defineHeadTags: () => defineHeadTags
 });
 module.exports = __toCommonJS(exports_src);
 var import_core = require("@richie-router/core");
-function defineHeadTags(routeManifest, headTagSchema, definitions) {
+function defineHeadTags(routeManifest, routerSchema, definitions) {
   return {
     routeManifest,
-    headTagSchema,
+    routerSchema,
     definitions
   };
 }
@@ -111,11 +112,11 @@ function buildMatches(routeManifest, location) {
     };
   });
 }
-async function executeHeadTag(request, headTags, headTagName, params, rawSearch) {
-  const definition = headTags.definitions[headTagName];
-  const schemaEntry = headTags.headTagSchema[headTagName];
+async function executeHeadTag(request, headTags, routeId, params, rawSearch) {
+  const definition = headTags.definitions[routeId];
+  const schemaEntry = headTags.routerSchema[routeId];
   if (!definition) {
-    throw new Error(`Unknown head tag "${headTagName}".`);
+    throw new Error(`Unknown server head route "${routeId}".`);
   }
   const search = schemaEntry?.searchSchema ? schemaEntry.searchSchema.parse(rawSearch) : rawSearch;
   const head = await definition.head({
@@ -131,44 +132,63 @@ async function executeHeadTag(request, headTags, headTagName, params, rawSearch)
 async function resolveMatchedHead(request, headTags, matches) {
   const resolvedHeadByRoute = new Map;
   for (const match of matches) {
-    const headOption = match.route.options.head;
-    if (typeof headOption !== "string") {
+    if (!match.route.serverHead) {
       continue;
     }
-    const result = await executeHeadTag(request, headTags, headOption, match.params, match.search);
+    const result = await executeHeadTag(request, headTags, match.route.fullPath, match.params, match.search);
     resolvedHeadByRoute.set(match.route.fullPath, result.head);
   }
   return import_core.resolveHeadConfig(matches, resolvedHeadByRoute);
 }
-async function handleRequest(request, options) {
+async function handleHeadTagRequest(request, options) {
   const url = new URL(request.url);
   const headBasePath = options.headBasePath ?? "/head-api";
-  const routeBasePath = options.routeBasePath ?? "/";
-  if (url.pathname.startsWith(`${headBasePath}/`)) {
-    const headTagName = decodeURIComponent(url.pathname.slice(headBasePath.length + 1));
-    const params = JSON.parse(url.searchParams.get("params") ?? "{}");
-    const search = JSON.parse(url.searchParams.get("search") ?? "{}");
-    try {
-      const result = await executeHeadTag(request, options.headTags, headTagName, params, search);
+  if (url.pathname !== headBasePath) {
+    return {
+      matched: false,
+      response: new Response("Not Found", { status: 404 })
+    };
+  }
+  const routeId = url.searchParams.get("routeId");
+  if (!routeId) {
+    return {
+      matched: true,
+      response: jsonResponse({ message: "Missing routeId" }, { status: 400 })
+    };
+  }
+  const params = JSON.parse(url.searchParams.get("params") ?? "{}");
+  const search = JSON.parse(url.searchParams.get("search") ?? "{}");
+  try {
+    const result = await executeHeadTag(request, options.headTags, routeId, params, search);
+    return {
+      matched: true,
+      response: jsonResponse(result)
+    };
+  } catch (error) {
+    if (error instanceof Response) {
+      return {
+        matched: true,
+        response: error
+      };
+    }
+    if (import_core.isNotFound(error)) {
       return {
         matched: true,
-        response: jsonResponse(result)
+        response: jsonResponse({ message: "Not Found" }, { status: 404 })
       };
-    } catch (error) {
-      if (error instanceof Response) {
-        return {
-          matched: true,
-          response: error
-        };
-      }
-      if (import_core.isNotFound(error)) {
-        return {
-          matched: true,
-          response: jsonResponse({ message: "Not Found" }, { status: 404 })
-        };
-      }
-      throw error;
     }
+    throw error;
+  }
+}
+async function handleRequest(request, options) {
+  const url = new URL(request.url);
+  const routeBasePath = options.routeBasePath ?? "/";
+  const handledHeadTagRequest = await handleHeadTagRequest(request, {
+    headTags: options.headTags,
+    headBasePath: options.headBasePath
+  });
+  if (handledHeadTagRequest.matched) {
+    return handledHeadTagRequest;
   }
   if (!url.pathname.startsWith(routeBasePath)) {
     return {

package/dist/esm/index.mjs

@@ -10,10 +10,10 @@ import {
   resolveHeadConfig,
   serializeHeadConfig
 } from "@richie-router/core";
-function defineHeadTags(routeManifest, headTagSchema, definitions) {
+function defineHeadTags(routeManifest, routerSchema, definitions) {
   return {
     routeManifest,
-    headTagSchema,
+    routerSchema,
     definitions
   };
 }
@@ -77,11 +77,11 @@ function buildMatches(routeManifest, location) {
     };
   });
 }
-async function executeHeadTag(request, headTags, headTagName, params, rawSearch) {
-  const definition = headTags.definitions[headTagName];
-  const schemaEntry = headTags.headTagSchema[headTagName];
+async function executeHeadTag(request, headTags, routeId, params, rawSearch) {
+  const definition = headTags.definitions[routeId];
+  const schemaEntry = headTags.routerSchema[routeId];
   if (!definition) {
-    throw new Error(`Unknown head tag "${headTagName}".`);
+    throw new Error(`Unknown server head route "${routeId}".`);
   }
   const search = schemaEntry?.searchSchema ? schemaEntry.searchSchema.parse(rawSearch) : rawSearch;
   const head = await definition.head({
@@ -97,44 +97,63 @@ async function executeHeadTag(request, headTags, headTagName, params, rawSearch)
 async function resolveMatchedHead(request, headTags, matches) {
   const resolvedHeadByRoute = new Map;
   for (const match of matches) {
-    const headOption = match.route.options.head;
-    if (typeof headOption !== "string") {
+    if (!match.route.serverHead) {
       continue;
     }
-    const result = await executeHeadTag(request, headTags, headOption, match.params, match.search);
+    const result = await executeHeadTag(request, headTags, match.route.fullPath, match.params, match.search);
     resolvedHeadByRoute.set(match.route.fullPath, result.head);
   }
   return resolveHeadConfig(matches, resolvedHeadByRoute);
 }
-async function handleRequest(request, options) {
+async function handleHeadTagRequest(request, options) {
   const url = new URL(request.url);
   const headBasePath = options.headBasePath ?? "/head-api";
-  const routeBasePath = options.routeBasePath ?? "/";
-  if (url.pathname.startsWith(`${headBasePath}/`)) {
-    const headTagName = decodeURIComponent(url.pathname.slice(headBasePath.length + 1));
-    const params = JSON.parse(url.searchParams.get("params") ?? "{}");
-    const search = JSON.parse(url.searchParams.get("search") ?? "{}");
-    try {
-      const result = await executeHeadTag(request, options.headTags, headTagName, params, search);
+  if (url.pathname !== headBasePath) {
+    return {
+      matched: false,
+      response: new Response("Not Found", { status: 404 })
+    };
+  }
+  const routeId = url.searchParams.get("routeId");
+  if (!routeId) {
+    return {
+      matched: true,
+      response: jsonResponse({ message: "Missing routeId" }, { status: 400 })
+    };
+  }
+  const params = JSON.parse(url.searchParams.get("params") ?? "{}");
+  const search = JSON.parse(url.searchParams.get("search") ?? "{}");
+  try {
+    const result = await executeHeadTag(request, options.headTags, routeId, params, search);
+    return {
+      matched: true,
+      response: jsonResponse(result)
+    };
+  } catch (error) {
+    if (error instanceof Response) {
+      return {
+        matched: true,
+        response: error
+      };
+    }
+    if (isNotFound(error)) {
       return {
         matched: true,
-        response: jsonResponse(result)
+        response: jsonResponse({ message: "Not Found" }, { status: 404 })
       };
-    } catch (error) {
-      if (error instanceof Response) {
-        return {
-          matched: true,
-          response: error
-        };
-      }
-      if (isNotFound(error)) {
-        return {
-          matched: true,
-          response: jsonResponse({ message: "Not Found" }, { status: 404 })
-        };
-      }
-      throw error;
     }
+    throw error;
+  }
+}
+async function handleRequest(request, options) {
+  const url = new URL(request.url);
+  const routeBasePath = options.routeBasePath ?? "/";
+  const handledHeadTagRequest = await handleHeadTagRequest(request, {
+    headTags: options.headTags,
+    headBasePath: options.headBasePath
+  });
+  if (handledHeadTagRequest.matched) {
+    return handledHeadTagRequest;
   }
   if (!url.pathname.startsWith(routeBasePath)) {
     return {
@@ -203,5 +222,6 @@ async function handleRequest(request, options) {
 }
 export {
   handleRequest,
+  handleHeadTagRequest,
   defineHeadTags
 };

package/dist/types/index.d.ts

@@ -1,23 +1,22 @@
-import { type AnyRoute, type HeadConfig, type HeadTagSchemaShape, type InferHeadTagSearchSchema } from '@richie-router/core';
-export interface HeadTagContext<TSearch> {
+import { type ResolveAllParamsForRouteId, type RouteIdsWithServerHead, type RouterSchemaShape, type InferRouterSearchSchema, type AnyRoute, type HeadConfig } from '@richie-router/core';
+export interface HeadTagContext<TParams extends Record<string, string>, TSearch> {
     request: Request;
-    params: Record<string, string>;
+    params: TParams;
     search: TSearch;
 }
-export interface HeadTagDefinition<TSearch> {
+export interface HeadTagDefinition<TParams extends Record<string, string>, TSearch> {
     staleTime?: number;
-    head: (ctx: HeadTagContext<TSearch>) => Promise<HeadConfig> | HeadConfig;
+    head: (ctx: HeadTagContext<TParams, TSearch>) => Promise<HeadConfig> | HeadConfig;
 }
-export interface DefinedHeadTags<TRouteManifest extends AnyRoute, THeadTagSchema extends HeadTagSchemaShape, TDefinitions extends Partial<{
-    [THeadTagName in keyof THeadTagSchema]: HeadTagDefinition<InferHeadTagSearchSchema<THeadTagSchema, THeadTagName>>;
-}>> {
+export type HeadTagDefinitions<TRouterSchema extends RouterSchemaShape> = {
+    [TRouteId in RouteIdsWithServerHead<TRouterSchema>]: HeadTagDefinition<ResolveAllParamsForRouteId<TRouteId>, InferRouterSearchSchema<TRouterSchema, TRouteId>>;
+};
+export interface DefinedHeadTags<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape> {
     routeManifest: TRouteManifest;
-    headTagSchema: THeadTagSchema;
-    definitions: TDefinitions;
+    routerSchema: TRouterSchema;
+    definitions: HeadTagDefinitions<TRouterSchema>;
 }
-export declare function defineHeadTags<TRouteManifest extends AnyRoute, THeadTagSchema extends HeadTagSchemaShape, TDefinitions extends Partial<{
-    [THeadTagName in keyof THeadTagSchema]: HeadTagDefinition<InferHeadTagSearchSchema<THeadTagSchema, THeadTagName>>;
-}>>(routeManifest: TRouteManifest, headTagSchema: THeadTagSchema, definitions: TDefinitions): DefinedHeadTags<TRouteManifest, THeadTagSchema, TDefinitions>;
+export declare function defineHeadTags<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape>(routeManifest: TRouteManifest, routerSchema: TRouterSchema, definitions: HeadTagDefinitions<TRouterSchema>): DefinedHeadTags<TRouteManifest, TRouterSchema>;
 export interface HtmlOptions {
     template: string | ((ctx: {
         request: Request;
@@ -25,15 +24,20 @@ export interface HtmlOptions {
         head: HeadConfig;
     }) => string | Promise<string>);
 }
-export interface HandleRequestOptions<TRouteManifest extends AnyRoute, THeadTagSchema extends HeadTagSchemaShape, TDefinitions extends Partial<Record<keyof THeadTagSchema, HeadTagDefinition<any>>>> {
+export interface HandleRequestOptions<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape> {
     routeManifest: TRouteManifest;
-    headTags: DefinedHeadTags<TRouteManifest, THeadTagSchema, TDefinitions>;
+    headTags: DefinedHeadTags<TRouteManifest, TRouterSchema>;
     html: HtmlOptions;
     headBasePath?: string;
     routeBasePath?: string;
 }
+export interface HandleHeadTagRequestOptions<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape> {
+    headTags: DefinedHeadTags<TRouteManifest, TRouterSchema>;
+    headBasePath?: string;
+}
 export interface HandleRequestResult {
     matched: boolean;
     response: Response;
 }
-export declare function handleRequest<TRouteManifest extends AnyRoute, THeadTagSchema extends HeadTagSchemaShape, TDefinitions extends Partial<Record<keyof THeadTagSchema, HeadTagDefinition<any>>>>(request: Request, options: HandleRequestOptions<TRouteManifest, THeadTagSchema, TDefinitions>): Promise<HandleRequestResult>;
+export declare function handleHeadTagRequest<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape>(request: Request, options: HandleHeadTagRequestOptions<TRouteManifest, TRouterSchema>): Promise<HandleRequestResult>;
+export declare function handleRequest<TRouteManifest extends AnyRoute, TRouterSchema extends RouterSchemaShape>(request: Request, options: HandleRequestOptions<TRouteManifest, TRouterSchema>): Promise<HandleRequestResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@richie-router/server",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Server helpers for Richie Router head tags and document handling",
   "sideEffects": false,
   "exports": {
@@ -13,7 +13,7 @@
     }
   },
   "dependencies": {
-    "@richie-router/core": "^0.1.1"
+    "@richie-router/core": "^0.1.2"
   },
   "author": "Richie <oss@ricsam.dev>",
   "homepage": "https://docs.ricsam.dev/richie-router",