@shopify/shopify-app-session-storage 0.0.0-experimental-20240118200208

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Session Storage
+
+This folder contains the `SessionStorage` interface that the individual [packages](../) for most common databases implement.
+
+See the [`session-storage.ts`](./src/types.ts) file for the methods that need to be implemented, the params they accept and values they return.

package/build/cjs/abstract-migration-engine.js

@@ -0,0 +1,41 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var types = require('./types.js');
+
+class AbstractMigrationEngine {
+  constructor(db, opts = {}, migrations) {
+    this.options = void 0;
+    this.connection = void 0;
+    this.ready = void 0;
+    this.migrations = void 0;
+    this.options = {
+      ...types.defaultSessionStorageMigratorOptions,
+      ...opts
+    };
+    this.connection = db;
+    this.migrations = migrations;
+    this.ready = this.initMigrationPersistence();
+  }
+  async applyMigrations(databaseReady) {
+    await databaseReady;
+    await this.ready;
+    for (const {
+      migrationName,
+      migrationFunction
+    } of this.getMigrationList()) {
+      const migrationApplied = await this.hasMigrationBeenApplied(migrationName);
+      if (!migrationApplied) {
+        await migrationFunction(this.connection);
+        await this.saveAppliedMigration(migrationName);
+      }
+    }
+    return Promise.resolve();
+  }
+  getMigrationList() {
+    return this.migrations;
+  }
+}
+
+exports.AbstractMigrationEngine = AbstractMigrationEngine;

package/build/cjs/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var types = require('./types.js');
+var rdbmsSessionStorageMigrator = require('./rdbms-session-storage-migrator.js');
+var abstractMigrationEngine = require('./abstract-migration-engine.js');
+
+
+
+exports.MigrationOperation = types.MigrationOperation;
+exports.defaultRdbmsSessionStorageMigratorOptions = types.defaultRdbmsSessionStorageMigratorOptions;
+exports.defaultSessionStorageMigratorOptions = types.defaultSessionStorageMigratorOptions;
+exports.RdbmsSessionStorageMigrator = rdbmsSessionStorageMigrator.RdbmsSessionStorageMigrator;
+exports.AbstractMigrationEngine = abstractMigrationEngine.AbstractMigrationEngine;

package/build/cjs/rdbms-session-storage-migrator.js

@@ -0,0 +1,38 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var abstractMigrationEngine = require('./abstract-migration-engine.js');
+var types = require('./types.js');
+
+class RdbmsSessionStorageMigrator extends abstractMigrationEngine.AbstractMigrationEngine {
+  constructor(dbConnection, opts = {}, migrations) {
+    super(dbConnection, {
+      ...types.defaultRdbmsSessionStorageMigratorOptions,
+      ...opts
+    }, migrations);
+  }
+  async hasMigrationBeenApplied(migrationName) {
+    await this.ready;
+    const query = `
+      SELECT * FROM ${this.options.migrationDBIdentifier}
+      WHERE ${this.getOptions().migrationNameColumnName} = 
+        ${this.connection.getArgumentPlaceholder(1)};
+    `;
+    const rows = await this.connection.query(query, [migrationName]);
+    return rows.length === 1;
+  }
+  async saveAppliedMigration(migrationName) {
+    await this.ready;
+    const insert = `
+          INSERT INTO ${this.options.migrationDBIdentifier} (${this.getOptions().migrationNameColumnName})
+          VALUES(${this.connection.getArgumentPlaceholder(1)});
+        `;
+    await this.connection.query(insert, [migrationName]);
+  }
+  getOptions() {
+    return this.options;
+  }
+}
+
+exports.RdbmsSessionStorageMigrator = RdbmsSessionStorageMigrator;

package/build/cjs/types.js

@@ -0,0 +1,58 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * Defines the strategy to be used to store sessions for the Shopify App.
+ */
+
+/**
+ * define the option required to instantiate an RDBMS session storage implementation
+ */
+
+/**
+ * Define a common way for migrator to execute query on the underlying persistence layer
+ */
+
+/**
+ * This is for the use cases of the RDBMS database where
+ */
+
+/**
+ * Each migration 'migration_name' will be define the following way.
+ * Via a function that receive the engine in parameter.
+ */
+
+/**
+ * Defines what is needed for a migration to be execute
+ */
+class MigrationOperation {
+  constructor(migrationName, migrationFunction) {
+    /** Name of the migration that will be used to uniquely identity it among all other migration */
+    this.migrationName = void 0;
+    /** The actual migration function that will modify the perisitence storage */
+    this.migrationFunction = void 0;
+    this.migrationName = migrationName;
+    this.migrationFunction = migrationFunction;
+  }
+}
+
+/**
+ * Defines how database migration will be handled.
+ */
+
+/**
+ * Use to initialise session storage migrators
+ */
+
+const defaultSessionStorageMigratorOptions = {
+  migrationDBIdentifier: 'shopify_sessions_migrations'
+};
+const defaultRdbmsSessionStorageMigratorOptions = {
+  migrationDBIdentifier: 'shopify_sessions_migrations',
+  migrationNameColumnName: 'migration_name'
+};
+
+exports.MigrationOperation = MigrationOperation;
+exports.defaultRdbmsSessionStorageMigratorOptions = defaultRdbmsSessionStorageMigratorOptions;
+exports.defaultSessionStorageMigratorOptions = defaultSessionStorageMigratorOptions;

package/build/ts/abstract-migration-engine.d.ts

@@ -0,0 +1,14 @@
+import { MigrationOperation, SessionStorageMigrator, SessionStorageMigratorOptions, DBConnection } from './types';
+export declare abstract class AbstractMigrationEngine<ConnectionType extends DBConnection, MigratorOptionType extends SessionStorageMigratorOptions> implements SessionStorageMigrator {
+    protected options: SessionStorageMigratorOptions;
+    protected connection: ConnectionType;
+    protected ready: Promise<void>;
+    protected migrations: MigrationOperation[];
+    constructor(db: ConnectionType, opts: Partial<MigratorOptionType> | undefined, migrations: MigrationOperation[]);
+    applyMigrations(databaseReady: Promise<void>): Promise<void>;
+    getMigrationList(): MigrationOperation[];
+    abstract initMigrationPersistence(): Promise<void>;
+    abstract hasMigrationBeenApplied(migrationName: string): Promise<boolean>;
+    abstract saveAppliedMigration(migrationName: string): Promise<void>;
+}
+//# sourceMappingURL=abstract-migration-engine.d.ts.map

package/build/ts/abstract-migration-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-migration-engine.d.ts","sourceRoot":"","sources":["../../src/abstract-migration-engine.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,6BAA6B,EAE7B,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,8BAAsB,uBAAuB,CAC3C,cAAc,SAAS,YAAY,EACnC,kBAAkB,SAAS,6BAA6B,CACxD,YAAW,sBAAsB;IAEjC,SAAS,CAAC,OAAO,EAAE,6BAA6B,CAAC;IACjD,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;IACrC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,SAAS,CAAC,UAAU,EAAE,kBAAkB,EAAE,CAAC;gBAGzC,EAAE,EAAE,cAAc,EAClB,IAAI,yCAAkC,EACtC,UAAU,EAAE,kBAAkB,EAAE;IAS5B,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBlE,gBAAgB,IAAI,kBAAkB,EAAE;IAIxC,QAAQ,CAAC,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;IAClD,QAAQ,CAAC,uBAAuB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IACzE,QAAQ,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CACpE"}

package/build/ts/abstract-migration-engine.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractMigrationEngine = void 0;
+var tslib_1 = require("tslib");
+var types_1 = require("./types");
+var AbstractMigrationEngine = /** @class */ (function () {
+    function AbstractMigrationEngine(db, opts, migrations) {
+        if (opts === void 0) { opts = {}; }
+        this.options = tslib_1.__assign(tslib_1.__assign({}, types_1.defaultSessionStorageMigratorOptions), opts);
+        this.connection = db;
+        this.migrations = migrations;
+        this.ready = this.initMigrationPersistence();
+    }
+    AbstractMigrationEngine.prototype.applyMigrations = function (databaseReady) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _a, _b, _c, migrationName, migrationFunction, migrationApplied, e_1_1;
+            var e_1, _d;
+            return tslib_1.__generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0: return [4 /*yield*/, databaseReady];
+                    case 1:
+                        _e.sent();
+                        return [4 /*yield*/, this.ready];
+                    case 2:
+                        _e.sent();
+                        _e.label = 3;
+                    case 3:
+                        _e.trys.push([3, 10, 11, 12]);
+                        _a = tslib_1.__values(this.getMigrationList()), _b = _a.next();
+                        _e.label = 4;
+                    case 4:
+                        if (!!_b.done) return [3 /*break*/, 9];
+                        _c = _b.value, migrationName = _c.migrationName, migrationFunction = _c.migrationFunction;
+                        return [4 /*yield*/, this.hasMigrationBeenApplied(migrationName)];
+                    case 5:
+                        migrationApplied = _e.sent();
+                        if (!!migrationApplied) return [3 /*break*/, 8];
+                        return [4 /*yield*/, migrationFunction(this.connection)];
+                    case 6:
+                        _e.sent();
+                        return [4 /*yield*/, this.saveAppliedMigration(migrationName)];
+                    case 7:
+                        _e.sent();
+                        _e.label = 8;
+                    case 8:
+                        _b = _a.next();
+                        return [3 /*break*/, 4];
+                    case 9: return [3 /*break*/, 12];
+                    case 10:
+                        e_1_1 = _e.sent();
+                        e_1 = { error: e_1_1 };
+                        return [3 /*break*/, 12];
+                    case 11:
+                        try {
+                            if (_b && !_b.done && (_d = _a.return)) _d.call(_a);
+                        }
+                        finally { if (e_1) throw e_1.error; }
+                        return [7 /*endfinally*/];
+                    case 12: return [2 /*return*/, Promise.resolve()];
+                }
+            });
+        });
+    };
+    AbstractMigrationEngine.prototype.getMigrationList = function () {
+        return this.migrations;
+    };
+    return AbstractMigrationEngine;
+}());
+exports.AbstractMigrationEngine = AbstractMigrationEngine;
+//# sourceMappingURL=abstract-migration-engine.js.map

package/build/ts/abstract-migration-engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-migration-engine.js","sourceRoot":"","sources":["../../src/abstract-migration-engine.ts"],"names":[],"mappings":";;;;AAAA,iCAMiB;AAEjB;IAUE,iCACE,EAAkB,EAClB,IAAsC,EACtC,UAAgC;QADhC,qBAAA,EAAA,SAAsC;QAGtC,IAAI,CAAC,OAAO,yCAAO,4CAAoC,GAAK,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAC/C,CAAC;IAEK,iDAAe,GAArB,UAAsB,aAA4B;;;;;;4BAChD,qBAAM,aAAa,EAAA;;wBAAnB,SAAmB,CAAC;wBACpB,qBAAM,IAAI,CAAC,KAAK,EAAA;;wBAAhB,SAAgB,CAAC;;;;wBAEgC,KAAA,iBAAA,IAAI,CAAC,gBAAgB,EAAE,CAAA;;;;wBAA7D,aAAkC,EAAjC,aAAa,mBAAA,EAAE,iBAAiB,uBAAA;wBACjB,qBAAM,IAAI,CAAC,uBAAuB,CACzD,aAAa,CACd,EAAA;;wBAFK,gBAAgB,GAAG,SAExB;6BACG,CAAC,gBAAgB,EAAjB,wBAAiB;wBACnB,qBAAM,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAA;;wBAAxC,SAAwC,CAAC;wBACzC,qBAAM,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,EAAA;;wBAA9C,SAA8C,CAAC;;;;;;;;;;;;;;;;6BAGnD,sBAAO,OAAO,CAAC,OAAO,EAAE,EAAC;;;;KAC1B;IAED,kDAAgB,GAAhB;QACE,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAKH,8BAAC;AAAD,CAAC,AA7CD,IA6CC;AA7CqB,0DAAuB"}

package/build/ts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './rdbms-session-storage-migrator';
+export * from './abstract-migration-engine';
+//# sourceMappingURL=index.d.ts.map

package/build/ts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC"}

package/build/ts/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./rdbms-session-storage-migrator"), exports);
+tslib_1.__exportStar(require("./abstract-migration-engine"), exports);
+//# sourceMappingURL=index.js.map

package/build/ts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,2EAAiD;AACjD,sEAA4C"}

package/build/ts/rdbms-session-storage-migrator.d.ts

@@ -0,0 +1,10 @@
+import { AbstractMigrationEngine } from './abstract-migration-engine';
+import { RdbmsSessionStorageMigratorOptions, RdbmsConnection, MigrationOperation } from './types';
+export declare abstract class RdbmsSessionStorageMigrator extends AbstractMigrationEngine<RdbmsConnection, RdbmsSessionStorageMigratorOptions> {
+    constructor(dbConnection: RdbmsConnection, opts: Partial<RdbmsSessionStorageMigratorOptions> | undefined, migrations: MigrationOperation[]);
+    hasMigrationBeenApplied(migrationName: string): Promise<boolean>;
+    saveAppliedMigration(migrationName: string): Promise<void>;
+    getOptions(): RdbmsSessionStorageMigratorOptions;
+    abstract initMigrationPersistence(): Promise<void>;
+}
+//# sourceMappingURL=rdbms-session-storage-migrator.d.ts.map

package/build/ts/rdbms-session-storage-migrator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rdbms-session-storage-migrator.d.ts","sourceRoot":"","sources":["../../src/rdbms-session-storage-migrator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACL,kCAAkC,EAElC,eAAe,EACf,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAEjB,8BAAsB,2BAA4B,SAAQ,uBAAuB,CAC/E,eAAe,EACf,kCAAkC,CACnC;gBAEG,YAAY,EAAE,eAAe,EAC7B,IAAI,yDAAkD,EACtD,UAAU,EAAE,kBAAkB,EAAE;IAY5B,uBAAuB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAahE,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAazD,UAAU,IAAI,kCAAkC;IAIvD,QAAQ,CAAC,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;CACnD"}

package/build/ts/rdbms-session-storage-migrator.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RdbmsSessionStorageMigrator = void 0;
+var tslib_1 = require("tslib");
+var abstract_migration_engine_1 = require("./abstract-migration-engine");
+var types_1 = require("./types");
+var RdbmsSessionStorageMigrator = /** @class */ (function (_super) {
+    tslib_1.__extends(RdbmsSessionStorageMigrator, _super);
+    function RdbmsSessionStorageMigrator(dbConnection, opts, migrations) {
+        if (opts === void 0) { opts = {}; }
+        return _super.call(this, dbConnection, tslib_1.__assign(tslib_1.__assign({}, types_1.defaultRdbmsSessionStorageMigratorOptions), opts), migrations) || this;
+    }
+    RdbmsSessionStorageMigrator.prototype.hasMigrationBeenApplied = function (migrationName) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var query, rows;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.ready];
+                    case 1:
+                        _a.sent();
+                        query = "\n      SELECT * FROM ".concat(this.options.migrationDBIdentifier, "\n      WHERE ").concat(this.getOptions().migrationNameColumnName, " = \n        ").concat(this.connection.getArgumentPlaceholder(1), ";\n    ");
+                        return [4 /*yield*/, this.connection.query(query, [migrationName])];
+                    case 2:
+                        rows = _a.sent();
+                        return [2 /*return*/, rows.length === 1];
+                }
+            });
+        });
+    };
+    RdbmsSessionStorageMigrator.prototype.saveAppliedMigration = function (migrationName) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var insert;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.ready];
+                    case 1:
+                        _a.sent();
+                        insert = "\n          INSERT INTO ".concat(this.options.migrationDBIdentifier, " (").concat(this.getOptions().migrationNameColumnName, ")\n          VALUES(").concat(this.connection.getArgumentPlaceholder(1), ");\n        ");
+                        return [4 /*yield*/, this.connection.query(insert, [migrationName])];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RdbmsSessionStorageMigrator.prototype.getOptions = function () {
+        return this.options;
+    };
+    return RdbmsSessionStorageMigrator;
+}(abstract_migration_engine_1.AbstractMigrationEngine));
+exports.RdbmsSessionStorageMigrator = RdbmsSessionStorageMigrator;
+//# sourceMappingURL=rdbms-session-storage-migrator.js.map

package/build/ts/rdbms-session-storage-migrator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rdbms-session-storage-migrator.js","sourceRoot":"","sources":["../../src/rdbms-session-storage-migrator.ts"],"names":[],"mappings":";;;;AAAA,yEAAoE;AACpE,iCAKiB;AAEjB;IAA0D,uDAGzD;IACC,qCACE,YAA6B,EAC7B,IAAsD,EACtD,UAAgC;QADhC,qBAAA,EAAA,SAAsD;eAGtD,kBACE,YAAY,wCAEP,iDAAyC,GACzC,IAAI,GAET,UAAU,CACX;IACH,CAAC;IAEK,6DAAuB,GAA7B,UAA8B,aAAqB;;;;;4BACjD,qBAAM,IAAI,CAAC,KAAK,EAAA;;wBAAhB,SAAgB,CAAC;wBAEX,KAAK,GAAG,gCACI,IAAI,CAAC,OAAO,CAAC,qBAAqB,2BAC1C,IAAI,CAAC,UAAU,EAAE,CAAC,uBAAuB,0BAC7C,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,YAC9C,CAAC;wBAEW,qBAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,aAAa,CAAC,CAAC,EAAA;;wBAA1D,IAAI,GAAG,SAAmD;wBAChE,sBAAO,IAAI,CAAC,MAAM,KAAK,CAAC,EAAC;;;;KAC1B;IAEK,0DAAoB,GAA1B,UAA2B,aAAqB;;;;;4BAC9C,qBAAM,IAAI,CAAC,KAAK,EAAA;;wBAAhB,SAAgB,CAAC;wBAEX,MAAM,GAAG,kCACK,IAAI,CAAC,OAAO,CAAC,qBAAqB,eACpD,IAAI,CAAC,UAAU,EAAE,CAAC,uBAAuB,iCAE5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,iBACnD,CAAC;wBAEN,qBAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,aAAa,CAAC,CAAC,EAAA;;wBAApD,SAAoD,CAAC;;;;;KACtD;IAEM,gDAAU,GAAjB;QACE,OAAO,IAAI,CAAC,OAA6C,CAAC;IAC5D,CAAC;IAGH,kCAAC;AAAD,CAAC,AAlDD,CAA0D,mDAAuB,GAkDhF;AAlDqB,kEAA2B"}

package/build/ts/types.d.ts

@@ -0,0 +1,139 @@
+import { Session } from '@shopify/shopify-api';
+/**
+ * Defines the strategy to be used to store sessions for the Shopify App.
+ */
+export interface SessionStorage {
+    /**
+     * Creates or updates the given session in storage.
+     *
+     * @param session Session to store
+     */
+    storeSession(session: Session): Promise<boolean>;
+    /**
+     * Loads a session from storage.
+     *
+     * @param id Id of the session to load
+     */
+    loadSession(id: string): Promise<Session | undefined>;
+    /**
+     * Deletes a session from storage.
+     *
+     * @param id Id of the session to delete
+     */
+    deleteSession(id: string): Promise<boolean>;
+    /**
+     * Deletes an array of sessions from storage.
+     *
+     * @param ids Array of session id's to delete
+     */
+    deleteSessions(ids: string[]): Promise<boolean>;
+    /**
+     * Return an array of sessions for a given shop (or [] if none found).
+     *
+     * @param shop shop of the session(s) to return
+     */
+    findSessionsByShop(shop: string): Promise<Session[]>;
+}
+/**
+ * define the option required to instantiate an RDBMS session storage implementation
+ */
+export interface RdbmsSessionStorageOptions {
+    sessionTableName: string;
+    migratorOptions?: RdbmsSessionStorageMigratorOptions;
+}
+/**
+ * Define a common way for migrator to execute query on the underlying persistence layer
+ */
+export interface DBConnection {
+    /** the table used to store sessions */
+    sessionStorageIdentifier: string;
+    /**
+     * Initiate the actual connection to the underlying database
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the underlying database
+     */
+    disconnect(): Promise<void>;
+}
+/**
+ * This is for the use cases of the RDBMS database where
+ */
+export interface RdbmsConnection extends DBConnection {
+    /**
+     * Make a query to the underlying DB
+     * @param query - the query to execute
+     * @param params - the parameters required by the query
+     */
+    query(query: string, params: any[]): Promise<any[]>;
+    /**
+     * Determine if a table exist
+     * @param tablename - the table to search
+     */
+    hasTable(tablename: string): Promise<boolean>;
+    /**
+     * Based on the the #sqlArgumentPlaceholder value and the underlying engine, return the place holder for a given position in a list of sql argument
+     * @param position the position of the given sql argument
+     */
+    getArgumentPlaceholder(position?: number): string;
+}
+/**
+ * Each migration 'migration_name' will be define the following way.
+ * Via a function that receive the engine in parameter.
+ */
+export type MigrationFunction = (engine: DBConnection) => Promise<void>;
+/**
+ * Defines what is needed for a migration to be execute
+ */
+export declare class MigrationOperation {
+    /** Name of the migration that will be used to uniquely identity it among all other migration */
+    migrationName: string;
+    /** The actual migration function that will modify the perisitence storage */
+    migrationFunction: MigrationFunction;
+    constructor(migrationName: string, migrationFunction: MigrationFunction);
+}
+/**
+ * Defines how database migration will be handled.
+ */
+export interface SessionStorageMigrator {
+    /**
+     * Should ensure that the persistence 'table' is created if it does not exist yet.
+     */
+    initMigrationPersistence(): Promise<void>;
+    /**
+     * Returns true if the migrationName as already been applied and
+     * therefore the migrator should not apply it. if false,
+     * the migrator will run the associated migration
+     * @param migrationName the unique version name to look for in the migration table
+     */
+    hasMigrationBeenApplied(migrationName: string): Promise<boolean>;
+    /**
+     * Will persist that this migrationName has been applied in the migration table
+     * @param migrationName the version to persisited as applied
+     */
+    saveAppliedMigration(migrationName: string): Promise<void>;
+    /**
+     * Return a list MigrationOperation that needs to be executed
+     */
+    getMigrationList(): MigrationOperation[];
+    /**
+     * Will iterate over the map returned by #getmigrationList,
+     * for each entry call #hasMigrationBeenApplied, if it returns false
+     * it will execute execute the function and then call #saveAppliedMigration
+     * @param databaseReady - so that the migrator can wait for the database to fully up and running
+     * before starting its execution.
+     */
+    applyMigrations(databaseReady: Promise<void>): Promise<void>;
+}
+/**
+ * Use to initialise session storage migrators
+ */
+export interface SessionStorageMigratorOptions {
+    migrationDBIdentifier: string;
+}
+export declare const defaultSessionStorageMigratorOptions: SessionStorageMigratorOptions;
+export interface RdbmsSessionStorageMigratorOptions extends SessionStorageMigratorOptions {
+    migrationNameColumnName: string;
+}
+export declare const defaultRdbmsSessionStorageMigratorOptions: RdbmsSessionStorageMigratorOptions;
+//# sourceMappingURL=types.d.ts.map

package/build/ts/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAEtD;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhD;;;;OAIG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,kCAAkC,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEpD;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9C;;;OAGG;IACH,sBAAsB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAExE;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,gGAAgG;IAChG,aAAa,EAAE,MAAM,CAAC;IAEtB,6EAA6E;IAC7E,iBAAiB,EAAE,iBAAiB,CAAC;gBAEzB,aAAa,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;CAIxE;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,uBAAuB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjE;;;OAGG;IACH,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;OAEG;IACH,gBAAgB,IAAI,kBAAkB,EAAE,CAAC;IAEzC;;;;;;OAMG;IACH,eAAe,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAED,eAAO,MAAM,oCAAoC,EAAE,6BAGhD,CAAC;AAEJ,MAAM,WAAW,kCACf,SAAQ,6BAA6B;IACrC,uBAAuB,EAAE,MAAM,CAAC;CACjC;AAED,eAAO,MAAM,yCAAyC,EAAE,kCAIrD,CAAC"}

package/build/ts/types.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultRdbmsSessionStorageMigratorOptions = exports.defaultSessionStorageMigratorOptions = exports.MigrationOperation = void 0;
+/**
+ * Defines what is needed for a migration to be execute
+ */
+var MigrationOperation = /** @class */ (function () {
+    function MigrationOperation(migrationName, migrationFunction) {
+        this.migrationName = migrationName;
+        this.migrationFunction = migrationFunction;
+    }
+    return MigrationOperation;
+}());
+exports.MigrationOperation = MigrationOperation;
+exports.defaultSessionStorageMigratorOptions = {
+    migrationDBIdentifier: 'shopify_sessions_migrations',
+};
+exports.defaultRdbmsSessionStorageMigratorOptions = {
+    migrationDBIdentifier: 'shopify_sessions_migrations',
+    migrationNameColumnName: 'migration_name',
+};
+//# sourceMappingURL=types.js.map

package/build/ts/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";;;AAkGA;;GAEG;AACH;IAOE,4BAAY,aAAqB,EAAE,iBAAoC;QACrE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IACH,yBAAC;AAAD,CAAC,AAXD,IAWC;AAXY,gDAAkB;AA0DlB,QAAA,oCAAoC,GAC/C;IACE,qBAAqB,EAAE,6BAA6B;CACrD,CAAC;AAOS,QAAA,yCAAyC,GACpD;IACE,qBAAqB,EAAE,6BAA6B;IACpD,uBAAuB,EAAE,gBAAgB;CAC1C,CAAC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@shopify/shopify-app-session-storage",
+  "version": "0.0.0-experimental-20240118200208",
+  "description": "Shopify App Session Storage - abstract class",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Shopify/shopify-app-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Shopify/shopify-app-js/issues"
+  },
+  "homepage": "https://github.com/Shopify/shopify-app-js/tree/main/packages/shopify-app-session-storage",
+  "author": "Shopify Inc.",
+  "license": "MIT",
+  "main": "./build/cjs/index.js",
+  "types": "./build/ts/index.d.ts",
+  "scripts": {},
+  "publishConfig": {
+    "access": "public",
+    "@shopify:registry": "https://registry.npmjs.org"
+  },
+  "keywords": [
+    "shopify",
+    "node",
+    "app",
+    "graphql",
+    "rest",
+    "webhook",
+    "Admin API",
+    "Storefront API",
+    "session storage"
+  ],
+  "dependencies": {
+    "tslib": "^2.6.2"
+  },
+  "peerDependencies": {
+    "@shopify/shopify-api": "^9.0.2"
+  },
+  "devDependencies": {
+    "@shopify/eslint-plugin": "^42.1.0",
+    "@shopify/prettier-config": "^1.1.2",
+    "@types/jest": "^29.5.1",
+    "eslint": "^8.55.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.8.8",
+    "typescript": "^4.9.5"
+  },
+  "files": [
+    "build/*",
+    "!bundle/*",
+    "!tsconfig.tsbuildinfo",
+    "!node_modules"
+  ]
+}