@leexi/shared 0.2.1 → 0.3.1

package/dist/module.d.mts

@@ -0,0 +1,11 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+declare const _default: _nuxt_schema.NuxtModule<{
+    composables: boolean;
+    utils: boolean;
+}, {
+    composables: boolean;
+    utils: boolean;
+}, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "configKey": "leexi",
+  "name": "@leexi/shared",
+  "version": "0.3.1",
+  "builder": {
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,39 @@
+import { readdirSync, statSync } from 'fs';
+import { defineNuxtModule, createResolver, addImports } from '@nuxt/kit';
+
+const module = defineNuxtModule({
+  defaults: {
+    composables: true,
+    utils: true
+  },
+  meta: {
+    configKey: "leexi",
+    name: "@leexi/shared"
+  },
+  setup: (options) => {
+    const resolver = createResolver(import.meta.url);
+    const addImportsDir = (dir) => {
+      const files = readdirSync(dir);
+      files.forEach((file) => {
+        if (/index/.test(file) || /\.d\.ts/.test(file)) {
+          return;
+        }
+        const path = resolver.resolve(`${dir}/${file}`);
+        const stat = statSync(path);
+        if (stat.isDirectory()) {
+          return addImportsDir(path);
+        }
+        const [name] = file.split(".");
+        addImports({ as: name, from: path, name });
+      });
+    };
+    if (options.composables) {
+      addImportsDir(resolver.resolve("./runtime/composables"));
+    }
+    if (options.utils) {
+      addImportsDir(resolver.resolve("./runtime/utils"));
+    }
+  }
+});
+
+export { module as default };

package/dist/runtime/composables/index.d.ts

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

package/dist/runtime/composables/index.js

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

package/dist/{composables → runtime/composables}/useLocalStorage.d.ts

@@ -1,9 +1,10 @@
+import type { Ref } from 'vue';
 /**
  * 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
  *
- * @param  key - a key pointing to a localStorage value
- * @param  defaultValue - an optional default value used if the localStorage value is undefined
+ * @param key - a key pointing to a localStorage value
+ * @param defaultValue - an optional default value used if the localStorage value is undefined
  * @returns a reactive variable pointing to that localStorage value
  *
  * @example
@@ -12,4 +13,4 @@
  * fooOne.value // => 'bar'
  * localStorage.foo // => '"bar"'
  */
-export declare const useLocalStorage: <T>(key: string, defaultValue?: T) => any;
+export declare const useLocalStorage: <T>(key: string, defaultValue?: T) => Ref<undefined | T>;

package/dist/runtime/composables/useLocalStorage.js

@@ -0,0 +1,12 @@
+import { useState, watch } from "#imports";
+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/dist/runtime/utils/index.d.ts

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

package/dist/runtime/utils/index.js

@@ -0,0 +1,3 @@
+export * from "./objects/index.js";
+export * from "./records/index.js";
+export * from "./strings/index.js";

package/dist/{utils → runtime/utils}/objects/deepDup.d.ts

@@ -1,9 +1,6 @@
 /**
  * Deeply duplicates an object.
  *
- * @param object - an object
- * @returns a duplicate of the same object
- *
  * @example
  * const object = [{ foo: 'bar' }]
  * const dup = deepDup(object) // => `[{ foo: 'bar' }]`

package/dist/runtime/utils/objects/deepDup.js

@@ -0,0 +1,17 @@
+export const deepDup = (object) => {
+  if (!object || typeof object !== "object") {
+    return object;
+  }
+  const duplicate = (value) => value && typeof value === "object" ? deepDup(value) : value;
+  if (Array.isArray(object)) {
+    return object.map(duplicate);
+  }
+  if (object instanceof Set) {
+    return new Set([...object].map(duplicate));
+  }
+  if (Object.getPrototypeOf(object) === Object.prototype) {
+    const dup = Object.entries(object).map(([key, value]) => [key, duplicate(value)]);
+    return Object.fromEntries(dup);
+  }
+  return object;
+};

package/dist/runtime/utils/objects/index.js

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

package/dist/{utils → runtime/utils}/objects/isSame.d.ts

@@ -1,10 +1,6 @@
 /**
  * Compares whether two objects are identical.
  *
- * @param a - an object
- * @param b - another object
- * @returns whether these objects are identical
- *
  * @example
  * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
  * isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`

package/dist/runtime/utils/objects/isSame.js

@@ -0,0 +1 @@
+export const isSame = (a, b) => JSON.stringify(a) === JSON.stringify(b);

package/dist/runtime/utils/records/index.d.ts

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

package/dist/runtime/utils/records/index.js

@@ -0,0 +1 @@
+export { set } from "./set.js";

package/dist/runtime/utils/records/set.d.ts

@@ -0,0 +1,19 @@
+type SetRecord<T extends Record<string, unknown>, P extends readonly string[], V> = P extends [infer F extends string, ...infer R extends readonly string[]] ? T & {
+    [K in F]: R extends [] ? V : SetRecord<T[K] extends T ? T[K] : {}, R, V>;
+} : T;
+/**
+ * Deeply sets an attribute at a specified path within a nested object.
+ * **This method is destructive.**
+ *
+ * @param record - a record
+ * @param path - an array of strings leading to a deeply nested key in the record
+ * @param value - a value to be set at the given path
+ * @returns the mutated record
+ *
+ * @example
+ * const foo = {}
+ * set(foo, ['bar', 'biz'], 'fiz')
+ * foo // => { bar: { biz: 'fiz' } }
+ */
+export declare const set: <T extends Record<string, unknown>, const P extends string[], V>(record: T, path: P, value: V) => SetRecord<T, P, V>;
+export {};

package/dist/runtime/utils/records/set.js

@@ -0,0 +1,5 @@
+export const set = (record, path, value) => {
+  const [key, ...rest] = path;
+  Object.assign(record, { ...record, [key]: rest.length ? set(record[key] ?? {}, rest, value) : value });
+  return record;
+};

package/dist/runtime/utils/strings/capitalize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Capitalizes a string
+ *
+ * @example
+ * capitalize('foo') // => 'Foo'
+ */
+export declare const capitalize: (string?: string) => string;

package/dist/runtime/utils/strings/capitalize.js

@@ -0,0 +1 @@
+export const capitalize = (string = "") => `${string.charAt(0).toUpperCase()}${string.slice(1)}`;

package/dist/runtime/utils/strings/index.d.ts

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

package/dist/runtime/utils/strings/index.js

@@ -0,0 +1 @@
+export { capitalize } from "./capitalize.js";

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -1,39 +1,52 @@
 {
+  "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.2.1",
-  "scripts": {
-    "build": "yarn lint && yarn test --reporter default && yarn tsc && tsc -p tsconfig.build.json",
-    "lint": "eslint .",
-    "test": "vitest run",
-    "tsc": "nuxt prepare && tsc"
-  },
+  "version": "0.3.1",
   "exports": {
     "./composables": {
-      "import": "./dist/composables/index.js",
-      "types": "./dist/composables/index.d.ts"
+      "import": "./dist/runtime/composables/index.js",
+      "types": "./dist/runtime/composables/index.d.ts"
     },
     "./eslint/base": {
-      "import": "./dist/eslint/base.js",
-      "types": "./dist/eslint/base.d.ts"
+      "import": "./dist/eslint/base.eslint.config.mjs",
+      "types": "./dist/eslint/base.eslint.config.d.ts"
     },
     "./eslint/vue": {
-      "import": "./dist/eslint/vue.js",
-      "types": "./dist/eslint/vue.d.ts"
+      "import": "./dist/eslint/vue.eslint.config.mjs",
+      "types": "./dist/eslint/vue.eslint.config.d.ts"
     },
     "./utils": {
-      "import": "./dist/utils/index.js",
-      "types": "./dist/utils/index.d.ts"
+      "import": "./dist/runtime/utils/index.js",
+      "types": "./dist/runtime/utils/index.d.ts"
     },
     ".": {
-      "import": "./dist/module.js",
-      "types": "./dist/module.d.ts"
+      "import": "./dist/module.mjs",
+      "types": "./dist/module.d.mts"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
     }
   },
   "files": [
     "dist"
   ],
-  "main": "./dist/module.js",
+  "scripts": {
+    "build": "nuxt-module-build build && bun run lib/readme",
+    "dev": "nuxi dev playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "lint": "eslint .",
+    "postinstall": "yarn dev:prepare",
+    "prepack": "yarn lint && yarn test --reporter default && yarn tsc && yarn build",
+    "release": "npm publish",
+    "test": "vitest run",
+    "tsc": "vue-tsc --noEmit"
+  },
   "dependencies": {
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "@stylistic/eslint-plugin-ts": "^4.2.0",
@@ -46,6 +59,7 @@
     "vue-eslint-parser": "^10.1.1"
   },
   "devDependencies": {
+    "@nuxt/module-builder": "^1.0.1",
     "@nuxt/test-utils": "^3.17.2",
     "@types/node": "^22.14.0",
     "eslint": "^9.23.0",
@@ -53,7 +67,7 @@
     "nuxt": "^3.16.2",
     "tailwindcss": "<4.0.0",
     "vitest": "^3.1.1",
-    "vue": "^3.5.13"
+    "vue-tsc": "^2.2.8"
   },
   "peerDependencies": {
     "eslint": ">9.0.0"

package/dist/composables/index.d.ts

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

package/dist/composables/index.js

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

package/dist/composables/useLocalStorage.js

@@ -1,27 +0,0 @@
-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
- *
- * @param  key - a key pointing to a localStorage value
- * @param  defaultValue - an optional default value used if the localStorage value is undefined
- * @returns 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/dist/eslint/base.js

@@ -1,110 +0,0 @@
-import js from '@eslint/js';
-import stylisticJS from '@stylistic/eslint-plugin-js';
-import stylisticTS from '@stylistic/eslint-plugin-ts';
-import globals from 'globals';
-import tseslint from 'typescript-eslint';
-export default [
-    js.configs.recommended,
-    ...tseslint.configs.recommended,
-    // base config
-    {
-        languageOptions: {
-            globals: {
-                ...globals.browser,
-                ...globals.node,
-            },
-            parserOptions: {
-                ecmaVersion: 'latest',
-                sourceType: 'module',
-            },
-        },
-        plugins: {
-            '@stylistic/js': stylisticJS,
-        },
-        rules: {
-            'arrow-body-style': ['error', 'as-needed'],
-            'eqeqeq': ['error', 'smart'],
-            'no-console': 'error',
-            'no-unused-vars': ['error', {
-                    argsIgnorePattern: '^_',
-                    destructuredArrayIgnorePattern: '^_',
-                    ignoreRestSiblings: true,
-                }],
-            'prefer-const': ['error', {
-                    destructuring: 'all',
-                }],
-            'prefer-template': 'error',
-            '@stylistic/js/array-bracket-spacing': ['error', 'never'],
-            '@stylistic/js/comma-dangle': ['error', 'always-multiline'],
-            '@stylistic/js/comma-spacing': 'error',
-            '@stylistic/js/eol-last': ['error', 'always'],
-            '@stylistic/js/indent': ['error', 2, {
-                    SwitchCase: 1,
-                }],
-            '@stylistic/js/key-spacing': 'error',
-            '@stylistic/js/keyword-spacing': 'error',
-            '@stylistic/js/no-multi-spaces': 'error',
-            '@stylistic/js/no-multiple-empty-lines': ['error', {
-                    max: 1,
-                }],
-            '@stylistic/js/no-trailing-spaces': 'error',
-            '@stylistic/js/object-curly-spacing': ['error', 'always'],
-            '@stylistic/js/quotes': ['error', 'single'],
-            '@stylistic/js/quote-props': ['error', 'consistent-as-needed'],
-            '@stylistic/js/semi': ['error', 'always'],
-            '@stylistic/js/semi-spacing': 'error',
-            '@stylistic/js/space-before-blocks': ['error', 'always'],
-            '@stylistic/js/space-before-function-paren': ['error', 'always'],
-            '@stylistic/js/space-in-parens': ['error', 'never'],
-            '@stylistic/js/space-infix-ops': 'error',
-            '@stylistic/js/spaced-comment': 'error',
-            '@stylistic/js/template-curly-spacing': ['error', 'never'],
-            '@typescript-eslint/no-unused-expressions': 'off',
-            '@typescript-eslint/no-unused-vars': ['error', {
-                    argsIgnorePattern: '^_',
-                    destructuredArrayIgnorePattern: '^_',
-                    ignoreRestSiblings: true,
-                }],
-        },
-    },
-    // typescript
-    {
-        files: ['**/*.ts'],
-        plugins: {
-            '@stylistic/ts': stylisticTS,
-        },
-        rules: {
-            '@stylistic/js/comma-dangle': 'off',
-            '@stylistic/js/comma-spacing': 'off',
-            '@stylistic/js/indent': 'off',
-            '@stylistic/js/key-spacing': 'off',
-            '@stylistic/js/keyword-spacing': 'off',
-            '@stylistic/js/object-curly-spacing': 'off',
-            '@stylistic/js/quotes': 'off',
-            '@stylistic/js/quote-props': 'off',
-            '@stylistic/js/semi': 'off',
-            '@stylistic/js/space-before-blocks': 'off',
-            '@stylistic/js/space-before-function-paren': 'off',
-            '@stylistic/js/space-infix-ops': 'off',
-            '@stylistic/ts/comma-dangle': ['error', 'always-multiline'],
-            '@stylistic/ts/comma-spacing': 'error',
-            '@stylistic/ts/indent': ['error', 2, {
-                    SwitchCase: 1,
-                }],
-            '@stylistic/ts/key-spacing': 'error',
-            '@stylistic/ts/keyword-spacing': 'error',
-            '@stylistic/ts/object-curly-spacing': ['error', 'always'],
-            '@stylistic/ts/quotes': ['error', 'single'],
-            '@stylistic/ts/quote-props': ['error', 'consistent-as-needed'],
-            '@stylistic/ts/semi': ['error', 'always'],
-            '@stylistic/ts/space-before-blocks': ['error', 'always'],
-            '@stylistic/ts/space-before-function-paren': ['error', 'always'],
-            '@stylistic/ts/space-infix-ops': 'error',
-        },
-    },
-    {
-        ignores: [
-            'node_modules/',
-        ],
-    },
-];

package/dist/eslint/vue.js

@@ -1,43 +0,0 @@
-import tailwind from 'eslint-plugin-tailwindcss';
-import vue from 'eslint-plugin-vue';
-import base from './base.js';
-export default [
-    ...base,
-    ...tailwind.configs['flat/recommended'],
-    ...vue.configs['flat/recommended'],
-    {
-        files: ['**/*.vue'],
-        rules: {
-            '@stylistic/js/indent': 'off',
-            '@stylistic/js/object-curly-spacing': 'off',
-            'tailwindcss/no-custom-classname': 'error',
-            'vue/attributes-order': ['error', {
-                    alphabetical: true,
-                }],
-            'vue/component-name-in-template-casing': ['error', 'PascalCase', {
-                    registeredComponentsOnly: false,
-                }],
-            'vue/first-attribute-linebreak': ['error', {
-                    singleline: 'beside',
-                }],
-            'vue/multi-word-component-names': 'off',
-            'vue/no-bare-strings-in-template': ['error', {
-                    allowlist: ['Leexi'],
-                }],
-            'vue/object-curly-spacing': ['error', 'always'],
-            'vue/prefer-template': 'error',
-            'vue/script-indent': ['error', 2, {
-                    baseIndent: 1,
-                    switchCase: 1,
-                }],
-            'vue/template-curly-spacing': ['error', 'never'],
-        },
-    },
-    {
-        ignores: [
-            '.nuxt/',
-            '.output/',
-            'dist/',
-        ],
-    },
-];

package/dist/module.d.ts

@@ -1,8 +0,0 @@
-declare const _default: import("@nuxt/schema").NuxtModule<{
-    composables: boolean;
-    utils: boolean;
-}, {
-    composables: boolean;
-    utils: boolean;
-}, false>;
-export default _default;

package/dist/module.js

@@ -1,36 +0,0 @@
-import { readdirSync, statSync } from 'fs';
-import { addImports, createResolver, defineNuxtModule } from '@nuxt/kit';
-export default defineNuxtModule({
-    defaults: {
-        composables: true,
-        utils: true,
-    },
-    meta: {
-        configKey: 'leexi',
-        name: '@leexi/shared',
-    },
-    setup: options => {
-        const resolver = createResolver(import.meta.url);
-        const addImportsDir = (dir) => {
-            const files = readdirSync(dir);
-            files.forEach(file => {
-                if (/index/.test(file) || /\.d\.ts/.test(file)) {
-                    return;
-                }
-                const path = resolver.resolve(`${dir}/${file}`);
-                const stat = statSync(path);
-                if (stat.isDirectory()) {
-                    return addImportsDir(path);
-                }
-                const [name] = file.split('.');
-                addImports({ as: name, from: path, name });
-            });
-        };
-        if (options.composables) {
-            addImportsDir(resolver.resolve('./composables'));
-        }
-        if (options.utils) {
-            addImportsDir(resolver.resolve('./utils'));
-        }
-    },
-});

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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

package/dist/utils/objects/deepDup.js

@@ -1,28 +0,0 @@
-/**
- * Deeply duplicates an object.
- *
- * @param object - an object
- * @returns 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;
-    }
-    const duplicate = (value) => value && typeof value === 'object' ? deepDup(value) : value;
-    if (Array.isArray(object)) {
-        return object.map(duplicate);
-    }
-    if (object instanceof Set) {
-        return new Set([...object].map(duplicate));
-    }
-    if (Object.getPrototypeOf(object) === Object.prototype) {
-        const dup = Object.entries(object).map(([key, value]) => [key, duplicate(value)]);
-        return Object.fromEntries(dup);
-    }
-    return object;
-};

package/dist/utils/objects/index.js

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

package/dist/utils/objects/isSame.js

@@ -1,12 +0,0 @@
-/**
- * Compares whether two objects are identical.
- *
- * @param a - an object
- * @param b - another object
- * @returns 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);