@leexi/shared 0.3.6 → 0.3.8

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

@@ -1,9 +1,14 @@
 /**
- * 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.
+ *
+ * @param record The input record from which to omit keys.
+ * @param keys An array of keys to omit.
+ * @returns A new object with the specified keys removed.
  *
  * @example
- * 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 }
  */
 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/pick.d.ts

@@ -1,9 +1,14 @@
 /**
- * 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.
+ *
+ * @param record The input record from which to pick keys.
+ * @param keys An array of keys to pick.
+ * @returns A new object containing only the specified keys and their values.
  *
  * @example
- * 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 }
  */
 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/set.d.ts

@@ -2,18 +2,19 @@ type SetRecord<T extends Record<string, unknown>, P extends readonly string[], V
     [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.**
+ * 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.
  *
- * @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
+ * @param record The object within which to set the value.
+ * @param path An array of strings representing the path to the desired property.
+ * @param value The value to set at the specified path.
+ * @returns The modified object with the value set at the specified path.
  *
  * @example
- * 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 } } }
  */
 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/strings/camelcase.d.ts

@@ -1,8 +1,12 @@
 /**
- * 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.
+ *
+ * @param string The input string to convert.
+ * @returns The camelCased string.
  *
  * @example
- * 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
  */
 export declare const camelcase: (string: string) => string;

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

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

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

@@ -1,7 +1,11 @@
 /**
- * Capitalizes a string
+ * Capitalizes the first letter of a string.
+ *
+ * @param string The input string. Defaults to an empty string if not provided.
+ * @returns The string with the first letter capitalized.
  *
  * @example
- * capitalize('foo') // => 'Foo'
+ * console.log(capitalize('hello world')); // Output: Hello world
+ * console.log(capitalize('')); // Output: ''
  */
-export declare const capitalize: (string?: string) => string;
+export declare const capitalize: (string: string) => string;

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

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

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

@@ -1,8 +1,12 @@
 /**
- * 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.
+ *
+ * @param string The input string to convert.
+ * @returns The kebab-cased string.
  *
  * @example
- * 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
  */
 export declare const kebabcase: (string: string) => string;

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

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

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

@@ -1,8 +1,12 @@
 /**
- * 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.
+ *
+ * @param string The input string to convert.
+ * @returns The snake-cased string.
  *
  * @example
- * 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
  */
 export declare const snakecase: (string: string) => string;

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

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

package/package.json

@@ -2,7 +2,7 @@
   "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "exports": {
     "./composables": {
       "import": "./dist/runtime/composables/index.js",
@@ -41,30 +41,29 @@
     "dev": "nuxi dev playground",
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "lint": "eslint .",
-    "prepack": "yarn lint && yarn test --reporter default && yarn tsc && yarn build",
+    "prepack": "yarn dev:prepare && yarn lint && yarn tsc && yarn test --reporter default && yarn build",
     "test": "vitest run",
     "tsc": "vue-tsc --noEmit"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin-js": "^4.2.0",
-    "@stylistic/eslint-plugin-ts": "^4.2.0",
+    "@stylistic/eslint-plugin": "^5.1.0",
     "@types/eslint-plugin-tailwindcss": "^3.17.0",
-    "eslint": "^9.25.1",
+    "eslint": "^9.30.0",
     "eslint-plugin-tailwindcss": "^3.18.0",
-    "eslint-plugin-vue": "^10.1.0",
-    "globals": "^16.0.0",
+    "eslint-plugin-vue": "^10.2.0",
+    "globals": "^16.2.0",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.31.1",
-    "vue-eslint-parser": "^10.1.3"
+    "typescript-eslint": "^8.35.1",
+    "vue-eslint-parser": "^10.2.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^1.0.1",
-    "@nuxt/test-utils": "^3.17.2",
-    "@types/node": "^22.15.3",
-    "happy-dom": "^17.4.6",
-    "nuxt": "^3.17.1",
+    "@nuxt/test-utils": "^3.19.2",
+    "@types/node": "^22.16.0",
+    "happy-dom": "^18.0.1",
+    "nuxt": "^3.17.6",
     "tailwindcss": "<4.0.0",
-    "vitest": "^3.1.2",
+    "vitest": "^3.2.4",
     "vue-tsc": "^2.2.10"
   }
 }