@leexi/shared 0.3.6 → 0.3.7

package/README.md

@@ -79,132 +79,156 @@ export default defineNuxtConfig({
 
 ## 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
+A composable that provides a reactive reference to a value stored in localStorage.
+It handles JSON parsing/stringifying and migration from kebab-case/snake_case keys to camelCase.
 - 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"'
+const userSetting = useLocalStorage('userSetting', { theme: 'light' });
+console.log(userSetting.value); // Output: { theme: 'light' }
+console.log(localStorage.userSetting); // Output: '{"theme":"light"}'
+
+const sameUserSetting = useLocalStorage('userSetting');
+console.log(sameUserSetting.value); // Output: { theme: 'light' }
+
+userSetting.value = { theme: 'dark', notifications: true };
+console.log(sameUserSetting.value); // Output: { theme: 'dark', notifications: true }
+console.log(localStorage.userSetting); // Output: '{"theme":"dark","notifications":true}'
 ```
 
 ## Utils
 ### Records
 #### set
-Deeply sets an attribute at a specified path within a nested object.
-**This method is destructive.**
+Sets a value within a nested object structure based on a provided path.
+It mutates the original object and creates nested objects if they don't exist along the path.
 - 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' } }
+const myObject = { a: { b: { c: 1 } } };
+set(myObject, ['a', 'b', 'd'], 2);
+
+console.log(myObject); // Output: { a: { b: { c: 1, d: 2 } } }
 ```
 
 #### omit
-Returns a copy of a given object excluding a given set of attributes
+Creates a new object by omitting the specified keys from the input record.
 - Type
 ```ts
 const omit: <T extends Record<string, unknown>, K extends (keyof T)[]>(record: T, keys: K) => Omit<T, K[number]>;
 ```
 - Example
 ```ts
-const foo = { a: 1, b: 2, c: 3 }
-const bar = omit(foo, ['b', 'c'])
-bar // => { a: 1 }
+const myObject = { a: 1, b: 2, c: 3, d: 4 };
+const omittedObject = omit(myObject, ['b', 'd']);
+
+console.log(omittedObject); // Output: { a: 1, c: 3 }
 ```
 
 #### pick
-Returns a copy of a given object only including a given set of attributes
+Creates a new object by picking only the specified keys from the input record.
 - Type
 ```ts
 const pick: <T extends Record<string, unknown>, K extends (keyof T)[]>(record: T, keys: K) => Pick<T, K[number]>;
 ```
 - Example
 ```ts
-const foo = { a: 1, b: 2, c: 3 }
-const bar = pick(foo, ['b', 'c'])
-bar // => { b: 2, c: 3 }
+const myObject = { a: 1, b: 2, c: 3, d: 4 };
+const pickedObject = pick(myObject, ['a', 'c']);
+
+console.log(pickedObject); // Output: { a: 1, c: 3 }
 ```
 
 ### Strings
 #### camelcase
-Convert a kebab-case string or a snake_case string to a camelCase string
+Converts a string from snake_case or kebab-case to camelCase.
 - Type
 ```ts
 const camelcase: (string: string) => string;
 ```
 - Example
 ```ts
-camelcase('foo_bar') // => 'fooBar'
-camelcase('foo-bar') // => 'fooBar'
+console.log(camelcase('my_variable_name')); // Output: myVariableName
+console.log(camelcase('my-variable-name')); // Output: myVariableName
+console.log(camelcase('myVariable')); // Output: myVariable
 ```
 
 #### capitalize
-Capitalizes a string
+Capitalizes the first letter of a string.
 - Type
 ```ts
-const capitalize: (string?: string) => string;
+const capitalize: (string: string) => string;
 ```
 - Example
 ```ts
-capitalize('foo') // => 'Foo'
+console.log(capitalize('hello world')); // Output: Hello world
+console.log(capitalize('')); // Output: ''
 ```
 
 #### kebabcase
-Convert a camelCase string or a snake_case string to a kebab-case string
+Converts a string from camelCase or snake_case to kebab-case.
 - Type
 ```ts
 const kebabcase: (string: string) => string;
 ```
 - Example
 ```ts
-kebabcase('fooBar') // => 'foo-bar'
-kebabcase('foo_bar') // => 'foo-bar'
+console.log(kebabcase('myVariableName')); // Output: my-variable-name
+console.log(kebabcase('my_variable_name')); // Output: my-variable-name
+console.log(kebabcase('my-variable-name')); // Output: my-variable-name
 ```
 
 #### snakecase
-Convert a camelCase string or a kebab-case string to a snake_case string
+Converts a string from camelCase or kebab-case to snake_case.
 - Type
 ```ts
 const snakecase: (string: string) => string;
 ```
 - Example
 ```ts
-snakecase('fooBar') // => 'foo_bar'
-snakecase('foo-bar') // => 'foo_bar'
+console.log(snakecase('myVariableName')); // Output: my_variable_name
+console.log(snakecase('my-variable-name')); // Output: my_variable_name
+console.log(snakecase('my_variable_name')); // Output: my_variable_name
 ```
 
 ### Objects
 #### deepDup
-Deeply duplicates an object.
+Creates a deep duplicate of an object, array, or Set.
+It handles nested objects, arrays, and Sets but does not handle functions, Dates, or circular references.
 - 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`
+const originalObject = { a: 1, b: { c: 2, d: [3, 4] }, e: new Set([5, 6]) };
+const duplicatedObject = deepDup(originalObject);
+
+console.log(duplicatedObject); // Output: { a: 1, b: { c: 2, d: [3, 4] }, e: Set { 5, 6 } }
+console.log(originalObject === duplicatedObject); // Output: false
+console.log(originalObject.b === duplicatedObject.b); // Output: false
+console.log(originalObject.b.d === duplicatedObject.b.d); // Output: false
+console.log(originalObject.e === duplicatedObject.e); // Output: false
 ```
 
 #### isSame
-Compares whether two objects are identical.
+Checks if two objects are the same by comparing their JSON stringified representations.
+Note: This method has limitations and may not accurately compare objects with different key orders, non-primitive values like functions or Dates, or circular references.
 - Type
 ```ts
 const isSame: (a: object, b: object) => boolean;
 ```
 - Example
 ```ts
-isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
-isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+const obj1 = { a: 1, b: 2 };
+const obj2 = { a: 1, b: 2 };
+const obj3 = { b: 2, a: 1 };
+
+console.log(isSame(obj1, obj2)); // Output: true
+console.log(isSame(obj1, obj3)); // Output: false (due to key order difference in JSON stringification)
 ```

package/dist/eslint/base.eslint.config.d.ts

@@ -7,6 +7,7 @@ declare const _default: ({
             __filename: false;
             AbortController: false;
             AbortSignal: false;
+            AsyncDisposableStack: false;
             atob: false;
             Blob: false;
             BroadcastChannel: false;
@@ -25,6 +26,7 @@ declare const _default: ({
             CryptoKey: false;
             CustomEvent: false;
             DecompressionStream: false;
+            DisposableStack: false;
             DOMException: false;
             Event: false;
             EventTarget: false;
@@ -64,6 +66,7 @@ declare const _default: ({
             setTimeout: false;
             structuredClone: false;
             SubtleCrypto: false;
+            SuppressedError: false;
             TextDecoder: false;
             TextDecoderStream: false;
             TextEncoder: false;
@@ -71,6 +74,7 @@ declare const _default: ({
             TransformStream: false;
             TransformStreamDefaultController: false;
             URL: false;
+            URLPattern: false;
             URLSearchParams: false;
             WebAssembly: false;
             WebSocket: false;
@@ -83,6 +87,7 @@ declare const _default: ({
             addEventListener: false;
             ai: false;
             AI: false;
+            AICreateMonitor: false;
             AITextSession: false;
             alert: false;
             AnalyserNode: false;
@@ -159,6 +164,7 @@ declare const _default: ({
             close: false;
             closed: false;
             CloseWatcher: false;
+            CommandEvent: false;
             Comment: false;
             CompositionEvent: false;
             confirm: false;
@@ -176,6 +182,7 @@ declare const _default: ({
             CredentialsContainer: false;
             CropTarget: false;
             crossOriginIsolated: false;
+            CSPViolationReportBody: false;
             CSS: false;
             CSSAnimation: false;
             CSSConditionRule: false;
@@ -251,6 +258,7 @@ declare const _default: ({
             DeviceMotionEventRotationRate: false;
             DeviceOrientationEvent: false;
             devicePixelRatio: false;
+            DevicePosture: false;
             dispatchEvent: false;
             document: false;
             Document: false;
@@ -305,9 +313,9 @@ declare const _default: ({
             FileSystemFileEntry: false;
             FileSystemFileHandle: false;
             FileSystemHandle: false;
+            FileSystemObserver: false;
             FileSystemWritableFileStream: false;
             find: false;
-            Float16Array: false;
             focus: false;
             FocusEvent: false;
             FontData: false;
@@ -442,6 +450,7 @@ declare const _default: ({
             HTMLProgressElement: false;
             HTMLQuoteElement: false;
             HTMLScriptElement: false;
+            HTMLSelectedContentElement: false;
             HTMLSelectElement: false;
             HTMLSlotElement: false;
             HTMLSourceElement: false;
@@ -500,6 +509,7 @@ declare const _default: ({
             KeyboardEvent: false;
             KeyboardLayoutMap: false;
             KeyframeEffect: false;
+            LanguageDetector: false;
             LargestContentfulPaint: false;
             LaunchParams: false;
             launchQueue: false;
@@ -592,6 +602,7 @@ declare const _default: ({
             NotifyPaintEvent: false;
             NotRestoredReasonDetails: false;
             NotRestoredReasons: false;
+            Observable: false;
             OfflineAudioCompletionEvent: false;
             OfflineAudioContext: false;
             offscreenBuffering: false;
@@ -619,6 +630,7 @@ declare const _default: ({
             onchange: true;
             onclick: true;
             onclose: true;
+            oncommand: true;
             oncontentvisibilityautostatechange: true;
             oncontextlost: true;
             oncontextmenu: true;
@@ -797,6 +809,7 @@ declare const _default: ({
             RelativeOrientationSensor: false;
             RemotePlayback: false;
             removeEventListener: false;
+            ReportBody: false;
             reportError: false;
             ReportingObserver: false;
             requestAnimationFrame: false;
@@ -806,6 +819,7 @@ declare const _default: ({
             ResizeObserverEntry: false;
             ResizeObserverSize: false;
             resizeTo: false;
+            RestrictionTarget: false;
             RTCCertificate: false;
             RTCDataChannel: false;
             RTCDataChannelEvent: false;
@@ -864,6 +878,11 @@ declare const _default: ({
             ShadowRoot: false;
             sharedStorage: false;
             SharedStorage: false;
+            SharedStorageAppendMethod: false;
+            SharedStorageClearMethod: false;
+            SharedStorageDeleteMethod: false;
+            SharedStorageModifierMethod: false;
+            SharedStorageSetMethod: false;
             SharedStorageWorklet: false;
             SharedWorker: false;
             showDirectoryPicker: false;
@@ -894,6 +913,7 @@ declare const _default: ({
             StyleSheet: false;
             StyleSheetList: false;
             SubmitEvent: false;
+            Subscriber: false;
             SVGAElement: false;
             SVGAngle: false;
             SVGAnimatedAngle: false;
@@ -1025,7 +1045,6 @@ declare const _default: ({
             TrustedTypePolicyFactory: false;
             trustedTypes: false;
             UIEvent: false;
-            URLPattern: false;
             USB: false;
             USBAlternateInterface: false;
             USBConfiguration: false;
@@ -1087,6 +1106,7 @@ declare const _default: ({
             WebTransportSendStream: false;
             WGSLLanguageFeatures: false;
             WheelEvent: false;
+            when: false;
             window: false;
             Window: false;
             WindowControlsOverlay: false;
@@ -1148,15 +1168,10 @@ declare const _default: ({
         };
     };
     plugins: {
-        '@stylistic/js': {
-            rules: import("@stylistic/eslint-plugin-js").Rules;
-            configs: {
-                "disable-legacy": import("eslint").Linter.Config;
-                "all": import("eslint").Linter.Config;
-                "all-flat": import("eslint").Linter.Config;
-            };
+        '@stylistic': {
+            rules: import("@stylistic/eslint-plugin").Rules;
+            configs: import("eslint").ESLint.Plugin["configs"] & import("@stylistic/eslint-plugin").Configs;
         };
-        '@stylistic/ts'?: undefined;
     };
     rules: {
         'arrow-body-style': string[];
@@ -1172,117 +1187,42 @@ declare const _default: ({
             destructuring: string;
         })[];
         'prefer-template': string;
-        '@stylistic/js/array-bracket-spacing': string[];
-        '@stylistic/js/arrow-parens': string[];
-        '@stylistic/js/comma-dangle': string[];
-        '@stylistic/js/comma-spacing': string;
-        '@stylistic/js/eol-last': string[];
-        '@stylistic/js/indent': (string | number | {
+        '@stylistic/array-bracket-spacing': string[];
+        '@stylistic/arrow-parens': string[];
+        '@stylistic/comma-dangle': string[];
+        '@stylistic/comma-spacing': string;
+        '@stylistic/eol-last': string[];
+        '@stylistic/indent': (string | number | {
             SwitchCase: number;
         })[];
-        '@stylistic/js/key-spacing': string;
-        '@stylistic/js/keyword-spacing': string;
-        '@stylistic/js/multiline-ternary': string[];
-        '@stylistic/js/no-multi-spaces': string;
-        '@stylistic/js/no-multiple-empty-lines': (string | {
+        '@stylistic/key-spacing': string;
+        '@stylistic/keyword-spacing': string;
+        '@stylistic/multiline-ternary': string[];
+        '@stylistic/no-multi-spaces': string;
+        '@stylistic/no-multiple-empty-lines': (string | {
             max: number;
         })[];
-        '@stylistic/js/no-trailing-spaces': string;
-        '@stylistic/js/object-curly-spacing': string[];
-        '@stylistic/js/quote-props': string[];
-        '@stylistic/js/quotes': string[];
-        '@stylistic/js/semi': string[];
-        '@stylistic/js/semi-spacing': string;
-        '@stylistic/js/space-before-blocks': string[];
-        '@stylistic/js/space-before-function-paren': string[];
-        '@stylistic/js/space-in-parens': string[];
-        '@stylistic/js/space-infix-ops': string;
-        '@stylistic/js/spaced-comment': string;
-        '@stylistic/js/template-curly-spacing': string[];
+        '@stylistic/no-trailing-spaces': string;
+        '@stylistic/object-curly-spacing': string[];
+        '@stylistic/quote-props': string[];
+        '@stylistic/quotes': string[];
+        '@stylistic/semi': string[];
+        '@stylistic/semi-spacing': string;
+        '@stylistic/space-before-blocks': string[];
+        '@stylistic/space-before-function-paren': string[];
+        '@stylistic/space-in-parens': string[];
+        '@stylistic/space-infix-ops': string;
+        '@stylistic/spaced-comment': string;
+        '@stylistic/template-curly-spacing': string[];
         '@typescript-eslint/no-unused-expressions': string;
         '@typescript-eslint/no-unused-vars': (string | {
             argsIgnorePattern: string;
             destructuredArrayIgnorePattern: string;
             ignoreRestSiblings: boolean;
         })[];
-        '@stylistic/ts/comma-dangle'?: undefined;
-        '@stylistic/ts/comma-spacing'?: undefined;
-        '@stylistic/ts/indent'?: undefined;
-        '@stylistic/ts/key-spacing'?: undefined;
-        '@stylistic/ts/keyword-spacing'?: undefined;
-        '@stylistic/ts/object-curly-spacing'?: undefined;
-        '@stylistic/ts/quote-props'?: undefined;
-        '@stylistic/ts/quotes'?: undefined;
-        '@stylistic/ts/semi'?: undefined;
-        '@stylistic/ts/space-before-blocks'?: undefined;
-        '@stylistic/ts/space-before-function-paren'?: undefined;
-        '@stylistic/ts/space-infix-ops'?: undefined;
         'sort-keys'?: undefined;
     };
     files?: undefined;
-} | {
-    files: string[];
-    plugins: {
-        '@stylistic/ts': {
-            rules: import("@stylistic/eslint-plugin-ts").Rules;
-            configs: {
-                "disable-legacy": import("eslint").Linter.Config;
-                "all": import("eslint").Linter.Config;
-                "all-flat": import("eslint").Linter.Config;
-            };
-        };
-        '@stylistic/js'?: undefined;
-    };
-    rules: {
-        '@stylistic/js/comma-dangle': string;
-        '@stylistic/js/comma-spacing': string;
-        '@stylistic/js/indent': string;
-        '@stylistic/js/key-spacing': string;
-        '@stylistic/js/keyword-spacing': string;
-        '@stylistic/js/object-curly-spacing': string;
-        '@stylistic/js/quote-props': string;
-        '@stylistic/js/quotes': string;
-        '@stylistic/js/semi': string;
-        '@stylistic/js/space-before-blocks': string;
-        '@stylistic/js/space-before-function-paren': string;
-        '@stylistic/js/space-infix-ops': string;
-        '@stylistic/ts/comma-dangle': string[];
-        '@stylistic/ts/comma-spacing': string;
-        '@stylistic/ts/indent': (string | number | {
-            SwitchCase: number;
-        })[];
-        '@stylistic/ts/key-spacing': string;
-        '@stylistic/ts/keyword-spacing': string;
-        '@stylistic/ts/object-curly-spacing': string[];
-        '@stylistic/ts/quote-props': string[];
-        '@stylistic/ts/quotes': string[];
-        '@stylistic/ts/semi': string[];
-        '@stylistic/ts/space-before-blocks': string[];
-        '@stylistic/ts/space-before-function-paren': string[];
-        '@stylistic/ts/space-infix-ops': string;
-        'arrow-body-style'?: undefined;
-        eqeqeq?: undefined;
-        'no-console'?: undefined;
-        'no-nested-ternary'?: undefined;
-        'no-unused-vars'?: undefined;
-        'prefer-const'?: undefined;
-        'prefer-template'?: undefined;
-        '@stylistic/js/array-bracket-spacing'?: undefined;
-        '@stylistic/js/arrow-parens'?: undefined;
-        '@stylistic/js/eol-last'?: undefined;
-        '@stylistic/js/multiline-ternary'?: undefined;
-        '@stylistic/js/no-multi-spaces'?: undefined;
-        '@stylistic/js/no-multiple-empty-lines'?: undefined;
-        '@stylistic/js/no-trailing-spaces'?: undefined;
-        '@stylistic/js/semi-spacing'?: undefined;
-        '@stylistic/js/space-in-parens'?: undefined;
-        '@stylistic/js/spaced-comment'?: undefined;
-        '@stylistic/js/template-curly-spacing'?: undefined;
-        '@typescript-eslint/no-unused-expressions'?: undefined;
-        '@typescript-eslint/no-unused-vars'?: undefined;
-        'sort-keys'?: undefined;
-    };
-    languageOptions?: undefined;
 } | {
     files: string[];
     rules: {
@@ -1297,43 +1237,31 @@ declare const _default: ({
         'no-unused-vars'?: undefined;
         'prefer-const'?: undefined;
         'prefer-template'?: undefined;
-        '@stylistic/js/array-bracket-spacing'?: undefined;
-        '@stylistic/js/arrow-parens'?: undefined;
-        '@stylistic/js/comma-dangle'?: undefined;
-        '@stylistic/js/comma-spacing'?: undefined;
-        '@stylistic/js/eol-last'?: undefined;
-        '@stylistic/js/indent'?: undefined;
-        '@stylistic/js/key-spacing'?: undefined;
-        '@stylistic/js/keyword-spacing'?: undefined;
-        '@stylistic/js/multiline-ternary'?: undefined;
-        '@stylistic/js/no-multi-spaces'?: undefined;
-        '@stylistic/js/no-multiple-empty-lines'?: undefined;
-        '@stylistic/js/no-trailing-spaces'?: undefined;
-        '@stylistic/js/object-curly-spacing'?: undefined;
-        '@stylistic/js/quote-props'?: undefined;
-        '@stylistic/js/quotes'?: undefined;
-        '@stylistic/js/semi'?: undefined;
-        '@stylistic/js/semi-spacing'?: undefined;
-        '@stylistic/js/space-before-blocks'?: undefined;
-        '@stylistic/js/space-before-function-paren'?: undefined;
-        '@stylistic/js/space-in-parens'?: undefined;
-        '@stylistic/js/space-infix-ops'?: undefined;
-        '@stylistic/js/spaced-comment'?: undefined;
-        '@stylistic/js/template-curly-spacing'?: undefined;
+        '@stylistic/array-bracket-spacing'?: undefined;
+        '@stylistic/arrow-parens'?: undefined;
+        '@stylistic/comma-dangle'?: undefined;
+        '@stylistic/comma-spacing'?: undefined;
+        '@stylistic/eol-last'?: undefined;
+        '@stylistic/indent'?: undefined;
+        '@stylistic/key-spacing'?: undefined;
+        '@stylistic/keyword-spacing'?: undefined;
+        '@stylistic/multiline-ternary'?: undefined;
+        '@stylistic/no-multi-spaces'?: undefined;
+        '@stylistic/no-multiple-empty-lines'?: undefined;
+        '@stylistic/no-trailing-spaces'?: undefined;
+        '@stylistic/object-curly-spacing'?: undefined;
+        '@stylistic/quote-props'?: undefined;
+        '@stylistic/quotes'?: undefined;
+        '@stylistic/semi'?: undefined;
+        '@stylistic/semi-spacing'?: undefined;
+        '@stylistic/space-before-blocks'?: undefined;
+        '@stylistic/space-before-function-paren'?: undefined;
+        '@stylistic/space-in-parens'?: undefined;
+        '@stylistic/space-infix-ops'?: undefined;
+        '@stylistic/spaced-comment'?: undefined;
+        '@stylistic/template-curly-spacing'?: undefined;
         '@typescript-eslint/no-unused-expressions'?: undefined;
         '@typescript-eslint/no-unused-vars'?: undefined;
-        '@stylistic/ts/comma-dangle'?: undefined;
-        '@stylistic/ts/comma-spacing'?: undefined;
-        '@stylistic/ts/indent'?: undefined;
-        '@stylistic/ts/key-spacing'?: undefined;
-        '@stylistic/ts/keyword-spacing'?: undefined;
-        '@stylistic/ts/object-curly-spacing'?: undefined;
-        '@stylistic/ts/quote-props'?: undefined;
-        '@stylistic/ts/quotes'?: undefined;
-        '@stylistic/ts/semi'?: undefined;
-        '@stylistic/ts/space-before-blocks'?: undefined;
-        '@stylistic/ts/space-before-function-paren'?: undefined;
-        '@stylistic/ts/space-infix-ops'?: undefined;
     };
     languageOptions?: undefined;
     plugins?: undefined;