@orpc/contract 0.0.0-next.4555a17 → 0.0.0-next.5204560

package/dist/index.js

@@ -3,11 +3,17 @@ 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;
   }
 };
 function isContractProcedure(item) {
-  return item instanceof ContractProcedure;
+  if (item instanceof ContractProcedure) {
+    return true;
+  }
+  return (typeof item === "object" || typeof item === "function") && item !== null && "~type" in item && item["~type"] === "ContractProcedure" && "~orpc" in item && typeof item["~orpc"] === "object" && item["~orpc"] !== null && "InputSchema" in item["~orpc"] && "OutputSchema" in item["~orpc"];
 }
 
 // src/procedure-decorated.ts
@@ -35,12 +41,15 @@ var DecoratedContractProcedure = class _DecoratedContractProcedure extends Contr
       } : void 0
     });
   }
-  pushTag(...tags) {
+  unshiftTag(...tags) {
     return new _DecoratedContractProcedure({
       ...this["~orpc"],
       route: {
         ...this["~orpc"].route,
-        tags: [...this["~orpc"].route?.tags ?? [], ...tags]
+        tags: [
+          ...tags,
+          ...this["~orpc"].route?.tags?.filter((tag) => !tags.includes(tag)) ?? []
+        ]
       }
     });
   }
@@ -80,21 +89,19 @@ var ContractRouterBuilder = class _ContractRouterBuilder {
     });
   }
   router(router) {
+    if (isContractProcedure(router)) {
+      let decorated = DecoratedContractProcedure.decorate(router);
+      if (this["~orpc"].tags) {
+        decorated = decorated.unshiftTag(...this["~orpc"].tags);
+      }
+      if (this["~orpc"].prefix) {
+        decorated = decorated.prefix(this["~orpc"].prefix);
+      }
+      return decorated;
+    }
     const adapted = {};
     for (const key in router) {
-      const item = router[key];
-      if (isContractProcedure(item)) {
-        let decorated = DecoratedContractProcedure.decorate(item);
-        if (this["~orpc"].tags) {
-          decorated = decorated.pushTag(...this["~orpc"].tags);
-        }
-        if (this["~orpc"].prefix) {
-          decorated = decorated.prefix(this["~orpc"].prefix);
-        }
-        adapted[key] = decorated;
-      } else {
-        adapted[key] = this.router(item);
-      }
+      adapted[key] = this.router(router[key]);
     }
     return adapted;
   }
@@ -138,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 {
@@ -145,6 +177,8 @@ export {
   ContractProcedure,
   ContractRouterBuilder,
   DecoratedContractProcedure,
+  configGlobal,
+  fallbackToGlobalConfig,
   isContractProcedure,
   oc
 };

package/dist/src/builder.d.ts

@@ -7,8 +7,8 @@ export declare class ContractBuilder {
     prefix(prefix: HTTPPath): ContractRouterBuilder;
     tag(...tags: string[]): ContractRouterBuilder;
     route(route: RouteOptions): DecoratedContractProcedure<undefined, undefined>;
-    input<U extends Schema>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined>;
-    output<U extends Schema>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U>;
+    input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, undefined>;
+    output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<undefined, U>;
     router<T extends ContractRouter>(router: T): T;
 }
 //# sourceMappingURL=builder.d.ts.map

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-decorated.d.ts

@@ -5,7 +5,7 @@ export declare class DecoratedContractProcedure<TInputSchema extends Schema, TOu
     static decorate<UInputSchema extends Schema = undefined, UOutputSchema extends Schema = undefined>(procedure: ContractProcedure<UInputSchema, UOutputSchema>): DecoratedContractProcedure<UInputSchema, UOutputSchema>;
     route(route: RouteOptions): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
     prefix(prefix: HTTPPath): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
-    pushTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
+    unshiftTag(...tags: string[]): DecoratedContractProcedure<TInputSchema, TOutputSchema>;
     input<U extends Schema = undefined>(schema: U, example?: SchemaInput<U>): DecoratedContractProcedure<U, TOutputSchema>;
     output<U extends Schema = undefined>(schema: U, example?: SchemaOutput<U>): DecoratedContractProcedure<TInputSchema, U>;
 }

package/dist/src/procedure.d.ts

@@ -1,11 +1,61 @@
-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;
     summary?: string;
     description?: string;
     deprecated?: boolean;
-    tags?: string[];
+    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/router.d.ts

@@ -1,12 +1,12 @@
 import type { ANY_CONTRACT_PROCEDURE, ContractProcedure } from './procedure';
 import type { SchemaInput, SchemaOutput } from './types';
-export interface ContractRouter {
-    [k: string]: ANY_CONTRACT_PROCEDURE | ContractRouter;
-}
-export type InferContractRouterInputs<T extends ContractRouter> = {
-    [K in keyof T]: T[K] extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
+export type ContractRouter = ANY_CONTRACT_PROCEDURE | {
+    [k: string]: ContractRouter;
 };
-export type InferContractRouterOutputs<T extends ContractRouter> = {
-    [K in keyof T]: T[K] extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
+export type InferContractRouterInputs<T extends ContractRouter> = T extends ContractProcedure<infer UInputSchema, any> ? SchemaInput<UInputSchema> : {
+    [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterInputs<T[K]> : never;
+};
+export type InferContractRouterOutputs<T extends ContractRouter> = T extends ContractProcedure<any, infer UOutputSchema> ? SchemaOutput<UOutputSchema> : {
+    [K in keyof T]: T[K] extends ContractRouter ? InferContractRouterOutputs<T[K]> : never;
 };
 //# sourceMappingURL=router.d.ts.map

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.4555a17",
+  "version": "0.0.0-next.5204560",
   "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.4555a17"
+    "@orpc/shared": "0.0.0-next.5204560"
   },
   "devDependencies": {
     "arktype": "2.0.0-rc.26",