@segment/analytics-browser-appcues-web-actions 1.1.0

package/README.md

@@ -0,0 +1,31 @@
+# @segment/analytics-browser-appcues-web-actions
+
+The Appcues Web browser action destination for use with @segment/analytics-next.
+
+## License
+
+MIT License
+
+Copyright (c) 2025 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Contributing
+
+All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

package/dist/cjs/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const URL: {
+    US: string;
+    EU: string;
+};

package/dist/cjs/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.URL = void 0;
+exports.URL = {
+    US: "fast.appcues.com",
+    EU: "fast.eu.appcues.com"
+};
+//# 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,GAAG,GAAG;IACjB,EAAE,EAAE,kBAAkB;IACtB,EAAE,EAAE,qBAAqB;CAC1B,CAAA"}

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

@@ -0,0 +1,5 @@
+export interface Settings {
+    accountID: string;
+    region: string;
+    enableURLDetection: boolean;
+}

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

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

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

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

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

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

package/dist/cjs/group/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/cjs/group/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Group',
+    description: 'Send Segment group events to Appcues.',
+    platform: 'web',
+    fields: {
+        groupId: {
+            label: 'Group ID',
+            description: 'The ID of the group to identify in Appcues.',
+            required: true,
+            type: 'string',
+            default: { '@path': '$.groupId' }
+        },
+        traits: {
+            label: 'Group traits',
+            description: 'Properties to associate with the group / account / company.',
+            required: false,
+            type: 'object',
+            default: { '@path': '$.traits' }
+        }
+    },
+    defaultSubscription: 'type = "group"',
+    perform: (appcues, { payload }) => {
+        const { groupId, traits } = payload;
+        appcues.group(groupId, traits);
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/group/index.ts"],"names":[],"mappings":";;AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,uCAAuC;IACpD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,OAAO,EAAE;YACP,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,6CAA6C;YAC1D,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;SAClC;QACD,MAAM,EAAE;YACN,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,6DAA6D;YAC1E,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;KACF;IACD,mBAAmB,EAAE,gBAAgB;IACrC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;QACnC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAChC,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

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

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

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

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

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

package/dist/cjs/identify/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/cjs/identify/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Identify',
+    description: 'Send Segment identify events to Appcues.',
+    platform: 'web',
+    fields: {
+        userId: {
+            label: 'User ID',
+            description: 'The ID of the user to identify in Appcues.',
+            required: true,
+            type: 'string',
+            default: { '@path': '$.userId' }
+        },
+        traits: {
+            label: 'User traits',
+            description: 'Properties to associate with the user.',
+            required: false,
+            type: 'object',
+            default: { '@path': '$.traits' }
+        }
+    },
+    defaultSubscription: 'type = "identify"',
+    perform: (appcues, { payload }) => {
+        const { userId, traits } = payload;
+        appcues.identify(userId, traits);
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identify/index.ts"],"names":[],"mappings":";;AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,0CAA0C;IACvD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,4CAA4C;YACzD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;QACD,MAAM,EAAE;YACN,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,wCAAwC;YACrD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;KACF;IACD,mBAAmB,EAAE,mBAAmB;IACxC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;QAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

@@ -0,0 +1,67 @@
+"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 track_1 = tslib_1.__importDefault(require("./track"));
+const page_1 = tslib_1.__importDefault(require("./page"));
+const identify_1 = tslib_1.__importDefault(require("./identify"));
+const group_1 = tslib_1.__importDefault(require("./group"));
+const constants_1 = require("./constants");
+const actions_core_1 = require("@segment/actions-core");
+exports.destination = {
+    name: 'Appcues Web',
+    slug: 'appcues-web-actions',
+    mode: 'device',
+    settings: {
+        accountID: {
+            label: 'Appcues Account ID',
+            description: 'Your Appcues Account ID.',
+            type: 'password',
+            required: true
+        },
+        region: {
+            label: 'Region',
+            description: 'Select the Appcues region for your account.',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'US', value: 'US' },
+                { label: 'EU', value: 'EU' }
+            ],
+            default: 'US'
+        },
+        enableURLDetection: {
+            label: 'Enable URL Detection',
+            description: 'Enable or disable URL detection in Appcues. If enabled, page events should not be triggered manually using the page action.',
+            type: 'boolean',
+            required: true,
+            default: false
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        const { region, accountID, enableURLDetection } = settings;
+        const url = region === 'EU' ? constants_1.URL.EU : constants_1.URL.US;
+        window.AppcuesSettings = { enableURLDetection };
+        await deps.loadScript(`//${url}/${accountID}.js`);
+        await deps.resolveWhen(() => Object.prototype.hasOwnProperty.call(window, 'Appcues'), 100);
+        return window.Appcues;
+    },
+    presets: [
+        {
+            name: 'Page',
+            subscribe: 'type = "page"',
+            partnerAction: 'page',
+            mapping: (0, actions_core_1.defaultValues)(page_1.default.fields),
+            type: 'automatic'
+        }
+    ],
+    actions: {
+        track: track_1.default,
+        page: page_1.default,
+        identify: identify_1.default,
+        group: group_1.default
+    }
+};
+exports.default = (0, 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,4DAA2B;AAC3B,0DAAyB;AACzB,kEAAiC;AACjC,4DAA2B;AAC3B,2CAAiC;AACjC,wDAAqD;AAExC,QAAA,WAAW,GAAoD;IAC1E,IAAI,EAAE,aAAa;IACnB,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,6CAA6C;YAC1D,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;gBAC5B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;YACD,OAAO,EAAE,IAAI;SACd;QACD,kBAAkB,EAAE;YAClB,KAAK,EAAE,sBAAsB;YAC7B,WAAW,EAAE,6HAA6H;YAC1I,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;SACf;KACF;IACD,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE;QACvC,MAAM,EACJ,MAAM,EACN,SAAS,EACT,kBAAkB,EACnB,GAAG,QAAQ,CAAA;QACZ,MAAM,GAAG,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,eAAG,CAAC,EAAE,CAAC,CAAC,CAAC,eAAG,CAAC,EAAE,CAAA;QAC7C,MAAM,CAAC,eAAe,GAAG,EAAE,kBAAkB,EAAE,CAAA;QAC/C,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI,SAAS,KAAK,CAAC,CAAA;QACjD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,CAAC,CAAA;QAC1F,OAAO,MAAM,CAAC,OAAO,CAAA;IACvB,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,eAAe;YAC1B,aAAa,EAAE,MAAM;YACrB,OAAO,EAAE,IAAA,4BAAa,EAAC,cAAI,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAL,eAAK;QACL,IAAI,EAAJ,cAAI;QACJ,QAAQ,EAAR,kBAAQ;QACR,KAAK,EAAL,eAAK;KACN;CACF,CAAA;AAED,kBAAe,IAAA,yBAAkB,EAAC,mBAAW,CAAC,CAAA"}

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

@@ -0,0 +1,2 @@
+export interface Payload {
+}

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

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

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

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

package/dist/cjs/page/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/cjs/page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Page',
+    description: 'Send Segment page events to Appcues.',
+    platform: 'web',
+    fields: {},
+    defaultSubscription: 'type = "page"',
+    perform: (appcues) => {
+        appcues.page();
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/page/index.ts"],"names":[],"mappings":";;AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,sCAAsC;IACnD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE,EAAE;IACV,mBAAmB,EAAE,eAAe;IACpC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;QACnB,OAAO,CAAC,IAAI,EAAE,CAAA;IAChB,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

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

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

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

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

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

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

package/dist/cjs/track/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/cjs/track/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Track',
+    description: 'Send Segment track events to Appcues.',
+    platform: 'web',
+    fields: {
+        event: {
+            label: 'Event Name',
+            description: 'The name of the event to track in Appcues.',
+            required: true,
+            type: 'string',
+            default: { '@path': '$.event' }
+        },
+        properties: {
+            label: 'Event Properties',
+            description: 'Properties to associate with the event.',
+            required: false,
+            type: 'object',
+            default: { '@path': '$.properties' }
+        }
+    },
+    defaultSubscription: 'type = "track"',
+    perform: (appcues, { payload }) => {
+        const { event, properties } = payload;
+        appcues.track(event, properties);
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/track/index.ts"],"names":[],"mappings":";;AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,uCAAuC;IACpD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,4CAA4C;YACzD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;SAChC;QACD,UAAU,EAAE;YACV,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE,yCAAyC;YACtD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE;SACrC;KACF;IACD,mBAAmB,EAAE,gBAAgB;IACrC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QACrC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;IAClC,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/cjs/types.d.ts

@@ -0,0 +1,18 @@
+declare global {
+    interface Window {
+        Appcues: Appcues;
+        AppcuesSettings: AppcuesSettings;
+    }
+}
+export interface Appcues {
+    track(event_name: string, properties?: Properties): void;
+    identify(userId: string, traits?: Properties): void;
+    group(groupId: string, traits?: Properties): void;
+    page(): void;
+}
+export interface AppcuesSettings {
+    enableURLDetection: boolean;
+}
+export type Properties = {
+    [k: string]: unknown;
+};

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/esm/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const URL: {
+    US: string;
+    EU: string;
+};

package/dist/esm/constants.js

@@ -0,0 +1,5 @@
+export const URL = {
+    US: "fast.appcues.com",
+    EU: "fast.eu.appcues.com"
+};
+//# 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,GAAG,GAAG;IACjB,EAAE,EAAE,kBAAkB;IACtB,EAAE,EAAE,qBAAqB;CAC1B,CAAA"}

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

@@ -0,0 +1,5 @@
+export interface Settings {
+    accountID: string;
+    region: string;
+    enableURLDetection: boolean;
+}

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

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

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

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

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

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

package/dist/esm/group/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/esm/group/index.js

@@ -0,0 +1,28 @@
+const action = {
+    title: 'Group',
+    description: 'Send Segment group events to Appcues.',
+    platform: 'web',
+    fields: {
+        groupId: {
+            label: 'Group ID',
+            description: 'The ID of the group to identify in Appcues.',
+            required: true,
+            type: 'string',
+            default: { '@path': '$.groupId' }
+        },
+        traits: {
+            label: 'Group traits',
+            description: 'Properties to associate with the group / account / company.',
+            required: false,
+            type: 'object',
+            default: { '@path': '$.traits' }
+        }
+    },
+    defaultSubscription: 'type = "group"',
+    perform: (appcues, { payload }) => {
+        const { groupId, traits } = payload;
+        appcues.group(groupId, traits);
+    }
+};
+export default action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/group/index.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,uCAAuC;IACpD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,OAAO,EAAE;YACP,KAAK,EAAE,UAAU;YACjB,WAAW,EAAE,6CAA6C;YAC1D,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;SAClC;QACD,MAAM,EAAE;YACN,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,6DAA6D;YAC1E,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;KACF;IACD,mBAAmB,EAAE,gBAAgB;IACrC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;QACnC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAChC,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

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

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

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

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

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

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

package/dist/esm/identify/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 type { Appcues } from '../types';
+declare const action: BrowserActionDefinition<Settings, Appcues, Payload>;
+export default action;

package/dist/esm/identify/index.js

@@ -0,0 +1,28 @@
+const action = {
+    title: 'Identify',
+    description: 'Send Segment identify events to Appcues.',
+    platform: 'web',
+    fields: {
+        userId: {
+            label: 'User ID',
+            description: 'The ID of the user to identify in Appcues.',
+            required: true,
+            type: 'string',
+            default: { '@path': '$.userId' }
+        },
+        traits: {
+            label: 'User traits',
+            description: 'Properties to associate with the user.',
+            required: false,
+            type: 'object',
+            default: { '@path': '$.traits' }
+        }
+    },
+    defaultSubscription: 'type = "identify"',
+    perform: (appcues, { payload }) => {
+        const { userId, traits } = payload;
+        appcues.identify(userId, traits);
+    }
+};
+export default action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/identify/index.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,GAAwD;IAClE,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,0CAA0C;IACvD,QAAQ,EAAE,KAAK;IACf,MAAM,EAAE;QACN,MAAM,EAAE;YACN,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,4CAA4C;YACzD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;QACD,MAAM,EAAE;YACN,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,wCAAwC;YACrD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;SACjC;KACF;IACD,mBAAmB,EAAE,mBAAmB;IACxC,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QAChC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;QAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,CAAC;CACF,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,63 @@
+import { browserDestination } from '@segment/browser-destination-runtime/shim';
+import track from './track';
+import page from './page';
+import identify from './identify';
+import group from './group';
+import { URL } from './constants';
+import { defaultValues } from '@segment/actions-core';
+export const destination = {
+    name: 'Appcues Web',
+    slug: 'appcues-web-actions',
+    mode: 'device',
+    settings: {
+        accountID: {
+            label: 'Appcues Account ID',
+            description: 'Your Appcues Account ID.',
+            type: 'password',
+            required: true
+        },
+        region: {
+            label: 'Region',
+            description: 'Select the Appcues region for your account.',
+            type: 'string',
+            required: true,
+            choices: [
+                { label: 'US', value: 'US' },
+                { label: 'EU', value: 'EU' }
+            ],
+            default: 'US'
+        },
+        enableURLDetection: {
+            label: 'Enable URL Detection',
+            description: 'Enable or disable URL detection in Appcues. If enabled, page events should not be triggered manually using the page action.',
+            type: 'boolean',
+            required: true,
+            default: false
+        }
+    },
+    initialize: async ({ settings }, deps) => {
+        const { region, accountID, enableURLDetection } = settings;
+        const url = region === 'EU' ? URL.EU : URL.US;
+        window.AppcuesSettings = { enableURLDetection };
+        await deps.loadScript(`//${url}/${accountID}.js`);
+        await deps.resolveWhen(() => Object.prototype.hasOwnProperty.call(window, 'Appcues'), 100);
+        return window.Appcues;
+    },
+    presets: [
+        {
+            name: 'Page',
+            subscribe: 'type = "page"',
+            partnerAction: 'page',
+            mapping: defaultValues(page.fields),
+            type: 'automatic'
+        }
+    ],
+    actions: {
+        track,
+        page,
+        identify,
+        group
+    }
+};
+export default browserDestination(destination);
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAE9E,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,IAAI,MAAM,QAAQ,CAAA;AACzB,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAErD,MAAM,CAAC,MAAM,WAAW,GAAoD;IAC1E,IAAI,EAAE,aAAa;IACnB,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE;QACR,SAAS,EAAE;YACT,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAE;YACN,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,6CAA6C;YAC1D,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;gBAC5B,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;aAC7B;YACD,OAAO,EAAE,IAAI;SACd;QACD,kBAAkB,EAAE;YAClB,KAAK,EAAE,sBAAsB;YAC7B,WAAW,EAAE,6HAA6H;YAC1I,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;SACf;KACF;IACD,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE;QACvC,MAAM,EACJ,MAAM,EACN,SAAS,EACT,kBAAkB,EACnB,GAAG,QAAQ,CAAA;QACZ,MAAM,GAAG,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAA;QAC7C,MAAM,CAAC,eAAe,GAAG,EAAE,kBAAkB,EAAE,CAAA;QAC/C,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI,SAAS,KAAK,CAAC,CAAA;QACjD,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,CAAC,CAAA;QAC1F,OAAO,MAAM,CAAC,OAAO,CAAA;IACvB,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,MAAM;YACZ,SAAS,EAAE,eAAe;YAC1B,aAAa,EAAE,MAAM;YACrB,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;YACnC,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,KAAK;QACL,IAAI;QACJ,QAAQ;QACR,KAAK;KACN;CACF,CAAA;AAED,eAAe,kBAAkB,CAAC,WAAW,CAAC,CAAA"}

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

@@ -0,0 +1,2 @@
+export interface Payload {
+}

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

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