nmce-func 0.0.6 → 0.0.7

package/_func/dateFunc.d.ts

@@ -63,7 +63,7 @@ export declare class DateFunc {
     static getHour(dtUtc: Date | null | undefined | number): number;
     static getMinute(dtUtc: Date | null | undefined | number): number;
     static composeDateTime(dt: Date | null | undefined, h?: number, minute?: number): Date;
-    static olderThan24Hours(d: Date): boolean;
+    static olderThan24Hours(d: Date | null | undefined): boolean;
     static olderThan24HoursUtc(dtUtc: Date | null | undefined): boolean;
     static olderThanHours(d: Date, hours: number): boolean;
     static olderThanHoursUtc(dtUtc: Date | null | undefined, hours: number): boolean;
@@ -79,7 +79,17 @@ export declare class DateFunc {
      * @param dtUtc
      */
     static getDayAgeUtc(dtUtc: Date | null | undefined): number;
+    /**
+     * How many years from now.
+     * @param d
+     * @returns
+     */
     static getAge(d: Date): number;
+    /**
+     * Year of date.
+     * @param d
+     * @returns
+     */
     static getYear(d: Date): number;
     static getUtcNow(): Date;
     static addMinutes(d: Date, m: number): Date;

package/_func/htmlPrintFunc.d.ts

@@ -0,0 +1,18 @@
+export declare class HtmlPrintFunc {
+    /**
+     * Print with CSS for internal reports
+     * @param htmlTags
+     * @param cssUrl
+     */
+    static printWithCSS(htmlTags: string, cssUrl: string): boolean;
+    /**
+     * Print for external documents.
+     * @param htmlTags
+     */
+    static print(htmlTags: string): boolean;
+    /**
+     * Print image url through html img.
+     * @param url
+     */
+    static printImage(url: string): void;
+}

package/_func/index.d.ts

@@ -2,7 +2,9 @@ export * from './addressFunc';
 export * from './authentication.service';
 export * from './currencyFunc';
 export * from './dateFunc';
-export * from './helperFunc';
-export * from './htmlFunc';
-export * from './jsFunc';
+export * from './htmlPrintFunc';
+export * from './javascriptFunc';
+export * from './jsonFunc';
+export * from './stringAusFunc';
 export * from './stringFunc';
+export * from './uuidFunc';

package/_func/javascriptFunc.d.ts

@@ -0,0 +1,9 @@
+export declare class JavaScriptFunc {
+    /**
+     * Some business functions depend on external JavaScript libraries. Lazy loading of respective business modules is good,
+     * and this function supports lazy loading of JS libraries.
+     * @param scriptUrl
+     * @returns Promise for subsequent JS function calls.
+     */
+    static loadExternalScript(scriptUrl: string): Promise<unknown>;
+}

package/_func/{jsFunc.d.ts → jsonFunc.d.ts}

@@ -1,7 +1,17 @@
-export declare class JSFunc {
+/**
+ * Basic JSON functions
+ */
+export declare class JsonFunc {
+    /**
+     *
+     * @param array Group by a property of array element.
+     * @param propertyName
+     * @returns
+     */
     static groupBy<T>(array: Array<T>, propertyName: string): any;
     /**
-     * Group by a date property. The key is always of string type and representing milliseconds. The client should convert the string to number.
+     * Group by a date property. The key is always of string type and representing milliseconds.
+     * The client should convert the string to number.
      * Angular date pipe could actually consume such string without explicitly converting to number.
      * @param array
      * @param propertyName
@@ -9,8 +19,13 @@ export declare class JSFunc {
     static groupByDate<T>(array: Array<T>, propertyName: string): any;
     /**
      * Remove null or empty fields including those in nested objects.
+     * This is useful for reducing payload of AJAX serialization.
      * @param obj
      */
     static removeNullOrEmptyFields(obj: any): void;
+    /**
+     *
+     * @param obj Remove null fields of object at only the 1st level.
+     */
     static removeNullFields(obj: any): void;
 }

package/_func/stringAusFunc.d.ts

@@ -0,0 +1,40 @@
+/**
+ * String functions specific to Australia
+ */
+export declare class StringAusFunc {
+    private static acnWeights;
+    private static weights;
+    private static suggestLookup;
+    /**
+     * Validate medicare number
+     * @param n
+     * @returns validation error message
+     */
+    static validateMedicare(n: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+    static validateMedicareProviderNumber(providerNumber: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+    static validateDVAFileNumber(dva: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+    static validateTFN(n: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+    private static addWeighted;
+    private static addAcnWeighted;
+    private static generateLookup;
+    static validateABN(abn: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+    static validateACN(acn: string | null | undefined): {
+        code: number;
+        message: string;
+    } | null;
+}

package/_func/stringFunc.d.ts

@@ -1,7 +1,4 @@
 export declare class StringFunc {
-    private static acnWeights;
-    private static weights;
-    private static suggestLookup;
     /**
      * Up to 2 letters. For John Smith, returns JS, for Huang, Zijian, returns ZH
      * @param s
@@ -21,6 +18,12 @@ export declare class StringFunc {
      * @returns result, or empty string if the input is empty, null or undefined
      */
     static getOneLineDigestOfHtml(s: string | null | undefined, length: number): string;
+    /**
+     * Pad number with zero
+     * @param num
+     * @param size
+     * @returns
+     */
     static pad(num: number | undefined, size: number): string;
     /**
      * get plain text of HTML content
@@ -34,37 +37,5 @@ export declare class StringFunc {
      * @returns result. If input is empty, null, or undefined, return the same.
      */
     static capitalizeWords(s: string | null | undefined): string | null | undefined;
-    /**
-     * Validate medicare number
-     * @param n
-     * @returns validation error message
-     */
-    static validateMedicare(n: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    static validateMedicareProviderNumber(providerNumber: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    static validateDVAFileNumber(dva: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    static validateTFN(n: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    private static addWeighted;
-    private static addAcnWeighted;
-    private static generateLookup;
-    static validateABN(abn: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    static validateACN(acn: string | null | undefined): {
-        code: number;
-        message: string;
-    } | null;
-    validateEmail(email: string | null | undefined): boolean;
+    static validateEmail(email: string | null | undefined): boolean;
 }

package/_func/{helperFunc.d.ts → uuidFunc.d.ts}

@@ -1,5 +1,4 @@
-export declare class HelperFunc {
-    static loadExternalScript(scriptUrl: string): Promise<unknown>;
+export declare class UuidFunc {
     /**
      * 36 UUID string including 4 hyphens. MySql stores GUID as 36 bytes anyway rather than 16bytes.
      */