@cosystem/storage 0.0.2 → 1.0.0

package/dist/index.d.ts

@@ -11,13 +11,19 @@ interface StoragePluginOptions<TState = unknown> {
   readonly storage: StorageLike;
   readonly serialize?: (state: TState) => string;
   readonly deserialize?: (value: string) => TState;
+  readonly partialize?: (state: unknown) => TState;
+  readonly merge?: (persisted: TState, current: unknown) => unknown;
   readonly shouldPersist?: (event: StateChangeEvent) => boolean;
+  readonly onError?: (error: unknown, phase: StoragePluginErrorPhase) => void;
 }
+type StoragePluginErrorPhase = "clear" | "hydrate" | "persist";
 interface StoragePlugin extends Plugin {
   clear(): Promise<void>;
+  flush(): Promise<void>;
   persist(app: App): Promise<void>;
+  ready(): Promise<void>;
 }
 declare function createStoragePlugin<TState = unknown>(options: StoragePluginOptions<TState>): StoragePlugin;
 //#endregion
-export { StorageLike, StoragePlugin, StoragePluginOptions, createStoragePlugin };
+export { StorageLike, StoragePlugin, StoragePluginErrorPhase, StoragePluginOptions, createStoragePlugin };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;UAEiB,WAAA;EACf,OAAA,CAAQ,GAAA,2BAA8B,OAAA;EACtC,OAAA,CAAQ,GAAA,UAAa,KAAA,kBAAuB,OAAA;EAC5C,UAAA,EAAY,GAAA,kBAAqB,OAAA;AAAA;AAAA,UAGlB,oBAAA;EAAA,SACN,GAAA;EAAA,SACA,OAAA,EAAS,WAAA;EAAA,SACT,SAAA,IAAa,KAAA,EAAO,MAAA;EAAA,SACpB,WAAA,IAAe,KAAA,aAAkB,MAAA;EAAA,SACjC,aAAA,IAAiB,KAAA,EAAO,gBAAA;AAAA;AAAA,UAGlB,aAAA,SAAsB,MAAA;EACrC,KAAA,IAAS,OAAA;EACT,OAAA,CAAQ,GAAA,EAAK,GAAA,GAAM,OAAA;AAAA;AAAA,iBAGL,mBAAA,mBACd,OAAA,EAAS,oBAAA,CAAqB,MAAA,IAC7B,aAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;UAEiB,WAAA;EACf,OAAA,CAAQ,GAAA,2BAA8B,OAAA;EACtC,OAAA,CAAQ,GAAA,UAAa,KAAA,kBAAuB,OAAA;EAC5C,UAAA,EAAY,GAAA,kBAAqB,OAAA;AAAA;AAAA,UAGlB,oBAAA;EAAA,SACN,GAAA;EAAA,SACA,OAAA,EAAS,WAAA;EAAA,SACT,SAAA,IAAa,KAAA,EAAO,MAAA;EAAA,SACpB,WAAA,IAAe,KAAA,aAAkB,MAAA;EAAA,SACjC,UAAA,IAAc,KAAA,cAAmB,MAAA;EAAA,SACjC,KAAA,IAAS,SAAA,EAAW,MAAA,EAAQ,OAAA;EAAA,SAC5B,aAAA,IAAiB,KAAA,EAAO,gBAAA;EAAA,SACxB,OAAA,IAAW,KAAA,WAAgB,KAAA,EAAO,uBAAA;AAAA;AAAA,KAGjC,uBAAA;AAAA,UAEK,aAAA,SAAsB,MAAA;EACrC,KAAA,IAAS,OAAA;EACT,KAAA,IAAS,OAAA;EACT,OAAA,CAAQ,GAAA,EAAK,GAAA,GAAM,OAAA;EACnB,KAAA,IAAS,OAAA;AAAA;AAAA,iBAGK,mBAAA,mBACd,OAAA,EAAS,oBAAA,CAAqB,MAAA,IAC7B,aAAA"}

package/dist/index.js

@@ -2,22 +2,56 @@
 function createStoragePlugin(options) {
 	const serialize = options.serialize ?? JSON.stringify;
 	const deserialize = options.deserialize ?? JSON.parse;
+	const partialize = options.partialize ?? ((state) => state);
+	const merge = options.merge ?? ((persisted) => persisted);
+	let readyPromise = Promise.resolve();
+	let writeQueue = Promise.resolve();
+	const runQueued = (phase, task) => {
+		const operation = writeQueue.catch(() => void 0).then(task);
+		writeQueue = operation.catch((error) => {
+			options.onError?.(error, phase);
+		});
+		return operation;
+	};
 	return {
 		name: "cosystem:storage",
 		async clear() {
-			await options.storage.removeItem?.(options.key);
+			await readyPromise;
+			await runQueued("clear", async () => {
+				await options.storage.removeItem?.(options.key);
+			});
+		},
+		async flush() {
+			await readyPromise;
+			await writeQueue;
 		},
-		async onStateChange(event) {
+		onStateChange(event) {
 			if (options.shouldPersist !== void 0 && !options.shouldPersist(event)) return;
-			await options.storage.setItem(options.key, serialize(event.state));
+			runQueued("persist", async () => {
+				await options.storage.setItem(options.key, serialize(partialize(event.state)));
+			}).catch(() => void 0);
 		},
 		async persist(app) {
-			await options.storage.setItem(options.key, serialize(app.store.getPureState()));
+			await readyPromise;
+			await runQueued("persist", async () => {
+				await options.storage.setItem(options.key, serialize(partialize(app.store.getPureState())));
+			});
+		},
+		ready() {
+			return readyPromise;
 		},
-		async setup(app) {
-			const stored = await options.storage.getItem(options.key);
-			if (stored === null) return;
-			app.store.setState(deserialize(stored));
+		setup(app) {
+			readyPromise = (async () => {
+				try {
+					const stored = await options.storage.getItem(options.key);
+					if (stored === null) return;
+					app.store.setState(merge(deserialize(stored), app.store.getPureState()));
+				} catch (error) {
+					options.onError?.(error, "hydrate");
+					throw error;
+				}
+			})();
+			return readyPromise;
 		}
 	};
 }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { App, Plugin, StateChangeEvent } from \"@cosystem/core\";\n\nexport interface StorageLike {\n  getItem(key: string): string | null | Promise<string | null>;\n  setItem(key: string, value: string): void | Promise<void>;\n  removeItem?(key: string): void | Promise<void>;\n}\n\nexport interface StoragePluginOptions<TState = unknown> {\n  readonly key: string;\n  readonly storage: StorageLike;\n  readonly serialize?: (state: TState) => string;\n  readonly deserialize?: (value: string) => TState;\n  readonly shouldPersist?: (event: StateChangeEvent) => boolean;\n}\n\nexport interface StoragePlugin extends Plugin {\n  clear(): Promise<void>;\n  persist(app: App): Promise<void>;\n}\n\nexport function createStoragePlugin<TState = unknown>(\n  options: StoragePluginOptions<TState>,\n): StoragePlugin {\n  const serialize = options.serialize ?? JSON.stringify;\n  const deserialize = options.deserialize ?? JSON.parse;\n\n  return {\n    name: \"cosystem:storage\",\n    async clear() {\n      await options.storage.removeItem?.(options.key);\n    },\n    async onStateChange(event) {\n      if (options.shouldPersist !== undefined && !options.shouldPersist(event)) {\n        return;\n      }\n\n      await options.storage.setItem(options.key, serialize(event.state as TState));\n    },\n    async persist(app) {\n      await options.storage.setItem(options.key, serialize(app.store.getPureState() as TState));\n    },\n    async setup(app) {\n      const stored = await options.storage.getItem(options.key);\n\n      if (stored === null) {\n        return;\n      }\n\n      app.store.setState(deserialize(stored) as never);\n    },\n  };\n}\n"],"mappings":";AAqBA,SAAgB,oBACd,SACe;CACf,MAAM,YAAY,QAAQ,aAAa,KAAK;CAC5C,MAAM,cAAc,QAAQ,eAAe,KAAK;CAEhD,OAAO;EACL,MAAM;EACN,MAAM,QAAQ;GACZ,MAAM,QAAQ,QAAQ,aAAa,QAAQ,GAAG;EAChD;EACA,MAAM,cAAc,OAAO;GACzB,IAAI,QAAQ,kBAAkB,KAAA,KAAa,CAAC,QAAQ,cAAc,KAAK,GACrE;GAGF,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,KAAK,UAAU,MAAM,KAAe,CAAC;EAC7E;EACA,MAAM,QAAQ,KAAK;GACjB,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,KAAK,UAAU,IAAI,MAAM,aAAa,CAAW,CAAC;EAC1F;EACA,MAAM,MAAM,KAAK;GACf,MAAM,SAAS,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,GAAG;GAExD,IAAI,WAAW,MACb;GAGF,IAAI,MAAM,SAAS,YAAY,MAAM,CAAU;EACjD;CACF;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { App, Plugin, StateChangeEvent } from \"@cosystem/core\";\n\nexport interface StorageLike {\n  getItem(key: string): string | null | Promise<string | null>;\n  setItem(key: string, value: string): void | Promise<void>;\n  removeItem?(key: string): void | Promise<void>;\n}\n\nexport interface StoragePluginOptions<TState = unknown> {\n  readonly key: string;\n  readonly storage: StorageLike;\n  readonly serialize?: (state: TState) => string;\n  readonly deserialize?: (value: string) => TState;\n  readonly partialize?: (state: unknown) => TState;\n  readonly merge?: (persisted: TState, current: unknown) => unknown;\n  readonly shouldPersist?: (event: StateChangeEvent) => boolean;\n  readonly onError?: (error: unknown, phase: StoragePluginErrorPhase) => void;\n}\n\nexport type StoragePluginErrorPhase = \"clear\" | \"hydrate\" | \"persist\";\n\nexport interface StoragePlugin extends Plugin {\n  clear(): Promise<void>;\n  flush(): Promise<void>;\n  persist(app: App): Promise<void>;\n  ready(): Promise<void>;\n}\n\nexport function createStoragePlugin<TState = unknown>(\n  options: StoragePluginOptions<TState>,\n): StoragePlugin {\n  const serialize = options.serialize ?? JSON.stringify;\n  const deserialize = options.deserialize ?? JSON.parse;\n  const partialize = options.partialize ?? ((state: unknown) => state as TState);\n  const merge = options.merge ?? ((persisted: TState) => persisted);\n  let readyPromise: Promise<void> = Promise.resolve();\n  let writeQueue: Promise<void> = Promise.resolve();\n\n  const runQueued = (\n    phase: StoragePluginErrorPhase,\n    task: () => void | Promise<void>,\n  ): Promise<void> => {\n    const operation = writeQueue.catch(() => undefined).then(task);\n    writeQueue = operation.catch((error: unknown) => {\n      options.onError?.(error, phase);\n    });\n\n    return operation;\n  };\n\n  return {\n    name: \"cosystem:storage\",\n    async clear() {\n      await readyPromise;\n      await runQueued(\"clear\", async () => {\n        await options.storage.removeItem?.(options.key);\n      });\n    },\n    async flush() {\n      await readyPromise;\n      await writeQueue;\n    },\n    onStateChange(event) {\n      if (options.shouldPersist !== undefined && !options.shouldPersist(event)) {\n        return;\n      }\n\n      void runQueued(\"persist\", async () => {\n        await options.storage.setItem(options.key, serialize(partialize(event.state)));\n      }).catch(() => undefined);\n    },\n    async persist(app) {\n      await readyPromise;\n      await runQueued(\"persist\", async () => {\n        await options.storage.setItem(options.key, serialize(partialize(app.store.getPureState())));\n      });\n    },\n    ready() {\n      return readyPromise;\n    },\n    setup(app) {\n      readyPromise = (async () => {\n        try {\n          const stored = await options.storage.getItem(options.key);\n\n          if (stored === null) {\n            return;\n          }\n\n          app.store.setState(merge(deserialize(stored), app.store.getPureState()) as never);\n        } catch (error) {\n          options.onError?.(error, \"hydrate\");\n          throw error;\n        }\n      })();\n\n      return readyPromise;\n    },\n  };\n}\n"],"mappings":";AA4BA,SAAgB,oBACd,SACe;CACf,MAAM,YAAY,QAAQ,aAAa,KAAK;CAC5C,MAAM,cAAc,QAAQ,eAAe,KAAK;CAChD,MAAM,aAAa,QAAQ,gBAAgB,UAAmB;CAC9D,MAAM,QAAQ,QAAQ,WAAW,cAAsB;CACvD,IAAI,eAA8B,QAAQ,QAAQ;CAClD,IAAI,aAA4B,QAAQ,QAAQ;CAEhD,MAAM,aACJ,OACA,SACkB;EAClB,MAAM,YAAY,WAAW,YAAY,KAAA,CAAS,CAAC,CAAC,KAAK,IAAI;EAC7D,aAAa,UAAU,OAAO,UAAmB;GAC/C,QAAQ,UAAU,OAAO,KAAK;EAChC,CAAC;EAED,OAAO;CACT;CAEA,OAAO;EACL,MAAM;EACN,MAAM,QAAQ;GACZ,MAAM;GACN,MAAM,UAAU,SAAS,YAAY;IACnC,MAAM,QAAQ,QAAQ,aAAa,QAAQ,GAAG;GAChD,CAAC;EACH;EACA,MAAM,QAAQ;GACZ,MAAM;GACN,MAAM;EACR;EACA,cAAc,OAAO;GACnB,IAAI,QAAQ,kBAAkB,KAAA,KAAa,CAAC,QAAQ,cAAc,KAAK,GACrE;GAGF,UAAe,WAAW,YAAY;IACpC,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,KAAK,UAAU,WAAW,MAAM,KAAK,CAAC,CAAC;GAC/E,CAAC,CAAC,CAAC,YAAY,KAAA,CAAS;EAC1B;EACA,MAAM,QAAQ,KAAK;GACjB,MAAM;GACN,MAAM,UAAU,WAAW,YAAY;IACrC,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,KAAK,UAAU,WAAW,IAAI,MAAM,aAAa,CAAC,CAAC,CAAC;GAC5F,CAAC;EACH;EACA,QAAQ;GACN,OAAO;EACT;EACA,MAAM,KAAK;GACT,gBAAgB,YAAY;IAC1B,IAAI;KACF,MAAM,SAAS,MAAM,QAAQ,QAAQ,QAAQ,QAAQ,GAAG;KAExD,IAAI,WAAW,MACb;KAGF,IAAI,MAAM,SAAS,MAAM,YAAY,MAAM,GAAG,IAAI,MAAM,aAAa,CAAC,CAAU;IAClF,SAAS,OAAO;KACd,QAAQ,UAAU,OAAO,SAAS;KAClC,MAAM;IACR;GACF,EAAA,CAAG;GAEH,OAAO;EACT;CACF;AACF"}

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@cosystem/storage",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "description": "Persistence plugin for CoSystem.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coactionjs/cosystem.git",
+    "directory": "packages/storage"
+  },
   "files": [
     "dist"
   ],
@@ -20,7 +25,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@cosystem/core": "0.0.2"
+    "@cosystem/core": "1.0.0"
   },
   "devDependencies": {
     "tsdown": "0.22.3",