@xlt-token/store-contract 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 xltorg
+
+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/dist/index.cjs

@@ -0,0 +1,41 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let vitest = require("vitest");
+let _xlt_token_core = require("@xlt-token/core");
+
+//#region src/store-contract.ts
+function defineStoreContract(name, createStore) {
+	(0, vitest.describe)(name, () => {
+		(0, vitest.it)("keeps one winner for concurrent setIfAbsent", async () => {
+			const store = await createStore();
+			(0, vitest.expect)((await Promise.all(Array.from({ length: 20 }, (_, index) => store.setIfAbsent("{contract}:lock", String(index), (0, _xlt_token_core.finiteTtl)(30))))).filter(Boolean)).toHaveLength(1);
+			await (0, vitest.expect)(store.get("{contract}:lock")).resolves.toMatchObject({ value: vitest.expect.any(String) });
+		});
+		(0, vitest.it)("keeps value and ttl unchanged when compareAndSet misses", async () => {
+			const store = await createStore();
+			await store.set("{contract}:cas", "v1", (0, _xlt_token_core.finiteTtl)(60));
+			await (0, vitest.expect)(store.compareAndSet("{contract}:cas", "wrong", "v2", (0, _xlt_token_core.keepTtl)())).resolves.toBe(false);
+			await (0, vitest.expect)(store.get("{contract}:cas")).resolves.toMatchObject({ value: "v1" });
+		});
+		(0, vitest.it)("updates and deletes only when the current value matches", async () => {
+			const store = await createStore();
+			await store.set("{contract}:mutable", "v1", (0, _xlt_token_core.persistentTtl)());
+			await (0, vitest.expect)(store.compareAndSet("{contract}:mutable", "v1", "v2", (0, _xlt_token_core.keepTtl)())).resolves.toBe(true);
+			await (0, vitest.expect)(store.get("{contract}:mutable")).resolves.toMatchObject({ value: "v2" });
+			await (0, vitest.expect)(store.compareAndDelete("{contract}:mutable", "wrong")).resolves.toBe(false);
+			await (0, vitest.expect)(store.compareAndDelete("{contract}:mutable", "v2")).resolves.toBe(true);
+			await (0, vitest.expect)(store.get("{contract}:mutable")).resolves.toBeNull();
+		});
+		(0, vitest.it)("touches ttl without changing value", async () => {
+			const store = await createStore();
+			await store.set("{contract}:touch", "v1", (0, _xlt_token_core.finiteTtl)(30));
+			await (0, vitest.expect)(store.touch("{contract}:touch", (0, _xlt_token_core.persistentTtl)())).resolves.toBe(true);
+			await (0, vitest.expect)(store.get("{contract}:touch")).resolves.toMatchObject({
+				value: "v1",
+				expiresAt: null
+			});
+		});
+	});
+}
+
+//#endregion
+exports.defineStoreContract = defineStoreContract;

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+import { XltTokenStore } from "@xlt-token/core";
+
+//#region src/store-contract.d.ts
+declare function defineStoreContract(name: string, createStore: () => Promise<XltTokenStore> | XltTokenStore): void;
+//#endregion
+export { defineStoreContract };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/store-contract.ts"],"mappings":";;;iBAGgB,mBAAA,CACd,IAAA,UACA,WAAA,QAAmB,OAAA,CAAQ,aAAA,IAAiB,aAAA"}

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+import { XltTokenStore } from "@xlt-token/core";
+
+//#region src/store-contract.d.ts
+declare function defineStoreContract(name: string, createStore: () => Promise<XltTokenStore> | XltTokenStore): void;
+//#endregion
+export { defineStoreContract };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/store-contract.ts"],"mappings":";;;iBAGgB,mBAAA,CACd,IAAA,UACA,WAAA,QAAmB,OAAA,CAAQ,aAAA,IAAiB,aAAA"}

package/dist/index.mjs

@@ -0,0 +1,41 @@
+import { describe, expect, it } from "vitest";
+import { finiteTtl, keepTtl, persistentTtl } from "@xlt-token/core";
+
+//#region src/store-contract.ts
+function defineStoreContract(name, createStore) {
+	describe(name, () => {
+		it("keeps one winner for concurrent setIfAbsent", async () => {
+			const store = await createStore();
+			expect((await Promise.all(Array.from({ length: 20 }, (_, index) => store.setIfAbsent("{contract}:lock", String(index), finiteTtl(30))))).filter(Boolean)).toHaveLength(1);
+			await expect(store.get("{contract}:lock")).resolves.toMatchObject({ value: expect.any(String) });
+		});
+		it("keeps value and ttl unchanged when compareAndSet misses", async () => {
+			const store = await createStore();
+			await store.set("{contract}:cas", "v1", finiteTtl(60));
+			await expect(store.compareAndSet("{contract}:cas", "wrong", "v2", keepTtl())).resolves.toBe(false);
+			await expect(store.get("{contract}:cas")).resolves.toMatchObject({ value: "v1" });
+		});
+		it("updates and deletes only when the current value matches", async () => {
+			const store = await createStore();
+			await store.set("{contract}:mutable", "v1", persistentTtl());
+			await expect(store.compareAndSet("{contract}:mutable", "v1", "v2", keepTtl())).resolves.toBe(true);
+			await expect(store.get("{contract}:mutable")).resolves.toMatchObject({ value: "v2" });
+			await expect(store.compareAndDelete("{contract}:mutable", "wrong")).resolves.toBe(false);
+			await expect(store.compareAndDelete("{contract}:mutable", "v2")).resolves.toBe(true);
+			await expect(store.get("{contract}:mutable")).resolves.toBeNull();
+		});
+		it("touches ttl without changing value", async () => {
+			const store = await createStore();
+			await store.set("{contract}:touch", "v1", finiteTtl(30));
+			await expect(store.touch("{contract}:touch", persistentTtl())).resolves.toBe(true);
+			await expect(store.get("{contract}:touch")).resolves.toMatchObject({
+				value: "v1",
+				expiresAt: null
+			});
+		});
+	});
+}
+
+//#endregion
+export { defineStoreContract };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/store-contract.ts"],"sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { finiteTtl, keepTtl, persistentTtl, type XltTokenStore } from \"@xlt-token/core\";\n\nexport function defineStoreContract(\n  name: string,\n  createStore: () => Promise<XltTokenStore> | XltTokenStore,\n): void {\n  describe(name, () => {\n    it(\"keeps one winner for concurrent setIfAbsent\", async () => {\n      const store = await createStore();\n\n      const results = await Promise.all(\n        Array.from({ length: 20 }, (_, index) =>\n          store.setIfAbsent(\"{contract}:lock\", String(index), finiteTtl(30)),\n        ),\n      );\n\n      expect(results.filter(Boolean)).toHaveLength(1);\n      await expect(store.get(\"{contract}:lock\")).resolves.toMatchObject({\n        value: expect.any(String),\n      });\n    });\n\n    it(\"keeps value and ttl unchanged when compareAndSet misses\", async () => {\n      const store = await createStore();\n\n      await store.set(\"{contract}:cas\", \"v1\", finiteTtl(60));\n\n      await expect(store.compareAndSet(\"{contract}:cas\", \"wrong\", \"v2\", keepTtl())).resolves.toBe(\n        false,\n      );\n      await expect(store.get(\"{contract}:cas\")).resolves.toMatchObject({ value: \"v1\" });\n    });\n\n    it(\"updates and deletes only when the current value matches\", async () => {\n      const store = await createStore();\n\n      await store.set(\"{contract}:mutable\", \"v1\", persistentTtl());\n\n      await expect(store.compareAndSet(\"{contract}:mutable\", \"v1\", \"v2\", keepTtl())).resolves.toBe(\n        true,\n      );\n      await expect(store.get(\"{contract}:mutable\")).resolves.toMatchObject({ value: \"v2\" });\n\n      await expect(store.compareAndDelete(\"{contract}:mutable\", \"wrong\")).resolves.toBe(false);\n      await expect(store.compareAndDelete(\"{contract}:mutable\", \"v2\")).resolves.toBe(true);\n      await expect(store.get(\"{contract}:mutable\")).resolves.toBeNull();\n    });\n\n    it(\"touches ttl without changing value\", async () => {\n      const store = await createStore();\n\n      await store.set(\"{contract}:touch\", \"v1\", finiteTtl(30));\n\n      await expect(store.touch(\"{contract}:touch\", persistentTtl())).resolves.toBe(true);\n      await expect(store.get(\"{contract}:touch\")).resolves.toMatchObject({\n        value: \"v1\",\n        expiresAt: null,\n      });\n    });\n  });\n}\n"],"mappings":";;;;AAGA,SAAgB,oBACd,MACA,aACM;AACN,UAAS,YAAY;AACnB,KAAG,+CAA+C,YAAY;GAC5D,MAAM,QAAQ,MAAM,aAAa;AAQjC,WANgB,MAAM,QAAQ,IAC5B,MAAM,KAAK,EAAE,QAAQ,IAAI,GAAG,GAAG,UAC7B,MAAM,YAAY,mBAAmB,OAAO,MAAM,EAAE,UAAU,GAAG,CAAC,CACnE,CACF,EAEc,OAAO,QAAQ,CAAC,CAAC,aAAa,EAAE;AAC/C,SAAM,OAAO,MAAM,IAAI,kBAAkB,CAAC,CAAC,SAAS,cAAc,EAChE,OAAO,OAAO,IAAI,OAAO,EAC1B,CAAC;IACF;AAEF,KAAG,2DAA2D,YAAY;GACxE,MAAM,QAAQ,MAAM,aAAa;AAEjC,SAAM,MAAM,IAAI,kBAAkB,MAAM,UAAU,GAAG,CAAC;AAEtD,SAAM,OAAO,MAAM,cAAc,kBAAkB,SAAS,MAAM,SAAS,CAAC,CAAC,CAAC,SAAS,KACrF,MACD;AACD,SAAM,OAAO,MAAM,IAAI,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,OAAO,MAAM,CAAC;IACjF;AAEF,KAAG,2DAA2D,YAAY;GACxE,MAAM,QAAQ,MAAM,aAAa;AAEjC,SAAM,MAAM,IAAI,sBAAsB,MAAM,eAAe,CAAC;AAE5D,SAAM,OAAO,MAAM,cAAc,sBAAsB,MAAM,MAAM,SAAS,CAAC,CAAC,CAAC,SAAS,KACtF,KACD;AACD,SAAM,OAAO,MAAM,IAAI,qBAAqB,CAAC,CAAC,SAAS,cAAc,EAAE,OAAO,MAAM,CAAC;AAErF,SAAM,OAAO,MAAM,iBAAiB,sBAAsB,QAAQ,CAAC,CAAC,SAAS,KAAK,MAAM;AACxF,SAAM,OAAO,MAAM,iBAAiB,sBAAsB,KAAK,CAAC,CAAC,SAAS,KAAK,KAAK;AACpF,SAAM,OAAO,MAAM,IAAI,qBAAqB,CAAC,CAAC,SAAS,UAAU;IACjE;AAEF,KAAG,sCAAsC,YAAY;GACnD,MAAM,QAAQ,MAAM,aAAa;AAEjC,SAAM,MAAM,IAAI,oBAAoB,MAAM,UAAU,GAAG,CAAC;AAExD,SAAM,OAAO,MAAM,MAAM,oBAAoB,eAAe,CAAC,CAAC,CAAC,SAAS,KAAK,KAAK;AAClF,SAAM,OAAO,MAAM,IAAI,mBAAmB,CAAC,CAAC,SAAS,cAAc;IACjE,OAAO;IACP,WAAW;IACZ,CAAC;IACF;GACF"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@xlt-token/store-contract",
+  "version": "2.1.0",
+  "description": "Shared XltTokenStore contract tests for xlt-token stores",
+  "keywords": [
+    "auth",
+    "contract",
+    "store",
+    "token"
+  ],
+  "homepage": "https://xiaolangtou.github.io/xlt-token/",
+  "bugs": {
+    "url": "https://github.com/xiaoLangtou/xlt-token/issues"
+  },
+  "license": "MIT",
+  "author": "xltorg",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xiaoLangtou/xlt-token.git",
+    "directory": "packages/store-contract"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@xlt-token/core": "^2.1.0",
+    "vitest": "^2.0.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.9",
+    "tsdown": "^0.20.0",
+    "typescript": "^5.1.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "build:watch": "tsdown --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}