openai 7.4.0 → 7.5.0

package/helpers/standard-schema.d.mts

@@ -1,44 +1,72 @@
-import { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.mjs";
-import { AutoParseableResponseTool } from "../lib/ResponsesParser.mjs";
-import { type JSONSchema } from "../lib/jsonschema.mjs";
-import { ResponseFormatJSONSchema } from "../resources/index.mjs";
-import { type ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.mjs";
+import type { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.mjs";
+import type { AutoParseableResponseTool } from "../lib/ResponsesParser.mjs";
+import type { JSONSchema } from "../lib/jsonschema.mjs";
+import type { ResponseFormatJSONSchema } from "../resources/index.mjs";
+import type { ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.mjs";
+/** Validation issue returned by a Standard Schema-compatible validator. */
 type StandardSchemaIssue = {
+    /** Human-readable explanation of the validation failure. */
     readonly message: string;
-    readonly path?: ReadonlyArray<PropertyKey | {
+    /** Optional path identifying the input property or array element that failed validation. */
+    readonly path?: readonly (PropertyKey | {
+        /** Property name, symbol, or array index associated with this path segment. */
         readonly key: PropertyKey;
-    }> | undefined;
+    })[] | undefined;
 };
+/** Successful parsed output or validation issues produced by a Standard Schema validator. */
 type StandardSchemaResult<Output> = {
+    /** Parsed and validated value returned by a successful validation. */
     readonly value: Output;
+    /** Validation issues are absent when parsing succeeds. */
     readonly issues?: undefined;
 } | {
-    readonly issues: ReadonlyArray<StandardSchemaIssue>;
+    /** Validation issues describing why the input could not be parsed. */
+    readonly issues: readonly StandardSchemaIssue[];
 };
+/** JSON Schema conversion settings passed to a Standard Schema implementation. */
 type StandardJSONSchemaOptions = {
+    /** JSON Schema dialect required by the SDK's structured-output helpers. */
     readonly target: 'draft-07';
+    /** Optional validator-specific JSON Schema conversion settings. */
     readonly libraryOptions?: Record<string, unknown> | undefined;
 };
+/** Minimal Standard Schema v1 validator contract accepted by the public parsing helpers. */
 type StandardSchemaLike<Input = unknown, Output = Input> = {
+    /** Standard Schema metadata, validation entrypoint, and optional JSON Schema conversion. */
     readonly '~standard': {
+        /** Standard Schema specification version supported by the validator. */
         readonly version: 1;
+        /** Identifier of the library that implements this Standard Schema validator. */
         readonly vendor: string;
+        /** Optional type-level input and output metadata used to infer parsed result types. */
         readonly types?: {
+            /** Type accepted by the validator before parsing or transformation. */
             readonly input: Input;
+            /** Type produced after successful validation or transformation. */
             readonly output: Output;
         } | undefined;
+        /**
+         * Validates model output; SDK parsing helpers require this method to finish synchronously.
+         * Promise-returning validators are rejected when a response is parsed.
+         */
         readonly validate: (value: unknown) => StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>>;
+        /** Optional JSON Schema conversion methods; provide an explicit `schema` when absent. */
         readonly jsonSchema?: {
+            /** Produces the model-facing input JSON Schema for the requested dialect. */
             readonly input: (options: StandardJSONSchemaOptions) => Record<string, unknown>;
+            /** Produces an optional output JSON Schema; structured-output helpers use `input` instead. */
             readonly output?: (options: StandardJSONSchemaOptions) => Record<string, unknown>;
         } | undefined;
     };
 };
+/** Extracts parsed Standard Schema output, falling back to `unknown` without type metadata. */
 type InferStandardOutput<Schema extends StandardSchemaLike> = [
     NonNullable<Schema['~standard']['types']>
 ] extends [never] ? unknown : NonNullable<Schema['~standard']['types']> extends {
+    /** Parsed output type declared by the Standard Schema validator's type metadata. */
     readonly output: infer Output;
 } ? Output : unknown;
+/** Supplies a model-facing JSON Schema when a validator cannot generate one itself. */
 type StandardSchemaJSONSchemaProps = {
     /**
      * A JSON Schema override for Standard Schema implementations that do not
@@ -46,24 +74,36 @@ type StandardSchemaJSONSchemaProps = {
      */
     schema?: JSONSchema | Record<string, unknown> | undefined;
 };
+/** Optional Chat Completions response-format metadata and explicit JSON Schema override. */
 type StandardResponseFormatProps = Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'> & StandardSchemaJSONSchemaProps;
+/** Optional Responses API text-format metadata and explicit JSON Schema override. */
 type StandardTextFormatProps = Omit<ResponseFormatTextJSONSchemaConfig, 'schema' | 'type' | 'strict' | 'name'> & StandardSchemaJSONSchemaProps;
+/** Function callback invoked with arguments validated by a Standard Schema implementation. */
 type StandardToolFunction<Parameters extends StandardSchemaLike> = (args: InferStandardOutput<Parameters>) => unknown | Promise<unknown>;
+/** Model-facing function-tool settings and optional Standard Schema validation callback. */
 type StandardToolOptions<Parameters extends StandardSchemaLike> = {
+    /** Model-visible function name used to identify matching tool calls. */
     name: string;
+    /** Standard Schema validator used to describe and validate the function's arguments. */
     parameters: Parameters;
     /**
      * A JSON Schema override for Standard Schema implementations that do not
      * expose `~standard.jsonSchema.input()`.
      */
     schema?: JSONSchema | Record<string, unknown> | undefined;
+    /** Optional callback retained on the tool and invoked by compatible chat `runTools()` helpers. */
     function?: StandardToolFunction<Parameters> | undefined;
+    /** Optional model-visible explanation of when and how the function should be used. */
     description?: string | undefined;
 };
-type StandardToolReturnOptions<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters> | undefined> = {
+/** Type-level function-tool metadata preserving validated arguments and callback availability. */
+type StandardToolReturnOptions<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters> | undefined> = {
+    /** Inferred argument type returned by the Standard Schema validator. */
     arguments: InferStandardOutput<Parameters>;
+    /** Model-visible name used to match generated function calls. */
     name: string;
-    function: Function;
+    /** Callback type when supplied, or `undefined` for a parse-only function tool. */
+    function: ToolFunction;
 };
 /**
  * Creates a chat completion `JSONSchema` response format from a Standard
@@ -72,33 +112,129 @@ type StandardToolReturnOptions<Parameters extends StandardSchemaLike, Function e
  * The helper uses `~standard.jsonSchema.input()` for the model-facing schema
  * and `~standard.validate()` for parsed output. Validation must be
  * synchronous because the SDK's parse helpers are synchronous.
+ *
+ * Pass the returned format to `client.chat.completions.parse()` to populate
+ * `message.parsed`. Supply `props.schema` when the validator does not implement
+ * `~standard.jsonSchema.input()`.
+ *
+ * @param standardSchema Standard Schema v1 validator used to describe and parse output.
+ * @param name Model-visible name of the generated strict JSON Schema.
+ * @param props Optional response-format metadata and explicit JSON Schema override.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
 export declare function standardResponseFormat<Schema extends StandardSchemaLike>(standardSchema: Schema, name: string, props?: StandardResponseFormatProps): AutoParseableResponseFormat<InferStandardOutput<Schema>>;
 /**
  * Creates a Responses API `json_schema` text format from a Standard Schema
  * validator.
+ *
+ * Pass the returned format as `text.format` to `client.responses.parse()` to
+ * populate `response.output_parsed`. Validation must be synchronous. Supply
+ * `props.schema` when the validator cannot generate its own input JSON Schema.
+ *
+ * @param standardSchema Standard Schema v1 validator used to describe and parse output.
+ * @param name Model-visible name of the generated strict JSON Schema.
+ * @param props Optional text-format metadata and explicit JSON Schema override.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
 export declare function standardTextFormat<Schema extends StandardSchemaLike>(standardSchema: Schema, name: string, props?: StandardTextFormatProps): AutoParseableTextFormat<InferStandardOutput<Schema>>;
 /**
  * Creates a chat completion `function` tool from a Standard Schema
- * validator.
+ * validator and a callback that can be invoked by `chat.completions.runTools()`.
+ *
+ * The generated tool uses strict JSON Schema, and arguments are validated
+ * synchronously before the callback receives them. Supply `options.schema`
+ * when the validator cannot generate an input JSON Schema.
+ *
+ * @param options Model-visible function details, synchronous parameter validator,
+ * optional schema override, and required execution callback.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
+export declare function standardFunction<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
+    /** Callback invoked with synchronously validated arguments by chat `runTools()`. */
+    function: ToolFunction;
+}): AutoParseableTool<StandardToolReturnOptions<Parameters, ToolFunction>>;
+/**
+ * Creates a parse-only Chat Completions function tool without an execution callback.
+ *
+ * Arguments are validated synchronously by `chat.completions.parse()` or
+ * `.stream()`. Callback-free tools cannot be executed by `runTools()`.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
-export declare function standardFunction<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
-    function: Function;
-}): AutoParseableTool<StandardToolReturnOptions<Parameters, Function>>;
 export declare function standardFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters> & {
+    /** No execution callback is attached to this parse-only function tool. */
     function?: undefined;
 }): AutoParseableTool<StandardToolReturnOptions<Parameters, undefined>>;
+/**
+ * Creates a strict Chat Completions function tool with an optionally available callback.
+ * The validator must support synchronous validation and provide or receive a JSON Schema.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
 export declare function standardFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters>): AutoParseableTool<StandardToolReturnOptions<Parameters, StandardToolFunction<Parameters> | undefined>>;
 /**
- * Creates a Responses API `function` tool from a Standard Schema validator.
+ * Creates a strict Responses API function tool from a Standard Schema validator and callback.
+ *
+ * `client.responses.parse()` validates matching function-call arguments and
+ * exposes them as `parsed_arguments`; it does not execute the attached callback
+ * or submit tool results. Validation must complete synchronously.
+ *
+ * @param options Model-visible function details, synchronous parameter validator,
+ * optional schema override, and callback metadata.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
+export declare function standardResponsesFunction<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
+    /** Callback retained on the tool; `responses.parse()` does not execute it. */
+    function: ToolFunction;
+}): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, ToolFunction>>;
+/**
+ * Creates a parse-only Responses API function tool without an execution callback.
+ * `responses.parse()` exposes synchronously validated arguments as `parsed_arguments`.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
-export declare function standardResponsesFunction<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
-    function: Function;
-}): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, Function>>;
 export declare function standardResponsesFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters> & {
+    /** No execution callback is attached to this parse-only function tool. */
     function?: undefined;
 }): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, undefined>>;
+/**
+ * Creates a strict Responses API function tool with an optionally available callback.
+ * Argument validation is synchronous; `responses.parse()` does not execute callbacks.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
 export declare function standardResponsesFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters>): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, StandardToolFunction<Parameters> | undefined>>;
 export {};
 //# sourceMappingURL=standard-schema.d.mts.map

package/helpers/standard-schema.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"standard-schema.d.mts","sourceRoot":"","sources":["../src/helpers/standard-schema.ts"],"names":[],"mappings":"AACA,OAAO,EACL,2BAA2B,EAC3B,uBAAuB,EACvB,iBAAiB,EAIlB,0BAAsB;AACvB,OAAO,EAAE,yBAAyB,EAA6B,mCAA+B;AAC9F,OAAO,EAAE,KAAK,UAAU,EAAE,8BAA0B;AAUpD,OAAO,EAAE,wBAAwB,EAAE,+BAA2B;AAC9D,OAAO,EAAE,KAAK,kCAAkC,EAAE,6CAAyC;AAE3F,KAAK,mBAAmB,GAAG;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,GAAG;QAAE,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC,GAAG,SAAS,CAAC;CACxF,CAAC;AAEF,KAAK,oBAAoB,CAAC,MAAM,IAC5B;IACE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACrD,CAAC;AAEN,KAAK,yBAAyB,GAAG;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF,KAAK,kBAAkB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK,IAAI;IACzD,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,EACX;YACE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;SACzB,GACD,SAAS,CAAC;QACd,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,QAAQ,CAAC,UAAU,CAAC,EAChB;YACE,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAChF,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnF,GACD,SAAS,CAAC;KACf,CAAC;CACH,CAAC;AAEF,KAAK,mBAAmB,CAAC,MAAM,SAAS,kBAAkB,IACxD;IAAC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GACnE,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,MAAM,CAAA;CAAE,GAAG,MAAM,GAC5F,OAAO,CAAC;AAEZ,KAAK,6BAA6B,GAAG;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF,KAAK,2BAA2B,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GACxG,6BAA6B,CAAC;AAEhC,KAAK,uBAAuB,GAAG,IAAI,CACjC,kCAAkC,EAClC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CACtC,GACC,6BAA6B,CAAC;AAEhC,KAAK,oBAAoB,CAAC,UAAU,SAAS,kBAAkB,IAAI,CACjE,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAClC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,KAAK,mBAAmB,CAAC,UAAU,SAAS,kBAAkB,IAAI;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;IACxD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,KAAK,yBAAyB,CAC5B,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,IAC3D;IACF,SAAS,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAmVF;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,SAAS,kBAAkB,EACtE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,2BAA2B,GAClC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAe1D;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,kBAAkB,EAClE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,uBAAuB,GAC9B,uBAAuB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAatD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAEjD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAChE,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AACtE,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GAClE,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;AAqB1G;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAEjD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAChE,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9E,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GAClE,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAC/E,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,yBAAyB,CAC1B,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CACpF,CAAC"}
+{"version":3,"file":"standard-schema.d.mts","sourceRoot":"","sources":["../src/helpers/standard-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,0BAAsB;AAE7G,OAAO,KAAK,EAAE,yBAAyB,EAAE,mCAA+B;AAExE,OAAO,KAAK,EAAE,UAAU,EAAE,8BAA0B;AAUpD,OAAO,KAAK,EAAE,wBAAwB,EAAE,+BAA2B;AACnE,OAAO,KAAK,EAAE,kCAAkC,EAAE,6CAAyC;AAE3F,2EAA2E;AAC3E,KAAK,mBAAmB,GAAG;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,4FAA4F;IAC5F,QAAQ,CAAC,IAAI,CAAC,EACV,SAAS,CACL,WAAW,GACX;QACE,+EAA+E;QAC/E,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;KAC3B,CACJ,EAAE,GACH,SAAS,CAAC;CACf,CAAC;AAEF,6FAA6F;AAC7F,KAAK,oBAAoB,CAAC,MAAM,IAC5B;IACE,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IACE,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACjD,CAAC;AAEN,kFAAkF;AAClF,KAAK,yBAAyB,GAAG;IAC/B,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAE5B,mEAAmE;IACnE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF,4FAA4F;AAC5F,KAAK,kBAAkB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK,IAAI;IACzD,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,EAAE;QACpB,wEAAwE;QACxE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAEpB,gFAAgF;QAChF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB,uFAAuF;QACvF,QAAQ,CAAC,KAAK,CAAC,EACX;YACE,uEAAuE;YACvE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YAEtB,mEAAmE;YACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;SACzB,GACD,SAAS,CAAC;QAEd;;;WAGG;QACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QAE1E,yFAAyF;QACzF,QAAQ,CAAC,UAAU,CAAC,EAChB;YACE,6EAA6E;YAC7E,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEhF,8FAA8F;YAC9F,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnF,GACD,SAAS,CAAC;KACf,CAAC;CACH,CAAC;AAEF,+FAA+F;AAC/F,KAAK,mBAAmB,CAAC,MAAM,SAAS,kBAAkB,IAAI;IAC5D,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;CAC1C,SAAS,CAAC,KAAK,CAAC,GACb,OAAO,GACP,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS;IAC9C,oFAAoF;IACpF,QAAQ,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC;CAC/B,GACD,MAAM,GACN,OAAO,CAAC;AAEd,uFAAuF;AACvF,KAAK,6BAA6B,GAAG;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF,4FAA4F;AAC5F,KAAK,2BAA2B,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GACxG,6BAA6B,CAAC;AAEhC,qFAAqF;AACrF,KAAK,uBAAuB,GAAG,IAAI,CACjC,kCAAkC,EAClC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CACtC,GACC,6BAA6B,CAAC;AAEhC,8FAA8F;AAC9F,KAAK,oBAAoB,CAAC,UAAU,SAAS,kBAAkB,IAAI,CACjE,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAClC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,4FAA4F;AAC5F,KAAK,mBAAmB,CAAC,UAAU,SAAS,kBAAkB,IAAI;IAChE,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IAEb,wFAAwF;IACxF,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAE1D,kGAAkG;IAClG,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;IAExD,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,kGAAkG;AAClG,KAAK,yBAAyB,CAC5B,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,IAC/D;IACF,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAE3C,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb,kFAAkF;IAClF,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAiXF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,SAAS,kBAAkB,EACtE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,2BAA2B,GAClC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAe1D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,kBAAkB,EAClE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,uBAAuB,GAC9B,uBAAuB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAatD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAErD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,oFAAoF;IACpF,QAAQ,EAAE,YAAY,CAAC;CACxB,GACA,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACA,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAEvE;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;AAuB1G;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAErD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,8EAA8E;IAC9E,QAAQ,EAAE,YAAY,CAAC;CACxB,GACA,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;AAElF;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACA,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAE/E;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,yBAAyB,CAC1B,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CACpF,CAAC"}

package/helpers/standard-schema.d.ts

@@ -1,44 +1,72 @@
-import { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.js";
-import { AutoParseableResponseTool } from "../lib/ResponsesParser.js";
-import { type JSONSchema } from "../lib/jsonschema.js";
-import { ResponseFormatJSONSchema } from "../resources/index.js";
-import { type ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.js";
+import type { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.js";
+import type { AutoParseableResponseTool } from "../lib/ResponsesParser.js";
+import type { JSONSchema } from "../lib/jsonschema.js";
+import type { ResponseFormatJSONSchema } from "../resources/index.js";
+import type { ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.js";
+/** Validation issue returned by a Standard Schema-compatible validator. */
 type StandardSchemaIssue = {
+    /** Human-readable explanation of the validation failure. */
     readonly message: string;
-    readonly path?: ReadonlyArray<PropertyKey | {
+    /** Optional path identifying the input property or array element that failed validation. */
+    readonly path?: readonly (PropertyKey | {
+        /** Property name, symbol, or array index associated with this path segment. */
         readonly key: PropertyKey;
-    }> | undefined;
+    })[] | undefined;
 };
+/** Successful parsed output or validation issues produced by a Standard Schema validator. */
 type StandardSchemaResult<Output> = {
+    /** Parsed and validated value returned by a successful validation. */
     readonly value: Output;
+    /** Validation issues are absent when parsing succeeds. */
     readonly issues?: undefined;
 } | {
-    readonly issues: ReadonlyArray<StandardSchemaIssue>;
+    /** Validation issues describing why the input could not be parsed. */
+    readonly issues: readonly StandardSchemaIssue[];
 };
+/** JSON Schema conversion settings passed to a Standard Schema implementation. */
 type StandardJSONSchemaOptions = {
+    /** JSON Schema dialect required by the SDK's structured-output helpers. */
     readonly target: 'draft-07';
+    /** Optional validator-specific JSON Schema conversion settings. */
     readonly libraryOptions?: Record<string, unknown> | undefined;
 };
+/** Minimal Standard Schema v1 validator contract accepted by the public parsing helpers. */
 type StandardSchemaLike<Input = unknown, Output = Input> = {
+    /** Standard Schema metadata, validation entrypoint, and optional JSON Schema conversion. */
     readonly '~standard': {
+        /** Standard Schema specification version supported by the validator. */
         readonly version: 1;
+        /** Identifier of the library that implements this Standard Schema validator. */
         readonly vendor: string;
+        /** Optional type-level input and output metadata used to infer parsed result types. */
         readonly types?: {
+            /** Type accepted by the validator before parsing or transformation. */
             readonly input: Input;
+            /** Type produced after successful validation or transformation. */
             readonly output: Output;
         } | undefined;
+        /**
+         * Validates model output; SDK parsing helpers require this method to finish synchronously.
+         * Promise-returning validators are rejected when a response is parsed.
+         */
         readonly validate: (value: unknown) => StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>>;
+        /** Optional JSON Schema conversion methods; provide an explicit `schema` when absent. */
         readonly jsonSchema?: {
+            /** Produces the model-facing input JSON Schema for the requested dialect. */
             readonly input: (options: StandardJSONSchemaOptions) => Record<string, unknown>;
+            /** Produces an optional output JSON Schema; structured-output helpers use `input` instead. */
             readonly output?: (options: StandardJSONSchemaOptions) => Record<string, unknown>;
         } | undefined;
     };
 };
+/** Extracts parsed Standard Schema output, falling back to `unknown` without type metadata. */
 type InferStandardOutput<Schema extends StandardSchemaLike> = [
     NonNullable<Schema['~standard']['types']>
 ] extends [never] ? unknown : NonNullable<Schema['~standard']['types']> extends {
+    /** Parsed output type declared by the Standard Schema validator's type metadata. */
     readonly output: infer Output;
 } ? Output : unknown;
+/** Supplies a model-facing JSON Schema when a validator cannot generate one itself. */
 type StandardSchemaJSONSchemaProps = {
     /**
      * A JSON Schema override for Standard Schema implementations that do not
@@ -46,24 +74,36 @@ type StandardSchemaJSONSchemaProps = {
      */
     schema?: JSONSchema | Record<string, unknown> | undefined;
 };
+/** Optional Chat Completions response-format metadata and explicit JSON Schema override. */
 type StandardResponseFormatProps = Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'> & StandardSchemaJSONSchemaProps;
+/** Optional Responses API text-format metadata and explicit JSON Schema override. */
 type StandardTextFormatProps = Omit<ResponseFormatTextJSONSchemaConfig, 'schema' | 'type' | 'strict' | 'name'> & StandardSchemaJSONSchemaProps;
+/** Function callback invoked with arguments validated by a Standard Schema implementation. */
 type StandardToolFunction<Parameters extends StandardSchemaLike> = (args: InferStandardOutput<Parameters>) => unknown | Promise<unknown>;
+/** Model-facing function-tool settings and optional Standard Schema validation callback. */
 type StandardToolOptions<Parameters extends StandardSchemaLike> = {
+    /** Model-visible function name used to identify matching tool calls. */
     name: string;
+    /** Standard Schema validator used to describe and validate the function's arguments. */
     parameters: Parameters;
     /**
      * A JSON Schema override for Standard Schema implementations that do not
      * expose `~standard.jsonSchema.input()`.
      */
     schema?: JSONSchema | Record<string, unknown> | undefined;
+    /** Optional callback retained on the tool and invoked by compatible chat `runTools()` helpers. */
     function?: StandardToolFunction<Parameters> | undefined;
+    /** Optional model-visible explanation of when and how the function should be used. */
     description?: string | undefined;
 };
-type StandardToolReturnOptions<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters> | undefined> = {
+/** Type-level function-tool metadata preserving validated arguments and callback availability. */
+type StandardToolReturnOptions<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters> | undefined> = {
+    /** Inferred argument type returned by the Standard Schema validator. */
     arguments: InferStandardOutput<Parameters>;
+    /** Model-visible name used to match generated function calls. */
     name: string;
-    function: Function;
+    /** Callback type when supplied, or `undefined` for a parse-only function tool. */
+    function: ToolFunction;
 };
 /**
  * Creates a chat completion `JSONSchema` response format from a Standard
@@ -72,33 +112,129 @@ type StandardToolReturnOptions<Parameters extends StandardSchemaLike, Function e
  * The helper uses `~standard.jsonSchema.input()` for the model-facing schema
  * and `~standard.validate()` for parsed output. Validation must be
  * synchronous because the SDK's parse helpers are synchronous.
+ *
+ * Pass the returned format to `client.chat.completions.parse()` to populate
+ * `message.parsed`. Supply `props.schema` when the validator does not implement
+ * `~standard.jsonSchema.input()`.
+ *
+ * @param standardSchema Standard Schema v1 validator used to describe and parse output.
+ * @param name Model-visible name of the generated strict JSON Schema.
+ * @param props Optional response-format metadata and explicit JSON Schema override.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
 export declare function standardResponseFormat<Schema extends StandardSchemaLike>(standardSchema: Schema, name: string, props?: StandardResponseFormatProps): AutoParseableResponseFormat<InferStandardOutput<Schema>>;
 /**
  * Creates a Responses API `json_schema` text format from a Standard Schema
  * validator.
+ *
+ * Pass the returned format as `text.format` to `client.responses.parse()` to
+ * populate `response.output_parsed`. Validation must be synchronous. Supply
+ * `props.schema` when the validator cannot generate its own input JSON Schema.
+ *
+ * @param standardSchema Standard Schema v1 validator used to describe and parse output.
+ * @param name Model-visible name of the generated strict JSON Schema.
+ * @param props Optional text-format metadata and explicit JSON Schema override.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
 export declare function standardTextFormat<Schema extends StandardSchemaLike>(standardSchema: Schema, name: string, props?: StandardTextFormatProps): AutoParseableTextFormat<InferStandardOutput<Schema>>;
 /**
  * Creates a chat completion `function` tool from a Standard Schema
- * validator.
+ * validator and a callback that can be invoked by `chat.completions.runTools()`.
+ *
+ * The generated tool uses strict JSON Schema, and arguments are validated
+ * synchronously before the callback receives them. Supply `options.schema`
+ * when the validator cannot generate an input JSON Schema.
+ *
+ * @param options Model-visible function details, synchronous parameter validator,
+ * optional schema override, and required execution callback.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
+export declare function standardFunction<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
+    /** Callback invoked with synchronously validated arguments by chat `runTools()`. */
+    function: ToolFunction;
+}): AutoParseableTool<StandardToolReturnOptions<Parameters, ToolFunction>>;
+/**
+ * Creates a parse-only Chat Completions function tool without an execution callback.
+ *
+ * Arguments are validated synchronously by `chat.completions.parse()` or
+ * `.stream()`. Callback-free tools cannot be executed by `runTools()`.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
-export declare function standardFunction<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
-    function: Function;
-}): AutoParseableTool<StandardToolReturnOptions<Parameters, Function>>;
 export declare function standardFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters> & {
+    /** No execution callback is attached to this parse-only function tool. */
     function?: undefined;
 }): AutoParseableTool<StandardToolReturnOptions<Parameters, undefined>>;
+/**
+ * Creates a strict Chat Completions function tool with an optionally available callback.
+ * The validator must support synchronous validation and provide or receive a JSON Schema.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
 export declare function standardFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters>): AutoParseableTool<StandardToolReturnOptions<Parameters, StandardToolFunction<Parameters> | undefined>>;
 /**
- * Creates a Responses API `function` tool from a Standard Schema validator.
+ * Creates a strict Responses API function tool from a Standard Schema validator and callback.
+ *
+ * `client.responses.parse()` validates matching function-call arguments and
+ * exposes them as `parsed_arguments`; it does not execute the attached callback
+ * or submit tool results. Validation must complete synchronously.
+ *
+ * @param options Model-visible function details, synchronous parameter validator,
+ * optional schema override, and callback metadata.
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
+export declare function standardResponsesFunction<Parameters extends StandardSchemaLike, ToolFunction extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
+    /** Callback retained on the tool; `responses.parse()` does not execute it. */
+    function: ToolFunction;
+}): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, ToolFunction>>;
+/**
+ * Creates a parse-only Responses API function tool without an execution callback.
+ * `responses.parse()` exposes synchronously validated arguments as `parsed_arguments`.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
  */
-export declare function standardResponsesFunction<Parameters extends StandardSchemaLike, Function extends StandardToolFunction<Parameters>>(options: StandardToolOptions<Parameters> & {
-    function: Function;
-}): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, Function>>;
 export declare function standardResponsesFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters> & {
+    /** No execution callback is attached to this parse-only function tool. */
     function?: undefined;
 }): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, undefined>>;
+/**
+ * Creates a strict Responses API function tool with an optionally available callback.
+ * Argument validation is synchronous; `responses.parse()` does not execute callbacks.
+ *
+ * @throws {OpenAIError} If no JSON Schema is available or its `oneOf` branches
+ * cannot be represented safely.
+ * @throws {Error} If strict normalization rejects another unsupported or
+ * unrepresentable JSON Schema feature.
+ * @throws {TypeError} If malformed JSON Schema values have unexpected structural types.
+ */
 export declare function standardResponsesFunction<Parameters extends StandardSchemaLike>(options: StandardToolOptions<Parameters>): AutoParseableResponseTool<StandardToolReturnOptions<Parameters, StandardToolFunction<Parameters> | undefined>>;
 export {};
 //# sourceMappingURL=standard-schema.d.ts.map

package/helpers/standard-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standard-schema.d.ts","sourceRoot":"","sources":["../src/helpers/standard-schema.ts"],"names":[],"mappings":"AACA,OAAO,EACL,2BAA2B,EAC3B,uBAAuB,EACvB,iBAAiB,EAIlB,yBAAsB;AACvB,OAAO,EAAE,yBAAyB,EAA6B,kCAA+B;AAC9F,OAAO,EAAE,KAAK,UAAU,EAAE,6BAA0B;AAUpD,OAAO,EAAE,wBAAwB,EAAE,8BAA2B;AAC9D,OAAO,EAAE,KAAK,kCAAkC,EAAE,4CAAyC;AAE3F,KAAK,mBAAmB,GAAG;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,WAAW,GAAG;QAAE,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAA;KAAE,CAAC,GAAG,SAAS,CAAC;CACxF,CAAC;AAEF,KAAK,oBAAoB,CAAC,MAAM,IAC5B;IACE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACrD,CAAC;AAEN,KAAK,yBAAyB,GAAG;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF,KAAK,kBAAkB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK,IAAI;IACzD,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QACpB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,CAAC,EACX;YACE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;SACzB,GACD,SAAS,CAAC;QACd,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1E,QAAQ,CAAC,UAAU,CAAC,EAChB;YACE,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAChF,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnF,GACD,SAAS,CAAC;KACf,CAAC;CACH,CAAC;AAEF,KAAK,mBAAmB,CAAC,MAAM,SAAS,kBAAkB,IACxD;IAAC,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GACnE,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,MAAM,CAAA;CAAE,GAAG,MAAM,GAC5F,OAAO,CAAC;AAEZ,KAAK,6BAA6B,GAAG;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF,KAAK,2BAA2B,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GACxG,6BAA6B,CAAC;AAEhC,KAAK,uBAAuB,GAAG,IAAI,CACjC,kCAAkC,EAClC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CACtC,GACC,6BAA6B,CAAC;AAEhC,KAAK,oBAAoB,CAAC,UAAU,SAAS,kBAAkB,IAAI,CACjE,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAClC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,KAAK,mBAAmB,CAAC,UAAU,SAAS,kBAAkB,IAAI;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;IACxD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,KAAK,yBAAyB,CAC5B,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,IAC3D;IACF,SAAS,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAmVF;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,SAAS,kBAAkB,EACtE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,2BAA2B,GAClC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAe1D;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,kBAAkB,EAClE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,uBAAuB,GAC9B,uBAAuB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAatD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAEjD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAChE,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AACtE,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GAClE,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AACvE,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;AAqB1G;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,SAAS,kBAAkB,EACrC,QAAQ,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAEjD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAChE,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9E,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GAClE,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAC/E,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,yBAAyB,CAC1B,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CACpF,CAAC"}
+{"version":3,"file":"standard-schema.d.ts","sourceRoot":"","sources":["../src/helpers/standard-schema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,yBAAsB;AAE7G,OAAO,KAAK,EAAE,yBAAyB,EAAE,kCAA+B;AAExE,OAAO,KAAK,EAAE,UAAU,EAAE,6BAA0B;AAUpD,OAAO,KAAK,EAAE,wBAAwB,EAAE,8BAA2B;AACnE,OAAO,KAAK,EAAE,kCAAkC,EAAE,4CAAyC;AAE3F,2EAA2E;AAC3E,KAAK,mBAAmB,GAAG;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,4FAA4F;IAC5F,QAAQ,CAAC,IAAI,CAAC,EACV,SAAS,CACL,WAAW,GACX;QACE,+EAA+E;QAC/E,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;KAC3B,CACJ,EAAE,GACH,SAAS,CAAC;CACf,CAAC;AAEF,6FAA6F;AAC7F,KAAK,oBAAoB,CAAC,MAAM,IAC5B;IACE,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC;CAC7B,GACD;IACE,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACjD,CAAC;AAEN,kFAAkF;AAClF,KAAK,yBAAyB,GAAG;IAC/B,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAE5B,mEAAmE;IACnE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF,4FAA4F;AAC5F,KAAK,kBAAkB,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,KAAK,IAAI;IACzD,4FAA4F;IAC5F,QAAQ,CAAC,WAAW,EAAE;QACpB,wEAAwE;QACxE,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAEpB,gFAAgF;QAChF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAExB,uFAAuF;QACvF,QAAQ,CAAC,KAAK,CAAC,EACX;YACE,uEAAuE;YACvE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;YAEtB,mEAAmE;YACnE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;SACzB,GACD,SAAS,CAAC;QAEd;;;WAGG;QACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,OAAO,KACX,oBAAoB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;QAE1E,yFAAyF;QACzF,QAAQ,CAAC,UAAU,CAAC,EAChB;YACE,6EAA6E;YAC7E,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEhF,8FAA8F;YAC9F,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,yBAAyB,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SACnF,GACD,SAAS,CAAC;KACf,CAAC;CACH,CAAC;AAEF,+FAA+F;AAC/F,KAAK,mBAAmB,CAAC,MAAM,SAAS,kBAAkB,IAAI;IAC5D,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC;CAC1C,SAAS,CAAC,KAAK,CAAC,GACb,OAAO,GACP,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS;IAC9C,oFAAoF;IACpF,QAAQ,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC;CAC/B,GACD,MAAM,GACN,OAAO,CAAC;AAEd,uFAAuF;AACvF,KAAK,6BAA6B,GAAG;IACnC;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC3D,CAAC;AAEF,4FAA4F;AAC5F,KAAK,2BAA2B,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GACxG,6BAA6B,CAAC;AAEhC,qFAAqF;AACrF,KAAK,uBAAuB,GAAG,IAAI,CACjC,kCAAkC,EAClC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CACtC,GACC,6BAA6B,CAAC;AAEhC,8FAA8F;AAC9F,KAAK,oBAAoB,CAAC,UAAU,SAAS,kBAAkB,IAAI,CACjE,IAAI,EAAE,mBAAmB,CAAC,UAAU,CAAC,KAClC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEhC,4FAA4F;AAC5F,KAAK,mBAAmB,CAAC,UAAU,SAAS,kBAAkB,IAAI;IAChE,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IAEb,wFAAwF;IACxF,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAE1D,kGAAkG;IAClG,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;IAExD,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,kGAAkG;AAClG,KAAK,yBAAyB,CAC5B,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,IAC/D;IACF,wEAAwE;IACxE,SAAS,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAE3C,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb,kFAAkF;IAClF,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAiXF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,SAAS,kBAAkB,EACtE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,2BAA2B,GAClC,2BAA2B,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAe1D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,SAAS,kBAAkB,EAClE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,uBAAuB,GAC9B,uBAAuB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAatD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAErD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,oFAAoF;IACpF,QAAQ,EAAE,YAAY,CAAC;CACxB,GACA,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACA,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAEvE;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,SAAS,kBAAkB,EACpE,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,iBAAiB,CAAC,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;AAuB1G;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,SAAS,kBAAkB,EACrC,YAAY,SAAS,oBAAoB,CAAC,UAAU,CAAC,EAErD,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,8EAA8E;IAC9E,QAAQ,EAAE,YAAY,CAAC;CACxB,GACA,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;AAElF;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GAAG;IACzC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACA,yBAAyB,CAAC,yBAAyB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAE/E;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CAAC,UAAU,SAAS,kBAAkB,EAC7E,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,GACvC,yBAAyB,CAC1B,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,CACpF,CAAC"}