@etsoo/shared 1.2.57 → 1.2.59

package/lib/cjs/DataTypes.js

@@ -98,6 +98,28 @@ var DataTypes;
         PlacementEnum[PlacementEnum["BottomRight"] = 8] = "BottomRight";
         PlacementEnum[PlacementEnum["Unknown"] = 9] = "Unknown"; // Reserved for modal, only one instance held at the same time
     })(PlacementEnum = DataTypes.PlacementEnum || (DataTypes.PlacementEnum = {}));
+    /**
+     * Tristate enum
+     * 三态枚举
+     */
+    let TristateEnum;
+    (function (TristateEnum) {
+        /**
+         * False
+         * 假
+         */
+        TristateEnum[TristateEnum["False"] = 0] = "False";
+        /**
+         * True
+         * 真
+         */
+        TristateEnum[TristateEnum["True"] = 1] = "True";
+        /**
+         * Unsure
+         * 无法判断
+         */
+        TristateEnum[TristateEnum["Unsure"] = 9] = "Unsure";
+    })(TristateEnum = DataTypes.TristateEnum || (DataTypes.TristateEnum = {}));
     /**
      * Convert value to target type
      * @param input Input value

package/lib/cjs/Utils.d.ts

@@ -89,6 +89,7 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
+    const IgnoredProperty: "changedFields";
     /**
      * Add blank item to collection
      * @param options Options
@@ -96,19 +97,19 @@ export declare namespace Utils {
      * @param labelField Label field, default is label
      * @param blankLabel Blank label, default is ---
      */
-    function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): T[];
+    export function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): T[];
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
      * @returns Number
      */
-    function charsToNumber(base64Chars: string): number;
+    export function charsToNumber(base64Chars: string): number;
     /**
      * Correct object's property value type
      * @param input Input object
      * @param fields Fields to correct
      */
-    function correctTypes<T extends object, F extends {
+    export function correctTypes<T extends object, F extends {
         [P in keyof T]?: DataTypes.BasicNames;
     }>(input: T, fields: F): void;
     /**
@@ -117,7 +118,7 @@ export declare namespace Utils {
      * @param v2 Value 2
      * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
      */
-    function equals(v1: unknown, v2: unknown, strict?: number): boolean;
+    export function equals(v1: unknown, v2: unknown, strict?: number): boolean;
     /**
      * Exclude specific items
      * @param items Items
@@ -125,7 +126,7 @@ export declare namespace Utils {
      * @param excludedValues Excluded values
      * @returns Result
      */
-    function exclude<T extends {
+    export function exclude<T extends {
         [P in D]: IdType;
     }, D extends string = "id">(items: T[], field: D, ...excludedValues: T[D][]): T[];
     /**
@@ -135,7 +136,7 @@ export declare namespace Utils {
      * @param excludedValues Excluded values
      * @returns Result
      */
-    function excludeAsync<T extends {
+    export function excludeAsync<T extends {
         [P in D]: IdType;
     }, D extends string = "id">(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]): Promise<T[] | undefined>;
     /**
@@ -143,75 +144,75 @@ export declare namespace Utils {
      * @param input Input string
      * @param upperCase To upper case or lower case
      */
-    function formatInitial(input: string, upperCase?: boolean): string;
+    export function formatInitial(input: string, upperCase?: boolean): string;
     /**
      * Format string with parameters
      * @param template Template with {0}, {1}, ...
      * @param parameters Parameters to fill the template
      * @returns Result
      */
-    function formatString(template: string, ...parameters: string[]): string;
+    export function formatString(template: string, ...parameters: string[]): string;
     /**
-     * Get data changed fields with input data updated
+     * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
      * @param ignoreFields Ignore fields
      * @returns
      */
-    function getDataChanges<T extends object>(input: T, initData: object, ignoreFields?: string[]): (keyof T & string)[];
+    export function getDataChanges<T extends object>(input: T, initData: object, ignoreFields?: string[]): Exclude<keyof T & string, typeof IgnoredProperty>[];
     /**
      * Get nested value from object
      * @param data Data
      * @param name Field name, support property chain like 'jsonData.logSize'
      * @returns Result
      */
-    function getNestedValue(data: object, name: string): any;
+    export function getNestedValue(data: object, name: string): any;
     /**
      * Get input function or value result
      * @param input Input function or value
      * @param args Arguments
      * @returns Result
      */
-    const getResult: <R, T = R | DataTypes.Func<R>>(input: T, ...args: T extends DataTypes.Func<R> ? Parameters<typeof input> : never | []) => T extends DataTypes.Func<R> ? ReturnType<T> : T;
+    export const getResult: <R, T = R | DataTypes.Func<R>>(input: T, ...args: T extends DataTypes.Func<R> ? Parameters<typeof input> : never | []) => T extends DataTypes.Func<R> ? ReturnType<T> : T;
     /**
      * Get time zone
      * @returns Timezone
      */
-    const getTimeZone: () => string | undefined;
+    export const getTimeZone: () => string | undefined;
     /**
      * Is digits string
      * @param input Input string
      * @param minLength Minimum length
      * @returns Result
      */
-    const isDigits: (input?: string, minLength?: number) => boolean;
+    export const isDigits: (input?: string, minLength?: number) => boolean;
     /**
      * Is email string
      * @param input Input string
      * @returns Result
      */
-    const isEmail: (input?: string) => boolean;
+    export const isEmail: (input?: string) => boolean;
     /**
      * Join items as a string
      * @param items Items
      * @param joinPart Join string
      */
-    const joinItems: (items: (string | undefined)[], joinPart?: string) => string;
+    export const joinItems: (items: (string | undefined)[], joinPart?: string) => string;
     /**
      * Merge class names
      * @param classNames Class names
      */
-    const mergeClasses: (...classNames: (string | undefined)[]) => string;
+    export const mergeClasses: (...classNames: (string | undefined)[]) => string;
     /**
      * Create a GUID
      */
-    function newGUID(): string;
+    export function newGUID(): string;
     /**
      * Number to base64 chars
      * @param num Input number
      * @returns Result
      */
-    function numberToChars(num: number): string;
+    export function numberToChars(num: number): string;
     /**
      * Test two objects are equal or not
      * @param obj1 Object 1
@@ -220,7 +221,7 @@ export declare namespace Utils {
      * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
      * @returns Result
      */
-    function objectEqual(obj1: object, obj2: object, ignoreFields?: string[], strict?: number): boolean;
+    export function objectEqual(obj1: object, obj2: object, ignoreFields?: string[], strict?: number): boolean;
     /**
      * Get two object's unqiue properties
      * @param obj1 Object 1
@@ -228,7 +229,7 @@ export declare namespace Utils {
      * @param ignoreFields Ignored fields
      * @returns Unique properties
      */
-    function objectKeys(obj1: object, obj2: object, ignoreFields?: string[]): Set<string>;
+    export function objectKeys(obj1: object, obj2: object, ignoreFields?: string[]): Set<string>;
     /**
      * Get the new object's updated fields contrast to the previous object
      * @param objNew New object
@@ -237,21 +238,21 @@ export declare namespace Utils {
      * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
      * @returns Updated fields
      */
-    function objectUpdated(objNew: object, objPrev: object, ignoreFields?: string[], strict?: number): string[];
+    export function objectUpdated(objNew: object, objPrev: object, ignoreFields?: string[], strict?: number): string[];
     /**
      * Try to parse JSON input to array
      * @param input JSON input
      * @param checkValue Type check value
      * @returns Result
      */
-    function parseJsonArray<T>(input: string, checkValue?: T): T[] | undefined;
+    export function parseJsonArray<T>(input: string, checkValue?: T): T[] | undefined;
     /**
      * Parse string (JSON) to specific type, no type conversion
      * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null): T | undefined;
+    export function parseString<T>(input: string | undefined | null): T | undefined;
     /**
      * Parse string (JSON) to specific type, no type conversion
      * For type conversion, please use DataTypes.convert
@@ -259,38 +260,38 @@ export declare namespace Utils {
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null, defaultValue: T): T;
+    export function parseString<T>(input: string | undefined | null, defaultValue: T): T;
     /**
      * Remove empty values (null, undefined, '') from the input object
      * @param input Input object
      */
-    function removeEmptyValues(input: object): void;
+    export function removeEmptyValues(input: object): void;
     /**
      * Remove non letters
      * @param input Input string
      * @returns Result
      */
-    const removeNonLetters: (input?: string) => string | undefined;
+    export const removeNonLetters: (input?: string) => string | undefined;
     /**
      * Replace null or empty with default value
      * @param input Input string
      * @param defaultValue Default value
      * @returns Result
      */
-    const replaceNullOrEmpty: (input: string | null | undefined, defaultValue: string) => string;
+    export const replaceNullOrEmpty: (input: string | null | undefined, defaultValue: string) => string;
     /**
      * Set source with new labels
      * @param source Source
      * @param labels Labels
      * @param reference Key reference dictionary
      */
-    const setLabels: (source: DataTypes.StringRecord, labels: DataTypes.StringRecord, reference?: Readonly<DataTypes.StringDictionary>) => void;
+    export const setLabels: (source: DataTypes.StringRecord, labels: DataTypes.StringRecord, reference?: Readonly<DataTypes.StringDictionary>) => void;
     /**
      * Snake name to works, 'snake_name' to 'Snake Name'
      * @param name Name text
      * @param firstOnly Only convert the first word to upper case
      */
-    const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
+    export const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
     /**
      * Set nested value to object
      * @param data Data
@@ -298,19 +299,19 @@ export declare namespace Utils {
      * @param value Value
      * @param keepNull Keep null value or not
      */
-    function setNestedValue(data: object, name: string, value: unknown, keepNull?: boolean): void;
+    export function setNestedValue(data: object, name: string, value: unknown, keepNull?: boolean): void;
     /**
      * Parse path similar with node.js path.parse
      * @param path Input path
      */
-    const parsePath: (path: string) => ParsedPath;
+    export const parsePath: (path: string) => ParsedPath;
     /**
      * Sort array by favored values
      * @param items Items
      * @param favored Favored values
      * @returns Sorted array
      */
-    const sortByFavor: <T>(items: T[], favored: T[]) => T[];
+    export const sortByFavor: <T>(items: T[], favored: T[]) => T[];
     /**
      * Sort array by favored field values
      * @param items Items
@@ -318,26 +319,27 @@ export declare namespace Utils {
      * @param favored Favored field values
      * @returns Sorted array
      */
-    const sortByFieldFavor: <T, F extends keyof T>(items: T[], field: F, favored: T[F][]) => T[];
+    export const sortByFieldFavor: <T, F extends keyof T>(items: T[], field: F, favored: T[F][]) => T[];
     /**
      * Trim chars
      * @param input Input string
      * @param chars Trim chars
      * @returns Result
      */
-    const trim: (input: string, ...chars: string[]) => string;
+    export const trim: (input: string, ...chars: string[]) => string;
     /**
      * Trim end chars
      * @param input Input string
      * @param chars Trim chars
      * @returns Result
      */
-    const trimEnd: (input: string, ...chars: string[]) => string;
+    export const trimEnd: (input: string, ...chars: string[]) => string;
     /**
      * Trim start chars
      * @param input Input string
      * @param chars Trim chars
      * @returns Result
      */
-    const trimStart: (input: string, ...chars: string[]) => string;
+    export const trimStart: (input: string, ...chars: string[]) => string;
+    export {};
 }

package/lib/cjs/Utils.js

@@ -133,6 +133,7 @@ String.prototype.removeNonLetters = function () {
  */
 var Utils;
 (function (Utils) {
+    const IgnoredProperty = "changedFields";
     /**
      * Add blank item to collection
      * @param options Options
@@ -253,7 +254,7 @@ var Utils;
     }
     Utils.formatString = formatString;
     /**
-     * Get data changed fields with input data updated
+     * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
      * @param ignoreFields Ignore fields
@@ -264,7 +265,7 @@ var Utils;
         const changes = [];
         Object.entries(input).forEach(([key, value]) => {
             // Ignore fields, no process
-            if (ignoreFields.includes(key))
+            if (key === IgnoredProperty || ignoreFields.includes(key))
                 return;
             // Compare with init value
             const initValue = Reflect.get(initData, key);

package/lib/mjs/DataTypes.d.ts

@@ -283,6 +283,27 @@ export declare namespace DataTypes {
     type DIS<K extends string, T> = {
         [P in K]: T;
     };
+    /**
+     * Tristate enum
+     * 三态枚举
+     */
+    enum TristateEnum {
+        /**
+         * False
+         * 假
+         */
+        False = 0,
+        /**
+         * True
+         * 真
+         */
+        True = 1,
+        /**
+         * Unsure
+         * 无法判断
+         */
+        Unsure = 9
+    }
     /**
      * Convert value to target type
      * @param input Input value

package/lib/mjs/DataTypes.js

@@ -95,6 +95,28 @@ export var DataTypes;
         PlacementEnum[PlacementEnum["BottomRight"] = 8] = "BottomRight";
         PlacementEnum[PlacementEnum["Unknown"] = 9] = "Unknown"; // Reserved for modal, only one instance held at the same time
     })(PlacementEnum = DataTypes.PlacementEnum || (DataTypes.PlacementEnum = {}));
+    /**
+     * Tristate enum
+     * 三态枚举
+     */
+    let TristateEnum;
+    (function (TristateEnum) {
+        /**
+         * False
+         * 假
+         */
+        TristateEnum[TristateEnum["False"] = 0] = "False";
+        /**
+         * True
+         * 真
+         */
+        TristateEnum[TristateEnum["True"] = 1] = "True";
+        /**
+         * Unsure
+         * 无法判断
+         */
+        TristateEnum[TristateEnum["Unsure"] = 9] = "Unsure";
+    })(TristateEnum = DataTypes.TristateEnum || (DataTypes.TristateEnum = {}));
     /**
      * Convert value to target type
      * @param input Input value