ai-functions 2.1.3 → 2.4.0

package/dist/digital-objects-registry.d.ts

@@ -0,0 +1,229 @@
+/**
+ * DigitalObjectsFunctionRegistry - Persistent function registry using digital-objects
+ *
+ * This implementation stores function definitions as Things and function calls as Actions,
+ * providing full persistence and audit trail capabilities.
+ *
+ * Nouns:
+ * - CodeFunction: Functions that generate executable code
+ * - GenerativeFunction: Functions that use AI to generate content
+ * - AgenticFunction: Functions that run in a loop with tools
+ * - HumanFunction: Functions that require human input/approval
+ *
+ * Verbs:
+ * - define: Function definition action
+ * - call: Function invocation action
+ * - complete: Successful completion action
+ * - fail: Failed execution action
+ *
+ * @packageDocumentation
+ */
+import type { DigitalObjectsProvider, Thing, Action } from 'digital-objects';
+import type { FunctionRegistry, DefinedFunction } from './types.js';
+/**
+ * Noun names for function types
+ */
+export declare const FUNCTION_NOUNS: {
+    readonly CODE: "CodeFunction";
+    readonly GENERATIVE: "GenerativeFunction";
+    readonly AGENTIC: "AgenticFunction";
+    readonly HUMAN: "HumanFunction";
+};
+/**
+ * Verb names for function actions
+ */
+export declare const FUNCTION_VERBS: {
+    readonly DEFINE: "define";
+    readonly CALL: "call";
+    readonly COMPLETE: "complete";
+    readonly FAIL: "fail";
+};
+/**
+ * Stored function definition shape
+ */
+export interface StoredFunctionDefinition {
+    name: string;
+    type: 'code' | 'generative' | 'agentic' | 'human';
+    description?: string;
+    args: unknown;
+    returnType?: unknown;
+    /** Inline deterministic code body for a `code` function (handlers are not persistable). */
+    code?: string;
+    language?: string;
+    instructions?: string;
+    /** @deprecated Legacy code-authoring fields; retained only for back-compat reads. */
+    includeTests?: boolean;
+    /** @deprecated Legacy code-authoring fields; retained only for back-compat reads. */
+    includeExamples?: boolean;
+    output?: string;
+    system?: string;
+    promptTemplate?: string;
+    model?: string;
+    temperature?: number;
+    tools?: unknown[];
+    maxIterations?: number;
+    stream?: boolean;
+    channel?: string;
+    timeout?: number;
+    assignee?: string;
+}
+/**
+ * Function call data stored in actions
+ */
+export interface FunctionCallData {
+    args: unknown;
+    result?: unknown;
+    error?: string;
+    duration?: number;
+}
+/**
+ * Options for creating a DigitalObjectsFunctionRegistry
+ */
+export interface DigitalObjectsRegistryOptions {
+    /** The digital-objects provider to use for storage */
+    provider: DigitalObjectsProvider;
+    /** Whether to auto-initialize nouns and verbs (default: true) */
+    autoInitialize?: boolean;
+}
+/**
+ * DigitalObjectsFunctionRegistry - Persistent function registry using digital-objects
+ *
+ * This class implements the FunctionRegistry interface using digital-objects for storage.
+ * Function definitions are stored as Things, and function calls are tracked as Actions.
+ *
+ * @example
+ * ```ts
+ * import { createMemoryProvider } from 'digital-objects'
+ * import { createDigitalObjectsRegistry, defineFunction } from 'ai-functions'
+ *
+ * const provider = createMemoryProvider()
+ * const registry = await createDigitalObjectsRegistry({ provider })
+ *
+ * // Define a function
+ * const summarize = defineFunction({
+ *   type: 'generative',
+ *   name: 'summarize',
+ *   args: { text: 'Text to summarize' },
+ *   output: 'string',
+ * })
+ *
+ * // Store it in the registry
+ * registry.set('summarize', summarize)
+ *
+ * // Later, retrieve it
+ * const fn = registry.get('summarize')
+ * if (fn) {
+ *   const result = await fn.call({ text: 'Long article...' })
+ * }
+ * ```
+ */
+export declare class DigitalObjectsFunctionRegistry implements FunctionRegistry {
+    private provider;
+    private initialized;
+    private autoInitialize;
+    private initPromise;
+    private functionCache;
+    constructor(options: DigitalObjectsRegistryOptions);
+    /**
+     * Initialize the registry by defining all necessary nouns and verbs
+     */
+    initialize(): Promise<void>;
+    private _initialize;
+    /**
+     * Ensure the registry is initialized before operations
+     */
+    private ensureInitialized;
+    /**
+     * Get a function by name
+     */
+    get(name: string): DefinedFunction | undefined;
+    /**
+     * Get a function by name (async version for loading from storage)
+     */
+    getAsync(name: string): Promise<DefinedFunction | undefined>;
+    /**
+     * Store a function definition
+     */
+    set(name: string, fn: DefinedFunction): void;
+    /**
+     * Store a function definition (async version)
+     */
+    setAsync(name: string, fn: DefinedFunction): Promise<Thing<StoredFunctionDefinition>>;
+    /**
+     * Check if a function exists
+     */
+    has(name: string): boolean;
+    /**
+     * Check if a function exists (async version that also checks storage)
+     */
+    hasAsync(name: string): Promise<boolean>;
+    /**
+     * List all function names
+     */
+    list(): string[];
+    /**
+     * List all function names (async version that includes storage)
+     */
+    listAsync(): Promise<string[]>;
+    /**
+     * Delete a function
+     */
+    delete(name: string): boolean;
+    /**
+     * Delete a function (async version)
+     */
+    deleteAsync(name: string): Promise<boolean>;
+    /**
+     * Clear all functions
+     */
+    clear(): void;
+    /**
+     * Clear all functions (async version)
+     */
+    clearAsync(): Promise<void>;
+    /**
+     * Record a function call as an Action
+     */
+    trackCall(functionName: string, args: unknown): Promise<Action<FunctionCallData>>;
+    /**
+     * Record a successful function completion
+     */
+    trackCompletion(callActionId: string, result: unknown, duration?: number): Promise<Action<FunctionCallData>>;
+    /**
+     * Record a function failure
+     */
+    trackFailure(callActionId: string, error: string, duration?: number): Promise<Action<FunctionCallData>>;
+    /**
+     * Get call history for a function
+     */
+    getCallHistory(functionName: string): Promise<Action<FunctionCallData>[]>;
+    /**
+     * Get all recent function calls
+     */
+    getRecentCalls(limit?: number): Promise<Action<FunctionCallData>[]>;
+    /**
+     * Get the underlying provider for advanced operations
+     */
+    getProvider(): DigitalObjectsProvider;
+}
+/**
+ * Create a DigitalObjectsFunctionRegistry
+ *
+ * @param options - Configuration options including the provider
+ * @returns An initialized DigitalObjectsFunctionRegistry
+ *
+ * @example
+ * ```ts
+ * import { createMemoryProvider } from 'digital-objects'
+ * import { createDigitalObjectsRegistry } from 'ai-functions'
+ *
+ * const provider = createMemoryProvider()
+ * const registry = await createDigitalObjectsRegistry({ provider })
+ *
+ * // Use the registry
+ * registry.set('myFunc', definedFunction)
+ * const fn = registry.get('myFunc')
+ * ```
+ */
+export declare function createDigitalObjectsRegistry(options: DigitalObjectsRegistryOptions): Promise<DigitalObjectsFunctionRegistry>;
+//# sourceMappingURL=digital-objects-registry.d.ts.map

package/dist/digital-objects-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"digital-objects-registry.d.ts","sourceRoot":"","sources":["../src/digital-objects-registry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAE5E,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAMhB,MAAM,YAAY,CAAA;AAGnB;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;CAKjB,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;CAKjB,CAAA;AAEV;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;IACjD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB,2FAA2F;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qFAAqF;IACrF,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,qFAAqF;IACrF,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,sDAAsD;IACtD,QAAQ,EAAE,sBAAsB,CAAA;IAChC,iEAAiE;IACjE,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AA8JD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,8BAA+B,YAAW,gBAAgB;IACrE,OAAO,CAAC,QAAQ,CAAwB;IACxC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,WAAW,CAA6B;IAGhD,OAAO,CAAC,aAAa,CAAqC;gBAE9C,OAAO,EAAE,6BAA6B;IAKlD;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;YASnB,WAAW;IAmEzB;;OAEG;YACW,iBAAiB;IAM/B;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAK9C;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAsClE;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,GAAG,IAAI;IAU5C;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAkC3F;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAc9C;;OAEG;IACH,IAAI,IAAI,MAAM,EAAE;IAIhB;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAgBpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAY7B;;OAEG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBjD;;OAEG;IACH,KAAK,IAAI,IAAI;IASb;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBjC;;OAEG;IACG,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAwBvF;;OAEG;IACG,eAAe,CACnB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,OAAO,EACf,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAapC;;OAEG;IACG,YAAY,CAChB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAapC;;OAEG;IACG,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAoB/E;;OAEG;IACG,cAAc,CAAC,KAAK,SAAK,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;IASrE;;OAEG;IACH,WAAW,IAAI,sBAAsB;CAGtC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,8BAA8B,CAAC,CAMzC"}