@orpc/contract 1.14.6 → 2.0.0-beta.2

package/dist/index.mjs

@@ -1,316 +1,153 @@
-import { i as isContractProcedure, C as ContractProcedure, m as mergeErrorMap, V as ValidationError } from './shared/contract.D_dZrO__.mjs';
-export { v as validateORPCError } from './shared/contract.D_dZrO__.mjs';
-import { toHttpPath } from '@orpc/client/standard';
-import { toArray, isAsyncIteratorObject, get, isTypescriptObject, isPropertyKey } from '@orpc/shared';
-export { AsyncIteratorClass } from '@orpc/shared';
-import { mapEventIterator, ORPCError } from '@orpc/client';
-export { ORPCError } from '@orpc/client';
+import { isTypescriptObject, toArray, set, get, ORPC_NAME, isAsyncIteratorObject, isPropertyKey } from '@orpc/shared';
+import { P as ProcedureContract, r as resolveMetaPlugins, m as mergeErrorMap, a as augmentContractRouter, V as ValidationError } from './shared/contract.CW-2wl1i.mjs';
+export { d as defineMeta, g as getProcedureContractOrThrow, b as getRouterContract, c as minifyRouterContract, e as reconcileORPCError } from './shared/contract.CW-2wl1i.mjs';
+import { createORPCClient, wrapEventIteratorPreservingMeta, ORPCError } from '@orpc/client';
 
-function mergeMeta(meta1, meta2) {
-  return { ...meta1, ...meta2 };
-}
-
-function mergeRoute(a, b) {
-  return { ...a, ...b };
-}
-function prefixRoute(route, prefix) {
-  if (!route.path) {
-    return route;
-  }
-  return {
-    ...route,
-    path: `${prefix}${route.path}`
-  };
-}
-function unshiftTagRoute(route, tags) {
-  return {
-    ...route,
-    tags: [...tags, ...route.tags ?? []]
-  };
-}
-function mergePrefix(a, b) {
-  return a ? `${a}${b}` : b;
-}
-function mergeTags(a, b) {
-  return a ? [...a, ...b] : b;
-}
-function enhanceRoute(route, options) {
-  let router = route;
-  if (options.prefix) {
-    router = prefixRoute(router, options.prefix);
-  }
-  if (options.tags?.length) {
-    router = unshiftTagRoute(router, options.tags);
-  }
-  return router;
-}
-
-function getContractRouter(router, path) {
-  let current = router;
-  for (let i = 0; i < path.length; i++) {
-    const segment = path[i];
-    if (!current) {
-      return void 0;
-    }
-    if (isContractProcedure(current)) {
-      return void 0;
-    }
-    if (typeof current !== "object") {
-      return void 0;
-    }
-    current = current[segment];
-  }
-  return current;
-}
-function enhanceContractRouter(router, options) {
-  if (isContractProcedure(router)) {
-    const enhanced2 = new ContractProcedure({
-      ...router["~orpc"],
-      errorMap: mergeErrorMap(options.errorMap, router["~orpc"].errorMap),
-      route: enhanceRoute(router["~orpc"].route, options)
-    });
-    return enhanced2;
-  }
-  if (typeof router !== "object" || router === null) {
-    return router;
-  }
-  const enhanced = {};
-  for (const key in router) {
-    enhanced[key] = enhanceContractRouter(router[key], options);
-  }
-  return enhanced;
-}
-function minifyContractRouter(router) {
-  if (isContractProcedure(router)) {
-    const procedure = {
-      "~orpc": {
-        errorMap: {},
-        meta: router["~orpc"].meta,
-        route: router["~orpc"].route
-      }
-    };
-    return procedure;
-  }
-  if (typeof router !== "object" || router === null) {
-    return router;
-  }
-  const json = {};
-  for (const key in router) {
-    json[key] = minifyContractRouter(router[key]);
+const HIDDEN_META_PLUGINS_SYMBOL = Symbol.for("ORPC_HIDDEN_META_PLUGINS");
+function getHiddenMetaPlugins(container) {
+  if (!isTypescriptObject(container)) {
+    return void 0;
   }
-  return json;
+  return container[HIDDEN_META_PLUGINS_SYMBOL];
 }
-function populateContractRouterPaths(router, options = {}) {
-  const path = toArray(options.path);
-  if (isContractProcedure(router)) {
-    if (router["~orpc"].route.path === void 0) {
-      return new ContractProcedure({
-        ...router["~orpc"],
-        route: {
-          ...router["~orpc"].route,
-          path: toHttpPath(path)
-        }
-      });
-    }
-    return router;
-  }
-  if (typeof router !== "object" || router === null) {
-    return router;
-  }
-  const populated = {};
-  for (const key in router) {
-    populated[key] = populateContractRouterPaths(router[key], { ...options, path: [...path, key] });
-  }
-  return populated;
+function setHiddenMetaPlugins(container, metaPlugins) {
+  container[HIDDEN_META_PLUGINS_SYMBOL] = metaPlugins;
 }
 
-class ContractBuilder extends ContractProcedure {
-  constructor(def) {
-    super(def);
-    this["~orpc"].prefix = def.prefix;
-    this["~orpc"].tags = def.tags;
-  }
+class ContractBuilder extends ProcedureContract {
   /**
-   * Sets or overrides the initial meta.
-   *
-   * @see {@link https://orpc.dev/docs/metadata Metadata Docs}
+   * Private constructor to prevent direct instantiation.
+   * Use the static `create` method to initialize a new instance with a safe initial definition.
    */
-  $meta(initialMeta) {
-    return new ContractBuilder({
-      ...this["~orpc"],
-      meta: initialMeta
-    });
+  constructor(definition) {
+    super(definition);
   }
-  /**
-   * Sets or overrides the initial route.
-   * This option is typically relevant when integrating with OpenAPI.
-   *
-   * @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
-   * @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
-   */
-  $route(initialRoute) {
+  static create() {
     return new ContractBuilder({
-      ...this["~orpc"],
-      route: initialRoute
+      errorMap: {},
+      meta: {}
     });
   }
-  /**
-   * Sets or overrides the initial input schema.
-   *
-   * @see {@link https://orpc.dev/docs/procedure#initial-configuration Initial Procedure Configuration Docs}
-   */
-  $input(initialInputSchema) {
+  meta(...plugins) {
+    const [meta, metaPlugins] = resolveMetaPlugins(
+      this["~orpc"].meta,
+      this["~orpc"].metaPlugins,
+      plugins
+    );
     return new ContractBuilder({
       ...this["~orpc"],
-      inputSchema: initialInputSchema
+      meta,
+      metaPlugins
     });
   }
-  /**
-   * Adds type-safe custom errors to the contract.
-   * The provided errors are spared-merged with any existing errors in the contract.
-   *
-   * @see {@link https://orpc.dev/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
-   */
   errors(errors) {
-    return new ContractBuilder({
+    let result = new ContractBuilder({
       ...this["~orpc"],
       errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
     });
+    const plugins = getHiddenMetaPlugins(errors);
+    if (plugins) {
+      result = result.meta(...plugins);
+    }
+    return result;
   }
-  /**
-   * Sets or updates the metadata for the contract.
-   * The provided metadata is spared-merged with any existing metadata in the contract.
-   *
-   * @see {@link https://orpc.dev/docs/metadata Metadata Docs}
-   */
-  meta(meta) {
-    return new ContractBuilder({
-      ...this["~orpc"],
-      meta: mergeMeta(this["~orpc"].meta, meta)
-    });
-  }
-  /**
-   * Sets or updates the route definition for the contract.
-   * The provided route is spared-merged with any existing route in the contract.
-   * This option is typically relevant when integrating with OpenAPI.
-   *
-   * @see {@link https://orpc.dev/docs/openapi/routing OpenAPI Routing Docs}
-   * @see {@link https://orpc.dev/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
-   */
-  route(route) {
-    return new ContractBuilder({
-      ...this["~orpc"],
-      route: mergeRoute(this["~orpc"].route, route)
-    });
-  }
-  /**
-   * Defines the input validation schema for the contract.
-   *
-   * @see {@link https://orpc.dev/docs/procedure#input-output-validation Input Validation Docs}
-   */
   input(schema) {
-    return new ContractBuilder({
+    let result = new ContractBuilder({
       ...this["~orpc"],
-      inputSchema: schema
+      inputSchemas: [...toArray(this["~orpc"].inputSchemas), schema]
     });
+    const plugins = getHiddenMetaPlugins(schema);
+    if (plugins) {
+      result = result.meta(...plugins);
+    }
+    return result;
   }
-  /**
-   * Defines the output validation schema for the contract.
-   *
-   * @see {@link https://orpc.dev/docs/procedure#input-output-validation Output Validation Docs}
-   */
   output(schema) {
-    return new ContractBuilder({
-      ...this["~orpc"],
-      outputSchema: schema
-    });
-  }
-  /**
-   * Prefixes all procedures in the contract router.
-   * The provided prefix is post-appended to any existing router prefix.
-   *
-   * @note This option does not affect procedures that do not define a path in their route definition.
-   *
-   * @see {@link https://orpc.dev/docs/openapi/routing#route-prefixes OpenAPI Route Prefixes Docs}
-   */
-  prefix(prefix) {
-    return new ContractBuilder({
-      ...this["~orpc"],
-      prefix: mergePrefix(this["~orpc"].prefix, prefix)
-    });
-  }
-  /**
-   * Adds tags to all procedures in the contract router.
-   * This helpful when you want to group procedures together in the OpenAPI specification.
-   *
-   * @see {@link https://orpc.dev/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
-   */
-  tag(...tags) {
-    return new ContractBuilder({
+    let result = new ContractBuilder({
       ...this["~orpc"],
-      tags: mergeTags(this["~orpc"].tags, tags)
+      outputSchemas: [...toArray(this["~orpc"].outputSchemas), schema]
     });
+    const plugins = getHiddenMetaPlugins(schema);
+    if (plugins) {
+      result = result.meta(...plugins);
+    }
+    return result;
   }
-  /**
-   * Applies all of the previously defined options to the specified contract router.
-   *
-   * @see {@link https://orpc.dev/docs/router#extending-router Extending Router Docs}
-   */
   router(router) {
-    return enhanceContractRouter(router, this["~orpc"]);
+    return augmentContractRouter(router, this["~orpc"]);
   }
 }
-const oc = new ContractBuilder({
-  errorMap: {},
-  route: {},
-  meta: {}
-});
+const oc = ContractBuilder.create();
 
-const DEFAULT_CONFIG = {
-  defaultMethod: "POST",
-  defaultSuccessStatus: 200,
-  defaultSuccessDescription: "OK",
-  defaultInputStructure: "compact",
-  defaultOutputStructure: "compact"
-};
-function fallbackContractConfig(key, value) {
-  if (value === void 0) {
-    return DEFAULT_CONFIG[key];
+const meta = {
+  path(path) {
+    return {
+      name: "~path",
+      init(meta2) {
+        return {
+          ...meta2,
+          "~path": path
+        };
+      }
+    };
   }
-  return value;
+};
+function getPathMeta(procedureOrLazy) {
+  return procedureOrLazy["~orpc"].meta["~path"];
 }
 
-const EVENT_ITERATOR_DETAILS_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_DETAILS");
-function eventIterator(yields, returns) {
+function createContractCaller(link, options = {}) {
+  return async (procedure, ...rest) => {
+    const path = getPathMeta(procedure);
+    if (!path) {
+      throw new TypeError(
+        "ContractCaller: procedure contract must define `meta.path` that matches its path in the root router contract."
+      );
+    }
+    if (options.contractRef) {
+      set(options.contractRef, [...path, "~orpc"], procedure["~orpc"]);
+    }
+    const scoped = get(options.scoped, path);
+    if (scoped !== void 0 && (scoped === null || typeof scoped !== "object")) {
+      throw new TypeError(
+        `ContractCaller: "scoped" at path "${path.join(".")}" must be an object or undefined, got "${scoped}".`
+      );
+    }
+    const client = createORPCClient(link, { path, interceptors: options.interceptors, scoped });
+    return client(...rest);
+  };
+}
+
+const EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL = Symbol.for("ORPC_EVENT_ITERATOR_SCHEMA_DETAILS");
+function eventIterator(yieldSchema, returnSchema) {
   return {
     "~standard": {
-      [EVENT_ITERATOR_DETAILS_SYMBOL]: { yields, returns },
-      vendor: "orpc",
+      [EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL]: { yieldSchema, returnSchema },
+      vendor: ORPC_NAME,
       version: 1,
       validate(iterator) {
         if (!isAsyncIteratorObject(iterator)) {
           return { issues: [{ message: "Expect event iterator", path: [] }] };
         }
-        const mapped = mapEventIterator(iterator, {
-          async value(value, done) {
-            const schema = done ? returns : yields;
+        const mapped = wrapEventIteratorPreservingMeta(iterator, {
+          async mapResult(result) {
+            const schema = result.done ? returnSchema : yieldSchema;
             if (!schema) {
-              return value;
+              return result;
             }
-            const result = await schema["~standard"].validate(value);
-            if (result.issues) {
+            const validated = await schema["~standard"].validate(result.value);
+            if (validated.issues) {
               throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
                 message: "Event iterator validation failed",
                 cause: new ValidationError({
-                  issues: result.issues,
+                  issues: validated.issues,
                   message: "Event iterator validation failed",
-                  data: value
+                  invalidData: result.value
                 })
               });
             }
-            return result.value;
-          },
-          error: async (error) => error
+            return { done: result.done, value: validated.value };
+          }
         });
         return { value: mapped };
       }
@@ -321,26 +158,13 @@ function getEventIteratorSchemaDetails(schema) {
   if (schema === void 0) {
     return void 0;
   }
-  return schema["~standard"][EVENT_ITERATOR_DETAILS_SYMBOL];
-}
-
-function inferRPCMethodFromContractRouter(contract) {
-  return (_, path) => {
-    const procedure = get(contract, path);
-    if (!isContractProcedure(procedure)) {
-      throw new Error(
-        `[inferRPCMethodFromContractRouter] No valid procedure found at path "${path.join(".")}". This may happen when the contract router is not properly configured.`
-      );
-    }
-    const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
-    return method === "HEAD" ? "GET" : method;
-  };
+  return schema["~standard"][EVENT_ITERATOR_SCHEMA_DETAILS_SYMBOL];
 }
 
 function type(...[map]) {
   return {
     "~standard": {
-      vendor: "custom",
+      vendor: ORPC_NAME,
       version: 1,
       async validate(value) {
         if (map) {
@@ -351,7 +175,6 @@ function type(...[map]) {
     }
   };
 }
-
 function isSchemaIssue(issue) {
   if (!isTypescriptObject(issue) || typeof issue.message !== "string") {
     return false;
@@ -367,4 +190,4 @@ function isSchemaIssue(issue) {
   return true;
 }
 
-export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, inferRPCMethodFromContractRouter, isContractProcedure, isSchemaIssue, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, minifyContractRouter, oc, populateContractRouterPaths, prefixRoute, type, unshiftTagRoute };
+export { ContractBuilder, HIDDEN_META_PLUGINS_SYMBOL, ProcedureContract, ValidationError, augmentContractRouter, createContractCaller, eventIterator, getEventIteratorSchemaDetails, getHiddenMetaPlugins, getPathMeta, isSchemaIssue, mergeErrorMap, meta, oc, resolveMetaPlugins, setHiddenMetaPlugins, type };

package/dist/plugins/index.d.mts

@@ -1,43 +1,38 @@
 import { ClientContext } from '@orpc/client';
 import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
-import { A as AnyContractRouter } from '../shared/contract.TuRtB1Ca.mjs';
+import { R as RouterContract } from '../shared/contract.Do92aRJ4.mjs';
 import '@orpc/shared';
 import '@standard-schema/spec';
-import 'openapi-types';
 
-declare class RequestValidationPluginError extends Error {
+interface RequestValidationLinkPluginOptions<_T extends ClientContext> {
+    /**
+     * Forwards the locally validated/transformed input downstream.
+     *
+     * Disabled by default because some schema transforms produce a locally valid
+     * value that cannot be validated successfully again by the server.
+     * Keeping the original input as the flow input is the safer default.
+     *
+     * @default false
+     */
+    forwardValidatedInput?: boolean | undefined;
 }
 /**
- * A link plugin that validates client requests against your contract schema,
- * ensuring that data sent to your server matches the expected types defined in your contract.
- *
- * @throws {ORPCError} with code `BAD_REQUEST` (same as server side) if input doesn't match the expected schema
- * @see {@link https://orpc.dev/docs/plugins/request-validation Request Validation Plugin Docs}
+ * Validates client request input against contract schemas before the request is encoded.
  */
-declare class RequestValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+declare class RequestValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
-    constructor(contract: AnyContractRouter);
-    init(options: StandardLinkOptions<T>): void;
+    name: string;
+    private readonly forwardValidatedInput;
+    constructor(contract: RouterContract, options?: RequestValidationLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-/**
- * A link plugin that validates server responses against your contract schema,
- * ensuring that data returned from your server matches the expected types defined in your contract.
- *
- * - Throws `ValidationError` if output doesn't match the expected schema
- * - Converts mismatched defined errors to normal `ORPCError` instances
- *
- * @see {@link https://orpc.dev/docs/plugins/response-validation Response Validation Plugin Docs}
- */
-declare class ResponseValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+declare class ResponseValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
-    constructor(contract: AnyContractRouter);
-    /**
-     * run before (validate after) retry plugin, because validation failed can't be retried
-     * run before (validate after) durable iterator plugin, because we expect durable iterator to validation (if user use it)
-     */
-    order: number;
-    init(options: StandardLinkOptions<T>): void;
+    name: string;
+    constructor(contract: RouterContract);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { RequestValidationPlugin, RequestValidationPluginError, ResponseValidationPlugin };
+export { RequestValidationLinkPlugin, ResponseValidationLinkPlugin };
+export type { RequestValidationLinkPluginOptions };

package/dist/plugins/index.d.ts

@@ -1,43 +1,38 @@
 import { ClientContext } from '@orpc/client';
 import { StandardLinkPlugin, StandardLinkOptions } from '@orpc/client/standard';
-import { A as AnyContractRouter } from '../shared/contract.TuRtB1Ca.js';
+import { R as RouterContract } from '../shared/contract.Do92aRJ4.js';
 import '@orpc/shared';
 import '@standard-schema/spec';
-import 'openapi-types';
 
-declare class RequestValidationPluginError extends Error {
+interface RequestValidationLinkPluginOptions<_T extends ClientContext> {
+    /**
+     * Forwards the locally validated/transformed input downstream.
+     *
+     * Disabled by default because some schema transforms produce a locally valid
+     * value that cannot be validated successfully again by the server.
+     * Keeping the original input as the flow input is the safer default.
+     *
+     * @default false
+     */
+    forwardValidatedInput?: boolean | undefined;
 }
 /**
- * A link plugin that validates client requests against your contract schema,
- * ensuring that data sent to your server matches the expected types defined in your contract.
- *
- * @throws {ORPCError} with code `BAD_REQUEST` (same as server side) if input doesn't match the expected schema
- * @see {@link https://orpc.dev/docs/plugins/request-validation Request Validation Plugin Docs}
+ * Validates client request input against contract schemas before the request is encoded.
  */
-declare class RequestValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+declare class RequestValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
-    constructor(contract: AnyContractRouter);
-    init(options: StandardLinkOptions<T>): void;
+    name: string;
+    private readonly forwardValidatedInput;
+    constructor(contract: RouterContract, options?: RequestValidationLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-/**
- * A link plugin that validates server responses against your contract schema,
- * ensuring that data returned from your server matches the expected types defined in your contract.
- *
- * - Throws `ValidationError` if output doesn't match the expected schema
- * - Converts mismatched defined errors to normal `ORPCError` instances
- *
- * @see {@link https://orpc.dev/docs/plugins/response-validation Response Validation Plugin Docs}
- */
-declare class ResponseValidationPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+declare class ResponseValidationLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly contract;
-    constructor(contract: AnyContractRouter);
-    /**
-     * run before (validate after) retry plugin, because validation failed can't be retried
-     * run before (validate after) durable iterator plugin, because we expect durable iterator to validation (if user use it)
-     */
-    order: number;
-    init(options: StandardLinkOptions<T>): void;
+    name: string;
+    constructor(contract: RouterContract);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { RequestValidationPlugin, RequestValidationPluginError, ResponseValidationPlugin };
+export { RequestValidationLinkPlugin, ResponseValidationLinkPlugin };
+export type { RequestValidationLinkPluginOptions };