@nascentdigital/funnel-apps 4.4.18

package/dist/react/profile/web/WebProfileStore.d.ts

@@ -0,0 +1,8 @@
+import { ProfileStore } from '../domain';
+export declare class WebProfileStore<TData extends ProfileStore.Data = ProfileStore.Data> extends ProfileStore<TData> {
+    constructor(args: WebProfileStore.ConstructorArgs<TData>);
+    save(): Promise<void>;
+}
+export declare namespace WebProfileStore {
+    type ConstructorArgs<TData extends ProfileStore.Data> = ProfileStore.ConstructorArgs<TData>;
+}

package/dist/react/profile/web/WebProfileStore.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebProfileStore = void 0;
+const web_1 = require("../../app/web");
+const domain_1 = require("../../identity/domain");
+const domain_2 = require("../domain");
+// class
+class WebProfileStore extends domain_2.ProfileStore {
+    constructor(args) {
+        // construct base
+        super(args);
+    }
+    async save() {
+        // get props
+        const { identity } = this;
+        const changes = this.exportChanges();
+        // push update
+        const update = await web_1.AppServiceClient.post({
+            apiToken: identity instanceof domain_1.AuthenticatedIdentity
+                ? identity.apiToken
+                : undefined,
+            id: '_nd-profile',
+            method: 'store.update',
+            data: JSON.parse(JSON.stringify(changes))
+        });
+        // reset to latest
+        this.reset(update);
+        // raise event
+        this.raiseEvent('saved');
+    }
+}
+exports.WebProfileStore = WebProfileStore;

package/dist/react/profile/web/index.d.ts

@@ -0,0 +1,3 @@
+export * from '../domain';
+export * from '../core';
+export * from './WebProfileProvider';

package/dist/react/profile/web/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../domain"), exports);
+__exportStar(require("../core"), exports);
+__exportStar(require("./WebProfileProvider"), exports);

package/dist/react/push/domain/PushAppRequest.d.ts

@@ -0,0 +1,13 @@
+import { Jsonify } from 'type-fest';
+import type { AppService } from '../../app/domain';
+export type PushAppRequest = PushAppRequest.SubscribeWeb | PushAppRequest.SubscribeExpo | PushAppRequest.Unsubscribe;
+export declare namespace PushAppRequest {
+    const appId: "_nd-push";
+    type AppId = typeof appId;
+    type SubscribeWeb = AppService.Request<AppId, typeof SubscribeWebMethod, Jsonify<PushSubscriptionJSON>>;
+    const SubscribeWebMethod: "subscribe.web";
+    type SubscribeExpo = AppService.Request<AppId, typeof SubscribeExpoMethod, string>;
+    const SubscribeExpoMethod: "subscribe.expo";
+    type Unsubscribe = AppService.Request<AppId, typeof UnsubscribeMethod, null>;
+    const UnsubscribeMethod: "unsubscribe";
+}

package/dist/react/push/domain/PushAppRequest.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushAppRequest = void 0;
+// extension
+var PushAppRequest;
+(function (PushAppRequest) {
+    // app id
+    PushAppRequest.appId = '_nd-push';
+    PushAppRequest.SubscribeWebMethod = 'subscribe.web';
+    PushAppRequest.SubscribeExpoMethod = 'subscribe.expo';
+    PushAppRequest.UnsubscribeMethod = 'unsubscribe';
+})(PushAppRequest || (exports.PushAppRequest = PushAppRequest = {}));

package/dist/react/push/domain/PushStore.d.ts

@@ -0,0 +1,7 @@
+export interface PushStore {
+    webPushTokens: PushSubscriptionJSON[];
+    expoPushTokens: string[];
+}
+export declare namespace PushStore {
+    const id: "_nd-push";
+}

package/dist/react/push/domain/PushStore.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushStore = void 0;
+// extension
+var PushStore;
+(function (PushStore) {
+    // id
+    PushStore.id = '_nd-push';
+})(PushStore || (exports.PushStore = PushStore = {}));

package/dist/react/push/domain/index.d.ts

@@ -0,0 +1,2 @@
+export * from './PushAppRequest';
+export * from './PushStore';

package/dist/react/push/domain/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./PushAppRequest"), exports);
+__exportStar(require("./PushStore"), exports);

package/dist/react/push/server/PushService.d.ts

@@ -0,0 +1,22 @@
+import { JsonValue } from 'type-fest';
+import { AbstractAppService } from '../../app/server';
+import { Identity } from '../../identity/domain';
+import { PushAppRequest } from '../domain';
+export declare class PushService extends AbstractAppService<PushAppRequest> {
+    private readonly mailto;
+    private readonly vapIdKey;
+    private readonly vapIdSecret;
+    constructor(args: PushService.ConstructorArgs);
+    onExecute(request: PushAppRequest, identity?: Identity): Promise<JsonValue>;
+    private onSubscribeWeb;
+    private onSubscribeExpo;
+    private onUnsubscribe;
+}
+export declare namespace PushService {
+    const subscriptionKey = "push_subId";
+    type ConstructorArgs = {
+        mailto: string;
+        vapIdKey: string;
+        vapIdSecret: string;
+    };
+}

package/dist/react/push/server/PushService.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushService = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const server_1 = require("../../app/server");
+const domain_1 = require("../../identity/domain");
+// service
+class PushService extends server_1.AbstractAppService {
+    constructor(args) {
+        // construct base
+        super({
+            id: '_nd-push',
+            name: 'Push Service'
+        });
+        // initialize instance variables
+        this.mailto = args.mailto;
+        this.vapIdKey = args.vapIdKey;
+        this.vapIdSecret = args.vapIdSecret;
+    }
+    async onExecute(request, identity) {
+        // throw if not authenticated
+        if (!(identity instanceof domain_1.AuthenticatedIdentity)) {
+            throw new funnel_core_1.NotAuthenticatedError();
+        }
+        // handle subscribe
+        switch (request.method) {
+            case 'subscribe.web':
+                return this.onSubscribeWeb(identity, request);
+            case 'subscribe.expo':
+                return this.onSubscribeExpo(identity, request);
+            case 'unsubscribe':
+                return this.onUnsubscribe(identity);
+            default:
+                throw new funnel_core_1.InvalidOperationError(`Unrecognized PushService request`);
+        }
+    }
+    async onSubscribeWeb(identity, { data }) {
+        console.debug(`[PushService/onSubscribe] registering push for "${identity.id}"`, data);
+        // TODO: set subscription
+        return true;
+    }
+    async onSubscribeExpo(identity, { data }) {
+        console.debug(`[PushService/onSubscribeNative] registering push for "${identity.id}"`, data);
+        return true;
+    }
+    async onUnsubscribe(identity) {
+        console.debug(`[PushService/onUnsubscribe] unregistering push for "${identity.id}"`);
+        // TODO: delete subscription
+        return true;
+    }
+}
+exports.PushService = PushService;
+// extension
+(function (PushService) {
+    // constants
+    PushService.subscriptionKey = 'push_subId';
+})(PushService || (exports.PushService = PushService = {}));

package/dist/react/push/server/index.d.ts

@@ -0,0 +1,3 @@
+import 'server-only';
+export * from '../domain';
+export * from './PushService';

package/dist/react/push/server/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("server-only");
+__exportStar(require("../domain"), exports);
+__exportStar(require("./PushService"), exports);

package/dist/react/push/server/keygen.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/react/push/server/keygen.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const web_push_1 = __importDefault(require("web-push"));
+// generate a keypair
+console.debug('[Push/keygen] generated web-push keys', web_push_1.default.generateVAPIDKeys());

package/dist/react/push/web/PushClient.d.ts

@@ -0,0 +1,35 @@
+import { Observable } from 'rxjs';
+export declare class PushClient implements PushClient.Type {
+    readonly vapIdKey: string;
+    private readonly _state$;
+    private readonly _subscription$;
+    constructor({ vapIdKey }: PushClient.Args);
+    get state$(): Observable<PushClient.State>;
+    get state(): PushClient.State;
+    private set state(value);
+    get subscription$(): Observable<PushSubscription | null | undefined>;
+    get subscription(): PushSubscription | null | undefined;
+    private set subscription(value);
+    private isBlocked;
+    initialize(): Promise<void>;
+    subscribe(): Promise<void>;
+    unsubscribe(): Promise<void>;
+    toJSON(): {
+        class: string;
+        vapIdKey: string;
+    };
+}
+export declare namespace PushClient {
+    type Args = {
+        vapIdKey: string;
+    };
+    interface Type {
+        readonly state$: Observable<State>;
+        readonly state: State;
+        readonly subscription$: Observable<PushSubscription | null | undefined>;
+        readonly subscription: PushSubscription | null | undefined;
+        subscribe(): Promise<void>;
+        unsubscribe(): Promise<void>;
+    }
+    type State = 'uninitialized' | 'initializing' | 'ready' | 'updating' | 'error.unsupported' | 'error.blocked' | 'error.initialize';
+}

package/dist/react/push/web/PushClient.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushClient = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const rxjs_1 = require("rxjs");
+const AppServiceClient_1 = require("../../app/domain/AppServiceClient");
+// client
+class PushClient {
+    constructor({ vapIdKey }) {
+        // initialize instance variables
+        this.vapIdKey = vapIdKey;
+        this._state$ = new rxjs_1.BehaviorSubject('uninitialized');
+        this._subscription$ = new rxjs_1.BehaviorSubject(undefined);
+    }
+    get state$() {
+        return this._state$.asObservable();
+    }
+    get state() {
+        return this._state$.getValue();
+    }
+    set state(state) {
+        // update only if changed
+        if (state !== this.state) {
+            this._state$.next(state);
+        }
+    }
+    get subscription$() {
+        return this._subscription$.asObservable();
+    }
+    get subscription() {
+        return this._subscription$.getValue();
+    }
+    set subscription(subscription) {
+        this._subscription$.next(subscription);
+    }
+    async isBlocked() {
+        if (!funnel_core_1.Browser.available) {
+            return true;
+        }
+        // use permissions query (best case)
+        if ('permissions' in navigator) {
+            try {
+                const query = await navigator.permissions.query({ name: 'push', userVisibleOnly: true });
+                return query.state === 'denied';
+            }
+            catch (e) {
+                return Notification.permission === 'denied';
+            }
+        }
+        // or fallback
+        else {
+            return Notification.permission === 'denied';
+        }
+    }
+    async initialize() {
+        // ignore if not uninitialized
+        if (this.state !== 'uninitialized') {
+            console.warn('[PushClient] ignoring redundant initialize()');
+            return;
+        }
+        // mark unsupported if not available in browser
+        if (!funnel_core_1.Browser.available || !('serviceWorker' in navigator) || !('PushManager' in window)) {
+            this.state = 'error.unsupported';
+            return;
+        }
+        // try to initialize
+        try {
+            // mark initializing
+            this.state = 'initializing';
+            // register service worker
+            const registration = await navigator.serviceWorker
+                .register('/push.js', { scope: '/', updateViaCache: 'none' });
+            console.debug(`[PushClient] registered service worker with "${registration.scope}" scope`);
+            // stop if blocked
+            const blocked = await this.isBlocked();
+            if (blocked) {
+                this.state = 'error.blocked';
+                return;
+            }
+            // bind subscription
+            this.subscription = await registration.pushManager.getSubscription();
+            // mark initialized
+            this.state = 'ready';
+        }
+        // handle error
+        catch (e) {
+            // mark error
+            this.state = 'error.initialize';
+            // rethrow
+            throw e;
+        }
+    }
+    async subscribe() {
+        // fail if not ready
+        if (this.state !== 'ready') {
+            throw new funnel_core_1.InvalidOperationError('Cannot subscribe() before being "ready"');
+        }
+        // ignore if already subscribed
+        else if (this.subscription) {
+            console.warn('[PushClient] ignoring redundant subscribe()');
+            return;
+        }
+        // try to subscribe
+        let subscription = undefined;
+        try {
+            // update state
+            this.state = 'updating';
+            // get registration (in-case we're waiting)
+            const registration = await navigator.serviceWorker.ready;
+            // subscribe locally
+            subscription = await registration.pushManager.subscribe({
+                userVisibleOnly: true,
+                applicationServerKey: urlBase64ToUint8Array(this.vapIdKey)
+            });
+            // persist the subscription
+            await AppServiceClient_1.AppServiceClient.post({
+                id: '_nd-push',
+                method: 'subscribe.web',
+                data: subscription
+            });
+            // update subscription
+            this.subscription = subscription;
+        }
+        // forward errors
+        catch (e) {
+            // TODO: handle isometric (server) errors
+            // or something unexpected
+            console.error('[PushClient] failed to subscribe()', e);
+            // clear subscription (if any)
+            subscription === null || subscription === void 0 ? void 0 : subscription.unsubscribe();
+        }
+        // mark ready
+        finally {
+            // handle blocked status
+            const blocked = await this.isBlocked();
+            if (blocked) {
+                this.state = 'error.blocked';
+            }
+            else {
+                this.state = 'ready';
+            }
+        }
+    }
+    async unsubscribe() {
+        // fail if not ready
+        if (this.state !== 'ready') {
+            throw new funnel_core_1.InvalidOperationError('Cannot unsubscribe() before being "ready"');
+        }
+        // ignore if already subscribed
+        const { subscription } = this;
+        if (!subscription) {
+            console.warn('[PushClient] ignoring redundant unsubscribe()');
+            return;
+        }
+        // clear subscription
+        try {
+            // mark updating
+            this.state = 'updating';
+            // clear the subscription
+            await AppServiceClient_1.AppServiceClient.post({
+                id: '_nd-push',
+                method: 'unsubscribe',
+                data: null
+            });
+            // clear push
+            await subscription.unsubscribe();
+            this.subscription = undefined;
+        }
+        // handle error
+        catch (e) {
+            console.error('[PushClient] failed to unsubscribe()', e);
+            // rethrow
+            throw e;
+        }
+        // mark ready
+        finally {
+            this.state = 'ready';
+        }
+    }
+    toJSON() {
+        const { constructor: { name }, vapIdKey } = this;
+        return {
+            class: name,
+            vapIdKey
+        };
+    }
+}
+exports.PushClient = PushClient;
+// helpers
+function urlBase64ToUint8Array(base64Raw) {
+    // sanitize string
+    const padding = '='.repeat((4 - (base64Raw.length % 4)) % 4);
+    const base64 = (base64Raw + padding)
+        .replace(/-/g, '+')
+        .replace(/_/g, '/');
+    // convert to array
+    const rawData = window.atob(base64);
+    const array = new Uint8Array(rawData.length);
+    for (let i = 0; i < rawData.length; ++i) {
+        array[i] = rawData.charCodeAt(i);
+    }
+    // and return it
+    return array;
+}

package/dist/react/push/web/PushContext.d.ts

@@ -0,0 +1,7 @@
+import { PushClient } from './PushClient';
+export declare const PushContext: import("react").Context<PushContext.Data>;
+export declare namespace PushContext {
+    type Data = {
+        client?: PushClient;
+    };
+}

package/dist/react/push/web/PushContext.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushContext = void 0;
+const react_1 = require("react");
+// context
+exports.PushContext = (0, react_1.createContext)({});

package/dist/react/push/web/PushProvider.d.ts

@@ -0,0 +1,6 @@
+import { PropsWithChildren } from 'react';
+export declare function PushProvider({ children }: PushProvider.Props): import("react/jsx-runtime").JSX.Element;
+export declare namespace PushProvider {
+    type Props = PropsWithChildren;
+    function setVapIdKey(vapIdKey: string): void;
+}

package/dist/react/push/web/PushProvider.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushProvider = PushProvider;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const web_1 = require("../../bridge/web");
+const PushClient_1 = require("./PushClient");
+const PushContext_1 = require("./PushContext");
+// container
+function PushProvider({ children }) {
+    // bind context
+    const context = (0, react_1.useMemo)(() => ({ client: _vapIdKey ? new PushClient_1.PushClient({ vapIdKey: _vapIdKey }) : undefined }), []);
+    const { client } = context;
+    const { isNative } = (0, web_1.useBridge)();
+    // initialize push client on mount
+    (0, react_1.useEffect)(() => {
+        // skip if there's no client
+        if (!client) {
+            console.debug('[PushProvider] no web PushClient configured');
+            return;
+        }
+        // or if native
+        else if (isNative) {
+            console.debug('[PushProvider] skipping web PushClient initialization');
+            return;
+        }
+        // initialize client
+        client.initialize()
+            .catch(console.error);
+    }, [client, isNative]);
+    // render
+    return ((0, jsx_runtime_1.jsx)(PushContext_1.PushContext.Provider, { value: context, children: children }));
+}
+// extension
+(function (PushProvider) {
+    function setVapIdKey(vapIdKey) {
+        _vapIdKey = vapIdKey;
+    }
+    PushProvider.setVapIdKey = setVapIdKey;
+})(PushProvider || (exports.PushProvider = PushProvider = {}));
+// storage
+let _vapIdKey = undefined;

package/dist/react/push/web/index.d.ts

@@ -0,0 +1,4 @@
+export * from '../domain';
+export * from './PushClient';
+export * from './PushProvider';
+export * from './usePushClient';

package/dist/react/push/web/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../domain"), exports);
+__exportStar(require("./PushClient"), exports);
+__exportStar(require("./PushProvider"), exports);
+__exportStar(require("./usePushClient"), exports);

package/dist/react/push/web/usePushClient.d.ts

@@ -0,0 +1,3 @@
+import { PushClient } from './PushClient';
+export declare function usePossiblePushClient(): PushClient.Type | undefined;
+export declare function usePushClient(): PushClient.Type;

package/dist/react/push/web/usePushClient.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePossiblePushClient = usePossiblePushClient;
+exports.usePushClient = usePushClient;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const client_1 = require("@nascentdigital/funnel-ui/client");
+const react_1 = require("react");
+const PushContext_1 = require("./PushContext");
+// hook
+function usePossiblePushClient() {
+    // bind memos + hooks
+    const { client } = (0, react_1.useContext)(PushContext_1.PushContext);
+    const touch = (0, client_1.useTouch)();
+    // bind worker
+    (0, react_1.useEffect)(() => {
+        // skip if there's no client
+        if (!client) {
+            return;
+        }
+        // bind client
+        const subscriptions = [
+            client.state$.subscribe(() => touch()),
+            client.subscription$.subscribe(() => touch())
+        ];
+        // clear subscription on unmount
+        return () => subscriptions.forEach(subscription => subscription.unsubscribe());
+    }, [client, touch]);
+    console.debug('[usePossiblePushClient] client:', client);
+    // return client
+    return client;
+}
+function usePushClient() {
+    // bind client (throw if not bound)
+    const client = usePossiblePushClient();
+    if (!client) {
+        throw new funnel_core_1.InvalidOperationError('Cannot access usePushClient() outside of PushProvider scope');
+    }
+    // return client
+    return client;
+}

package/dist/react/server.d.ts

@@ -0,0 +1,7 @@
+export * from './app/server';
+export * from './auth0/server';
+export * from './content/server';
+export * from './identity/server';
+export * from './nav/server';
+export * from './profile/server';
+export * from './push/server';