@beinformed/ui 1.24.1-beta.1 → 1.24.1-beta.4

package/types/utils/browser/Cache.d.ts

@@ -0,0 +1,45 @@
+declare const _default: Cache;
+export default _default;
+/**
+ * Manage the browser cache
+ */
+declare class Cache {
+    _cache: Storage;
+    /**
+     * Create a key that can be used to cache resources, needs the request arguments and uses url, params and header of the request args
+     * to create a key that is unique for time versions and locale
+     */
+    createResourceKey(requestArgs: RequestOptions): string;
+    /**
+     * Get a cached item by it's key
+     */
+    getItem(key: string): any;
+    /**
+     * Check if the item with key exists in the browser cache
+     */
+    hasItem(key: string): boolean;
+    /**
+     * Add an item to the cache
+     */
+    addItem(key: string, value: string | Object): void;
+    /**
+     */
+    setItem(key: string, value: string | Object): void;
+    /**
+     */
+    removeItem(key: string): void;
+    /**
+     * Clear complete cache storage
+     */
+    clear(pattern: string | null): void;
+    /**
+     */
+    loadOtherBrowserTabs(callback: Function): void;
+    /**
+     */
+    sendSessionStorage(e: StorageEvent): void;
+    /**
+     */
+    receiveSessionStorage(e: StorageEvent, callback: Function): any;
+}
+import { RequestOptions } from "../fetch/types";

package/types/utils/browser/Cookies.d.ts

@@ -0,0 +1,15 @@
+/**
+ */
+export function getCookie(name: string): null | string;
+/**
+ */
+export function setCookie(name: string, value: any, options?: CookieOptions): void;
+/**
+ */
+export function clearCookie(name: string): void;
+type CookieOptions = {
+    days?: number;
+    sameSite?: "None" | "Lax" | "Strict";
+    secure?: boolean;
+};
+export {};

package/types/utils/datetime/DateTimeUtil.d.ts

@@ -0,0 +1,164 @@
+/// <reference types="date-fns" />
+/**
+ * DateUtil
+ */
+export const DateUtil: BaseDateTimeUtil;
+/**
+ * DateTimeUtil
+ */
+export const DateTimeUtil: BaseDateTimeUtil;
+/**
+ * TimeUtil
+ */
+export const TimeUtil: BaseDateTimeUtil;
+/**
+ * TimestampUtil
+ */
+export const TimestampUtil: BaseDateTimeUtil;
+/**
+ * @hideconstructor
+ */
+declare class BaseDateTimeUtil {
+    constructor(isoFormat: string);
+    _isoFormat: string;
+    /**
+     */
+    getLocale(): typeof nl | typeof enGB;
+    getOptions(): {
+        weekStartsOn: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+        firstWeekContainsDate: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    };
+    /**
+     */
+    toDate(date: string, inputFormat?: string): Date;
+    /**
+     */
+    toFormat(date: string | Date, targetFormat: string): string;
+    /**
+     */
+    toISO(date: string | Date, sourceFormat?: string): string;
+    /**
+     */
+    now(): string;
+    /**
+     */
+    convertFormat(sourceFormat: string): string;
+    /**
+     * VALIDATION
+     */
+    hasFormat(date: string, sourceFormat: string): boolean;
+    /**
+     */
+    isValid(date: string, inputFormat?: string): boolean;
+    /**
+     */
+    isAfter(inputDate: string, afterISODate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isSameOrAfter(inputDate: string, afterISODate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isBefore(inputDate: string, beforeISODate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isSameOrBefore(inputDate: string, beforeISODate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isSame(inputDate: string, compareDate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isSameDay(inputDate: string, compareDate: string, inputFormat?: string): boolean;
+    /**
+     */
+    isOther(inputDate: string, compareDate: string | null, inputFormat?: string): boolean;
+    /**
+     */
+    isWeekend(inputDate: string): boolean;
+    /**
+     * CALCULATIONS
+     */
+    addSeconds(date: string, amount: number): string;
+    /**
+     */
+    addMinutes(date: string, amount: number): string;
+    /**
+     */
+    addHours(date: string, amount: number): string;
+    /**
+     */
+    addDays(date: string, amount: number): string;
+    /**
+     */
+    addWeeks(date: string, amount: number): string;
+    /**
+     */
+    addMonths(date: string, amount: number): string;
+    /**
+     */
+    addYears(date: string, amount: number): string;
+    /**
+     */
+    subtractSeconds(date: string, amount: number): string;
+    /**
+     */
+    subtractMinutes(date: string, amount: number): string;
+    /**
+     */
+    subtractHours(date: string, amount: number): string;
+    /**
+     */
+    subtractDays(date: string, amount: number): string;
+    /**
+     */
+    subtractWeeks(date: string, amount: number): string;
+    /**
+     */
+    subtractMonths(date: string, amount: number): string;
+    /**
+     */
+    subtractYears(date: string, amount: number): string;
+    /**
+     * GETTERS
+     */
+    startOfMonth(date: string, inputFormat?: string): string;
+    /**
+     */
+    endOfMonth(date: string, inputFormat?: string): string;
+    /**
+     */
+    startOfWeek(date: string, inputFormat?: string): string;
+    /**
+     */
+    getHours(date: string | Date): number;
+    /**
+     */
+    getMinutes(date: string | Date): number;
+    /**
+     */
+    getWeek(date: string): number;
+    /**
+     * SETTERS
+     */
+    setYear(date: string, year: number): string;
+    /**
+     */
+    setMonth(date: string, month: number): string;
+    /**
+     */
+    setHour(date: string, hour: number): string;
+    /**
+     */
+    setMinute(date: string, minute: number): string;
+    /**
+     */
+    setSecond(date: string, second: number): string;
+    /**
+     */
+    setMilliseconds(date: string, milliseconds: number): string;
+    /**
+     */
+    setTime(date: string, hours: number, minutes: number, seconds: number, milliseconds: number): string;
+}
+import { nl } from "date-fns/locale";
+import { enGB } from "date-fns/locale";
+export {};

package/types/utils/fetch/serverFetch.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch data from server (uses nashorn and datafetcher).
+ */
+export default function serverFetch(args: RequestOptions): Promise<any>;
+import { RequestOptions } from "./types";

package/types/utils/fetch/types.d.ts

@@ -0,0 +1,38 @@
+type RequestURLOptions = {
+    url: string;
+};
+type RequestBaseOptions = {
+    method?: $Keys<HTTP_METHODS>;
+    params?: string;
+    data?: string | {
+        [key: string]: string;
+    };
+    timeout?: number;
+    responseType?: string;
+    headers?: {
+        [headerName: string]: string;
+        Accept?: string;
+        "Accept-Language"?: string;
+        "Content-Type"?: string;
+        "x-filename"?: string;
+        "x-filesize"?: string;
+    };
+    events?: {
+        [eventName: string]: () => void;
+    };
+    onProgress?: ProgressEventHandler;
+    includeContext?: boolean;
+    locale?: string;
+    cache?: boolean;
+    childmodels?: boolean;
+    isValidationRequest?: boolean;
+    targetModel?: Class<ModularUIModel>;
+    updateModel?: ModularUIModel;
+    isReload?: boolean;
+    removeOnUnmount?: boolean;
+};
+type RequestOptions = {
+    RequestURLOptions: any;
+    RequestBaseOptions: any;
+};
+export {};

package/types/utils/fetch/universalFetch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Request data from server, uses server datafetcher or xhr in browser.
+ */
+export default function universalFetch(args: RequestOptions): Promise<CachedResponse> | Promise<(string | {}) | null>;
+import { RequestOptions } from "./types";
+type CachedResponse = string | {};
+export {};

package/types/utils/fetch/xhr.d.ts

@@ -0,0 +1,5 @@
+export default xhr;
+/**
+ */
+declare function xhr(args: RequestOptions): Promise<any>;
+import { RequestOptions } from "./types";

package/types/utils/helpers/checkResource.d.ts

@@ -0,0 +1,3 @@
+export function resourceExists(url: string | Href): boolean;
+export function resourceRedirectsToSecureLogin(url: string | Href): boolean;
+import Href from "../../models/href/Href";

package/types/utils/helpers/createHash.d.ts

@@ -0,0 +1,8 @@
+/**
+ * https://werxltd.com/wp/2010/05/13/javascript-implementation-of-javas-string-hashcode-method/
+ */
+export function createHash(str: string): number;
+/**
+ */
+export function createHashFromHref(href: Href): number;
+import Href from "../../models/href/Href";

package/types/utils/helpers/createUUID.d.ts

@@ -0,0 +1,4 @@
+export default createUUID;
+/**
+ */
+declare function createUUID(): string;

package/types/utils/helpers/objects.d.ts

@@ -0,0 +1,3 @@
+export function isPlainObject(value: any): boolean;
+export function has(obj: any, propName: string): boolean;
+export function get(obj: {}, ...: any[]): any;

package/types/utils/helpers/sanitizeHtml.d.ts

@@ -0,0 +1,9 @@
+/**
+ * removes unwanted html, this might result in incorrect html, as it removes all html that we don't except,
+ * like <b style="font-weight: 400">bold</b> will result in bold</b>
+ */
+export function removeUnwantedHtml(html: string, options?: removeUnwantedHtmlOptions): string;
+type removeUnwantedHtmlOptions = {
+    allowedTags?: string[];
+};
+export {};

package/types/utils/helpers/text.d.ts

@@ -0,0 +1,7 @@
+export function retrieveText(text: string | {
+    id?: string;
+    message: string;
+    properties?: {
+        [key: string]: any;
+    };
+}): string;

package/types/utils/index.d.ts

@@ -0,0 +1,16 @@
+export { default as Cache } from "./browser/Cache";
+export * from "./browser/Cookies";
+export * from "./datetime/DateTimeUtil";
+export * from "./fetch/types";
+export * from "./helpers/createHash";
+export * from "./helpers/sanitizeHtml";
+export * from "./helpers/objects";
+export * from "./helpers/text";
+export * from "./helpers/checkResource";
+export * from "./number/parseNumbers";
+export { default as serverFetch } from "./fetch/serverFetch";
+export { default as universalFetch } from "./fetch/universalFetch";
+export { default as xhr } from "./fetch/xhr";
+export { default as createUUID } from "./helpers/createUUID";
+export { default as DecimalFormat } from "./number/DecimalFormat";
+export { default as formatValue } from "./number/formatValue";

package/types/utils/number/DecimalFormat.d.ts

@@ -0,0 +1,90 @@
+export default DecimalFormat;
+/**
+ */
+declare class DecimalFormat {
+    /**
+     * Solves problem where big numbers loose the precision:
+     * e.g. Number(23423423423342234.34) => 23423423423342236
+     */
+    static getNumericString(stringNumber: string): string;
+    /**
+     */
+    static scientificNumber(stringNumber: string): string;
+    /**
+     */
+    static getFraction(number: string): string;
+    /**
+     */
+    constructor(format: string);
+    _prefix: string;
+    _suffix: string;
+    _comma: number;
+    _minInt: number;
+    _minFrac: number;
+    _maxFrac: number;
+    _isPercentage: boolean;
+    /**
+     */
+    get prefix(): string;
+    /**
+     */
+    get suffix(): string;
+    /**
+     */
+    get comma(): number;
+    /**
+     */
+    get minInt(): number;
+    /**
+     */
+    get minFrac(): number;
+    /**
+     */
+    get maxFrac(): number;
+    /**
+     */
+    get isPercentage(): boolean;
+    /**
+     */
+    setAffix(format: string): void;
+    /**
+     */
+    setFractionLengths(format: string): void;
+    /**
+     */
+    setGroupLength(format: string): void;
+    /**
+     */
+    setMinLength(format: string): void;
+    /**
+     */
+    setPercentage(): void;
+    /**
+     * Converts formatted value back to non-formatted value
+     * e.g. $1,223.06 --> 1223.06
+     */
+    formatBack(formattedNumber: string): string;
+    /**
+     */
+    getFracAsNumber(fracStr: string): string;
+    /**
+     */
+    getRoundedFrac(fracStr: string): string;
+    /**
+     */
+    getFracCorrectLength(frac: string): string;
+    /**
+     */
+    getInteger(number: string): string;
+    /**
+     */
+    addGrouping(intStr: string): string;
+    /**
+     */
+    getFormattedValue(intStr: string, fracStr: string, isNegative: boolean): string;
+    /**
+     * Formats given value, using the pattern
+     * e.g. $#,###.00: 1223.06 --> $1,223.06
+     */
+    format(stringNumber?: string): string;
+}

package/types/utils/number/formatValue.d.ts

@@ -0,0 +1,4 @@
+export default formatValue;
+/**
+ */
+declare function formatValue(value: (number | (string | null)) | null, format?: string | null, groupingSeparator?: string, decimalSeparator?: string): string;

package/types/utils/number/parseNumbers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Parses input into a number, removes the grouping separator from the input and
+ * replaces the decimal separator with a dot to make it a JavaScript parseable number
+ */
+export function parseToNumber(input: (string | (number | null)) | null, groupingSeparator?: string | null, decimalSeparator?: string | null): number;
+/**
+ * parses Numbers To String
+ */
+export function parseNumberToString(input: (string | (number | null)) | null, groupingSeparator?: string | null, decimalSeparator?: string | null): string;

package/utils/package.json

@@ -4,5 +4,6 @@
   "main": "../lib/utils/index.js",
   "jsnext:main": "../esm/utils/index.js",
   "module": "../esm/utils/index.js",
-  "esnext": "../src/utils/index.js"
+  "esnext": "../src/utils/index.js",
+  "types": "../types/utils/index.d.ts"
 }