beeai-framework 0.1.2

package/dist/serializer-CJx5ZpUx.d.cts

@@ -0,0 +1,125 @@
+import { SerializableClass, Serializable } from './internals/serializable.cjs';
+import { ClassConstructor, NamedFunction, AnyFn, AnyConstructable } from './internals/types.cjs';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const SerializerSelfRefIdentifier = "__self_ref";
+declare const SerializerRefIdentifier = "__ref";
+declare class ClassConstructorPlaceholder {
+}
+declare class RefPlaceholder<T = unknown> {
+    protected readonly node: SerializerNode;
+    protected readonly factory: SerializeFactory<T>;
+    private static EmptyPlaceholder;
+    private partialResult;
+    constructor(node: SerializerNode, factory: SerializeFactory<T>);
+    get value(): T;
+    final(): Promise<T>;
+}
+interface SerializerNode {
+    __class: string;
+    __ref: string;
+    __value: unknown;
+    __serializer: true;
+}
+declare function isSerializerNode(data: unknown): data is SerializerNode;
+interface RootNode<T = any> {
+    __version: string;
+    __root: T;
+}
+declare function isRootNode<T>(data: unknown): data is RootNode<T>;
+declare const extractClassName: (value: unknown) => string;
+declare function primitiveToSerializableClass(value: unknown): SymbolConstructor | ObjectConstructor | FunctionConstructor | BooleanConstructor | StringConstructor | NumberConstructor | BigIntConstructor | {
+    new (): {};
+} | {
+    new (): {};
+};
+type TraverseObjectFn = (el: {
+    key: string;
+    path: readonly string[];
+    value: any;
+}) => Promise<void>;
+declare function traverseObject(obj: unknown, handler: TraverseObjectFn, stopFn?: (_obj: unknown) => boolean): Promise<void>;
+declare function isSerializationRequired(factory: ClassConstructor | NamedFunction): boolean;
+declare function traverseWithUpdate<T = unknown>(_obj: unknown): Generator<{
+    value: T;
+    update: (value: T) => void;
+}>;
+declare function shallowCopy<T>(value: T): T;
+declare function deepCopy<T>(source: T): Promise<T>;
+type Bounded = {
+    name: string;
+    value: any;
+} | AnyConstructable;
+declare function toBoundedFunction<T extends AnyFn>(fn: T, binds: [Bounded, ...Bounded[]]): T;
+declare namespace toBoundedFunction {
+    var symbol: symbol;
+}
+declare function getFunctionBinds<T extends Function>(fn: T): Bounded[];
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface SerializeFactory<A = unknown, B = unknown> {
+    ref: ClassConstructor<A> | NamedFunction<A>;
+    createEmpty?: () => A;
+    updateInstance?: (instance: A, update: A) => void | Promise<void>;
+    toPlain: (value: A) => B | Promise<B>;
+    fromPlain: (value: B, ref: ClassConstructor<A> | NamedFunction<A>) => A | Promise<A>;
+}
+declare class Serializer {
+    private static factories;
+    static registerSerializable<A>(ref: SerializableClass<A>, processors?: Partial<Omit<SerializeFactory<Serializable<A>, A>, "ref">>, aliases?: string[]): void;
+    static deregister(ref: ClassConstructor | NamedFunction): void;
+    static register<A, B = unknown>(ref: ClassConstructor<A> | NamedFunction<A>, processors: Omit<SerializeFactory<A, B>, "ref">, aliases?: string[]): void;
+    static getFactory(clsName: string): SerializeFactory;
+    static findFactory(value: unknown): {
+        targetClass: string;
+        factory: SerializeFactory<unknown, unknown>;
+        isSelfRef: boolean;
+    } | {
+        targetClass: string;
+        factory: SerializeFactory<any, any>;
+        isSelfRef: boolean;
+    };
+    static hasFactory(clsName: string): boolean;
+    static serialize<T>(rawData: T): Promise<string>;
+    /** @internal */
+    static deserializeWithMeta<T = any>(raw: string, extraClasses?: SerializableClass<unknown>[]): Promise<RootNode<T>>;
+    static deserialize<T = any>(raw: string, extraClasses?: SerializableClass<unknown>[]): Promise<T>;
+    protected static _createOutputBuilder<T>(): {
+        _container: T;
+        get(): T;
+        update(path: readonly string[], value: any): void;
+        toJSON(): string;
+    };
+}
+
+export { ClassConstructorPlaceholder as C, RefPlaceholder as R, type SerializeFactory as S, Serializer as a, SerializerSelfRefIdentifier as b, SerializerRefIdentifier as c, type SerializerNode as d, type RootNode as e, isRootNode as f, extractClassName as g, isSerializationRequired as h, isSerializerNode as i, traverseWithUpdate as j, deepCopy as k, toBoundedFunction as l, getFunctionBinds as m, primitiveToSerializableClass as p, shallowCopy as s, traverseObject as t };

package/dist/serializer-VYDhdryk.d.ts

@@ -0,0 +1,125 @@
+import { SerializableClass, Serializable } from './internals/serializable.js';
+import { ClassConstructor, NamedFunction, AnyFn, AnyConstructable } from './internals/types.js';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const SerializerSelfRefIdentifier = "__self_ref";
+declare const SerializerRefIdentifier = "__ref";
+declare class ClassConstructorPlaceholder {
+}
+declare class RefPlaceholder<T = unknown> {
+    protected readonly node: SerializerNode;
+    protected readonly factory: SerializeFactory<T>;
+    private static EmptyPlaceholder;
+    private partialResult;
+    constructor(node: SerializerNode, factory: SerializeFactory<T>);
+    get value(): T;
+    final(): Promise<T>;
+}
+interface SerializerNode {
+    __class: string;
+    __ref: string;
+    __value: unknown;
+    __serializer: true;
+}
+declare function isSerializerNode(data: unknown): data is SerializerNode;
+interface RootNode<T = any> {
+    __version: string;
+    __root: T;
+}
+declare function isRootNode<T>(data: unknown): data is RootNode<T>;
+declare const extractClassName: (value: unknown) => string;
+declare function primitiveToSerializableClass(value: unknown): SymbolConstructor | ObjectConstructor | FunctionConstructor | BooleanConstructor | StringConstructor | NumberConstructor | BigIntConstructor | {
+    new (): {};
+} | {
+    new (): {};
+};
+type TraverseObjectFn = (el: {
+    key: string;
+    path: readonly string[];
+    value: any;
+}) => Promise<void>;
+declare function traverseObject(obj: unknown, handler: TraverseObjectFn, stopFn?: (_obj: unknown) => boolean): Promise<void>;
+declare function isSerializationRequired(factory: ClassConstructor | NamedFunction): boolean;
+declare function traverseWithUpdate<T = unknown>(_obj: unknown): Generator<{
+    value: T;
+    update: (value: T) => void;
+}>;
+declare function shallowCopy<T>(value: T): T;
+declare function deepCopy<T>(source: T): Promise<T>;
+type Bounded = {
+    name: string;
+    value: any;
+} | AnyConstructable;
+declare function toBoundedFunction<T extends AnyFn>(fn: T, binds: [Bounded, ...Bounded[]]): T;
+declare namespace toBoundedFunction {
+    var symbol: symbol;
+}
+declare function getFunctionBinds<T extends Function>(fn: T): Bounded[];
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface SerializeFactory<A = unknown, B = unknown> {
+    ref: ClassConstructor<A> | NamedFunction<A>;
+    createEmpty?: () => A;
+    updateInstance?: (instance: A, update: A) => void | Promise<void>;
+    toPlain: (value: A) => B | Promise<B>;
+    fromPlain: (value: B, ref: ClassConstructor<A> | NamedFunction<A>) => A | Promise<A>;
+}
+declare class Serializer {
+    private static factories;
+    static registerSerializable<A>(ref: SerializableClass<A>, processors?: Partial<Omit<SerializeFactory<Serializable<A>, A>, "ref">>, aliases?: string[]): void;
+    static deregister(ref: ClassConstructor | NamedFunction): void;
+    static register<A, B = unknown>(ref: ClassConstructor<A> | NamedFunction<A>, processors: Omit<SerializeFactory<A, B>, "ref">, aliases?: string[]): void;
+    static getFactory(clsName: string): SerializeFactory;
+    static findFactory(value: unknown): {
+        targetClass: string;
+        factory: SerializeFactory<unknown, unknown>;
+        isSelfRef: boolean;
+    } | {
+        targetClass: string;
+        factory: SerializeFactory<any, any>;
+        isSelfRef: boolean;
+    };
+    static hasFactory(clsName: string): boolean;
+    static serialize<T>(rawData: T): Promise<string>;
+    /** @internal */
+    static deserializeWithMeta<T = any>(raw: string, extraClasses?: SerializableClass<unknown>[]): Promise<RootNode<T>>;
+    static deserialize<T = any>(raw: string, extraClasses?: SerializableClass<unknown>[]): Promise<T>;
+    protected static _createOutputBuilder<T>(): {
+        _container: T;
+        get(): T;
+        update(path: readonly string[], value: any): void;
+        toJSON(): string;
+    };
+}
+
+export { ClassConstructorPlaceholder as C, RefPlaceholder as R, type SerializeFactory as S, Serializer as a, SerializerSelfRefIdentifier as b, SerializerRefIdentifier as c, type SerializerNode as d, type RootNode as e, isRootNode as f, extractClassName as g, isSerializationRequired as h, isSerializerNode as i, traverseWithUpdate as j, deepCopy as k, toBoundedFunction as l, getFunctionBinds as m, primitiveToSerializableClass as p, shallowCopy as s, traverseObject as t };

package/dist/template.cjs

@@ -0,0 +1,121 @@
+'use strict';
+
+var errors_cjs = require('./errors.cjs');
+var remeda = require('remeda');
+var Mustache = require('mustache');
+var serializable_cjs = require('./internals/serializable.cjs');
+var schema_cjs = require('./internals/helpers/schema.cjs');
+var object_cjs = require('./internals/helpers/object.cjs');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var Mustache__default = /*#__PURE__*/_interopDefault(Mustache);
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class PromptTemplateError extends errors_cjs.FrameworkError {
+  static {
+    __name(this, "PromptTemplateError");
+  }
+  template;
+  constructor(message, template, context) {
+    super(message, [], {
+      context
+    });
+    this.template = template;
+  }
+}
+class ValidationPromptTemplateError extends PromptTemplateError {
+  static {
+    __name(this, "ValidationPromptTemplateError");
+  }
+}
+class PromptTemplate extends serializable_cjs.Serializable {
+  static {
+    __name(this, "PromptTemplate");
+  }
+  config;
+  static functions = {
+    trim: /* @__PURE__ */ __name(() => (text, render) => {
+      return render(text).replace(/(,\s*$)/g, "");
+    }, "trim")
+  };
+  constructor(config) {
+    super();
+    this.config = {
+      ...config,
+      defaults: config.defaults ?? {},
+      schema: schema_cjs.toJsonSchema(config.schema),
+      escape: Boolean(config.escape),
+      customTags: config.customTags ?? [
+        "{{",
+        "}}"
+      ],
+      functions: {
+        ...PromptTemplate.functions,
+        ...config.functions
+      }
+    };
+  }
+  static {
+    this.register();
+  }
+  validateInput(input) {
+    const validator = schema_cjs.createSchemaValidator(this.config.schema, {
+      coerceTypes: false
+    });
+    const success = validator(input);
+    if (!success) {
+      throw new ValidationPromptTemplateError(`Template cannot be rendered because input does not adhere to the template schema.`, this, {
+        errors: validator.errors
+      });
+    }
+  }
+  fork(customizer) {
+    const config = remeda.clone(this.config);
+    const newConfig = customizer?.(config) ?? config;
+    if (!remeda.isPlainObject(newConfig)) {
+      throw new errors_cjs.ValueError("Return type from customizer must be a config or nothing.");
+    }
+    return new PromptTemplate(newConfig);
+  }
+  render(input) {
+    const updatedInput = {
+      ...input
+    };
+    Object.assign(updatedInput, remeda.pickBy(this.config.defaults, (_, k) => object_cjs.getProp(updatedInput, [
+      k
+    ]) === void 0));
+    this.validateInput(updatedInput);
+    const view = {
+      ...this.config.functions,
+      ...updatedInput
+    };
+    const output = Mustache__default.default.render(this.config.template, view, {}, {
+      tags: this.config.customTags,
+      ...!this.config.escape && {
+        escape: remeda.identity()
+      }
+    });
+    if (output.match(/\[object (.+)]/)) {
+      throw new ValidationPromptTemplateError("Rendered template contains incorrectly serialized value!", this, {
+        output
+      });
+    }
+    return output;
+  }
+  loadSnapshot(data) {
+    this.config = data.config;
+  }
+  createSnapshot() {
+    return {
+      config: this.config
+    };
+  }
+}
+
+exports.PromptTemplate = PromptTemplate;
+exports.PromptTemplateError = PromptTemplateError;
+exports.ValidationPromptTemplateError = ValidationPromptTemplateError;
+//# sourceMappingURL=template.cjs.map
+//# sourceMappingURL=template.cjs.map

package/dist/template.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/template.ts"],"names":["PromptTemplateError","FrameworkError","template","constructor","message","context","ValidationPromptTemplateError","PromptTemplate","Serializable","config","functions","trim","text","render","replace","defaults","schema","toJsonSchema","escape","Boolean","customTags","register","validateInput","input","validator","createSchemaValidator","coerceTypes","success","errors","fork","customizer","clone","newConfig","isPlainObject","ValueError","updatedInput","Object","assign","pickBy","_","k","getProp","undefined","view","output","Mustache","tags","identity","match","loadSnapshot","data","createSnapshot"],"mappings":";;;;;;;;;;;;;;;AA2DO,MAAMA,4BAA+CC,yBAAAA,CAAAA;EA3D5D;;;AA4DEC,EAAAA,QAAAA;EAEAC,WAAYC,CAAAA,OAAAA,EAAiBF,UAA6BG,OAAsB,EAAA;AAC9E,IAAMD,KAAAA,CAAAA,OAAAA,EAAS,EAAI,EAAA;AACjBC,MAAAA;KACF,CAAA;AACA,IAAA,IAAA,CAAKH,QAAWA,GAAAA,QAAAA;AAClB;AACF;AAEO,MAAMI,sCAAyDN,mBAAAA,CAAAA;EAtEtE;;;AAsE8F;AAEvF,MAAMO,uBAA0CC,6BAAAA,CAAAA;EAxEvD;;;AAyEYC,EAAAA,MAAAA;AAEV,EAAA,OAAcC,SAAY,GAAA;IACxBC,IAAM,kBAAA,MAAA,CAAA,MAAM,CAACC,IAAAA,EAAcC,MAAAA,KAAAA;AACzB,MAAA,OAAOA,MAAOD,CAAAA,IAAAA,CAAME,CAAAA,OAAAA,CAAQ,YAAY,EAAA,CAAA;KADpC,EAAA,MAAA;AAGR,GAAA;AAEAX,EAAAA,WAAAA,CAAYM,MAA+E,EAAA;AACzF,IAAK,KAAA,EAAA;AACL,IAAA,IAAA,CAAKA,MAAS,GAAA;MACZ,GAAGA,MAAAA;MACHM,QAAWN,EAAAA,MAAAA,CAAOM,YAAY,EAAC;MAC/BC,MAAQC,EAAAA,uBAAAA,CAAaR,OAAOO,MAAM,CAAA;MAClCE,MAAQC,EAAAA,OAAAA,CAAQV,OAAOS,MAAM,CAAA;AAC7BE,MAAAA,UAAAA,EAAYX,OAAOW,UAAc,IAAA;AAAC,QAAA,IAAA;AAAM,QAAA;;MACxCV,SAAW,EAAA;AACT,QAAA,GAAGH,cAAeG,CAAAA,SAAAA;AAClB,QAAA,GAAGD,MAAOC,CAAAA;AACZ;AACF,KAAA;AACF;EAEA;AACE,IAAA,IAAA,CAAKW,QAAQ,EAAA;AACf;AAEAC,EAAAA,aAAAA,CAAcC,KAAoC,EAAA;AAChD,IAAA,MAAMC,SAAYC,GAAAA,gCAAAA,CAAsB,IAAKhB,CAAAA,MAAAA,CAAOO,MAAQ,EAAA;MAC1DU,WAAa,EAAA;KACf,CAAA;AAEA,IAAMC,MAAAA,OAAAA,GAAUH,UAAUD,KAAAA,CAAAA;AAC1B,IAAA,IAAI,CAACI,OAAS,EAAA;AACZ,MAAM,MAAA,IAAIrB,6BACR,CAAA,CAAA,iFAAA,CAAA,EACA,IACA,EAAA;AACEsB,QAAAA,MAAAA,EAAQJ,SAAUI,CAAAA;OACpB,CAAA;AAEJ;AACF;AAIAC,EAAAA,IAAAA,CACEC,UACuB,EAAA;AACvB,IAAMrB,MAAAA,MAAAA,GAASsB,YAAM,CAAA,IAAA,CAAKtB,MAAM,CAAA;AAChC,IAAMuB,MAAAA,SAAAA,GAAYF,UAAarB,GAAAA,MAAAA,CAAWA,IAAAA,MAAAA;AAC1C,IAAI,IAAA,CAACwB,oBAAcD,CAAAA,SAAAA,CAAY,EAAA;AAC7B,MAAM,MAAA,IAAIE,sBAAW,0DAAA,CAAA;AACvB;AACA,IAAO,OAAA,IAAI3B,eAAeyB,SAAAA,CAAAA;AAC5B;AAEAnB,EAAAA,MAAAA,CAAOU,KAA6C,EAAA;AAClD,IAAA,MAAMY,YAA6B,GAAA;MAAE,GAAGZ;AAAM,KAAA;AAC9Ca,IAAOC,MAAAA,CAAAA,MAAAA,CACLF,YACAG,EAAAA,aAAAA,CAAO,IAAK7B,CAAAA,MAAAA,CAAOM,UAAU,CAACwB,CAAAA,EAAGC,CAAMC,KAAAA,kBAAAA,CAAQN,YAAc,EAAA;AAACK,MAAAA;AAAE,KAAA,CAAA,KAAME,MAAAA,CAAAA,CAAAA;AAGxE,IAAA,IAAA,CAAKpB,cAAca,YAAAA,CAAAA;AACnB,IAAA,MAAMQ,IAA4B,GAAA;AAChC,MAAA,GAAG,KAAKlC,MAAOC,CAAAA,SAAAA;MACf,GAAGyB;AACL,KAAA;AAEA,IAAMS,MAAAA,MAAAA,GAASC,0BAAShC,MACtB,CAAA,IAAA,CAAKJ,OAAOP,QACZyC,EAAAA,IAAAA,EACA,EACA,EAAA;AACEG,MAAAA,IAAAA,EAAM,KAAKrC,MAAOW,CAAAA,UAAAA;MAClB,GAAI,CAAC,IAAKX,CAAAA,MAAAA,CAAOS,MAAU,IAAA;AACzBA,QAAAA,MAAAA,EAAQ6B,eAAAA;AACV;KACF,CAAA;AAGF,IAAIH,IAAAA,MAAAA,CAAOI,KAAM,CAAA,gBAAA,CAAmB,EAAA;AAClC,MAAM,MAAA,IAAI1C,6BACR,CAAA,0DAAA,EACA,IACA,EAAA;AACEsC,QAAAA;OACF,CAAA;AAEJ;AAEA,IAAOA,OAAAA,MAAAA;AACT;AAEAK,EAAAA,YAAAA,CAAaC,IAA8C,EAAA;AACzD,IAAA,IAAA,CAAKzC,SAASyC,IAAKzC,CAAAA,MAAAA;AACrB;EAEA0C,cAAiB,GAAA;AACf,IAAO,OAAA;AACL1C,MAAAA,MAAAA,EAAQ,IAAKA,CAAAA;AACf,KAAA;AACF;AACF","file":"template.cjs","sourcesContent":["/**\n * Copyright 2025 IBM Corp.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { FrameworkError, ValueError } from \"@/errors.js\";\nimport { ObjectLike, PlainObject } from \"@/internals/types.js\";\nimport { clone, identity, isPlainObject, pickBy } from \"remeda\";\nimport Mustache from \"mustache\";\nimport { Serializable } from \"@/internals/serializable.js\";\nimport { z, ZodType } from \"zod\";\nimport { createSchemaValidator, toJsonSchema } from \"@/internals/helpers/schema.js\";\nimport type { SchemaObject, ValidateFunction } from \"ajv\";\nimport { getProp } from \"@/internals/helpers/object.js\";\n\ntype PostInfer<T> = T extends PlainObject\n  ? {\n      [K in keyof T]: T[K] extends Date ? string : T[K];\n    }\n  : T;\ntype InferValue<T> = T extends ZodType<infer A> ? PostInfer<A> : never;\nexport type PromptTemplateRenderFn<K extends ZodType> = (this: InferValue<K>) => any;\n\nexport type PromptTemplateRenderInput<T extends ZodType, T2 extends z.input<T> = z.input<T>> = {\n  [K in Extract<keyof T2, string>]: T2[K] | PromptTemplateRenderFn<T> | undefined;\n};\n\nexport interface PromptTemplateInput<T extends ZodType> {\n  template: string;\n  customTags?: [string, string];\n  escape?: boolean;\n  schema: SchemaObject;\n  defaults?: Partial<InferValue<T>>;\n  functions?: Record<string, PromptTemplateRenderFn<T>>;\n}\n\ntype PromptTemplateConstructor<T extends ZodType, N> = N extends ZodType\n  ? Omit<PromptTemplateInput<N>, \"schema\" | \"functions\" | \"defaults\"> & {\n      schema: N;\n      functions?: Record<string, PromptTemplateRenderFn<N | T>>;\n      defaults?: Partial<InferValue<N | T>>;\n    }\n  : Omit<PromptTemplateInput<T>, \"schema\"> & { schema: T | SchemaObject };\n\ntype Customizer<T extends ZodType, N> =\n  | ((config: Required<PromptTemplateInput<T>>) => PromptTemplateConstructor<T, N>)\n  | ((config: Required<PromptTemplateInput<T>>) => void);\n\nexport class PromptTemplateError<T extends ZodType> extends FrameworkError {\n  template: PromptTemplate<T>;\n\n  constructor(message: string, template: PromptTemplate<T>, context?: ObjectLike) {\n    super(message, [], {\n      context,\n    });\n    this.template = template;\n  }\n}\n\nexport class ValidationPromptTemplateError<T extends ZodType> extends PromptTemplateError<T> {}\n\nexport class PromptTemplate<T extends ZodType> extends Serializable {\n  protected config: Required<PromptTemplateInput<T>>;\n\n  public static functions = {\n    trim: () => (text: string, render: (value: string) => string) => {\n      return render(text).replace(/(,\\s*$)/g, \"\");\n    },\n  };\n\n  constructor(config: Omit<PromptTemplateInput<T>, \"schema\"> & { schema: T | SchemaObject }) {\n    super();\n    this.config = {\n      ...config,\n      defaults: (config.defaults ?? {}) as Partial<InferValue<T>>,\n      schema: toJsonSchema(config.schema),\n      escape: Boolean(config.escape),\n      customTags: config.customTags ?? [\"{{\", \"}}\"],\n      functions: {\n        ...PromptTemplate.functions,\n        ...config.functions,\n      },\n    };\n  }\n\n  static {\n    this.register();\n  }\n\n  validateInput(input: unknown): asserts input is T {\n    const validator = createSchemaValidator(this.config.schema, {\n      coerceTypes: false,\n    }) as ValidateFunction<T>;\n\n    const success = validator(input);\n    if (!success) {\n      throw new ValidationPromptTemplateError(\n        `Template cannot be rendered because input does not adhere to the template schema.`,\n        this,\n        {\n          errors: validator.errors,\n        },\n      );\n    }\n  }\n\n  fork(customizer: Customizer<T, SchemaObject>): PromptTemplate<T>;\n  fork<R extends ZodType>(customizer: Customizer<T, R>): PromptTemplate<R>;\n  fork<R extends ZodType>(\n    customizer: Customizer<T, SchemaObject> | Customizer<T, R>,\n  ): PromptTemplate<T | R> {\n    const config = clone(this.config);\n    const newConfig = customizer?.(config) ?? config;\n    if (!isPlainObject(newConfig)) {\n      throw new ValueError(\"Return type from customizer must be a config or nothing.\");\n    }\n    return new PromptTemplate(newConfig);\n  }\n\n  render(input: PromptTemplateRenderInput<T>): string {\n    const updatedInput: typeof input = { ...input };\n    Object.assign(\n      updatedInput,\n      pickBy(this.config.defaults, (_, k) => getProp(updatedInput, [k]) === undefined),\n    );\n\n    this.validateInput(updatedInput);\n    const view: Record<string, any> = {\n      ...this.config.functions,\n      ...updatedInput,\n    };\n\n    const output = Mustache.render(\n      this.config.template,\n      view,\n      {},\n      {\n        tags: this.config.customTags,\n        ...(!this.config.escape && {\n          escape: identity(),\n        }),\n      },\n    );\n\n    if (output.match(/\\[object (.+)]/)) {\n      throw new ValidationPromptTemplateError(\n        \"Rendered template contains incorrectly serialized value!\",\n        this,\n        {\n          output,\n        },\n      );\n    }\n\n    return output;\n  }\n\n  loadSnapshot(data: ReturnType<typeof this.createSnapshot>) {\n    this.config = data.config;\n  }\n\n  createSnapshot() {\n    return {\n      config: this.config,\n    };\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace PromptTemplate {\n  export type infer<T> = PromptTemplate<ZodType<T>>;\n}\n"]}

package/dist/template.d.cts

@@ -0,0 +1,75 @@
+import { FrameworkError } from './errors.cjs';
+import { ObjectLike, PlainObject } from './internals/types.cjs';
+import { Serializable } from './internals/serializable.cjs';
+import { ZodType, z } from 'zod';
+import { SchemaObject } from 'ajv';
+import './internals/helpers/guards.cjs';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+type PostInfer<T> = T extends PlainObject ? {
+    [K in keyof T]: T[K] extends Date ? string : T[K];
+} : T;
+type InferValue<T> = T extends ZodType<infer A> ? PostInfer<A> : never;
+type PromptTemplateRenderFn<K extends ZodType> = (this: InferValue<K>) => any;
+type PromptTemplateRenderInput<T extends ZodType, T2 extends z.input<T> = z.input<T>> = {
+    [K in Extract<keyof T2, string>]: T2[K] | PromptTemplateRenderFn<T> | undefined;
+};
+interface PromptTemplateInput<T extends ZodType> {
+    template: string;
+    customTags?: [string, string];
+    escape?: boolean;
+    schema: SchemaObject;
+    defaults?: Partial<InferValue<T>>;
+    functions?: Record<string, PromptTemplateRenderFn<T>>;
+}
+type PromptTemplateConstructor<T extends ZodType, N> = N extends ZodType ? Omit<PromptTemplateInput<N>, "schema" | "functions" | "defaults"> & {
+    schema: N;
+    functions?: Record<string, PromptTemplateRenderFn<N | T>>;
+    defaults?: Partial<InferValue<N | T>>;
+} : Omit<PromptTemplateInput<T>, "schema"> & {
+    schema: T | SchemaObject;
+};
+type Customizer<T extends ZodType, N> = ((config: Required<PromptTemplateInput<T>>) => PromptTemplateConstructor<T, N>) | ((config: Required<PromptTemplateInput<T>>) => void);
+declare class PromptTemplateError<T extends ZodType> extends FrameworkError {
+    template: PromptTemplate<T>;
+    constructor(message: string, template: PromptTemplate<T>, context?: ObjectLike);
+}
+declare class ValidationPromptTemplateError<T extends ZodType> extends PromptTemplateError<T> {
+}
+declare class PromptTemplate<T extends ZodType> extends Serializable {
+    protected config: Required<PromptTemplateInput<T>>;
+    static functions: {
+        trim: () => (text: string, render: (value: string) => string) => string;
+    };
+    constructor(config: Omit<PromptTemplateInput<T>, "schema"> & {
+        schema: T | SchemaObject;
+    });
+    validateInput(input: unknown): asserts input is T;
+    fork(customizer: Customizer<T, SchemaObject>): PromptTemplate<T>;
+    fork<R extends ZodType>(customizer: Customizer<T, R>): PromptTemplate<R>;
+    render(input: PromptTemplateRenderInput<T>): string;
+    loadSnapshot(data: ReturnType<typeof this.createSnapshot>): void;
+    createSnapshot(): {
+        config: Required<PromptTemplateInput<T>>;
+    };
+}
+declare namespace PromptTemplate {
+    type infer<T> = PromptTemplate<ZodType<T>>;
+}
+
+export { PromptTemplate, PromptTemplateError, type PromptTemplateInput, type PromptTemplateRenderFn, type PromptTemplateRenderInput, ValidationPromptTemplateError };

package/dist/template.d.ts

@@ -0,0 +1,75 @@
+import { FrameworkError } from './errors.js';
+import { ObjectLike, PlainObject } from './internals/types.js';
+import { Serializable } from './internals/serializable.js';
+import { ZodType, z } from 'zod';
+import { SchemaObject } from 'ajv';
+import './internals/helpers/guards.js';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+type PostInfer<T> = T extends PlainObject ? {
+    [K in keyof T]: T[K] extends Date ? string : T[K];
+} : T;
+type InferValue<T> = T extends ZodType<infer A> ? PostInfer<A> : never;
+type PromptTemplateRenderFn<K extends ZodType> = (this: InferValue<K>) => any;
+type PromptTemplateRenderInput<T extends ZodType, T2 extends z.input<T> = z.input<T>> = {
+    [K in Extract<keyof T2, string>]: T2[K] | PromptTemplateRenderFn<T> | undefined;
+};
+interface PromptTemplateInput<T extends ZodType> {
+    template: string;
+    customTags?: [string, string];
+    escape?: boolean;
+    schema: SchemaObject;
+    defaults?: Partial<InferValue<T>>;
+    functions?: Record<string, PromptTemplateRenderFn<T>>;
+}
+type PromptTemplateConstructor<T extends ZodType, N> = N extends ZodType ? Omit<PromptTemplateInput<N>, "schema" | "functions" | "defaults"> & {
+    schema: N;
+    functions?: Record<string, PromptTemplateRenderFn<N | T>>;
+    defaults?: Partial<InferValue<N | T>>;
+} : Omit<PromptTemplateInput<T>, "schema"> & {
+    schema: T | SchemaObject;
+};
+type Customizer<T extends ZodType, N> = ((config: Required<PromptTemplateInput<T>>) => PromptTemplateConstructor<T, N>) | ((config: Required<PromptTemplateInput<T>>) => void);
+declare class PromptTemplateError<T extends ZodType> extends FrameworkError {
+    template: PromptTemplate<T>;
+    constructor(message: string, template: PromptTemplate<T>, context?: ObjectLike);
+}
+declare class ValidationPromptTemplateError<T extends ZodType> extends PromptTemplateError<T> {
+}
+declare class PromptTemplate<T extends ZodType> extends Serializable {
+    protected config: Required<PromptTemplateInput<T>>;
+    static functions: {
+        trim: () => (text: string, render: (value: string) => string) => string;
+    };
+    constructor(config: Omit<PromptTemplateInput<T>, "schema"> & {
+        schema: T | SchemaObject;
+    });
+    validateInput(input: unknown): asserts input is T;
+    fork(customizer: Customizer<T, SchemaObject>): PromptTemplate<T>;
+    fork<R extends ZodType>(customizer: Customizer<T, R>): PromptTemplate<R>;
+    render(input: PromptTemplateRenderInput<T>): string;
+    loadSnapshot(data: ReturnType<typeof this.createSnapshot>): void;
+    createSnapshot(): {
+        config: Required<PromptTemplateInput<T>>;
+    };
+}
+declare namespace PromptTemplate {
+    type infer<T> = PromptTemplate<ZodType<T>>;
+}
+
+export { PromptTemplate, PromptTemplateError, type PromptTemplateInput, type PromptTemplateRenderFn, type PromptTemplateRenderInput, ValidationPromptTemplateError };

package/dist/template.js

@@ -0,0 +1,113 @@
+import { FrameworkError, ValueError } from './errors.js';
+import { clone, isPlainObject, pickBy, identity } from 'remeda';
+import Mustache from 'mustache';
+import { Serializable } from './internals/serializable.js';
+import { toJsonSchema, createSchemaValidator } from './internals/helpers/schema.js';
+import { getProp } from './internals/helpers/object.js';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class PromptTemplateError extends FrameworkError {
+  static {
+    __name(this, "PromptTemplateError");
+  }
+  template;
+  constructor(message, template, context) {
+    super(message, [], {
+      context
+    });
+    this.template = template;
+  }
+}
+class ValidationPromptTemplateError extends PromptTemplateError {
+  static {
+    __name(this, "ValidationPromptTemplateError");
+  }
+}
+class PromptTemplate extends Serializable {
+  static {
+    __name(this, "PromptTemplate");
+  }
+  config;
+  static functions = {
+    trim: /* @__PURE__ */ __name(() => (text, render) => {
+      return render(text).replace(/(,\s*$)/g, "");
+    }, "trim")
+  };
+  constructor(config) {
+    super();
+    this.config = {
+      ...config,
+      defaults: config.defaults ?? {},
+      schema: toJsonSchema(config.schema),
+      escape: Boolean(config.escape),
+      customTags: config.customTags ?? [
+        "{{",
+        "}}"
+      ],
+      functions: {
+        ...PromptTemplate.functions,
+        ...config.functions
+      }
+    };
+  }
+  static {
+    this.register();
+  }
+  validateInput(input) {
+    const validator = createSchemaValidator(this.config.schema, {
+      coerceTypes: false
+    });
+    const success = validator(input);
+    if (!success) {
+      throw new ValidationPromptTemplateError(`Template cannot be rendered because input does not adhere to the template schema.`, this, {
+        errors: validator.errors
+      });
+    }
+  }
+  fork(customizer) {
+    const config = clone(this.config);
+    const newConfig = customizer?.(config) ?? config;
+    if (!isPlainObject(newConfig)) {
+      throw new ValueError("Return type from customizer must be a config or nothing.");
+    }
+    return new PromptTemplate(newConfig);
+  }
+  render(input) {
+    const updatedInput = {
+      ...input
+    };
+    Object.assign(updatedInput, pickBy(this.config.defaults, (_, k) => getProp(updatedInput, [
+      k
+    ]) === void 0));
+    this.validateInput(updatedInput);
+    const view = {
+      ...this.config.functions,
+      ...updatedInput
+    };
+    const output = Mustache.render(this.config.template, view, {}, {
+      tags: this.config.customTags,
+      ...!this.config.escape && {
+        escape: identity()
+      }
+    });
+    if (output.match(/\[object (.+)]/)) {
+      throw new ValidationPromptTemplateError("Rendered template contains incorrectly serialized value!", this, {
+        output
+      });
+    }
+    return output;
+  }
+  loadSnapshot(data) {
+    this.config = data.config;
+  }
+  createSnapshot() {
+    return {
+      config: this.config
+    };
+  }
+}
+
+export { PromptTemplate, PromptTemplateError, ValidationPromptTemplateError };
+//# sourceMappingURL=template.js.map
+//# sourceMappingURL=template.js.map