@leexi/shared 0.3.0 → 0.3.2

package/dist/eslint/vue.eslint.config.mjs

@@ -0,0 +1,48 @@
+import tailwind from "eslint-plugin-tailwindcss";
+import tseslint from "typescript-eslint";
+import vue from "eslint-plugin-vue";
+import base from "./base.eslint.config.mjs";
+export default [
+  ...base,
+  ...tailwind.configs["flat/recommended"],
+  ...vue.configs["flat/recommended"],
+  {
+    files: ["**/*.vue"],
+    languageOptions: {
+      parserOptions: {
+        parser: tseslint.parser
+      }
+    },
+    rules: {
+      "@stylistic/js/indent": "off",
+      "@stylistic/js/object-curly-spacing": "off",
+      "@stylistic/ts/indent": "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",
+      "vue/object-curly-spacing": ["error", "always"],
+      "vue/prefer-template": "error",
+      "vue/require-default-prop": "off",
+      "vue/script-indent": ["error", 2, {
+        switchCase: 1
+      }],
+      "vue/template-curly-spacing": ["error", "never"]
+    }
+  },
+  {
+    ignores: [
+      "**/.nuxt/",
+      "**/.output/",
+      "**/dist/"
+    ]
+  }
+];

package/dist/module.d.mts

@@ -1,2 +1,11 @@
-export * from "/home/joenn/code/joenn/leexi/shared/src/module.js";
-export { default } from "/home/joenn/code/joenn/leexi/shared/src/module.js";
+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

@@ -1,7 +1,7 @@
 {
   "configKey": "leexi",
   "name": "@leexi/shared",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "builder": {
     "@nuxt/module-builder": "1.0.1",
     "unbuild": "3.5.0"

package/dist/module.mjs

@@ -1,18 +1,39 @@
-import { createJiti } from "../node_modules/jiti/lib/jiti.mjs";
+import { readdirSync, statSync } from 'fs';
+import { defineNuxtModule, createResolver, addImports } from '@nuxt/kit';
 
-const jiti = createJiti(import.meta.url, {
-  "interopDefault": true,
-  "alias": {
-    "@leexi/shared": "/home/joenn/code/joenn/leexi/shared"
+const module = defineNuxtModule({
+  defaults: {
+    composables: true,
+    utils: true
   },
-  "transformOptions": {
-    "babel": {
-      "plugins": []
+  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"));
     }
   }
-})
-
-/** @type {import("/home/joenn/code/joenn/leexi/shared/src/module.js")} */
-const _module = await jiti.import("/home/joenn/code/joenn/leexi/shared/src/module.ts");
+});
 
-export default _module?.default ?? _module;
+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/runtime/composables/useLocalStorage.d.ts

@@ -0,0 +1,16 @@
+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
+ * @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 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/runtime/utils/objects/deepDup.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Deeply duplicates an object.
+ *
+ * @example
+ * const object = [{ foo: 'bar' }]
+ * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
+ * object === dup // => `false`
+ */
+export declare const deepDup: <T extends object>(object: T) => T;

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.d.ts

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

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

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

package/dist/runtime/utils/objects/isSame.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Compares whether two objects are identical.
+ *
+ * @example
+ * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
+ * isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+ */
+export declare const isSame: (a: object, b: object) => boolean;

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

@@ -1,13 +1,7 @@
-import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.mjs'
+import type { NuxtModule } from '@nuxt/schema'
 
-declare module '#app' {
-  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
-}
+import type { default as Module } from './module.mjs'
 
-declare module '@nuxt/schema' {
-  interface NuxtHooks extends ModuleHooks {}
-  interface RuntimeConfig extends ModuleRuntimeConfig {}
-  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
-}
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-export * from "./module.mjs"
+export { default } from './module.mjs'

package/package.json

@@ -2,7 +2,7 @@
   "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "exports": {
     "./composables": {
       "import": "./dist/runtime/composables/index.js",
@@ -37,11 +37,11 @@
     "dist"
   ],
   "scripts": {
-    "build": "yarn prepare && yarn lint && yarn test --reporter default && yarn tsc && yarn prepack && bun run lib/readme",
+    "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 .",
-    "prepack": "nuxt-module-build build",
-    "prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "prepack": "yarn lint && yarn test --reporter default && yarn tsc && yarn build",
     "test": "vitest run",
     "tsc": "vue-tsc --noEmit"
   },

package/dist/module.d.cts

@@ -1,2 +0,0 @@
-export * from "/home/joenn/code/joenn/leexi/shared/src/module.js";
-export { default } from "/home/joenn/code/joenn/leexi/shared/src/module.js";