@oneblink/apps-react 9.0.0-beta.2 → 9.0.0-beta.4

package/dist/apps/localisation-service.d.ts

@@ -0,0 +1,207 @@
+import { submissionService } from '@oneblink/sdk-core';
+/**
+ * Get the locale (e.g. `en-AU`) for the current tenant.
+ *
+ * #### Example
+ *
+ * ```js
+ * const locale = localisationService.getLocale()
+ * ```
+ *
+ * @returns
+ */
+export declare function getLocale(): "en-AU" | "en-US";
+/**
+ * Get the distance units (e.g. `feet` & 'ft) for the current tenant.
+ *
+ * #### Example
+ *
+ * ```js
+ * const { distanceUnit, distanceUnitShortName } =
+ *   localisationService.getDistanceUnits()
+ * ```
+ *
+ * @returns
+ */
+export declare function getDistanceUnits(): {
+    distanceUnit: string;
+    distanceUnitShortName: string;
+};
+export declare function getDateFnsFormats(): {
+    time: string;
+    shortDate: string;
+    shortYearlessDate: string;
+    longDate: string;
+    longYearlessDate: string;
+    shortDateTime: string;
+    longDateTime: string;
+};
+/**
+ * Format a `Date` as a `string` that just contains the date portion e.g.
+ * _31/01/2020_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDate(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatDate(value: Date): string;
+/**
+ * Format a `Date` as a `string` that just contains the date portion in a long
+ * format e.g. _Thursday, 2 January 2020_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDateLong(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatDateLong(value: Date): string;
+/**
+ * Format a `Date` as a `string` that just contains the time portion e.g. _5:31
+ * pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatTime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatTime(value: Date): string;
+/**
+ * Format a `Date` as a `string` that contains the date and time portions e.g.
+ * _31/01/2020 5:31 pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDatetime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatDatetime(value: Date): string;
+/**
+ * Format a `Date` as a `string` that contains the date and time portions in a
+ * long format e.g. _Thursday, 2 January 2020 5:31 pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDatetime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatDatetimeLong(value: Date): string;
+/**
+ * Format a `number` as a `string` represented as a readable number e.g.
+ * _123,321.123_
+ *
+ * #### Example
+ *
+ * ```js
+ * const amount = 1234.4321
+ * const text = localisationService.formatCurrency(amount)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatNumber(value: number): string;
+/**
+ * Format a `number` as a `string` represented as a currency e.g. _$123.31_
+ *
+ * #### Example
+ *
+ * ```js
+ * const amount = 123.321
+ * const text = localisationService.formatCurrency(amount)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export declare function formatCurrency(value: number): string;
+/**
+ * Generate a `Date` based a `string` while adding/subtracting a number of days.
+ * Use this function to generate a date with the correct time if only the date
+ * part is required to be formatted for display purposes. Also supports passing
+ * `'NOW'` as the value to get the current date with an offset.
+ *
+ * #### Example
+ *
+ * ```js
+ * const dateOnly = localisationService.generateDate({
+ *   value: '2023-05-04',
+ *   dateOnly: true,
+ *   daysOffset: undefined,
+ * })
+ *
+ * const date = localisationService.generateDate({
+ *   value: '2023-05-04T02:49:23.616Z',
+ *   dateOnly: false,
+ *   daysOffset: undefined,
+ * })
+ *
+ * const now = localisationService.generateDate({
+ *   value: 'NOW',
+ *   dateOnly: false,
+ *   daysOffset: undefined,
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export declare function generateDate({ daysOffset, value, }: {
+    daysOffset: number | undefined;
+    value: string;
+}): Date | undefined;
+export declare const replaceSubmissionFormatters: submissionService.ReplaceInjectablesFormatters;
+/**
+ * Replace the `{ELEMENT:<elementName>}` values in text after a successful form
+ * submission as well as other replaceable parameters e.g. `submissionId`. The
+ * replacements are suppose to be user friendly and for display purposes, e.g.
+ * dates should be displayed in the user's desired format and timezone.
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
+export declare function replaceInjectablesWithSubmissionValues(text: string, options: Omit<Parameters<typeof submissionService.replaceInjectablesWithSubmissionValues>[1], keyof submissionService.ReplaceInjectablesFormatters>): ReturnType<typeof submissionService.replaceInjectablesWithSubmissionValues>;
+/**
+ * Replace the `{ELEMENT:<elementName>}` values in text while a form is being
+ * filled out. The replacements are suppose to be user friendly and for display
+ * purposes, e.g. dates should be displayed in the user's desired format and
+ * timezone.
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
+export declare function replaceInjectablesWithElementValues(text: string, options: Omit<Parameters<typeof submissionService.replaceInjectablesWithElementValues>[1], keyof submissionService.ReplaceInjectablesFormatters>): ReturnType<typeof submissionService.replaceInjectablesWithElementValues>;

package/dist/apps/localisation-service.js

@@ -0,0 +1,321 @@
+import { submissionService } from '@oneblink/sdk-core';
+import tenants from './tenants';
+import parser from 'ua-parser-js';
+import { add, parse } from 'date-fns';
+let iosVersion;
+const parsedUserAgent = parser(window.navigator.userAgent);
+if (parsedUserAgent.os.name === 'iOS' &&
+    typeof parsedUserAgent.os.version === 'string') {
+    iosVersion = parseFloat(parsedUserAgent.os.version);
+    if (Number.isNaN(iosVersion)) {
+        iosVersion = undefined;
+    }
+}
+/**
+ * Get the locale (e.g. `en-AU`) for the current tenant.
+ *
+ * #### Example
+ *
+ * ```js
+ * const locale = localisationService.getLocale()
+ * ```
+ *
+ * @returns
+ */
+export function getLocale() {
+    return tenants.locale;
+}
+/**
+ * Get the distance units (e.g. `feet` & 'ft) for the current tenant.
+ *
+ * #### Example
+ *
+ * ```js
+ * const { distanceUnit, distanceUnitShortName } =
+ *   localisationService.getDistanceUnits()
+ * ```
+ *
+ * @returns
+ */
+export function getDistanceUnits() {
+    return {
+        distanceUnit: tenants.current.distanceUnit,
+        distanceUnitShortName: tenants.current.distanceUnitShortName,
+    };
+}
+function generateFormats({ time, shortDate, shortYearlessDate, longDate, longYearlessDate, }) {
+    return {
+        time,
+        shortDate,
+        shortYearlessDate,
+        longDate,
+        longYearlessDate,
+        shortDateTime: `${shortDate} ${time}`,
+        longDateTime: `${longDate} ${time}`,
+    };
+}
+export function getDateFnsFormats() {
+    const time = 'h:mm a';
+    switch (tenants.locale) {
+        case 'en-US': {
+            return generateFormats({
+                time,
+                shortDate: 'MM/dd/yyyy',
+                shortYearlessDate: 'MM/dd',
+                longDate: 'MMM do, yyyy',
+                longYearlessDate: 'MMM do',
+            });
+        }
+        case 'en-AU':
+        default: {
+            return generateFormats({
+                time,
+                shortDate: 'dd/MM/yyyy',
+                shortYearlessDate: 'dd/MM',
+                longDate: 'do MMM, yyyy',
+                longYearlessDate: 'do MMM',
+            });
+        }
+    }
+}
+/**
+ * Format a `Date` as a `string` that just contains the date portion e.g.
+ * _31/01/2020_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDate(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatDate(value) {
+    return tenants.current.intlFormats.date.format(value);
+}
+/**
+ * Format a `Date` as a `string` that just contains the date portion in a long
+ * format e.g. _Thursday, 2 January 2020_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDateLong(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatDateLong(value) {
+    return tenants.current.intlFormats.dateLong.format(value);
+}
+/**
+ * Format a `Date` as a `string` that just contains the time portion e.g. _5:31
+ * pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatTime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatTime(value) {
+    /*
+     * Time formatting for older iOS devices. Prevents date from repeating.
+     * Example: Last sync time: 24/11/2022 24/11/2022
+     */
+    if (typeof iosVersion === 'number' && iosVersion < 13.0) {
+        const time = tenants.current.intlFormats.olderIOSTime.formatToParts(value);
+        const newTime = time.map((t) => t.value).join('');
+        return `${newTime}`;
+    }
+    return tenants.current.intlFormats.time.format(value);
+}
+/**
+ * Format a `Date` as a `string` that contains the date and time portions e.g.
+ * _31/01/2020 5:31 pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDatetime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatDatetime(value) {
+    return `${formatDate(value)} ${formatTime(value)}`;
+}
+/**
+ * Format a `Date` as a `string` that contains the date and time portions in a
+ * long format e.g. _Thursday, 2 January 2020 5:31 pm_
+ *
+ * #### Example
+ *
+ * ```js
+ * const date = new Date()
+ * const text = localisationService.formatDatetime(date)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatDatetimeLong(value) {
+    return `${formatDateLong(value)} ${formatTime(value)}`;
+}
+/**
+ * Format a `number` as a `string` represented as a readable number e.g.
+ * _123,321.123_
+ *
+ * #### Example
+ *
+ * ```js
+ * const amount = 1234.4321
+ * const text = localisationService.formatCurrency(amount)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatNumber(value) {
+    return tenants.current.intlFormats.number.format(value);
+}
+/**
+ * Format a `number` as a `string` represented as a currency e.g. _$123.31_
+ *
+ * #### Example
+ *
+ * ```js
+ * const amount = 123.321
+ * const text = localisationService.formatCurrency(amount)
+ * // Display text
+ * ```
+ *
+ * @param value
+ * @returns
+ */
+export function formatCurrency(value) {
+    return tenants.current.intlFormats.currency.format(value);
+}
+/**
+ * Generate a `Date` based a `string` while adding/subtracting a number of days.
+ * Use this function to generate a date with the correct time if only the date
+ * part is required to be formatted for display purposes. Also supports passing
+ * `'NOW'` as the value to get the current date with an offset.
+ *
+ * #### Example
+ *
+ * ```js
+ * const dateOnly = localisationService.generateDate({
+ *   value: '2023-05-04',
+ *   dateOnly: true,
+ *   daysOffset: undefined,
+ * })
+ *
+ * const date = localisationService.generateDate({
+ *   value: '2023-05-04T02:49:23.616Z',
+ *   dateOnly: false,
+ *   daysOffset: undefined,
+ * })
+ *
+ * const now = localisationService.generateDate({
+ *   value: 'NOW',
+ *   dateOnly: false,
+ *   daysOffset: undefined,
+ * })
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export function generateDate({ daysOffset, value, }) {
+    if (value === 'NOW') {
+        const date = new Date();
+        if (daysOffset !== undefined) {
+            date.setDate(date.getDate() + daysOffset);
+        }
+        return date;
+    }
+    else {
+        let date = parse(value, 'yyyy-MM-dd', new Date());
+        if (Number.isNaN(date.getTime())) {
+            date = parse(value, "yyyy-MM-dd'T'HH:mm:ss.SSSX", new Date());
+            if (!Number.isNaN(date.getTime())) {
+                return generateDateOffset({ date, daysOffset });
+            }
+        }
+        else {
+            return generateDateOffset({ date, daysOffset });
+        }
+    }
+}
+function generateDateOffset({ date, daysOffset, }) {
+    if (daysOffset !== undefined) {
+        return add(date, { days: daysOffset });
+    }
+    return date;
+}
+export const replaceSubmissionFormatters = {
+    formatDate: (v) => {
+        const date = generateDate({
+            value: v,
+            daysOffset: undefined,
+        });
+        if (date) {
+            return formatDate(date);
+        }
+        return '';
+    },
+    formatDateTime: (value) => formatDatetime(new Date(value)),
+    formatTime: (value) => formatTime(new Date(value)),
+    formatCurrency: (value) => formatCurrency(value),
+    formatNumber: (value) => value.toString(),
+};
+/**
+ * Replace the `{ELEMENT:<elementName>}` values in text after a successful form
+ * submission as well as other replaceable parameters e.g. `submissionId`. The
+ * replacements are suppose to be user friendly and for display purposes, e.g.
+ * dates should be displayed in the user's desired format and timezone.
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
+export function replaceInjectablesWithSubmissionValues(text, options) {
+    return submissionService.replaceInjectablesWithSubmissionValues(text, {
+        ...options,
+        ...replaceSubmissionFormatters,
+    });
+}
+/**
+ * Replace the `{ELEMENT:<elementName>}` values in text while a form is being
+ * filled out. The replacements are suppose to be user friendly and for display
+ * purposes, e.g. dates should be displayed in the user's desired format and
+ * timezone.
+ *
+ * @param text
+ * @param options
+ * @returns
+ */
+export function replaceInjectablesWithElementValues(text, options) {
+    return submissionService.replaceInjectablesWithElementValues(text, {
+        ...options,
+        ...replaceSubmissionFormatters,
+    });
+}
+//# sourceMappingURL=localisation-service.js.map

package/dist/apps/localisation-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localisation-service.js","sourceRoot":"","sources":["../../src/apps/localisation-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,MAAM,MAAM,cAAc,CAAA;AACjC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAErC,IAAI,UAA8B,CAAA;AAClC,MAAM,eAAe,GAAmB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;AAC1E,IACE,eAAe,CAAC,EAAE,CAAC,IAAI,KAAK,KAAK;IACjC,OAAO,eAAe,CAAC,EAAE,CAAC,OAAO,KAAK,QAAQ,EAC9C,CAAC;IACD,UAAU,GAAG,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC,OAAO,CAAC,CAAA;IACnD,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7B,UAAU,GAAG,SAAS,CAAA;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,OAAO,CAAC,MAAM,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB;IAC9B,OAAO;QACL,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY;QAC1C,qBAAqB,EAAE,OAAO,CAAC,OAAO,CAAC,qBAAqB;KAC7D,CAAA;AACH,CAAC;AAED,SAAS,eAAe,CAAC,EACvB,IAAI,EACJ,SAAS,EACT,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,GAOjB;IACC,OAAO;QACL,IAAI;QACJ,SAAS;QACT,iBAAiB;QACjB,QAAQ;QACR,gBAAgB;QAChB,aAAa,EAAE,GAAG,SAAS,IAAI,IAAI,EAAE;QACrC,YAAY,EAAE,GAAG,QAAQ,IAAI,IAAI,EAAE;KACpC,CAAA;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,IAAI,GAAG,QAAQ,CAAA;IACrB,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;QACvB,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,eAAe,CAAC;gBACrB,IAAI;gBACJ,SAAS,EAAE,YAAY;gBACvB,iBAAiB,EAAE,OAAO;gBAC1B,QAAQ,EAAE,cAAc;gBACxB,gBAAgB,EAAE,QAAQ;aAC3B,CAAC,CAAA;QACJ,CAAC;QACD,KAAK,OAAO,CAAC;QACb,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,eAAe,CAAC;gBACrB,IAAI;gBACJ,SAAS,EAAE,YAAY;gBACvB,iBAAiB,EAAE,OAAO;gBAC1B,QAAQ,EAAE,cAAc;gBACxB,gBAAgB,EAAE,QAAQ;aAC3B,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,UAAU,CAAC,KAAW;IACpC,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAAC,KAAW;IACxC,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC3D,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,UAAU,CAAC,KAAW;IACpC;;;OAGG;IACH,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,GAAG,IAAI,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjD,OAAO,GAAG,OAAO,EAAE,CAAA;IACrB,CAAC;IACD,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACvD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAAC,KAAW;IACxC,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;AACpD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAW;IAC5C,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAA;AACxD,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACzD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC3D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,UAAU,EACV,KAAK,GAIN;IACC,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QACvB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAA;QAC3C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,CAAC;QACN,IAAI,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QACjD,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;YACjC,IAAI,GAAG,KAAK,CAAC,KAAK,EAAE,4BAA4B,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;YAC7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;gBAClC,OAAO,kBAAkB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,kBAAkB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;QACjD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,EAC1B,IAAI,EACJ,UAAU,GAIX;IACC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,CAAC,MAAM,2BAA2B,GACtC;IACE,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;QAChB,MAAM,IAAI,GAAG,YAAY,CAAC;YACxB,KAAK,EAAE,CAAC;YACR,UAAU,EAAE,SAAS;SACtB,CAAC,CAAA;QACF,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1D,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC;IAChD,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE;CAC1C,CAAA;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,sCAAsC,CACpD,IAAY,EACZ,OAKC;IAED,OAAO,iBAAiB,CAAC,sCAAsC,CAAC,IAAI,EAAE;QACpE,GAAG,OAAO;QACV,GAAG,2BAA2B;KAC/B,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,mCAAmC,CACjD,IAAY,EACZ,OAGC;IAED,OAAO,iBAAiB,CAAC,mCAAmC,CAAC,IAAI,EAAE;QACjE,GAAG,OAAO;QACV,GAAG,2BAA2B;KAC/B,CAAC,CAAA;AACJ,CAAC","sourcesContent":["import { submissionService } from '@oneblink/sdk-core'\nimport tenants from './tenants'\nimport parser from 'ua-parser-js'\nimport { add, parse } from 'date-fns'\n\nlet iosVersion: number | undefined\nconst parsedUserAgent: parser.IResult = parser(window.navigator.userAgent)\nif (\n  parsedUserAgent.os.name === 'iOS' &&\n  typeof parsedUserAgent.os.version === 'string'\n) {\n  iosVersion = parseFloat(parsedUserAgent.os.version)\n  if (Number.isNaN(iosVersion)) {\n    iosVersion = undefined\n  }\n}\n\n/**\n * Get the locale (e.g. `en-AU`) for the current tenant.\n *\n * #### Example\n *\n * ```js\n * const locale = localisationService.getLocale()\n * ```\n *\n * @returns\n */\nexport function getLocale() {\n  return tenants.locale\n}\n\n/**\n * Get the distance units (e.g. `feet` & 'ft) for the current tenant.\n *\n * #### Example\n *\n * ```js\n * const { distanceUnit, distanceUnitShortName } =\n *   localisationService.getDistanceUnits()\n * ```\n *\n * @returns\n */\nexport function getDistanceUnits() {\n  return {\n    distanceUnit: tenants.current.distanceUnit,\n    distanceUnitShortName: tenants.current.distanceUnitShortName,\n  }\n}\n\nfunction generateFormats({\n  time,\n  shortDate,\n  shortYearlessDate,\n  longDate,\n  longYearlessDate,\n}: {\n  time: string\n  shortDate: string\n  shortYearlessDate: string\n  longDate: string\n  longYearlessDate: string\n}) {\n  return {\n    time,\n    shortDate,\n    shortYearlessDate,\n    longDate,\n    longYearlessDate,\n    shortDateTime: `${shortDate} ${time}`,\n    longDateTime: `${longDate} ${time}`,\n  }\n}\n\nexport function getDateFnsFormats() {\n  const time = 'h:mm a'\n  switch (tenants.locale) {\n    case 'en-US': {\n      return generateFormats({\n        time,\n        shortDate: 'MM/dd/yyyy',\n        shortYearlessDate: 'MM/dd',\n        longDate: 'MMM do, yyyy',\n        longYearlessDate: 'MMM do',\n      })\n    }\n    case 'en-AU':\n    default: {\n      return generateFormats({\n        time,\n        shortDate: 'dd/MM/yyyy',\n        shortYearlessDate: 'dd/MM',\n        longDate: 'do MMM, yyyy',\n        longYearlessDate: 'do MMM',\n      })\n    }\n  }\n}\n\n/**\n * Format a `Date` as a `string` that just contains the date portion e.g.\n * _31/01/2020_\n *\n * #### Example\n *\n * ```js\n * const date = new Date()\n * const text = localisationService.formatDate(date)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatDate(value: Date): string {\n  return tenants.current.intlFormats.date.format(value)\n}\n\n/**\n * Format a `Date` as a `string` that just contains the date portion in a long\n * format e.g. _Thursday, 2 January 2020_\n *\n * #### Example\n *\n * ```js\n * const date = new Date()\n * const text = localisationService.formatDateLong(date)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatDateLong(value: Date): string {\n  return tenants.current.intlFormats.dateLong.format(value)\n}\n\n/**\n * Format a `Date` as a `string` that just contains the time portion e.g. _5:31\n * pm_\n *\n * #### Example\n *\n * ```js\n * const date = new Date()\n * const text = localisationService.formatTime(date)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatTime(value: Date): string {\n  /*\n   * Time formatting for older iOS devices. Prevents date from repeating.\n   * Example: Last sync time: 24/11/2022 24/11/2022\n   */\n  if (typeof iosVersion === 'number' && iosVersion < 13.0) {\n    const time = tenants.current.intlFormats.olderIOSTime.formatToParts(value)\n    const newTime = time.map((t) => t.value).join('')\n    return `${newTime}`\n  }\n  return tenants.current.intlFormats.time.format(value)\n}\n\n/**\n * Format a `Date` as a `string` that contains the date and time portions e.g.\n * _31/01/2020 5:31 pm_\n *\n * #### Example\n *\n * ```js\n * const date = new Date()\n * const text = localisationService.formatDatetime(date)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatDatetime(value: Date) {\n  return `${formatDate(value)} ${formatTime(value)}`\n}\n\n/**\n * Format a `Date` as a `string` that contains the date and time portions in a\n * long format e.g. _Thursday, 2 January 2020 5:31 pm_\n *\n * #### Example\n *\n * ```js\n * const date = new Date()\n * const text = localisationService.formatDatetime(date)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatDatetimeLong(value: Date) {\n  return `${formatDateLong(value)} ${formatTime(value)}`\n}\n\n/**\n * Format a `number` as a `string` represented as a readable number e.g.\n * _123,321.123_\n *\n * #### Example\n *\n * ```js\n * const amount = 1234.4321\n * const text = localisationService.formatCurrency(amount)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatNumber(value: number): string {\n  return tenants.current.intlFormats.number.format(value)\n}\n\n/**\n * Format a `number` as a `string` represented as a currency e.g. _$123.31_\n *\n * #### Example\n *\n * ```js\n * const amount = 123.321\n * const text = localisationService.formatCurrency(amount)\n * // Display text\n * ```\n *\n * @param value\n * @returns\n */\nexport function formatCurrency(value: number): string {\n  return tenants.current.intlFormats.currency.format(value)\n}\n\n/**\n * Generate a `Date` based a `string` while adding/subtracting a number of days.\n * Use this function to generate a date with the correct time if only the date\n * part is required to be formatted for display purposes. Also supports passing\n * `'NOW'` as the value to get the current date with an offset.\n *\n * #### Example\n *\n * ```js\n * const dateOnly = localisationService.generateDate({\n *   value: '2023-05-04',\n *   dateOnly: true,\n *   daysOffset: undefined,\n * })\n *\n * const date = localisationService.generateDate({\n *   value: '2023-05-04T02:49:23.616Z',\n *   dateOnly: false,\n *   daysOffset: undefined,\n * })\n *\n * const now = localisationService.generateDate({\n *   value: 'NOW',\n *   dateOnly: false,\n *   daysOffset: undefined,\n * })\n * ```\n *\n * @param options\n * @returns\n */\nexport function generateDate({\n  daysOffset,\n  value,\n}: {\n  daysOffset: number | undefined\n  value: string\n}): Date | undefined {\n  if (value === 'NOW') {\n    const date = new Date()\n    if (daysOffset !== undefined) {\n      date.setDate(date.getDate() + daysOffset)\n    }\n    return date\n  } else {\n    let date = parse(value, 'yyyy-MM-dd', new Date())\n    if (Number.isNaN(date.getTime())) {\n      date = parse(value, \"yyyy-MM-dd'T'HH:mm:ss.SSSX\", new Date())\n      if (!Number.isNaN(date.getTime())) {\n        return generateDateOffset({ date, daysOffset })\n      }\n    } else {\n      return generateDateOffset({ date, daysOffset })\n    }\n  }\n}\n\nfunction generateDateOffset({\n  date,\n  daysOffset,\n}: {\n  daysOffset: number | undefined\n  date: Date\n}) {\n  if (daysOffset !== undefined) {\n    return add(date, { days: daysOffset })\n  }\n  return date\n}\n\nexport const replaceSubmissionFormatters: submissionService.ReplaceInjectablesFormatters =\n  {\n    formatDate: (v) => {\n      const date = generateDate({\n        value: v,\n        daysOffset: undefined,\n      })\n      if (date) {\n        return formatDate(date)\n      }\n      return ''\n    },\n    formatDateTime: (value) => formatDatetime(new Date(value)),\n    formatTime: (value) => formatTime(new Date(value)),\n    formatCurrency: (value) => formatCurrency(value),\n    formatNumber: (value) => value.toString(),\n  }\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text after a successful form\n * submission as well as other replaceable parameters e.g. `submissionId`. The\n * replacements are suppose to be user friendly and for display purposes, e.g.\n * dates should be displayed in the user's desired format and timezone.\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithSubmissionValues(\n  text: string,\n  options: Omit<\n    Parameters<\n      typeof submissionService.replaceInjectablesWithSubmissionValues\n    >[1],\n    keyof submissionService.ReplaceInjectablesFormatters\n  >,\n): ReturnType<typeof submissionService.replaceInjectablesWithSubmissionValues> {\n  return submissionService.replaceInjectablesWithSubmissionValues(text, {\n    ...options,\n    ...replaceSubmissionFormatters,\n  })\n}\n\n/**\n * Replace the `{ELEMENT:<elementName>}` values in text while a form is being\n * filled out. The replacements are suppose to be user friendly and for display\n * purposes, e.g. dates should be displayed in the user's desired format and\n * timezone.\n *\n * @param text\n * @param options\n * @returns\n */\nexport function replaceInjectablesWithElementValues(\n  text: string,\n  options: Omit<\n    Parameters<typeof submissionService.replaceInjectablesWithElementValues>[1],\n    keyof submissionService.ReplaceInjectablesFormatters\n  >,\n): ReturnType<typeof submissionService.replaceInjectablesWithElementValues> {\n  return submissionService.replaceInjectablesWithElementValues(text, {\n    ...options,\n    ...replaceSubmissionFormatters,\n  })\n}\n"]}

package/dist/apps/notification-service.d.ts

@@ -0,0 +1,83 @@
+import { FormsAppsTypes } from '@oneblink/types';
+/**
+ * Check if the user is currently subscribed to notifications
+ *
+ * #### Example
+ *
+ * ```js
+ * const isSubscribed = await notificationService.isSubscribed()
+ * // Allow user to subscribe or unsubscribe
+ * ```
+ *
+ * @returns
+ */
+declare function isSubscribed(): Promise<boolean>;
+/**
+ * Subscribe the current user to notifications
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const isSubscribed = await notificationService.subscribe(formsAppId)
+ * // isSubscribed will be false if user denied permission to push notifications
+ * ```
+ *
+ * @param formsAppId
+ * @returns
+ */
+declare function subscribe(formsAppId: number): Promise<boolean>;
+/**
+ * Subscribe the current user to notifications
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * await notificationService.unsubscribe(formsAppId)
+ * // isSubscribed will be false if user denied permission to push notifications
+ * ```
+ *
+ * @param formsAppId
+ * @returns
+ */
+declare function unsubscribe(formsAppId: number): Promise<void>;
+/**
+ * Get the current users email subscriptions for a single forms app.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formsAppId = 1
+ * const emailSubscriptions =
+ *   await approvalsService.getEmailSubscriptions(formsAppId)
+ * ```
+ *
+ * @param formsAppId
+ * @param abortSignal
+ * @returns
+ */
+export declare function getEmailSubscriptions(formsAppId: number, abortSignal?: AbortSignal): Promise<FormsAppsTypes.FormsAppUserSubscription['emailSubscriptions']>;
+/**
+ * Update the current users email subscriptions for a single forms app.
+ *
+ * #### Example
+ *
+ * ```js
+ * const emailSubscriptions = {
+ *   newApproval: true,
+ *   clarificationReceived: true,
+ * }
+ * const savedFormsAppUserSubscription =
+ *   await approvalsService.updateFormsAppUserSubscription(
+ *     emailSubscriptions,
+ *   )
+ * ```
+ *
+ * @param formsAppId
+ * @param emailSubscriptions
+ * @param abortSignal
+ * @returns
+ */
+export declare function updateEmailSubscriptions(formsAppId: number, emailSubscriptions: FormsAppsTypes.FormsAppUserSubscription['emailSubscriptions'], abortSignal?: AbortSignal): Promise<void>;
+export { isSubscribed, subscribe, unsubscribe };