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

package/.eslintcache

@@ -0,0 +1 @@
+[{"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/constants.ts":"1","/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/generated-types.ts":"2","/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/index.ts":"3","/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/test-utilities.ts":"4","/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/types.ts":"5","/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/utils.ts":"6"},{"size":71,"mtime":1686339431100,"results":"7","hashOfConfig":"8"},{"size":1575,"mtime":1686339431100,"results":"9","hashOfConfig":"8"},{"size":4250,"mtime":1686339475060,"results":"10","hashOfConfig":"8"},{"size":1365,"mtime":1686339475060,"results":"11","hashOfConfig":"8"},{"size":481,"mtime":1686339431100,"results":"12","hashOfConfig":"8"},{"size":1172,"mtime":1686339431100,"results":"13","hashOfConfig":"8"},{"filePath":"14","messages":"15","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"11wi5y",{"filePath":"16","messages":"17","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"18","messages":"19","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"20","messages":"21","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"22","messages":"23","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"24","messages":"25","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/constants.ts",[],"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/generated-types.ts",[],"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/index.ts",[],"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/test-utilities.ts",[],"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/types.ts",[],"/home/kaari/action-destinations/packages/browser-destinations/destinations/heap/src/utils.ts",[]]

package/dist/cjs/constants.d.ts

@@ -0,0 +1 @@
+export declare const HEAP_SEGMENT_BROWSER_LIBRARY_NAME = "browser-destination";

package/dist/cjs/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HEAP_SEGMENT_BROWSER_LIBRARY_NAME = void 0;
+exports.HEAP_SEGMENT_BROWSER_LIBRARY_NAME = 'browser-destination';
+//# sourceMappingURL=constants.js.map

package/dist/cjs/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,iCAAiC,GAAG,qBAAqB,CAAA"}

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

@@ -0,0 +1,8 @@
+export interface Settings {
+    appId: string;
+    disableTextCapture?: boolean;
+    secureCookie?: boolean;
+    trackingServer?: string;
+    hostname?: string;
+    browserArrayLimit?: number;
+}

package/dist/cjs/generated-types.js

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

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

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

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

@@ -0,0 +1,6 @@
+export interface Payload {
+    userId?: string;
+    traits?: {
+        [k: string]: unknown;
+    };
+}

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

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

package/dist/cjs/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/cjs/identifyUser/index.d.ts

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

package/dist/cjs/identifyUser/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Identify User',
+    description: 'Sets user identity',
+    platform: 'web',
+    defaultSubscription: 'type = "identify"',
+    fields: {
+        userId: {
+            type: 'string',
+            required: false,
+            description: "The user's identity",
+            label: 'Identity',
+            default: {
+                '@path': '$.userId'
+            }
+        },
+        traits: {
+            type: 'object',
+            required: false,
+            description: 'The Segment traits to be forwarded to Heap',
+            label: 'Traits',
+            default: {
+                '@path': '$.traits'
+            }
+        }
+    },
+    perform: (heap, event) => {
+        if (event.payload.traits) {
+            heap.addUserProperties(event.payload.traits);
+        }
+        if (event.payload.userId) {
+            heap.identify(event.payload.userId);
+        }
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identifyUser/index.ts"],"names":[],"mappings":";;AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,oBAAoB;IACjC,QAAQ,EAAE,KAAK;IACf,mBAAmB,EAAE,mBAAmB;IACxC,MAAM,EAAE;QACN,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,qBAAqB;YAClC,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE;gBACP,OAAO,EAAE,UAAU;aACpB;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,UAAU;aACpB;SACF;KACF;IACD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;YACxB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC7C;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;YACxB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SACpC;IACH,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,11 @@
+import type { Settings } from './generated-types';
+import type { BrowserDestinationDefinition } from '@segment/browser-destination-runtime/types';
+import { HeapApi } from './types';
+declare global {
+    interface Window {
+        heap: HeapApi;
+    }
+}
+export declare const destination: BrowserDestinationDefinition<Settings, HeapApi>;
+declare const _default: import("@segment/browser-destination-runtime/types").PluginFactory;
+export default _default;

package/dist/cjs/index.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.destination = void 0;
+const tslib_1 = require("tslib");
+const shim_1 = require("@segment/browser-destination-runtime/shim");
+const actions_core_1 = require("@segment/actions-core");
+const trackEvent_1 = tslib_1.__importDefault(require("./trackEvent"));
+const identifyUser_1 = tslib_1.__importDefault(require("./identifyUser"));
+const utils_1 = require("./utils");
+exports.destination = {
+    name: 'Heap Web (Actions)',
+    slug: 'actions-heap-web',
+    mode: 'device',
+    presets: [
+        {
+            name: 'Track Event',
+            subscribe: 'type = "track"',
+            partnerAction: 'trackEvent',
+            mapping: actions_core_1.defaultValues(trackEvent_1.default.fields)
+        },
+        {
+            name: 'Identify User',
+            subscribe: 'type = "identify"',
+            partnerAction: 'identifyUser',
+            mapping: actions_core_1.defaultValues(identifyUser_1.default.fields)
+        }
+    ],
+    settings: {
+        appId: {
+            label: 'Heap app ID',
+            description: 'The app ID of the environment to which you want to send data. You can find this ID on the [Projects](https://heapanalytics.com/app/manage/projects) page.',
+            type: 'string',
+            required: true
+        },
+        disableTextCapture: {
+            label: 'Global data redaction via Disabling Text Capture',
+            description: 'Setting to true will redact all target text on your website. For more information visit the heap [docs page](https://developers.heap.io/docs/web#global-data-redaction-via-disabling-text-capture).',
+            type: 'boolean',
+            required: false
+        },
+        secureCookie: {
+            label: 'Secure Cookie',
+            description: 'This option is turned off by default to accommodate websites not served over HTTPS. If your application uses HTTPS, we recommend enabling secure cookies to prevent Heap cookies from being observed by unauthorized parties. For more information visit the heap [docs page](https://developers.heap.io/docs/web#securecookie).',
+            type: 'boolean',
+            required: false
+        },
+        trackingServer: {
+            label: 'Tracking Server',
+            description: 'This is an optional setting. This is used to set up first-party data collection. For most cased this should not be set. For more information visit the heap [docs page](https://developers.heap.io/docs/set-up-first-party-data-collection-in-heap).',
+            type: 'string',
+            required: false
+        },
+        hostname: {
+            label: 'Hostname',
+            description: 'This is an optional setting used to set the host that loads heap-js. This setting is used when heapJS is self-hosted. In most cased this should be left unset. The hostname should not contain https or app id it will be populated like so: https://${hostname}/js/heap-${appId}.js. For more information visit the heap [docs page](https://developers.heap.io/docs/self-hosting-heapjs).',
+            type: 'string',
+            required: false
+        },
+        browserArrayLimit: {
+            label: 'Browser Array Limit',
+            description: 'This is an optional setting. When set, nested array items will be sent in as new Heap events. Defaults to 0.',
+            type: 'number',
+            required: false
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        if (window.heap) {
+            return window.heap;
+        }
+        const config = {
+            disableTextCapture: settings.disableTextCapture || false,
+            secureCookie: settings.secureCookie || false
+        };
+        if (settings.trackingServer) {
+            config.trackingServer = settings.trackingServer;
+        }
+        window.heap = window.heap || [];
+        window.heap.appid = settings.appId;
+        window.heap.config = config;
+        if (utils_1.isDefined(settings.hostname)) {
+            await deps.loadScript(`https://${settings.hostname}/js/heap-${settings.appId}.js`);
+        }
+        else {
+            await deps.loadScript(`https://cdn.heapanalytics.com/js/heap-${settings.appId}.js`);
+        }
+        await deps.resolveWhen(() => Object.prototype.hasOwnProperty.call(window, 'heap'), 100);
+        return window.heap;
+    },
+    actions: {
+        trackEvent: trackEvent_1.default,
+        identifyUser: identifyUser_1.default
+    }
+};
+exports.default = shim_1.browserDestination(exports.destination);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAEA,oEAA8E;AAE9E,wDAAqD;AACrD,sEAAqC;AACrC,0EAAyC;AACzC,mCAAmC;AAStB,QAAA,WAAW,GAAoD;IAC1E,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,QAAQ;IACd,OAAO,EAAE;QACP;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,gBAAgB;YAC3B,aAAa,EAAE,YAAY;YAC3B,OAAO,EAAE,4BAAa,CAAC,oBAAU,CAAC,MAAM,CAAC;SAC1C;QACD;YACE,IAAI,EAAE,eAAe;YACrB,SAAS,EAAE,mBAAmB;YAC9B,aAAa,EAAE,cAAc;YAC7B,OAAO,EAAE,4BAAa,CAAC,sBAAY,CAAC,MAAM,CAAC;SAC5C;KACF;IACD,QAAQ,EAAE;QAER,KAAK,EAAE;YACL,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,2JAA2J;YAC7J,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;QACD,kBAAkB,EAAE;YAClB,KAAK,EAAE,kDAAkD;YACzD,WAAW,EACT,qMAAqM;YACvM,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,KAAK;SAChB;QACD,YAAY,EAAE;YACZ,KAAK,EAAE,eAAe;YACtB,WAAW,EACT,kUAAkU;YACpU,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,KAAK;SAChB;QACD,cAAc,EAAE;YACd,KAAK,EAAE,iBAAiB;YACxB,WAAW,EACT,sPAAsP;YACxP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,WAAW,EACT,6XAA6X;YAC/X,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB;QACD,iBAAiB,EAAE;YACjB,KAAK,EAAE,qBAAqB;YAC5B,WAAW,EACT,8GAA8G;YAChH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB;KACF;IAED,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE;QACvC,IAAI,MAAM,CAAC,IAAI,EAAE;YACf,OAAO,MAAM,CAAC,IAAI,CAAA;SACnB;QAED,MAAM,MAAM,GAAe;YACzB,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,IAAI,KAAK;YACxD,YAAY,EAAE,QAAQ,CAAC,YAAY,IAAI,KAAK;SAC7C,CAAA;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,MAAM,CAAC,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAA;SAChD;QAGD,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,EAAE,CAAA;QAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;QAClC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAE3B,IAAI,iBAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAChC,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,QAAQ,CAAC,QAAQ,YAAY,QAAQ,CAAC,KAAK,KAAK,CAAC,CAAA;SACnF;aAAM;YACL,MAAM,IAAI,CAAC,UAAU,CAAC,yCAAyC,QAAQ,CAAC,KAAK,KAAK,CAAC,CAAA;SACpF;QAGD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,CAAA;QAEvF,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;IAED,OAAO,EAAE;QACP,UAAU,EAAV,oBAAU;QACV,YAAY,EAAZ,sBAAY;KACb;CACF,CAAA;AAED,kBAAe,yBAAkB,CAAC,mBAAW,CAAC,CAAA"}

package/dist/cjs/test-utilities.d.ts

@@ -0,0 +1,7 @@
+import { HeapApi } from './types';
+import { Subscription } from '@segment/browser-destination-runtime/types';
+export declare const HEAP_TEST_ENV_ID = "1";
+export declare const createMockedHeapJsSdk: () => HeapApi;
+export declare const trackEventSubscription: Subscription;
+export declare const identifyUserSubscription: Subscription;
+export declare const mockHeapJsHttpRequest: () => void;

package/dist/cjs/test-utilities.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockHeapJsHttpRequest = exports.identifyUserSubscription = exports.trackEventSubscription = exports.createMockedHeapJsSdk = exports.HEAP_TEST_ENV_ID = void 0;
+const tslib_1 = require("tslib");
+const nock_1 = tslib_1.__importDefault(require("nock"));
+exports.HEAP_TEST_ENV_ID = '1';
+const createMockedHeapJsSdk = () => {
+    return {
+        appid: exports.HEAP_TEST_ENV_ID,
+        config: {
+            disableTextCapture: true,
+            secureCookie: true
+        },
+        load: jest.fn(),
+        track: jest.fn(),
+        identify: jest.fn(),
+        addUserProperties: jest.fn()
+    };
+};
+exports.createMockedHeapJsSdk = createMockedHeapJsSdk;
+exports.trackEventSubscription = {
+    partnerAction: 'trackEvent',
+    name: 'Track Event',
+    enabled: true,
+    subscribe: 'type = "track"',
+    mapping: {
+        name: {
+            '@path': '$.name'
+        },
+        properties: {
+            '@path': '$.properties'
+        },
+        identity: {
+            '@path': '$.userId'
+        },
+        anonymousId: {
+            '@path': '$.anonymousId'
+        },
+        traits: {
+            '@path': '$.context.traits'
+        }
+    }
+};
+exports.identifyUserSubscription = {
+    partnerAction: 'identifyUser',
+    name: 'Identify User',
+    enabled: true,
+    subscribe: 'type = "identify"',
+    mapping: {
+        anonymousId: {
+            '@path': '$.anonymousId'
+        },
+        userId: {
+            '@path': '$.userId'
+        },
+        traits: {
+            '@path': '$.traits'
+        }
+    }
+};
+const mockHeapJsHttpRequest = () => {
+    nock_1.default('https://cdn.heapanalytics.com').get(`/js/heap-${exports.HEAP_TEST_ENV_ID}.js`).reply(200, {});
+};
+exports.mockHeapJsHttpRequest = mockHeapJsHttpRequest;
+//# sourceMappingURL=test-utilities.js.map

package/dist/cjs/test-utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utilities.js","sourceRoot":"","sources":["../../src/test-utilities.ts"],"names":[],"mappings":";;;;AAEA,wDAAuB;AAEV,QAAA,gBAAgB,GAAG,GAAG,CAAA;AAE5B,MAAM,qBAAqB,GAAG,GAAY,EAAE;IACjD,OAAO;QACL,KAAK,EAAE,wBAAgB;QACvB,MAAM,EAAE;YACN,kBAAkB,EAAE,IAAI;YACxB,YAAY,EAAE,IAAI;SACnB;QACD,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;QACf,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;QAChB,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;QACnB,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE;KAC7B,CAAA;AACH,CAAC,CAAA;AAZY,QAAA,qBAAqB,yBAYjC;AACY,QAAA,sBAAsB,GAAiB;IAClD,aAAa,EAAE,YAAY;IAC3B,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,gBAAgB;IAC3B,OAAO,EAAE;QACP,IAAI,EAAE;YACJ,OAAO,EAAE,QAAQ;SAClB;QACD,UAAU,EAAE;YACV,OAAO,EAAE,cAAc;SACxB;QACD,QAAQ,EAAE;YACR,OAAO,EAAE,UAAU;SACpB;QACD,WAAW,EAAE;YACX,OAAO,EAAE,eAAe;SACzB;QACD,MAAM,EAAE;YACN,OAAO,EAAE,kBAAkB;SAC5B;KACF;CACF,CAAA;AAEY,QAAA,wBAAwB,GAAiB;IACpD,aAAa,EAAE,cAAc;IAC7B,IAAI,EAAE,eAAe;IACrB,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,mBAAmB;IAC9B,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,eAAe;SACzB;QACD,MAAM,EAAE;YACN,OAAO,EAAE,UAAU;SACpB;QACD,MAAM,EAAE;YACN,OAAO,EAAE,UAAU;SACpB;KACF;CACF,CAAA;AAEM,MAAM,qBAAqB,GAAG,GAAS,EAAE;IAC9C,cAAI,CAAC,+BAA+B,CAAC,CAAC,GAAG,CAAC,YAAY,wBAAgB,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AAC7F,CAAC,CAAA;AAFY,QAAA,qBAAqB,yBAEjC"}

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

@@ -0,0 +1,11 @@
+export interface Payload {
+    name: string;
+    properties?: {
+        [k: string]: unknown;
+    };
+    identity?: string;
+    anonymousId?: string;
+    traits?: {
+        [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 type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+import { HeapApi } from '../types';
+declare const action: BrowserActionDefinition<Settings, HeapApi, Payload>;
+export default action;

package/dist/cjs/trackEvent/index.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const action = {
+    title: 'Track Event',
+    description: 'Track events',
+    platform: 'web',
+    defaultSubscription: 'type = "track"',
+    fields: {
+        name: {
+            description: 'The name of the event.',
+            label: 'Name',
+            required: true,
+            type: 'string',
+            default: {
+                '@path': '$.event'
+            }
+        },
+        properties: {
+            description: 'A JSON object containing additional information about the event that will be indexed by Heap.',
+            label: 'Properties',
+            required: false,
+            type: 'object',
+            default: {
+                '@path': '$.properties'
+            }
+        },
+        identity: {
+            type: 'string',
+            required: false,
+            label: 'Identity',
+            description: 'a string that uniquely identifies a user, such as an email, handle, or username. This means no two users in one environment may share the same identity. More on identify: https://developers.heap.io/docs/using-identify'
+        },
+        anonymousId: {
+            type: 'string',
+            required: false,
+            description: 'The segment anonymous identifier for the user',
+            label: 'Anonymous ID',
+            default: {
+                '@path': '$.anonymousId'
+            }
+        },
+        traits: {
+            label: 'User Properties',
+            type: 'object',
+            description: 'An object with key-value properties you want associated with the user. Each property must either be a number or string with fewer than 1024 characters.',
+            default: {
+                '@path': '$.context.traits'
+            }
+        }
+    },
+    perform: (heap, event) => {
+        if (event.payload.anonymousId || utils_1.isDefined(event.payload?.traits)) {
+            const traits = utils_1.flat(event.payload?.traits);
+            heap.addUserProperties({
+                ...(utils_1.isDefined(event.payload.anonymousId) && { anonymous_id: event.payload.anonymousId }),
+                ...(utils_1.isDefined(traits) && traits)
+            });
+        }
+        if (event.payload?.identity && utils_1.isDefined(event.payload?.identity)) {
+            heap.identify(event.payload.identity);
+        }
+        let eventProperties = Object.assign({}, event.payload.properties);
+        const eventName = event.payload.name;
+        const browserArrayLimit = event.settings.browserArrayLimit || 0;
+        const browserArrayLimitSet = !!browserArrayLimit;
+        let arrayEventsCount = 0;
+        for (const [key, value] of Object.entries(eventProperties)) {
+            if (browserArrayLimitSet && arrayEventsCount >= browserArrayLimit) {
+                break;
+            }
+            if (!Array.isArray(value)) {
+                continue;
+            }
+            delete eventProperties[key];
+            eventProperties = { ...eventProperties, ...utils_1.flat({ [key]: value }) };
+            const arrayLength = value.length;
+            let arrayPropertyValues;
+            if (browserArrayLimitSet && arrayLength + arrayEventsCount > browserArrayLimit) {
+                arrayPropertyValues = value.splice(0, browserArrayLimit - arrayEventsCount);
+            }
+            else {
+                arrayPropertyValues = value;
+            }
+            arrayEventsCount += arrayLength;
+            arrayPropertyValues.forEach((arrayPropertyValue) => {
+                const arrayProperties = utils_1.flattenProperties(arrayPropertyValue);
+                heapTrack(heap, `${eventName} ${key} item`, arrayProperties);
+            });
+        }
+        heapTrack(heap, eventName, eventProperties);
+    }
+};
+const heapTrack = (heap, eventName, properties) => {
+    properties.segment_library = constants_1.HEAP_SEGMENT_BROWSER_LIBRARY_NAME;
+    heap.track(eventName, properties);
+};
+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":";;AAIA,4CAAgE;AAChE,oCAA6D;AAE7D,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,cAAc;IAC3B,QAAQ,EAAE,KAAK;IACf,mBAAmB,EAAE,gBAAgB;IACrC,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,WAAW,EAAE,wBAAwB;YACrC,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,SAAS;aACnB;SACF;QACD,UAAU,EAAE;YACV,WAAW,EAAE,+FAA+F;YAC5G,KAAK,EAAE,YAAY;YACnB,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;aACxB;SACF;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,UAAU;YACjB,WAAW,EACT,2NAA2N;SAC9N;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,+CAA+C;YAC5D,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE;gBACP,OAAO,EAAE,eAAe;aACzB;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EACT,yJAAyJ;YAC3J,OAAO,EAAE;gBACP,OAAO,EAAE,kBAAkB;aAC5B;SACF;KACF;IACD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAEvB,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,IAAI,iBAAS,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACjE,MAAM,MAAM,GAAG,YAAI,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YAC1C,IAAI,CAAC,iBAAiB,CAAC;gBACrB,GAAG,CAAC,iBAAS,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxF,GAAG,CAAC,iBAAS,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC;aACjC,CAAC,CAAA;SACH;QAGD,IAAI,KAAK,CAAC,OAAO,EAAE,QAAQ,IAAI,iBAAS,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;YACjE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;SACtC;QAGD,IAAI,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjE,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAA;QACpC,MAAM,iBAAiB,GAAG,KAAK,CAAC,QAAQ,CAAC,iBAAiB,IAAI,CAAC,CAAA;QAC/D,MAAM,oBAAoB,GAAG,CAAC,CAAC,iBAAiB,CAAA;QAChD,IAAI,gBAAgB,GAAG,CAAC,CAAA;QAExB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;YAC1D,IAAI,oBAAoB,IAAI,gBAAgB,IAAI,iBAAiB,EAAE;gBACjE,MAAK;aACN;YAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACzB,SAAQ;aACT;YAED,OAAO,eAAe,CAAC,GAAG,CAAC,CAAA;YAC3B,eAAe,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,YAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAA;YAEnE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAA;YAChC,IAAI,mBAAmB,CAAA;YAEvB,IAAI,oBAAoB,IAAI,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,EAAE;gBAC9E,mBAAmB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,CAAC,CAAA;aAC5E;iBAAM;gBACL,mBAAmB,GAAG,KAAK,CAAA;aAC5B;YAED,gBAAgB,IAAI,WAAW,CAAA;YAE/B,mBAAmB,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;gBACjD,MAAM,eAAe,GAAG,yBAAiB,CAAC,kBAAkB,CAAC,CAAA;gBAC7D,SAAS,CAAC,IAAI,EAAE,GAAG,SAAS,IAAI,GAAG,OAAO,EAAE,eAAe,CAAC,CAAA;YAC9D,CAAC,CAAC,CAAA;SACH;QACD,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,eAAe,CAAC,CAAA;IAC7C,CAAC;CACF,CAAA;AAED,MAAM,SAAS,GAAG,CAChB,IAAa,EACb,SAAiB,EACjB,UAEC,EACD,EAAE;IACF,UAAU,CAAC,eAAe,GAAG,6CAAiC,CAAA;IAC9D,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;AACnC,CAAC,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/types.d.ts

@@ -0,0 +1,20 @@
+export declare type UserConfig = {
+    trackingServer?: string;
+    disableTextCapture: boolean;
+    secureCookie: boolean;
+};
+declare type UserProperties = {
+    [k: string]: unknown;
+};
+declare type EventProperties = {
+    [key: string]: unknown;
+};
+export declare type HeapApi = {
+    appid: string;
+    track: (eventName: string, eventProperties: EventProperties, library?: string) => void;
+    load: () => void;
+    config: UserConfig;
+    identify: (identity: string) => void;
+    addUserProperties: (properties: UserProperties) => void;
+};
+export {};

package/dist/cjs/types.js

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

package/dist/cjs/types.js.map

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

package/dist/cjs/utils.d.ts

@@ -0,0 +1,10 @@
+export declare function isDefined(value: string | undefined | null | number | object): boolean;
+export declare type Properties = {
+    [k: string]: unknown;
+};
+declare type FlattenProperties = object & {
+    [k: string]: string;
+};
+export declare function flat(data?: Properties, prefix?: string): FlattenProperties | undefined;
+export declare const flattenProperties: (arrayPropertyValue: any) => {};
+export {};

package/dist/cjs/utils.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flattenProperties = exports.flat = exports.isDefined = void 0;
+function isDefined(value) {
+    if (typeof value === 'object') {
+        return !!value && Object.keys(value).length !== 0;
+    }
+    return !(value === undefined || value === null || value === '' || value === 0 || value === '0');
+}
+exports.isDefined = isDefined;
+function flat(data, prefix = '') {
+    if (!isDefined(data)) {
+        return undefined;
+    }
+    let result = {};
+    for (const key in data) {
+        if (typeof data[key] == 'object' && data[key] !== null) {
+            const flatten = flat(data[key], prefix + '.' + key);
+            result = { ...result, ...flatten };
+        }
+        else {
+            const stringifiedValue = stringify(data[key]);
+            result[(prefix + '.' + key).replace(/^\./, '')] = stringifiedValue;
+        }
+    }
+    return result;
+}
+exports.flat = flat;
+const flattenProperties = (arrayPropertyValue) => {
+    let arrayProperties = {};
+    for (const [key, value] of Object.entries(arrayPropertyValue)) {
+        if (typeof value == 'object' && value !== null) {
+            arrayProperties = { ...arrayProperties, ...flat({ [key]: value }) };
+        }
+        else {
+            arrayProperties = Object.assign(arrayProperties, { [key]: value });
+        }
+    }
+    return arrayProperties;
+};
+exports.flattenProperties = flattenProperties;
+function stringify(value) {
+    if (typeof value === 'string') {
+        return value;
+    }
+    if (typeof value === 'number' || typeof value === 'boolean') {
+        return value.toString();
+    }
+    return JSON.stringify(value);
+}
+//# 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,SAAgB,SAAS,CAAC,KAAkD;IAC1E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAA;KAClD;IACD,OAAO,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,GAAG,CAAC,CAAA;AACjG,CAAC;AALD,8BAKC;AAUD,SAAgB,IAAI,CAAC,IAAiB,EAAE,MAAM,GAAG,EAAE;IACjD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QACpB,OAAO,SAAS,CAAA;KACjB;IACD,IAAI,MAAM,GAAsB,EAAE,CAAA;IAClC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YACtD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAe,EAAE,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,CAAA;YACjE,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAAA;SACnC;aAAM;YACL,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;YAC7C,MAAM,CAAC,CAAC,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAA;SACnE;KACF;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAfD,oBAeC;AAGM,MAAM,iBAAiB,GAAG,CAAC,kBAAuB,EAAE,EAAE;IAC3D,IAAI,eAAe,GAAG,EAAE,CAAA;IACxB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;QAC7D,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;YAC9C,eAAe,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAmB,EAAE,CAAC,EAAE,CAAA;SAClF;aAAM;YACL,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;SACnE;KACF;IACD,OAAO,eAAe,CAAA;AACxB,CAAC,CAAA;AAVY,QAAA,iBAAiB,qBAU7B;AAED,SAAS,SAAS,CAAC,KAAc;IAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,KAAK,CAAA;KACb;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;QAC3D,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAA;KACxB;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC"}

package/dist/esm/constants.d.ts

@@ -0,0 +1 @@
+export declare const HEAP_SEGMENT_BROWSER_LIBRARY_NAME = "browser-destination";

package/dist/esm/constants.js

@@ -0,0 +1,2 @@
+export const HEAP_SEGMENT_BROWSER_LIBRARY_NAME = 'browser-destination';
+//# sourceMappingURL=constants.js.map

package/dist/esm/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iCAAiC,GAAG,qBAAqB,CAAA"}

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

@@ -0,0 +1,8 @@
+export interface Settings {
+    appId: string;
+    disableTextCapture?: boolean;
+    secureCookie?: boolean;
+    trackingServer?: string;
+    hostname?: string;
+    browserArrayLimit?: number;
+}

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/identifyUser/generated-types.d.ts

@@ -0,0 +1,6 @@
+export interface Payload {
+    userId?: string;
+    traits?: {
+        [k: string]: unknown;
+    };
+}

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 type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+import { HeapApi } from '../types';
+declare const action: BrowserActionDefinition<Settings, HeapApi, Payload>;
+export default action;

package/dist/esm/identifyUser/index.js

@@ -0,0 +1,36 @@
+const action = {
+    title: 'Identify User',
+    description: 'Sets user identity',
+    platform: 'web',
+    defaultSubscription: 'type = "identify"',
+    fields: {
+        userId: {
+            type: 'string',
+            required: false,
+            description: "The user's identity",
+            label: 'Identity',
+            default: {
+                '@path': '$.userId'
+            }
+        },
+        traits: {
+            type: 'object',
+            required: false,
+            description: 'The Segment traits to be forwarded to Heap',
+            label: 'Traits',
+            default: {
+                '@path': '$.traits'
+            }
+        }
+    },
+    perform: (heap, event) => {
+        if (event.payload.traits) {
+            heap.addUserProperties(event.payload.traits);
+        }
+        if (event.payload.userId) {
+            heap.identify(event.payload.userId);
+        }
+    }
+};
+export default action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identifyUser/index.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,oBAAoB;IACjC,QAAQ,EAAE,KAAK;IACf,mBAAmB,EAAE,mBAAmB;IACxC,MAAM,EAAE;QACN,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,qBAAqB;YAClC,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE;gBACP,OAAO,EAAE,UAAU;aACpB;SACF;QACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE,QAAQ;YACf,OAAO,EAAE;gBACP,OAAO,EAAE,UAAU;aACpB;SACF;KACF;IACD,OAAO,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;YACxB,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC7C;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE;YACxB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SACpC;IACH,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}