@leexi/shared 0.0.6 → 0.1.0

package/package.json

@@ -1,11 +1,22 @@
 {
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "scripts": {
     "lint": "eslint .",
     "test": "vitest run"
   },
+  "exports": {
+    "./composables": "./src/composables/index.js",
+    "./eslint/base": "./src/eslint/base.js",
+    "./eslint/vue": "./src/eslint/vue.js",
+    "./utils": "./src/utils/index.js",
+    ".": "./src/module.js"
+  },
+  "files": [
+    "src"
+  ],
+  "main": "./src/module.js",
   "dependencies": {
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "@stylistic/eslint-plugin-ts": "^4.2.0",
@@ -18,21 +29,16 @@
     "vue-eslint-parser": "^10.1.1"
   },
   "devDependencies": {
+    "@leexi/shared": "^0.0.6",
+    "@nuxt/test-utils": "^3.17.2",
     "eslint": "^9.23.0",
     "happy-dom": "^17.4.4",
+    "nuxt": "^3.16.2",
     "tailwindcss": "<4.0.0",
-    "vitest": "^3.1.1"
+    "vitest": "^3.1.1",
+    "vue": "^3.5.13"
   },
   "peerDependencies": {
     "eslint": ">9.0.0"
-  },
-  "exports": {
-    "./eslint/base": "./eslint/base.js",
-    "./eslint/vue": "./eslint/vue.js",
-    "./utils": "./utils/index.js"
-  },
-  "files": [
-    "eslint",
-    "utils"
-  ]
+  }
 }

package/src/composables/index.js

@@ -0,0 +1 @@
+export { useLocalStorage } from './useLocalStorage.js';

package/src/composables/useLocalStorage.js

@@ -0,0 +1,30 @@
+import { useState, watch } from '#imports';
+
+/**
+ * Creates a reactive pointer to a specific localStorage value.
+ * The value is stored in the localStorage as a JSON stringified data to enable parsing primitives and objects
+ *
+ * @template T extends unknown
+ * @param {string} key - a key pointing to a localStorage value
+ * @param {T} [defaultValue] - an optional default value used if the localStorage value is undefined
+ * @returns {Ref<T>} a reactive variable pointing to that localStorage value
+ *
+ * @example
+ * const fooOne = useLocalStorage('foo')
+ * const fooTwo = useLocalStorage('foo', 'bar')
+ * fooOne.value // => 'bar'
+ * localStorage.foo // => '"bar"'
+ */
+export const useLocalStorage = (key, defaultValue) => {
+  const data = useState(key, () => JSON.parse(localStorage?.getItem(key) || null) || defaultValue);
+
+  watch(data, () => {
+    if (data.value) {
+      localStorage?.setItem(key, JSON.stringify(data.value));
+    } else {
+      localStorage?.removeItem(key);
+    }
+  }, { immediate: true });
+
+  return data;
+};

package/src/module.js

@@ -0,0 +1,18 @@
+import { addImportsDir, createResolver, defineNuxtModule } from '@nuxt/kit';
+
+export default defineNuxtModule({
+  meta: {
+    configKey: 'leexi',
+    defaults: {
+      composables: true,
+      utils: true,
+    },
+    name: '@leexi/shared',
+  },
+  setup (options) {
+    const resolver = createResolver(import.meta.url);
+
+    if (options.composables) { addImportsDir(resolver.resolve('./composables')); }
+    if (options.utils) { addImportsDir(resolver.resolve('./utils')); }
+  },
+});

package/src/utils/index.js

@@ -0,0 +1 @@
+export * from './objects/index.js';

package/{utils → src/utils}/objects/deepDup.js

@@ -1,3 +1,14 @@
+/**
+ * Deeply duplicates an object.
+ *
+ * @param {object} object - an object
+ * @returns {object} a duplicate of the same object
+ *
+ * @example
+ * const object = [{ foo: 'bar' }]
+ * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
+ * object === dup // => `false`
+ */
 export const deepDup = object => {
   if (!object || typeof object !== 'object') { return object; }
 

package/src/utils/objects/index.js

@@ -0,0 +1,2 @@
+export { deepDup } from './deepDup.js';
+export { isSame } from './isSame.js';

package/src/utils/objects/isSame.js

@@ -0,0 +1,12 @@
+/**
+ * Compares whether two objects are identical.
+ *
+ * @param {object} a - an object
+ * @param {object} b - another object
+ * @returns {boolean} whether these objects are identical
+ *
+ * @example
+ * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
+ * isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+ */
+export const isSame = (a, b) => JSON.stringify(a) === JSON.stringify(b);

package/utils/index.js

@@ -1 +0,0 @@
-export { deepDup } from './objects/deepDup.js';