@temporary-name/server 1.9.3-alpha.03f5d40e5b399f85012c2fb4e98167e26d551d36 → 1.9.3-alpha.0f2e1f4d66464608b85c66977bff51174cbb238f

package/dist/openapi/index.mjs

@@ -1,7 +1,7 @@
 import { isProcedure, resolveContractProcedures, ORPCError, createRouterClient } from '@temporary-name/server';
-import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@temporary-name/contract';
-import { isObject, stringifyJSON, findDeepMatches, toArray, clone, value, toHttpPath, isORPCErrorStatus, fallbackORPCErrorStatus, fallbackORPCErrorMessage, resolveMaybeOptionalOptions, createORPCErrorFromJson } from '@temporary-name/shared';
-import { a as standardizeHTTPPath, j as jsonSerialize, g as getDynamicParams, d as deserialize, s as serialize } from '../shared/server.BEHw7Eyx.mjs';
+import { standardizeHTTPPath, fallbackContractConfig, getDynamicParams, getEventIteratorSchemaDetails } from '@temporary-name/contract';
+import { isObject, stringifyJSON, findDeepMatches, toArray, clone, value, toHttpPath, isORPCErrorStatus, resolveMaybeOptionalOptions, createORPCErrorFromJson } from '@temporary-name/shared';
+import { j as jsonSerialize, d as deserialize, s as serialize } from '../shared/server.JtIZ8YG7.mjs';
 import '@temporary-name/standard-server';
 import { TypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
 export { ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from '@temporary-name/interop/json-schema-typed/draft-2020-12';
@@ -22,12 +22,6 @@ function getCustomOpenAPIOperation(o) {
 }
 function applyCustomOpenAPIOperation(operation, contract) {
   const operationCustoms = [];
-  for (const errorItem of Object.values(contract["~orpc"].errorMap)) {
-    const maybeExtender = errorItem ? getCustomOpenAPIOperation(errorItem) : void 0;
-    if (maybeExtender) {
-      operationCustoms.push(maybeExtender);
-    }
-  }
   if (isProcedure(contract)) {
     for (const middleware of contract["~orpc"].middlewares) {
       const maybeExtender = getCustomOpenAPIOperation(middleware);
@@ -432,12 +426,6 @@ class OpenAPIGenerator {
           };
           await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
           await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
-          await this.#errorResponse(
-            operationObjectRef,
-            def,
-            baseSchemaConvertOptions,
-            undefinedErrorJsonSchema
-          );
         }
         if (typeof def.route.spec === "function") {
           operationObjectRef = def.route.spec(operationObjectRef);
@@ -530,94 +518,77 @@ ${errors.join("\n\n")}`
   }
   async #request(doc, ref, def, baseSchemaConvertOptions) {
     const method = fallbackContractConfig("defaultMethod", def.route.method);
-    const details = getEventIteratorSchemaDetails(def.inputSchema);
-    if (details) {
-      ref.requestBody = {
-        required: true,
-        content: toOpenAPIEventIteratorContent(
-          await this.converter.convert(details.yields, { ...baseSchemaConvertOptions, strategy: "input" }),
-          await this.converter.convert(details.returns, { ...baseSchemaConvertOptions, strategy: "input" })
-        )
-      };
-      return;
-    }
     const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
-    const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
-    let [required, schema] = await this.converter.convert(def.inputSchema, {
+    const [_pathRequired, pathSchema] = await this.converter.convert(def.schemas.pathSchema, {
       ...baseSchemaConvertOptions,
       strategy: "input",
-      minStructureDepthForRef: dynamicParams?.length || inputStructure === "detailed" ? 1 : 0
+      minStructureDepthForRef: 1
     });
-    if (isAnySchema(schema) && !dynamicParams?.length) {
-      return;
-    }
-    if (inputStructure === "compact") {
-      if (dynamicParams?.length) {
-        const error2 = new OpenAPIGeneratorError(
-          'When input structure is "compact", and path has dynamic params, input schema must be an object with all dynamic params as required.'
-        );
-        if (!isObjectSchema(schema)) {
-          throw error2;
-        }
-        const [paramsSchema, rest] = separateObjectSchema(schema, dynamicParams);
-        schema = rest;
-        required = rest.required ? rest.required.length !== 0 : false;
-        if (!checkParamsSchema(paramsSchema, dynamicParams)) {
-          throw error2;
-        }
-        ref.parameters ??= [];
-        ref.parameters.push(...toOpenAPIParameters(paramsSchema, "path"));
+    if (dynamicParams?.length) {
+      const error = new OpenAPIGeneratorError(
+        // TODO: fix this error
+        'When input structure is "compact", and path has dynamic params, input schema must be an object with all dynamic params as required.'
+      );
+      if (!isObjectSchema(pathSchema)) {
+        throw error;
       }
-      if (method === "GET") {
-        const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, schema);
-        if (!isObjectSchema(resolvedSchema)) {
-          throw new OpenAPIGeneratorError(
-            'When method is "GET", input schema must satisfy: object | any | unknown'
-          );
-        }
-        ref.parameters ??= [];
-        ref.parameters.push(...toOpenAPIParameters(resolvedSchema, "query"));
-      } else {
-        ref.requestBody = {
-          required,
-          content: toOpenAPIContent(schema)
-        };
+      if (!checkParamsSchema(pathSchema, dynamicParams)) {
+        throw error;
+      }
+      ref.parameters ??= [];
+      ref.parameters.push(...toOpenAPIParameters(pathSchema, "path"));
+    } else {
+      const error = new OpenAPIGeneratorError("Params set via path do not match those on the route");
+      if (!isObjectSchema(pathSchema)) {
+        console.log("FOO", pathSchema);
+        throw error;
+      }
+      if (!checkParamsSchema(pathSchema, [])) {
+        console.log("BAR", pathSchema);
+        throw error;
       }
-      return;
-    }
-    const error = new OpenAPIGeneratorError(
-      'When input structure is "detailed", input schema must satisfy: { params?: Record<string, unknown>, query?: Record<string, unknown>, headers?: Record<string, unknown>, body?: unknown }'
-    );
-    if (!isObjectSchema(schema)) {
-      throw error;
     }
-    const resolvedParamSchema = schema.properties?.params !== void 0 ? resolveOpenAPIJsonSchemaRef(doc, schema.properties.params) : void 0;
-    if (dynamicParams?.length && (resolvedParamSchema === void 0 || !isObjectSchema(resolvedParamSchema) || !checkParamsSchema(resolvedParamSchema, dynamicParams))) {
-      throw new OpenAPIGeneratorError(
-        'When input structure is "detailed" and path has dynamic params, the "params" schema must be an object with all dynamic params as required.'
-      );
+    const [_queryRequired, querySchema] = await this.converter.convert(def.schemas.querySchema, {
+      ...baseSchemaConvertOptions,
+      strategy: "input",
+      minStructureDepthForRef: 0
+    });
+    if (!isAnySchema(querySchema)) {
+      const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, querySchema);
+      if (!isObjectSchema(resolvedSchema)) {
+        throw new OpenAPIGeneratorError("Query param schema must satisfy: object | any | unknown");
+      }
+      ref.parameters ??= [];
+      ref.parameters.push(...toOpenAPIParameters(resolvedSchema, "query"));
     }
-    for (const from of ["params", "query", "headers"]) {
-      const fromSchema = schema.properties?.[from];
-      if (fromSchema !== void 0) {
-        const resolvedSchema = resolveOpenAPIJsonSchemaRef(doc, fromSchema);
-        if (!isObjectSchema(resolvedSchema)) {
-          throw error;
+    if (method !== "GET") {
+      const details = getEventIteratorSchemaDetails(def.schemas.bodySchema);
+      if (details) {
+        ref.requestBody = {
+          required: true,
+          content: toOpenAPIEventIteratorContent(
+            await this.converter.convert(details.yields, { ...baseSchemaConvertOptions, strategy: "input" }),
+            await this.converter.convert(details.returns, { ...baseSchemaConvertOptions, strategy: "input" })
+          )
+        };
+      } else {
+        const [bodyRequired, bodySchema] = await this.converter.convert(def.schemas.bodySchema, {
+          ...baseSchemaConvertOptions,
+          strategy: "input",
+          minStructureDepthForRef: 0
+        });
+        if (isAnySchema(bodySchema)) {
+          return;
         }
-        const parameterIn = from === "params" ? "path" : from === "headers" ? "header" : "query";
-        ref.parameters ??= [];
-        ref.parameters.push(...toOpenAPIParameters(resolvedSchema, parameterIn));
+        ref.requestBody = {
+          required: bodyRequired,
+          content: toOpenAPIContent(bodySchema)
+        };
       }
     }
-    if (schema.properties?.body !== void 0) {
-      ref.requestBody = {
-        required: schema.required?.includes("body"),
-        content: toOpenAPIContent(schema.properties.body)
-      };
-    }
   }
   async #successResponse(doc, ref, def, baseSchemaConvertOptions) {
-    const outputSchema = def.outputSchema;
+    const outputSchema = def.schemas.outputSchema;
     const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
     const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
     const eventIteratorSchemaDetails = getEventIteratorSchemaDetails(outputSchema);
@@ -713,44 +684,6 @@ ${errors.join("\n\n")}`
       }
     }
   }
-  async #errorResponse(ref, def, baseSchemaConvertOptions, undefinedErrorSchema) {
-    const errorMap = def.errorMap;
-    const errors = {};
-    for (const code in errorMap) {
-      const config = errorMap[code];
-      if (!config) {
-        continue;
-      }
-      const status = fallbackORPCErrorStatus(code, config.status);
-      const message = fallbackORPCErrorMessage(code, config.message);
-      const [dataRequired, dataSchema] = await this.converter.convert(config.data, {
-        ...baseSchemaConvertOptions,
-        strategy: "output"
-      });
-      errors[status] ??= [];
-      errors[status].push({
-        type: "object",
-        properties: {
-          defined: { const: true },
-          code: { const: code },
-          status: { const: status },
-          message: { type: "string", default: message },
-          data: dataSchema
-        },
-        required: dataRequired ? ["defined", "code", "status", "message", "data"] : ["defined", "code", "status", "message"]
-      });
-    }
-    ref.responses ??= {};
-    for (const status in errors) {
-      const schemas = errors[status];
-      ref.responses[status] = {
-        description: status,
-        content: toOpenAPIContent({
-          oneOf: [...schemas, undefinedErrorSchema]
-        })
-      };
-    }
-  }
 }
 
 function createJsonifiedRouterClient(router, ...rest) {

package/dist/plugins/index.d.mts

@@ -1,58 +1,8 @@
 import { Value, Promisable, ORPCError } from '@temporary-name/shared';
-import { StandardRequest, StandardHeaders } from '@temporary-name/standard-server';
-import { BatchResponseBodyItem } from '@temporary-name/standard-server/batch';
-import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.CbLTWfgn.mjs';
-import { C as Context, E as ProcedureClientInterceptorOptions } from '../shared/server.CZNLCQBm.mjs';
+import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.25yUS-xw.mjs';
+import { C as Context, H as ProcedureClientInterceptorOptions } from '../shared/server.VtI8pLxV.mjs';
 import { Meta } from '@temporary-name/contract';
 
-interface BatchHandlerOptions<T extends Context> {
-    /**
-     * The max size of the batch allowed.
-     *
-     * @default 10
-     */
-    maxSize?: Value<Promisable<number>, [StandardHandlerInterceptorOptions<T>]>;
-    /**
-     * Map the request before processing it.
-     *
-     * @default merged back batch request headers into the request
-     */
-    mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
-    /**
-     * Success batch response status code.
-     *
-     * @default 207
-     */
-    successStatus?: Value<Promisable<number>, [
-        responses: Promise<BatchResponseBodyItem>[],
-        batchOptions: StandardHandlerInterceptorOptions<T>
-    ]>;
-    /**
-     * success batch response headers.
-     *
-     * @default {}
-     */
-    headers?: Value<Promisable<StandardHeaders>, [
-        responses: Promise<BatchResponseBodyItem>[],
-        batchOptions: StandardHandlerInterceptorOptions<T>
-    ]>;
-}
-/**
- * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
- * reducing the overhead of sending each one separately.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
- */
-declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
-    private readonly maxSize;
-    private readonly mapRequestItem;
-    private readonly successStatus;
-    private readonly headers;
-    order: number;
-    constructor(options?: BatchHandlerOptions<T>);
-    init(options: StandardHandlerOptions<T>): void;
-}
-
 interface CORSOptions<T extends Context> {
     origin?: Value<Promisable<string | readonly string[] | null | undefined>, [
         origin: string,
@@ -80,32 +30,6 @@ declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T>
     init(options: StandardHandlerOptions<T>): void;
 }
 
-interface RequestHeadersPluginContext {
-    reqHeaders?: Headers;
-}
-/**
- * The Request Headers Plugin injects a `reqHeaders` instance into the context,
- * allowing access to request headers in oRPC.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/request-headers Request Headers Plugin Docs}
- */
-declare class RequestHeadersPlugin<T extends RequestHeadersPluginContext> implements StandardHandlerPlugin<T> {
-    init(options: StandardHandlerOptions<T>): void;
-}
-
-interface ResponseHeadersPluginContext {
-    resHeaders?: Headers;
-}
-/**
- * The Response Headers Plugin allows you to set response headers in oRPC.
- * It injects a resHeaders instance into the context, enabling you to modify response headers easily.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
- */
-declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
-    init(options: StandardHandlerOptions<T>): void;
-}
-
 interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
     /**
      * The name of the header to check.
@@ -126,9 +50,7 @@ interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
      * @default false
      *
      */
-    exclude?: Value<Promisable<boolean>, [
-        options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>
-    ]>;
+    exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Meta>]>;
     /**
      * The error thrown when the CSRF token is invalid.
      *
@@ -156,5 +78,5 @@ declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements St
     init(options: StandardHandlerOptions<T>): void;
 }
 
-export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
-export type { BatchHandlerOptions, CORSOptions, RequestHeadersPluginContext, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions };
+export { CORSPlugin, SimpleCsrfProtectionHandlerPlugin };
+export type { CORSOptions, SimpleCsrfProtectionHandlerPluginOptions };

package/dist/plugins/index.d.ts

@@ -1,58 +1,8 @@
 import { Value, Promisable, ORPCError } from '@temporary-name/shared';
-import { StandardRequest, StandardHeaders } from '@temporary-name/standard-server';
-import { BatchResponseBodyItem } from '@temporary-name/standard-server/batch';
-import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.Bk5r0-2R.js';
-import { C as Context, E as ProcedureClientInterceptorOptions } from '../shared/server.CZNLCQBm.js';
+import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.Co-zpS8Y.js';
+import { C as Context, H as ProcedureClientInterceptorOptions } from '../shared/server.VtI8pLxV.js';
 import { Meta } from '@temporary-name/contract';
 
-interface BatchHandlerOptions<T extends Context> {
-    /**
-     * The max size of the batch allowed.
-     *
-     * @default 10
-     */
-    maxSize?: Value<Promisable<number>, [StandardHandlerInterceptorOptions<T>]>;
-    /**
-     * Map the request before processing it.
-     *
-     * @default merged back batch request headers into the request
-     */
-    mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
-    /**
-     * Success batch response status code.
-     *
-     * @default 207
-     */
-    successStatus?: Value<Promisable<number>, [
-        responses: Promise<BatchResponseBodyItem>[],
-        batchOptions: StandardHandlerInterceptorOptions<T>
-    ]>;
-    /**
-     * success batch response headers.
-     *
-     * @default {}
-     */
-    headers?: Value<Promisable<StandardHeaders>, [
-        responses: Promise<BatchResponseBodyItem>[],
-        batchOptions: StandardHandlerInterceptorOptions<T>
-    ]>;
-}
-/**
- * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
- * reducing the overhead of sending each one separately.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
- */
-declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
-    private readonly maxSize;
-    private readonly mapRequestItem;
-    private readonly successStatus;
-    private readonly headers;
-    order: number;
-    constructor(options?: BatchHandlerOptions<T>);
-    init(options: StandardHandlerOptions<T>): void;
-}
-
 interface CORSOptions<T extends Context> {
     origin?: Value<Promisable<string | readonly string[] | null | undefined>, [
         origin: string,
@@ -80,32 +30,6 @@ declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T>
     init(options: StandardHandlerOptions<T>): void;
 }
 
-interface RequestHeadersPluginContext {
-    reqHeaders?: Headers;
-}
-/**
- * The Request Headers Plugin injects a `reqHeaders` instance into the context,
- * allowing access to request headers in oRPC.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/request-headers Request Headers Plugin Docs}
- */
-declare class RequestHeadersPlugin<T extends RequestHeadersPluginContext> implements StandardHandlerPlugin<T> {
-    init(options: StandardHandlerOptions<T>): void;
-}
-
-interface ResponseHeadersPluginContext {
-    resHeaders?: Headers;
-}
-/**
- * The Response Headers Plugin allows you to set response headers in oRPC.
- * It injects a resHeaders instance into the context, enabling you to modify response headers easily.
- *
- * @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
- */
-declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
-    init(options: StandardHandlerOptions<T>): void;
-}
-
 interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
     /**
      * The name of the header to check.
@@ -126,9 +50,7 @@ interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
      * @default false
      *
      */
-    exclude?: Value<Promisable<boolean>, [
-        options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>
-    ]>;
+    exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Meta>]>;
     /**
      * The error thrown when the CSRF token is invalid.
      *
@@ -156,5 +78,5 @@ declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements St
     init(options: StandardHandlerOptions<T>): void;
 }
 
-export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
-export type { BatchHandlerOptions, CORSOptions, RequestHeadersPluginContext, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions };
+export { CORSPlugin, SimpleCsrfProtectionHandlerPlugin };
+export type { CORSOptions, SimpleCsrfProtectionHandlerPluginOptions };