@leexi/shared 0.3.2 → 0.3.4

package/README.md

@@ -66,8 +66,13 @@ export default defineNuxtConfig({
 - [Utils](#utils)
    - [Records](#records)
       - [set](#set)
+      - [omit](#omit)
+      - [pick](#pick)
    - [Strings](#strings)
+      - [camelcase](#camelcase)
       - [capitalize](#capitalize)
+      - [kebabcase](#kebabcase)
+      - [snakecase](#snakecase)
    - [Objects](#objects)
       - [deepDup](#deepdup)
       - [isSame](#issame)
@@ -104,7 +109,45 @@ set(foo, ['bar', 'biz'], 'fiz')
 foo // => { bar: { biz: 'fiz' } }
 ```
 
+#### omit
+Returns a copy of a given object excluding a given set of attributes
+- 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 }
+```
+
+#### pick
+Returns a copy of a given object only including a given set of attributes
+- 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 }
+```
+
 ### Strings
+#### camelcase
+Convert a kebab-case string or a snake_case string to a camelCase string
+- Type
+```ts
+const camelcase: (string: string) => string;
+```
+- Example
+```ts
+camelcase('foo_bar') // => 'fooBar'
+camelcase('foo-bar') // => 'fooBar'
+```
+
 #### capitalize
 Capitalizes a string
 - Type
@@ -116,6 +159,30 @@ const capitalize: (string?: string) => string;
 capitalize('foo') // => 'Foo'
 ```
 
+#### kebabcase
+Convert a camelCase string or a snake_case string to a kebab-case string
+- Type
+```ts
+const kebabcase: (string: string) => string;
+```
+- Example
+```ts
+kebabcase('fooBar') // => 'foo-bar'
+kebabcase('foo_bar') // => 'foo-bar'
+```
+
+#### snakecase
+Convert a camelCase string or a kebab-case string to a snake_case string
+- Type
+```ts
+const snakecase: (string: string) => string;
+```
+- Example
+```ts
+snakecase('fooBar') // => 'foo_bar'
+snakecase('foo-bar') // => 'foo_bar'
+```
+
 ### Objects
 #### deepDup
 Deeply duplicates an object.

package/dist/module.json

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

package/dist/runtime/composables/useLocalStorage.js

@@ -1,6 +1,35 @@
 import { useState, watch } from "#imports";
+import { kebabcase, snakecase } from "../utils/index.js";
 export const useLocalStorage = (key, defaultValue) => {
-  const data = useState(key, () => JSON.parse(localStorage?.getItem(key) || "null") || defaultValue);
+  if (/[-_][a-z]/.test(key)) {
+    throw new Error(`[useLocalStorage]: prefer camelCase fro key \`${key}\``);
+  }
+  const _findLocalStorageValue = () => {
+    if (localStorage?.getItem(key)) {
+      return localStorage.getItem(key);
+    }
+    for (const caseKey of [key, kebabcase(key), snakecase(key)]) {
+      if (localStorage?.getItem(caseKey)) {
+        localStorage.setItem(key, localStorage.getItem(caseKey));
+        localStorage.removeItem(caseKey);
+        return localStorage.getItem(key);
+      }
+    }
+    return "null";
+  };
+  const _parseLocalStorageValue = () => {
+    try {
+      const value = JSON.parse(_findLocalStorageValue());
+      return value || defaultValue;
+    } catch (error) {
+      if (error instanceof Error && /is not valid JSON/.test(error.message)) {
+        localStorage.setItem(key, JSON.stringify(localStorage.getItem(key)));
+        return _parseLocalStorageValue();
+      }
+      throw error;
+    }
+  };
+  const data = useState(key, _parseLocalStorageValue);
   watch(data, () => {
     if (data.value) {
       localStorage?.setItem(key, JSON.stringify(data.value));

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

@@ -1 +1,3 @@
+export { omit } from './omit.js';
+export { pick } from './pick.js';
 export { set } from './set.js';

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

@@ -1 +1,3 @@
+export { omit } from "./omit.js";
+export { pick } from "./pick.js";
 export { set } from "./set.js";

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

@@ -0,0 +1,9 @@
+/**
+ * Returns a copy of a given object excluding a given set of attributes
+ *
+ * @example
+ * const foo = { a: 1, b: 2, c: 3 }
+ * const bar = omit(foo, ['b', 'c'])
+ * bar // => { a: 1 }
+ */
+export declare const omit: <T extends Record<string, unknown>, K extends (keyof T)[]>(record: T, keys: K) => Omit<T, K[number]>;

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

@@ -0,0 +1 @@
+export const omit = (record, keys) => Object.fromEntries(Object.entries(record).filter(([key]) => !keys.includes(key)));

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

@@ -0,0 +1,9 @@
+/**
+ * Returns a copy of a given object only including a given set of attributes
+ *
+ * @example
+ * const foo = { a: 1, b: 2, c: 3 }
+ * const bar = pick(foo, ['b', 'c'])
+ * bar // => { b: 2, c: 3 }
+ */
+export declare const pick: <T extends Record<string, unknown>, K extends (keyof T)[]>(record: T, keys: K) => Pick<T, K[number]>;

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

@@ -0,0 +1 @@
+export const pick = (record, keys) => Object.fromEntries(Object.entries(record).filter(([key]) => keys.includes(key)));

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

@@ -0,0 +1,8 @@
+/**
+ * Convert a kebab-case string or a snake_case string to a camelCase string
+ *
+ * @example
+ * camelcase('foo_bar') // => 'fooBar'
+ * camelcase('foo-bar') // => 'fooBar'
+ */
+export declare const camelcase: (string: string) => string;

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

@@ -0,0 +1 @@
+export const camelcase = (string) => string.replaceAll(/[-_][a-z]/g, (char) => char.toUpperCase().replace("_", "").replace("-", ""));

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

@@ -1 +1,4 @@
+export { camelcase } from './camelcase.js';
 export { capitalize } from './capitalize.js';
+export { kebabcase } from './kebabcase.js';
+export { snakecase } from './snakecase.js';

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

@@ -1 +1,4 @@
+export { camelcase } from "./camelcase.js";
 export { capitalize } from "./capitalize.js";
+export { kebabcase } from "./kebabcase.js";
+export { snakecase } from "./snakecase.js";

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

@@ -0,0 +1,8 @@
+/**
+ * Convert a camelCase string or a snake_case string to a kebab-case string
+ *
+ * @example
+ * kebabcase('fooBar') // => 'foo-bar'
+ * kebabcase('foo_bar') // => 'foo-bar'
+ */
+export declare const kebabcase: (string: string) => string;

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

@@ -0,0 +1 @@
+export const kebabcase = (string) => string.replaceAll(/[A-Z]|_[a-z]/g, (char) => `-${char.toLowerCase().replace("_", "")}`);

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

@@ -0,0 +1,8 @@
+/**
+ * Convert a camelCase string or a kebab-case string to a snake_case string
+ *
+ * @example
+ * snakecase('fooBar') // => 'foo_bar'
+ * snakecase('foo-bar') // => 'foo_bar'
+ */
+export declare const snakecase: (string: string) => string;

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

@@ -0,0 +1 @@
+export const snakecase = (string) => string.replaceAll(/[A-Z]|-[a-z]/g, (char) => `_${char.toLowerCase().replace("-", "")}`);

package/package.json

@@ -2,7 +2,7 @@
   "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "exports": {
     "./composables": {
       "import": "./dist/runtime/composables/index.js",