@mastra/redis 1.0.1 → 1.0.2

package/dist/storage/store.d.ts

@@ -0,0 +1,66 @@
+import { MastraStorage } from '@mastra/core/storage';
+import type { StorageDomains } from '@mastra/core/storage';
+import type { RedisClient, RedisConfig } from './types.js';
+/**
+ * Redis storage adapter for Mastra.
+ *
+ * Provides storage functionality for direct Redis connections using the official redis package.
+ *
+ * Access domain-specific storage via `getStore()`:
+ *
+ * @example
+ * ```typescript
+ * // Using connection string
+ * const storage = new RedisStore({
+ *   id: 'my-store',
+ *   connectionString: 'redis://localhost:6379',
+ * });
+ *
+ * // Using host/port
+ * const storage = new RedisStore({
+ *   id: 'my-store',
+ *   host: 'localhost',
+ *   port: 6379,
+ *   password: 'secret',
+ * });
+ *
+ * // Access memory domain
+ * const memory = await storage.getStore('memory');
+ * await memory?.saveThread({ thread });
+ *
+ * // Access workflows domain
+ * const workflows = await storage.getStore('workflows');
+ * await workflows?.persistWorkflowSnapshot({ workflowName, runId, snapshot });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Using a pre-configured client for advanced features
+ * import { createClient } from 'redis';
+ *
+ * const client = createClient({
+ *   url: 'redis://localhost:6379',
+ *   socket: {
+ *     reconnectStrategy: (retries) => Math.min(retries * 50, 2000),
+ *   },
+ * });
+ * await client.connect();
+ *
+ * const storage = new RedisStore({
+ *   id: 'my-store',
+ *   client,
+ * });
+ * ```
+ */
+export declare class RedisStore extends MastraStorage {
+    private client;
+    private shouldManageConnection;
+    stores: StorageDomains;
+    constructor(config: RedisConfig);
+    init(): Promise<void>;
+    getClient(): RedisClient;
+    close(): Promise<void>;
+    private createClient;
+    private createClientUrl;
+}
+//# sourceMappingURL=store.d.ts.map

package/dist/storage/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/storage/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAM3D,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,UAAW,SAAQ,aAAa;IAC3C,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,sBAAsB,CAAU;IACjC,MAAM,EAAE,cAAc,CAAC;gBAElB,MAAM,EAAE,WAAW;IAcT,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAOpC,SAAS,IAAI,WAAW;IAIlB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAMnC,OAAO,CAAC,YAAY;IA+BpB,OAAO,CAAC,eAAe;CASxB"}

package/dist/storage/types.d.ts

@@ -0,0 +1,88 @@
+import type { RedisClientType } from 'redis';
+export type RedisClient = RedisClientType<Record<string, never>, Record<string, never>, Record<string, never>>;
+/**
+ * Redis configuration type.
+ *
+ * Accepts either:
+ * - A pre-configured redis client: `{ id, client }`
+ * - Connection string: `{ id, connectionString }`
+ * - Host/port config: `{ id, host, port?, password?, db? }`
+ */
+export type RedisConfig = {
+    id: string;
+    /**
+     * When true, automatic initialization (table creation/migrations) is disabled.
+     * This is useful for CI/CD pipelines where you want to:
+     * 1. Run migrations explicitly during deployment (not at runtime)
+     * 2. Use different credentials for schema changes vs runtime operations
+     *
+     * When disableInit is true:
+     * - The storage will not automatically create/alter tables on first use
+     * - You must call `storage.init()` explicitly in your CI/CD scripts
+     *
+     * @example
+     * // In CI/CD script:
+     * const storage = new RedisStore({ ...config, disableInit: false });
+     * await storage.init(); // Explicitly run migrations
+     *
+     * // In runtime application:
+     * const storage = new RedisStore({ ...config, disableInit: true });
+     * // No auto-init, tables must already exist
+     */
+    disableInit?: boolean;
+} & ({
+    /**
+     * Pre-configured redis client (from the official `redis` package).
+     * Use this when you need to configure the client before initialization,
+     * e.g., to set custom socket options or interceptors.
+     *
+     * @example
+     * ```typescript
+     * import { createClient } from 'redis';
+     *
+     * const client = createClient({
+     *   url: 'redis://localhost:6379',
+     *   socket: {
+     *     reconnectStrategy: (retries) => Math.min(retries * 50, 2000),
+     *   },
+     * });
+     * await client.connect();
+     *
+     * const store = new RedisStore({ id: 'my-store', client });
+     * ```
+     */
+    client: RedisClient;
+} | {
+    /**
+     * Redis connection string URL.
+     *
+     * @example
+     * ```typescript
+     * const store = new RedisStore({
+     *   id: 'my-store',
+     *   connectionString: 'redis://user:password@localhost:6379/0',
+     * });
+     * ```
+     */
+    connectionString: string;
+} | {
+    /**
+     * Redis host address.
+     */
+    host: string;
+    /**
+     * Redis port number.
+     * @default 6379
+     */
+    port?: number;
+    /**
+     * Redis password for authentication.
+     */
+    password?: string;
+    /**
+     * Redis database number.
+     * @default 0
+     */
+    db?: number;
+});
+//# sourceMappingURL=types.d.ts.map

package/dist/storage/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/storage/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAE/G;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,GAAG,CACA;IACE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,EAAE,WAAW,CAAC;CACrB,GACD;IACE;;;;;;;;;;OAUG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACD;IACE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CACJ,CAAC"}

package/dist/storage/utils.d.ts

@@ -0,0 +1,8 @@
+import type { RedisClient, RedisConfig } from './types.js';
+export declare function isClientConfig(config: RedisConfig): config is RedisConfig & {
+    client: RedisClient;
+};
+export declare function isConnectionStringConfig(config: RedisConfig): config is RedisConfig & {
+    connectionString: string;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/storage/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/storage/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAExD,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,IAAI,WAAW,GAAG;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAEnG;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,IAAI,WAAW,GAAG;IAAE,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAElH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/redis",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Redis storage provider for Mastra - provides storage capabilities for direct Redis connections",
   "type": "module",
   "main": "dist/index.js",
@@ -25,17 +25,17 @@
   },
   "devDependencies": {
     "@types/node": "22.13.17",
-    "@vitest/coverage-v8": "4.1.4",
-    "@vitest/ui": "4.1.4",
+    "@vitest/coverage-v8": "4.1.5",
+    "@vitest/ui": "4.1.5",
     "dotenv": "^17.0.0",
     "eslint": "^9.37.0",
     "tsup": "^8.5.0",
     "typescript": "^5.9.3",
-    "vitest": "4.1.4",
-    "@internal/storage-test-utils": "0.0.80",
-    "@internal/lint": "0.0.84",
-    "@internal/types-builder": "0.0.59",
-    "@mastra/core": "1.26.0"
+    "vitest": "4.1.5",
+    "@internal/lint": "0.0.87",
+    "@internal/types-builder": "0.0.62",
+    "@internal/storage-test-utils": "0.0.83",
+    "@mastra/core": "1.29.0"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.0.0-0 <2.0.0-0"
@@ -62,7 +62,6 @@
     "posttest": "docker compose down",
     "lint": "eslint .",
     "build:lib": "tsup --silent --config tsup.config.ts",
-    "build:docs": "pnpx tsx ../../scripts/generate-package-docs.ts stores/redis",
     "build:watch": "tsup --watch --silent --config tsup.config.ts"
   }
 }