diginext-utils 3.13.14 → 4.0.0

package/README.md

@@ -1,162 +1,168 @@
-# The library of utility plugins
+# Diginext Utils
 
-## Exports
+A professional, production-ready utility library with full TypeScript support, comprehensive documentation, and optimized tree-shaking.
 
--   "diginext-utils/dist": ES6 modules / NodeJS
--   "diginext-utils/esm": Node modules / JavaScript modules
+## Features
+
+- 🎯 **Fully Typed**: Written in TypeScript with complete type definitions
+- 📦 **Tree-Shakeable**: Import only what you need with ES modules
+- 📚 **Well Documented**: Comprehensive JSDoc comments with examples
+- 🧪 **Thoroughly Tested**: High test coverage with modern testing framework
+- ⚡ **Zero Dependencies**: Core utilities have no external dependencies
+- 🔧 **Multiple Module Formats**: Supports both CommonJS and ES modules
+
+## Installation
+
+```bash
+npm install diginext-utils
+# or
+yarn add diginext-utils
+# or
+pnpm add diginext-utils
+```
+
+## Usage
+
+### Modern Import (Recommended - Tree-shaking friendly)
 
-## Imports
+```typescript
+// Import specific functions
+import { sum, average, shuffle } from 'diginext-utils/array';
+import { isNull, toBool, deepClone } from 'diginext-utils/object';
+import { randomInt, clamp } from 'diginext-utils/math';
 
-### ES5 module import:
+const numbers = [1, 2, 3, 4, 5];
+console.log(sum(numbers)); // 15
+console.log(average(numbers)); // 3
+console.log(shuffle(numbers)); // [3, 1, 5, 2, 4] (random order)
+```
+
+### Namespace Import
 
-```javascript
-import utils from "diginext-utils";
-console.log(utils.xname.NameEN.generateName()); // output some random name in English
+```typescript
+import { array, object, math } from 'diginext-utils';
 
-// or
+console.log(array.sum([1, 2, 3])); // 6
+console.log(object.isNull(null)); // true
+console.log(math.randomInt(1, 10)); // Random integer between 1-10
+```
 
-import { NameEN } from "diginext-utils/dist/name";
-console.log(NameEN.generateName()); // output some random name in English
+### Legacy Import (Backward Compatible)
 
-// or just
-import { generateName } from "diginext-utils/dist/name/en";
-console.log(generateName()); // output some random name in English
+```typescript
+import utils from 'diginext-utils';
 
-// or with require(...)
-const xurl = require("../dist/string/url");
-xurl.isLink("abc"); // FALSE
-xurl.isLink("https://www.google.com"); // TRUE
+console.log(utils.array.sum([1, 2, 3])); // 6
+console.log(utils.object.isNull(null)); // true
 ```
 
-### Node module import:
+## API Documentation
+
+### Array Utilities
+
+Comprehensive array manipulation and analysis functions:
+
+- `sum`, `average`, `min`, `max` - Statistical operations
+- `first`, `last`, `randomElement` - Element access
+- `sortByString`, `sortByNumber` - Sorting operations
+- `unique`, `intersection`, `difference`, `union` - Set operations
+- `shuffle`, `sample`, `chunk`, `compact`, `flatten` - Transformations
+- `removeItem`, `removeItemByKey`, `moveElement` - Modifications
+
+[See full array documentation](https://github.com/digitopvn/digitopecosystem-turbo-monorepo/tree/main/packages/diginext-utils#array-utilities)
+
+### Object Utilities
+
+Type-safe object operations and conversions:
+
+- `isNull`, `isEmpty`, `isObject`, `isEqual` - Type checking
+- `toBool`, `toInt`, `toFloat`, `toArray` - Type conversion
+- `pick`, `omit`, `merge`, `deepClone` - Object manipulation
+- `iterate` - Recursive traversal
+
+[See full object documentation](https://github.com/digitopvn/digitopecosystem-turbo-monorepo/tree/main/packages/diginext-utils#object-utilities)
+
+### Math Utilities
+
+Mathematical operations and helpers:
+
+- `random`, `randomInt`, `randomFloat` - Random number generation
+- `clamp`, `lerp`, `round` - Number operations
+- `degToRad`, `radToDeg` - Angle conversion
+- `distance`, `angleBetweenPoints` - Geometric calculations
 
-**IMPORTANT**: Set "type" as "module" your `package.json`
+[See full math documentation](https://github.com/digitopvn/digitopecosystem-turbo-monorepo/tree/main/packages/diginext-utils#math-utilities)
 
-```javascript
-// NodeJS moduies
-import utils from "diginext-utils";
-console.log(utils.xname.NameEN.generateName()); // output some random name in English
+### String Utilities
+
+String manipulation and formatting (legacy modules maintained)
+
+### File Utilities
+
+File system operations and helpers (legacy modules maintained)
+
+### Device Utilities
+
+Browser and device detection (legacy modules maintained)
+
+## TypeScript Support
+
+All functions are fully typed with generics for type safety:
+
+```typescript
+import { sum } from 'diginext-utils/array';
+import { pick } from 'diginext-utils/object';
+
+interface User {
+	id: number;
+	name: string;
+	age: number;
+}
+
+const users: User[] = [/* ... */];
+const totalAge: number = sum(users, 'age');
+const userSubset: Pick<User, 'id' | 'name'> = pick(users[0], ['id', 'name']);
 ```
 
-```html
-// browser
-<script type="module">
-	import { NameEN } from "diginext-utils/esm/name/index.js"; // ".js" file extension is required !
-	console.log(NameEN.generateName()); // output some random name in English
-</script>
+## Performance & Bundle Size
+
+Optimized for tree-shaking - import only what you need:
+
+```typescript
+// ✅ Good - Only includes sum function (~0.5kb)
+import { sum } from 'diginext-utils/array';
+
+// ❌ Less optimal - Includes all array utilities
+import { array } from 'diginext-utils';
 ```
 
-## Features
+## Migration from v3.x
+
+Backward compatible with improved APIs:
 
--   xconsole
--   xarray
-    -   sumArray
-    -   averageArray
-    -   minArray
-    -   maxArray
-    -   sortElementByString
-    -   sortElementByNumber
-    -   firstElement
-    -   lastElement
-    -   randomIndex
-    -   randomElement
-    -   mergeAndMakeUniqueElement
-    -   allMatchInArray
-    -   removeItem
-    -   removeItemByKey
-    -   getRandom
-    -   getHalfRandom
-    -   shuffle
-    -   moveIndex
-    -   moveArray
--   xmath
-    -   rand
-    -   randRound
-    -   randHalt
-    -   randInt
-    -   randFloat
-    -   degToRad
-    -   radToDeg
-    -   angleBetweenPoints
-    -   diffDate
-    -   positiveNumber
--   xname
-    -   NameEN.generateName()
-    -   NameVI.generateName()
--   xobject
-    -   isNull
-    -   toBool
-    -   toInt
-    -   toFloat
-    -   toArray
-    -   objectToArray
--   xjson
-    -   isValid
--   xfile
-    -   createDir
-    -   fileMove
-    -   findFileByExt
--   xstring
-    -   getBetween
-    -   makeString
-    -   toUpperCase
-    -   toLowerCase
-    -   titleize
-    -   capitalize
-    -   capitalizeName
-    -   clearUnicodeCharacters
-    -   generateUUID
-    -   randAllCharacterByLength
-    -   randomStringByLength
-    -   formatNumber
-    -   generatePassword
-    -   trimNull
-    -   addQueryParam
-    -   getUrlParams
-    -   isLink
-    -   getFileNameWithoutExtension
-    -   getFileNameWithExtension
-    -   getFileExtension
-    -   isImage
--   xurl
-    -   addQueryParam
-    -   getUrlParams
-    -   isLink
-    -   getFileNameWithoutExtension
-    -   getFileNameWithExtension
-    -   getFileExtension
-    -   isImage
--   slug
-    -   makeSlug
--   color
-    -   random
-    -   pSBC
-    -   hexToRgb
-    -   hexDarken
-    -   hexLighten
-    -   RGBToHex
--   device
--   camera
-    -   requestCamera
-    -   requestDeviceOrientationControl
--   browser
-    -   isPotrait
-    -   isLandscape
-    -   ua
-    -   isFacebookWebview
-    -   isInAppWebview
--   Timer
-    -   wait
--   Validation
-    -   imageValidate
-    -   videoValidate
-
-## Dev
+```typescript
+// Old way (still works)
+import utils from 'diginext-utils';
+const result = utils.array.sumArray([1, 2, 3]);
 
+// New way (recommended)
+import { sum } from 'diginext-utils/array';
+const result = sum([1, 2, 3]);
 ```
-yarn dev
+
+## Development
+
+```bash
+npm install        # Install dependencies
+npm run build      # Build library
+npm run test       # Run tests
+npm run lint       # Lint code
 ```
 
+## License
+
+MIT © TOP GROUP (Digitop)
+
 ## Support
 
-Liên hệ [TOP GROUP Developers](mailto:dev@wearetopgroup.com) nếu cần hỗ trợ.
+Contact [TOP GROUP Developers](mailto:dev@wearetopgroup.com) for support.

package/dist/Checker.d.ts

@@ -1,8 +1,9 @@
-/**
- * Check if the object or string is in JSON format
- */
-export declare const isJSON: (content: object | string) => boolean;
-declare const Checker: {
-    isJSON: (content: object | string) => boolean;
-};
-export default Checker;
+/**
+ * Check if the object or string is in JSON format
+ */
+export declare const isJSON: (content: object | string) => boolean;
+declare const Checker: {
+    isJSON: (content: object | string) => boolean;
+};
+export default Checker;
+//# sourceMappingURL=Checker.d.ts.map

package/dist/Checker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Checker.d.ts","sourceRoot":"","sources":["../src/Checker.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS,MAAM,GAAG,MAAM,YAqB9C,CAAC;AAEF,QAAA,MAAM,OAAO;sBAvBmB,MAAM,GAAG,MAAM;CAuBrB,CAAC;AAE3B,eAAe,OAAO,CAAC"}

package/dist/Checker.js

@@ -1,31 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJSON = void 0;
-/**
- * Check if the object or string is in JSON format
- */
-const isJSON = (content) => {
-    if (typeof content == "object") {
-        try {
-            content = JSON.stringify(content);
-        }
-        catch (err) {
-            return false;
-        }
-    }
-    if (typeof content == "string") {
-        try {
-            content = JSON.parse(content);
-        }
-        catch (err) {
-            return false;
-        }
-    }
-    if (typeof content != "object") {
-        return false;
-    }
-    return true;
-};
-exports.isJSON = isJSON;
-const Checker = { isJSON: exports.isJSON };
-exports.default = Checker;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isJSON = void 0;
+/**
+ * Check if the object or string is in JSON format
+ */
+const isJSON = (content) => {
+    if (typeof content == "object") {
+        try {
+            content = JSON.stringify(content);
+        }
+        catch (err) {
+            return false;
+        }
+    }
+    if (typeof content == "string") {
+        try {
+            content = JSON.parse(content);
+        }
+        catch (err) {
+            return false;
+        }
+    }
+    if (typeof content != "object") {
+        return false;
+    }
+    return true;
+};
+exports.isJSON = isJSON;
+const Checker = { isJSON: exports.isJSON };
+exports.default = Checker;
+//# sourceMappingURL=Checker.js.map

package/dist/Checker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Checker.js","sourceRoot":"","sources":["../src/Checker.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACI,MAAM,MAAM,GAAG,CAAC,OAAwB,EAAE,EAAE;IAClD,IAAI,OAAO,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED,IAAI,OAAO,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC;YACJ,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED,IAAI,OAAO,OAAO,IAAI,QAAQ,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AArBW,QAAA,MAAM,UAqBjB;AAEF,MAAM,OAAO,GAAG,EAAE,MAAM,EAAN,cAAM,EAAE,CAAC;AAE3B,kBAAe,OAAO,CAAC"}

package/dist/EventDispatcher.d.ts

@@ -1,13 +1,14 @@
-declare class EventDispatcher {
-    constructor();
-    _listeners: any;
-    addEventListener(type: string, listener: any): void;
-    hasEventListener(type: string, listener: any): boolean;
-    removeEventListener(type: string, listener: any): void;
-    dispatchEvent(event: {
-        type: string;
-        target: any;
-    }): void;
-}
-export { EventDispatcher };
-export default EventDispatcher;
+declare class EventDispatcher {
+    constructor();
+    _listeners: any;
+    addEventListener(type: string, listener: any): void;
+    hasEventListener(type: string, listener: any): boolean;
+    removeEventListener(type: string, listener: any): void;
+    dispatchEvent(event: {
+        type: string;
+        target: any;
+    }): void;
+}
+export { EventDispatcher };
+export default EventDispatcher;
+//# sourceMappingURL=EventDispatcher.d.ts.map

package/dist/EventDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDispatcher.d.ts","sourceRoot":"","sources":["../src/EventDispatcher.ts"],"names":[],"mappings":"AAAA,cAAM,eAAe;;IAGpB,UAAU,EAAE,GAAG,CAAC;IAEhB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG;IAc5C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG;IAQ5C,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG;IAe/C,aAAa,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE;CAiBlD;AACD,OAAO,EAAE,eAAe,EAAE,CAAC;AAC3B,eAAe,eAAe,CAAC"}

package/dist/EventDispatcher.js

@@ -1,51 +1,52 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventDispatcher = void 0;
-class EventDispatcher {
-    constructor() { }
-    addEventListener(type, listener) {
-        if (this._listeners === undefined)
-            this._listeners = {};
-        const listeners = this._listeners;
-        if (listeners[type] === undefined) {
-            listeners[type] = [];
-        }
-        if (listeners[type].indexOf(listener) === -1) {
-            listeners[type].push(listener);
-        }
-    }
-    hasEventListener(type, listener) {
-        if (this._listeners === undefined)
-            return false;
-        const listeners = this._listeners;
-        return listeners[type] !== undefined && listeners[type].indexOf(listener) !== -1;
-    }
-    removeEventListener(type, listener) {
-        if (this._listeners === undefined)
-            return;
-        const listeners = this._listeners;
-        const listenerArray = listeners[type];
-        if (listenerArray !== undefined) {
-            const index = listenerArray.indexOf(listener);
-            if (index !== -1) {
-                listenerArray.splice(index, 1);
-            }
-        }
-    }
-    dispatchEvent(event) {
-        if (this._listeners === undefined)
-            return;
-        const listeners = this._listeners;
-        const listenerArray = listeners[event.type];
-        if (listenerArray !== undefined) {
-            event.target = this;
-            // Make a copy, in case listeners are removed while iterating.
-            const array = listenerArray.slice(0);
-            for (let i = 0, l = array.length; i < l; i++) {
-                array[i].call(this, event);
-            }
-        }
-    }
-}
-exports.EventDispatcher = EventDispatcher;
-exports.default = EventDispatcher;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventDispatcher = void 0;
+class EventDispatcher {
+    constructor() { }
+    addEventListener(type, listener) {
+        if (this._listeners === undefined)
+            this._listeners = {};
+        const listeners = this._listeners;
+        if (listeners[type] === undefined) {
+            listeners[type] = [];
+        }
+        if (listeners[type].indexOf(listener) === -1) {
+            listeners[type].push(listener);
+        }
+    }
+    hasEventListener(type, listener) {
+        if (this._listeners === undefined)
+            return false;
+        const listeners = this._listeners;
+        return listeners[type] !== undefined && listeners[type].indexOf(listener) !== -1;
+    }
+    removeEventListener(type, listener) {
+        if (this._listeners === undefined)
+            return;
+        const listeners = this._listeners;
+        const listenerArray = listeners[type];
+        if (listenerArray !== undefined) {
+            const index = listenerArray.indexOf(listener);
+            if (index !== -1) {
+                listenerArray.splice(index, 1);
+            }
+        }
+    }
+    dispatchEvent(event) {
+        if (this._listeners === undefined)
+            return;
+        const listeners = this._listeners;
+        const listenerArray = listeners[event.type];
+        if (listenerArray !== undefined) {
+            event.target = this;
+            // Make a copy, in case listeners are removed while iterating.
+            const array = listenerArray.slice(0);
+            for (let i = 0, l = array.length; i < l; i++) {
+                array[i].call(this, event);
+            }
+        }
+    }
+}
+exports.EventDispatcher = EventDispatcher;
+exports.default = EventDispatcher;
+//# sourceMappingURL=EventDispatcher.js.map

package/dist/EventDispatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDispatcher.js","sourceRoot":"","sources":["../src/EventDispatcher.ts"],"names":[],"mappings":";;;AAAA,MAAM,eAAe;IACpB,gBAAe,CAAC;IAIhB,gBAAgB,CAAC,IAAY,EAAE,QAAa;QAC3C,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAExD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAElC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACnC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC9C,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;IACF,CAAC;IAED,gBAAgB,CAAC,IAAY,EAAE,QAAa;QAC3C,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QAEhD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAElC,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAClF,CAAC;IAED,mBAAmB,CAAC,IAAY,EAAE,QAAa;QAC9C,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO;QAE1C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAEtC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAE9C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;gBAClB,aAAa,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;IAED,aAAa,CAAC,KAAoC;QACjD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,OAAO;QAE1C,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE5C,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;YAEpB,8DAA8D;YAC9D,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAErC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC9C,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC;QACF,CAAC;IACF,CAAC;CACD;AACQ,0CAAe;AACxB,kBAAe,eAAe,CAAC"}

package/dist/FileUpload.d.ts

@@ -1,12 +1,13 @@
-type UploadParams = {
-    blob: Blob;
-    url: string;
-    params: any;
-    onComplete: any;
-    onError: any;
-};
-declare const FileUpload: {
-    uploadBlob(props: UploadParams): void;
-};
-export { FileUpload };
-export default FileUpload;
+type UploadParams = {
+    blob: Blob;
+    url: string;
+    params: any;
+    onComplete: any;
+    onError: any;
+};
+declare const FileUpload: {
+    uploadBlob(props: UploadParams): void;
+};
+export { FileUpload };
+export default FileUpload;
+//# sourceMappingURL=FileUpload.d.ts.map

package/dist/FileUpload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileUpload.d.ts","sourceRoot":"","sources":["../src/FileUpload.ts"],"names":[],"mappings":"AAEA,KAAK,YAAY,GAAG;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,GAAG,CAAC;IAAC,UAAU,EAAE,GAAG,CAAC;IAAC,OAAO,EAAE,GAAG,CAAA;CAAE,CAAC;AAE5F,QAAA,MAAM,UAAU;sBACG,YAAY;CAyD9B,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,eAAe,UAAU,CAAC"}