@shopify/shopify-app-session-storage-memory 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,19 @@
+# In-Memory Session Storage
+
+This package implements the `SessionStorage` interface to work with an in-memory storage table.
+
+```js
+import {shopifyApp} from '@shopify/shopify-app-express';
+import {MemorySessionStorage} from '@shopify/shopify-app-session-storage-memory';
+
+const shopify = shopifyApp({
+  sessionStorage: new MemorySessionStorage(),
+  // ...
+});
+```
+
+> **Note**: :warning: This session storage model is for local development only, to make it easier for developers to get started.
+> It will delete all sessions if the app process gets restarted or redeployed, and is not meant for production use.
+> For persistent storage, use one of the other options (see relevant section above for instructions).
+
+If you prefer to use your own implementation of a session storage mechanism that is compatible with the `@shopify/shopify-app-express` package, see the [implementing session storage guide](https://github.com/Shopify/shopify-app-js/blob/main/packages/shopify-app-session-storage/implementing-session-storage.md).

package/build/cjs/memory.js

@@ -0,0 +1,32 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class MemorySessionStorage {
+  constructor() {
+    this.sessions = {};
+  }
+  async storeSession(session) {
+    this.sessions[session.id] = session;
+    return true;
+  }
+  async loadSession(id) {
+    return this.sessions[id] || undefined;
+  }
+  async deleteSession(id) {
+    if (this.sessions[id]) {
+      delete this.sessions[id];
+    }
+    return true;
+  }
+  async deleteSessions(ids) {
+    ids.forEach(id => delete this.sessions[id]);
+    return true;
+  }
+  async findSessionsByShop(shop) {
+    const results = Object.values(this.sessions).filter(session => session.shop === shop);
+    return results;
+  }
+}
+
+exports.MemorySessionStorage = MemorySessionStorage;

package/build/ts/memory.d.ts

@@ -0,0 +1,11 @@
+import { Session } from '@shopify/shopify-api';
+import { SessionStorage } from '@shopify/shopify-app-session-storage';
+export declare class MemorySessionStorage implements SessionStorage {
+    private sessions;
+    storeSession(session: Session): Promise<boolean>;
+    loadSession(id: string): Promise<Session | undefined>;
+    deleteSession(id: string): Promise<boolean>;
+    deleteSessions(ids: string[]): Promise<boolean>;
+    findSessionsByShop(shop: string): Promise<Session[]>;
+}
+//# sourceMappingURL=memory.d.ts.map

package/build/ts/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/memory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AAEpE,qBAAa,oBAAqB,YAAW,cAAc;IACzD,OAAO,CAAC,QAAQ,CAA+B;IAElC,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAKhD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAIrD,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAO3C,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAK/C,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAMlE"}

package/build/ts/memory.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemorySessionStorage = void 0;
+var tslib_1 = require("tslib");
+var MemorySessionStorage = /** @class */ (function () {
+    function MemorySessionStorage() {
+        this.sessions = {};
+    }
+    MemorySessionStorage.prototype.storeSession = function (session) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                this.sessions[session.id] = session;
+                return [2 /*return*/, true];
+            });
+        });
+    };
+    MemorySessionStorage.prototype.loadSession = function (id) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.sessions[id] || undefined];
+            });
+        });
+    };
+    MemorySessionStorage.prototype.deleteSession = function (id) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                if (this.sessions[id]) {
+                    delete this.sessions[id];
+                }
+                return [2 /*return*/, true];
+            });
+        });
+    };
+    MemorySessionStorage.prototype.deleteSessions = function (ids) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                ids.forEach(function (id) { return delete _this.sessions[id]; });
+                return [2 /*return*/, true];
+            });
+        });
+    };
+    MemorySessionStorage.prototype.findSessionsByShop = function (shop) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var results;
+            return tslib_1.__generator(this, function (_a) {
+                results = Object.values(this.sessions).filter(function (session) { return session.shop === shop; });
+                return [2 /*return*/, results];
+            });
+        });
+    };
+    return MemorySessionStorage;
+}());
+exports.MemorySessionStorage = MemorySessionStorage;
+//# sourceMappingURL=memory.js.map

package/build/ts/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../../src/memory.ts"],"names":[],"mappings":";;;;AAGA;IAAA;QACU,aAAQ,GAA4B,EAAE,CAAC;IA6BjD,CAAC;IA3Bc,2CAAY,GAAzB,UAA0B,OAAgB;;;gBACxC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;gBACpC,sBAAO,IAAI,EAAC;;;KACb;IAEY,0CAAW,GAAxB,UAAyB,EAAU;;;gBACjC,sBAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,SAAS,EAAC;;;KACvC;IAEY,4CAAa,GAA1B,UAA2B,EAAU;;;gBACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;oBACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;iBAC1B;gBACD,sBAAO,IAAI,EAAC;;;KACb;IAEY,6CAAc,GAA3B,UAA4B,GAAa;;;;gBACvC,GAAG,CAAC,OAAO,CAAC,UAAC,EAAE,IAAK,OAAA,OAAO,KAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAxB,CAAwB,CAAC,CAAC;gBAC9C,sBAAO,IAAI,EAAC;;;KACb;IAEY,iDAAkB,GAA/B,UAAgC,IAAY;;;;gBACpC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CACjD,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,IAAI,KAAK,IAAI,EAArB,CAAqB,CACnC,CAAC;gBACF,sBAAO,OAAO,EAAC;;;KAChB;IACH,2BAAC;AAAD,CAAC,AA9BD,IA8BC;AA9BY,oDAAoB"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@shopify/shopify-app-session-storage-memory",
+  "version": "0.0.0-experimental-20240118200208",
+  "description": "Shopify App Session Storage for Memory",
+  "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-memory",
+  "author": "Shopify Inc.",
+  "license": "MIT",
+  "main": "./build/cjs/memory.js",
+  "types": "./build/ts/memory.d.ts",
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "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",
+    "@shopify/shopify-app-session-storage": "0.0.0-experimental-20240118200208"
+  },
+  "devDependencies": {
+    "@shopify/eslint-plugin": "^42.1.0",
+    "@shopify/prettier-config": "^1.1.2",
+    "@shopify/shopify-app-session-storage-test-utils": "0.0.0-experimental-20240118200208",
+    "@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"
+  ]
+}