@effect/ai 0.26.0 → 0.27.0

package/dist/cjs/IdGenerator.js

@@ -0,0 +1,255 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.make = exports.layer = exports.defaultIdGenerator = exports.IdGenerator = void 0;
+var Cause = _interopRequireWildcard(require("effect/Cause"));
+var Context = _interopRequireWildcard(require("effect/Context"));
+var Effect = _interopRequireWildcard(require("effect/Effect"));
+var Layer = _interopRequireWildcard(require("effect/Layer"));
+var Predicate = _interopRequireWildcard(require("effect/Predicate"));
+var Random = _interopRequireWildcard(require("effect/Random"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+/**
+ * The `IdGenerator` module provides a pluggable system for generating unique identifiers
+ * for tool calls and other items in the Effect AI SDKs.
+ *
+ * This module offers a flexible and configurable approach to ID generation, supporting
+ * custom alphabets, prefixes, separators, and sizes.
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect, Layer } from "effect"
+ *
+ * // Using the default ID generator
+ * const program = Effect.gen(function* () {
+ *   const idGen = yield* IdGenerator.IdGenerator
+ *   const toolCallId = yield* idGen.generateId()
+ *   console.log(toolCallId) // "id_A7xK9mP2qR5tY8uV"
+ *   return toolCallId
+ * }).pipe(
+ *   Effect.provide(Layer.succeed(
+ *     IdGenerator.IdGenerator,
+ *     IdGenerator.defaultIdGenerator
+ *   ))
+ * )
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect, Layer } from "effect"
+ *
+ * // Creating a custom ID generator for AI tool calls
+ * const customLayer = IdGenerator.layer({
+ *   alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789",
+ *   prefix: "tool_call",
+ *   separator: "-",
+ *   size: 12
+ * })
+ *
+ * const program = Effect.gen(function* () {
+ *   const idGen = yield* IdGenerator.IdGenerator
+ *   const id = yield* idGen.generateId()
+ *   console.log(id) // "tool_call-A7XK9MP2QR5T"
+ *   return id
+ * }).pipe(
+ *   Effect.provide(customLayer)
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ */
+
+/**
+ * The `IdGenerator` service tag for dependency injection.
+ *
+ * This tag is used to provide and access ID generation functionality throughout
+ * the application. It follows Effect's standard service pattern for type-safe
+ * dependency injection.
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * const useIdGenerator = Effect.gen(function* () {
+ *   const idGenerator = yield* IdGenerator.IdGenerator
+ *   const newId = yield* idGenerator.generateId()
+ *   return newId
+ * })
+ * ```
+ *
+ * @since 1.0.0
+ * @category Models
+ */
+class IdGenerator extends /*#__PURE__*/Context.Tag("@effect/ai/IdGenerator")() {}
+exports.IdGenerator = IdGenerator;
+const DEFAULT_ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+const DEFAULT_SEPARATOR = "_";
+const DEFAULT_SIZE = 16;
+const makeGenerator = ({
+  alphabet = DEFAULT_ALPHABET,
+  prefix,
+  separator = DEFAULT_SEPARATOR,
+  size = DEFAULT_SIZE
+}) => {
+  const alphabetLength = alphabet.length;
+  return Effect.fnUntraced(function* () {
+    const chars = new Array(size);
+    for (let i = 0; i < size; i++) {
+      chars[i] = alphabet[(yield* Random.next) * alphabetLength | 0];
+    }
+    const identifier = chars.join("");
+    if (Predicate.isUndefined(prefix)) {
+      return identifier;
+    }
+    return `${prefix}${separator}${identifier}`;
+  });
+};
+/**
+ * Default ID generator service implementation.
+ *
+ * Uses the standard configuration with "id" prefix and generates IDs in the
+ * format "id_XXXXXXXXXXXXXXXX" where X represents random alphanumeric
+ * characters.
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect, Layer } from "effect"
+ *
+ * const program = Effect.gen(function* () {
+ *   const id = yield* IdGenerator.defaultIdGenerator.generateId()
+ *   console.log(id) // "id_A7xK9mP2qR5tY8uV"
+ *   return id
+ * })
+ *
+ * // Or provide it as a service
+ * const withDefault = program.pipe(
+ *   Effect.provideService(
+ *     IdGenerator.IdGenerator,
+ *     IdGenerator.defaultIdGenerator
+ *   )
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const defaultIdGenerator = exports.defaultIdGenerator = {
+  generateId: /*#__PURE__*/makeGenerator({
+    prefix: "id"
+  })
+};
+/**
+ * Creates a custom ID generator service with the specified options.
+ *
+ * Validates the configuration to ensure the separator is not part of the
+ * alphabet, which would cause ambiguity in parsing generated IDs.
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * const program = Effect.gen(function* () {
+ *   // Create a generator for AI assistant message IDs
+ *   const messageIdGen = yield* IdGenerator.make({
+ *     alphabet: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ *     prefix: "msg",
+ *     separator: "-",
+ *     size: 10
+ *   })
+ *
+ *   const messageId = yield* messageIdGen.generateId()
+ *   console.log(messageId) // "msg-A7X9K2M5P8"
+ *   return messageId
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect } from "effect"
+ *
+ * // This will fail with IllegalArgumentException
+ * const invalidConfig = IdGenerator.make({
+ *   alphabet: "ABC123",
+ *   prefix: "test",
+ *   separator: "A", // Error: separator is part of alphabet
+ *   size: 8
+ * })
+ *
+ * const program = Effect.gen(function* () {
+ *   const generator = yield* invalidConfig
+ *   return generator
+ * }).pipe(
+ *   Effect.catchAll(error =>
+ *     Effect.succeed(`Configuration error: ${error.message}`)
+ *   )
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const make = exports.make = /*#__PURE__*/Effect.fnUntraced(function* ({
+  alphabet = DEFAULT_ALPHABET,
+  prefix,
+  separator = DEFAULT_SEPARATOR,
+  size = DEFAULT_SIZE
+}) {
+  if (alphabet.includes(separator)) {
+    const message = `The separator "${separator}" must not be part of the alphabet "${alphabet}".`;
+    return yield* new Cause.IllegalArgumentException(message);
+  }
+  const generateId = makeGenerator({
+    alphabet,
+    prefix,
+    separator,
+    size
+  });
+  return {
+    generateId
+  };
+});
+/**
+ * Creates a Layer that provides the IdGenerator service with custom
+ * configuration.
+ *
+ * This is the recommended way to provide ID generation capabilities to your
+ * application. The layer will fail during construction if the configuration is
+ * invalid.
+ *
+ * @example
+ * ```ts
+ * import { IdGenerator } from "@effect/ai"
+ * import { Effect, Layer } from "effect"
+ *
+ * // Create a layer for generating AI tool call IDs
+ * const toolCallIdLayer = IdGenerator.layer({
+ *   alphabet: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ *   prefix: "tool_call",
+ *   separator: "_",
+ *   size: 12
+ * })
+ *
+ * const program = Effect.gen(function* () {
+ *   const idGen = yield* IdGenerator.IdGenerator
+ *   const toolCallId = yield* idGen.generateId()
+ *   console.log(toolCallId) // "tool_call_A7XK9MP2QR5T"
+ *   return toolCallId
+ * }).pipe(
+ *   Effect.provide(toolCallIdLayer)
+ * )
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+const layer = options => Layer.effect(IdGenerator, make(options));
+exports.layer = layer;
+//# sourceMappingURL=IdGenerator.js.map

package/dist/cjs/IdGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdGenerator.js","names":["Cause","_interopRequireWildcard","require","Context","Effect","Layer","Predicate","Random","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","IdGenerator","Tag","exports","DEFAULT_ALPHABET","DEFAULT_SEPARATOR","DEFAULT_SIZE","makeGenerator","alphabet","prefix","separator","size","alphabetLength","length","fnUntraced","chars","Array","next","identifier","join","isUndefined","defaultIdGenerator","generateId","make","includes","message","IllegalArgumentException","layer","options","effect"],"sources":["../../src/IdGenerator.ts"],"sourcesContent":[null],"mappings":";;;;;;AAmDA,IAAAA,KAAA,GAAAC,uBAAA,CAAAC,OAAA;AACA,IAAAC,OAAA,GAAAF,uBAAA,CAAAC,OAAA;AACA,IAAAE,MAAA,GAAAH,uBAAA,CAAAC,OAAA;AACA,IAAAG,KAAA,GAAAJ,uBAAA,CAAAC,OAAA;AACA,IAAAI,SAAA,GAAAL,uBAAA,CAAAC,OAAA;AACA,IAAAK,MAAA,GAAAN,uBAAA,CAAAC,OAAA;AAAuC,SAAAD,wBAAAO,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAT,uBAAA,YAAAA,CAAAO,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,gBAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA,WAAAO,CAAA,KAAAR,CAAA,EAAAC,CAAA;AAxDvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA;;;;;;;;;;;;;;;;;;;;;;AAsBM,MAAOkB,WAAY,sBAAQxB,OAAO,CAACyB,GAAG,CAAC,wBAAwB,CAAC,EAGnE;AAAAC,OAAA,CAAAF,WAAA,GAAAA,WAAA;AAyEH,MAAMG,gBAAgB,GAAG,gEAAgE;AACzF,MAAMC,iBAAiB,GAAG,GAAG;AAC7B,MAAMC,YAAY,GAAG,EAAE;AAEvB,MAAMC,aAAa,GAAGA,CAAC;EACrBC,QAAQ,GAAGJ,gBAAgB;EAC3BK,MAAM;EACNC,SAAS,GAAGL,iBAAiB;EAC7BM,IAAI,GAAGL;AAAY,CACE,KAAI;EACzB,MAAMM,cAAc,GAAGJ,QAAQ,CAACK,MAAM;EACtC,OAAOnC,MAAM,CAACoC,UAAU,CAAC,aAAS;IAChC,MAAMC,KAAK,GAAG,IAAIC,KAAK,CAACL,IAAI,CAAC;IAC7B,KAAK,IAAItB,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGsB,IAAI,EAAEtB,CAAC,EAAE,EAAE;MAC7B0B,KAAK,CAAC1B,CAAC,CAAC,GAAGmB,QAAQ,CAAE,CAAC,OAAO3B,MAAM,CAACoC,IAAI,IAAIL,cAAc,GAAI,CAAC,CAAC;IAClE;IACA,MAAMM,UAAU,GAAGH,KAAK,CAACI,IAAI,CAAC,EAAE,CAAC;IACjC,IAAIvC,SAAS,CAACwC,WAAW,CAACX,MAAM,CAAC,EAAE;MACjC,OAAOS,UAAU;IACnB;IACA,OAAO,GAAGT,MAAM,GAAGC,SAAS,GAAGQ,UAAU,EAAE;EAC7C,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BO,MAAMG,kBAAkB,GAAAlB,OAAA,CAAAkB,kBAAA,GAAY;EACzCC,UAAU,eAAEf,aAAa,CAAC;IAAEE,MAAM,EAAE;EAAI,CAAE;CAC3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDO,MAAMc,IAAI,GAAApB,OAAA,CAAAoB,IAAA,gBAAG7C,MAAM,CAACoC,UAAU,CAAC,WAAU;EAC9CN,QAAQ,GAAGJ,gBAAgB;EAC3BK,MAAM;EACNC,SAAS,GAAGL,iBAAiB;EAC7BM,IAAI,GAAGL;AAAY,CACP;EACZ,IAAIE,QAAQ,CAACgB,QAAQ,CAACd,SAAS,CAAC,EAAE;IAChC,MAAMe,OAAO,GAAG,kBAAkBf,SAAS,uCAAuCF,QAAQ,IAAI;IAC9F,OAAO,OAAO,IAAIlC,KAAK,CAACoD,wBAAwB,CAACD,OAAO,CAAC;EAC3D;EAEA,MAAMH,UAAU,GAAGf,aAAa,CAAC;IAAEC,QAAQ;IAAEC,MAAM;IAAEC,SAAS;IAAEC;EAAI,CAAE,CAAC;EAEvE,OAAO;IACLW;GACQ;AACZ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCO,MAAMK,KAAK,GAAIC,OAAoB,IACxCjD,KAAK,CAACkD,MAAM,CAAC5B,WAAW,EAAEsB,IAAI,CAACK,OAAO,CAAC,CAAC;AAAAzB,OAAA,CAAAwB,KAAA,GAAAA,KAAA","ignoreList":[]}