@fluidframework/type-factory 2.93.0

package/dist/methodBinding.d.ts

@@ -0,0 +1,101 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { TypeFactoryType } from "./treeAgentTypes.js";
+/**
+ * A utility type that extracts the method keys from a given type.
+ * @alpha
+ */
+export type MethodKeys<T> = {
+    [K in keyof T]: T[K] extends (...args: any[]) => any ? K : never;
+};
+/**
+ * A type that represents a constructor function.
+ * @alpha
+ */
+export type Ctor<T = any> = new (...args: any[]) => T;
+/**
+ * A type that represents a function argument.
+ * @alpha
+ */
+export type Arg<T extends TypeFactoryType = TypeFactoryType> = readonly [
+    name: string,
+    type: T
+];
+/**
+ * A utility type that extracts the argument types from a function definition.
+ * @alpha
+ */
+export type ArgsTuple<T extends readonly Arg[]> = T extends readonly [infer Single extends Arg] ? [Single[1]] : T extends readonly [infer Head extends Arg, ...infer Tail extends readonly Arg[]] ? [Head[1], ...ArgsTuple<Tail>] : never;
+/**
+ * A function definition interface that describes the structure of a function.
+ * @alpha
+ */
+export interface FunctionDef<Args extends readonly Arg[], Return extends TypeFactoryType, Rest extends TypeFactoryType | null = null> {
+    /**
+     * Optional description of the function.
+     */
+    description?: string;
+    /**
+     * The function's parameters.
+     */
+    args: Args;
+    /**
+     * Optional rest parameter type.
+     */
+    rest?: Rest;
+    /**
+     * The function's return type.
+     */
+    returns: Return;
+}
+/**
+ * A utility function to build a function definition.
+ * @alpha
+ */
+export declare function buildFunc<const Return extends TypeFactoryType, const Args extends readonly Arg[], const Rest extends TypeFactoryType | null = null>(def: {
+    description?: string;
+    returns: Return;
+    rest?: Rest;
+}, ...args: Args): FunctionDef<Args, Return, Rest>;
+/**
+ * An interface for exposing methods of classes to an agent.
+ * @alpha
+ */
+export interface ExposedMethods {
+    /**
+     * Expose a method with type factory types.
+     */
+    exposeMethod<const K extends string & keyof MethodKeys<InstanceType<S>>, S extends Ctor & IExposedMethods, Z extends FunctionDef<readonly Arg[], TypeFactoryType, TypeFactoryType | null>>(constructor: S, methodName: K, tfFunction: Z): void;
+    /**
+     * Expose a method with type factory types.
+     */
+    expose<const K extends string & keyof MethodKeys<InstanceType<S>>, S extends Ctor & IExposedMethods, Z extends FunctionDef<readonly Arg[], TypeFactoryType, TypeFactoryType | null>>(constructor: S, methodName: K, tfFunction: Z): void;
+}
+/**
+ * A symbol used to expose methods to the LLM.
+ * @alpha
+ */
+export declare const exposeMethodsSymbol: unique symbol;
+/**
+ * An interface that classes should implement to expose their methods to the LLM.
+ *
+ * @remarks
+ * The `getExposedMethods` free function will cause the method here to be called on the class passed to it.
+ *
+ * @privateremarks
+ * Implementing this interface correctly seems tricky?
+ * To actually implement it in a way that satisfies TypeScript,
+ * classes need to declare both a static version and an instance version of the method
+ * (the instance one can just delegate to the static one).
+ *
+ * @alpha
+ */
+export interface IExposedMethods {
+    /**
+     * Static method that exposes methods of this class to an agent.
+     */
+    [exposeMethodsSymbol](methods: ExposedMethods): void;
+}
+//# sourceMappingURL=methodBinding.d.ts.map

package/dist/methodBinding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methodBinding.d.ts","sourceRoot":"","sources":["../src/methodBinding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KAC1B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK;CAChE,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,GAAG,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,IAAI,SAAS;IACvE,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,CAAC;CACP,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,MAAM,SAAS,GAAG,CAAC,GAC5F,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GACX,CAAC,SAAS,SAAS,CAAC,MAAM,IAAI,SAAS,GAAG,EAAE,GAAG,MAAM,IAAI,SAAS,SAAS,GAAG,EAAE,CAAC,GAChF,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,GAC7B,KAAK,CAAC;AAEV;;;GAGG;AACH,MAAM,WAAW,WAAW,CAC3B,IAAI,SAAS,SAAS,GAAG,EAAE,EAC3B,MAAM,SAAS,eAAe,EAC9B,IAAI,SAAS,eAAe,GAAG,IAAI,GAAG,IAAI;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,SAAS,CACxB,KAAK,CAAC,MAAM,SAAS,eAAe,EACpC,KAAK,CAAC,IAAI,SAAS,SAAS,GAAG,EAAE,EACjC,KAAK,CAAC,IAAI,SAAS,eAAe,GAAG,IAAI,GAAG,IAAI,EAEhD,GAAG,EAAE;IAAE,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,EAC3D,GAAG,IAAI,EAAE,IAAI,GACX,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAOjC;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,YAAY,CACX,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC1D,CAAC,SAAS,IAAI,GAAG,eAAe,EAChC,CAAC,SAAS,WAAW,CAAC,SAAS,GAAG,EAAE,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC,EAC7E,WAAW,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,MAAM,CACL,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC1D,CAAC,SAAS,IAAI,GAAG,eAAe,EAChC,CAAC,SAAS,WAAW,CAAC,SAAS,GAAG,EAAE,EAAE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC,EAC7E,WAAW,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC;CACtD;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAoD,CAAC;AAE9F;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,CAAC,mBAAmB,CAAC,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;CACrD"}

package/dist/methodBinding.js

@@ -0,0 +1,26 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exposeMethodsSymbol = exports.buildFunc = void 0;
+/**
+ * A utility function to build a function definition.
+ * @alpha
+ */
+function buildFunc(def, ...args) {
+    return {
+        description: def.description,
+        returns: def.returns,
+        args,
+        rest: def.rest,
+    };
+}
+exports.buildFunc = buildFunc;
+/**
+ * A symbol used to expose methods to the LLM.
+ * @alpha
+ */
+exports.exposeMethodsSymbol = Symbol("Type factory expose method/symbol");
+//# sourceMappingURL=methodBinding.js.map

package/dist/methodBinding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methodBinding.js","sourceRoot":"","sources":["../src/methodBinding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAkEH;;;GAGG;AACH,SAAgB,SAAS,CAKxB,GAA2D,EAC3D,GAAG,IAAU;IAEb,OAAO;QACN,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,IAAI;QACJ,IAAI,EAAE,GAAG,CAAC,IAAI;KACd,CAAC;AACH,CAAC;AAdD,8BAcC;AA0BD;;;GAGG;AACU,QAAA,mBAAmB,GAAkB,MAAM,CAAC,mCAAmC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport type { TypeFactoryType } from \"./treeAgentTypes.js\";\n\n/**\n * A utility type that extracts the method keys from a given type.\n * @alpha\n */\nexport type MethodKeys<T> = {\n\t[K in keyof T]: T[K] extends (...args: any[]) => any ? K : never;\n};\n\n/**\n * A type that represents a constructor function.\n * @alpha\n */\nexport type Ctor<T = any> = new (...args: any[]) => T;\n\n/**\n * A type that represents a function argument.\n * @alpha\n */\nexport type Arg<T extends TypeFactoryType = TypeFactoryType> = readonly [\n\tname: string,\n\ttype: T,\n];\n\n/**\n * A utility type that extracts the argument types from a function definition.\n * @alpha\n */\nexport type ArgsTuple<T extends readonly Arg[]> = T extends readonly [infer Single extends Arg]\n\t? [Single[1]]\n\t: T extends readonly [infer Head extends Arg, ...infer Tail extends readonly Arg[]]\n\t\t? [Head[1], ...ArgsTuple<Tail>]\n\t\t: never;\n\n/**\n * A function definition interface that describes the structure of a function.\n * @alpha\n */\nexport interface FunctionDef<\n\tArgs extends readonly Arg[],\n\tReturn extends TypeFactoryType,\n\tRest extends TypeFactoryType | null = null,\n> {\n\t/**\n\t * Optional description of the function.\n\t */\n\tdescription?: string;\n\t/**\n\t * The function's parameters.\n\t */\n\targs: Args;\n\t/**\n\t * Optional rest parameter type.\n\t */\n\trest?: Rest;\n\t/**\n\t * The function's return type.\n\t */\n\treturns: Return;\n}\n\n/**\n * A utility function to build a function definition.\n * @alpha\n */\nexport function buildFunc<\n\tconst Return extends TypeFactoryType,\n\tconst Args extends readonly Arg[],\n\tconst Rest extends TypeFactoryType | null = null,\n>(\n\tdef: { description?: string; returns: Return; rest?: Rest },\n\t...args: Args\n): FunctionDef<Args, Return, Rest> {\n\treturn {\n\t\tdescription: def.description,\n\t\treturns: def.returns,\n\t\targs,\n\t\trest: def.rest,\n\t};\n}\n\n/**\n * An interface for exposing methods of classes to an agent.\n * @alpha\n */\nexport interface ExposedMethods {\n\t/**\n\t * Expose a method with type factory types.\n\t */\n\texposeMethod<\n\t\tconst K extends string & keyof MethodKeys<InstanceType<S>>,\n\t\tS extends Ctor & IExposedMethods,\n\t\tZ extends FunctionDef<readonly Arg[], TypeFactoryType, TypeFactoryType | null>,\n\t>(constructor: S, methodName: K, tfFunction: Z): void;\n\n\t/**\n\t * Expose a method with type factory types.\n\t */\n\texpose<\n\t\tconst K extends string & keyof MethodKeys<InstanceType<S>>,\n\t\tS extends Ctor & IExposedMethods,\n\t\tZ extends FunctionDef<readonly Arg[], TypeFactoryType, TypeFactoryType | null>,\n\t>(constructor: S, methodName: K, tfFunction: Z): void;\n}\n\n/**\n * A symbol used to expose methods to the LLM.\n * @alpha\n */\nexport const exposeMethodsSymbol: unique symbol = Symbol(\"Type factory expose method/symbol\");\n\n/**\n * An interface that classes should implement to expose their methods to the LLM.\n *\n * @remarks\n * The `getExposedMethods` free function will cause the method here to be called on the class passed to it.\n *\n * @privateremarks\n * Implementing this interface correctly seems tricky?\n * To actually implement it in a way that satisfies TypeScript,\n * classes need to declare both a static version and an instance version of the method\n * (the instance one can just delegate to the static one).\n *\n * @alpha\n */\nexport interface IExposedMethods {\n\t/**\n\t * Static method that exposes methods of this class to an agent.\n\t */\n\t[exposeMethodsSymbol](methods: ExposedMethods): void;\n}\n"]}

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+	"type": "commonjs",
+	"sideEffects": false
+}

package/dist/propertyBinding.d.ts

@@ -0,0 +1,50 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { Ctor } from "./methodBinding.js";
+import type { TypeFactoryType } from "./treeAgentTypes.js";
+/**
+ * A symbol used to expose properties to the LLM.
+ * @alpha
+ */
+export declare const exposePropertiesSymbol: unique symbol;
+/**
+ * An interface for exposing properties of classes to an agent.
+ * @alpha
+ */
+export interface ExposedProperties {
+    /**
+     * Expose a property with type factory type and metadata.
+     */
+    exposeProperty<S extends Ctor, K extends string>(constructor: S, name: K, def: {
+        schema: TypeFactoryType;
+        description?: string;
+        readOnly?: boolean;
+    }): void;
+    /**
+     * Expose a property with type factory type (simple form).
+     */
+    exposeProperty<S extends Ctor, K extends string>(constructor: S, name: K, tfType: TypeFactoryType): void;
+}
+/**
+ * An interface that classes should implement to expose their properties to the LLM.
+ *
+ * @remarks
+ * The `getExposedProperties` free function will cause the method here to be called on the class passed to it.
+ *
+ * @privateremarks
+ * Implementing this interface correctly seems tricky?
+ * To actually implement it in a way that satisfies TypeScript,
+ * classes need to declare both a static version and an instance version of the method
+ * (the instance one can just delegate to the static one).
+ *
+ * @alpha
+ */
+export interface IExposedProperties {
+    /**
+     * Static method that exposes properties of this class to an agent.
+     */
+    [exposePropertiesSymbol]?(properties: ExposedProperties): void;
+}
+//# sourceMappingURL=propertyBinding.d.ts.map

package/dist/propertyBinding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyBinding.d.ts","sourceRoot":"","sources":["../src/propertyBinding.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,OAAO,MAE3C,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,MAAM,EAC9C,WAAW,EAAE,CAAC,EACd,IAAI,EAAE,CAAC,EACP,GAAG,EAAE;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GACxE,IAAI,CAAC;IAER;;OAEG;IACH,cAAc,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,MAAM,EAC9C,WAAW,EAAE,CAAC,EACd,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,eAAe,GACrB,IAAI,CAAC;CACR;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,CAAC,sBAAsB,CAAC,CAAC,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/D"}

package/dist/propertyBinding.js

@@ -0,0 +1,13 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exposePropertiesSymbol = void 0;
+/**
+ * A symbol used to expose properties to the LLM.
+ * @alpha
+ */
+exports.exposePropertiesSymbol = Symbol("Type factory expose property/symbol");
+//# sourceMappingURL=propertyBinding.js.map

package/dist/propertyBinding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyBinding.js","sourceRoot":"","sources":["../src/propertyBinding.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH;;;GAGG;AACU,QAAA,sBAAsB,GAAkB,MAAM,CAC1D,qCAAqC,CACrC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport type { Ctor } from \"./methodBinding.js\";\nimport type { TypeFactoryType } from \"./treeAgentTypes.js\";\n\n/**\n * A symbol used to expose properties to the LLM.\n * @alpha\n */\nexport const exposePropertiesSymbol: unique symbol = Symbol(\n\t\"Type factory expose property/symbol\",\n);\n\n/**\n * An interface for exposing properties of classes to an agent.\n * @alpha\n */\nexport interface ExposedProperties {\n\t/**\n\t * Expose a property with type factory type and metadata.\n\t */\n\texposeProperty<S extends Ctor, K extends string>(\n\t\tconstructor: S,\n\t\tname: K,\n\t\tdef: { schema: TypeFactoryType; description?: string; readOnly?: boolean },\n\t): void;\n\n\t/**\n\t * Expose a property with type factory type (simple form).\n\t */\n\texposeProperty<S extends Ctor, K extends string>(\n\t\tconstructor: S,\n\t\tname: K,\n\t\ttfType: TypeFactoryType,\n\t): void;\n}\n\n/**\n * An interface that classes should implement to expose their properties to the LLM.\n *\n * @remarks\n * The `getExposedProperties` free function will cause the method here to be called on the class passed to it.\n *\n * @privateremarks\n * Implementing this interface correctly seems tricky?\n * To actually implement it in a way that satisfies TypeScript,\n * classes need to declare both a static version and an instance version of the method\n * (the instance one can just delegate to the static one).\n *\n * @alpha\n */\nexport interface IExposedProperties {\n\t/**\n\t * Static method that exposes properties of this class to an agent.\n\t */\n\t[exposePropertiesSymbol]?(properties: ExposedProperties): void;\n}\n"]}

package/dist/public.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/*
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+ * Generated by "flub generate entrypoints --resolutionConditions require --outFileLegacyBeta legacy --outDir ./dist" in @fluid-tools/build-cli.
+ */
+
+/**
+ * Shared types for exposing schema methods and properties to an LLM agent.
+ *
+ * @packageDocumentation
+ */export {}
+

package/dist/treeAgentTypes.d.ts

@@ -0,0 +1,428 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Type kinds for the type factory type system.
+ * @alpha
+ */
+export type TypeFactoryTypeKind = "string" | "number" | "boolean" | "void" | "undefined" | "null" | "unknown" | "date" | "promise" | "array" | "object" | "record" | "map" | "tuple" | "union" | "intersection" | "literal" | "optional" | "readonly" | "function" | "instanceof";
+/**
+ * Base interface for type factory types.
+ * @alpha
+ */
+export interface TypeFactoryType {
+    /**
+     * The kind of type this represents.
+     */
+    readonly _kind: TypeFactoryTypeKind;
+}
+/**
+ * Type guard to check if a value is a type factory type.
+ * @alpha
+ */
+export declare function isTypeFactoryType(value: unknown): value is TypeFactoryType;
+/**
+ * Represents a string type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryString extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "string";
+}
+/**
+ * Represents a number type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryNumber extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "number";
+}
+/**
+ * Represents a boolean type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryBoolean extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "boolean";
+}
+/**
+ * Represents a Date type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryDate extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "date";
+}
+/**
+ * Represents a void type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryVoid extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "void";
+}
+/**
+ * Represents an undefined type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryUndefined extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "undefined";
+}
+/**
+ * Represents a null type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryNull extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "null";
+}
+/**
+ * Represents an unknown type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryUnknown extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "unknown";
+}
+/**
+ * Represents an array type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryArray extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "array";
+    /**
+     * The type of elements in the array.
+     */
+    readonly element: TypeFactoryType;
+}
+/**
+ * Represents a Promise type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryPromise extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "promise";
+    /**
+     * The type that the Promise resolves to.
+     */
+    readonly innerType: TypeFactoryType;
+}
+/**
+ * Represents an object type with a fixed shape in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryObject extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "object";
+    /**
+     * The shape of the object, mapping property names to their types.
+     */
+    readonly shape: Record<string, TypeFactoryType>;
+}
+/**
+ * Represents a record type (index signature) in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryRecord extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "record";
+    /**
+     * The type of the record's keys.
+     */
+    readonly keyType: TypeFactoryType;
+    /**
+     * The type of the record's values.
+     */
+    readonly valueType: TypeFactoryType;
+}
+/**
+ * Represents a Map type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryMap extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "map";
+    /**
+     * The type of the map's keys.
+     */
+    readonly keyType: TypeFactoryType;
+    /**
+     * The type of the map's values.
+     */
+    readonly valueType: TypeFactoryType;
+}
+/**
+ * Represents a tuple type with fixed-length items and optional rest elements in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryTuple extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "tuple";
+    /**
+     * The fixed-length items in the tuple.
+     */
+    readonly items: readonly TypeFactoryType[];
+    /**
+     * Optional rest element type for variable-length tuples.
+     */
+    readonly rest?: TypeFactoryType;
+}
+/**
+ * Represents a union type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryUnion extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "union";
+    /**
+     * The possible types in the union.
+     */
+    readonly options: readonly TypeFactoryType[];
+}
+/**
+ * Represents an intersection type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryIntersection extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "intersection";
+    /**
+     * The types to intersect.
+     */
+    readonly types: readonly TypeFactoryType[];
+}
+/**
+ * Represents a literal type (specific string, number, or boolean value) in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryLiteral extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "literal";
+    /**
+     * The specific literal value.
+     */
+    readonly value: string | number | boolean;
+}
+/**
+ * Represents an optional type modifier in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryOptional extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "optional";
+    /**
+     * The inner type that is optional.
+     */
+    readonly innerType: TypeFactoryType;
+}
+/**
+ * Represents a readonly type modifier in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryReadonly extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "readonly";
+    /**
+     * The inner type that is readonly.
+     */
+    readonly innerType: TypeFactoryType;
+}
+/**
+ * Represents a function parameter as a tuple of [name, type].
+ * @alpha
+ */
+export type TypeFactoryFunctionParameter = readonly [name: string, type: TypeFactoryType];
+/**
+ * Represents a function type in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryFunction extends TypeFactoryType {
+    /**
+     * {@inheritDoc TypeFactoryType._kind}
+     */
+    readonly _kind: "function";
+    /**
+     * The function parameters.
+     */
+    readonly parameters: readonly TypeFactoryFunctionParameter[];
+    /**
+     * The function return type.
+     */
+    readonly returnType: TypeFactoryType;
+    /**
+     * Optional rest parameter for variable-length argument lists.
+     */
+    readonly restParameter?: TypeFactoryFunctionParameter;
+}
+/**
+ * Represents an instanceof type that references a class in the type factory system.
+ * @alpha
+ */
+export interface TypeFactoryInstanceOf extends TypeFactoryType {
+    /**
+     * The kind of type this represents.
+     */
+    readonly _kind: "instanceof";
+    /**
+     * The constructor to reference.
+     */
+    readonly constructor: new (...args: any[]) => unknown;
+}
+/**
+ * Namespace containing type factory functions for building type definitions
+ * that describe method signatures and property types to an LLM agent.
+ *
+ * @internal
+ */
+export declare const typeFactory: {
+    /**
+     * Create a string type.
+     * @alpha
+     */
+    string(): TypeFactoryString;
+    /**
+     * Create a number type.
+     * @alpha
+     */
+    number(): TypeFactoryNumber;
+    /**
+     * Create a boolean type.
+     * @alpha
+     */
+    boolean(): TypeFactoryBoolean;
+    /**
+     * Create a Date type.
+     * @alpha
+     */
+    date(): TypeFactoryDate;
+    /**
+     * Create a void type.
+     * @alpha
+     */
+    void(): TypeFactoryVoid;
+    /**
+     * Create an undefined type.
+     * @alpha
+     */
+    undefined(): TypeFactoryUndefined;
+    /**
+     * Create a null type.
+     * @alpha
+     */
+    null(): TypeFactoryNull;
+    /**
+     * Create an unknown type.
+     * @alpha
+     */
+    unknown(): TypeFactoryUnknown;
+    /**
+     * Create an array type.
+     * @alpha
+     */
+    array(element: TypeFactoryType): TypeFactoryArray;
+    /**
+     * Create a Promise type.
+     * @alpha
+     */
+    promise(innerType: TypeFactoryType): TypeFactoryPromise;
+    /**
+     * Create an object type.
+     * @alpha
+     */
+    object(shape: Record<string, TypeFactoryType>): TypeFactoryObject;
+    /**
+     * Create a record type.
+     * @alpha
+     */
+    record(keyType: TypeFactoryType, valueType: TypeFactoryType): TypeFactoryRecord;
+    /**
+     * Create a map type.
+     * @alpha
+     */
+    map(keyType: TypeFactoryType, valueType: TypeFactoryType): TypeFactoryMap;
+    /**
+     * Create a tuple type.
+     * @alpha
+     */
+    tuple(items: readonly TypeFactoryType[], rest?: TypeFactoryType): TypeFactoryTuple;
+    /**
+     * Create a union type.
+     * @alpha
+     */
+    union(options: readonly TypeFactoryType[]): TypeFactoryUnion;
+    /**
+     * Create an intersection type.
+     * @alpha
+     */
+    intersection(types: readonly TypeFactoryType[]): TypeFactoryIntersection;
+    /**
+     * Create a literal type.
+     * @alpha
+     */
+    literal(value: string | number | boolean): TypeFactoryLiteral;
+    /**
+     * Create an optional type.
+     * @alpha
+     */
+    optional(innerType: TypeFactoryType): TypeFactoryOptional;
+    /**
+     * Create a readonly type.
+     * @alpha
+     */
+    readonly(innerType: TypeFactoryType): TypeFactoryReadonly;
+    /**
+     * Create a function type.
+     * @alpha
+     */
+    function(parameters: readonly TypeFactoryFunctionParameter[], returnType: TypeFactoryType, restParameter?: TypeFactoryFunctionParameter): TypeFactoryFunction;
+    /**
+     * Create an instanceOf type for a class.
+     * @remarks
+     * This is an untyped version. `@fluidframework/tree-agent` re-exports a
+     * narrower override that constrains the constructor to `ObjectNodeSchema`.
+     * @internal
+     */
+    instanceOf(constructor: new (...args: any[]) => unknown): TypeFactoryInstanceOf;
+};
+//# sourceMappingURL=treeAgentTypes.d.ts.map

package/dist/treeAgentTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeAgentTypes.d.ts","sourceRoot":"","sources":["../src/treeAgentTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC5B,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,GACN,SAAS,GACT,MAAM,GACN,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,OAAO,GACP,OAAO,GACP,cAAc,GACd,SAAS,GACT,UAAU,GACV,UAAU,GACV,UAAU,GACV,YAAY,CAAC;AAEhB;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,mBAAmB,CAAC;CACpC;AA8BD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAM1E;AAID;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACvD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACvD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC5D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACvD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC1B;AAID;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACxD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,eAAe;IACtD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACxD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACxD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,eAAe,EAAE,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC/D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IAC1D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC3D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC3D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC3D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,4BAA4B,EAAE,CAAC;IAC7D;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,4BAA4B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC7D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B;;OAEG;IAEH,QAAQ,CAAC,WAAW,EAAE,KACrB,GAAG,IAAI,EAAE,GAAG,EAAE,KACV,OAAO,CAAC;CACb;AAED;;;;;GAKG;AACH,eAAO,MAAM,WAAW;IACvB;;;OAGG;cACO,iBAAiB;IAI3B;;;OAGG;cACO,iBAAiB;IAI3B;;;OAGG;eACQ,kBAAkB;IAI7B;;;OAGG;YACK,eAAe;IAIvB;;;OAGG;YACK,eAAe;IAIvB;;;OAGG;iBACU,oBAAoB;IAIjC;;;OAGG;YACK,eAAe;IAIvB;;;OAGG;eACQ,kBAAkB;IAI7B;;;OAGG;mBACY,eAAe,GAAG,gBAAgB;IAIjD;;;OAGG;uBACgB,eAAe,GAAG,kBAAkB;IAIvD;;;OAGG;kBACW,OAAO,MAAM,EAAE,eAAe,CAAC,GAAG,iBAAiB;IAIjE;;;OAGG;oBACa,eAAe,aAAa,eAAe,GAAG,iBAAiB;IAI/E;;;OAGG;iBACU,eAAe,aAAa,eAAe,GAAG,cAAc;IAIzE;;;OAGG;iBACU,SAAS,eAAe,EAAE,SAAS,eAAe,GAAG,gBAAgB;IASlF;;;OAGG;mBACY,SAAS,eAAe,EAAE,GAAG,gBAAgB;IAS5D;;;OAGG;wBACiB,SAAS,eAAe,EAAE,GAAG,uBAAuB;IASxE;;;OAGG;mBACY,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,kBAAkB;IAI7D;;;OAGG;wBACiB,eAAe,GAAG,mBAAmB;IAIzD;;;OAGG;wBACiB,eAAe,GAAG,mBAAmB;IAIzD;;;OAGG;yBAEU,SAAS,4BAA4B,EAAE,cACvC,eAAe,kBACX,4BAA4B,GAC1C,mBAAmB;IAMtB;;;;;;OAMG;4BAEqB,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,GAAG,qBAAqB;CAG/E,CAAC"}