@leexi/shared 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,143 @@
+<p align="center"><img src="https://github.com/user-attachments/assets/581a8322-430f-4912-bc11-60fc0ca099f4" width="500"></p><br><br><br>
+
+`@leexi/shared` is a collection of config files and utility functions for JavaScript or TypeScript based repositories as well as composables and components for Vue based repositores of the [Leexi-ai](https://github.com/Leexi-ai) organisation.
+
+# Installation
+```bash
+yarn add -D @leexi/shared
+```
+
+# Usage
+## esLint
+There are 2 available esLint configs.
+- **[base](https://github.com/Leexi-ai/shared/blob/master/src/eslint/base.eslint.config.ts)**: for JavaScript/TypeScript based repositories
+- **[vue](https://github.com/Leexi-ai/shared/blob/master/src/eslint/vue.eslint.config.ts)**: for Vue based repositories
+```js
+// eslint.config.js
+import base from '@leexi/shared/eslint/base';
+
+export default [
+  ...base,
+  {
+    // add custom config here
+  }
+];
+```
+
+## Utils
+```js
+import { deepDup, isSame, set } from '@leexi/shared/utils';
+
+const foo = { foo: 'bar' };
+const dup = deepDup(foo);
+if (isSame(foo, dup)) {
+  set(foo, ['foo'], 'fiz');
+}
+```
+
+## Composables
+```vue
+<script setup>
+  import { useLocalStorage } from '@leexi/shared/composables'
+
+  const mode = useLocalStorage('mode', 'dark')
+</script>
+```
+
+## Nuxt
+This package provides a module for Nuxt to auto import every component, composable and util in a Nuxt based repository
+```js
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: [
+    '@leexi/shared'
+  ],
+
+  leexi: {
+    composables: true, // whether composables should be auto-imported. Defaults to true
+    utils: true, // whether utils should be auto-imported. Defaults to true
+  }
+})
+```
+
+# API
+- [Composables](#composables)
+   - [useLocalStorage](#uselocalstorage)
+- [Utils](#utils)
+   - [Records](#records)
+      - [set](#set)
+   - [Strings](#strings)
+      - [capitalize](#capitalize)
+   - [Objects](#objects)
+      - [deepDup](#deepdup)
+      - [isSame](#issame)
+
+## Composables
+### useLocalStorage
+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
+- Type
+```ts
+const useLocalStorage: <T>(key: string, defaultValue?: T) => Ref<undefined | T>;
+```
+- Example
+```ts
+const fooOne = useLocalStorage('foo')
+const fooTwo = useLocalStorage('foo', 'bar')
+fooOne.value // => 'bar'
+localStorage.foo // => '"bar"'
+```
+
+## Utils
+### Records
+#### set
+Deeply sets an attribute at a specified path within a nested object.
+**This method is destructive.**
+- Type
+```ts
+const set: <T extends Record<string, unknown>, const P extends string[], V>(record: T, path: P, value: V) => SetRecord<T, P, V>;
+```
+- Example
+```ts
+const foo = {}
+set(foo, ['bar', 'biz'], 'fiz')
+foo // => { bar: { biz: 'fiz' } }
+```
+
+### Strings
+#### capitalize
+Capitalizes a string
+- Type
+```ts
+const capitalize: (string?: string) => string;
+```
+- Example
+```ts
+capitalize('foo') // => 'Foo'
+```
+
+### Objects
+#### deepDup
+Deeply duplicates an object.
+- Type
+```ts
+const deepDup: <T extends object>(object: T) => T;
+```
+- Example
+```ts
+const object = [{ foo: 'bar' }]
+const dup = deepDup(object) // => `[{ foo: 'bar' }]`
+object === dup // => `false`
+```
+
+#### isSame
+Compares whether two objects are identical.
+- Type
+```ts
+const isSame: (a: object, b: object) => boolean;
+```
+- Example
+```ts
+isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
+isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+```

package/dist/module.d.cts

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

package/dist/module.d.mts

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

package/dist/module.json

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

package/dist/module.mjs

@@ -0,0 +1,18 @@
+import { createJiti } from "../node_modules/jiti/lib/jiti.mjs";
+
+const jiti = createJiti(import.meta.url, {
+  "interopDefault": true,
+  "alias": {
+    "@leexi/shared": "/home/joenn/code/joenn/leexi/shared"
+  },
+  "transformOptions": {
+    "babel": {
+      "plugins": []
+    }
+  }
+})
+
+/** @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;

package/dist/types.d.mts

@@ -0,0 +1,13 @@
+import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.mjs'
+
+declare module '#app' {
+  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
+}
+
+declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+export * from "./module.mjs"

package/package.json

@@ -1,39 +1,50 @@
 {
+  "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.2.0",
-  "scripts": {
-    "build": "yarn lint && yarn test --reporter default && tsc && tsc -p tsconfig.build.json",
-    "lint": "eslint .",
-    "postinstall": "nuxt prepare",
-    "test": "vitest run"
-  },
+  "version": "0.3.0",
   "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": "yarn prepare && yarn lint && yarn test --reporter default && yarn tsc && yarn prepack && bun run lib/readme",
+    "dev": "nuxi dev playground",
+    "lint": "eslint .",
+    "prepack": "nuxt-module-build build",
+    "prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "test": "vitest run",
+    "tsc": "vue-tsc --noEmit"
+  },
   "dependencies": {
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "@stylistic/eslint-plugin-ts": "^4.2.0",
@@ -46,6 +57,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 +65,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.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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) => any;

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;
-};