@segment/analytics-browser-actions-intercom 1.0.0 → 1.3.0

package/dist/cjs/sharedCompanyProperties.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCompanyProperties = void 0;
+const getCompanyProperties = () => ({
+    company_id: {
+        description: 'The unique identifier of the company.',
+        label: 'Company ID',
+        type: 'string',
+        required: true
+    },
+    name: {
+        description: 'The name of the company.',
+        label: 'Company Name',
+        type: 'string',
+        required: true
+    },
+    created_at: {
+        description: 'The time the company was created in your system.',
+        label: 'Company Creation Time',
+        type: 'datetime',
+        required: false
+    },
+    plan: {
+        description: 'The name of the plan you have associated with the company.',
+        label: 'Company Plan',
+        type: 'string',
+        required: false
+    },
+    monthly_spend: {
+        description: 'The monthly spend of the company, e.g. how much revenue the company generates for your business.',
+        label: 'Monthly Spend',
+        type: 'integer',
+        required: false
+    },
+    size: {
+        description: 'The number of employees in the company.',
+        label: 'Company Size',
+        type: 'integer',
+        required: false
+    },
+    website: {
+        description: 'The URL for the company website.',
+        label: 'Company Website',
+        type: 'string',
+        required: false
+    },
+    industry: {
+        description: 'The industry that the company operates in.',
+        label: 'Industry',
+        type: 'string',
+        required: false
+    },
+    company_custom_traits: {
+        description: 'The custom attributes for the company object.',
+        label: 'Company Custom Attributes',
+        type: 'object',
+        required: false,
+        defaultObjectUI: 'keyvalue'
+    }
+});
+exports.getCompanyProperties = getCompanyProperties;
+//# sourceMappingURL=sharedCompanyProperties.js.map

package/dist/cjs/sharedCompanyProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedCompanyProperties.js","sourceRoot":"","sources":["../../src/sharedCompanyProperties.ts"],"names":[],"mappings":";;;AAEO,MAAM,oBAAoB,GAAG,GAA+B,EAAE,CAAC,CAAC;IACrE,UAAU,EAAE;QACV,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACf;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;KACf;IACD,UAAU,EAAE;QACV,WAAW,EAAE,kDAAkD;QAC/D,KAAK,EAAE,uBAAuB;QAC9B,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,4DAA4D;QACzE,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;KAChB;IACD,aAAa,EAAE;QACb,WAAW,EAAE,kGAAkG;QAC/G,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,KAAK;KAChB;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,yCAAyC;QACtD,KAAK,EAAE,cAAc;QACrB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,KAAK;KAChB;IACD,OAAO,EAAE;QACP,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;KAChB;IACD,QAAQ,EAAE;QACR,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;KAChB;IACD,qBAAqB,EAAE;QACrB,WAAW,EAAE,+CAA+C;QAC5D,KAAK,EAAE,2BAA2B;QAClC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,KAAK;QACf,eAAe,EAAE,UAAU;KAC5B;CACF,CAAC,CAAA;AAxDW,QAAA,oBAAoB,wBAwD/B"}

package/dist/cjs/trackEvent/generated-types.d.ts

@@ -0,0 +1,8 @@
+export interface Payload {
+    event_name: string;
+    revenue?: number;
+    currency?: string;
+    event_metadata?: {
+        [k: string]: unknown;
+    };
+}

package/dist/cjs/trackEvent/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/cjs/trackEvent/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/trackEvent/generated-types.ts"],"names":[],"mappings":""}

package/dist/cjs/trackEvent/index.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
+import { Intercom } from '../api';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: BrowserActionDefinition<Settings, Intercom, Payload>;
+export default action;

package/dist/cjs/trackEvent/index.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const action = {
+    title: 'Track Event',
+    description: 'Submit an event to Intercom.',
+    defaultSubscription: 'type = "track"',
+    platform: 'web',
+    fields: {
+        event_name: {
+            description: 'The name of the event.',
+            label: 'Event Name',
+            type: 'string',
+            required: true,
+            default: {
+                '@path': '$.event'
+            }
+        },
+        revenue: {
+            description: 'The amount associated with a purchase. Segment will multiply by 100 as Intercom requires the amount in cents.',
+            label: 'Revenue',
+            type: 'number',
+            required: false,
+            default: {
+                '@path': '$.properties.revenue'
+            }
+        },
+        currency: {
+            description: 'The currency of the purchase amount. Segment will default to USD if revenue is provided without a currency.',
+            label: 'Currency',
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.properties.currency'
+            }
+        },
+        event_metadata: {
+            description: 'Optional metadata describing the event.',
+            label: 'Event Metadata',
+            type: 'object',
+            required: false,
+            default: {
+                '@path': '$.properties'
+            }
+        }
+    },
+    perform: (Intercom, event) => {
+        const { event_name, event_metadata, ...rest } = event.payload;
+        const payload = { ...rest };
+        const richLinkProperties = Intercom.richLinkProperties ? Intercom.richLinkProperties : [];
+        const richLinkObjects = {};
+        if (event_metadata && richLinkProperties.length != 0) {
+            Object.entries(event_metadata).forEach(([key, value]) => {
+                if (richLinkProperties.includes(key)) {
+                    richLinkObjects[key] = value;
+                }
+            });
+        }
+        const filteredMetadata = utils_1.filterCustomTraits(event_metadata);
+        let price = {};
+        if (payload.revenue) {
+            price = {
+                amount: payload.revenue * 100,
+                currency: payload.currency ?? 'USD'
+            };
+            delete filteredMetadata.revenue;
+            delete filteredMetadata.currency;
+        }
+        Intercom('trackEvent', event_name, {
+            ...filteredMetadata,
+            ...richLinkObjects,
+            ...(!utils_1.isEmpty(price) && { price })
+        });
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/cjs/trackEvent/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/trackEvent/index.ts"],"names":[],"mappings":";;AAGA,oCAAsD;AAGtD,MAAM,MAAM,GAAyD;IACnE,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,8BAA8B;IAC3C,mBAAmB,EAAE,gBAAgB;IACrC,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,UAAU,EAAE;YACV,WAAW,EAAE,wBAAwB;YACrC,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,SAAS;aACnB;SACF;QACD,OAAO,EAAE;YACP,WAAW,EACT,+GAA+G;YACjH,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,sBAAsB;aAChC;SACF;QACD,QAAQ,EAAE;YACR,WAAW,EACT,6GAA6G;YAC/G,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,cAAc,EAAE;YACd,WAAW,EAAE,yCAAyC;YACtD,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;aACxB;SACF;KACF;IACD,OAAO,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAE3B,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,CAAA;QAC7D,MAAM,OAAO,GAAG,EAAE,GAAG,IAAI,EAAE,CAAA;QAC3B,MAAM,kBAAkB,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAA;QAGzF,MAAM,eAAe,GAA6B,EAAE,CAAA;QACpD,IAAI,cAAc,IAAI,kBAAkB,CAAC,MAAM,IAAI,CAAC,EAAE;YACpD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACtD,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACpC,eAAe,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;iBAC7B;YACH,CAAC,CAAC,CAAA;SACH;QAGD,MAAM,gBAAgB,GAAG,0BAAkB,CAAC,cAAc,CAAC,CAAA;QAG3D,IAAI,KAAK,GAAG,EAAE,CAAA;QACd,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,KAAK,GAAG;gBACN,MAAM,EAAE,OAAO,CAAC,OAAO,GAAG,GAAG;gBAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;aACpC,CAAA;YACD,OAAO,gBAAgB,CAAC,OAAO,CAAA;YAC/B,OAAO,gBAAgB,CAAC,QAAQ,CAAA;SACjC;QAID,QAAQ,CAAC,YAAY,EAAE,UAAU,EAAE;YACjC,GAAG,gBAAgB;YACnB,GAAG,eAAe;YAClB,GAAG,CAAC,CAAC,eAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;SAClC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/utils.d.ts

@@ -0,0 +1,10 @@
+export declare function convertDateToUnix(created_at: string | number): number;
+export declare function filterCustomTraits(traits: {
+    [k: string]: unknown;
+} | undefined): {
+    [k: string]: unknown;
+};
+export declare function getWidgetOptions(hide_default_launcher: boolean | undefined, activator: string | undefined): {
+    [key: string]: unknown;
+};
+export declare function isEmpty(o: object | undefined): boolean;

package/dist/cjs/utils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEmpty = exports.getWidgetOptions = exports.filterCustomTraits = exports.convertDateToUnix = void 0;
+const tslib_1 = require("tslib");
+const actions_core_1 = require("@segment/actions-core");
+const actions_shared_1 = require("@segment/actions-shared");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+function convertDateToUnix(created_at) {
+    if (typeof created_at === 'number') {
+        let unixDate = dayjs_1.default.unix(created_at).unix();
+        if (unixDate.toString().length == 13) {
+            unixDate = Math.floor(unixDate / 1000);
+        }
+        return unixDate;
+    }
+    return dayjs_1.default(created_at).unix();
+}
+exports.convertDateToUnix = convertDateToUnix;
+function filterCustomTraits(traits) {
+    const filteredCustomTraits = {};
+    if (traits) {
+        for (const [key, value] of Object.entries(traits)) {
+            if (!actions_core_1.isArray(value) && !actions_core_1.isObject(value)) {
+                filteredCustomTraits[key] = value;
+            }
+        }
+    }
+    return filteredCustomTraits;
+}
+exports.filterCustomTraits = filterCustomTraits;
+function getWidgetOptions(hide_default_launcher, activator) {
+    const widgetOptions = {};
+    if (hide_default_launcher !== undefined) {
+        widgetOptions.hide_default_launcher = hide_default_launcher;
+    }
+    if (activator !== '#IntercomDefaultWidget') {
+        widgetOptions.widget = {
+            activator: activator
+        };
+    }
+    return widgetOptions;
+}
+exports.getWidgetOptions = getWidgetOptions;
+function isEmpty(o) {
+    return !actions_shared_1.isNonEmpty(o);
+}
+exports.isEmpty = isEmpty;
+//# sourceMappingURL=utils.js.map

package/dist/cjs/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;;AAAA,wDAAyD;AACzD,4DAAoD;AACpD,0DAAyB;AAEzB,SAAgB,iBAAiB,CAAC,UAA2B;IAC3D,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,IAAI,QAAQ,GAAG,eAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAA;QAC5C,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,EAAE,EAAE;YACpC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;SACvC;QACD,OAAO,QAAQ,CAAA;KAChB;IACD,OAAO,eAAK,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAA;AACjC,CAAC;AATD,8CASC;AAED,SAAgB,kBAAkB,CAAC,MAA4C;IAC7E,MAAM,oBAAoB,GAA6B,EAAE,CAAA;IACzD,IAAI,MAAM,EAAE;QACV,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACjD,IAAI,CAAC,sBAAO,CAAC,KAAK,CAAC,IAAI,CAAC,uBAAQ,CAAC,KAAK,CAAC,EAAE;gBACvC,oBAAoB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;aAClC;SACF;KACF;IACD,OAAO,oBAAoB,CAAA;AAC7B,CAAC;AAVD,gDAUC;AAED,SAAgB,gBAAgB,CAAC,qBAA0C,EAAE,SAA6B;IACxG,MAAM,aAAa,GAA+B,EAAE,CAAA;IACpD,IAAI,qBAAqB,KAAK,SAAS,EAAE;QACvC,aAAa,CAAC,qBAAqB,GAAG,qBAAqB,CAAA;KAC5D;IACD,IAAI,SAAS,KAAK,wBAAwB,EAAE;QAC1C,aAAa,CAAC,MAAM,GAAG;YACrB,SAAS,EAAE,SAAS;SACrB,CAAA;KACF;IACD,OAAO,aAAa,CAAA;AACtB,CAAC;AAXD,4CAWC;AAED,SAAgB,OAAO,CAAC,CAAqB;IAC3C,OAAO,CAAC,2BAAU,CAAC,CAAC,CAAC,CAAA;AACvB,CAAC;AAFD,0BAEC"}

package/dist/esm/api.d.ts

@@ -0,0 +1,9 @@
+declare type method = 'trackEvent' | 'update';
+declare type IntercomApi = {
+    richLinkProperties: string[] | undefined;
+    appId: string;
+    activator: string | undefined;
+};
+declare type IntercomFunction = (method: method, ...args: unknown[]) => void;
+export declare type Intercom = IntercomFunction & IntercomApi;
+export {};

package/dist/esm/api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.js.map

package/dist/esm/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":""}

package/dist/esm/generated-types.d.ts

@@ -0,0 +1,6 @@
+export interface Settings {
+    appId: string;
+    activator?: string;
+    richLinkProperties?: string[];
+    apiBase?: string;
+}

package/dist/esm/generated-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generated-types.js.map

package/dist/esm/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../src/generated-types.ts"],"names":[],"mappings":""}

package/dist/esm/identifyCompany/generated-types.d.ts

@@ -0,0 +1,16 @@
+export interface Payload {
+    company: {
+        company_id: string;
+        name: string;
+        created_at?: string | number;
+        plan?: string;
+        monthly_spend?: number;
+        size?: number;
+        website?: string;
+        industry?: string;
+        company_custom_traits?: {
+            [k: string]: unknown;
+        };
+    };
+    hide_default_launcher?: boolean;
+}

package/dist/esm/identifyCompany/generated-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generated-types.js.map

package/dist/esm/identifyCompany/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/identifyCompany/generated-types.ts"],"names":[],"mappings":""}

package/dist/esm/identifyCompany/index.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
+import { Intercom } from '../api';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: BrowserActionDefinition<Settings, Intercom, Payload>;
+export default action;

package/dist/esm/identifyCompany/index.js

@@ -0,0 +1,63 @@
+import { getCompanyProperties } from '../sharedCompanyProperties';
+import { convertDateToUnix, filterCustomTraits, getWidgetOptions } from '../utils';
+const companyProperties = getCompanyProperties();
+const action = {
+    title: 'Identify Company',
+    description: 'Create or update a company in Intercom.',
+    defaultSubscription: 'type = "group"',
+    platform: 'web',
+    fields: {
+        company: {
+            description: "The user's company.",
+            label: 'Company',
+            type: 'object',
+            required: true,
+            properties: companyProperties,
+            default: {
+                company_id: { '@path': '$.groupId' },
+                name: { '@path': '$.traits.name' },
+                created_at: {
+                    '@if': {
+                        exists: { '@path': '$.traits.createdAt' },
+                        then: { '@path': '$.traits.createdAt' },
+                        else: { '@path': '$.traits.created_at' }
+                    }
+                },
+                plan: { '@path': '$.traits.plan' },
+                size: { '@path': '$.traits.size' },
+                website: { '@path': '$.traits.website' },
+                industry: { '@path': '$.traits.industry' },
+                monthly_spend: { '@path': '$.traits.monthly_spend' }
+            }
+        },
+        hide_default_launcher: {
+            description: 'Selectively show the chat widget. As per [Intercom docs](https://www.intercom.com/help/en/articles/189-turn-off-show-or-hide-the-intercom-messenger), you want to first hide the Messenger for all users inside the Intercom UI using Messenger settings. Then think about how you want to programmatically decide which users you would like to show the widget to.',
+            label: 'Hide Default Launcher',
+            type: 'boolean',
+            required: false,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.context.Intercom.hideDefaultLauncher' },
+                    then: { '@path': '$.context.Intercom.hideDefaultLauncher' },
+                    else: { '@path': '$.context.Intercom.hide_default_launcher' }
+                }
+            }
+        }
+    },
+    perform: (Intercom, event) => {
+        const { company_custom_traits, ...rest } = event.payload.company;
+        let company = { ...rest };
+        if (company?.created_at) {
+            company.created_at = convertDateToUnix(company.created_at);
+        }
+        const filteredCustomTraits = filterCustomTraits(company_custom_traits);
+        company = { ...company, ...filteredCustomTraits };
+        const widgetOptions = getWidgetOptions(event.payload.hide_default_launcher, Intercom.activator);
+        Intercom('update', {
+            company,
+            ...widgetOptions
+        });
+    }
+};
+export default action;
+//# sourceMappingURL=index.js.map

package/dist/esm/identifyCompany/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identifyCompany/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAGlF,MAAM,iBAAiB,GAA+B,oBAAoB,EAAE,CAAA;AAE5E,MAAM,MAAM,GAAyD;IACnE,KAAK,EAAE,kBAAkB;IACzB,WAAW,EAAE,yCAAyC;IACtD,mBAAmB,EAAE,gBAAgB;IACrC,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,OAAO,EAAE;YACP,WAAW,EAAE,qBAAqB;YAClC,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,iBAAiB;YAC7B,OAAO,EAAE;gBACP,UAAU,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;gBACpC,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;gBAClC,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;wBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;wBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;qBACzC;iBACF;gBACD,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;gBAClC,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;gBAClC,OAAO,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACxC,QAAQ,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;gBAC1C,aAAa,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aACrD;SACF;QACD,qBAAqB,EAAE;YACrB,WAAW,EACT,sWAAsW;YACxW,KAAK,EAAE,uBAAuB;YAC9B,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,KAAK;YACf,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE;oBAC7D,IAAI,EAAE,EAAE,OAAO,EAAE,wCAAwC,EAAE;oBAC3D,IAAI,EAAE,EAAE,OAAO,EAAE,0CAA0C,EAAE;iBAC9D;aACF;SACF;KACF;IACD,OAAO,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAE3B,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAA;QAChE,IAAI,OAAO,GAAG,EAAE,GAAG,IAAI,EAAE,CAAA;QAGzB,IAAI,OAAO,EAAE,UAAU,EAAE;YACvB,OAAO,CAAC,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;SAC3D;QAGD,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,qBAAqB,CAAC,CAAA;QAGtE,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,oBAAoB,EAAE,CAAA;QAGjD,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;QAG/F,QAAQ,CAAC,QAAQ,EAAE;YACjB,OAAO;YACP,GAAG,aAAa;SACjB,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/esm/identifyUser/generated-types.d.ts

@@ -0,0 +1,41 @@
+export interface Payload {
+    user_id?: string;
+    custom_traits?: {
+        [k: string]: unknown;
+    };
+    name?: string;
+    phone?: string;
+    unsubscribed_from_emails?: boolean;
+    language_override?: string;
+    email?: string;
+    created_at?: string | number;
+    avatar_image_url?: string;
+    user_hash?: string;
+    company?: {
+        company_id: string;
+        name: string;
+        created_at?: string | number;
+        plan?: string;
+        monthly_spend?: number;
+        size?: number;
+        website?: string;
+        industry?: string;
+        company_custom_traits?: {
+            [k: string]: unknown;
+        };
+    };
+    companies?: {
+        company_id: string;
+        name: string;
+        created_at?: string | number;
+        plan?: string;
+        monthly_spend?: number;
+        size?: number;
+        website?: string;
+        industry?: string;
+        company_custom_traits?: {
+            [k: string]: unknown;
+        };
+    }[];
+    hide_default_launcher?: boolean;
+}

package/dist/esm/identifyUser/generated-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generated-types.js.map

package/dist/esm/identifyUser/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/identifyUser/generated-types.ts"],"names":[],"mappings":""}

package/dist/esm/identifyUser/index.d.ts

@@ -0,0 +1,6 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types';
+import { Intercom } from '../api';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: BrowserActionDefinition<Settings, Intercom, Payload>;
+export default action;

package/dist/esm/identifyUser/index.js

@@ -0,0 +1,211 @@
+import { getCompanyProperties } from '../sharedCompanyProperties';
+import { convertDateToUnix, filterCustomTraits, getWidgetOptions, isEmpty } from '../utils';
+const companyProperties = getCompanyProperties();
+const action = {
+    title: 'Identify User',
+    description: 'Create or update a user in Intercom.',
+    defaultSubscription: 'type = "identify" or type = "page"',
+    platform: 'web',
+    fields: {
+        user_id: {
+            description: 'A unique identifier for the user.',
+            label: 'User ID',
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.userId'
+            }
+        },
+        custom_traits: {
+            description: "The user's custom attributes.",
+            label: 'Custom Attributes',
+            type: 'object',
+            required: false,
+            defaultObjectUI: 'keyvalue'
+        },
+        name: {
+            description: "The user's name.",
+            label: 'Name',
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.traits.name'
+            }
+        },
+        phone: {
+            description: "The user's phone number.",
+            label: 'Phone Number',
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.traits.phone'
+            }
+        },
+        unsubscribed_from_emails: {
+            description: "The user's email unsubscribe status.",
+            label: 'Unsubscribed From Emails',
+            type: 'boolean',
+            required: false
+        },
+        language_override: {
+            description: "The user's messenger language (instead of relying on browser language settings).",
+            label: 'Language Override',
+            type: 'string',
+            required: false
+        },
+        email: {
+            description: "The user's email address.",
+            label: 'Email Address',
+            type: 'string',
+            required: false,
+            default: {
+                '@path': '$.traits.email'
+            }
+        },
+        created_at: {
+            description: 'The time the user was created in your system.',
+            label: 'User Creation Time',
+            type: 'datetime',
+            required: false,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.traits.createdAt' },
+                    then: { '@path': '$.traits.createdAt' },
+                    else: { '@path': '$.traits.created_at' }
+                }
+            }
+        },
+        avatar_image_url: {
+            description: "The URL for the user's avatar/profile image.",
+            label: 'Avatar',
+            type: 'string',
+            required: false,
+            default: { '@path': '$.traits.avatar' }
+        },
+        user_hash: {
+            description: 'The user hash used for identity verification. See [Intercom docs](https://www.intercom.com/help/en/articles/183-enable-identity-verification-for-web-and-mobile) for more information on how to set this field.',
+            label: 'User Hash',
+            type: 'string',
+            required: false,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.context.Intercom.user_hash' },
+                    then: { '@path': '$.context.Intercom.user_hash' },
+                    else: { '@path': '$.context.Intercom.userHash' }
+                }
+            }
+        },
+        company: {
+            description: "The user's company.",
+            label: 'Company',
+            type: 'object',
+            required: false,
+            properties: companyProperties,
+            default: {
+                company_id: { '@path': '$.traits.company.id' },
+                name: { '@path': '$.traits.company.name' },
+                created_at: {
+                    '@if': {
+                        exists: { '@path': '$.traits.company.createdAt' },
+                        then: { '@path': '$.traits.company.createdAt' },
+                        else: { '@path': '$.traits.company.created_at' }
+                    }
+                },
+                plan: { '@path': '$.traits.company.plan' },
+                size: { '@path': '$.traits.company.size' },
+                website: { '@path': '$.traits.company.website' },
+                industry: { '@path': '$.traits.company.industry' },
+                monthly_spend: { '@path': '$.traits.company.monthly_spend' }
+            }
+        },
+        companies: {
+            description: 'The array of companies the user is associated to.',
+            label: 'Companies',
+            type: 'object',
+            multiple: true,
+            required: false,
+            properties: companyProperties,
+            default: {
+                '@arrayPath': [
+                    '$.traits.companies',
+                    {
+                        company_id: { '@path': '$.id' },
+                        name: { '@path': '$.name' },
+                        created_at: {
+                            '@if': {
+                                exists: { '@path': '$.createdAt' },
+                                then: { '@path': '$.createdAt' },
+                                else: { '@path': '$.created_at' }
+                            }
+                        },
+                        plan: { '@path': '$.plan' },
+                        size: { '@path': '$.size' },
+                        website: { '@path': '$.website' },
+                        industry: { '@path': '$.industry' },
+                        monthly_spend: { '@path': '$.monthly_spend' }
+                    }
+                ]
+            }
+        },
+        hide_default_launcher: {
+            description: 'Selectively show the chat widget. As per [Intercom docs](https://www.intercom.com/help/en/articles/189-turn-off-show-or-hide-the-intercom-messenger), you want to first hide the Messenger for all users inside the Intercom UI using Messenger settings. Then think about how you want to programmatically decide which users you would like to show the widget to.',
+            label: 'Hide Default Launcher',
+            type: 'boolean',
+            required: false,
+            default: {
+                '@if': {
+                    exists: { '@path': '$.context.Intercom.hideDefaultLauncher' },
+                    then: { '@path': '$.context.Intercom.hideDefaultLauncher' },
+                    else: { '@path': '$.context.Intercom.hide_default_launcher' }
+                }
+            }
+        }
+    },
+    perform: (Intercom, event) => {
+        const { custom_traits, avatar_image_url, ...rest } = event.payload;
+        const payload = { ...rest };
+        if (isEmpty(payload.company?.company_custom_traits)) {
+            delete payload.company?.company_custom_traits;
+        }
+        if (isEmpty(payload.company)) {
+            delete payload.company;
+        }
+        const companies = Array.isArray(payload.companies) ? [...payload.companies] : [];
+        const datesToConvert = [payload, payload.company, ...companies];
+        for (const objectWithDateProp of datesToConvert) {
+            if (objectWithDateProp && objectWithDateProp?.created_at) {
+                objectWithDateProp.created_at = convertDateToUnix(objectWithDateProp.created_at);
+            }
+        }
+        const filteredCustomTraits = filterCustomTraits(custom_traits);
+        if (payload.company) {
+            const { company_custom_traits, ...rest } = payload.company;
+            const companyFilteredCustomTraits = filterCustomTraits(company_custom_traits);
+            payload.company = { ...rest, ...companyFilteredCustomTraits };
+        }
+        if (payload.companies) {
+            payload.companies = payload.companies.map((company) => {
+                const { company_custom_traits, ...rest } = company;
+                const companyFilteredCustomTraits = filterCustomTraits(company_custom_traits);
+                company = { ...rest, ...companyFilteredCustomTraits };
+                return company;
+            });
+        }
+        const widgetOptions = getWidgetOptions(payload.hide_default_launcher, Intercom.activator);
+        let avatar = {};
+        if (avatar_image_url) {
+            avatar = {
+                image_url: avatar_image_url,
+                type: 'avatar'
+            };
+        }
+        Intercom('update', {
+            ...payload,
+            ...filteredCustomTraits,
+            ...widgetOptions,
+            ...(!isEmpty(avatar) && { avatar })
+        });
+    }
+};
+export default action;
+//# sourceMappingURL=index.js.map