@effect/ai-anthropic 4.0.0-beta.7 → 4.0.0-beta.71

package/dist/AnthropicConfig.js

@@ -1,22 +1,58 @@
 /**
- * @since 1.0.0
+ * The `AnthropicConfig` module provides contextual configuration for the
+ * Anthropic AI provider integration. It is used to customize the generated
+ * Anthropic HTTP client without changing individual request code.
+ *
+ * **Common tasks**
+ *
+ * - Provide a shared `HttpClient` transformation for Anthropic requests
+ * - Add provider-specific concerns such as request instrumentation, proxying,
+ *   retries, or header manipulation
+ * - Scope a client transformation to a single effect with {@link withClientTransform}
+ *
+ * **Gotchas**
+ *
+ * - Configuration is read from the Effect context, so overrides only apply to
+ *   effects run inside the configured scope
+ * - `withClientTransform` replaces the current `transformClient` value while
+ *   preserving any other Anthropic configuration fields
+ *
+ * @since 4.0.0
  */
+import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import { dual } from "effect/Function";
-import * as ServiceMap from "effect/ServiceMap";
 /**
- * @since 1.0.0
+ * Service tag for Anthropic client configuration overrides, such as transformations applied to the generated HTTP client.
+ *
+ * **When to use**
+ *
+ * Use when a layer or integration needs to provide or read Anthropic client
+ * configuration through Effect's context.
+ *
+ * @see {@link withClientTransform} for scoping an HTTP client transformation
+ *
  * @category services
+ * @since 4.0.0
  */
-export class AnthropicConfig extends /*#__PURE__*/ServiceMap.Service()("@effect/ai-anthropic/AnthropicConfig") {
+export class AnthropicConfig extends /*#__PURE__*/Context.Service()("@effect/ai-anthropic/AnthropicConfig") {
   /**
-   * @since 1.0.0
+   * Gets the configured Anthropic service from the current context when present.
+   *
+   * @since 4.0.0
    */
-  static getOrUndefined = /*#__PURE__*/Effect.map(/*#__PURE__*/Effect.services(), services => services.mapUnsafe.get(AnthropicConfig.key));
+  static getOrUndefined = /*#__PURE__*/Effect.map(/*#__PURE__*/Effect.context(), services => services.mapUnsafe.get(AnthropicConfig.key));
 }
 /**
- * @since 1.0.0
+ * Runs an effect with an `AnthropicConfig` override that transforms the underlying `HttpClient` used by generated Anthropic requests.
+ *
+ * **When to use**
+ *
+ * Use when you need to apply a temporary `HttpClient` transformation, such as adding middleware or logging, to a
+ * specific scope of an effectful program.
+ *
  * @category configuration
+ * @since 4.0.0
  */
 export const withClientTransform = /*#__PURE__*/dual(2, (self, transformClient) => Effect.flatMap(AnthropicConfig.getOrUndefined, config => Effect.provideService(self, AnthropicConfig, {
   ...config,

package/dist/AnthropicConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"AnthropicConfig.js","names":["Effect","dual","ServiceMap","AnthropicConfig","Service","getOrUndefined","map","services","mapUnsafe","get","key","withClientTransform","self","transformClient","flatMap","config","provideService"],"sources":["../src/AnthropicConfig.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AACtC,OAAO,KAAKC,UAAU,MAAM,mBAAmB;AAG/C;;;;AAIA,OAAM,MAAOC,eAAgB,sBAAQD,UAAU,CAACE,OAAO,EAGpD,CAAC,sCAAsC,CAAC;EACzC;;;EAGA,OAAgBC,cAAc,gBAA8DL,MAAM,CAACM,GAAG,cACpGN,MAAM,CAACO,QAAQ,EAAS,EACvBA,QAAQ,IAAKA,QAAQ,CAACC,SAAS,CAACC,GAAG,CAACN,eAAe,CAACO,GAAG,CAAC,CAC1D;;AAgBH;;;;AAIA,OAAO,MAAMC,mBAAmB,gBAc5BV,IAAI,CAAC,CAAC,EAAE,CACVW,IAA4B,EAC5BC,eAAmD,KAEnDb,MAAM,CAACc,OAAO,CACZX,eAAe,CAACE,cAAc,EAC7BU,MAAM,IAAKf,MAAM,CAACgB,cAAc,CAACJ,IAAI,EAAET,eAAe,EAAE;EAAE,GAAGY,MAAM;EAAEF;AAAe,CAAE,CAAC,CACzF,CAAC","ignoreList":[]}
+{"version":3,"file":"AnthropicConfig.js","names":["Context","Effect","dual","AnthropicConfig","Service","getOrUndefined","map","context","services","mapUnsafe","get","key","withClientTransform","self","transformClient","flatMap","config","provideService"],"sources":["../src/AnthropicConfig.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AAGtC;;;;;;;;;;;;;AAaA,OAAM,MAAOC,eAAgB,sBAAQH,OAAO,CAACI,OAAO,EAGjD,CAAC,sCAAsC,CAAC;EACzC;;;;;EAKA,OAAgBC,cAAc,gBAA8DJ,MAAM,CAACK,GAAG,cACpGL,MAAM,CAACM,OAAO,EAAS,EACtBC,QAAQ,IAAKA,QAAQ,CAACC,SAAS,CAACC,GAAG,CAACP,eAAe,CAACQ,GAAG,CAAC,CAC1D;;AAwBH;;;;;;;;;;;AAWA,OAAO,MAAMC,mBAAmB,gBA4B5BV,IAAI,CAAC,CAAC,EAAE,CACVW,IAA4B,EAC5BC,eAAmD,KAEnDb,MAAM,CAACc,OAAO,CACZZ,eAAe,CAACE,cAAc,EAC7BW,MAAM,IAAKf,MAAM,CAACgB,cAAc,CAACJ,IAAI,EAAEV,eAAe,EAAE;EAAE,GAAGa,MAAM;EAAEF;AAAe,CAAE,CAAC,CACzF,CAAC","ignoreList":[]}

package/dist/AnthropicError.d.ts

@@ -4,13 +4,21 @@
  * Provides Anthropic-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to Anthropic error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 /**
  * Anthropic-specific error metadata fields.
  *
- * @since 1.0.0
+ * **Details**
+ *
+ * Contains the Anthropic error type and request identifier copied from provider
+ * error responses when available. Either field may be `null` when Anthropic
+ * does not include it or the response cannot be decoded.
+ *
+ * @see {@link AnthropicRateLimitMetadata} for rate-limit responses that also include parsed Anthropic rate-limit headers
+ *
  * @category models
+ * @since 4.0.0
  */
 export type AnthropicErrorMetadata = {
     /**
@@ -25,11 +33,12 @@ export type AnthropicErrorMetadata = {
 /**
  * Anthropic-specific rate limit metadata fields.
  *
- * Extends base error metadata with rate limit specific information from
- * Anthropic's rate limit headers.
+ * **Details**
+ *
+ * Extends base error metadata with rate limit-specific information from Anthropic's rate limit headers.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type AnthropicRateLimitMetadata = AnthropicErrorMetadata & {
     /**
@@ -58,45 +67,135 @@ export type AnthropicRateLimitMetadata = AnthropicErrorMetadata & {
     readonly tokensReset: string | null;
 };
 declare module "effect/unstable/ai/AiError" {
-    interface RateLimitError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicRateLimitMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `RateLimitError` values.
+     *
+     * **Details**
+     *
+     * Includes request identifiers, Anthropic error types, and parsed request or token limit headers when the provider rejects a request due to rate limits.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface RateLimitErrorMetadata {
+        readonly anthropic?: AnthropicRateLimitMetadata | null;
     }
-    interface QuotaExhaustedError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `QuotaExhaustedError` values.
+     *
+     * **Details**
+     *
+     * Captures the Anthropic error type and request identifier for failures where the account or workspace has exhausted its available quota.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface QuotaExhaustedErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
+    }
+    /**
+     * Anthropic metadata attached to `AuthenticationError` values.
+     *
+     * **Details**
+     *
+     * Preserves Anthropic error details for missing, invalid, or unauthorized API credentials while keeping the error in the shared AI error model.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface AuthenticationErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
+    }
+    /**
+     * Anthropic metadata attached to `ContentPolicyError` values.
+     *
+     * **Details**
+     *
+     * Records Anthropic error details returned when a request or response is rejected by Anthropic safety or content policy enforcement.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface ContentPolicyErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface AuthenticationError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `InvalidRequestError` values.
+     *
+     * **Details**
+     *
+     * Provides the Anthropic error type and request identifier for malformed or unsupported requests rejected before model execution.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface InvalidRequestErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface ContentPolicyError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `InternalProviderError` values.
+     *
+     * **Details**
+     *
+     * Preserves Anthropic request correlation data for provider-side failures that should be reported or investigated with Anthropic support.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface InternalProviderErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface InvalidRequestError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `InvalidOutputError` values.
+     *
+     * **Details**
+     *
+     * Describes Anthropic-specific context for responses that could not be decoded or interpreted as valid AI output.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface InvalidOutputErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface InternalProviderError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `StructuredOutputError` values.
+     *
+     * **Details**
+     *
+     * Captures Anthropic error details for structured-output failures, including request correlation data useful when diagnosing schema-related responses.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface StructuredOutputErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface InvalidOutputError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `UnsupportedSchemaError` values.
+     *
+     * **Details**
+     *
+     * Provides Anthropic error details for schemas that cannot be represented by or submitted to the Anthropic API.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface UnsupportedSchemaErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
-    interface UnknownError {
-        readonly metadata: {
-            readonly anthropic?: AnthropicErrorMetadata | null;
-        };
+    /**
+     * Anthropic metadata attached to `UnknownError` values.
+     *
+     * **Details**
+     *
+     * Retains the Anthropic error type and request identifier when a provider response cannot be classified as a more specific AI error.
+     *
+     * @category configuration
+     * @since 4.0.0
+     */
+    interface UnknownErrorMetadata {
+        readonly anthropic?: AnthropicErrorMetadata | null;
     }
 }
 //# sourceMappingURL=AnthropicError.d.ts.map

package/dist/AnthropicError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AnthropicError.d.ts","sourceRoot":"","sources":["../src/AnthropicError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG;IAChE;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C,UAAiB,cAAc;QAC7B,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAA;SACvD,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,kBAAkB;QACjC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,mBAAmB;QAClC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,qBAAqB;QACpC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,kBAAkB;QACjC,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;IAED,UAAiB,YAAY;QAC3B,QAAQ,CAAC,QAAQ,EAAE;YACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;SACnD,CAAA;KACF;CACF"}
+{"version":3,"file":"AnthropicError.d.ts","sourceRoot":"","sources":["../src/AnthropicError.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,0BAA0B,GAAG,sBAAsB,GAAG;IAChE;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC,CAAA;AAED,OAAO,QAAQ,4BAA4B,CAAC;IAC1C;;;;;;;;;OASG;IACH,UAAiB,sBAAsB;QACrC,QAAQ,CAAC,SAAS,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAA;KACvD;IAED;;;;;;;;;OASG;IACH,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,2BAA2B;QAC1C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,0BAA0B;QACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,6BAA6B;QAC5C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,8BAA8B;QAC7C,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;IAED;;;;;;;;;OASG;IACH,UAAiB,oBAAoB;QACnC,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KACnD;CACF"}

package/dist/AnthropicError.js

@@ -4,7 +4,7 @@
  * Provides Anthropic-specific metadata fields for AI error types through module
  * augmentation, enabling typed access to Anthropic error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 export {};
 //# sourceMappingURL=AnthropicError.js.map