@shopify/shopify-app-session-storage-redis 1.0.2 → 1.1.1

package/build/cjs/migrations.js

@@ -3,15 +3,20 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var shopifyApi = require('@shopify/shopify-api');
+var shopifyAppSessionStorage = require('@shopify/shopify-app-session-storage');
+
+const migrationList = [new shopifyAppSessionStorage.MigrationOperation(
+// This migration name cannot be changed as it has already been released
+'migrateToVersion1_0_1', migrateAddShopKeyToTrackSessionsByShop)];
 
 // need to add shop keys with list of associated session keys to support
 // the new findSessionsByShop in v2.x.x
-async function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
+async function migrateAddShopKeyToTrackSessionsByShop(connection) {
   const shopsAndSessions = {};
-  const keys = await client.keys('*');
+  const keys = await connection.keys('*');
   for (const key of keys) {
-    if (key.startsWith(sessionKeyPrefix)) {
-      const session = shopifyApi.Session.fromPropertyArray(JSON.parse(await client.get(key)));
+    if (key.startsWith(connection.sessionStorageIdentifier)) {
+      const session = shopifyApi.Session.fromPropertyArray(JSON.parse(await connection.get(key, false)));
       if (!shopsAndSessions[session.shop]) {
         shopsAndSessions[session.shop] = [];
       }
@@ -20,8 +25,9 @@ async function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
   }
   // eslint-disable-next-line guard-for-in
   for (const shop in shopsAndSessions) {
-    await client.set(fullKey(shop), JSON.stringify(shopsAndSessions[shop]));
+    await connection.set(shop, JSON.stringify(shopsAndSessions[shop]));
   }
 }
 
-exports.migrateToVersion1_0_1 = migrateToVersion1_0_1;
+exports.migrateAddShopKeyToTrackSessionsByShop = migrateAddShopKeyToTrackSessionsByShop;
+exports.migrationList = migrationList;

package/build/cjs/redis-connection.js

@@ -0,0 +1,52 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var redis = require('redis');
+
+class RedisConnection {
+  constructor(dbUrl, options, keyPrefix, onError) {
+    this.sessionStorageIdentifier = void 0;
+    this.client = void 0;
+    this.init(dbUrl, options);
+    this.sessionStorageIdentifier = keyPrefix;
+    if (onError) {
+      this.client.on('error', onError);
+    }
+  }
+  query(_query, _params) {
+    throw new Error('Method not implemented. Use get(string, boolean) instead');
+  }
+  async connect() {
+    return this.client.connect();
+  }
+  async disconnect() {
+    await this.client.quit();
+  }
+  async keys(name) {
+    return this.client.keys(name);
+  }
+  async set(baseKey, value, addKeyPrefix = true) {
+    await this.client.set(this.buildKey(baseKey, addKeyPrefix), value);
+  }
+  async del(baseKey, addKeyPrefix = true) {
+    return this.client.del(this.buildKey(baseKey, addKeyPrefix));
+  }
+  async get(baseKey, addKeyPrefix = true) {
+    return this.client.get(this.buildKey(baseKey, addKeyPrefix));
+  }
+  generateFullKey(name) {
+    return `${this.sessionStorageIdentifier}_${name}`;
+  }
+  buildKey(baseKey, addKeyPrefix) {
+    return addKeyPrefix ? this.generateFullKey(baseKey) : baseKey;
+  }
+  init(dbUrl, options) {
+    this.client = redis.createClient({
+      ...options,
+      url: dbUrl
+    });
+  }
+}
+
+exports.RedisConnection = RedisConnection;

package/build/cjs/redis-migrator.js

@@ -0,0 +1,39 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var shopifyAppSessionStorage = require('@shopify/shopify-app-session-storage');
+
+class RedisSessionStorageMigrator extends shopifyAppSessionStorage.AbstractMigrationEngine {
+  constructor(dbConnection, opts = {}, migrations) {
+    // The name has already been decided whith the last migration
+    opts.migrationDBIdentifier = 'migrations';
+    super(dbConnection, opts, migrations);
+  }
+  async initMigrationPersistence() {
+    // nothing to do here
+    return Promise.resolve();
+  }
+  async hasMigrationBeenApplied(migrationName) {
+    var _migrations$get;
+    const migrations = await this.getMigrationRecords();
+    const found = (_migrations$get = migrations.get(migrationName)) !== null && _migrations$get !== void 0 ? _migrations$get : false;
+    return Promise.resolve(found);
+  }
+  async saveAppliedMigration(migrationName) {
+    const migrations = await this.getMigrationRecords();
+    migrations.set(migrationName, true);
+    this.connection.set(this.options.migrationDBIdentifier, JSON.stringify(Object.fromEntries(migrations)));
+    return Promise.resolve();
+  }
+  async getMigrationRecords() {
+    const migrationsRecord = await this.connection.get(this.options.migrationDBIdentifier);
+    let migrations = new Map();
+    if (migrationsRecord) {
+      migrations = new Map(Object.entries(JSON.parse(migrationsRecord)));
+    }
+    return Promise.resolve(migrations);
+  }
+}
+
+exports.RedisSessionStorageMigrator = RedisSessionStorageMigrator;

package/build/cjs/redis.js

@@ -2,40 +2,44 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var redis = require('redis');
 var shopifyApi = require('@shopify/shopify-api');
 var migrations = require('./migrations.js');
+var redisConnection = require('./redis-connection.js');
+var redisMigrator = require('./redis-migrator.js');
 
 const defaultRedisSessionStorageOptions = {
-  sessionKeyPrefix: 'shopify_sessions'
+  sessionKeyPrefix: 'shopify_sessions',
+  migratorOptions: {
+    migrationDBIdentifier: 'migrations'
+  }
 };
 class RedisSessionStorage {
   static withCredentials(host, db, username, password, opts) {
     return new RedisSessionStorage(new URL(`redis://${encodeURIComponent(username)}:${encodeURIComponent(password)}@${host}/${db}`), opts);
   }
   constructor(dbUrl, opts = {}) {
-    this.dbUrl = dbUrl;
     this.ready = void 0;
+    this.internalInit = void 0;
     this.options = void 0;
     this.client = void 0;
-    if (typeof this.dbUrl === 'string') {
-      this.dbUrl = new URL(this.dbUrl);
-    }
+    this.migrator = void 0;
     this.options = {
       ...defaultRedisSessionStorageOptions,
       ...opts
     };
-    this.ready = this.init();
+    this.internalInit = this.init(dbUrl.toString());
+    this.migrator = new redisMigrator.RedisSessionStorageMigrator(this.client, this.options.migratorOptions, migrations.migrationList);
+    this.ready = this.migrator.applyMigrations(this.internalInit);
   }
   async storeSession(session) {
     await this.ready;
-    await this.client.set(this.fullKey(session.id), JSON.stringify(session.toPropertyArray()));
+    await this.client.set(session.id, JSON.stringify(session.toPropertyArray()));
     await this.addKeyToShopList(session);
     return true;
   }
   async loadSession(id) {
     await this.ready;
-    let rawResult = await this.client.get(this.fullKey(id));
+    let rawResult = await this.client.get(id);
     if (!rawResult) return undefined;
     rawResult = JSON.parse(rawResult);
     return shopifyApi.Session.fromPropertyArray(rawResult);
@@ -45,7 +49,7 @@ class RedisSessionStorage {
     const session = await this.loadSession(id);
     if (session) {
       await this.removeKeyFromShopList(session.shop, id);
-      await this.client.del(this.fullKey(id));
+      await this.client.del(id);
     }
     return true;
   }
@@ -56,12 +60,12 @@ class RedisSessionStorage {
   }
   async findSessionsByShop(shop) {
     await this.ready;
-    const idKeysArrayString = await this.client.get(this.fullKey(shop));
+    const idKeysArrayString = await this.client.get(shop);
     if (!idKeysArrayString) return [];
     const idKeysArray = JSON.parse(idKeysArrayString);
     const results = [];
     for (const idKey of idKeysArray) {
-      const rawResult = await this.client.get(idKey);
+      const rawResult = await this.client.get(idKey, false);
       if (!rawResult) continue;
       const session = shopifyApi.Session.fromPropertyArray(JSON.parse(rawResult));
       results.push(session);
@@ -69,14 +73,11 @@ class RedisSessionStorage {
     return results;
   }
   async disconnect() {
-    await this.client.quit();
-  }
-  fullKey(name) {
-    return `${this.options.sessionKeyPrefix}_${name}`;
+    await this.client.disconnect();
   }
   async addKeyToShopList(session) {
-    const shopKey = this.fullKey(session.shop);
-    const idKey = this.fullKey(session.id);
+    const shopKey = session.shop;
+    const idKey = this.client.generateFullKey(session.id);
     const idKeysArrayString = await this.client.get(shopKey);
     if (idKeysArrayString) {
       const idKeysArray = JSON.parse(idKeysArrayString);
@@ -89,8 +90,8 @@ class RedisSessionStorage {
     }
   }
   async removeKeyFromShopList(shop, id) {
-    const shopKey = this.fullKey(shop);
-    const idKey = this.fullKey(id);
+    const shopKey = shop;
+    const idKey = this.client.generateFullKey(id);
     const idKeysArrayString = await this.client.get(shopKey);
     if (idKeysArrayString) {
       const idKeysArray = JSON.parse(idKeysArrayString);
@@ -101,28 +102,9 @@ class RedisSessionStorage {
       }
     }
   }
-  async init() {
-    this.client = redis.createClient({
-      ...this.options,
-      url: this.dbUrl.toString()
-    });
-    if (this.options.onError) {
-      this.client.on('error', this.options.onError);
-    }
+  async init(dbUrl) {
+    this.client = new redisConnection.RedisConnection(dbUrl, this.options, this.options.sessionKeyPrefix);
     await this.client.connect();
-    await this.migrate();
-  }
-  async migrate() {
-    const migrationsRecord = await this.client.get(this.fullKey('migrations'));
-    let migrations$1 = {};
-    if (migrationsRecord) {
-      migrations$1 = JSON.parse(migrationsRecord);
-    }
-    if (!migrations$1.migrateToVersion1_0_1) {
-      await migrations.migrateToVersion1_0_1(this.client, this.options.sessionKeyPrefix, this.fullKey.bind(this));
-      migrations$1.migrateToVersion1_0_1 = true;
-    }
-    await this.client.set(this.fullKey('migrations'), JSON.stringify(migrations$1));
   }
 }
 

package/build/ts/migrations.d.ts

@@ -1,5 +1,5 @@
-import { createClient } from 'redis';
-type RedisClient = ReturnType<typeof createClient>;
-export declare function migrateToVersion1_0_1(client: RedisClient, sessionKeyPrefix: string, fullKey: (name: string) => string): Promise<void>;
-export {};
+import { MigrationOperation } from '@shopify/shopify-app-session-storage';
+import { RedisConnection } from './redis-connection';
+export declare const migrationList: MigrationOperation[];
+export declare function migrateAddShopKeyToTrackSessionsByShop(connection: RedisConnection): Promise<void>;
 //# sourceMappingURL=migrations.d.ts.map

package/build/ts/migrations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../src/migrations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,OAAO,CAAC;AAGnC,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAInD,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,WAAW,EACnB,gBAAgB,EAAE,MAAM,EACxB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,iBAmBlC"}
+{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../../src/migrations.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,kBAAkB,EAAC,MAAM,sCAAsC,CAAC;AAExE,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAEnD,eAAO,MAAM,aAAa,sBAMzB,CAAC;AAIF,wBAAsB,sCAAsC,CAC1D,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/build/ts/migrations.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateToVersion1_0_1 = void 0;
+exports.migrateAddShopKeyToTrackSessionsByShop = exports.migrationList = void 0;
 var tslib_1 = require("tslib");
 var shopify_api_1 = require("@shopify/shopify-api");
+var shopify_app_session_storage_1 = require("@shopify/shopify-app-session-storage");
+exports.migrationList = [
+    new shopify_app_session_storage_1.MigrationOperation(
+    // This migration name cannot be changed as it has already been released
+    'migrateToVersion1_0_1', migrateAddShopKeyToTrackSessionsByShop),
+];
 // need to add shop keys with list of associated session keys to support
 // the new findSessionsByShop in v2.x.x
-function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
+function migrateAddShopKeyToTrackSessionsByShop(connection) {
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         var shopsAndSessions, keys, keys_1, keys_1_1, key, session, _a, _b, _c, _d, e_1_1, _e, _f, _g, _i, shop;
         var e_1, _h;
@@ -13,7 +19,7 @@ function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
             switch (_j.label) {
                 case 0:
                     shopsAndSessions = {};
-                    return [4 /*yield*/, client.keys('*')];
+                    return [4 /*yield*/, connection.keys('*')];
                 case 1:
                     keys = _j.sent();
                     _j.label = 2;
@@ -24,10 +30,10 @@ function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
                 case 3:
                     if (!!keys_1_1.done) return [3 /*break*/, 6];
                     key = keys_1_1.value;
-                    if (!key.startsWith(sessionKeyPrefix)) return [3 /*break*/, 5];
+                    if (!key.startsWith(connection.sessionStorageIdentifier)) return [3 /*break*/, 5];
                     _b = (_a = shopify_api_1.Session).fromPropertyArray;
                     _d = (_c = JSON).parse;
-                    return [4 /*yield*/, client.get(key)];
+                    return [4 /*yield*/, connection.get(key, false)];
                 case 4:
                     session = _b.apply(_a, [_d.apply(_c, [(_j.sent())])]);
                     if (!shopsAndSessions[session.shop]) {
@@ -61,7 +67,7 @@ function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
                     _g = _f[_i];
                     if (!(_g in _e)) return [3 /*break*/, 12];
                     shop = _g;
-                    return [4 /*yield*/, client.set(fullKey(shop), JSON.stringify(shopsAndSessions[shop]))];
+                    return [4 /*yield*/, connection.set(shop, JSON.stringify(shopsAndSessions[shop]))];
                 case 11:
                     _j.sent();
                     _j.label = 12;
@@ -73,5 +79,5 @@ function migrateToVersion1_0_1(client, sessionKeyPrefix, fullKey) {
         });
     });
 }
-exports.migrateToVersion1_0_1 = migrateToVersion1_0_1;
+exports.migrateAddShopKeyToTrackSessionsByShop = migrateAddShopKeyToTrackSessionsByShop;
 //# sourceMappingURL=migrations.js.map

package/build/ts/migrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/migrations.ts"],"names":[],"mappings":";;;;AACA,oDAA6C;AAI7C,wEAAwE;AACxE,uCAAuC;AACvC,SAAsB,qBAAqB,CACzC,MAAmB,EACnB,gBAAwB,EACxB,OAAiC;;;;;;;oBAE3B,gBAAgB,GAA8B,EAAE,CAAC;oBAC1C,qBAAM,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAA;;oBAA7B,IAAI,GAAG,SAAsB;;;;oBACjB,SAAA,iBAAA,IAAI,CAAA;;;;oBAAX,GAAG;yBACR,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAhC,wBAAgC;oBAClB,KAAA,CAAA,KAAA,qBAAO,CAAA,CAAC,iBAAiB,CAAA;oBACvC,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,KAAK,CAAA;oBAAE,qBAAM,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAA;;oBAD7B,OAAO,GAAG,cACd,cAAW,CAAC,SAAqB,CAAW,EAAC,EAC9C;oBACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;wBACnC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;qBACrC;oBACD,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;;;;;;;;;;;;;;;;yBAI1B,gBAAgB;;;;;;;;;;;oBACjC,qBAAM,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAA;;oBAAvE,SAAuE,CAAC;;;;;;;;;CAE3E;AAtBD,sDAsBC"}
+{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/migrations.ts"],"names":[],"mappings":";;;;AAAA,oDAA6C;AAC7C,oFAAwE;AAI3D,QAAA,aAAa,GAAG;IAC3B,IAAI,gDAAkB;IACpB,wEAAwE;IACxE,uBAAuB,EACvB,sCAAsC,CACvC;CACF,CAAC;AAEF,wEAAwE;AACxE,uCAAuC;AACvC,SAAsB,sCAAsC,CAC1D,UAA2B;;;;;;;oBAErB,gBAAgB,GAA8B,EAAE,CAAC;oBAC1C,qBAAM,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAA;;oBAAjC,IAAI,GAAG,SAA0B;;;;oBACrB,SAAA,iBAAA,IAAI,CAAA;;;;oBAAX,GAAG;yBACR,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,wBAAwB,CAAC,EAAnD,wBAAmD;oBACrC,KAAA,CAAA,KAAA,qBAAO,CAAA,CAAC,iBAAiB,CAAA;oBACvC,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,KAAK,CAAA;oBAAE,qBAAM,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,EAAA;;oBADxC,OAAO,GAAG,cACd,cAAW,CAAC,SAAgC,CAAW,EAAC,EACzD;oBACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;wBACnC,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;qBACrC;oBACD,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;;;;;;;;;;;;;;;;yBAI1B,gBAAgB;;;;;;;;;;;oBACjC,qBAAM,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAA;;oBAAlE,SAAkE,CAAC;;;;;;;;;CAEtE;AApBD,wFAoBC"}

package/build/ts/redis-connection.d.ts

@@ -0,0 +1,18 @@
+import { RedisClientOptions } from 'redis';
+import { DBConnection } from '@shopify/shopify-app-session-storage';
+export declare class RedisConnection implements DBConnection {
+    sessionStorageIdentifier: string;
+    private client;
+    constructor(dbUrl: string, options: RedisClientOptions, keyPrefix: string, onError?: (...args: any[]) => void);
+    query(_query: string, _params: any[]): Promise<any[]>;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    keys(name: string): Promise<any>;
+    set(baseKey: string, value: any, addKeyPrefix?: boolean): Promise<void>;
+    del(baseKey: string, addKeyPrefix?: boolean): Promise<any>;
+    get(baseKey: string, addKeyPrefix?: boolean): Promise<any>;
+    generateFullKey(name: string): string;
+    private buildKey;
+    private init;
+}
+//# sourceMappingURL=redis-connection.d.ts.map

package/build/ts/redis-connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-connection.d.ts","sourceRoot":"","sources":["../../src/redis-connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,kBAAkB,EAAC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAC,YAAY,EAAC,MAAM,sCAAsC,CAAC;AAIlE,qBAAa,eAAgB,YAAW,YAAY;IAClD,wBAAwB,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,MAAM,CAAc;gBAG1B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAUpC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAI/C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,UAAO;IAIpD,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvD,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7D,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAIrC,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,IAAI;CAMb"}

package/build/ts/redis-connection.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisConnection = void 0;
+var tslib_1 = require("tslib");
+var redis_1 = require("redis");
+var RedisConnection = /** @class */ (function () {
+    function RedisConnection(dbUrl, options, keyPrefix, onError) {
+        this.init(dbUrl, options);
+        this.sessionStorageIdentifier = keyPrefix;
+        if (onError) {
+            this.client.on('error', onError);
+        }
+    }
+    RedisConnection.prototype.query = function (_query, _params) {
+        throw new Error('Method not implemented. Use get(string, boolean) instead');
+    };
+    RedisConnection.prototype.connect = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.client.connect()];
+            });
+        });
+    };
+    RedisConnection.prototype.disconnect = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.quit()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RedisConnection.prototype.keys = function (name) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.client.keys(name)];
+            });
+        });
+    };
+    RedisConnection.prototype.set = function (baseKey, value, addKeyPrefix) {
+        if (addKeyPrefix === void 0) { addKeyPrefix = true; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.client.set(this.buildKey(baseKey, addKeyPrefix), value)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RedisConnection.prototype.del = function (baseKey, addKeyPrefix) {
+        if (addKeyPrefix === void 0) { addKeyPrefix = true; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.client.del(this.buildKey(baseKey, addKeyPrefix))];
+            });
+        });
+    };
+    RedisConnection.prototype.get = function (baseKey, addKeyPrefix) {
+        if (addKeyPrefix === void 0) { addKeyPrefix = true; }
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.client.get(this.buildKey(baseKey, addKeyPrefix))];
+            });
+        });
+    };
+    RedisConnection.prototype.generateFullKey = function (name) {
+        return "".concat(this.sessionStorageIdentifier, "_").concat(name);
+    };
+    RedisConnection.prototype.buildKey = function (baseKey, addKeyPrefix) {
+        return addKeyPrefix ? this.generateFullKey(baseKey) : baseKey;
+    };
+    RedisConnection.prototype.init = function (dbUrl, options) {
+        this.client = (0, redis_1.createClient)(tslib_1.__assign(tslib_1.__assign({}, options), { url: dbUrl }));
+    };
+    return RedisConnection;
+}());
+exports.RedisConnection = RedisConnection;
+//# sourceMappingURL=redis-connection.js.map

package/build/ts/redis-connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-connection.js","sourceRoot":"","sources":["../../src/redis-connection.ts"],"names":[],"mappings":";;;;AAAA,+BAAuD;AAKvD;IAIE,yBACE,KAAa,EACb,OAA2B,EAC3B,SAAiB,EACjB,OAAkC;QAElC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;QAE1C,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SAClC;IACH,CAAC;IAED,+BAAK,GAAL,UAAM,MAAc,EAAE,OAAc;QAClC,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IAEK,iCAAO,GAAb;;;gBACE,sBAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAC;;;KAC9B;IAEK,oCAAU,GAAhB;;;;4BACE,qBAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAA;;wBAAxB,SAAwB,CAAC;;;;;KAC1B;IAEK,8BAAI,GAAV,UAAW,IAAY;;;gBACrB,sBAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC;;;KAC/B;IAEK,6BAAG,GAAT,UAAU,OAAe,EAAE,KAAU,EAAE,YAAmB;QAAnB,6BAAA,EAAA,mBAAmB;;;;4BACxD,qBAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,KAAK,CAAC,EAAA;;wBAAlE,SAAkE,CAAC;;;;;KACpE;IAEK,6BAAG,GAAT,UAAU,OAAe,EAAE,YAAmB;QAAnB,6BAAA,EAAA,mBAAmB;;;gBAC5C,sBAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,EAAC;;;KAC9D;IAEK,6BAAG,GAAT,UAAU,OAAe,EAAE,YAAmB;QAAnB,6BAAA,EAAA,mBAAmB;;;gBAC5C,sBAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,EAAC;;;KAC9D;IAED,yCAAe,GAAf,UAAgB,IAAY;QAC1B,OAAO,UAAG,IAAI,CAAC,wBAAwB,cAAI,IAAI,CAAE,CAAC;IACpD,CAAC;IAEO,kCAAQ,GAAhB,UAAiB,OAAe,EAAE,YAAqB;QACrD,OAAO,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAChE,CAAC;IAEO,8BAAI,GAAZ,UAAa,KAAa,EAAE,OAA2B;QACrD,IAAI,CAAC,MAAM,GAAG,IAAA,oBAAY,wCACrB,OAAO,KACV,GAAG,EAAE,KAAK,IACV,CAAC;IACL,CAAC;IACH,sBAAC;AAAD,CAAC,AA5DD,IA4DC;AA5DY,0CAAe"}

package/build/ts/redis-migrator.d.ts

@@ -0,0 +1,10 @@
+import { AbstractMigrationEngine, SessionStorageMigratorOptions, MigrationOperation } from '@shopify/shopify-app-session-storage';
+import { RedisConnection } from './redis-connection';
+export declare class RedisSessionStorageMigrator extends AbstractMigrationEngine<RedisConnection, SessionStorageMigratorOptions> {
+    constructor(dbConnection: RedisConnection, opts: Partial<SessionStorageMigratorOptions> | undefined, migrations: MigrationOperation[]);
+    initMigrationPersistence(): Promise<void>;
+    hasMigrationBeenApplied(migrationName: string): Promise<boolean>;
+    saveAppliedMigration(migrationName: string): Promise<void>;
+    private getMigrationRecords;
+}
+//# sourceMappingURL=redis-migrator.d.ts.map

package/build/ts/redis-migrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-migrator.d.ts","sourceRoot":"","sources":["../../src/redis-migrator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,kBAAkB,EACnB,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAC,eAAe,EAAC,MAAM,oBAAoB,CAAC;AAEnD,qBAAa,2BAA4B,SAAQ,uBAAuB,CACtE,eAAe,EACf,6BAA6B,CAC9B;gBAEG,YAAY,EAAE,eAAe,EAC7B,IAAI,oDAA6C,EACjD,UAAU,EAAE,kBAAkB,EAAE;IAO5B,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAKzC,uBAAuB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOhE,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAYlD,mBAAmB;CAWlC"}

package/build/ts/redis-migrator.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisSessionStorageMigrator = void 0;
+var tslib_1 = require("tslib");
+var shopify_app_session_storage_1 = require("@shopify/shopify-app-session-storage");
+var RedisSessionStorageMigrator = /** @class */ (function (_super) {
+    tslib_1.__extends(RedisSessionStorageMigrator, _super);
+    function RedisSessionStorageMigrator(dbConnection, opts, migrations) {
+        if (opts === void 0) { opts = {}; }
+        // The name has already been decided whith the last migration
+        opts.migrationDBIdentifier = 'migrations';
+        return _super.call(this, dbConnection, opts, migrations) || this;
+    }
+    RedisSessionStorageMigrator.prototype.initMigrationPersistence = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                // nothing to do here
+                return [2 /*return*/, Promise.resolve()];
+            });
+        });
+    };
+    RedisSessionStorageMigrator.prototype.hasMigrationBeenApplied = function (migrationName) {
+        var _a;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var migrations, found;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.getMigrationRecords()];
+                    case 1:
+                        migrations = _b.sent();
+                        found = (_a = migrations.get(migrationName)) !== null && _a !== void 0 ? _a : false;
+                        return [2 /*return*/, Promise.resolve(found)];
+                }
+            });
+        });
+    };
+    RedisSessionStorageMigrator.prototype.saveAppliedMigration = function (migrationName) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var migrations;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getMigrationRecords()];
+                    case 1:
+                        migrations = _a.sent();
+                        migrations.set(migrationName, true);
+                        this.connection.set(this.options.migrationDBIdentifier, JSON.stringify(Object.fromEntries(migrations)));
+                        return [2 /*return*/, Promise.resolve()];
+                }
+            });
+        });
+    };
+    RedisSessionStorageMigrator.prototype.getMigrationRecords = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var migrationsRecord, migrations;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.connection.get(this.options.migrationDBIdentifier)];
+                    case 1:
+                        migrationsRecord = _a.sent();
+                        migrations = new Map();
+                        if (migrationsRecord) {
+                            migrations = new Map(Object.entries(JSON.parse(migrationsRecord)));
+                        }
+                        return [2 /*return*/, Promise.resolve(migrations)];
+                }
+            });
+        });
+    };
+    return RedisSessionStorageMigrator;
+}(shopify_app_session_storage_1.AbstractMigrationEngine));
+exports.RedisSessionStorageMigrator = RedisSessionStorageMigrator;
+//# sourceMappingURL=redis-migrator.js.map

package/build/ts/redis-migrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-migrator.js","sourceRoot":"","sources":["../../src/redis-migrator.ts"],"names":[],"mappings":";;;;AAAA,oFAI8C;AAI9C;IAAiD,uDAGhD;IACC,qCACE,YAA6B,EAC7B,IAAiD,EACjD,UAAgC;QADhC,qBAAA,EAAA,SAAiD;QAGjD,6DAA6D;QAC7D,IAAI,CAAC,qBAAqB,GAAG,YAAY,CAAC;eAC1C,kBAAM,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC;IACvC,CAAC;IAEK,8DAAwB,GAA9B;;;gBACE,qBAAqB;gBACrB,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;KAC1B;IAEK,6DAAuB,GAA7B,UAA8B,aAAqB;;;;;;4BAC9B,qBAAM,IAAI,CAAC,mBAAmB,EAAE,EAAA;;wBAA7C,UAAU,GAAG,SAAgC;wBAC7C,KAAK,GAAG,MAAA,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,mCAAI,KAAK,CAAC;wBAErD,sBAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAC;;;;KAC/B;IAEK,0DAAoB,GAA1B,UAA2B,aAAqB;;;;;4BAC3B,qBAAM,IAAI,CAAC,mBAAmB,EAAE,EAAA;;wBAA7C,UAAU,GAAG,SAAgC;wBACnD,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;wBAEpC,IAAI,CAAC,UAAU,CAAC,GAAG,CACjB,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAClC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAC/C,CAAC;wBAEF,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;KAC1B;IAEa,yDAAmB,GAAjC;;;;;4BAC2B,qBAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAChD,IAAI,CAAC,OAAO,CAAC,qBAAqB,CACnC,EAAA;;wBAFK,gBAAgB,GAAG,SAExB;wBACG,UAAU,GAAyB,IAAI,GAAG,EAAE,CAAC;wBACjD,IAAI,gBAAgB,EAAE;4BACpB,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;yBACpE;wBAED,sBAAO,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAC;;;;KACpC;IACH,kCAAC;AAAD,CAAC,AAjDD,CAAiD,qDAAuB,GAiDvE;AAjDY,kEAA2B"}

package/build/ts/redis.d.ts

@@ -1,16 +1,18 @@
 import { RedisClientOptions } from 'redis';
 import { Session } from '@shopify/shopify-api';
-import { SessionStorage } from '@shopify/shopify-app-session-storage';
+import { SessionStorage, SessionStorageMigratorOptions } from '@shopify/shopify-app-session-storage';
 export interface RedisSessionStorageOptions extends RedisClientOptions {
     sessionKeyPrefix: string;
     onError?: (...args: any[]) => void;
+    migratorOptions?: SessionStorageMigratorOptions;
 }
 export declare class RedisSessionStorage implements SessionStorage {
-    private dbUrl;
     static withCredentials(host: string, db: number, username: string, password: string, opts: Partial<RedisSessionStorageOptions>): RedisSessionStorage;
     readonly ready: Promise<void>;
+    private internalInit;
     private options;
     private client;
+    private migrator;
     constructor(dbUrl: URL, opts?: Partial<RedisSessionStorageOptions>);
     storeSession(session: Session): Promise<boolean>;
     loadSession(id: string): Promise<Session | undefined>;
@@ -18,10 +20,8 @@ export declare class RedisSessionStorage implements SessionStorage {
     deleteSessions(ids: string[]): Promise<boolean>;
     findSessionsByShop(shop: string): Promise<Session[]>;
     disconnect(): Promise<void>;
-    private fullKey;
     private addKeyToShopList;
     private removeKeyFromShopList;
     private init;
-    private migrate;
 }
 //# sourceMappingURL=redis.d.ts.map

package/build/ts/redis.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,kBAAkB,EAAC,MAAM,OAAO,CAAC;AACvD,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAKpE,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CACpC;AAKD,qBAAa,mBAAoB,YAAW,cAAc;IAuBtD,OAAO,CAAC,KAAK;IAtBf,MAAM,CAAC,eAAe,CACpB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAY3C,SAAgB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,MAAM,CAAc;gBAGlB,KAAK,EAAE,GAAG,EAClB,IAAI,GAAE,OAAO,CAAC,0BAA0B,CAAM;IASnC,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAWhD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAWrD,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU3C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAmBpD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,OAAO,CAAC,OAAO;YAID,gBAAgB;YAiBhB,qBAAqB;YAgBrB,IAAI;YAYJ,OAAO;CAmBtB"}
+{"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/redis.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,6BAA6B,EAE9B,MAAM,sCAAsC,CAAC;AAM9C,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IACnC,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD;AAQD,qBAAa,mBAAoB,YAAW,cAAc;IACxD,MAAM,CAAC,eAAe,CACpB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAY3C,SAAgB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,QAAQ,CAAyB;gBAE7B,KAAK,EAAE,GAAG,EAAE,IAAI,GAAE,OAAO,CAAC,0BAA0B,CAAM;IAWzD,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAWhD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAWrD,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAU3C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAmBpD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;YAI1B,gBAAgB;YAiBhB,qBAAqB;YAgBrB,IAAI;CAQnB"}