@voltagent/internal 0.0.5 → 0.0.7

package/README.md

@@ -9,10 +9,12 @@ pnpm add @voltagent/internal
 ```
 
 ```typescript
-import { devLogger } from "@voltagent/internal";
+import { isObject, isString } from "@voltagent/internal";
 
-// will only log if process.env.NODE_ENV is "development"
-devLogger.info("Hello, world!");
+// Use utility functions
+if (isObject(data)) {
+  console.log("Data is an object");
+}
 ```
 
 ## 📦 Imports
@@ -20,8 +22,8 @@ devLogger.info("Hello, world!");
 You can also import specific subsets of the package:
 
 ```typescript
-import { devLogger } from "@voltagent/internal/dev";
 import { convertArrayToAsyncIterable } from "@voltagent/internal/test";
+import { deepClone, hasKey } from "@voltagent/internal/utils";
 ```
 
 Allowing you to only import the tools you need.

package/dist/main/index.d.mts

@@ -1,107 +1,5 @@
 import { SetRequired, EmptyObject, Merge } from 'type-fest';
 
-interface DevLoggerOptions {
-    dev: boolean | (() => boolean);
-}
-/**
- * A logger for development purposes, that will not pollute the production logs (aka if process.env.NODE_ENV is not "development").
- *
- * @example
- * ```typescript
- * devLogger.info("Hello, world!");
- * ```
- */
-declare function createDevLogger(options?: DevLoggerOptions): {
-    /**
-     * Log a message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.info("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] INFO: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    info: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.warn("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] WARN: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    warn: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development.
-     *
-     * @example
-     * ```typescript
-     * devLogger.error("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] ERROR: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    error: (message?: any, ...args: any[]) => void;
-    debug: (_message?: any, ..._args: any[]) => void;
-};
-declare const _default: {
-    /**
-     * Log a message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.info("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] INFO: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    info: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.warn("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] WARN: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    warn: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development.
-     *
-     * @example
-     * ```typescript
-     * devLogger.error("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] ERROR: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    error: (message?: any, ...args: any[]) => void;
-    debug: (_message?: any, ..._args: any[]) => void;
-};
-
 /**
  * Convert a readable stream to an array
  * @param stream - The readable stream to convert
@@ -133,6 +31,108 @@ declare function convertArrayToReadableStream<T>(values: T[]): ReadableStream<T>
  */
 declare function convertResponseStreamToArray(response: Response): Promise<string[]>;
 
+/**
+ * Shared logger types for VoltAgent
+ * These types define the minimal logger interface that both core and logger packages use
+ */
+/**
+ * Valid log levels
+ */
+type LogLevel = "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "silent";
+/**
+ * Log function signatures
+ */
+type LogFn = (msg: string, context?: object) => void;
+/**
+ * Minimal logger interface for VoltAgent
+ * This interface is implemented by @voltagent/logger and can be implemented by other logging solutions
+ */
+interface Logger {
+    /**
+     * Log at trace level - most detailed level
+     */
+    trace: LogFn;
+    /**
+     * Log at debug level - detailed information for debugging
+     */
+    debug: LogFn;
+    /**
+     * Log at info level - general informational messages
+     */
+    info: LogFn;
+    /**
+     * Log at warn level - warning messages
+     */
+    warn: LogFn;
+    /**
+     * Log at error level - error messages
+     */
+    error: LogFn;
+    /**
+     * Log at fatal level - fatal error messages
+     */
+    fatal: LogFn;
+    /**
+     * Create a child logger with additional context
+     * @param bindings - Additional context to bind to the child logger
+     */
+    child(bindings: Record<string, any>): Logger;
+}
+/**
+ * Logger options for configuration
+ */
+interface LoggerOptions {
+    /**
+     * Log level
+     */
+    level?: string;
+    /**
+     * Logger name
+     */
+    name?: string;
+    /**
+     * Additional options specific to the logger implementation
+     */
+    [key: string]: any;
+}
+/**
+ * Log entry structure
+ */
+interface LogEntry {
+    timestamp: string;
+    level: LogLevel;
+    msg: string;
+    component?: string;
+    agentId?: string;
+    conversationId?: string;
+    workflowId?: string;
+    executionId?: string;
+    userId?: string;
+    [key: string]: any;
+}
+/**
+ * Log filter for querying logs
+ */
+interface LogFilter {
+    level?: LogLevel;
+    agentId?: string;
+    conversationId?: string;
+    workflowId?: string;
+    executionId?: string;
+    since?: Date;
+    until?: Date;
+    limit?: number;
+}
+/**
+ * Log buffer interface for storing logs in memory
+ */
+interface LogBuffer {
+    add(entry: LogEntry): void;
+    query(filter?: LogFilter): LogEntry[];
+    clear(): void;
+    size(): number;
+}
+
 /**
  * A plain object is an object that has no special properties or methods,
  * and just has properties that are strings, numbers, or symbols.
@@ -159,9 +159,10 @@ type AnyFunction = AnyAsyncFunction | AnySyncFunction;
  * Deep clone an object using JSON serialization with fallback to shallow clone
  *
  * @param obj - The object to clone
+ * @param logger - Optional logger for warnings
  * @returns A deep copy of the object, or shallow copy if JSON serialization fails
  */
-declare function deepClone<T>(obj: T): T;
+declare function deepClone<T>(obj: T, logger?: Logger): T;
 /**
  * Check if an object has a key
  *
@@ -237,4 +238,4 @@ type AsyncIterableStream<T> = Merge<AsyncIterable<T>, ReadableStream<T>>;
  */
 declare function createAsyncIterableStream<T>(source: ReadableStream<T>): AsyncIterableStream<T>;
 
-export { type AsyncIterableStream, type DevLoggerOptions, convertArrayToAsyncIterable, convertArrayToReadableStream, convertAsyncIterableToArray, convertReadableStreamToArray, convertResponseStreamToArray, createAsyncIterableStream, createDevLogger, deepClone, _default as devLogger, hasKey, isEmptyObject, isFunction, isNil, isObject, isPlainObject };
+export { type AsyncIterableStream, type LogBuffer, type LogEntry, type LogFilter, type LogFn, type LogLevel, type Logger, type LoggerOptions, convertArrayToAsyncIterable, convertArrayToReadableStream, convertAsyncIterableToArray, convertReadableStreamToArray, convertResponseStreamToArray, createAsyncIterableStream, deepClone, hasKey, isEmptyObject, isFunction, isNil, isObject, isPlainObject };

package/dist/main/index.d.ts

@@ -1,107 +1,5 @@
 import { SetRequired, EmptyObject, Merge } from 'type-fest';
 
-interface DevLoggerOptions {
-    dev: boolean | (() => boolean);
-}
-/**
- * A logger for development purposes, that will not pollute the production logs (aka if process.env.NODE_ENV is not "development").
- *
- * @example
- * ```typescript
- * devLogger.info("Hello, world!");
- * ```
- */
-declare function createDevLogger(options?: DevLoggerOptions): {
-    /**
-     * Log a message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.info("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] INFO: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    info: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.warn("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] WARN: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    warn: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development.
-     *
-     * @example
-     * ```typescript
-     * devLogger.error("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] ERROR: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    error: (message?: any, ...args: any[]) => void;
-    debug: (_message?: any, ..._args: any[]) => void;
-};
-declare const _default: {
-    /**
-     * Log a message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.info("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] INFO: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    info: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development. This will NOT be logged if process.env.NODE_ENV is not "development".
-     *
-     * @example
-     * ```typescript
-     * devLogger.warn("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] WARN: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    warn: (message?: any, ...args: any[]) => void;
-    /**
-     * Log a warning message to the console if the environment is development.
-     *
-     * @example
-     * ```typescript
-     * devLogger.error("Hello, world!");
-     *
-     * // output: [VoltAgent] [2021-01-01T00:00:00.000Z] ERROR: Hello, world!
-     * ```
-     *
-     * @param message - The message to log.
-     * @param args - The arguments to log.
-     */
-    error: (message?: any, ...args: any[]) => void;
-    debug: (_message?: any, ..._args: any[]) => void;
-};
-
 /**
  * Convert a readable stream to an array
  * @param stream - The readable stream to convert
@@ -133,6 +31,108 @@ declare function convertArrayToReadableStream<T>(values: T[]): ReadableStream<T>
  */
 declare function convertResponseStreamToArray(response: Response): Promise<string[]>;
 
+/**
+ * Shared logger types for VoltAgent
+ * These types define the minimal logger interface that both core and logger packages use
+ */
+/**
+ * Valid log levels
+ */
+type LogLevel = "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "silent";
+/**
+ * Log function signatures
+ */
+type LogFn = (msg: string, context?: object) => void;
+/**
+ * Minimal logger interface for VoltAgent
+ * This interface is implemented by @voltagent/logger and can be implemented by other logging solutions
+ */
+interface Logger {
+    /**
+     * Log at trace level - most detailed level
+     */
+    trace: LogFn;
+    /**
+     * Log at debug level - detailed information for debugging
+     */
+    debug: LogFn;
+    /**
+     * Log at info level - general informational messages
+     */
+    info: LogFn;
+    /**
+     * Log at warn level - warning messages
+     */
+    warn: LogFn;
+    /**
+     * Log at error level - error messages
+     */
+    error: LogFn;
+    /**
+     * Log at fatal level - fatal error messages
+     */
+    fatal: LogFn;
+    /**
+     * Create a child logger with additional context
+     * @param bindings - Additional context to bind to the child logger
+     */
+    child(bindings: Record<string, any>): Logger;
+}
+/**
+ * Logger options for configuration
+ */
+interface LoggerOptions {
+    /**
+     * Log level
+     */
+    level?: string;
+    /**
+     * Logger name
+     */
+    name?: string;
+    /**
+     * Additional options specific to the logger implementation
+     */
+    [key: string]: any;
+}
+/**
+ * Log entry structure
+ */
+interface LogEntry {
+    timestamp: string;
+    level: LogLevel;
+    msg: string;
+    component?: string;
+    agentId?: string;
+    conversationId?: string;
+    workflowId?: string;
+    executionId?: string;
+    userId?: string;
+    [key: string]: any;
+}
+/**
+ * Log filter for querying logs
+ */
+interface LogFilter {
+    level?: LogLevel;
+    agentId?: string;
+    conversationId?: string;
+    workflowId?: string;
+    executionId?: string;
+    since?: Date;
+    until?: Date;
+    limit?: number;
+}
+/**
+ * Log buffer interface for storing logs in memory
+ */
+interface LogBuffer {
+    add(entry: LogEntry): void;
+    query(filter?: LogFilter): LogEntry[];
+    clear(): void;
+    size(): number;
+}
+
 /**
  * A plain object is an object that has no special properties or methods,
  * and just has properties that are strings, numbers, or symbols.
@@ -159,9 +159,10 @@ type AnyFunction = AnyAsyncFunction | AnySyncFunction;
  * Deep clone an object using JSON serialization with fallback to shallow clone
  *
  * @param obj - The object to clone
+ * @param logger - Optional logger for warnings
  * @returns A deep copy of the object, or shallow copy if JSON serialization fails
  */
-declare function deepClone<T>(obj: T): T;
+declare function deepClone<T>(obj: T, logger?: Logger): T;
 /**
  * Check if an object has a key
  *
@@ -237,4 +238,4 @@ type AsyncIterableStream<T> = Merge<AsyncIterable<T>, ReadableStream<T>>;
  */
 declare function createAsyncIterableStream<T>(source: ReadableStream<T>): AsyncIterableStream<T>;
 
-export { type AsyncIterableStream, type DevLoggerOptions, convertArrayToAsyncIterable, convertArrayToReadableStream, convertAsyncIterableToArray, convertReadableStreamToArray, convertResponseStreamToArray, createAsyncIterableStream, createDevLogger, deepClone, _default as devLogger, hasKey, isEmptyObject, isFunction, isNil, isObject, isPlainObject };
+export { type AsyncIterableStream, type LogBuffer, type LogEntry, type LogFilter, type LogFn, type LogLevel, type Logger, type LoggerOptions, convertArrayToAsyncIterable, convertArrayToReadableStream, convertAsyncIterableToArray, convertReadableStreamToArray, convertResponseStreamToArray, createAsyncIterableStream, deepClone, hasKey, isEmptyObject, isFunction, isNil, isObject, isPlainObject };