@orpc/contract 0.0.0-next.5d3da98 → 0.0.0-next.6083cd9

package/dist/index.js

@@ -3,6 +3,9 @@ var ContractProcedure = class {
   "~type" = "ContractProcedure";
   "~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");
+    }
     this["~orpc"] = def;
   }
 };
@@ -142,6 +145,31 @@ var ContractBuilder = class {
   }
 };
 
+// src/config.ts
+var DEFAULT_CONFIG = {
+  defaultMethod: "POST",
+  defaultSuccessStatus: 200,
+  defaultInputStructure: "compact",
+  defaultOutputStructure: "compact"
+};
+var GLOBAL_CONFIG_REF = { value: DEFAULT_CONFIG };
+function configGlobal(config) {
+  if (config.defaultSuccessStatus !== void 0 && (config.defaultSuccessStatus < 200 || config.defaultSuccessStatus > 299)) {
+    throw new Error("[configGlobal] The defaultSuccessStatus must be between 200 and 299");
+  }
+  GLOBAL_CONFIG_REF.value = config;
+}
+function fallbackToGlobalConfig(key, value) {
+  if (value === void 0) {
+    const fallback = GLOBAL_CONFIG_REF.value[key];
+    if (fallback === void 0) {
+      return DEFAULT_CONFIG[key];
+    }
+    return fallback;
+  }
+  return value;
+}
+
 // src/index.ts
 var oc = new ContractBuilder();
 export {
@@ -149,6 +177,8 @@ export {
   ContractProcedure,
   ContractRouterBuilder,
   DecoratedContractProcedure,
+  configGlobal,
+  fallbackToGlobalConfig,
   isContractProcedure,
   oc
 };

package/dist/src/config.d.ts

@@ -0,0 +1,31 @@
+import type { HTTPMethod, InputStructure } from './types';
+export interface ORPCConfig {
+    /**
+     * @default 'POST'
+     */
+    defaultMethod?: HTTPMethod;
+    /**
+     *
+     * @default 200
+     */
+    defaultSuccessStatus?: number;
+    /**
+     *
+     * @default 'compact'
+     */
+    defaultInputStructure?: InputStructure;
+    /**
+     *
+     * @default 'compact'
+     */
+    defaultOutputStructure?: InputStructure;
+}
+/**
+ * Set the global configuration, this configuration can effect entire project
+ */
+export declare function configGlobal(config: ORPCConfig): void;
+/**
+ * Fallback the value to the global config if it is undefined
+ */
+export declare function fallbackToGlobalConfig<T extends keyof ORPCConfig>(key: T, value: ORPCConfig[T]): Exclude<ORPCConfig[T], undefined>;
+//# sourceMappingURL=config.d.ts.map

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 /** unnoq */
 import { ContractBuilder } from './builder';
 export * from './builder';
+export * from './config';
 export * from './procedure';
 export * from './procedure-decorated';
 export * from './router';

package/dist/src/procedure.d.ts

@@ -1,4 +1,4 @@
-import type { HTTPMethod, HTTPPath, Schema, SchemaOutput } from './types';
+import type { HTTPMethod, HTTPPath, InputStructure, OutputStructure, Schema, SchemaOutput } from './types';
 export interface RouteOptions {
     method?: HTTPMethod;
     path?: HTTPPath;
@@ -6,6 +6,56 @@ export interface RouteOptions {
     description?: string;
     deprecated?: boolean;
     tags?: readonly string[];
+    /**
+     * The status code of the response when the procedure is successful.
+     *
+     * @default 200
+     */
+    successStatus?: number;
+    /**
+     * Determines how the input should be structured based on `params`, `query`, `headers`, and `body`.
+     *
+     * @option 'compact'
+     * Combines `params` and either `query` or `body` (depending on the HTTP method) into a single object.
+     *
+     * @option 'detailed'
+     * Keeps each part of the request (`params`, `query`, `headers`, and `body`) as separate fields in the input object.
+     *
+     * Example:
+     * ```ts
+     * const input = {
+     *   params: { id: 1 },
+     *   query: { search: 'hello' },
+     *   headers: { 'Content-Type': 'application/json' },
+     *   body: { name: 'John' },
+     * }
+     * ```
+     *
+     * @default 'compact'
+     */
+    inputStructure?: InputStructure;
+    /**
+     * Determines how the response should be structured based on the output.
+     *
+     * @option 'compact'
+     * Includes only the body data, encoded directly in the response.
+     *
+     * @option 'detailed'
+     * Separates the output into `headers` and `body` fields.
+     * - `headers`: Custom headers to merge with the response headers.
+     * - `body`: The response data.
+     *
+     * Example:
+     * ```ts
+     * const output = {
+     *   headers: { 'x-custom-header': 'value' },
+     *   body: { message: 'Hello, world!' },
+     * };
+     * ```
+     *
+     * @default 'compact'
+     */
+    outputStructure?: OutputStructure;
 }
 export interface ContractProcedureDef<TInputSchema extends Schema, TOutputSchema extends Schema> {
     route?: RouteOptions;

package/dist/src/types.d.ts

@@ -1,6 +1,8 @@
 import type { StandardSchemaV1 } from '@standard-schema/spec';
 export type HTTPPath = `/${string}`;
 export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+export type InputStructure = 'compact' | 'detailed';
+export type OutputStructure = 'compact' | 'detailed';
 export type Schema = StandardSchemaV1 | undefined;
 export type SchemaInput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : TFallback;
 export type SchemaOutput<TSchema extends Schema, TFallback = unknown> = TSchema extends undefined ? TFallback : TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : TFallback;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/contract",
   "type": "module",
-  "version": "0.0.0-next.5d3da98",
+  "version": "0.0.0-next.6083cd9",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -30,7 +30,7 @@
   ],
   "dependencies": {
     "@standard-schema/spec": "1.0.0-beta.4",
-    "@orpc/shared": "0.0.0-next.5d3da98"
+    "@orpc/shared": "0.0.0-next.6083cd9"
   },
   "devDependencies": {
     "arktype": "2.0.0-rc.26",