@elizaos/api-client 1.4.4 → 1.5.0

package/dist/core/src/types/message.d.ts

@@ -0,0 +1,202 @@
+import { Service } from './service';
+import type { UUID } from './primitives';
+export interface MessageParticipant {
+    id: UUID;
+    name: string;
+    username?: string;
+    avatar?: string;
+    status?: 'online' | 'offline' | 'away' | 'busy';
+}
+export interface MessageAttachment {
+    id: UUID;
+    filename: string;
+    url: string;
+    mimeType: string;
+    size: number;
+    width?: number;
+    height?: number;
+    duration?: number;
+    thumbnail?: string;
+}
+export interface MessageReaction {
+    emoji: string;
+    count: number;
+    users: UUID[];
+    hasReacted: boolean;
+}
+export interface MessageReference {
+    messageId: UUID;
+    channelId: UUID;
+    type: 'reply' | 'forward' | 'quote';
+}
+export interface MessageContent {
+    text?: string;
+    html?: string;
+    markdown?: string;
+    attachments?: MessageAttachment[];
+    reactions?: MessageReaction[];
+    reference?: MessageReference;
+    mentions?: UUID[];
+    embeds?: Array<{
+        title?: string;
+        description?: string;
+        url?: string;
+        image?: string;
+        fields?: Array<{
+            name: string;
+            value: string;
+            inline?: boolean;
+        }>;
+    }>;
+}
+export interface MessageInfo {
+    id: UUID;
+    channelId: UUID;
+    senderId: UUID;
+    content: MessageContent;
+    timestamp: Date;
+    edited?: Date;
+    deleted?: Date;
+    pinned?: boolean;
+    thread?: {
+        id: UUID;
+        messageCount: number;
+        participants: UUID[];
+        lastMessageAt: Date;
+    };
+}
+export interface MessageSendOptions {
+    replyTo?: UUID;
+    ephemeral?: boolean;
+    silent?: boolean;
+    scheduled?: Date;
+    thread?: UUID;
+    nonce?: string;
+}
+export interface MessageSearchOptions {
+    query?: string;
+    channelId?: UUID;
+    senderId?: UUID;
+    before?: Date;
+    after?: Date;
+    limit?: number;
+    offset?: number;
+    hasAttachments?: boolean;
+    pinned?: boolean;
+    mentions?: UUID;
+}
+export interface MessageChannel {
+    id: UUID;
+    name: string;
+    type: 'text' | 'voice' | 'dm' | 'group' | 'announcement' | 'thread';
+    description?: string;
+    participants?: MessageParticipant[];
+    permissions?: {
+        canSend: boolean;
+        canRead: boolean;
+        canDelete: boolean;
+        canPin: boolean;
+        canManage: boolean;
+    };
+    lastMessageAt?: Date;
+    messageCount?: number;
+    unreadCount?: number;
+}
+/**
+ * Interface for messaging services
+ */
+export declare abstract class IMessageService extends Service {
+    static readonly serviceType: "message";
+    readonly capabilityDescription = "Message sending, receiving, and management capabilities";
+    /**
+     * Send a message to a channel
+     * @param channelId - Channel ID
+     * @param content - Message content
+     * @param options - Send options
+     * @returns Promise resolving to message ID
+     */
+    abstract sendMessage(channelId: UUID, content: MessageContent, options?: MessageSendOptions): Promise<UUID>;
+    /**
+     * Get messages from a channel
+     * @param channelId - Channel ID
+     * @param options - Search options
+     * @returns Promise resolving to array of messages
+     */
+    abstract getMessages(channelId: UUID, options?: MessageSearchOptions): Promise<MessageInfo[]>;
+    /**
+     * Get a specific message by ID
+     * @param messageId - Message ID
+     * @returns Promise resolving to message
+     */
+    abstract getMessage(messageId: UUID): Promise<MessageInfo>;
+    /**
+     * Edit a message
+     * @param messageId - Message ID
+     * @param content - New message content
+     * @returns Promise resolving when edit completes
+     */
+    abstract editMessage(messageId: UUID, content: MessageContent): Promise<void>;
+    /**
+     * Delete a message
+     * @param messageId - Message ID
+     * @returns Promise resolving when deletion completes
+     */
+    abstract deleteMessage(messageId: UUID): Promise<void>;
+    /**
+     * Add a reaction to a message
+     * @param messageId - Message ID
+     * @param emoji - Reaction emoji
+     * @returns Promise resolving when reaction is added
+     */
+    abstract addReaction(messageId: UUID, emoji: string): Promise<void>;
+    /**
+     * Remove a reaction from a message
+     * @param messageId - Message ID
+     * @param emoji - Reaction emoji
+     * @returns Promise resolving when reaction is removed
+     */
+    abstract removeReaction(messageId: UUID, emoji: string): Promise<void>;
+    /**
+     * Pin a message
+     * @param messageId - Message ID
+     * @returns Promise resolving when message is pinned
+     */
+    abstract pinMessage(messageId: UUID): Promise<void>;
+    /**
+     * Unpin a message
+     * @param messageId - Message ID
+     * @returns Promise resolving when message is unpinned
+     */
+    abstract unpinMessage(messageId: UUID): Promise<void>;
+    /**
+     * Get available channels
+     * @returns Promise resolving to array of channels
+     */
+    abstract getChannels(): Promise<MessageChannel[]>;
+    /**
+     * Get channel information
+     * @param channelId - Channel ID
+     * @returns Promise resolving to channel info
+     */
+    abstract getChannel(channelId: UUID): Promise<MessageChannel>;
+    /**
+     * Create a new channel
+     * @param name - Channel name
+     * @param type - Channel type
+     * @param options - Channel options
+     * @returns Promise resolving to new channel ID
+     */
+    abstract createChannel(name: string, type: MessageChannel['type'], options?: {
+        description?: string;
+        participants?: UUID[];
+        private?: boolean;
+    }): Promise<UUID>;
+    /**
+     * Search messages across channels
+     * @param query - Search query
+     * @param options - Search options
+     * @returns Promise resolving to search results
+     */
+    abstract searchMessages(query: string, options?: MessageSearchOptions): Promise<MessageInfo[]>;
+}
+//# sourceMappingURL=message.d.ts.map

package/dist/core/src/types/message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;CACjD;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,IAAI,CAAC;IACT,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAClC,SAAS,CAAC,EAAE,eAAe,EAAE,CAAC;IAC9B,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,CAAC,EAAE,OAAO,CAAC;SAClB,CAAC,CAAC;KACJ,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,IAAI,CAAC;IACT,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,EAAE,cAAc,CAAC;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE;QACP,EAAE,EAAE,IAAI,CAAC;QACT,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,IAAI,EAAE,CAAC;QACrB,aAAa,EAAE,IAAI,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,GAAG,cAAc,GAAG,QAAQ,CAAC;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACpC,WAAW,CAAC,EAAE;QACZ,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,OAAO,CAAC;QACnB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IACF,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,8BAAsB,eAAgB,SAAQ,OAAO;IACnD,gBAAyB,WAAW,YAAuB;IAE3D,SAAgB,qBAAqB,6DAA6D;IAElG;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAClB,SAAS,EAAE,IAAI,EACf,OAAO,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAE7F;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IAE1D;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7E;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnD;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAErD;;;OAGG;IACH,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAEjD;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,GAAG,OAAO,CAAC,cAAc,CAAC;IAE7D;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CACpB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,EAC5B,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC;QACtB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GACA,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAC/F"}

package/dist/core/src/types/messaging.d.ts

@@ -0,0 +1,45 @@
+import type { Content, UUID } from './primitives';
+import type { IAgentRuntime } from './runtime';
+/**
+ * Information describing the target of a message.
+ */
+export interface TargetInfo {
+    source: string;
+    roomId?: UUID;
+    channelId?: string;
+    serverId?: string;
+    entityId?: UUID;
+    threadId?: string;
+}
+/**
+ * Function signature for handlers responsible for sending messages to specific platforms.
+ */
+export type SendHandlerFunction = (runtime: IAgentRuntime, target: TargetInfo, content: Content) => Promise<void>;
+export declare enum SOCKET_MESSAGE_TYPE {
+    ROOM_JOINING = 1,
+    SEND_MESSAGE = 2,
+    MESSAGE = 3,
+    ACK = 4,
+    THINKING = 5,
+    CONTROL = 6
+}
+/**
+ * Interface for control messages sent from the backend to the frontend
+ * to manage UI state and interaction capabilities
+ */
+export interface ControlMessage {
+    /** Message type identifier */
+    type: 'control';
+    /** Control message payload */
+    payload: {
+        /** Action to perform */
+        action: 'disable_input' | 'enable_input';
+        /** Optional target element identifier */
+        target?: string;
+        /** Additional optional parameters */
+        [key: string]: unknown;
+    };
+    /** Room ID to ensure signal is directed to the correct chat window */
+    roomId: UUID;
+}
+//# sourceMappingURL=messaging.d.ts.map

package/dist/core/src/types/messaging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messaging.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/messaging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAEnB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,oBAAY,mBAAmB;IAC7B,YAAY,IAAI;IAChB,YAAY,IAAI;IAChB,OAAO,IAAI;IACX,GAAG,IAAI;IACP,QAAQ,IAAI;IACZ,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,8BAA8B;IAC9B,IAAI,EAAE,SAAS,CAAC;IAEhB,8BAA8B;IAC9B,OAAO,EAAE;QACP,wBAAwB;QACxB,MAAM,EAAE,eAAe,GAAG,cAAc,CAAC;QAEzC,yCAAyC;QACzC,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,qCAAqC;QACrC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IAEF,sEAAsE;IACtE,MAAM,EAAE,IAAI,CAAC;CACd"}

package/dist/core/src/types/model.d.ts

@@ -0,0 +1,319 @@
+import type { IAgentRuntime } from './runtime';
+export type ModelTypeName = (typeof ModelType)[keyof typeof ModelType] | string;
+/**
+ * Defines the recognized types of models that the agent runtime can use.
+ * These include models for text generation (small, large, reasoning, completion),
+ * text embedding, tokenization (encode/decode), image generation and description,
+ * audio transcription, text-to-speech, and generic object generation.
+ * This constant is used throughout the system, particularly in `AgentRuntime.useModel`,
+ * `AgentRuntime.registerModel`, and in `ModelParamsMap` / `ModelResultMap` to ensure
+ * type safety and clarity when working with different AI models.
+ * String values are used for extensibility with custom model types.
+ */
+export declare const ModelType: {
+    readonly SMALL: "TEXT_SMALL";
+    readonly MEDIUM: "TEXT_LARGE";
+    readonly LARGE: "TEXT_LARGE";
+    readonly TEXT_SMALL: "TEXT_SMALL";
+    readonly TEXT_LARGE: "TEXT_LARGE";
+    readonly TEXT_EMBEDDING: "TEXT_EMBEDDING";
+    readonly TEXT_TOKENIZER_ENCODE: "TEXT_TOKENIZER_ENCODE";
+    readonly TEXT_TOKENIZER_DECODE: "TEXT_TOKENIZER_DECODE";
+    readonly TEXT_REASONING_SMALL: "REASONING_SMALL";
+    readonly TEXT_REASONING_LARGE: "REASONING_LARGE";
+    readonly TEXT_COMPLETION: "TEXT_COMPLETION";
+    readonly IMAGE: "IMAGE";
+    readonly IMAGE_DESCRIPTION: "IMAGE_DESCRIPTION";
+    readonly TRANSCRIPTION: "TRANSCRIPTION";
+    readonly TEXT_TO_SPEECH: "TEXT_TO_SPEECH";
+    readonly AUDIO: "AUDIO";
+    readonly VIDEO: "VIDEO";
+    readonly OBJECT_SMALL: "OBJECT_SMALL";
+    readonly OBJECT_LARGE: "OBJECT_LARGE";
+};
+/**
+ * Model configuration setting keys used in character settings.
+ * These constants define the keys for accessing model parameters
+ * from character configuration with support for per-model-type settings.
+ *
+ * Setting Precedence (highest to lowest):
+ * 1. Parameters passed directly to useModel()
+ * 2. Model-specific settings (e.g., TEXT_SMALL_TEMPERATURE)
+ * 3. Default settings (e.g., DEFAULT_TEMPERATURE)
+ *
+ * Example character settings:
+ * ```
+ * settings: {
+ *   DEFAULT_TEMPERATURE: 0.7,              // Applies to all models
+ *   TEXT_SMALL_TEMPERATURE: 0.5,           // Overrides default for TEXT_SMALL
+ *   TEXT_LARGE_MAX_TOKENS: 4096,           // Specific to TEXT_LARGE
+ *   OBJECT_SMALL_TEMPERATURE: 0.3,         // Specific to OBJECT_SMALL
+ * }
+ * ```
+ */
+export declare const MODEL_SETTINGS: {
+    readonly DEFAULT_MAX_TOKENS: "DEFAULT_MAX_TOKENS";
+    readonly DEFAULT_TEMPERATURE: "DEFAULT_TEMPERATURE";
+    readonly DEFAULT_FREQUENCY_PENALTY: "DEFAULT_FREQUENCY_PENALTY";
+    readonly DEFAULT_PRESENCE_PENALTY: "DEFAULT_PRESENCE_PENALTY";
+    readonly TEXT_SMALL_MAX_TOKENS: "TEXT_SMALL_MAX_TOKENS";
+    readonly TEXT_SMALL_TEMPERATURE: "TEXT_SMALL_TEMPERATURE";
+    readonly TEXT_SMALL_FREQUENCY_PENALTY: "TEXT_SMALL_FREQUENCY_PENALTY";
+    readonly TEXT_SMALL_PRESENCE_PENALTY: "TEXT_SMALL_PRESENCE_PENALTY";
+    readonly TEXT_LARGE_MAX_TOKENS: "TEXT_LARGE_MAX_TOKENS";
+    readonly TEXT_LARGE_TEMPERATURE: "TEXT_LARGE_TEMPERATURE";
+    readonly TEXT_LARGE_FREQUENCY_PENALTY: "TEXT_LARGE_FREQUENCY_PENALTY";
+    readonly TEXT_LARGE_PRESENCE_PENALTY: "TEXT_LARGE_PRESENCE_PENALTY";
+    readonly OBJECT_SMALL_MAX_TOKENS: "OBJECT_SMALL_MAX_TOKENS";
+    readonly OBJECT_SMALL_TEMPERATURE: "OBJECT_SMALL_TEMPERATURE";
+    readonly OBJECT_SMALL_FREQUENCY_PENALTY: "OBJECT_SMALL_FREQUENCY_PENALTY";
+    readonly OBJECT_SMALL_PRESENCE_PENALTY: "OBJECT_SMALL_PRESENCE_PENALTY";
+    readonly OBJECT_LARGE_MAX_TOKENS: "OBJECT_LARGE_MAX_TOKENS";
+    readonly OBJECT_LARGE_TEMPERATURE: "OBJECT_LARGE_TEMPERATURE";
+    readonly OBJECT_LARGE_FREQUENCY_PENALTY: "OBJECT_LARGE_FREQUENCY_PENALTY";
+    readonly OBJECT_LARGE_PRESENCE_PENALTY: "OBJECT_LARGE_PRESENCE_PENALTY";
+    readonly MODEL_MAX_TOKEN: "MODEL_MAX_TOKEN";
+    readonly MODEL_TEMPERATURE: "MODEL_TEMPERATURE";
+    readonly MODEL_FREQ_PENALTY: "MODEL_FREQ_PENALTY";
+    readonly MODEL_PRESENCE_PENALTY: "MODEL_PRESENCE_PENALTY";
+};
+/**
+ * Helper to get the model-specific setting key for a given model type and parameter.
+ * @param modelType The model type (e.g., TEXT_SMALL, TEXT_LARGE)
+ * @param param The parameter name (e.g., MAX_TOKENS, TEMPERATURE)
+ * @returns The appropriate setting key or null if not a supported model type
+ */
+export declare function getModelSpecificSettingKey(modelType: ModelTypeName, param: 'MAX_TOKENS' | 'TEMPERATURE' | 'FREQUENCY_PENALTY' | 'PRESENCE_PENALTY'): string | null;
+/**
+ * Parameters for generating text using a language model.
+ * This structure is typically passed to `AgentRuntime.useModel` when the `modelType` is one of
+ * `ModelType.TEXT_SMALL`, `ModelType.TEXT_LARGE`, `ModelType.TEXT_REASONING_SMALL`,
+ * `ModelType.TEXT_REASONING_LARGE`, or `ModelType.TEXT_COMPLETION`.
+ * It includes essential information like the prompt, model type, and various generation controls.
+ */
+export type GenerateTextParams = {
+    /** The `AgentRuntime` instance, providing access to models and other services. */
+    runtime: IAgentRuntime;
+    /** The input string or prompt that the language model will use to generate text. */
+    prompt: string;
+    /** Specifies the type of text generation model to use (e.g., TEXT_LARGE, REASONING_SMALL). */
+    modelType: ModelTypeName;
+    /** Optional. The maximum number of tokens to generate in the response. */
+    maxTokens?: number;
+    /** Optional. Controls randomness (0.0-1.0). Lower values are more deterministic, higher are more creative. */
+    temperature?: number;
+    /** Optional. Penalizes new tokens based on their existing frequency in the text so far. */
+    frequencyPenalty?: number;
+    /** Optional. Penalizes new tokens based on whether they appear in the text so far. */
+    presencePenalty?: number;
+    /** Optional. A list of sequences at which the model will stop generating further tokens. */
+    stopSequences?: string[];
+};
+/**
+ * Parameters for detokenizing text, i.e., converting a sequence of numerical tokens back into a string.
+ * This is the reverse operation of tokenization.
+ * This structure is used with `AgentRuntime.useModel` when the `modelType` is `ModelType.TEXT_TOKENIZER_DECODE`.
+ */
+export interface DetokenizeTextParams {
+    /** An array of numerical tokens to be converted back into text. */
+    tokens: number[];
+    /** The model type used for detokenization, ensuring consistency with the original tokenization. */
+    modelType: ModelTypeName;
+}
+/**
+ * Base parameters common to all model types
+ */
+export interface BaseModelParams {
+    /** The agent runtime for accessing services and utilities */
+    runtime: IAgentRuntime;
+}
+/**
+ * Parameters for text generation models
+ */
+export interface TextGenerationParams extends BaseModelParams {
+    /** The prompt to generate text from */
+    prompt: string;
+    /** Model temperature (0.0 to 1.0, lower is more deterministic) */
+    temperature?: number;
+    /** Maximum number of tokens to generate */
+    maxTokens?: number;
+    /** Sequences that should stop generation when encountered */
+    stopSequences?: string[];
+    /** Frequency penalty to apply */
+    frequencyPenalty?: number;
+    /** Presence penalty to apply */
+    presencePenalty?: number;
+}
+/**
+ * Parameters for text embedding models
+ */
+export interface TextEmbeddingParams extends BaseModelParams {
+    /** The text to create embeddings for */
+    text: string;
+}
+/**
+ * Parameters for text tokenization models
+ */
+export interface TokenizeTextParams extends BaseModelParams {
+    /** The text to tokenize */
+    prompt: string;
+    /** The model type to use for tokenization */
+    modelType: ModelTypeName;
+}
+/**
+ * Parameters for image generation models
+ */
+export interface ImageGenerationParams extends BaseModelParams {
+    /** The prompt describing the image to generate */
+    prompt: string;
+    /** The dimensions of the image to generate */
+    size?: string;
+    /** Number of images to generate */
+    count?: number;
+}
+/**
+ * Parameters for image description models
+ */
+export interface ImageDescriptionParams extends BaseModelParams {
+    /** The URL or path of the image to describe */
+    imageUrl: string;
+    /** Optional prompt to guide the description */
+    prompt?: string;
+}
+/**
+ * Parameters for transcription models
+ */
+export interface TranscriptionParams extends BaseModelParams {
+    /** The URL or path of the audio file to transcribe */
+    audioUrl: string;
+    /** Optional prompt to guide transcription */
+    prompt?: string;
+}
+/**
+ * Parameters for text-to-speech models
+ */
+export interface TextToSpeechParams extends BaseModelParams {
+    /** The text to convert to speech */
+    text: string;
+    /** The voice to use */
+    voice?: string;
+    /** The speaking speed */
+    speed?: number;
+}
+/**
+ * Parameters for audio processing models
+ */
+export interface AudioProcessingParams extends BaseModelParams {
+    /** The URL or path of the audio file to process */
+    audioUrl: string;
+    /** The type of audio processing to perform */
+    processingType: string;
+}
+/**
+ * Parameters for video processing models
+ */
+export interface VideoProcessingParams extends BaseModelParams {
+    /** The URL or path of the video file to process */
+    videoUrl: string;
+    /** The type of video processing to perform */
+    processingType: string;
+}
+/**
+ * Optional JSON schema for validating generated objects
+ */
+export type JSONSchema = {
+    type: string;
+    properties?: Record<string, any>;
+    required?: string[];
+    items?: JSONSchema;
+    [key: string]: any;
+};
+/**
+ * Parameters for object generation models
+ * @template T - The expected return type, inferred from schema if provided
+ */
+export interface ObjectGenerationParams extends BaseModelParams {
+    /** The prompt describing the object to generate */
+    prompt: string;
+    /** Optional JSON schema for validation */
+    schema?: JSONSchema;
+    /** Type of object to generate */
+    output?: 'object' | 'array' | 'enum';
+    /** For enum type, the allowed values */
+    enumValues?: string[];
+    /** Model type to use */
+    modelType?: ModelTypeName;
+    /** Model temperature (0.0 to 1.0) */
+    temperature?: number;
+    /** Sequences that should stop generation */
+    stopSequences?: string[];
+}
+/**
+ * Map of model types to their parameter types
+ */
+export interface ModelParamsMap {
+    [ModelType.TEXT_SMALL]: TextGenerationParams;
+    [ModelType.TEXT_LARGE]: TextGenerationParams;
+    [ModelType.TEXT_EMBEDDING]: TextEmbeddingParams | string | null;
+    [ModelType.TEXT_TOKENIZER_ENCODE]: TokenizeTextParams;
+    [ModelType.TEXT_TOKENIZER_DECODE]: DetokenizeTextParams;
+    [ModelType.TEXT_REASONING_SMALL]: TextGenerationParams;
+    [ModelType.TEXT_REASONING_LARGE]: TextGenerationParams;
+    [ModelType.IMAGE]: ImageGenerationParams;
+    [ModelType.IMAGE_DESCRIPTION]: ImageDescriptionParams | string;
+    [ModelType.TRANSCRIPTION]: TranscriptionParams | Buffer | string;
+    [ModelType.TEXT_TO_SPEECH]: TextToSpeechParams | string;
+    [ModelType.AUDIO]: AudioProcessingParams;
+    [ModelType.VIDEO]: VideoProcessingParams;
+    [ModelType.OBJECT_SMALL]: ObjectGenerationParams;
+    [ModelType.OBJECT_LARGE]: ObjectGenerationParams;
+    [key: string]: BaseModelParams | any;
+}
+/**
+ * Map of model types to their return value types
+ */
+export interface ModelResultMap {
+    [ModelType.TEXT_SMALL]: string;
+    [ModelType.TEXT_LARGE]: string;
+    [ModelType.TEXT_EMBEDDING]: number[];
+    [ModelType.TEXT_TOKENIZER_ENCODE]: number[];
+    [ModelType.TEXT_TOKENIZER_DECODE]: string;
+    [ModelType.TEXT_REASONING_SMALL]: string;
+    [ModelType.TEXT_REASONING_LARGE]: string;
+    [ModelType.IMAGE]: {
+        url: string;
+    }[];
+    [ModelType.IMAGE_DESCRIPTION]: {
+        title: string;
+        description: string;
+    };
+    [ModelType.TRANSCRIPTION]: string;
+    [ModelType.TEXT_TO_SPEECH]: any | Buffer;
+    [ModelType.AUDIO]: any;
+    [ModelType.VIDEO]: any;
+    [ModelType.OBJECT_SMALL]: any;
+    [ModelType.OBJECT_LARGE]: any;
+    [key: string]: any;
+}
+/**
+ * Defines the structure for a model handler registration within the `AgentRuntime`.
+ * Each model (e.g., for text generation, embedding) is associated with a handler function,
+ * the name of the provider (plugin or system) that registered it, and an optional priority.
+ * The `priority` (higher is more preferred) helps in selecting which handler to use if multiple
+ * handlers are registered for the same model type. The `registrationOrder` (not in type, but used in runtime)
+ * serves as a tie-breaker. See `AgentRuntime.registerModel` and `AgentRuntime.getModel`.
+ */
+export interface ModelHandler {
+    /** The function that executes the model, taking runtime and parameters, and returning a Promise. */
+    handler: (runtime: IAgentRuntime, params: Record<string, unknown>) => Promise<unknown>;
+    /** The name of the provider (e.g., plugin name) that registered this model handler. */
+    provider: string;
+    /**
+     * Optional priority for this model handler. Higher numbers indicate higher priority.
+     * This is used by `AgentRuntime.getModel` to select the most appropriate handler
+     * when multiple are available for a given model type. Defaults to 0 if not specified.
+     */
+    priority?: number;
+    registrationOrder?: number;
+}
+//# sourceMappingURL=model.d.ts.map

package/dist/core/src/types/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,OAAO,SAAS,CAAC,GAAG,MAAM,CAAC;AAEhF;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;CAoBZ,CAAC;AAEX;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;CAoCjB,CAAC;AAEX;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,aAAa,EACxB,KAAK,EAAE,YAAY,GAAG,aAAa,GAAG,mBAAmB,GAAG,kBAAkB,GAC7E,MAAM,GAAG,IAAI,CAQf;AAED;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,kFAAkF;IAClF,OAAO,EAAE,aAAa,CAAC;IACvB,oFAAoF;IACpF,MAAM,EAAE,MAAM,CAAC;IACf,8FAA8F;IAC9F,SAAS,EAAE,aAAa,CAAC;IACzB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8GAA8G;IAC9G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2FAA2F;IAC3F,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4FAA4F;IAC5F,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mEAAmE;IACnE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mGAAmG;IACnG,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gCAAgC;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,iCAAiC;IACjC,MAAM,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IACrC,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,wBAAwB;IACxB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAC7C,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAC7C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI,CAAC;IAChE,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,kBAAkB,CAAC;IACtD,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,oBAAoB,CAAC;IACxD,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IACvD,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IACvD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,qBAAqB,CAAC;IACzC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC;IAC/D,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,mBAAmB,GAAG,MAAM,GAAG,MAAM,CAAC;IACjE,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACxD,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,qBAAqB,CAAC;IACzC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,qBAAqB,CAAC;IACzC,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACjD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,sBAAsB,CAAC;IAEjD,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,GAAG,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC/B,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC/B,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5C,CAAC,SAAS,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC1C,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACzC,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACzC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrC,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IACtE,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAClC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC;IACzC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACvB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC;IACvB,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAC9B,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC;IAE9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,oGAAoG;IACpG,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvF,uFAAuF;IACvF,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/core/src/types/pdf.d.ts

@@ -0,0 +1,68 @@
+import { Service } from './service';
+export interface PdfExtractionResult {
+    text: string;
+    pageCount: number;
+    metadata?: {
+        title?: string;
+        author?: string;
+        createdAt?: Date;
+        modifiedAt?: Date;
+    };
+}
+export interface PdfGenerationOptions {
+    format?: 'A4' | 'A3' | 'Letter';
+    orientation?: 'portrait' | 'landscape';
+    margins?: {
+        top?: number;
+        bottom?: number;
+        left?: number;
+        right?: number;
+    };
+    header?: string;
+    footer?: string;
+}
+export interface PdfConversionOptions {
+    quality?: 'high' | 'medium' | 'low';
+    outputFormat?: 'pdf' | 'pdf/a';
+    compression?: boolean;
+}
+/**
+ * Interface for PDF processing services
+ */
+export declare abstract class IPdfService extends Service {
+    static readonly serviceType: "pdf";
+    readonly capabilityDescription = "PDF processing, extraction, and generation capabilities";
+    /**
+     * Extract text and metadata from a PDF file
+     * @param pdfPath - Path to the PDF file or buffer
+     * @returns Promise resolving to extracted text and metadata
+     */
+    abstract extractText(pdfPath: string | Buffer): Promise<PdfExtractionResult>;
+    /**
+     * Generate a PDF from HTML content
+     * @param htmlContent - HTML content to convert to PDF
+     * @param options - PDF generation options
+     * @returns Promise resolving to PDF buffer
+     */
+    abstract generatePdf(htmlContent: string, options?: PdfGenerationOptions): Promise<Buffer>;
+    /**
+     * Convert a document to PDF format
+     * @param filePath - Path to the document file
+     * @param options - Conversion options
+     * @returns Promise resolving to PDF buffer
+     */
+    abstract convertToPdf(filePath: string, options?: PdfConversionOptions): Promise<Buffer>;
+    /**
+     * Merge multiple PDF files into one
+     * @param pdfPaths - Array of PDF file paths or buffers
+     * @returns Promise resolving to merged PDF buffer
+     */
+    abstract mergePdfs(pdfPaths: (string | Buffer)[]): Promise<Buffer>;
+    /**
+     * Split a PDF into individual pages
+     * @param pdfPath - Path to the PDF file or buffer
+     * @returns Promise resolving to array of page buffers
+     */
+    abstract splitPdf(pdfPath: string | Buffer): Promise<Buffer[]>;
+}
+//# sourceMappingURL=pdf.d.ts.map

package/dist/core/src/types/pdf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/pdf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,WAAW,CAAC;AAEjD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB,UAAU,CAAC,EAAE,IAAI,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,CAAC;IAChC,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACvC,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACpC,YAAY,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC;IAC/B,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,8BAAsB,WAAY,SAAQ,OAAO;IAC/C,gBAAyB,WAAW,QAAmB;IAEvD,SAAgB,qBAAqB,6DAA6D;IAElG;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAE5E;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAE1F;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAExF;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAElE;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAC/D"}