@orpc/contract 0.0.0-next.b0f324e → 0.0.0-next.b11d127

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { mapEventIterator, ORPCError } from '@orpc/client';
+import { isORPCErrorStatus, mapEventIterator, ORPCError } from '@orpc/client';
 export { ORPCError } from '@orpc/client';
 import { isAsyncIteratorObject } from '@orpc/shared';
 
@@ -18,13 +18,16 @@ function mergeMeta(meta1, meta2) {
 }
 
 class ContractProcedure {
+  /**
+   * This property holds the defined options for the contract procedure.
+   */
   "~orpc";
   constructor(def) {
-    if (def.route?.successStatus && (def.route.successStatus < 200 || def.route?.successStatus > 299)) {
-      throw new Error("[ContractProcedure] The successStatus must be between 200 and 299");
+    if (def.route?.successStatus && isORPCErrorStatus(def.route.successStatus)) {
+      throw new Error("[ContractProcedure] Invalid successStatus.");
     }
-    if (Object.values(def.errorMap).some((val) => val && val.status && (val.status < 400 || val.status > 599))) {
-      throw new Error("[ContractProcedure] The error status code must be in the 400-599 range.");
+    if (Object.values(def.errorMap).some((val) => val && val.status && !isORPCErrorStatus(val.status))) {
+      throw new Error("[ContractProcedure] Invalid error status code.");
     }
     this["~orpc"] = def;
   }
@@ -33,7 +36,7 @@ function isContractProcedure(item) {
   if (item instanceof ContractProcedure) {
     return true;
   }
-  return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "inputSchema" in item["~orpc"] && "outputSchema" in item["~orpc"] && "errorMap" in item["~orpc"] && "route" in item["~orpc"] && "meta" in item["~orpc"];
+  return (typeof item === "object" || typeof item === "function") && item !== null && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "errorMap" in item["~orpc"] && "route" in item["~orpc"] && "meta" in item["~orpc"];
 }
 
 function mergeRoute(a, b) {
@@ -60,31 +63,45 @@ function mergePrefix(a, b) {
 function mergeTags(a, b) {
   return a ? [...a, ...b] : b;
 }
-function adaptRoute(route, options) {
+function enhanceRoute(route, options) {
   let router = route;
   if (options.prefix) {
     router = prefixRoute(router, options.prefix);
   }
-  if (options.tags) {
+  if (options.tags?.length) {
     router = unshiftTagRoute(router, options.tags);
   }
   return router;
 }
 
-function adaptContractRouter(contract, options) {
-  if (isContractProcedure(contract)) {
-    const adapted2 = new ContractProcedure({
-      ...contract["~orpc"],
-      errorMap: mergeErrorMap(options.errorMap, contract["~orpc"].errorMap),
-      route: adaptRoute(contract["~orpc"].route, options)
+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;
+    }
+    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 adapted2;
+    return enhanced2;
   }
-  const adapted = {};
-  for (const key in contract) {
-    adapted[key] = adaptContractRouter(contract[key], options);
+  const enhanced = {};
+  for (const key in router) {
+    enhanced[key] = enhanceContractRouter(router[key], options);
   }
-  return adapted;
+  return enhanced;
 }
 
 class ContractBuilder extends ContractProcedure {
@@ -94,7 +111,9 @@ class ContractBuilder extends ContractProcedure {
     this["~orpc"].tags = def.tags;
   }
   /**
-   * Reset initial meta
+   * Sets or overrides the initial meta.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/metadata Metadata Docs}
    */
   $meta(initialMeta) {
     return new ContractBuilder({
@@ -103,7 +122,11 @@ class ContractBuilder extends ContractProcedure {
     });
   }
   /**
-   * Reset initial route
+   * Sets or overrides the initial route.
+   * This option is typically relevant when integrating with OpenAPI.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+   * @see {@link https://orpc.unnoq.com/docs/openapi/input-output-structure OpenAPI Input/Output Structure Docs}
    */
   $route(initialRoute) {
     return new ContractBuilder({
@@ -111,56 +134,103 @@ class ContractBuilder extends ContractProcedure {
       route: initialRoute
     });
   }
+  /**
+   * 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.unnoq.com/docs/error-handling#type%E2%80%90safe-error-handling Type-Safe Error Handling Docs}
+   */
   errors(errors) {
     return new ContractBuilder({
       ...this["~orpc"],
       errorMap: mergeErrorMap(this["~orpc"].errorMap, errors)
     });
   }
+  /**
+   * 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.unnoq.com/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.unnoq.com/docs/openapi/routing OpenAPI Routing Docs}
+   * @see {@link https://orpc.unnoq.com/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.unnoq.com/docs/procedure#input-output-validation Input Validation Docs}
+   */
   input(schema) {
     return new ContractBuilder({
       ...this["~orpc"],
       inputSchema: schema
     });
   }
+  /**
+   * Defines the output validation schema for the contract.
+   *
+   * @see {@link https://orpc.unnoq.com/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.unnoq.com/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.unnoq.com/docs/openapi/openapi-specification#operation-metadata OpenAPI Operation Metadata Docs}
+   */
   tag(...tags) {
     return new ContractBuilder({
       ...this["~orpc"],
       tags: mergeTags(this["~orpc"].tags, tags)
     });
   }
+  /**
+   * Applies all of the previously defined options to the specified contract router.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/router#extending-router Extending Router Docs}
+   */
   router(router) {
-    return adaptContractRouter(router, this["~orpc"]);
+    return enhanceContractRouter(router, this["~orpc"]);
   }
 }
 const oc = new ContractBuilder({
   errorMap: {},
-  inputSchema: void 0,
-  outputSchema: void 0,
   route: {},
   meta: {}
 });
@@ -179,16 +249,16 @@ function fallbackContractConfig(key, value) {
   return value;
 }
 
-const EVENT_ITERATOR_SCHEMA_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_SCHEMA");
+const EVENT_ITERATOR_DETAILS_SYMBOL = Symbol("ORPC_EVENT_ITERATOR_DETAILS");
 function eventIterator(yields, returns) {
   return {
     "~standard": {
-      [EVENT_ITERATOR_SCHEMA_SYMBOL]: { yields, returns },
+      [EVENT_ITERATOR_DETAILS_SYMBOL]: { yields, returns },
       vendor: "orpc",
       version: 1,
       validate(iterator) {
         if (!isAsyncIteratorObject(iterator)) {
-          return { issues: [{ message: "Expect event source iterator", path: [] }] };
+          return { issues: [{ message: "Expect event iterator", path: [] }] };
         }
         const mapped = mapEventIterator(iterator, {
           async value(value, done) {
@@ -199,10 +269,10 @@ function eventIterator(yields, returns) {
             const result = await schema["~standard"].validate(value);
             if (result.issues) {
               throw new ORPCError("EVENT_ITERATOR_VALIDATION_FAILED", {
-                message: "Event source iterator validation failed",
+                message: "Event iterator validation failed",
                 cause: new ValidationError({
                   issues: result.issues,
-                  message: "Event source iterator validation failed"
+                  message: "Event iterator validation failed"
                 })
               });
             }
@@ -219,7 +289,7 @@ function getEventIteratorSchemaDetails(schema) {
   if (schema === void 0) {
     return void 0;
   }
-  return schema["~standard"][EVENT_ITERATOR_SCHEMA_SYMBOL];
+  return schema["~standard"][EVENT_ITERATOR_DETAILS_SYMBOL];
 }
 
 function type(...[map]) {
@@ -237,4 +307,4 @@ function type(...[map]) {
   };
 }
 
-export { ContractBuilder, ContractProcedure, ValidationError, adaptContractRouter, adaptRoute, eventIterator, fallbackContractConfig, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };
+export { ContractBuilder, ContractProcedure, ValidationError, enhanceContractRouter, enhanceRoute, eventIterator, fallbackContractConfig, getContractRouter, getEventIteratorSchemaDetails, isContractProcedure, mergeErrorMap, mergeMeta, mergePrefix, mergeRoute, mergeTags, oc, prefixRoute, type, unshiftTagRoute };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/contract",
   "type": "module",
-  "version": "0.0.0-next.b0f324e",
+  "version": "0.0.0-next.b11d127",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -25,14 +25,13 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@orpc/shared": "0.0.0-next.b0f324e",
-    "@orpc/standard-server": "0.0.0-next.b0f324e",
-    "@orpc/client": "0.0.0-next.b0f324e"
+    "@orpc/shared": "0.0.0-next.b11d127",
+    "@orpc/client": "0.0.0-next.b11d127"
   },
   "devDependencies": {
-    "arktype": "2.0.0-rc.26",
-    "valibot": "1.0.0-beta.9",
-    "zod": "^3.24.1"
+    "arktype": "2.1.20",
+    "valibot": "1.0.0",
+    "zod": "^3.24.2"
   },
   "scripts": {
     "build": "unbuild",