feat: checkpoint

platform/relay/libraries/client.ts

@@ -0,0 +1,198 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+
+import type { ZodObject, ZodType } from "zod";
+
+import type { RelayAdapter, RelayInput, RelayResponse } from "./adapter.ts";
+import { Route, type RouteFn, type Routes } from "./route.ts";
+
+/**
+ * Factory method for generating a new relay client instance.
+ *
+ * @param config     - Client configuration.
+ * @param procedures - Map of routes to make available to the client.
+ */
+export function makeClient<TRoutes extends Routes>(config: Config, routes: TRoutes): RelayClient<TRoutes> {
+  const client: any = {
+    getUrl: config.adapter.getUrl.bind(config.adapter),
+    request: config.adapter.request.bind(config.adapter),
+  };
+  for (const key in routes) {
+    const route = routes[key];
+    if (route instanceof Route) {
+      client[key] = getRouteFn(route, config);
+    } else if (typeof route === "function") {
+      client[key] = route;
+    } else {
+      client[key] = getNestedRoute(config, route);
+    }
+  }
+  return client;
+}
+
+/*
+ |--------------------------------------------------------------------------------
+ | Helpers
+ |--------------------------------------------------------------------------------
+ */
+
+function getNestedRoute<TRoutes extends Routes>(config: Config, routes: TRoutes): RelayClient<TRoutes> {
+  const nested: any = {};
+  for (const key in routes) {
+    const route = routes[key];
+    if (route instanceof Route) {
+      nested[key] = getRouteFn(route, config);
+    } else if (typeof route === "function") {
+      nested[key] = route;
+    } else {
+      nested[key] = getNestedRoute(config, route);
+    }
+  }
+  return nested;
+}
+
+function getRouteFn(route: Route, { adapter }: Config) {
+  return async (options: any = {}) => {
+    const input: RelayInput = {
+      method: route.state.method,
+      endpoint: route.state.path,
+      query: "",
+    };
+
+    // ### Params
+    // Prepare request parameters by replacing :param notations with the
+    // parameter argument provided.
+
+    if (route.state.params !== undefined) {
+      const params = await toParsedArgs(
+        route.state.params,
+        options.params,
+        `Invalid 'params' passed to ${route.state.path} handler.`,
+      );
+      for (const key in params) {
+        input.endpoint = input.endpoint.replace(`:${key}`, encodeURIComponent(params[key]));
+      }
+    }
+
+    // ### Query
+    // Prepare request query by looping through the query argument and
+    // creating a query string to pass onto the fetch request.
+
+    if (route.state.query !== undefined) {
+      const query = await toParsedArgs(
+        route.state.query,
+        options.query,
+        `Invalid 'query' passed to ${route.state.path} handler.`,
+      );
+      const pieces: string[] = [];
+      for (const key in query) {
+        pieces.push(`${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`);
+      }
+      if (pieces.length > 0) {
+        input.query = `?${pieces.join("&")}`;
+      }
+    }
+
+    // ### Body
+    // Attach the body to the input which is handled internally based on the
+    // type of fetch body is submitted.
+
+    if (route.state.body !== undefined) {
+      input.body = await toParsedArgs(
+        route.state.body,
+        options.body,
+        `Invalid 'body' passed to ${route.state.path} handler.`,
+      );
+    }
+
+    // ### Request Init
+    // List of request init options that we can extract and forward to the
+    // request adapter.
+
+    if (options.headers !== undefined) {
+      input.headers = new Headers(options.headers);
+    }
+
+    // ### Fetch
+
+    const response = await adapter.send(input);
+
+    if ("data" in response && route.state.response !== undefined) {
+      response.data = route.state.response.parse(response.data);
+    }
+
+    return response;
+  };
+}
+
+async function toParsedArgs(
+  zod: ZodType,
+  args: unknown,
+  msg: string,
+): Promise<Record<string, string | number | boolean>> {
+  const result = await zod.safeParseAsync(args);
+  if (result.success === false) {
+    throw new Error(msg);
+  }
+  return result.data as Record<string, string | number | boolean>;
+}
+
+/*
+ |--------------------------------------------------------------------------------
+ | Types
+ |--------------------------------------------------------------------------------
+ */
+
+export type RelayClient<TRoutes extends Routes> = RelayRequest & RelayRoutes<TRoutes>;
+
+type RelayRequest = {
+  url: string;
+  getUrl: (endpoint: string) => string;
+  request: <TData = unknown>(input: RequestInfo | URL, init?: RequestInit) => Promise<RelayResponse<TData>>;
+};
+
+type RelayRoutes<TRoutes extends Routes> = {
+  [TKey in keyof TRoutes]: TRoutes[TKey] extends Route
+    ? ClientRoute<TRoutes[TKey]>
+    : TRoutes[TKey] extends RouteFn
+      ? TRoutes[TKey]
+      : TRoutes[TKey] extends Routes
+        ? RelayRoutes<TRoutes[TKey]>
+        : never;
+};
+
+type ClientRoute<TRoute extends Route> = HasPayload<TRoute> extends true
+  ? (
+      payload: Prettify<
+        (TRoute["state"]["params"] extends ZodObject ? { params: TRoute["$params"] } : {}) &
+          (TRoute["state"]["query"] extends ZodObject ? { query: TRoute["$query"] } : {}) &
+          (TRoute["state"]["body"] extends ZodType ? { body: TRoute["$body"] } : {}) & {
+            headers?: HeadersInit;
+          }
+      >,
+    ) => RouteResponse<TRoute>
+  : (payload?: { headers: HeadersInit }) => RouteResponse<TRoute>;
+
+type HasPayload<TRoute extends Route> = TRoute["state"]["params"] extends ZodObject
+  ? true
+  : TRoute["state"]["query"] extends ZodObject
+    ? true
+    : TRoute["state"]["body"] extends ZodType
+      ? true
+      : false;
+
+type RouteResponse<TRoute extends Route> = Promise<RelayResponse<RouteOutput<TRoute>, RouteErrors<TRoute>>> & {
+  $params: TRoute["$params"];
+  $query: TRoute["$query"];
+  $body: TRoute["$body"];
+  $response: TRoute["$response"];
+};
+
+type RouteOutput<TRoute extends Route> = TRoute["state"]["response"] extends ZodType ? TRoute["$response"] : null;
+
+type RouteErrors<TRoute extends Route> = InstanceType<TRoute["state"]["errors"][number]>;
+
+type Config = {
+  adapter: RelayAdapter;
+};
+
+type Prettify<T> = { [K in keyof T]: T[K] } & {};