@ntnyq/utils 0.2.0 → 0.3.0

package/dist/index.cjs

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   NOOP: () => NOOP,
+  at: () => at,
   cAF: () => cAF,
   camelCase: () => camelCase,
   capitalize: () => capitalize,
@@ -31,6 +32,7 @@ __export(src_exports, {
   ensurePrefix: () => ensurePrefix,
   ensureSuffix: () => ensureSuffix,
   flatCase: () => flatCase,
+  flattenArrayable: () => flattenArrayable,
   getObjectType: () => getObjectType,
   hasOwn: () => hasOwn,
   hours: () => hours,
@@ -38,18 +40,28 @@ __export(src_exports, {
   isArrayEqual: () => isArrayEqual,
   isBoolean: () => isBoolean,
   isBrowser: () => isBrowser,
+  isEmptyString: () => isEmptyString,
+  isEmptyStringOrWhitespace: () => isEmptyStringOrWhitespace,
   isFunction: () => isFunction,
   isInteger: () => isInteger,
   isNativePromise: () => isNativePromise,
+  isNil: () => isNil,
   isNull: () => isNull,
   isNumber: () => isNumber,
+  isNumbericString: () => isNumbericString,
+  isObject: () => isObject,
   isPromise: () => isPromise,
+  isRegExp: () => isRegExp,
+  isSet: () => isSet,
   isString: () => isString,
   isUndefined: () => isUndefined,
   isUppercase: () => isUppercase,
+  isWhitespaceString: () => isWhitespaceString,
   join: () => join,
   kebabCase: () => kebabCase,
+  last: () => last,
   lowerFirst: () => lowerFirst,
+  mergeArrayable: () => mergeArrayable,
   minutes: () => minutes,
   noop: () => noop,
   omit: () => omit,
@@ -60,6 +72,7 @@ __export(src_exports, {
   seconds: () => seconds,
   slash: () => slash,
   snakeCase: () => snakeCase,
+  sortObject: () => sortObject,
   splitByCase: () => splitByCase,
   throttle: () => throttle,
   titleCase: () => titleCase,
@@ -85,6 +98,18 @@ function isString(value) {
 function isNumber(value) {
   return typeof value === "number";
 }
+function isEmptyString(value) {
+  return isString(value) && value.length === 0;
+}
+function isWhitespaceString(value) {
+  return isString(value) && /^\s*$/.test(value);
+}
+function isEmptyStringOrWhitespace(value) {
+  return isEmptyString(value) || isWhitespaceString(value);
+}
+function isNumbericString(value) {
+  return isString(value) && !isEmptyStringOrWhitespace(value) && !Number.isNaN(Number(value));
+}
 function isInteger(value) {
   return Number.isInteger(value);
 }
@@ -103,6 +128,18 @@ function isUndefined(value) {
 function isNull(value) {
   return value === null;
 }
+function isNil(value) {
+  return isNull(value) || isUndefined(value);
+}
+function isObject(value) {
+  return getObjectType(value) === "Object";
+}
+function isRegExp(value) {
+  return getObjectType(value) === "RegExp";
+}
+function isSet(value) {
+  return getObjectType(value) === "Set";
+}
 function isNativePromise(value) {
   return getObjectType(value) === "Promise";
 }
@@ -325,6 +362,19 @@ var warnOnce = (message) => {
   console.warn(message);
 };
 
+// src/array/at.ts
+function at(array, index) {
+  const length = array.length;
+  if (!length) return void 0;
+  if (index < 0) {
+    index += length;
+  }
+  return array[index];
+}
+function last(array) {
+  return at(array, -1);
+}
+
 // src/array/chunk.ts
 function chunk(array, size) {
   const result = [];
@@ -354,6 +404,14 @@ function toArray(array) {
   return Array.isArray(array) ? array : [array];
 }
 
+// src/array/arrayable.ts
+function flattenArrayable(array) {
+  return toArray(array).flat(1);
+}
+function mergeArrayable(...args) {
+  return args.flatMap((i) => toArray(i));
+}
+
 // src/array/isArrayEqual.ts
 function isArrayEqual(array1, array2) {
   if (array1.length !== array2.length) {
@@ -429,9 +487,41 @@ function pick(object, keys) {
     })
   );
 }
+
+// src/object/isPlainObject.ts
+function isPlainObject(value) {
+  if (!isObject(value)) return false;
+  const prototype = Object.getPrototypeOf(value);
+  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);
+}
+
+// src/object/sortObject.ts
+function sortObject(obj, options = {}) {
+  const { compareFn = (a, b) => a.localeCompare(b) } = options;
+  function sortKeys(obj2) {
+    const sortedKeys = Object.keys(obj2).sort(compareFn);
+    const result = {};
+    for (const key of sortedKeys) {
+      const value = obj2[key];
+      let newValue;
+      if (options.deep && isPlainObject(value)) {
+        newValue = sortKeys(value);
+      } else {
+        newValue = value;
+      }
+      Object.defineProperty(result, key, {
+        ...Object.getOwnPropertyDescriptor(obj2, key),
+        value: newValue
+      });
+    }
+    return result;
+  }
+  return sortKeys(obj);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   NOOP,
+  at,
   cAF,
   camelCase,
   capitalize,
@@ -442,6 +532,7 @@ function pick(object, keys) {
   ensurePrefix,
   ensureSuffix,
   flatCase,
+  flattenArrayable,
   getObjectType,
   hasOwn,
   hours,
@@ -449,18 +540,28 @@ function pick(object, keys) {
   isArrayEqual,
   isBoolean,
   isBrowser,
+  isEmptyString,
+  isEmptyStringOrWhitespace,
   isFunction,
   isInteger,
   isNativePromise,
+  isNil,
   isNull,
   isNumber,
+  isNumbericString,
+  isObject,
   isPromise,
+  isRegExp,
+  isSet,
   isString,
   isUndefined,
   isUppercase,
+  isWhitespaceString,
   join,
   kebabCase,
+  last,
   lowerFirst,
+  mergeArrayable,
   minutes,
   noop,
   omit,
@@ -471,6 +572,7 @@ function pick(object, keys) {
   seconds,
   slash,
   snakeCase,
+  sortObject,
   splitByCase,
   throttle,
   titleCase,

package/dist/index.d.cts

@@ -9,12 +9,24 @@ export * from 'scule';
 declare function getObjectType(value: unknown): string;
 declare function isString(value: unknown): value is string;
 declare function isNumber(value: unknown): value is number;
+declare function isEmptyString(value: unknown): value is '';
+type Whitespace = ' ';
+type NonEmptyString = string & {
+    0: '';
+};
+declare function isWhitespaceString(value: unknown): value is Whitespace;
+declare function isEmptyStringOrWhitespace(value: unknown): value is '' | Whitespace;
+declare function isNumbericString(value: unknown): value is `${number}`;
 declare function isInteger(value: unknown): value is number;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
 declare function isUndefined(value: unknown): value is undefined;
 declare function isNull(value: unknown): value is null;
+declare function isNil(value: unknown): value is null | undefined;
+declare function isObject(value: unknown): value is object;
+declare function isRegExp(value: unknown): value is RegExp;
+declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
 
@@ -123,6 +135,20 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
 
 declare const warnOnce: (message: string) => void;
 
+/**
+ * Get array item by index, negative for backward
+ * @param array - given array
+ * @param index - index of item
+ * @returns undefined if not match, otherwise matched item
+ */
+declare function at<T>(array: readonly T[], index: number): T | undefined;
+/**
+ * Get the last item of given array
+ * @param array - given array
+ * @returns undefined if empty array, otherwise last item
+ */
+declare function last<T>(array: readonly T[]): T | undefined;
+
 /**
  * Splits an array into smaller chunks of a given size.
  * @param array The array to split
@@ -163,6 +189,19 @@ type PrimitiveType = number | bigint | string | boolean | symbol | null | undefi
  */
 declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
 
+/**
+ * Convert `Arrayable<T>` to `Array<T>` and flatten the result
+ * @param array - given array
+ * @returns Array<T>
+ */
+declare function flattenArrayable<T>(array?: Nullable<Arrayable<T | Array<T>>>): Array<T>;
+/**
+ * Use rest arguments to merge arrays
+ * @param args - rest arguments
+ * @returns Array<T>
+ */
+declare function mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T>;
+
 declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
 
 type JoinableValue = string | number | null | undefined;
@@ -212,4 +251,20 @@ declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
 declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type ThrottleDebounceOptions, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, once, pick, rAF, seconds, slash, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+interface SortObjectOptions {
+    /**
+     * Recursive sorting
+     * @default false
+     */
+    deep?: boolean;
+    /**
+     * Compare function
+     */
+    compareFn?: (left: string, right: string) => number;
+}
+/**
+ * Sort object properties
+ */
+declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
+
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type NonEmptyString, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNativePromise, isNil, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.d.ts

@@ -9,12 +9,24 @@ export * from 'scule';
 declare function getObjectType(value: unknown): string;
 declare function isString(value: unknown): value is string;
 declare function isNumber(value: unknown): value is number;
+declare function isEmptyString(value: unknown): value is '';
+type Whitespace = ' ';
+type NonEmptyString = string & {
+    0: '';
+};
+declare function isWhitespaceString(value: unknown): value is Whitespace;
+declare function isEmptyStringOrWhitespace(value: unknown): value is '' | Whitespace;
+declare function isNumbericString(value: unknown): value is `${number}`;
 declare function isInteger(value: unknown): value is number;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
 declare function isUndefined(value: unknown): value is undefined;
 declare function isNull(value: unknown): value is null;
+declare function isNil(value: unknown): value is null | undefined;
+declare function isObject(value: unknown): value is object;
+declare function isRegExp(value: unknown): value is RegExp;
+declare function isSet<Value = unknown>(value: unknown): value is Set<Value>;
 declare function isNativePromise<T = unknown>(value: unknown): value is Promise<T>;
 declare function isPromise<T = unknown>(value: unknown): value is Promise<T>;
 
@@ -123,6 +135,20 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
 
 declare const warnOnce: (message: string) => void;
 
+/**
+ * Get array item by index, negative for backward
+ * @param array - given array
+ * @param index - index of item
+ * @returns undefined if not match, otherwise matched item
+ */
+declare function at<T>(array: readonly T[], index: number): T | undefined;
+/**
+ * Get the last item of given array
+ * @param array - given array
+ * @returns undefined if empty array, otherwise last item
+ */
+declare function last<T>(array: readonly T[]): T | undefined;
+
 /**
  * Splits an array into smaller chunks of a given size.
  * @param array The array to split
@@ -163,6 +189,19 @@ type PrimitiveType = number | bigint | string | boolean | symbol | null | undefi
  */
 declare function toArray<T>(array?: Nullable<Arrayable<T>>): T[];
 
+/**
+ * Convert `Arrayable<T>` to `Array<T>` and flatten the result
+ * @param array - given array
+ * @returns Array<T>
+ */
+declare function flattenArrayable<T>(array?: Nullable<Arrayable<T | Array<T>>>): Array<T>;
+/**
+ * Use rest arguments to merge arrays
+ * @param args - rest arguments
+ * @returns Array<T>
+ */
+declare function mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T>;
+
 declare function isArrayEqual(array1: unknown[], array2: unknown[]): boolean;
 
 type JoinableValue = string | number | null | undefined;
@@ -212,4 +251,20 @@ declare function pick<T, K extends keyof T>(object: T, keys: K[]): Pick<T, K>;
 
 declare function hasOwn<T, K extends keyof T>(object: T, key: K): boolean;
 
-export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type ThrottleDebounceOptions, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isFunction, isInteger, isNativePromise, isNull, isNumber, isPromise, isString, isUndefined, join, minutes, noop, omit, once, pick, rAF, seconds, slash, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+interface SortObjectOptions {
+    /**
+     * Recursive sorting
+     * @default false
+     */
+    deep?: boolean;
+    /**
+     * Compare function
+     */
+    compareFn?: (left: string, right: string) => number;
+}
+/**
+ * Sort object properties
+ */
+declare function sortObject<T extends Record<string, any>>(obj: T, options?: SortObjectOptions): T;
+
+export { type AnyFn, type Arrayable, type Awaitable, type MayBe, NOOP, type NonEmptyString, type Nullable, type Prettify, type PrettifyV2, type PrimitiveType, type SortObjectOptions, type ThrottleDebounceOptions, type Whitespace, at, cAF, capitalize, chunk, clamp, days, debounce, ensurePrefix, ensureSuffix, flattenArrayable, getObjectType, hasOwn, hours, isArray, isArrayEqual, isBoolean, isBrowser, isEmptyString, isEmptyStringOrWhitespace, isFunction, isInteger, isNativePromise, isNil, isNull, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isUndefined, isWhitespaceString, join, last, mergeArrayable, minutes, noop, omit, once, pick, rAF, seconds, slash, sortObject, throttle, toArray, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -8,6 +8,18 @@ function isString(value) {
 function isNumber(value) {
   return typeof value === "number";
 }
+function isEmptyString(value) {
+  return isString(value) && value.length === 0;
+}
+function isWhitespaceString(value) {
+  return isString(value) && /^\s*$/.test(value);
+}
+function isEmptyStringOrWhitespace(value) {
+  return isEmptyString(value) || isWhitespaceString(value);
+}
+function isNumbericString(value) {
+  return isString(value) && !isEmptyStringOrWhitespace(value) && !Number.isNaN(Number(value));
+}
 function isInteger(value) {
   return Number.isInteger(value);
 }
@@ -26,6 +38,18 @@ function isUndefined(value) {
 function isNull(value) {
   return value === null;
 }
+function isNil(value) {
+  return isNull(value) || isUndefined(value);
+}
+function isObject(value) {
+  return getObjectType(value) === "Object";
+}
+function isRegExp(value) {
+  return getObjectType(value) === "RegExp";
+}
+function isSet(value) {
+  return getObjectType(value) === "Set";
+}
 function isNativePromise(value) {
   return getObjectType(value) === "Promise";
 }
@@ -248,6 +272,19 @@ var warnOnce = (message) => {
   console.warn(message);
 };
 
+// src/array/at.ts
+function at(array, index) {
+  const length = array.length;
+  if (!length) return void 0;
+  if (index < 0) {
+    index += length;
+  }
+  return array[index];
+}
+function last(array) {
+  return at(array, -1);
+}
+
 // src/array/chunk.ts
 function chunk(array, size) {
   const result = [];
@@ -277,6 +314,14 @@ function toArray(array) {
   return Array.isArray(array) ? array : [array];
 }
 
+// src/array/arrayable.ts
+function flattenArrayable(array) {
+  return toArray(array).flat(1);
+}
+function mergeArrayable(...args) {
+  return args.flatMap((i) => toArray(i));
+}
+
 // src/array/isArrayEqual.ts
 function isArrayEqual(array1, array2) {
   if (array1.length !== array2.length) {
@@ -352,8 +397,40 @@ function pick(object, keys) {
     })
   );
 }
+
+// src/object/isPlainObject.ts
+function isPlainObject(value) {
+  if (!isObject(value)) return false;
+  const prototype = Object.getPrototypeOf(value);
+  return (prototype === null || prototype === Object.prototype || Object.getPrototypeOf(prototype) === null) && !(Symbol.toStringTag in value) && !(Symbol.iterator in value);
+}
+
+// src/object/sortObject.ts
+function sortObject(obj, options = {}) {
+  const { compareFn = (a, b) => a.localeCompare(b) } = options;
+  function sortKeys(obj2) {
+    const sortedKeys = Object.keys(obj2).sort(compareFn);
+    const result = {};
+    for (const key of sortedKeys) {
+      const value = obj2[key];
+      let newValue;
+      if (options.deep && isPlainObject(value)) {
+        newValue = sortKeys(value);
+      } else {
+        newValue = value;
+      }
+      Object.defineProperty(result, key, {
+        ...Object.getOwnPropertyDescriptor(obj2, key),
+        value: newValue
+      });
+    }
+    return result;
+  }
+  return sortKeys(obj);
+}
 export {
   NOOP,
+  at,
   cAF,
   camelCase,
   capitalize,
@@ -364,6 +441,7 @@ export {
   ensurePrefix,
   ensureSuffix,
   flatCase,
+  flattenArrayable,
   getObjectType,
   hasOwn,
   hours,
@@ -371,18 +449,28 @@ export {
   isArrayEqual,
   isBoolean,
   isBrowser,
+  isEmptyString,
+  isEmptyStringOrWhitespace,
   isFunction,
   isInteger,
   isNativePromise,
+  isNil,
   isNull,
   isNumber,
+  isNumbericString,
+  isObject,
   isPromise,
+  isRegExp,
+  isSet,
   isString,
   isUndefined,
   isUppercase,
+  isWhitespaceString,
   join,
   kebabCase,
+  last,
   lowerFirst,
+  mergeArrayable,
   minutes,
   noop,
   omit,
@@ -393,6 +481,7 @@ export {
   seconds,
   slash,
   snakeCase,
+  sortObject,
   splitByCase,
   throttle,
   titleCase,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -12,10 +12,10 @@
     "email": "ntnyq13@gmail.com"
   },
   "homepage": "https://github.com/ntnyq/utils#readme",
+  "repository": "ntnyq/utils",
   "bugs": {
     "url": "https://github.com/ntnyq/utils/issues"
   },
-  "repository": "ntnyq/utils",
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -40,19 +40,18 @@
     "scule": "^1.3.0"
   },
   "devDependencies": {
-    "@ntnyq/eslint-config": "^3.0.0-beta.20",
+    "@ntnyq/eslint-config": "^3.2.2",
     "@ntnyq/prettier-config": "^1.21.3",
-    "@vitest/coverage-v8": "^2.1.2",
-    "bumpp": "^9.7.1",
-    "eslint": "^9.12.0",
+    "@vitest/coverage-v8": "^2.1.5",
+    "bumpp": "^9.8.1",
+    "eslint": "^9.14.0",
     "husky": "^9.1.6",
     "nano-staged": "^0.8.0",
-    "npm-run-all2": "^6.2.3",
-    "pnpm": "^9.12.1",
+    "npm-run-all2": "^7.0.1",
     "prettier": "^3.3.3",
-    "tsup": "^8.3.0",
+    "tsup": "^8.3.5",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.2"
+    "vitest": "^2.1.5"
   },
   "engines": {
     "node": ">=18.18.0"