@cyberskill/shared 2.19.1 → 2.20.0

package/dist/node/storage/storage.constant.js

@@ -0,0 +1,7 @@
+const E = "localforage-node-fs", o = ".json", _ = "cyberskill", s = "node-storage";
+export {
+  E as NODE_FS_DRIVER_NAME,
+  _ as STORAGE_INSTANCE_NAME,
+  o as STORAGE_KEY_EXTENSION,
+  s as STORAGE_STORE_NAME
+};

package/dist/node/storage/storage.type.d.ts

@@ -0,0 +1,14 @@
+import { default as localForage } from 'localforage';
+export type LocalForageDriver = Parameters<typeof localForage.defineDriver>[0];
+export interface NodeLocalForageOptions {
+    driver?: string | string[];
+    size?: number;
+    version?: number;
+    description?: string;
+    name?: string;
+    storeName?: string;
+    baseDir?: string;
+}
+export interface NodeFsDriverState {
+    baseDir: string;
+}

package/dist/node/storage/storage.util.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("node-persist"),f=require("../../config/env/env.util.cjs"),u=require("../log/log.util.cjs");var l=(r,e,n)=>new Promise((h,a)=>{var d=t=>{try{c(n.next(t))}catch(s){a(s)}},v=t=>{try{c(n.throw(t))}catch(s){a(s)}},c=t=>t.done?h(t.value):Promise.resolve(t.value).then(d,v);c((n=n.apply(r,e)).next())});const y=f.getEnv();function o(){return l(this,null,function*(){i.defaultInstance||(yield i.init({dir:y.CYBERSKILL_STORAGE_DIRECTORY}))})}const E={get(r){return l(this,null,function*(){try{yield o();const e=yield i.getItem(r);return e!=null?e:null}catch(e){return u.catchError(e,{returnValue:null})}})},set(r,e){return l(this,null,function*(){try{yield o(),yield i.setItem(r,e)}catch(n){u.catchError(n)}})},remove(r){return l(this,null,function*(){try{yield o(),yield i.removeItem(r)}catch(e){u.catchError(e)}})},keys(){return l(this,null,function*(){try{yield o();const r=yield i.keys();return Array.isArray(r)?r:(u.log.warn("[Storage:keys] Invalid keys response:",r),[])}catch(r){return u.catchError(r,{returnValue:[]})}})},getLogLink(r){return l(this,null,function*(){try{return`${y.CYBERSKILL_STORAGE_DIRECTORY} (key: ${r})`}catch(e){return u.catchError(e,{returnValue:null})}})}};exports.storage=E;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("localforage"),o=require("node:fs/promises"),D=require("node:path"),c=require("./storage.constant.cjs"),I=require("../../config/env/env.util.cjs"),s=require("../log/log.util.cjs");var n=(e,r,t)=>new Promise((i,y)=>{var h=u=>{try{v(t.next(u))}catch(_){y(_)}},O=u=>{try{v(t.throw(u))}catch(_){y(_)}},v=u=>u.done?i(u.value):Promise.resolve(u.value).then(h,O);v((t=t.apply(e,r)).next())});const E=I.getEnv(),l={baseDir:E.CYBERSKILL_STORAGE_DIRECTORY};function m(e){return`${encodeURIComponent(e)}${c.STORAGE_KEY_EXTENSION}`}function N(e){return decodeURIComponent(e.slice(0,-c.STORAGE_KEY_EXTENSION.length))}function R(e,r){return D.join(r,m(e))}const d={_driver:c.NODE_FS_DRIVER_NAME,_support:!0,_initStorage(e){return n(this,null,function*(){try{const r=typeof e=="object"&&e!==null&&"baseDir"in e?e.baseDir:void 0;typeof r=="string"&&r.length>0?l.baseDir=r:l.baseDir=E.CYBERSKILL_STORAGE_DIRECTORY,yield o.mkdir(l.baseDir,{recursive:!0})}catch(r){throw s.log.error("[Storage:init]",r),r}})},clear(){return n(this,null,function*(){const{baseDir:e}=l;yield o.rm(e,{recursive:!0,force:!0}),yield o.mkdir(e,{recursive:!0})})},getItem(e){return n(this,null,function*(){const{baseDir:r}=l,t=R(e,r);try{const i=yield o.readFile(t,"utf8");return JSON.parse(i)}catch(i){if(i.code==="ENOENT")return null;throw i}})},iterate(e){return n(this,null,function*(){const r=yield d.keys();let t=1;for(const i of r){const y=yield d.getItem(i),h=e(y,i,t);if(h!==void 0)return h;t+=1}})},key(e){return n(this,null,function*(){var r;return(r=(yield d.keys())[e])!=null?r:null})},keys(){return n(this,null,function*(){const{baseDir:e}=l;try{return(yield o.readdir(e)).filter(t=>t.endsWith(c.STORAGE_KEY_EXTENSION)).map(N)}catch(r){if(r.code==="ENOENT")return[];throw r}})},length(){return n(this,null,function*(){return(yield d.keys()).length})},removeItem(e){return n(this,null,function*(){const{baseDir:r}=l,t=R(e,r);yield o.rm(t,{force:!0})})},setItem(e,r){return n(this,null,function*(){const{baseDir:t}=l,i=R(e,t);return yield o.mkdir(t,{recursive:!0}),yield o.writeFile(i,JSON.stringify(r),"utf8"),r})}};let a=null,S=null;function f(){return n(this,null,function*(){return a?(yield a,S):(a=n(null,null,function*(){yield g.defineDriver(d),l.baseDir=E.CYBERSKILL_STORAGE_DIRECTORY;const e=yield g.getDriver(c.NODE_FS_DRIVER_NAME),r={baseDir:l.baseDir,name:c.STORAGE_INSTANCE_NAME,storeName:c.STORAGE_STORE_NAME};yield e._initStorage(r),S=e}).catch(e=>{throw a=null,e}),yield a,S)})}const T={get(e){return n(this,null,function*(){try{const t=yield(yield f()).getItem(e);return t!=null?t:null}catch(r){return s.catchError(r,{returnValue:null})}})},set(e,r){return n(this,null,function*(){try{yield(yield f()).setItem(e,r)}catch(t){s.catchError(t)}})},remove(e){return n(this,null,function*(){try{yield(yield f()).removeItem(e)}catch(r){s.catchError(r)}})},keys(){return n(this,null,function*(){try{const r=yield(yield f()).keys();return Array.isArray(r)?r:(s.log.warn("[Storage:keys] Invalid keys response:",r),[])}catch(e){return s.catchError(e,{returnValue:[]})}})},getLogLink(e){return n(this,null,function*(){try{return`${D.join(E.CYBERSKILL_STORAGE_DIRECTORY,m(e))} (key: ${e})`}catch(r){return s.catchError(r,{returnValue:null})}})}};exports.storage=T;

package/dist/node/storage/storage.util.d.ts

@@ -1,6 +1,6 @@
 /**
  * Persistent storage utility object for data persistence across application sessions.
- * This object provides methods for storing, retrieving, and managing data using node-persist,
+ * This object provides methods for storing, retrieving, and managing data using localForage,
  * with automatic initialization and error handling.
  */
 export declare const storage: {

package/dist/node/storage/storage.util.js

@@ -1,31 +1,143 @@
-import u from "node-persist";
-import { getEnv as m } from "../../config/env/env.util.js";
-import { catchError as i, log as v } from "../log/log.util.js";
-var l = (r, e, n) => new Promise((h, a) => {
-  var d = (t) => {
+import _ from "localforage";
+import l from "node:fs/promises";
+import g from "node:path";
+import { STORAGE_KEY_EXTENSION as R, NODE_FS_DRIVER_NAME as I, STORAGE_STORE_NAME as p, STORAGE_INSTANCE_NAME as b } from "./storage.constant.js";
+import { getEnv as N } from "../../config/env/env.util.js";
+import { catchError as s, log as S } from "../log/log.util.js";
+var n = (e, r, t) => new Promise((i, d) => {
+  var y = (u) => {
     try {
-      s(n.next(t));
-    } catch (c) {
-      a(c);
+      m(t.next(u));
+    } catch (v) {
+      d(v);
     }
-  }, f = (t) => {
+  }, O = (u) => {
     try {
-      s(n.throw(t));
-    } catch (c) {
-      a(c);
+      m(t.throw(u));
+    } catch (v) {
+      d(v);
     }
-  }, s = (t) => t.done ? h(t.value) : Promise.resolve(t.value).then(d, f);
-  s((n = n.apply(r, e)).next());
+  }, m = (u) => u.done ? i(u.value) : Promise.resolve(u.value).then(y, O);
+  m((t = t.apply(e, r)).next());
 });
-const y = m();
-function o() {
-  return l(this, null, function* () {
-    u.defaultInstance || (yield u.init({
-      dir: y.CYBERSKILL_STORAGE_DIRECTORY
-    }));
+const h = N(), o = {
+  baseDir: h.CYBERSKILL_STORAGE_DIRECTORY
+};
+function k(e) {
+  return `${encodeURIComponent(e)}${R}`;
+}
+function T(e) {
+  return decodeURIComponent(e.slice(0, -R.length));
+}
+function E(e, r) {
+  return g.join(r, k(e));
+}
+const a = {
+  _driver: I,
+  _support: !0,
+  /** Ensures the storage directory exists and respects custom baseDir overrides. */
+  _initStorage(e) {
+    return n(this, null, function* () {
+      try {
+        const r = typeof e == "object" && e !== null && "baseDir" in e ? e.baseDir : void 0;
+        typeof r == "string" && r.length > 0 ? o.baseDir = r : o.baseDir = h.CYBERSKILL_STORAGE_DIRECTORY, yield l.mkdir(o.baseDir, { recursive: !0 });
+      } catch (r) {
+        throw S.error("[Storage:init]", r), r;
+      }
+    });
+  },
+  /** Deletes all stored entries by recreating the directory. */
+  clear() {
+    return n(this, null, function* () {
+      const { baseDir: e } = o;
+      yield l.rm(e, { recursive: !0, force: !0 }), yield l.mkdir(e, { recursive: !0 });
+    });
+  },
+  /** Reads and parses a stored value; returns null when the file is missing. */
+  getItem(e) {
+    return n(this, null, function* () {
+      const { baseDir: r } = o, t = E(e, r);
+      try {
+        const i = yield l.readFile(t, "utf8");
+        return JSON.parse(i);
+      } catch (i) {
+        if (i.code === "ENOENT")
+          return null;
+        throw i;
+      }
+    });
+  },
+  /** Iterates through all keys, invoking the iterator until it returns a value. */
+  iterate(e) {
+    return n(this, null, function* () {
+      const r = yield a.keys();
+      let t = 1;
+      for (const i of r) {
+        const d = yield a.getItem(i), y = e(d, i, t);
+        if (y !== void 0)
+          return y;
+        t += 1;
+      }
+    });
+  },
+  /** Returns the key name at the given index or null when out of bounds. */
+  key(e) {
+    return n(this, null, function* () {
+      var r;
+      return (r = (yield a.keys())[e]) != null ? r : null;
+    });
+  },
+  /** Lists all stored keys. */
+  keys() {
+    return n(this, null, function* () {
+      const { baseDir: e } = o;
+      try {
+        return (yield l.readdir(e)).filter((t) => t.endsWith(R)).map(T);
+      } catch (r) {
+        if (r.code === "ENOENT")
+          return [];
+        throw r;
+      }
+    });
+  },
+  /** Returns the count of stored keys. */
+  length() {
+    return n(this, null, function* () {
+      return (yield a.keys()).length;
+    });
+  },
+  /** Removes a stored value for the given key. */
+  removeItem(e) {
+    return n(this, null, function* () {
+      const { baseDir: r } = o, t = E(e, r);
+      yield l.rm(t, { force: !0 });
+    });
+  },
+  /** Stores a value as JSON on disk. */
+  setItem(e, r) {
+    return n(this, null, function* () {
+      const { baseDir: t } = o, i = E(e, t);
+      return yield l.mkdir(t, { recursive: !0 }), yield l.writeFile(i, JSON.stringify(r), "utf8"), r;
+    });
+  }
+};
+let c = null, D = null;
+function f() {
+  return n(this, null, function* () {
+    return c ? (yield c, D) : (c = n(null, null, function* () {
+      yield _.defineDriver(a), o.baseDir = h.CYBERSKILL_STORAGE_DIRECTORY;
+      const e = yield _.getDriver(I), r = {
+        baseDir: o.baseDir,
+        name: b,
+        storeName: p
+      };
+      yield e._initStorage(r), D = e;
+    }).catch((e) => {
+      throw c = null, e;
+    }), yield c, D);
   });
 }
-const R = {
+const w = {
   /**
    * Retrieves a value from persistent storage by key.
    * This method fetches data that was previously stored using the set method.
@@ -34,14 +146,13 @@ const R = {
    * @param key - The unique identifier for the stored value.
    * @returns A promise that resolves to the stored value or null if not found.
    */
-  get(r) {
-    return l(this, null, function* () {
+  get(e) {
+    return n(this, null, function* () {
       try {
-        yield o();
-        const e = yield u.getItem(r);
-        return e != null ? e : null;
-      } catch (e) {
-        return i(e, { returnValue: null });
+        const t = yield (yield f()).getItem(e);
+        return t != null ? t : null;
+      } catch (r) {
+        return s(r, { returnValue: null });
       }
     });
   },
@@ -54,12 +165,12 @@ const R = {
    * @param value - The data to store (will be automatically serialized).
    * @returns A promise that resolves when the storage operation is complete.
    */
-  set(r, e) {
-    return l(this, null, function* () {
+  set(e, r) {
+    return n(this, null, function* () {
       try {
-        yield o(), yield u.setItem(r, e);
-      } catch (n) {
-        i(n);
+        yield (yield f()).setItem(e, r);
+      } catch (t) {
+        s(t);
       }
     });
   },
@@ -70,12 +181,12 @@ const R = {
    * @param key - The unique identifier of the value to remove.
    * @returns A promise that resolves when the removal operation is complete.
    */
-  remove(r) {
-    return l(this, null, function* () {
+  remove(e) {
+    return n(this, null, function* () {
       try {
-        yield o(), yield u.removeItem(r);
-      } catch (e) {
-        i(e);
+        yield (yield f()).removeItem(e);
+      } catch (r) {
+        s(r);
       }
     });
   },
@@ -87,13 +198,12 @@ const R = {
    * @returns A promise that resolves to an array of storage keys.
    */
   keys() {
-    return l(this, null, function* () {
+    return n(this, null, function* () {
       try {
-        yield o();
-        const r = yield u.keys();
-        return Array.isArray(r) ? r : (v.warn("[Storage:keys] Invalid keys response:", r), []);
-      } catch (r) {
-        return i(r, { returnValue: [] });
+        const r = yield (yield f()).keys();
+        return Array.isArray(r) ? r : (S.warn("[Storage:keys] Invalid keys response:", r), []);
+      } catch (e) {
+        return s(e, { returnValue: [] });
       }
     });
   },
@@ -105,16 +215,16 @@ const R = {
    * @param key - The storage key to generate a log link for.
    * @returns A promise that resolves to a formatted log link string or null if an error occurs.
    */
-  getLogLink(r) {
-    return l(this, null, function* () {
+  getLogLink(e) {
+    return n(this, null, function* () {
       try {
-        return `${y.CYBERSKILL_STORAGE_DIRECTORY} (key: ${r})`;
-      } catch (e) {
-        return i(e, { returnValue: null });
+        return `${g.join(h.CYBERSKILL_STORAGE_DIRECTORY, k(e))} (key: ${e})`;
+      } catch (r) {
+        return s(r, { returnValue: null });
       }
     });
   }
 };
 export {
-  R as storage
+  w as storage
 };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@cyberskill/shared",
     "type": "module",
-    "version": "2.19.1",
+    "version": "2.20.0",
     "description": "CyberSkill Shared",
     "author": "Stephen Cheng",
     "license": "MIT",
@@ -50,6 +50,11 @@
             "import": "./dist/config/vitest/index.js",
             "require": "./dist/config/vitest/index.cjs"
         },
+        "./config/storybook": {
+            "types": "./dist/config/storybook/index.d.ts",
+            "import": "./dist/config/storybook/index.js",
+            "require": "./dist/config/storybook/index.cjs"
+        },
         "./constant": {
             "types": "./dist/constant/index.d.ts",
             "import": "./dist/constant/index.js",
@@ -210,16 +215,16 @@
         "@antfu/eslint-config": "6.2.0",
         "@apollo/client": "4.0.9",
         "@apollo/client-integration-nextjs": "0.14.1",
-        "@apollo/server": "5.1.0",
+        "@apollo/server": "5.2.0",
         "@as-integrations/express5": "1.1.2",
         "@dotenvx/dotenvx": "1.51.1",
-        "@eddeee888/gcg-typescript-resolver-files": "0.14.0",
-        "@eslint-react/eslint-plugin": "2.3.5",
-        "@graphql-codegen/cli": "6.0.2",
-        "@graphql-codegen/client-preset": "5.1.3",
+        "@eddeee888/gcg-typescript-resolver-files": "0.14.1",
+        "@eslint-react/eslint-plugin": "2.3.7",
+        "@graphql-codegen/cli": "6.1.0",
+        "@graphql-codegen/client-preset": "5.2.0",
         "@nestjs/common": "11.1.9",
         "@nestjs/core": "11.1.9",
-        "@userback/widget": "0.3.11",
+        "@userback/widget": "0.3.12",
         "@vitejs/plugin-react-swc": "4.2.2",
         "body-parser": "2.2.0",
         "chalk": "5.6.2",
@@ -243,36 +248,37 @@
         "graphql": "16.12.0",
         "graphql-upload": "17.0.0",
         "graphql-ws": "6.0.6",
-        "i18next": "25.6.2",
+        "i18next": "25.6.3",
         "jsdom": "27.2.0",
         "localforage": "1.10.0",
         "lodash-es": "4.17.21",
         "migrate-mongo": "12.1.3",
         "mongodb": "7.0.0",
-        "mongoose": "8.19.4",
+        "mongoose": "9.0.0",
         "mongoose-aggregate-paginate-v2": "1.1.4",
         "mongoose-paginate-v2": "1.9.1",
-        "next-intl": "4.5.3",
+        "next-intl": "4.5.5",
         "node-fetch": "3.3.2",
-        "node-persist": "4.0.4",
         "qs": "6.14.0",
         "react": "19.2.0",
         "react-dom": "19.2.0",
         "react-hot-toast": "2.6.0",
-        "react-i18next": "16.3.3",
+        "react-i18next": "16.3.5",
         "rxjs": "7.8.2",
         "slugify": "1.6.6",
         "unorm": "1.6.0",
         "uuid": "13.0.0",
-        "vite": "7.2.2",
+        "vite": "7.2.4",
         "ws": "8.18.3",
         "yargs": "18.0.0"
     },
     "devDependencies": {
         "@commitlint/cli": "20.1.0",
         "@commitlint/config-conventional": "20.0.0",
-        "@eslint/config-inspector": "1.3.0",
+        "@eslint/config-inspector": "1.4.2",
         "@next/eslint-plugin-next": "16.0.3",
+        "@storybook/react": "10.0.8",
+        "@storybook/react-vite": "10.0.8",
         "@testing-library/jest-dom": "6.9.1",
         "@testing-library/react": "16.3.0",
         "@types/body-parser": "1.19.6",
@@ -289,26 +295,25 @@
         "@types/lodash-es": "4.17.12",
         "@types/migrate-mongo": "10.0.6",
         "@types/node": "24.10.1",
-        "@types/node-persist": "3.1.8",
-        "@types/react": "19.2.4",
+        "@types/react": "19.2.6",
         "@types/react-dom": "19.2.3",
         "@types/unorm": "1.3.31",
         "@types/ws": "8.18.1",
         "@types/yargs": "17.0.35",
-        "@vitest/browser": "4.0.9",
+        "@vitest/browser": "4.0.13",
         "eslint": "9.39.1",
         "eslint-config-next": "16.0.3",
-        "glob": "11.0.3",
-        "lint-staged": "16.2.6",
+        "glob": "13.0.0",
+        "lint-staged": "16.2.7",
         "node-modules-inspector": "1.2.0",
         "npm-run-all2": "8.0.4",
-        "sass": "1.94.0",
+        "sass": "1.94.2",
         "simple-git-hooks": "2.13.1",
         "tsx": "4.20.6",
         "typescript": "5.9.3",
-        "vite": "7.2.2",
+        "vite": "7.2.4",
         "vite-plugin-dts": "4.5.4",
-        "vitest": "4.0.9"
+        "vitest": "4.0.13"
     },
     "publishConfig": {
         "access": "public",