@orpc/server 0.0.0-next.c59d67c → 0.0.0-next.ca29a36

package/README.md

@@ -0,0 +1,118 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/server">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fserver?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/server`
+
+Build your API or implement API contract. Read the [documentation](https://orpc.unnoq.com/docs/getting-started) for more information.
+
+```ts
+import type { IncomingHttpHeaders } from 'node:http'
+import { ORPCError, os } from '@orpc/server'
+import { z } from 'zod'
+
+const PlanetSchema = z.object({
+  id: z.number().int().min(1),
+  name: z.string(),
+  description: z.string().optional(),
+})
+
+export const listPlanet = os
+  .input(
+    z.object({
+      limit: z.number().int().min(1).max(100).optional(),
+      cursor: z.number().int().min(0).default(0),
+    }),
+  )
+  .handler(async ({ input }) => {
+    // your list code here
+    return [{ id: 1, name: 'name' }]
+  })
+
+export const findPlanet = os
+  .input(PlanetSchema.pick({ id: true }))
+  .handler(async ({ input }) => {
+    // your find code here
+    return { id: 1, name: 'name' }
+  })
+
+export const createPlanet = os
+  .$context<{ headers: IncomingHttpHeaders }>()
+  .use(({ context, next }) => {
+    const user = parseJWT(context.headers.authorization?.split(' ')[1])
+
+    if (user) {
+      return next({ context: { user } })
+    }
+
+    throw new ORPCError('UNAUTHORIZED')
+  })
+  .input(PlanetSchema.omit({ id: true }))
+  .handler(async ({ input, context }) => {
+    // your create code here
+    return { id: 1, name: 'name' }
+  })
+
+export const router = { planet: { list: listPlanet, find: findPlanet, create: createPlanet } }
+```
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/chunk-MBMXGUNI.js

@@ -0,0 +1,32 @@
+import {
+  RPCCodec,
+  RPCMatcher,
+  StandardHandler
+} from "./chunk-NTHCS5CK.js";
+
+// src/adapters/fetch/rpc-handler.ts
+import { toFetchResponse, toStandardRequest } from "@orpc/standard-server-fetch";
+var RPCHandler = class {
+  standardHandler;
+  constructor(router, options) {
+    const matcher = options?.matcher ?? new RPCMatcher();
+    const codec = options?.codec ?? new RPCCodec();
+    this.standardHandler = new StandardHandler(router, matcher, codec, options);
+  }
+  async handle(request, ...rest) {
+    const standardRequest = toStandardRequest(request);
+    const result = await this.standardHandler.handle(standardRequest, ...rest);
+    if (!result.matched) {
+      return result;
+    }
+    return {
+      matched: true,
+      response: toFetchResponse(result.response)
+    };
+  }
+};
+
+export {
+  RPCHandler
+};
+//# sourceMappingURL=chunk-MBMXGUNI.js.map

package/dist/chunk-MHVECKBC.js

@@ -0,0 +1,421 @@
+// src/lazy.ts
+var LAZY_LOADER_SYMBOL = Symbol("ORPC_LAZY_LOADER");
+function lazy(loader) {
+  return {
+    [LAZY_LOADER_SYMBOL]: loader
+  };
+}
+function isLazy(item) {
+  return (typeof item === "object" || typeof item === "function") && item !== null && LAZY_LOADER_SYMBOL in item && typeof item[LAZY_LOADER_SYMBOL] === "function";
+}
+function unlazy(lazied) {
+  return isLazy(lazied) ? lazied[LAZY_LOADER_SYMBOL]() : Promise.resolve({ default: lazied });
+}
+
+// src/procedure.ts
+import { isContractProcedure } from "@orpc/contract";
+var Procedure = class {
+  "~orpc";
+  constructor(def) {
+    this["~orpc"] = def;
+  }
+};
+function isProcedure(item) {
+  if (item instanceof Procedure) {
+    return true;
+  }
+  return isContractProcedure(item) && "middlewares" in item["~orpc"] && "inputValidationIndex" in item["~orpc"] && "outputValidationIndex" in item["~orpc"] && "handler" in item["~orpc"];
+}
+
+// src/lazy-utils.ts
+function flatLazy(lazied) {
+  const flattenLoader = async () => {
+    let current = await unlazy(lazied);
+    while (true) {
+      if (!isLazy(current.default)) {
+        break;
+      }
+      current = await unlazy(current.default);
+    }
+    return current;
+  };
+  return lazy(flattenLoader);
+}
+function createLazyProcedureFormAnyLazy(lazied) {
+  const lazyProcedure = lazy(async () => {
+    const { default: maybeProcedure } = await unlazy(flatLazy(lazied));
+    if (!isProcedure(maybeProcedure)) {
+      throw new Error(`
+            Expected a lazy<procedure> but got lazy<unknown>.
+            This should be caught by TypeScript compilation.
+            Please report this issue if this makes you feel uncomfortable.
+        `);
+    }
+    return { default: maybeProcedure };
+  });
+  return lazyProcedure;
+}
+
+// src/middleware.ts
+function middlewareOutputFn(output) {
+  return { output, context: {} };
+}
+
+// src/procedure-client.ts
+import { ORPCError as ORPCError2 } from "@orpc/client";
+import { ValidationError } from "@orpc/contract";
+import { intercept, toError, value } from "@orpc/shared";
+
+// src/error.ts
+import { fallbackORPCErrorStatus, ORPCError } from "@orpc/client";
+function createORPCErrorConstructorMap(errors) {
+  const proxy = new Proxy(errors, {
+    get(target, code) {
+      if (typeof code !== "string") {
+        return Reflect.get(target, code);
+      }
+      const item = (...[options]) => {
+        const config = errors[code];
+        return new ORPCError(code, {
+          defined: Boolean(config),
+          status: config?.status,
+          message: options?.message ?? config?.message,
+          data: options?.data,
+          cause: options?.cause
+        });
+      };
+      return item;
+    }
+  });
+  return proxy;
+}
+async function validateORPCError(map, error) {
+  const { code, status, message, data, cause, defined } = error;
+  const config = map?.[error.code];
+  if (!config || fallbackORPCErrorStatus(error.code, config.status) !== error.status) {
+    return defined ? new ORPCError(code, { defined: false, status, message, data, cause }) : error;
+  }
+  if (!config.data) {
+    return defined ? error : new ORPCError(code, { defined: true, status, message, data, cause });
+  }
+  const validated = await config.data["~standard"].validate(error.data);
+  if (validated.issues) {
+    return defined ? new ORPCError(code, { defined: false, status, message, data, cause }) : error;
+  }
+  return new ORPCError(code, { defined: true, status, message, data: validated.value, cause });
+}
+
+// src/procedure-client.ts
+function createProcedureClient(lazyableProcedure, ...[options]) {
+  return async (...[input, callerOptions]) => {
+    const path = options?.path ?? [];
+    const { default: procedure } = await unlazy(lazyableProcedure);
+    const clientContext = callerOptions?.context ?? {};
+    const context = await value(options?.context ?? {}, clientContext);
+    const errors = createORPCErrorConstructorMap(procedure["~orpc"].errorMap);
+    try {
+      return await intercept(
+        options?.interceptors ?? [],
+        {
+          context,
+          input,
+          // input only optional when it undefinable so we can safely cast it
+          errors,
+          path,
+          procedure,
+          signal: callerOptions?.signal,
+          lastEventId: callerOptions?.lastEventId
+        },
+        (interceptorOptions) => executeProcedureInternal(interceptorOptions.procedure, interceptorOptions)
+      );
+    } catch (e) {
+      if (!(e instanceof ORPCError2)) {
+        throw toError(e);
+      }
+      const validated = await validateORPCError(procedure["~orpc"].errorMap, e);
+      throw validated;
+    }
+  };
+}
+async function validateInput(procedure, input) {
+  const schema = procedure["~orpc"].inputSchema;
+  if (!schema) {
+    return input;
+  }
+  const result = await schema["~standard"].validate(input);
+  if (result.issues) {
+    throw new ORPCError2("BAD_REQUEST", {
+      message: "Input validation failed",
+      data: {
+        issues: result.issues
+      },
+      cause: new ValidationError({ message: "Input validation failed", issues: result.issues })
+    });
+  }
+  return result.value;
+}
+async function validateOutput(procedure, output) {
+  const schema = procedure["~orpc"].outputSchema;
+  if (!schema) {
+    return output;
+  }
+  const result = await schema["~standard"].validate(output);
+  if (result.issues) {
+    throw new ORPCError2("INTERNAL_SERVER_ERROR", {
+      message: "Output validation failed",
+      cause: new ValidationError({ message: "Output validation failed", issues: result.issues })
+    });
+  }
+  return result.value;
+}
+async function executeProcedureInternal(procedure, options) {
+  const middlewares = procedure["~orpc"].middlewares;
+  const inputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].inputValidationIndex), middlewares.length);
+  const outputValidationIndex = Math.min(Math.max(0, procedure["~orpc"].outputValidationIndex), middlewares.length);
+  let currentIndex = 0;
+  let currentContext = options.context;
+  let currentInput = options.input;
+  const next = async (...[nextOptions]) => {
+    const index = currentIndex;
+    currentIndex += 1;
+    currentContext = { ...currentContext, ...nextOptions?.context };
+    if (index === inputValidationIndex) {
+      currentInput = await validateInput(procedure, currentInput);
+    }
+    const mid = middlewares[index];
+    const result = mid ? await mid({ ...options, context: currentContext, next }, currentInput, middlewareOutputFn) : { output: await procedure["~orpc"].handler({ ...options, context: currentContext, input: currentInput }), context: currentContext };
+    if (index === outputValidationIndex) {
+      const validatedOutput = await validateOutput(procedure, result.output);
+      return {
+        ...result,
+        output: validatedOutput
+      };
+    }
+    return result;
+  };
+  return (await next({})).output;
+}
+
+// src/hidden.ts
+var ROUTER_CONTRACT_SYMBOL = Symbol("ORPC_ROUTER_CONTRACT");
+function setRouterContract(obj, contract) {
+  return new Proxy(obj, {
+    get(target, key) {
+      if (key === ROUTER_CONTRACT_SYMBOL) {
+        return contract;
+      }
+      return Reflect.get(target, key);
+    }
+  });
+}
+function getRouterContract(obj) {
+  return obj[ROUTER_CONTRACT_SYMBOL];
+}
+var LAZY_ROUTER_PREFIX_SYMBOL = Symbol("ORPC_LAZY_ROUTER_PREFIX");
+function deepSetLazyRouterPrefix(router, prefix) {
+  return new Proxy(router, {
+    get(target, key) {
+      if (key !== LAZY_ROUTER_PREFIX_SYMBOL) {
+        const val = Reflect.get(target, key);
+        if (isLazy(val)) {
+          return deepSetLazyRouterPrefix(val, prefix);
+        }
+        return val;
+      }
+      return prefix;
+    }
+  });
+}
+function getLazyRouterPrefix(obj) {
+  return obj[LAZY_ROUTER_PREFIX_SYMBOL];
+}
+
+// src/router.ts
+import { adaptRoute, mergeErrorMap, mergePrefix } from "@orpc/contract";
+
+// src/middleware-utils.ts
+function dedupeMiddlewares(compare, middlewares) {
+  let min = 0;
+  for (let i = 0; i < middlewares.length; i++) {
+    const index = compare.indexOf(middlewares[i], min);
+    if (index === -1) {
+      return middlewares.slice(i);
+    }
+    min = index + 1;
+  }
+  return [];
+}
+function mergeMiddlewares(first, second) {
+  return [...first, ...dedupeMiddlewares(first, second)];
+}
+function addMiddleware(middlewares, addition) {
+  return [...middlewares, addition];
+}
+
+// src/router.ts
+function adaptRouter(router, options) {
+  if (isLazy(router)) {
+    const adapted2 = lazy(async () => {
+      const unlaziedRouter = (await unlazy(router)).default;
+      const adapted3 = adaptRouter(unlaziedRouter, options);
+      return { default: adapted3 };
+    });
+    const accessible = createAccessibleLazyRouter(adapted2);
+    const currentPrefix = getLazyRouterPrefix(router);
+    const prefix = currentPrefix ? mergePrefix(options.prefix, currentPrefix) : options.prefix;
+    if (prefix) {
+      return deepSetLazyRouterPrefix(accessible, prefix);
+    }
+    return accessible;
+  }
+  if (isProcedure(router)) {
+    const newMiddlewares = mergeMiddlewares(options.middlewares, router["~orpc"].middlewares);
+    const newMiddlewareAdded = newMiddlewares.length - router["~orpc"].middlewares.length;
+    const adapted2 = new Procedure({
+      ...router["~orpc"],
+      route: adaptRoute(router["~orpc"].route, options),
+      errorMap: mergeErrorMap(options.errorMap, router["~orpc"].errorMap),
+      middlewares: newMiddlewares,
+      inputValidationIndex: router["~orpc"].inputValidationIndex + newMiddlewareAdded,
+      outputValidationIndex: router["~orpc"].outputValidationIndex + newMiddlewareAdded
+    });
+    return adapted2;
+  }
+  const adapted = {};
+  for (const key in router) {
+    adapted[key] = adaptRouter(router[key], options);
+  }
+  return adapted;
+}
+function getRouterChild(router, ...path) {
+  let current = router;
+  for (let i = 0; i < path.length; i++) {
+    const segment = path[i];
+    if (!current) {
+      return void 0;
+    }
+    if (isProcedure(current)) {
+      return void 0;
+    }
+    if (!isLazy(current)) {
+      current = current[segment];
+      continue;
+    }
+    const lazied = current;
+    const rest = path.slice(i);
+    const newLazy = lazy(async () => {
+      const unwrapped = await unlazy(lazied);
+      if (!unwrapped.default) {
+        return unwrapped;
+      }
+      const next = getRouterChild(unwrapped.default, ...rest);
+      return { default: next };
+    });
+    return flatLazy(newLazy);
+  }
+  return current;
+}
+
+// src/router-accessible-lazy.ts
+function createAccessibleLazyRouter(lazied) {
+  const flattenLazy = flatLazy(lazied);
+  const recursive = new Proxy(flattenLazy, {
+    get(target, key) {
+      if (typeof key !== "string") {
+        return Reflect.get(target, key);
+      }
+      const next = getRouterChild(flattenLazy, key);
+      return createAccessibleLazyRouter(next);
+    }
+  });
+  return recursive;
+}
+
+// src/utils.ts
+import { isContractProcedure as isContractProcedure2 } from "@orpc/contract";
+function eachContractProcedure(options, callback, laziedOptions = []) {
+  const hiddenContract = getRouterContract(options.router);
+  if (hiddenContract) {
+    return eachContractProcedure(
+      {
+        router: hiddenContract,
+        path: options.path
+      },
+      callback,
+      laziedOptions
+    );
+  }
+  if (isLazy(options.router)) {
+    laziedOptions.push({
+      lazied: options.router,
+      path: options.path
+    });
+  } else if (isContractProcedure2(options.router)) {
+    callback({
+      contract: options.router,
+      path: options.path
+    });
+  } else {
+    for (const key in options.router) {
+      eachContractProcedure(
+        {
+          router: options.router[key],
+          path: [...options.path, key]
+        },
+        callback,
+        laziedOptions
+      );
+    }
+  }
+  return laziedOptions;
+}
+async function eachAllContractProcedure(options, callback) {
+  const pending = [options];
+  for (const item of pending) {
+    const lazies = eachContractProcedure(item, callback);
+    for (const lazy2 of lazies) {
+      const { default: router } = await unlazy(lazy2.lazied);
+      pending.push({
+        path: lazy2.path,
+        router
+      });
+    }
+  }
+}
+function convertPathToHttpPath(path) {
+  return `/${path.map(encodeURIComponent).join("/")}`;
+}
+function createContractedProcedure(contract, procedure) {
+  return new Procedure({
+    ...procedure["~orpc"],
+    errorMap: contract["~orpc"].errorMap,
+    route: contract["~orpc"].route,
+    meta: contract["~orpc"].meta
+  });
+}
+
+export {
+  LAZY_LOADER_SYMBOL,
+  lazy,
+  isLazy,
+  unlazy,
+  Procedure,
+  isProcedure,
+  flatLazy,
+  createLazyProcedureFormAnyLazy,
+  addMiddleware,
+  middlewareOutputFn,
+  createProcedureClient,
+  setRouterContract,
+  getRouterContract,
+  deepSetLazyRouterPrefix,
+  getLazyRouterPrefix,
+  createAccessibleLazyRouter,
+  adaptRouter,
+  getRouterChild,
+  eachContractProcedure,
+  eachAllContractProcedure,
+  convertPathToHttpPath,
+  createContractedProcedure
+};
+//# sourceMappingURL=chunk-MHVECKBC.js.map