@mfeflow/url-factory 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,5 +1,18 @@
-/** Names of `:params` in a path template, e.g. `'/v1/orders/:orderId/items/:itemId'` → `'orderId' | 'itemId'`. */
-export type PathParams<P extends string> = P extends `${string}:${infer Param}/${infer Rest}` ? Param | PathParams<`/${Rest}`> : P extends `${string}:${infer Param}` ? Param : never;
+type IdChar = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '_';
+/** The leading letters, digits and underscores of `S`: where `fillPath` ends a param name. */
+type Ident<S extends string, Acc extends string = ''> = S extends `${infer C}${infer Rest}` ? C extends IdChar ? Ident<Rest, `${Acc}${C}`> : Acc : Acc;
+/**
+ * Names of `:params` in a path template, e.g. `'/v1/orders/:orderId/items/:itemId'` gives
+ * `'orderId' | 'itemId'`. A name is letters, digits and underscores, as in `fillPath`, so
+ * `'/a/:order-id'` has the param `order`.
+ */
+export type PathParams<P extends string> = string extends P ? string : P extends `${string}:${infer Rest}` ? Exclude<Ident<Rest>, ''> | PathParams<Rest> : never;
+/**
+ * Fills the `:params` of a path template with encoded values. Throws for a missing param and for
+ * the values `.` and `..`, which would walk out of the path. `scope` and `id` only name the caller in
+ * the message.
+ */
+export declare function fillPath(template: string, params: Readonly<Record<string, string | number>> | undefined, scope: string, id: string): string;
 export type QueryValue = string | number | boolean | null | undefined | readonly (string | number | boolean)[];
 export type Query = Readonly<Record<string, QueryValue>>;
 export interface Endpoint {
@@ -30,3 +43,4 @@ export declare function defineEndpoints<const E extends Endpoints>(endpoints: E)
  * ```
  */
 export declare function createUrlFactory<E extends Endpoints>(endpoints: E, baseUrl: (service: E[keyof E]['service']) => string | undefined): UrlFactory<E>;
+export {};

package/dist/index.js

@@ -1,3 +1,13 @@
+const PARAM = /:([A-Za-z0-9_]+)/g;
+function fillPath(template, params, scope, id) {
+    return template.replace(PARAM, (_match, name)=>{
+        const value = params?.[name];
+        if (void 0 === value) throw new Error(`${scope}: missing param "${name}" for "${id}"`);
+        const text = String(value);
+        if ('.' === text || '..' === text) throw new Error(`${scope}: param "${name}" for "${id}" cannot be "${text}"`);
+        return encodeURIComponent(text);
+    });
+}
 function defineEndpoints(endpoints) {
     for (const [key, e] of Object.entries(endpoints))if (!e.path.startsWith('/')) throw new Error(`Endpoint "${key}": path must start with "/"`);
     return endpoints;
@@ -14,14 +24,10 @@ function createUrlFactory(endpoints, baseUrl) {
         const base = baseUrl(endpoint.service);
         if (!base) throw new Error(`url-factory: no base URL for service "${endpoint.service}" (endpoint "${key}")`);
         const options = args[0];
-        const path = endpoint.path.replace(/:([A-Za-z0-9_]+)/g, (_match, name)=>{
-            const value = options?.params?.[name];
-            if (void 0 === value) throw new Error(`url-factory: missing param "${name}" for "${key}"`);
-            return encodeURIComponent(String(value));
-        });
+        const path = fillPath(endpoint.path, options?.params, 'url-factory', key);
         const url = new URL(path.slice(1), base.endsWith('/') ? base : `${base}/`);
         appendQuery(url, options?.query);
         return url.toString();
     };
 }
-export { createUrlFactory, defineEndpoints };
+export { createUrlFactory, defineEndpoints, fillPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mfeflow/url-factory",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Typed API URLs for micro-frontends: path params are checked from the template at compile time, base URLs come from runtime config, so one build runs in every environment.",
   "keywords": [
     "micro-frontend",