@aura-stack/router 0.2.0 → 0.4.0

package/dist/context.d.ts

@@ -1,5 +1,6 @@
-import { RoutePattern, Params, EndpointConfig, ContextSearchParams } from './types.js';
+import { EndpointConfig, ContextSearchParams } from './types.js';
 import 'zod';
+import './error.js';
 
 /**
  * Extracts route parameters from a given path using the specified route pattern.
@@ -8,9 +9,9 @@ import 'zod';
  * (e.g., "/users/:userId/posts/:postId") and returns an object mapping parameter
  * names to their decoded values.
  *
- * @param route - The route pattern, typically defined in the endpoint configuration.
- * @param path - The actual request path to extract parameters from.
- * @returns An object containing the extracted route parameters as key-value pairs.
+ * @param params - The extracted route parameters as key-value pairs.
+ * @param config - The endpoint configuration which may include schemas for validation.
+ * @returns An object containing the extracted and validated route parameters.
  *
  * @example
  * const route = "/users/:userId/posts/:postId";
@@ -19,7 +20,7 @@ import 'zod';
  * // Expected: { userId: "123", postId: "456" }
  * const params = getRouteParams(route, path);
  */
-declare const getRouteParams: <Route extends RoutePattern>(route: Route, path: string) => Params<Route>;
+declare const getRouteParams: (params: Record<string, string>, config: EndpointConfig) => Record<string, unknown>;
 /**
  * Extracts and validates search parameters from a given URL from the request.
  *

package/dist/context.js

@@ -3,10 +3,9 @@ import {
   getHeaders,
   getRouteParams,
   getSearchParams
-} from "./chunk-OXDCFAMF.js";
-import "./chunk-YUX3YHXF.js";
-import "./chunk-JRJKKBSH.js";
-import "./chunk-RFYOPPMW.js";
+} from "./chunk-PT4GU6PH.js";
+import "./chunk-JNMXLKDG.js";
+import "./chunk-GJC3ODME.js";
 export {
   getBody,
   getHeaders,

package/dist/endpoint.cjs

@@ -21,24 +21,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var endpoint_exports = {};
 __export(endpoint_exports, {
   createEndpoint: () => createEndpoint,
-  createEndpointConfig: () => createEndpointConfig,
-  createRoutePattern: () => createRoutePattern
+  createEndpointConfig: () => createEndpointConfig
 });
 module.exports = __toCommonJS(endpoint_exports);
 
-// src/assert.ts
-var supportedMethods = /* @__PURE__ */ new Set(["GET", "POST", "DELETE", "PUT", "PATCH"]);
-var isSupportedMethod = (method) => {
-  return supportedMethods.has(method);
-};
-var isValidRoute = (route) => {
-  const routePattern = /^\/[a-zA-Z0-9/_:-]*$/;
-  return routePattern.test(route);
-};
-var isValidHandler = (handler) => {
-  return typeof handler === "function";
-};
-
 // src/error.ts
 var statusCode = {
   OK: 200,
@@ -66,35 +52,50 @@ var statusCode = {
   SERVICE_UNAVAILABLE: 503,
   HTTP_VERSION_NOT_SUPPORTED: 505
 };
-var statusText = Object.entries(statusCode).reduce(
-  (previous, [status, code]) => {
-    return { ...previous, [code]: status };
+var statusText = Object.keys(statusCode).reduce(
+  (previous, status) => {
+    return { ...previous, [status]: status };
   },
   {}
 );
 var AuraStackRouterError = class extends Error {
   constructor(type, message, name) {
     super(message);
-    this.name = name ?? "AuraStackRouterError";
+    this.name = name ?? "RouterError";
     this.status = statusCode[type];
-    this.statusText = statusText[this.status];
+    this.statusText = statusText[type];
+  }
+};
+var RouterError = class extends AuraStackRouterError {
+  constructor(type, message, name) {
+    super(type, message, name);
+    this.name = name ?? "RouterError";
   }
 };
 
-// src/endpoint.ts
-var createRoutePattern = (route) => {
-  const pattern = route.replace(/:[^/]+/g, "([^/]+)").replace(/\//g, "\\/");
-  return new RegExp(`^${pattern}$`);
+// src/assert.ts
+var supportedMethods = /* @__PURE__ */ new Set(["GET", "POST", "DELETE", "PUT", "PATCH", "OPTIONS", "HEAD", "TRACE", "CONNECT"]);
+var isSupportedMethod = (method) => {
+  return supportedMethods.has(method);
+};
+var isValidRoute = (route) => {
+  const routePattern = /^\/[a-zA-Z0-9/_:-]*$/;
+  return routePattern.test(route);
 };
+var isValidHandler = (handler) => {
+  return typeof handler === "function";
+};
+
+// src/endpoint.ts
 var createEndpoint = (method, route, handler, config = {}) => {
   if (!isSupportedMethod(method)) {
-    throw new AuraStackRouterError("METHOD_NOT_ALLOWED", `Unsupported HTTP method: ${method}`);
+    throw new RouterError("METHOD_NOT_ALLOWED", `Unsupported HTTP method: ${method}`);
   }
   if (!isValidRoute(route)) {
-    throw new AuraStackRouterError("BAD_REQUEST", `Invalid route format: ${route}`);
+    throw new RouterError("BAD_REQUEST", `Invalid route format: ${route}`);
   }
   if (!isValidHandler(handler)) {
-    throw new AuraStackRouterError("BAD_REQUEST", "Handler must be a function");
+    throw new RouterError("BAD_REQUEST", "Handler must be a function");
   }
   return { method, route, handler, config };
 };
@@ -105,6 +106,5 @@ function createEndpointConfig(...args) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createEndpoint,
-  createEndpointConfig,
-  createRoutePattern
+  createEndpointConfig
 });

package/dist/endpoint.d.ts

@@ -1,18 +1,7 @@
-import { RoutePattern, HTTPMethod, EndpointSchemas, RouteHandler, EndpointConfig, RouteEndpoint } from './types.js';
+import { HTTPMethod, RoutePattern, EndpointSchemas, RouteHandler, EndpointConfig, RouteEndpoint } from './types.js';
 import 'zod';
+import './error.js';
 
-/**
- * Create a RegExp pattern from a route string. This function allows segment the
- * dynamic params in the route. For example, the route `/users/:id` will be
- * converted to a regex pattern that captures the `id` parameter.
- *
- * @param route - The route pattern string
- * @returns A RegExp object that matches the route pattern
- * @example
- * // Expected: /^\/users\/([^/]+)$/
- * const pattern = createRoutePattern("/users/:id");
- */
-declare const createRoutePattern: (route: RoutePattern) => RegExp;
 /**
  * Defines an API endpoint for the router by specifying the HTTP method, route pattern,
  * handler function, and optional configuration such as validation schemas or middlewares.
@@ -36,10 +25,13 @@ declare const createEndpoint: <const Method extends Uppercase<HTTPMethod>, const
  * Create an endpoint configuration to be passed to the `createEndpoint` function.
  * This function is primarily for type inference and does not perform any runtime checks.
  *
- * @experimental
+ * This overload is recommended when the route pattern does not need to be specified explicitly,
+ * otherwise use the overload that accepts the route pattern as the first argument.
+ *
  * @param config - The endpoint configuration object
  * @returns The same configuration object, typed as EndpointConfig
  * @example
+ * // Without route pattern
  * const config = createEndpointConfig({
  *   middlewares: [myMiddleware],
  *   schemas: {
@@ -52,8 +44,17 @@ declare const createEndpoint: <const Method extends Uppercase<HTTPMethod>, const
  * const search = createEndpoint("GET", "/search", async (request, ctx) => {
  *   return new Response("Search results");
  * }, config);
+ *
+ * // Overload with route pattern
+ * const config = createEndpointConfig("/users/:userId", {
+ *   middlewares: [myMiddleware],
+ * })
+ *
+ * const getUser = createEndpoint("GET", "/users/:userId", async (request, ctx) => {
+ *   return new Response("User details");
+ * }, config);
  */
 declare function createEndpointConfig<Schemas extends EndpointSchemas>(config: EndpointConfig<RoutePattern, Schemas>): EndpointConfig<RoutePattern, Schemas>;
-declare function createEndpointConfig<Route extends RoutePattern, S extends EndpointSchemas>(route: Route, config: EndpointConfig<Route, S>): EndpointConfig<Route, S>;
+declare function createEndpointConfig<Route extends RoutePattern, Schemas extends EndpointSchemas>(route: Route, config: EndpointConfig<Route, Schemas>): EndpointConfig<Route, Schemas>;
 
-export { createEndpoint, createEndpointConfig, createRoutePattern };
+export { createEndpoint, createEndpointConfig };

package/dist/endpoint.js

@@ -1,12 +1,10 @@
 import {
   createEndpoint,
-  createEndpointConfig,
-  createRoutePattern
-} from "./chunk-YUX3YHXF.js";
-import "./chunk-JRJKKBSH.js";
-import "./chunk-RFYOPPMW.js";
+  createEndpointConfig
+} from "./chunk-6PZEXNTS.js";
+import "./chunk-JNMXLKDG.js";
+import "./chunk-GJC3ODME.js";
 export {
   createEndpoint,
-  createEndpointConfig,
-  createRoutePattern
+  createEndpointConfig
 };

package/dist/error.cjs

@@ -20,7 +20,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/error.ts
 var error_exports = {};
 __export(error_exports, {
-  AuraStackRouterError: () => AuraStackRouterError
+  AuraStackRouterError: () => AuraStackRouterError,
+  RouterError: () => RouterError,
+  statusCode: () => statusCode,
+  statusText: () => statusText
 });
 module.exports = __toCommonJS(error_exports);
 var statusCode = {
@@ -49,21 +52,30 @@ var statusCode = {
   SERVICE_UNAVAILABLE: 503,
   HTTP_VERSION_NOT_SUPPORTED: 505
 };
-var statusText = Object.entries(statusCode).reduce(
-  (previous, [status, code]) => {
-    return { ...previous, [code]: status };
+var statusText = Object.keys(statusCode).reduce(
+  (previous, status) => {
+    return { ...previous, [status]: status };
   },
   {}
 );
 var AuraStackRouterError = class extends Error {
   constructor(type, message, name) {
     super(message);
-    this.name = name ?? "AuraStackRouterError";
+    this.name = name ?? "RouterError";
     this.status = statusCode[type];
-    this.statusText = statusText[this.status];
+    this.statusText = statusText[type];
+  }
+};
+var RouterError = class extends AuraStackRouterError {
+  constructor(type, message, name) {
+    super(type, message, name);
+    this.name = name ?? "RouterError";
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  AuraStackRouterError
+  AuraStackRouterError,
+  RouterError,
+  statusCode,
+  statusText
 });

package/dist/error.d.ts

@@ -27,14 +27,39 @@ declare const statusCode: {
     SERVICE_UNAVAILABLE: number;
     HTTP_VERSION_NOT_SUPPORTED: number;
 };
+type StatusCode = keyof typeof statusCode;
+/**
+ * Reverse mapping of status codes to their corresponding status text.
+ */
+declare const statusText: Record<"OK" | "CREATED" | "ACCEPTED" | "NO_CONTENT" | "MULTIPLE_CHOICES" | "MOVED_PERMANENTLY" | "FOUND" | "SEE_OTHER" | "NOT_MODIFIED" | "TEMPORARY_REDIRECT" | "BAD_REQUEST" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "PROXY_AUTHENTICATION_REQUIRED" | "UNPROCESSABLE_ENTITY" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "HTTP_VERSION_NOT_SUPPORTED", "OK" | "CREATED" | "ACCEPTED" | "NO_CONTENT" | "MULTIPLE_CHOICES" | "MOVED_PERMANENTLY" | "FOUND" | "SEE_OTHER" | "NOT_MODIFIED" | "TEMPORARY_REDIRECT" | "BAD_REQUEST" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "PROXY_AUTHENTICATION_REQUIRED" | "UNPROCESSABLE_ENTITY" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "HTTP_VERSION_NOT_SUPPORTED">;
 /**
  * Defines the errors used in AuraStack Router. Includes HTTP status code and
  * status text.
+ * @deprecated Use RouterError instead
  */
 declare class AuraStackRouterError extends Error {
+    /**
+     * The HTTP status code associated with the error.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status
+     * @example
+     * NOT_FOUND: 404
+     * METHOD_NOT_ALLOWED: 405
+     * INTERNAL_SERVER_ERROR: 500
+     */
     readonly status: number;
-    readonly statusText: keyof typeof statusCode;
-    constructor(type: keyof typeof statusCode, message: string, name?: string);
+    /**
+     * The HTTP status text associated with the status code of the error.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status
+     * @example
+     * NOT_FOUND: NOT_FOUND
+     * METHOD_NOT_ALLOWED: METHOD_NOT_ALLOWED
+     * INTERNAL_SERVER_ERROR: INTERNAL_SERVER_ERROR
+     */
+    readonly statusText: StatusCode;
+    constructor(type: StatusCode, message: string, name?: string);
+}
+declare class RouterError extends AuraStackRouterError {
+    constructor(type: StatusCode, message: string, name?: string);
 }
 
-export { AuraStackRouterError };
+export { AuraStackRouterError, RouterError, statusCode, statusText };

package/dist/error.js

@@ -1,6 +1,12 @@
 import {
-  AuraStackRouterError
-} from "./chunk-RFYOPPMW.js";
+  AuraStackRouterError,
+  RouterError,
+  statusCode,
+  statusText
+} from "./chunk-GJC3ODME.js";
 export {
-  AuraStackRouterError
+  AuraStackRouterError,
+  RouterError,
+  statusCode,
+  statusText
 };