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

package/dist/apps/notification-service.js

@@ -0,0 +1,315 @@
+import OneBlinkAppsError from './services/errors/oneBlinkAppsError';
+import { createNotificationsSubscription, deleteNotificationsSubscription, } from './services/api/notifications';
+import { isOffline } from './offline-service';
+import tenants from './tenants';
+import Sentry from './Sentry';
+import { getRequest, putRequest } from './services/fetch';
+function urlB64ToUint8Array(base64String) {
+    const padding = '='.repeat((4 - (base64String.length % 4)) % 4);
+    const base64 = (base64String + padding)
+        // eslint-disable-next-line no-useless-escape
+        .replace(/\-/g, '+')
+        .replace(/_/g, '/');
+    const rawData = window.atob(base64);
+    const outputArray = new Uint8Array(rawData.length);
+    for (let i = 0; i < rawData.length; ++i) {
+        outputArray[i] = rawData.charCodeAt(i);
+    }
+    return outputArray;
+}
+let applicationServerKey = null;
+let _isInitialised = false;
+let _swRegistration = null;
+async function getServiceWorkerRegistration() {
+    if (_isInitialised) {
+        return _swRegistration;
+    }
+    applicationServerKey = urlB64ToUint8Array(tenants.current.vapidPublicKey);
+    if ('serviceWorker' in navigator && navigator.serviceWorker) {
+        try {
+            _swRegistration = await navigator.serviceWorker.ready;
+            console.log('Service Worker is registered', _swRegistration);
+        }
+        catch (error) {
+            Sentry.captureException(error);
+            console.error('Notifications Service init error', error);
+        }
+    }
+    _isInitialised = true;
+    return _swRegistration;
+}
+/**
+ * Check if the user is currently subscribed to notifications
+ *
+ * #### Example
+ *
+ * ```js
+ * const isSubscribed = await notificationService.isSubscribed()
+ * // Allow user to subscribe or unsubscribe
+ * ```
+ *
+ * @returns
+ */
+async function isSubscribed() {
+    const swRegistration = await getServiceWorkerRegistration();
+    if (!swRegistration) {
+        return false;
+    }
+    const subscription = await swRegistration.pushManager.getSubscription();
+    return !!subscription;
+}
+/**
+ * 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
+ */
+async function subscribe(formsAppId) {
+    if (isOffline()) {
+        throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again.', {
+            isOffline: true,
+        });
+    }
+    const swRegistration = await getServiceWorkerRegistration();
+    if (!swRegistration) {
+        return false;
+    }
+    if (!('Notification' in window) ||
+        !swRegistration.pushManager ||
+        !swRegistration.pushManager.subscribe) {
+        throw new OneBlinkAppsError('Sorry, push notifications are not support for your device.', {
+            title: 'Unsupported Device',
+        });
+    }
+    try {
+        const key = applicationServerKey;
+        if (!key) {
+            throw new Error('Notifications have not been configured for your application.');
+        }
+        const permission = await Notification.requestPermission();
+        // If the user accepts, create subscription
+        if (permission !== 'granted') {
+            throw new OneBlinkAppsError('It looks like you may have denied this app permission to send you push notifications. Please grant this app the notifications permission and try again.', {
+                title: 'Permission Required',
+            });
+        }
+        console.log('User has granted notifications permission');
+        const subscription = await swRegistration.pushManager.subscribe({
+            userVisibleOnly: true,
+            applicationServerKey: key,
+        });
+        console.log('Subscribed to Service Worker Push:', subscription);
+        try {
+            await createNotificationsSubscription(formsAppId, subscription);
+        }
+        catch (error) {
+            await subscription.unsubscribe();
+            throw error;
+        }
+        console.log('Successfully subscribed to push notifications');
+        return true;
+    }
+    catch (error) {
+        console.warn('Failed to subscribe the user:', error);
+        if (Notification.permission === 'denied') {
+            console.warn('Permission for notifications was denied');
+            throw new OneBlinkAppsError('It looks like you may have denied this app permission to send you push notifications. Please grant this app the notifications permission and try again.', {
+                title: 'Permission Required',
+                originalError: error,
+            });
+        }
+        if (error instanceof OneBlinkAppsError) {
+            throw error;
+        }
+        Sentry.captureException(error);
+        throw new OneBlinkAppsError('We were unable to subscribe you to push notifications, please try again and contact support if the problem persists.', {
+            title: 'Permission Required',
+            originalError: error,
+        });
+    }
+}
+/**
+ * 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
+ */
+async function unsubscribe(formsAppId) {
+    if (isOffline()) {
+        throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again.', {
+            isOffline: true,
+        });
+    }
+    const swRegistration = await getServiceWorkerRegistration();
+    if (!swRegistration) {
+        return;
+    }
+    console.log('Checking for subscription to unsubscribe');
+    try {
+        const subscription = await swRegistration.pushManager.getSubscription();
+        if (!subscription) {
+            console.log('No subscription');
+            return;
+        }
+        await subscription.unsubscribe();
+        console.log('Unsubscribed from Service Worker Push subscription', subscription);
+        await deleteNotificationsSubscription(formsAppId, subscription).catch((error) => {
+            Sentry.captureException(error);
+            // Ignore this error as the server should remove
+            // this subscription the next time it tries to use it.
+            console.warn('Could not delete subscription on server', error);
+        });
+    }
+    catch (error) {
+        Sentry.captureException(error);
+        console.warn('Failed to unsubscribe the user:', error);
+        throw new OneBlinkAppsError('We were unable to unsubscribe you from push notifications, please try again and contact support if the problem persists.', {
+            originalError: error,
+        });
+    }
+}
+/**
+ * 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 async function getEmailSubscriptions(formsAppId, abortSignal) {
+    try {
+        const { emailSubscriptions } = await getRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-preferences`, abortSignal);
+        return emailSubscriptions;
+    }
+    catch (err) {
+        console.error('Error retrieving preferences for current user', err);
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot access your email subscriptions without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+/**
+ * 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 async function updateEmailSubscriptions(formsAppId, emailSubscriptions, abortSignal) {
+    try {
+        await putRequest(`${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-preferences`, { emailSubscriptions }, abortSignal);
+    }
+    catch (err) {
+        console.error('Error retrieving preferences for current user', err);
+        Sentry.captureException(err);
+        const error = err;
+        if (isOffline()) {
+            throw new OneBlinkAppsError('You are currently offline, please connect to the internet and try again', {
+                originalError: error,
+                isOffline: true,
+            });
+        }
+        switch (error.status) {
+            case 401: {
+                throw new OneBlinkAppsError('You cannot update your email subscriptions without first logging in. Please login and try again.', {
+                    originalError: error,
+                    requiresLogin: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 403: {
+                throw new OneBlinkAppsError('You do not have access to this application. Please contact your administrator to gain the correct level of access.', {
+                    originalError: error,
+                    requiresAccessRequest: true,
+                    httpStatusCode: error.status,
+                });
+            }
+            case 400:
+            case 404: {
+                throw new OneBlinkAppsError(error.message, {
+                    title: 'Invalid Request',
+                    httpStatusCode: error.status,
+                });
+            }
+            default: {
+                throw new OneBlinkAppsError('An unknown error has occurred. Please contact support if the problem persists.', {
+                    originalError: error,
+                    httpStatusCode: error.status,
+                });
+            }
+        }
+    }
+}
+export { isSubscribed, subscribe, unsubscribe };
+//# sourceMappingURL=notification-service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification-service.js","sourceRoot":"","sources":["../../src/apps/notification-service.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,qCAAqC,CAAA;AACnE,OAAO,EACL,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,OAAO,MAAM,WAAW,CAAA;AAC/B,OAAO,MAAM,MAAM,UAAU,CAAA;AAE7B,OAAO,EAAE,UAAU,EAAa,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAEpE,SAAS,kBAAkB,CAAC,YAAoB;IAC9C,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;IAC/D,MAAM,MAAM,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;QACrC,6CAA6C;SAC5C,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IAErB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACnC,MAAM,WAAW,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAElD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACxC,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IACD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,IAAI,oBAAoB,GAAsB,IAAI,CAAA;AAClD,IAAI,cAAc,GAAG,KAAK,CAAA;AAC1B,IAAI,eAAe,GAAqC,IAAI,CAAA;AAE5D,KAAK,UAAU,4BAA4B;IACzC,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,oBAAoB,GAAG,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;IAEzE,IAAI,eAAe,IAAI,SAAS,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;QAC5D,IAAI,CAAC;YACH,eAAe,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,KAAK,CAAA;YACrD,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE,eAAe,CAAC,CAAA;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAA;QAC1D,CAAC;IACH,CAAC;IAED,cAAc,GAAG,IAAI,CAAA;IACrB,OAAO,eAAe,CAAA;AACxB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,YAAY;IACzB,MAAM,cAAc,GAAG,MAAM,4BAA4B,EAAE,CAAA;IAC3D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,eAAe,EAAE,CAAA;IACvE,OAAO,CAAC,CAAC,YAAY,CAAA;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,SAAS,CAAC,UAAkB;IACzC,IAAI,SAAS,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,iBAAiB,CACzB,0EAA0E,EAC1E;YACE,SAAS,EAAE,IAAI;SAChB,CACF,CAAA;IACH,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,4BAA4B,EAAE,CAAA;IAC3D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IACE,CAAC,CAAC,cAAc,IAAI,MAAM,CAAC;QAC3B,CAAC,cAAc,CAAC,WAAW;QAC3B,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,EACrC,CAAC;QACD,MAAM,IAAI,iBAAiB,CACzB,4DAA4D,EAC5D;YACE,KAAK,EAAE,oBAAoB;SAC5B,CACF,CAAA;IACH,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,oBAAoB,CAAA;QAChC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAA;QACH,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAA;QACzD,2CAA2C;QAC3C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,IAAI,iBAAiB,CACzB,yJAAyJ,EACzJ;gBACE,KAAK,EAAE,qBAAqB;aAC7B,CACF,CAAA;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;QAExD,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC;YAC9D,eAAe,EAAE,IAAI;YACrB,oBAAoB,EAAE,GAAmB;SAC1C,CAAC,CAAA;QACF,OAAO,CAAC,GAAG,CAAC,oCAAoC,EAAE,YAAY,CAAC,CAAA;QAC/D,IAAI,CAAC;YACH,MAAM,+BAA+B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;QACjE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,CAAC,WAAW,EAAE,CAAA;YAChC,MAAM,KAAK,CAAA;QACb,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAA;QAC5D,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAA;QAEpD,IAAI,YAAY,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAA;YACvD,MAAM,IAAI,iBAAiB,CACzB,yJAAyJ,EACzJ;gBACE,KAAK,EAAE,qBAAqB;gBAC5B,aAAa,EAAE,KAAc;aAC9B,CACF,CAAA;QACH,CAAC;QAED,IAAI,KAAK,YAAY,iBAAiB,EAAE,CAAC;YACvC,MAAM,KAAK,CAAA;QACb,CAAC;QAED,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAE9B,MAAM,IAAI,iBAAiB,CACzB,sHAAsH,EACtH;YACE,KAAK,EAAE,qBAAqB;YAC5B,aAAa,EAAE,KAAc;SAC9B,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,KAAK,UAAU,WAAW,CAAC,UAAkB;IAC3C,IAAI,SAAS,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,iBAAiB,CACzB,0EAA0E,EAC1E;YACE,SAAS,EAAE,IAAI;SAChB,CACF,CAAA;IACH,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,4BAA4B,EAAE,CAAA;IAC3D,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAM;IACR,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;IACvD,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,eAAe,EAAE,CAAA;QACvE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;YAC9B,OAAM;QACR,CAAC;QAED,MAAM,YAAY,CAAC,WAAW,EAAE,CAAA;QAChC,OAAO,CAAC,GAAG,CACT,oDAAoD,EACpD,YAAY,CACb,CAAA;QAED,MAAM,+BAA+B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,KAAK,CACnE,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;YAC9B,gDAAgD;YAChD,sDAAsD;YACtD,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAA;QAChE,CAAC,CACF,CAAA;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAC9B,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAA;QACtD,MAAM,IAAI,iBAAiB,CACzB,0HAA0H,EAC1H;YACE,aAAa,EAAE,KAAc;SAC9B,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,UAAkB,EAClB,WAAyB;IAEzB,IAAI,CAAC;QACH,MAAM,EAAE,kBAAkB,EAAE,GAC1B,MAAM,UAAU,CACd,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iBAAiB,EACtE,WAAW,CACZ,CAAA;QACH,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAA;QACnE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,yEAAyE,EACzE;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,kGAAkG,EAClG;oBACE,aAAa,EAAE,KAAK;oBACpB,aAAa,EAAE,IAAI;oBACnB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,oHAAoH,EACpH;oBACE,aAAa,EAAE,KAAK;oBACpB,qBAAqB,EAAE,IAAI;oBAC3B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;oBACzC,KAAK,EAAE,iBAAiB;oBACxB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,UAAkB,EAClB,kBAAiF,EACjF,WAAyB;IAEzB,IAAI,CAAC;QACH,MAAM,UAAU,CACd,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,eAAe,UAAU,iBAAiB,EACtE,EAAE,kBAAkB,EAAE,EACtB,WAAW,CACZ,CAAA;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAA;QACnE,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;QAE5B,MAAM,KAAK,GAAG,GAAgB,CAAA;QAC9B,IAAI,SAAS,EAAE,EAAE,CAAC;YAChB,MAAM,IAAI,iBAAiB,CACzB,yEAAyE,EACzE;gBACE,aAAa,EAAE,KAAK;gBACpB,SAAS,EAAE,IAAI;aAChB,CACF,CAAA;QACH,CAAC;QACD,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,kGAAkG,EAClG;oBACE,aAAa,EAAE,KAAK;oBACpB,aAAa,EAAE,IAAI;oBACnB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CACzB,oHAAoH,EACpH;oBACE,aAAa,EAAE,KAAK;oBACpB,qBAAqB,EAAE,IAAI;oBAC3B,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;YACD,KAAK,GAAG,CAAC;YACT,KAAK,GAAG,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,iBAAiB,CAAC,KAAK,CAAC,OAAO,EAAE;oBACzC,KAAK,EAAE,iBAAiB;oBACxB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CAAC,CAAA;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,iBAAiB,CACzB,gFAAgF,EAChF;oBACE,aAAa,EAAE,KAAK;oBACpB,cAAc,EAAE,KAAK,CAAC,MAAM;iBAC7B,CACF,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,CAAA","sourcesContent":["import OneBlinkAppsError from './services/errors/oneBlinkAppsError'\nimport {\n  createNotificationsSubscription,\n  deleteNotificationsSubscription,\n} from './services/api/notifications'\nimport { isOffline } from './offline-service'\nimport tenants from './tenants'\nimport Sentry from './Sentry'\nimport { FormsAppsTypes } from '@oneblink/types'\nimport { getRequest, HTTPError, putRequest } from './services/fetch'\n\nfunction urlB64ToUint8Array(base64String: string) {\n  const padding = '='.repeat((4 - (base64String.length % 4)) % 4)\n  const base64 = (base64String + padding)\n    // eslint-disable-next-line no-useless-escape\n    .replace(/\\-/g, '+')\n    .replace(/_/g, '/')\n\n  const rawData = window.atob(base64)\n  const outputArray = new Uint8Array(rawData.length)\n\n  for (let i = 0; i < rawData.length; ++i) {\n    outputArray[i] = rawData.charCodeAt(i)\n  }\n  return outputArray\n}\n\nlet applicationServerKey: null | Uint8Array = null\nlet _isInitialised = false\nlet _swRegistration: null | ServiceWorkerRegistration = null\n\nasync function getServiceWorkerRegistration(): Promise<ServiceWorkerRegistration | null> {\n  if (_isInitialised) {\n    return _swRegistration\n  }\n\n  applicationServerKey = urlB64ToUint8Array(tenants.current.vapidPublicKey)\n\n  if ('serviceWorker' in navigator && navigator.serviceWorker) {\n    try {\n      _swRegistration = await navigator.serviceWorker.ready\n      console.log('Service Worker is registered', _swRegistration)\n    } catch (error) {\n      Sentry.captureException(error)\n      console.error('Notifications Service init error', error)\n    }\n  }\n\n  _isInitialised = true\n  return _swRegistration\n}\n\n/**\n * Check if the user is currently subscribed to notifications\n *\n * #### Example\n *\n * ```js\n * const isSubscribed = await notificationService.isSubscribed()\n * // Allow user to subscribe or unsubscribe\n * ```\n *\n * @returns\n */\nasync function isSubscribed(): Promise<boolean> {\n  const swRegistration = await getServiceWorkerRegistration()\n  if (!swRegistration) {\n    return false\n  }\n\n  const subscription = await swRegistration.pushManager.getSubscription()\n  return !!subscription\n}\n\n/**\n * Subscribe the current user to notifications\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const isSubscribed = await notificationService.subscribe(formsAppId)\n * // isSubscribed will be false if user denied permission to push notifications\n * ```\n *\n * @param formsAppId\n * @returns\n */\nasync function subscribe(formsAppId: number): Promise<boolean> {\n  if (isOffline()) {\n    throw new OneBlinkAppsError(\n      'You are currently offline, please connect to the internet and try again.',\n      {\n        isOffline: true,\n      },\n    )\n  }\n\n  const swRegistration = await getServiceWorkerRegistration()\n  if (!swRegistration) {\n    return false\n  }\n\n  if (\n    !('Notification' in window) ||\n    !swRegistration.pushManager ||\n    !swRegistration.pushManager.subscribe\n  ) {\n    throw new OneBlinkAppsError(\n      'Sorry, push notifications are not support for your device.',\n      {\n        title: 'Unsupported Device',\n      },\n    )\n  }\n\n  try {\n    const key = applicationServerKey\n    if (!key) {\n      throw new Error(\n        'Notifications have not been configured for your application.',\n      )\n    }\n\n    const permission = await Notification.requestPermission()\n    // If the user accepts, create subscription\n    if (permission !== 'granted') {\n      throw new OneBlinkAppsError(\n        'It looks like you may have denied this app permission to send you push notifications. Please grant this app the notifications permission and try again.',\n        {\n          title: 'Permission Required',\n        },\n      )\n    }\n\n    console.log('User has granted notifications permission')\n\n    const subscription = await swRegistration.pushManager.subscribe({\n      userVisibleOnly: true,\n      applicationServerKey: key as BufferSource,\n    })\n    console.log('Subscribed to Service Worker Push:', subscription)\n    try {\n      await createNotificationsSubscription(formsAppId, subscription)\n    } catch (error) {\n      await subscription.unsubscribe()\n      throw error\n    }\n    console.log('Successfully subscribed to push notifications')\n    return true\n  } catch (error) {\n    console.warn('Failed to subscribe the user:', error)\n\n    if (Notification.permission === 'denied') {\n      console.warn('Permission for notifications was denied')\n      throw new OneBlinkAppsError(\n        'It looks like you may have denied this app permission to send you push notifications. Please grant this app the notifications permission and try again.',\n        {\n          title: 'Permission Required',\n          originalError: error as Error,\n        },\n      )\n    }\n\n    if (error instanceof OneBlinkAppsError) {\n      throw error\n    }\n\n    Sentry.captureException(error)\n\n    throw new OneBlinkAppsError(\n      'We were unable to subscribe you to push notifications, please try again and contact support if the problem persists.',\n      {\n        title: 'Permission Required',\n        originalError: error as Error,\n      },\n    )\n  }\n}\n\n/**\n * Subscribe the current user to notifications\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * await notificationService.unsubscribe(formsAppId)\n * // isSubscribed will be false if user denied permission to push notifications\n * ```\n *\n * @param formsAppId\n * @returns\n */\nasync function unsubscribe(formsAppId: number): Promise<void> {\n  if (isOffline()) {\n    throw new OneBlinkAppsError(\n      'You are currently offline, please connect to the internet and try again.',\n      {\n        isOffline: true,\n      },\n    )\n  }\n\n  const swRegistration = await getServiceWorkerRegistration()\n  if (!swRegistration) {\n    return\n  }\n\n  console.log('Checking for subscription to unsubscribe')\n  try {\n    const subscription = await swRegistration.pushManager.getSubscription()\n    if (!subscription) {\n      console.log('No subscription')\n      return\n    }\n\n    await subscription.unsubscribe()\n    console.log(\n      'Unsubscribed from Service Worker Push subscription',\n      subscription,\n    )\n\n    await deleteNotificationsSubscription(formsAppId, subscription).catch(\n      (error) => {\n        Sentry.captureException(error)\n        // Ignore this error as the server should remove\n        // this subscription the next time it tries to use it.\n        console.warn('Could not delete subscription on server', error)\n      },\n    )\n  } catch (error) {\n    Sentry.captureException(error)\n    console.warn('Failed to unsubscribe the user:', error)\n    throw new OneBlinkAppsError(\n      'We were unable to unsubscribe you from push notifications, please try again and contact support if the problem persists.',\n      {\n        originalError: error as Error,\n      },\n    )\n  }\n}\n\n/**\n * Get the current users email subscriptions for a single forms app.\n *\n * #### Example\n *\n * ```js\n * const formsAppId = 1\n * const emailSubscriptions =\n *   await approvalsService.getEmailSubscriptions(formsAppId)\n * ```\n *\n * @param formsAppId\n * @param abortSignal\n * @returns\n */\nexport async function getEmailSubscriptions(\n  formsAppId: number,\n  abortSignal?: AbortSignal,\n): Promise<FormsAppsTypes.FormsAppUserSubscription['emailSubscriptions']> {\n  try {\n    const { emailSubscriptions } =\n      await getRequest<FormsAppsTypes.FormsAppUserSubscription>(\n        `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-preferences`,\n        abortSignal,\n      )\n    return emailSubscriptions\n  } catch (err) {\n    console.error('Error retrieving preferences for current user', err)\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 401: {\n        throw new OneBlinkAppsError(\n          'You cannot access your email subscriptions without first logging in. Please login and try again.',\n          {\n            originalError: error,\n            requiresLogin: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 403: {\n        throw new OneBlinkAppsError(\n          'You do not have access to this application. Please contact your administrator to gain the correct level of access.',\n          {\n            originalError: error,\n            requiresAccessRequest: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(error.message, {\n          title: 'Invalid Request',\n          httpStatusCode: error.status,\n        })\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n\n/**\n * Update the current users email subscriptions for a single forms app.\n *\n * #### Example\n *\n * ```js\n * const emailSubscriptions = {\n *   newApproval: true,\n *   clarificationReceived: true,\n * }\n * const savedFormsAppUserSubscription =\n *   await approvalsService.updateFormsAppUserSubscription(\n *     emailSubscriptions,\n *   )\n * ```\n *\n * @param formsAppId\n * @param emailSubscriptions\n * @param abortSignal\n * @returns\n */\nexport async function updateEmailSubscriptions(\n  formsAppId: number,\n  emailSubscriptions: FormsAppsTypes.FormsAppUserSubscription['emailSubscriptions'],\n  abortSignal?: AbortSignal,\n): Promise<void> {\n  try {\n    await putRequest<FormsAppsTypes.FormsAppUserSubscription>(\n      `${tenants.current.apiOrigin}/forms-apps/${formsAppId}/my-preferences`,\n      { emailSubscriptions },\n      abortSignal,\n    )\n  } catch (err) {\n    console.error('Error retrieving preferences for current user', err)\n    Sentry.captureException(err)\n\n    const error = err as HTTPError\n    if (isOffline()) {\n      throw new OneBlinkAppsError(\n        'You are currently offline, please connect to the internet and try again',\n        {\n          originalError: error,\n          isOffline: true,\n        },\n      )\n    }\n    switch (error.status) {\n      case 401: {\n        throw new OneBlinkAppsError(\n          'You cannot update your email subscriptions without first logging in. Please login and try again.',\n          {\n            originalError: error,\n            requiresLogin: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 403: {\n        throw new OneBlinkAppsError(\n          'You do not have access to this application. Please contact your administrator to gain the correct level of access.',\n          {\n            originalError: error,\n            requiresAccessRequest: true,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n      case 400:\n      case 404: {\n        throw new OneBlinkAppsError(error.message, {\n          title: 'Invalid Request',\n          httpStatusCode: error.status,\n        })\n      }\n      default: {\n        throw new OneBlinkAppsError(\n          'An unknown error has occurred. Please contact support if the problem persists.',\n          {\n            originalError: error,\n            httpStatusCode: error.status,\n          },\n        )\n      }\n    }\n  }\n}\n\nexport { isSubscribed, subscribe, unsubscribe }\n"]}

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

@@ -0,0 +1,18 @@
+declare global {
+    interface Window {
+        cordova: unknown;
+    }
+}
+/**
+ * Check if the user is currently offline
+ *
+ * #### Example
+ *
+ * ```js
+ * const isOffline = offlineService.isOffline()
+ * // handle user being offline
+ * ```
+ *
+ * @returns
+ */
+export declare function isOffline(): boolean;

package/dist/apps/offline-service.js

@@ -0,0 +1,25 @@
+/**
+ * Check if the user is currently offline
+ *
+ * #### Example
+ *
+ * ```js
+ * const isOffline = offlineService.isOffline()
+ * // handle user being offline
+ * ```
+ *
+ * @returns
+ */
+export function isOffline() {
+    if (!window.navigator) {
+        return false;
+    }
+    if (window.cordova) {
+        // @ts-expect-error
+        return window.navigator.connection.type === 'none';
+    }
+    else {
+        return !window.navigator.onLine;
+    }
+}
+//# sourceMappingURL=offline-service.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"offline-service.js","sourceRoot":"","sources":["../../src/apps/offline-service.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,SAAS;IACvB,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,mBAAmB;QACnB,OAAO,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,MAAM,CAAA;IACpD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAA;IACjC,CAAC;AACH,CAAC","sourcesContent":["declare global {\n  interface Window {\n    cordova: unknown\n  }\n}\n\n/**\n * Check if the user is currently offline\n *\n * #### Example\n *\n * ```js\n * const isOffline = offlineService.isOffline()\n * // handle user being offline\n * ```\n *\n * @returns\n */\nexport function isOffline(): boolean {\n  if (!window.navigator) {\n    return false\n  }\n\n  if (window.cordova) {\n    // @ts-expect-error\n    return window.navigator.connection.type === 'none'\n  } else {\n    return !window.navigator.onLine\n  }\n}\n"]}

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

@@ -0,0 +1,110 @@
+import { SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
+import { FormSubmission, FormSubmissionResult } from './types/submissions';
+import { HandlePaymentResult, PaymentReceiptItem } from './types/payments';
+import * as westpacQuickStream from './services/payment-providers/WestpacQuickStreamPaymentProvider';
+export { HandlePaymentResult, PaymentReceiptItem, westpacQuickStream };
+/**
+ * Pass in query string parameters after a redirect back to your app after a
+ * payment is processed. This function will handle all payment submission events
+ * supported by OneBlink. Will return a Transaction and the submission result
+ * that was returned from `handlePaymentSubmissionEvent()` before redirecting to
+ * `payment.hostedFormUrl`.
+ *
+ * #### Example
+ *
+ * ```js
+ * import queryString from 'query-string'
+ *
+ * const query = queryString.parse(window.location.search)
+ * const { transaction, submissionResult } =
+ *   await paymentService.handlePaymentQuerystring(query)
+ * ```
+ *
+ * @param query
+ * @returns
+ */
+export declare function handlePaymentQuerystring(query: Record<string, unknown>): Promise<HandlePaymentResult>;
+export declare function checkForPaymentSubmissionEvent(formSubmission: FormSubmission): {
+    paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
+    amount: number;
+} | undefined;
+/**
+ * Handle a submission result with a payment submission event. Will throw an
+ * error if a transaction has already been made using this submission result.
+ * Will return `undefined` if the submission does not have an amount. Will
+ * return the submission result passed in with a `payment` property if the
+ * submission requires processing.
+ *
+ * #### Example
+ *
+ * ```js
+ * const formSubmissionResult = {
+ *   submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',
+ *   submissionTimestamp: '2020-07-29T01:03:26.573Z'
+ *   formsAppId: 1,
+ *   submission: {
+ *     form: 'data',
+ *     goes: 'here',
+ *     amount: 1.50,
+ *   }
+ *   definition: OneBlinkForm,
+ *   payment: null,
+ * }
+ * const paymentSubmissionEvent = {
+ *   type: 'CP_PAY',
+ *   configuration: {
+ *     elementId: '12663efc-4c6a-4e72-8505-559edfe3e92e',
+ *     gatewayId: '6658c5c4-e0db-483b-8af7-6a6464fe772c',
+ *   },
+ * }
+ * const paymentReceiptUrl = `${window.location.origin}/payment-receipt`
+ * const paymentSubmissionResult = await paymentService.handlePaymentSubmissionEvent({
+ *   formSubmissionResult,
+ *   paymentSubmissionEvent,
+ *   paymentReceiptUrl,
+ * })
+ * if (paymentSubmissionResult) {
+ *   window.location.href = paymentSubmissionResult.payment.hostedFormUrl
+ * }
+ * ```
+ *
+ * @param options
+ * @returns
+ */
+export declare function handlePaymentSubmissionEvent({ amount, formSubmissionResult, paymentSubmissionEvent, paymentReceiptUrl, paymentFormUrl, }: {
+    amount: number;
+    formSubmissionResult: FormSubmissionResult;
+    paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
+    paymentReceiptUrl: string;
+    paymentFormUrl: string | undefined;
+}): Promise<FormSubmissionResult['payment']>;
+export declare function getFormSubmissionResultPayment(): Promise<{
+    formSubmissionResult: FormSubmissionResult;
+    paymentSubmissionEvent: SubmissionEventTypes.FormPaymentEvent;
+}>;
+/**
+ * Retrieve an array of detail items from a form submission payment.
+ *
+ * #### Example
+ *
+ * ```js
+ * const detailItems =
+ *   paymentService.getDisplayDetailsFromFormSubmissionPayment(
+ *     formSubmissionPayment,
+ *   )
+ * ```
+ *
+ * @param formSubmissionPayment
+ * @returns
+ */
+export declare function getDisplayDetailsFromFormSubmissionPayment(formSubmissionPayment: SubmissionTypes.FormSubmissionPayment): {
+    amount: {
+        value: number;
+        formatted: string;
+    };
+    paymentDisplayDetails: {
+        label: string;
+        value: string;
+        key: SubmissionEventTypes.PaymentDisplayDetailKey;
+    }[];
+} | undefined;