nmce-func 0.0.3 → 0.0.7

package/_func/addressFunc.d.ts

@@ -0,0 +1,31 @@
+export declare class AddressFunc {
+    /**
+     * Compose to one line separated by comma
+     * @param st1
+     * @param st2
+     * @param city
+     * @param state
+     * @param postcode
+     */
+    static composeOneLineAddress(st1: string | undefined, st2: string | undefined, city: string | undefined, state: string | undefined, postcode: string | undefined): string;
+    /**
+     * Compose to multiple separated by \n
+     * @param st1
+     * @param st2
+     * @param city
+     * @param state
+     * @param postcode
+     */
+    static composeMultiLineAddress(st1: string | undefined, st2: string | undefined, city: string | undefined, state: string | undefined, postcode: string | undefined): string;
+    /**
+     * Compose with separator
+     * @param st1
+     * @param st2
+     * @param city
+     * @param state
+     * @param postcode
+     * @param sep
+     */
+    static composeAddress(st1: string | undefined, st2: string | undefined, city: string | undefined, state: string | undefined, postcode: string | undefined, sep: string | undefined): string;
+    static composeGoogleMapsAuUrl(st1: string | undefined, st2: string | undefined, city: string | undefined, state: string | undefined, country: string | undefined): string;
+}

package/_func/authentication.service.d.ts

@@ -0,0 +1,24 @@
+import { HttpClient } from '@angular/common/http';
+/**
+ * Login and saving tokens in sessionStorage.
+ * App needs to provide constant 'auth.tokenUrl'.
+ */
+export declare class AuthenticationService {
+    private authUri;
+    private http;
+    userName: string;
+    constructor(authUri: string, http: HttpClient);
+    /**
+     * Login and save tokens to sessionStorage then return an observable.
+     * @param username
+     * @param password
+     */
+    login(username: string, password: string): import("rxjs").Observable<{
+        access_token?: string | undefined;
+        expires?: string | undefined;
+        expires_in?: number | undefined;
+        issued?: string | undefined;
+        token_type?: string | undefined;
+        username: string;
+    }>;
+}

package/_func/currencyFunc.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Currency calculations. Undefined input of number is considered zero, just like null.
+ */
+export declare class CurrencyFunc {
+    private static DECIMAL_SEPARATOR;
+    private static THOUSANDS_SEPARATOR;
+    private static PADDING;
+    /**
+     *
+     * @param num
+     * @param decimalPlaces default 0
+     */
+    static bankerRound(num: number | null | undefined, decimalPlaces?: number): number;
+    static bankerRoundTo5cents(num: number | null | undefined): number;
+    static ceilTo5cents(num: number | null | undefined): number;
+    static transformCurrency(value: number | string | undefined, fractionSize?: number): string;
+    static parseCurrency(value: string | undefined, fractionSize?: number): string;
+    static pad(num: number | null | undefined, size: number): string;
+    static sum(ns: (number | null | undefined)[]): number;
+}

package/_func/dateFunc.d.ts

@@ -0,0 +1,121 @@
+import moment from 'moment';
+export declare class DateFunc {
+    /**
+     * Transform UTC DateTime to local date without H, M and S. For example, the month day of 2018-01-23T22:00:00Z is 24 in Australia.
+     * @param dtUtc
+     * @param offsetMinutes if not defined, it will be new Date().getTimezoneOffset(). //https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset
+     */
+    static dateTimeUtcToLocalDateNumber(dtUtc: Date | null | undefined): number;
+    /**
+     * Date only. However, the date may still be in UTC.
+     * @param dtUtc
+     */
+    static dateTimeUtcToLocalDate(dtUtc: Date | null | undefined): Date;
+    static localISODateString(dtUtc: Date | null | undefined): string;
+    /**
+     * locate date ONLY (no time) to UTC date.
+     * @param dt if dt contain time info, it will become dt.setHours(0, 0, 0, 0)
+     */
+    static localDateToUtc(d: Date | number | null | undefined | string): Date;
+    static getTimezoneOffset(): number;
+    /**
+     * Transform UTC DateTime to local dateTime.
+     * @param dtUtc
+     * @param offsetMinutes if not defined, it will be new Date().getTimezoneOffset(). //https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset
+     */
+    static dateTimeUtcToLocalDateTime(dtUtc: Date | null | undefined): Date;
+    static dateTimeUtcToLocaMoment(dtUtc: Date | null | undefined): moment.Moment;
+    static getEndOfWeek(dt: Date | null | undefined | number): Date;
+    static getStartOfWeek(dt: Date | null | undefined | number): Date;
+    static getEndOfMonth(dt: Date | null | undefined | number): Date;
+    static getStartOfMonth(dt: Date | null | undefined | number): Date;
+    static getDaysBetweenDates(dt1: Date | null | undefined, dt2: Date | null | undefined): number;
+    static getEndOfDate(dt: Date | null | undefined): Date;
+    static getStartOfDate(dt: Date | null | undefined): Date;
+    static getEndOfToday(): Date;
+    static getStartOfToday(): Date;
+    static addDays(dt: Date | null | undefined, days?: number): Date;
+    static subtractDays(dt: Date | null | undefined, days?: number): Date;
+    /**
+     * Start of today
+     */
+    static get today(): Date;
+    static get now(): Date;
+    static getNext5MinuteMark(): Date;
+    static getYMD(d: Date): string;
+    static getDMYWithSlash(d: Date): string;
+    static getDMYHmWithSlash(d: Date): string;
+    static getMcpTime(dt: Date | null | undefined): string;
+    /**
+     * In 24 hour format
+     * @param dtUtc
+     */
+    static getLocalDMYHmWithSlash(dtUtc: Date | null | undefined): string;
+    /**
+     * Offset minutes comparing with today
+     */
+    static getOffsetMinutes(dtUtc: Date | null | undefined | number): number;
+    static getDaysBetween(d1?: Date | number | null | undefined, d2?: Date | number | null | undefined): number;
+    /**
+     * Get hour of the date. If Date is not defined, the hour will be current hour.
+     * @param dtUtc
+     */
+    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 | 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;
+    static olderThanMinutes(d: Date, minutes: number): boolean;
+    /**
+     * It could be 11PM yesterday, and 1 AM today. Actually based on local today.
+     */
+    static olderThan1Day(dtUtc: Date | null | undefined): boolean;
+    static getHourAge(d: Date): number;
+    static getHourAgeUtc(dtUtc: Date | null | undefined): number;
+    /**
+     * Compare utc date with utc now.
+     * @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;
+    static addMonth(d: Date, m: number): Date;
+    static getDuration(d1: Date, d2: Date): moment.Duration;
+    /**
+     * Convert minutes from midnight to HH:mm text
+     * @param mins
+     */
+    static getHMFromMins(mins: number): string;
+    static getMinutesSinceMidnight(d: Date | null | undefined): number;
+    static getMinutesBetween(start: Date | null | undefined, end: Date | null | undefined): number;
+    /**
+     * Parse json string with date serialized into string, and get proper date object back
+     * @param s
+     */
+    static dateSafeJsonParse(s: string): any;
+    private static dateReviver;
+    private static isSerializedDate;
+    private static isString;
+    static dateSafeParse(s: string | Date): Date;
+    static composeDateWithMinutes(d: Date, minute: number): Date;
+    /**
+     * Safe compare since date data may be considered as string rather than date.
+     * @param d1
+     * @param d2
+     */
+    static compare(d1: Date | undefined, d2: Date | undefined): number;
+}

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

@@ -0,0 +1,10 @@
+export * from './addressFunc';
+export * from './authentication.service';
+export * from './currencyFunc';
+export * from './dateFunc';
+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/jsonFunc.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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.
+     * Angular date pipe could actually consume such string without explicitly converting to number.
+     * @param array
+     * @param propertyName
+     */
+    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

@@ -0,0 +1,41 @@
+export declare class StringFunc {
+    /**
+     * Up to 2 letters. For John Smith, returns JS, for Huang, Zijian, returns ZH
+     * @param s
+     */
+    static getAbbr(s: string | null | undefined): string;
+    /**
+     * A substring with line breaks replaced by space.
+     * @param s
+     * @param length
+     * @returns result, or empty string if the input is empty, null or undefined
+     */
+    static getOneLineDigest(s: string | null | undefined, length: number): string;
+    /**
+     * Remove line breaks and econde with encodeURI() so the data could be saved in Azure as meta. If the string is truncated, the return will have ... suffix.
+     * @param s
+     * @param length
+     * @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
+     * @param s
+     * @returns result. If input is empty, null, or undefined, return the same.
+     */
+    static getHtmlPlainText(s: string | null | undefined): string | null;
+    /**
+     *
+     * @param s
+     * @returns result. If input is empty, null, or undefined, return the same.
+     */
+    static capitalizeWords(s: string | null | undefined): string | null | undefined;
+    static validateEmail(email: string | null | undefined): boolean;
+}

package/_func/uuidFunc.d.ts

@@ -0,0 +1,7 @@
+export declare class UuidFunc {
+    /**
+     * 36 UUID string including 4 hyphens. MySql stores GUID as 36 bytes anyway rather than 16bytes.
+     */
+    static newUUID(): string;
+    static newUUIDStartWith0(): string;
+}