@nascentdigital/funnel-services 4.4.18

package/dist/identity/client/IdentityContainer.js

@@ -0,0 +1,23 @@
+'use client';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityContainer = IdentityContainer;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const IdentityContext_1 = require("./IdentityContext");
+const ClientProfile_1 = require("./ClientProfile");
+// component
+function IdentityContainer({ brand, identity, profileData, onSetProfileData, children }) {
+    // bind context
+    const context = (0, react_1.useMemo)(() => {
+        // empty context if there is no identity
+        if (!identity) {
+            return {};
+        }
+        // create client profile
+        const profile = new ClientProfile_1.ClientProfile(Object.assign(Object.assign({}, identity), { brand, data: profileData, onSetProfileData }));
+        return { identity, profile };
+    }, [brand, identity, profileData, onSetProfileData]);
+    // render
+    return ((0, jsx_runtime_1.jsx)(IdentityContext_1.IdentityContext.Provider, { value: context, children: children }));
+}

package/dist/identity/client/IdentityContext.d.ts

@@ -0,0 +1,8 @@
+import { Identity, Profile } from '../api';
+export declare const IdentityContext: import("react").Context<IdentityContext.Type>;
+export declare namespace IdentityContext {
+    type Type = {
+        identity?: Identity | null;
+        profile?: Profile | null;
+    };
+}

package/dist/identity/client/IdentityContext.js

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

package/dist/identity/client/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IdentityContainer';
+export * from './useIdentity';
+export * from './useProfile';

package/dist/identity/client/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("./IdentityContainer"), exports);
+__exportStar(require("./useIdentity"), exports);
+__exportStar(require("./useProfile"), exports);

package/dist/identity/client/useIdentity.d.ts

@@ -0,0 +1,2 @@
+import { Identity } from '../api';
+export declare function useIdentity(): Identity | null | undefined;

package/dist/identity/client/useIdentity.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIdentity = useIdentity;
+const react_1 = require("react");
+const IdentityContext_1 = require("./IdentityContext");
+// hook
+function useIdentity() {
+    return (0, react_1.useContext)(IdentityContext_1.IdentityContext).identity;
+}

package/dist/identity/client/useProfile.d.ts

@@ -0,0 +1,2 @@
+import { Profile } from '../api';
+export declare function useProfile(): Profile | null | undefined;

package/dist/identity/client/useProfile.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useProfile = useProfile;
+const react_1 = require("react");
+const IdentityContext_1 = require("./IdentityContext");
+// hook
+function useProfile() {
+    return (0, react_1.useContext)(IdentityContext_1.IdentityContext).profile;
+}

package/dist/identity/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './auth0';
+export * from './server';

package/dist/identity/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("./api"), exports);
+__exportStar(require("./auth0"), exports);
+__exportStar(require("./server"), exports);

package/dist/identity/server/IdentityProvider.d.ts

@@ -0,0 +1,5 @@
+import { PropsWithChildren } from 'react';
+export declare function IdentityProvider({ children }: IdentityProvider.Props): Promise<string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<import("react").ReactNode> | null | undefined>;
+export declare namespace IdentityProvider {
+    type Props = PropsWithChildren;
+}

package/dist/identity/server/IdentityProvider.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityProvider = IdentityProvider;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const actions_1 = require("../actions");
+const api_1 = require("../api");
+const IdentityContainer_1 = require("../client/IdentityContainer");
+// container
+async function IdentityProvider({ children }) {
+    // get brand and services
+    const brand = funnel_core_1.AppConfig.brand();
+    const identityService = api_1.IdentityService.tryGet();
+    const profileService = api_1.ProfileService.tryGet();
+    // enable identity if set
+    if (identityService || profileService) {
+        // TODO: remove after testing
+        // await new Promise(resolve => setTimeout(resolve, 2000))
+        // try to get identity and profile
+        // const identity = await identityService?.current()
+        // const profile = await profileService?.current()
+        // render
+        return ((0, jsx_runtime_1.jsx)(IdentityContainer_1.IdentityContainer, { brand: brand, onSetProfileData: actions_1.IdentityActions.setProfileData, children: children }));
+    }
+    // or disable
+    else {
+        return children;
+    }
+}

package/dist/identity/server/index.d.ts

@@ -0,0 +1 @@
+export * from './IdentityProvider';

package/dist/identity/server/index.js

@@ -0,0 +1,17 @@
+"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("./IdentityProvider"), exports);

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './analytics';
+export * from './captcha/RecaptchaAdapter';
+export * from './consent';
+export * from './identity/client';
+export * from './ip';

package/dist/index.js

@@ -0,0 +1,21 @@
+"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("./analytics"), exports);
+__exportStar(require("./captcha/RecaptchaAdapter"), exports);
+__exportStar(require("./consent"), exports);
+__exportStar(require("./identity/client"), exports);
+__exportStar(require("./ip"), exports);

package/dist/ip/index.d.ts

@@ -0,0 +1 @@
+export * from './useIpAddress';

package/dist/ip/index.js

@@ -0,0 +1,17 @@
+"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("./useIpAddress"), exports);

package/dist/ip/useIpAddress.d.ts

@@ -0,0 +1 @@
+export declare function useIpAddress(): string | null | undefined;

package/dist/ip/useIpAddress.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIpAddress = useIpAddress;
+const react_1 = require("react");
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+// hooks
+function useIpAddress() {
+    // bind state
+    const ipResolver = SharedIpResolver.instance;
+    const [ip, setIp] = (0, react_1.useState)(ipResolver.ip);
+    // fetch address
+    (0, react_1.useEffect)(() => {
+        // bind ip
+        let cancelled = false;
+        ipResolver.getIp().then(ip => {
+            // update if not cancelled
+            if (!cancelled) {
+                setIp(ip);
+            }
+        });
+        // cancel on unmount
+        return () => {
+            cancelled = true;
+        };
+    }, [ipResolver]);
+    // return ip
+    return ip;
+}
+// helper
+class SharedIpResolver {
+    static get instance() {
+        // create if required
+        if (!SharedIpResolver._instance) {
+            SharedIpResolver._instance = new SharedIpResolver();
+        }
+        // throw if we don't have the instance
+        const instance = SharedIpResolver._instance;
+        if (!instance) {
+            throw new funnel_core_1.IllegalStateError('Unable to instantiate SharedIpResolver');
+        }
+        // return instance
+        return instance;
+    }
+    get ip() {
+        return this._ip;
+    }
+    getIp() {
+        // create promise if it isn't started
+        let ipPromise = this._ipPromise;
+        if (!ipPromise) {
+            ipPromise = this.fetchIp();
+            this._ipPromise = ipPromise;
+        }
+        // return promise
+        return ipPromise;
+    }
+    async fetchIp() {
+        // fetch ip
+        const response = await fetch('https://api.ipify.org');
+        // extract ip address
+        const ip = response.ok
+            ? await response.text()
+            : null;
+        // update locally
+        this._ip = ip;
+        // and return it
+        return ip;
+    }
+}

package/dist/leadgen/AbstractPipeDriveAdapter.d.ts

@@ -0,0 +1,27 @@
+import { Contact, IHumanVerification, ILeadGen } from '@nascentdigital/funnel-core';
+import { PipedriveClient } from './PipedriveClient';
+export declare abstract class AbstractPipeDriveAdapter<TUserData extends Contact.UserData = Contact.UserData, TTags extends Contact.Tags = Contact.Tags, TResponse extends PipedriveClient.CaptureContactResponse = PipedriveClient.CaptureContactResponse> implements ILeadGen {
+    protected readonly pipeDrive: PipedriveClient;
+    private readonly _apiKey;
+    private readonly _humanVerification;
+    private readonly _ownerId;
+    protected constructor(args: AbstractPipeDriveAdapter.ConstructorArgs);
+    captureEmail(args: any): Promise<void>;
+    captureContact({ contact, verificationToken }: AbstractPipeDriveAdapter.CaptureContactArgs<TUserData, TTags>): Promise<PipedriveClient.CaptureContactResponse>;
+    captureLead(args: any): Promise<void>;
+    protected abstract getCustomFields(contact: Contact<TUserData, TTags>): AbstractPipeDriveAdapter.CustomFields;
+    protected abstract getLabelIds(contact: Contact<TUserData, TTags>): AbstractPipeDriveAdapter.LabelIds;
+}
+export declare namespace AbstractPipeDriveAdapter {
+    type ConstructorArgs = {
+        apiKey: string;
+        humanVerification: IHumanVerification;
+        ownerId?: number;
+    };
+    type CaptureContactArgs<TUserData extends Contact.UserData = Contact.UserData, TTags extends Contact.Tags = Contact.Tags> = {
+        contact: Contact<TUserData, TTags>;
+        verificationToken: string;
+    };
+    type CustomFields = Record<string, string>;
+    type LabelIds = number[];
+}

package/dist/leadgen/AbstractPipeDriveAdapter.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractPipeDriveAdapter = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const PipedriveClient_1 = require("./PipedriveClient");
+class AbstractPipeDriveAdapter {
+    constructor(args) {
+        // initialize instance variables
+        this._apiKey = args.apiKey;
+        this._humanVerification = args.humanVerification;
+        this._ownerId = args.ownerId;
+        this.pipeDrive = new PipedriveClient_1.PipedriveClient({ apiKey: this._apiKey });
+    }
+    async captureEmail(args) {
+        throw new Error('Method not implemented.');
+    }
+    async captureContact({ contact, verificationToken }) {
+        // verify will throw if users is not human
+        await this._humanVerification.verify({ verificationToken });
+        // map contact phones to person phones
+        const phones = [];
+        if (contact.phone) {
+            phones.push({
+                value: funnel_core_1.Contact.Phone.isSingle(contact.phone) ? contact.phone : contact.phone.primary,
+                primary: true
+            });
+        }
+        // capture basic data
+        const data = {
+            email: contact.email,
+            label_ids: this.getLabelIds(contact),
+            phones,
+            customData: this.getCustomFields(contact),
+            ownerId: this._ownerId
+        };
+        // submit data to Pipedrive
+        return this.pipeDrive.upsertPerson(data);
+    }
+    async captureLead(args) {
+        throw new Error('Method not implemented.');
+    }
+}
+exports.AbstractPipeDriveAdapter = AbstractPipeDriveAdapter;

package/dist/leadgen/ConfigPipeDriveAdapter.d.ts

@@ -0,0 +1,18 @@
+import { Contact, IHumanVerification } from '@nascentdigital/funnel-core';
+import { AbstractPipeDriveAdapter } from './AbstractPipeDriveAdapter';
+export declare class ConfigPipeDriveAdapter<TCustomData extends Record<string, string> = Record<string, string>, TCustomTags extends Record<string, number> = Record<string, number>> extends AbstractPipeDriveAdapter<TCustomData> {
+    private readonly _customFields;
+    private readonly _labelIds;
+    constructor(args: ConfigPipeDriveAdapter.ConstructorArgs<TCustomData, TCustomTags>);
+    protected getCustomFields({ userData, name }: Contact): AbstractPipeDriveAdapter.CustomFields;
+    protected getLabelIds({ tags }: Contact): AbstractPipeDriveAdapter.LabelIds;
+}
+export declare namespace ConfigPipeDriveAdapter {
+    type ConstructorArgs<TCustomData extends Record<string, string> = Record<string, string>, TCustomTags extends Record<string, number> = Record<string, number>> = {
+        customFields: TCustomData;
+        labelIds: TCustomTags;
+        apiKey: string;
+        humanVerification: IHumanVerification;
+        ownerId?: number;
+    };
+}

package/dist/leadgen/ConfigPipeDriveAdapter.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigPipeDriveAdapter = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+const AbstractPipeDriveAdapter_1 = require("./AbstractPipeDriveAdapter");
+class ConfigPipeDriveAdapter extends AbstractPipeDriveAdapter_1.AbstractPipeDriveAdapter {
+    constructor(args) {
+        // construct base
+        super(args);
+        // initialize instance variables
+        this._customFields = args.customFields;
+        this._labelIds = args.labelIds;
+    }
+    getCustomFields({ userData, name }) {
+        // bind custom fields based on config
+        const customFields = {};
+        const { _customFields } = this;
+        Object.entries(userData !== null && userData !== void 0 ? userData : {}).forEach(([fieldId, value]) => {
+            // skip if we don't have a mapping for this field
+            if (!(fieldId in _customFields)) {
+                console.warn(`[TestLeadGen] no mapping for custom field "${fieldId}"`);
+                return;
+            }
+            // map the field to the data
+            customFields[_customFields[fieldId]] = value;
+        });
+        // merge known fields with custom fields and return
+        if (funnel_core_1.Contact.Name.isSplit(name)) {
+            return {
+                'custom_fields': customFields,
+                'first_name': name.firstName,
+                'last_name': name.lastName,
+            };
+        }
+        else {
+            const [first, ...last] = name.split(' ');
+            return {
+                'custom_fields': customFields,
+                'first_name': first,
+                'last_name': last.join(' '),
+            };
+        }
+    }
+    getLabelIds({ tags }) {
+        // for each contact tag get mapped label id
+        const labelIds = [];
+        tags === null || tags === void 0 ? void 0 : tags.forEach(tag => {
+            // skip if we don;t have mapping for tag
+            if (!this._labelIds[tag]) {
+                console.warn(`[TestLeadGen] no mapping for tag "${tag}"`);
+                return;
+            }
+            // added mapped label id
+            labelIds.push(this._labelIds[tag]);
+        });
+        // return valid label ids
+        return labelIds;
+    }
+}
+exports.ConfigPipeDriveAdapter = ConfigPipeDriveAdapter;

package/dist/leadgen/MockPipedrive.d.ts

@@ -0,0 +1,16 @@
+import { IHumanVerification, ILeadGen } from '@nascentdigital/funnel-core';
+export declare class MockPipedrive implements ILeadGen {
+    private readonly _apiKey;
+    private readonly _humanVerification;
+    constructor({ apiKey, humanVerification }: MockPipedrive.ConstructorArgs);
+    captureEmail(email: string): Promise<void>;
+    captureContact({ contact }: ILeadGen.CaptureContactArgs): Promise<{}>;
+    captureLead(args: any): Promise<void>;
+    private logArgs;
+}
+export declare namespace MockPipedrive {
+    type ConstructorArgs = {
+        apiKey: string;
+        humanVerification: IHumanVerification;
+    };
+}

package/dist/leadgen/MockPipedrive.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockPipedrive = void 0;
+const funnel_core_1 = require("@nascentdigital/funnel-core");
+// class
+class MockPipedrive {
+    constructor({ apiKey, humanVerification }) {
+        // initialize instance variables
+        this._apiKey = apiKey;
+        this._humanVerification = humanVerification;
+    }
+    async captureEmail(email) {
+        this.logArgs('[MockPipedrive] capture email', email);
+        await this._humanVerification.verify({ verificationToken: '' });
+        return Promise.resolve();
+    }
+    captureContact({ contact }) {
+        this.logArgs('[MockPipedrive] capture contact', contact);
+        return Promise.resolve({});
+    }
+    captureLead(args) {
+        throw new funnel_core_1.NotImplementedError();
+    }
+    logArgs(message, args) {
+        let stringArgs = '';
+        if (args) {
+            stringArgs = JSON.stringify(args);
+        }
+        console.log(message, stringArgs);
+    }
+}
+exports.MockPipedrive = MockPipedrive;

package/dist/leadgen/PipedriveClient.d.ts

@@ -0,0 +1,40 @@
+import { RequiredBy } from '@nascentdigital/funnel-core';
+export declare class PipedriveClient {
+    private readonly _apiKey;
+    private readonly _marketingStatusEnabled;
+    constructor({ apiKey, marketingStatusEnabled }: PipedriveClient.ConstructorArgs);
+    upsertPerson(data: RequiredBy<Partial<PipedriveClient.Person>, 'email'>): Promise<PipedriveClient.CaptureContactResponse>;
+    captureNote(personId: number, content: string): Promise<void>;
+    captureOrganization(personId: number, organizationName: string): Promise<void>;
+    private send;
+}
+export declare namespace PipedriveClient {
+    type ConstructorArgs = {
+        apiKey: string;
+        marketingStatusEnabled?: boolean;
+    };
+    type Person = {
+        email: string;
+        phones: ReadonlyArray<Phone>;
+        marketingStatus?: MarketingStatus;
+        label_ids: number[];
+        customData: {
+            [key: string]: string;
+        };
+        ownerId?: number;
+    };
+    type MarketingStatus = 'no_consent' | 'subscribed' | 'unsubscribed' | 'archived';
+    type Phone = {
+        value: string;
+        primary: boolean;
+    };
+    type CaptureContactResponse = {
+        success: boolean;
+        data: {
+            id: number;
+            first_name: string;
+            last_name: string;
+            owner_id: string;
+        };
+    };
+}