@ai-sdk/provider-utils 2.1.1 → 2.1.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/provider-utils
 
+## 2.1.3
+
+### Patch Changes
+
+- 39e5c1f: feat (provider-utils): add getFromApi and response handlers for binary responses and status-code errors
+
+## 2.1.2
+
+### Patch Changes
+
+- ed012d2: feat (provider): add metadata extraction mechanism to openai-compatible providers
+- Updated dependencies [3a58a2e]
+  - @ai-sdk/provider@1.0.6
+
 ## 2.1.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -54,43 +54,6 @@ declare const generateId: (size?: number) => string;
 
 declare function getErrorMessage(error: unknown | undefined): string;
 
-declare function isAbortError(error: unknown): error is Error;
-
-declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
-    apiKey: string | undefined;
-    environmentVariableName: string;
-    apiKeyParameterName?: string;
-    description: string;
-}): string;
-
-/**
- * Loads an optional `string` setting from the environment or a parameter.
- *
- * @param settingValue - The setting value.
- * @param environmentVariableName - The environment variable name.
- * @returns The setting value.
- */
-declare function loadOptionalSetting({ settingValue, environmentVariableName, }: {
-    settingValue: string | undefined;
-    environmentVariableName: string;
-}): string | undefined;
-
-/**
- * Loads a `string` setting from the environment or a parameter.
- *
- * @param settingValue - The setting value.
- * @param environmentVariableName - The environment variable name.
- * @param settingName - The setting name.
- * @param description - The description of the setting.
- * @returns The setting value.
- */
-declare function loadSetting({ settingValue, environmentVariableName, settingName, description, }: {
-    settingValue: string | undefined;
-    environmentVariableName: string;
-    settingName: string;
-    description: string;
-}): string;
-
 /**
  * Used to mark validator functions so we can support both Zod and custom schemas.
  */
@@ -183,6 +146,7 @@ type ResponseHandler<RETURN_TYPE> = (options: {
     response: Response;
 }) => PromiseLike<{
     value: RETURN_TYPE;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage, isRetryable, }: {
@@ -193,6 +157,58 @@ declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage,
 declare const createEventSourceResponseHandler: <T>(chunkSchema: ZodSchema<T>) => ResponseHandler<ReadableStream<ParseResult<T>>>;
 declare const createJsonStreamResponseHandler: <T>(chunkSchema: ZodSchema<T>) => ResponseHandler<ReadableStream<ParseResult<T>>>;
 declare const createJsonResponseHandler: <T>(responseSchema: ZodSchema<T>) => ResponseHandler<T>;
+declare const createBinaryResponseHandler: () => ResponseHandler<Uint8Array>;
+declare const createStatusCodeErrorResponseHandler: () => ResponseHandler<APICallError>;
+
+declare const getFromApi: <T>({ url, headers, successfulResponseHandler, failedResponseHandler, abortSignal, fetch, }: {
+    url: string;
+    headers?: Record<string, string | undefined>;
+    failedResponseHandler: ResponseHandler<Error>;
+    successfulResponseHandler: ResponseHandler<T>;
+    abortSignal?: AbortSignal;
+    fetch?: FetchFunction;
+}) => Promise<{
+    value: T;
+    rawValue?: unknown;
+    responseHeaders?: Record<string, string>;
+}>;
+
+declare function isAbortError(error: unknown): error is Error;
+
+declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
+    apiKey: string | undefined;
+    environmentVariableName: string;
+    apiKeyParameterName?: string;
+    description: string;
+}): string;
+
+/**
+ * Loads an optional `string` setting from the environment or a parameter.
+ *
+ * @param settingValue - The setting value.
+ * @param environmentVariableName - The environment variable name.
+ * @returns The setting value.
+ */
+declare function loadOptionalSetting({ settingValue, environmentVariableName, }: {
+    settingValue: string | undefined;
+    environmentVariableName: string;
+}): string | undefined;
+
+/**
+ * Loads a `string` setting from the environment or a parameter.
+ *
+ * @param settingValue - The setting value.
+ * @param environmentVariableName - The environment variable name.
+ * @param settingName - The setting name.
+ * @param description - The description of the setting.
+ * @returns The setting value.
+ */
+declare function loadSetting({ settingValue, environmentVariableName, settingName, description, }: {
+    settingValue: string | undefined;
+    environmentVariableName: string;
+    settingName: string;
+    description: string;
+}): string;
 
 declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, successfulResponseHandler, abortSignal, fetch, }: {
     url: string;
@@ -204,6 +220,7 @@ declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, su
     fetch?: FetchFunction;
 }) => Promise<{
     value: T;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, failedResponseHandler, abortSignal, fetch, }: {
@@ -219,6 +236,7 @@ declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, fa
     fetch?: FetchFunction;
 }) => Promise<{
     value: T;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 
@@ -309,4 +327,4 @@ interface ToolResult<NAME extends string, ARGS, RESULT> {
     result: RESULT;
 }
 
-export { type FetchFunction, type IDGenerator, type ParseResult, type Resolvable, type ResponseHandler, type ToolCall, type ToolResult, type ValidationResult, type Validator, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, extractResponseHeaders, generateId, getErrorMessage, isAbortError, isParsableJson, isValidator, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, postJsonToApi, postToApi, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodValidator };
+export { type FetchFunction, type IDGenerator, type ParseResult, type Resolvable, type ResponseHandler, type ToolCall, type ToolResult, type ValidationResult, type Validator, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createStatusCodeErrorResponseHandler, extractResponseHeaders, generateId, getErrorMessage, getFromApi, isAbortError, isParsableJson, isValidator, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, postJsonToApi, postToApi, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodValidator };

package/dist/index.d.ts

@@ -54,43 +54,6 @@ declare const generateId: (size?: number) => string;
 
 declare function getErrorMessage(error: unknown | undefined): string;
 
-declare function isAbortError(error: unknown): error is Error;
-
-declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
-    apiKey: string | undefined;
-    environmentVariableName: string;
-    apiKeyParameterName?: string;
-    description: string;
-}): string;
-
-/**
- * Loads an optional `string` setting from the environment or a parameter.
- *
- * @param settingValue - The setting value.
- * @param environmentVariableName - The environment variable name.
- * @returns The setting value.
- */
-declare function loadOptionalSetting({ settingValue, environmentVariableName, }: {
-    settingValue: string | undefined;
-    environmentVariableName: string;
-}): string | undefined;
-
-/**
- * Loads a `string` setting from the environment or a parameter.
- *
- * @param settingValue - The setting value.
- * @param environmentVariableName - The environment variable name.
- * @param settingName - The setting name.
- * @param description - The description of the setting.
- * @returns The setting value.
- */
-declare function loadSetting({ settingValue, environmentVariableName, settingName, description, }: {
-    settingValue: string | undefined;
-    environmentVariableName: string;
-    settingName: string;
-    description: string;
-}): string;
-
 /**
  * Used to mark validator functions so we can support both Zod and custom schemas.
  */
@@ -183,6 +146,7 @@ type ResponseHandler<RETURN_TYPE> = (options: {
     response: Response;
 }) => PromiseLike<{
     value: RETURN_TYPE;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage, isRetryable, }: {
@@ -193,6 +157,58 @@ declare const createJsonErrorResponseHandler: <T>({ errorSchema, errorToMessage,
 declare const createEventSourceResponseHandler: <T>(chunkSchema: ZodSchema<T>) => ResponseHandler<ReadableStream<ParseResult<T>>>;
 declare const createJsonStreamResponseHandler: <T>(chunkSchema: ZodSchema<T>) => ResponseHandler<ReadableStream<ParseResult<T>>>;
 declare const createJsonResponseHandler: <T>(responseSchema: ZodSchema<T>) => ResponseHandler<T>;
+declare const createBinaryResponseHandler: () => ResponseHandler<Uint8Array>;
+declare const createStatusCodeErrorResponseHandler: () => ResponseHandler<APICallError>;
+
+declare const getFromApi: <T>({ url, headers, successfulResponseHandler, failedResponseHandler, abortSignal, fetch, }: {
+    url: string;
+    headers?: Record<string, string | undefined>;
+    failedResponseHandler: ResponseHandler<Error>;
+    successfulResponseHandler: ResponseHandler<T>;
+    abortSignal?: AbortSignal;
+    fetch?: FetchFunction;
+}) => Promise<{
+    value: T;
+    rawValue?: unknown;
+    responseHeaders?: Record<string, string>;
+}>;
+
+declare function isAbortError(error: unknown): error is Error;
+
+declare function loadApiKey({ apiKey, environmentVariableName, apiKeyParameterName, description, }: {
+    apiKey: string | undefined;
+    environmentVariableName: string;
+    apiKeyParameterName?: string;
+    description: string;
+}): string;
+
+/**
+ * Loads an optional `string` setting from the environment or a parameter.
+ *
+ * @param settingValue - The setting value.
+ * @param environmentVariableName - The environment variable name.
+ * @returns The setting value.
+ */
+declare function loadOptionalSetting({ settingValue, environmentVariableName, }: {
+    settingValue: string | undefined;
+    environmentVariableName: string;
+}): string | undefined;
+
+/**
+ * Loads a `string` setting from the environment or a parameter.
+ *
+ * @param settingValue - The setting value.
+ * @param environmentVariableName - The environment variable name.
+ * @param settingName - The setting name.
+ * @param description - The description of the setting.
+ * @returns The setting value.
+ */
+declare function loadSetting({ settingValue, environmentVariableName, settingName, description, }: {
+    settingValue: string | undefined;
+    environmentVariableName: string;
+    settingName: string;
+    description: string;
+}): string;
 
 declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, successfulResponseHandler, abortSignal, fetch, }: {
     url: string;
@@ -204,6 +220,7 @@ declare const postJsonToApi: <T>({ url, headers, body, failedResponseHandler, su
     fetch?: FetchFunction;
 }) => Promise<{
     value: T;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, failedResponseHandler, abortSignal, fetch, }: {
@@ -219,6 +236,7 @@ declare const postToApi: <T>({ url, headers, body, successfulResponseHandler, fa
     fetch?: FetchFunction;
 }) => Promise<{
     value: T;
+    rawValue?: unknown;
     responseHeaders?: Record<string, string>;
 }>;
 
@@ -309,4 +327,4 @@ interface ToolResult<NAME extends string, ARGS, RESULT> {
     result: RESULT;
 }
 
-export { type FetchFunction, type IDGenerator, type ParseResult, type Resolvable, type ResponseHandler, type ToolCall, type ToolResult, type ValidationResult, type Validator, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertUint8ArrayToBase64, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, extractResponseHeaders, generateId, getErrorMessage, isAbortError, isParsableJson, isValidator, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, postJsonToApi, postToApi, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodValidator };
+export { type FetchFunction, type IDGenerator, type ParseResult, type Resolvable, type ResponseHandler, type ToolCall, type ToolResult, type ValidationResult, type Validator, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createStatusCodeErrorResponseHandler, extractResponseHeaders, generateId, getErrorMessage, getFromApi, isAbortError, isParsableJson, isValidator, loadApiKey, loadOptionalSetting, loadSetting, parseJSON, postJsonToApi, postToApi, resolve, safeParseJSON, safeValidateTypes, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodValidator };