@mastra/cloudflare-d1 0.0.0-separate-trace-data-from-component-20250501042644 → 0.0.0-support-d1-client-20250701191943

package/README.md

@@ -54,6 +54,21 @@ const store = new D1Store({
 });
 ```
 
+### Or you can pass any client implementation you want
+
+```typescript
+import { D1Store } from '@mastra/cloudflare-d1';
+
+const store = new D1Store({
+  client: {
+    query: ({ sql, params }) => {
+      // do something
+    },
+  },
+  tablePrefix: 'mastra_', // optional
+});
+```
+
 ## Supported Methods
 
 ### Thread Operations

package/dist/_tsup-dts-rollup.d.cts

@@ -1,42 +1,19 @@
+import { default as Cloudflare_2 } from 'cloudflare';
 import type { D1Database as D1Database_2 } from '@cloudflare/workers-types';
 import type { EvalRow } from '@mastra/core/storage';
+import type { MastraMessageContentV2 } from '@mastra/core/agent';
+import type { MastraMessageV1 } from '@mastra/core/memory';
+import type { MastraMessageV2 } from '@mastra/core/memory';
 import { MastraStorage } from '@mastra/core/storage';
-import type { MessageType } from '@mastra/core/memory';
-import type { MessageType as MessageType_2 } from '@mastra/core';
+import type { PaginationInfo } from '@mastra/core/storage';
 import type { StorageColumn } from '@mastra/core/storage';
 import type { StorageGetMessagesArg } from '@mastra/core/storage';
 import type { StorageThreadType } from '@mastra/core/memory';
 import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { Trace } from '@mastra/core/telemetry';
 import type { WorkflowRun } from '@mastra/core/storage';
 import type { WorkflowRuns } from '@mastra/core/storage';
 import type { WorkflowRunState } from '@mastra/core/workflows';
-import type { WorkflowRunState as WorkflowRunState_2 } from '@mastra/core';
-
-export declare const checkWorkflowSnapshot: (snapshot: WorkflowRunState_2 | string, stepId: string, status: string) => void;
-
-export declare const createSampleMessage: (threadId: string) => MessageType_2;
-
-export declare const createSampleThread: () => {
-    id: string;
-    resourceId: string;
-    title: string;
-    createdAt: Date;
-    updatedAt: Date;
-    metadata: {
-        key: string;
-    };
-};
-
-export declare const createSampleThreadWithParams: (threadId: string, resourceId: string, createdAt: Date, updatedAt: Date) => {
-    id: string;
-    resourceId: string;
-    title: string;
-    createdAt: Date;
-    updatedAt: Date;
-    metadata: {
-        key: string;
-    };
-};
 
 export declare const createSampleTrace: (name: string, scope?: string, attributes?: Record<string, string>) => {
     id: string;
@@ -55,14 +32,28 @@ export declare const createSampleTrace: (name: string, scope?: string, attribute
     createdAt: string;
 };
 
-export declare const createSampleWorkflowSnapshot: (threadId: string, status: string, createdAt?: Date) => {
-    snapshot: WorkflowRunState_2;
-    runId: string;
-    stepId: string;
-};
-
 export declare function createSqlBuilder(): SqlBuilder;
 
+declare interface D1Client {
+    query(args: {
+        sql: string;
+        params: string[];
+    }): Promise<{
+        result: D1QueryResult;
+    }>;
+}
+export { D1Client }
+export { D1Client as D1Client_alias_1 }
+
+declare interface D1ClientConfig {
+    /** Optional prefix for table names */
+    tablePrefix?: string;
+    /** D1 Client */
+    client: D1Client;
+}
+export { D1ClientConfig }
+export { D1ClientConfig as D1ClientConfig_alias_1 }
+
 /**
  * Configuration for D1 using the REST API
  */
@@ -79,10 +70,12 @@ declare interface D1Config {
 export { D1Config }
 export { D1Config as D1Config_alias_1 }
 
+declare type D1QueryResult = Awaited<ReturnType<Cloudflare_2['d1']['database']['query']>>['result'];
+export { D1QueryResult }
+export { D1QueryResult as D1QueryResult_alias_1 }
+
 declare class D1Store extends MastraStorage {
     private client?;
-    private accountId?;
-    private databaseId?;
     private binding?;
     private tablePrefix;
     /**
@@ -92,7 +85,6 @@ declare class D1Store extends MastraStorage {
     constructor(config: D1StoreConfig);
     private getTableName;
     private formatSqlParams;
-    private createIndexIfNotExists;
     private executeWorkersBindingQuery;
     private executeRestQuery;
     /**
@@ -101,15 +93,25 @@ declare class D1Store extends MastraStorage {
      * @returns Query results as an array or a single object if first=true
      */
     private executeQuery;
-    private getSqlType;
-    private ensureDate;
-    private serializeDate;
+    private getTableColumns;
     private serializeValue;
     private deserializeValue;
+    protected getSqlType(type: StorageColumn['type']): string;
     createTable({ tableName, schema, }: {
         tableName: TABLE_NAMES;
         schema: Record<string, StorageColumn>;
     }): Promise<void>;
+    /**
+     * Alters table schema to add columns if they don't exist
+     * @param tableName Name of the table
+     * @param schema Schema of the table
+     * @param ifNotExists Array of column names to add if they don't exist
+     */
+    alterTable({ tableName, schema, ifNotExists, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+        ifNotExists: string[];
+    }): Promise<void>;
     clearTable({ tableName }: {
         tableName: TABLE_NAMES;
     }): Promise<void>;
@@ -125,9 +127,19 @@ declare class D1Store extends MastraStorage {
     getThreadById({ threadId }: {
         threadId: string;
     }): Promise<StorageThreadType | null>;
+    /**
+     * @deprecated use getThreadsByResourceIdPaginated instead
+     */
     getThreadsByResourceId({ resourceId }: {
         resourceId: string;
     }): Promise<StorageThreadType[]>;
+    getThreadsByResourceIdPaginated(args: {
+        resourceId: string;
+        page: number;
+        perPage: number;
+    }): Promise<PaginationInfo & {
+        threads: StorageThreadType[];
+    }>;
     saveThread({ thread }: {
         thread: StorageThreadType;
     }): Promise<StorageThreadType>;
@@ -139,10 +151,29 @@ declare class D1Store extends MastraStorage {
     deleteThread({ threadId }: {
         threadId: string;
     }): Promise<void>;
-    saveMessages({ messages }: {
-        messages: MessageType[];
-    }): Promise<MessageType[]>;
-    getMessages<T = MessageType>({ threadId, selectBy }: StorageGetMessagesArg): Promise<T[]>;
+    saveMessages(args: {
+        messages: MastraMessageV1[];
+        format?: undefined | 'v1';
+    }): Promise<MastraMessageV1[]>;
+    saveMessages(args: {
+        messages: MastraMessageV2[];
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    private _getIncludedMessages;
+    /**
+     * @deprecated use getMessagesPaginated instead
+     */
+    getMessages(args: StorageGetMessagesArg & {
+        format?: 'v1';
+    }): Promise<MastraMessageV1[]>;
+    getMessages(args: StorageGetMessagesArg & {
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    getMessagesPaginated({ threadId, selectBy, format, }: StorageGetMessagesArg & {
+        format?: 'v1' | 'v2';
+    }): Promise<PaginationInfo & {
+        messages: MastraMessageV1[] | MastraMessageV2[];
+    }>;
     persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
         workflowName: string;
         runId: string;
@@ -161,14 +192,49 @@ declare class D1Store extends MastraStorage {
         tableName: TABLE_NAMES;
         records: Record<string, any>[];
     }): Promise<void>;
-    getTraces({ name, scope, page, perPage, attributes, }: {
+    /**
+     * Upsert multiple records in a batch operation
+     * @param tableName The table to insert into
+     * @param records The records to insert
+     */
+    private batchUpsert;
+    /**
+     * @deprecated use getTracesPaginated instead
+     */
+    getTraces({ name, scope, page, perPage, attributes, fromDate, toDate, }: {
         name?: string;
         scope?: string;
         page: number;
         perPage: number;
         attributes?: Record<string, string>;
-    }): Promise<Record<string, any>[]>;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<Trace[]>;
+    getTracesPaginated(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        page: number;
+        perPage: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<PaginationInfo & {
+        traces: Trace[];
+    }>;
+    /**
+     * @deprecated use getEvals instead
+     */
     getEvalsByAgentName(agentName: string, type?: 'test' | 'live'): Promise<EvalRow[]>;
+    getEvals(options?: {
+        agentName?: string;
+        type?: 'test' | 'live';
+        page?: number;
+        perPage?: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<PaginationInfo & {
+        evals: EvalRow[];
+    }>;
     private parseWorkflowRun;
     private hasColumn;
     getWorkflowRuns({ workflowName, fromDate, toDate, limit, offset, resourceId, }?: {
@@ -188,6 +254,15 @@ declare class D1Store extends MastraStorage {
      * No explicit cleanup needed for D1 in either REST or Workers Binding mode
      */
     close(): Promise<void>;
+    updateMessages(_args: {
+        messages: Partial<Omit<MastraMessageV2, 'createdAt'>> & {
+            id: string;
+            content?: {
+                metadata?: MastraMessageContentV2['metadata'];
+                content?: MastraMessageContentV2['content'];
+            };
+        }[];
+    }): Promise<MastraMessageV2[]>;
 }
 export { D1Store }
 export { D1Store as D1Store_alias_1 }
@@ -195,7 +270,7 @@ export { D1Store as D1Store_alias_1 }
 /**
  * Combined configuration type supporting both REST API and Workers Binding API
  */
-declare type D1StoreConfig = D1Config | D1WorkersConfig;
+declare type D1StoreConfig = D1Config | D1WorkersConfig | D1ClientConfig;
 export { D1StoreConfig }
 export { D1StoreConfig as D1StoreConfig_alias_1 }
 
@@ -211,9 +286,30 @@ declare interface D1WorkersConfig {
 export { D1WorkersConfig }
 export { D1WorkersConfig as D1WorkersConfig_alias_1 }
 
+/**
+ * Parses and returns a valid SQL SELECT column identifier.
+ * Allows a single identifier (letters, numbers, underscores), or '*', optionally with 'AS alias'.
+ *
+ * @param column - The column identifier string to parse.
+ * @returns The validated column identifier as a branded type.
+ * @throws {Error} If invalid.
+ *
+ * @example
+ * const col = parseSelectIdentifier('user_id'); // Ok
+ * parseSelectIdentifier('user_id AS uid'); // Ok
+ * parseSelectIdentifier('*'); // Ok
+ * parseSelectIdentifier('user id'); // Throws error
+ */
+export declare function parseSelectIdentifier(column: string): SelectIdentifier;
+
 export declare const retryUntil: <T>(fn: () => Promise<T>, condition: (result: T) => boolean, timeout?: number, // REST API needs longer timeout due to higher latency
 interval?: number) => Promise<T>;
 
+/** Represents a validated SQL SELECT column identifier (or '*', optionally with 'AS alias'). */
+declare type SelectIdentifier = string & {
+    __brand: 'SelectIdentifier';
+};
+
 /**
  * SQL Builder class for constructing type-safe SQL queries
  * This helps create maintainable and secure SQL queries with proper parameter handling
@@ -277,7 +373,6 @@ export declare class SqlBuilder {
      * @returns The builder instance
      */
     createIndex(indexName: string, tableName: string, columnName: string, indexType?: string): SqlBuilder;
-    raw(sql: string, ...params: SqlParam[]): SqlBuilder;
     /**
      * Add a LIKE condition to the query
      * @param column The column to check
@@ -315,7 +410,7 @@ export declare type SqlParam = string | number | boolean | null | undefined;
 /**
  * Interface for SQL query options with generic type support
  */
-declare interface SqlQueryOptions {
+export declare interface SqlQueryOptions {
     /** SQL query to execute */
     sql: string;
     /** Parameters to bind to the query */
@@ -323,7 +418,5 @@ declare interface SqlQueryOptions {
     /** Whether to return only the first result */
     first?: boolean;
 }
-export { SqlQueryOptions }
-export { SqlQueryOptions as SqlQueryOptions_alias_1 }
 
 export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -1,42 +1,19 @@
+import { default as Cloudflare_2 } from 'cloudflare';
 import type { D1Database as D1Database_2 } from '@cloudflare/workers-types';
 import type { EvalRow } from '@mastra/core/storage';
+import type { MastraMessageContentV2 } from '@mastra/core/agent';
+import type { MastraMessageV1 } from '@mastra/core/memory';
+import type { MastraMessageV2 } from '@mastra/core/memory';
 import { MastraStorage } from '@mastra/core/storage';
-import type { MessageType } from '@mastra/core/memory';
-import type { MessageType as MessageType_2 } from '@mastra/core';
+import type { PaginationInfo } from '@mastra/core/storage';
 import type { StorageColumn } from '@mastra/core/storage';
 import type { StorageGetMessagesArg } from '@mastra/core/storage';
 import type { StorageThreadType } from '@mastra/core/memory';
 import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { Trace } from '@mastra/core/telemetry';
 import type { WorkflowRun } from '@mastra/core/storage';
 import type { WorkflowRuns } from '@mastra/core/storage';
 import type { WorkflowRunState } from '@mastra/core/workflows';
-import type { WorkflowRunState as WorkflowRunState_2 } from '@mastra/core';
-
-export declare const checkWorkflowSnapshot: (snapshot: WorkflowRunState_2 | string, stepId: string, status: string) => void;
-
-export declare const createSampleMessage: (threadId: string) => MessageType_2;
-
-export declare const createSampleThread: () => {
-    id: string;
-    resourceId: string;
-    title: string;
-    createdAt: Date;
-    updatedAt: Date;
-    metadata: {
-        key: string;
-    };
-};
-
-export declare const createSampleThreadWithParams: (threadId: string, resourceId: string, createdAt: Date, updatedAt: Date) => {
-    id: string;
-    resourceId: string;
-    title: string;
-    createdAt: Date;
-    updatedAt: Date;
-    metadata: {
-        key: string;
-    };
-};
 
 export declare const createSampleTrace: (name: string, scope?: string, attributes?: Record<string, string>) => {
     id: string;
@@ -55,14 +32,28 @@ export declare const createSampleTrace: (name: string, scope?: string, attribute
     createdAt: string;
 };
 
-export declare const createSampleWorkflowSnapshot: (threadId: string, status: string, createdAt?: Date) => {
-    snapshot: WorkflowRunState_2;
-    runId: string;
-    stepId: string;
-};
-
 export declare function createSqlBuilder(): SqlBuilder;
 
+declare interface D1Client {
+    query(args: {
+        sql: string;
+        params: string[];
+    }): Promise<{
+        result: D1QueryResult;
+    }>;
+}
+export { D1Client }
+export { D1Client as D1Client_alias_1 }
+
+declare interface D1ClientConfig {
+    /** Optional prefix for table names */
+    tablePrefix?: string;
+    /** D1 Client */
+    client: D1Client;
+}
+export { D1ClientConfig }
+export { D1ClientConfig as D1ClientConfig_alias_1 }
+
 /**
  * Configuration for D1 using the REST API
  */
@@ -79,10 +70,12 @@ declare interface D1Config {
 export { D1Config }
 export { D1Config as D1Config_alias_1 }
 
+declare type D1QueryResult = Awaited<ReturnType<Cloudflare_2['d1']['database']['query']>>['result'];
+export { D1QueryResult }
+export { D1QueryResult as D1QueryResult_alias_1 }
+
 declare class D1Store extends MastraStorage {
     private client?;
-    private accountId?;
-    private databaseId?;
     private binding?;
     private tablePrefix;
     /**
@@ -92,7 +85,6 @@ declare class D1Store extends MastraStorage {
     constructor(config: D1StoreConfig);
     private getTableName;
     private formatSqlParams;
-    private createIndexIfNotExists;
     private executeWorkersBindingQuery;
     private executeRestQuery;
     /**
@@ -101,15 +93,25 @@ declare class D1Store extends MastraStorage {
      * @returns Query results as an array or a single object if first=true
      */
     private executeQuery;
-    private getSqlType;
-    private ensureDate;
-    private serializeDate;
+    private getTableColumns;
     private serializeValue;
     private deserializeValue;
+    protected getSqlType(type: StorageColumn['type']): string;
     createTable({ tableName, schema, }: {
         tableName: TABLE_NAMES;
         schema: Record<string, StorageColumn>;
     }): Promise<void>;
+    /**
+     * Alters table schema to add columns if they don't exist
+     * @param tableName Name of the table
+     * @param schema Schema of the table
+     * @param ifNotExists Array of column names to add if they don't exist
+     */
+    alterTable({ tableName, schema, ifNotExists, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+        ifNotExists: string[];
+    }): Promise<void>;
     clearTable({ tableName }: {
         tableName: TABLE_NAMES;
     }): Promise<void>;
@@ -125,9 +127,19 @@ declare class D1Store extends MastraStorage {
     getThreadById({ threadId }: {
         threadId: string;
     }): Promise<StorageThreadType | null>;
+    /**
+     * @deprecated use getThreadsByResourceIdPaginated instead
+     */
     getThreadsByResourceId({ resourceId }: {
         resourceId: string;
     }): Promise<StorageThreadType[]>;
+    getThreadsByResourceIdPaginated(args: {
+        resourceId: string;
+        page: number;
+        perPage: number;
+    }): Promise<PaginationInfo & {
+        threads: StorageThreadType[];
+    }>;
     saveThread({ thread }: {
         thread: StorageThreadType;
     }): Promise<StorageThreadType>;
@@ -139,10 +151,29 @@ declare class D1Store extends MastraStorage {
     deleteThread({ threadId }: {
         threadId: string;
     }): Promise<void>;
-    saveMessages({ messages }: {
-        messages: MessageType[];
-    }): Promise<MessageType[]>;
-    getMessages<T = MessageType>({ threadId, selectBy }: StorageGetMessagesArg): Promise<T[]>;
+    saveMessages(args: {
+        messages: MastraMessageV1[];
+        format?: undefined | 'v1';
+    }): Promise<MastraMessageV1[]>;
+    saveMessages(args: {
+        messages: MastraMessageV2[];
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    private _getIncludedMessages;
+    /**
+     * @deprecated use getMessagesPaginated instead
+     */
+    getMessages(args: StorageGetMessagesArg & {
+        format?: 'v1';
+    }): Promise<MastraMessageV1[]>;
+    getMessages(args: StorageGetMessagesArg & {
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    getMessagesPaginated({ threadId, selectBy, format, }: StorageGetMessagesArg & {
+        format?: 'v1' | 'v2';
+    }): Promise<PaginationInfo & {
+        messages: MastraMessageV1[] | MastraMessageV2[];
+    }>;
     persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
         workflowName: string;
         runId: string;
@@ -161,14 +192,49 @@ declare class D1Store extends MastraStorage {
         tableName: TABLE_NAMES;
         records: Record<string, any>[];
     }): Promise<void>;
-    getTraces({ name, scope, page, perPage, attributes, }: {
+    /**
+     * Upsert multiple records in a batch operation
+     * @param tableName The table to insert into
+     * @param records The records to insert
+     */
+    private batchUpsert;
+    /**
+     * @deprecated use getTracesPaginated instead
+     */
+    getTraces({ name, scope, page, perPage, attributes, fromDate, toDate, }: {
         name?: string;
         scope?: string;
         page: number;
         perPage: number;
         attributes?: Record<string, string>;
-    }): Promise<Record<string, any>[]>;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<Trace[]>;
+    getTracesPaginated(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        page: number;
+        perPage: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<PaginationInfo & {
+        traces: Trace[];
+    }>;
+    /**
+     * @deprecated use getEvals instead
+     */
     getEvalsByAgentName(agentName: string, type?: 'test' | 'live'): Promise<EvalRow[]>;
+    getEvals(options?: {
+        agentName?: string;
+        type?: 'test' | 'live';
+        page?: number;
+        perPage?: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<PaginationInfo & {
+        evals: EvalRow[];
+    }>;
     private parseWorkflowRun;
     private hasColumn;
     getWorkflowRuns({ workflowName, fromDate, toDate, limit, offset, resourceId, }?: {
@@ -188,6 +254,15 @@ declare class D1Store extends MastraStorage {
      * No explicit cleanup needed for D1 in either REST or Workers Binding mode
      */
     close(): Promise<void>;
+    updateMessages(_args: {
+        messages: Partial<Omit<MastraMessageV2, 'createdAt'>> & {
+            id: string;
+            content?: {
+                metadata?: MastraMessageContentV2['metadata'];
+                content?: MastraMessageContentV2['content'];
+            };
+        }[];
+    }): Promise<MastraMessageV2[]>;
 }
 export { D1Store }
 export { D1Store as D1Store_alias_1 }
@@ -195,7 +270,7 @@ export { D1Store as D1Store_alias_1 }
 /**
  * Combined configuration type supporting both REST API and Workers Binding API
  */
-declare type D1StoreConfig = D1Config | D1WorkersConfig;
+declare type D1StoreConfig = D1Config | D1WorkersConfig | D1ClientConfig;
 export { D1StoreConfig }
 export { D1StoreConfig as D1StoreConfig_alias_1 }
 
@@ -211,9 +286,30 @@ declare interface D1WorkersConfig {
 export { D1WorkersConfig }
 export { D1WorkersConfig as D1WorkersConfig_alias_1 }
 
+/**
+ * Parses and returns a valid SQL SELECT column identifier.
+ * Allows a single identifier (letters, numbers, underscores), or '*', optionally with 'AS alias'.
+ *
+ * @param column - The column identifier string to parse.
+ * @returns The validated column identifier as a branded type.
+ * @throws {Error} If invalid.
+ *
+ * @example
+ * const col = parseSelectIdentifier('user_id'); // Ok
+ * parseSelectIdentifier('user_id AS uid'); // Ok
+ * parseSelectIdentifier('*'); // Ok
+ * parseSelectIdentifier('user id'); // Throws error
+ */
+export declare function parseSelectIdentifier(column: string): SelectIdentifier;
+
 export declare const retryUntil: <T>(fn: () => Promise<T>, condition: (result: T) => boolean, timeout?: number, // REST API needs longer timeout due to higher latency
 interval?: number) => Promise<T>;
 
+/** Represents a validated SQL SELECT column identifier (or '*', optionally with 'AS alias'). */
+declare type SelectIdentifier = string & {
+    __brand: 'SelectIdentifier';
+};
+
 /**
  * SQL Builder class for constructing type-safe SQL queries
  * This helps create maintainable and secure SQL queries with proper parameter handling
@@ -277,7 +373,6 @@ export declare class SqlBuilder {
      * @returns The builder instance
      */
     createIndex(indexName: string, tableName: string, columnName: string, indexType?: string): SqlBuilder;
-    raw(sql: string, ...params: SqlParam[]): SqlBuilder;
     /**
      * Add a LIKE condition to the query
      * @param column The column to check
@@ -315,7 +410,7 @@ export declare type SqlParam = string | number | boolean | null | undefined;
 /**
  * Interface for SQL query options with generic type support
  */
-declare interface SqlQueryOptions {
+export declare interface SqlQueryOptions {
     /** SQL query to execute */
     sql: string;
     /** Parameters to bind to the query */
@@ -323,7 +418,5 @@ declare interface SqlQueryOptions {
     /** Whether to return only the first result */
     first?: boolean;
 }
-export { SqlQueryOptions }
-export { SqlQueryOptions as SqlQueryOptions_alias_1 }
 
 export { }