@effect/ai-openai 0.37.2 → 4.0.0-beta.0

package/src/OpenAiConfig.ts

@@ -1,25 +1,25 @@
 /**
  * @since 1.0.0
  */
-import type { HttpClient } from "@effect/platform/HttpClient"
-import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
 import { dual } from "effect/Function"
+import * as ServiceMap from "effect/ServiceMap"
+import type { HttpClient } from "effect/unstable/http/HttpClient"
 
 /**
  * @since 1.0.0
- * @category Context
+ * @category services
  */
-export class OpenAiConfig extends Context.Tag("@effect/ai-openai/OpenAiConfig")<
+export class OpenAiConfig extends ServiceMap.Service<
   OpenAiConfig,
   OpenAiConfig.Service
->() {
+>()("@effect/ai-openai/OpenAiConfig") {
   /**
    * @since 1.0.0
    */
   static readonly getOrUndefined: Effect.Effect<typeof OpenAiConfig.Service | undefined> = Effect.map(
-    Effect.context<never>(),
-    (context) => context.unsafeMap.get(OpenAiConfig.key)
+    Effect.services<never>(),
+    (context) => context.mapUnsafe.get(OpenAiConfig.key)
   )
 }
 
@@ -29,50 +29,36 @@ export class OpenAiConfig extends Context.Tag("@effect/ai-openai/OpenAiConfig")<
 export declare namespace OpenAiConfig {
   /**
    * @since 1.0.
-   * @category Models
+   * @category models
    */
   export interface Service {
-    readonly transformClient?: (client: HttpClient) => HttpClient
+    readonly transformClient?: ((client: HttpClient) => HttpClient) | undefined
   }
 }
 
 /**
  * @since 1.0.0
- * @category Configuration
+ * @category configuration
  */
 export const withClientTransform: {
   /**
    * @since 1.0.0
-   * @category Configuration
+   * @category configuration
    */
   (transform: (client: HttpClient) => HttpClient): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
   /**
    * @since 1.0.0
-   * @category Configuration
+   * @category configuration
    */
   <A, E, R>(
     self: Effect.Effect<A, E, R>,
     transform: (client: HttpClient) => HttpClient
   ): Effect.Effect<A, E, R>
-} = dual<
-  /**
-   * @since 1.0.0
-   * @category Configuration
-   */
-  (transform: (client: HttpClient) => HttpClient) => <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
-  /**
-   * @since 1.0.0
-   * @category Configuration
-   */
-  <A, E, R>(
-    self: Effect.Effect<A, E, R>,
-    transform: (client: HttpClient) => HttpClient
-  ) => Effect.Effect<A, E, R>
->(
-  2,
-  (self, transformClient) =>
-    Effect.flatMap(
-      OpenAiConfig.getOrUndefined,
-      (config) => Effect.provideService(self, OpenAiConfig, { ...config, transformClient })
-    )
-)
+} = dual(2, <A, E, R>(
+  self: Effect.Effect<A, E, R>,
+  transformClient: (client: HttpClient) => HttpClient
+) =>
+  Effect.flatMap(
+    OpenAiConfig.getOrUndefined,
+    (config) => Effect.provideService(self, OpenAiConfig, { ...config, transformClient })
+  ))

package/src/OpenAiError.ts

@@ -0,0 +1,107 @@
+/**
+ * OpenAI error metadata augmentation.
+ *
+ * Provides OpenAI-specific metadata fields for AI error types through module
+ * augmentation, enabling typed access to OpenAI error details.
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * OpenAI-specific error metadata fields.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type OpenAiErrorMetadata = {
+  /**
+   * The OpenAI error code returned by the API.
+   */
+  readonly errorCode: string | null
+  /**
+   * The OpenAI error type returned by the API.
+   */
+  readonly errorType: string | null
+  /**
+   * The unique request ID for debugging with OpenAI support.
+   */
+  readonly requestId: string | null
+}
+
+/**
+ * OpenAI-specific rate limit metadata fields.
+ *
+ * Extends base error metadata with rate limit specific information from
+ * OpenAI's rate limit headers.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export type OpenAiRateLimitMetadata = OpenAiErrorMetadata & {
+  /**
+   * The rate limit type (e.g. "requests", "tokens").
+   */
+  readonly limit: string | null
+  /**
+   * Number of remaining requests in the current window.
+   */
+  readonly remaining: number | null
+  /**
+   * Time until the request rate limit resets.
+   */
+  readonly resetRequests: string | null
+  /**
+   * Time until the token rate limit resets.
+   */
+  readonly resetTokens: string | null
+}
+
+declare module "effect/unstable/ai/AiError" {
+  export interface RateLimitError {
+    readonly metadata: {
+      readonly openai?: OpenAiRateLimitMetadata | null
+    }
+  }
+
+  export interface QuotaExhaustedError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface AuthenticationError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface ContentPolicyError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface InvalidRequestError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface InternalProviderError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface InvalidOutputError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+
+  export interface UnknownError {
+    readonly metadata: {
+      readonly openai?: OpenAiErrorMetadata | null
+    }
+  }
+}