@walkeros/server-destination-mparticle 3.4.0-next-1776749829492

package/dist/examples/index.js

@@ -0,0 +1,227 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  env: () => env_exports,
+  step: () => step_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+var mockSendServer = async () => {
+  return {
+    ok: true,
+    data: {}
+  };
+};
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  commercePurchase: () => commercePurchase,
+  customEvent: () => customEvent,
+  identityAndAttributes: () => identityAndAttributes,
+  screenView: () => screenView
+});
+var import_core = require("@walkeros/core");
+var ENDPOINT = "https://s2s.mparticle.com/v2/events";
+var OPTIONS = {
+  headers: {
+    // Basic base64('key:secret')
+    Authorization: "Basic a2V5OnNlY3JldA==",
+    "Content-Type": "application/json"
+  }
+};
+var customEvent = {
+  in: (0, import_core.getEvent)("product view", {
+    timestamp: 17000001e5,
+    data: { id: "SKU-A1", name: "Shoe", price: 129.99 },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "custom_event",
+            data: {
+              event_name: "product view",
+              custom_event_type: "other",
+              timestamp_unixtime_ms: 17000001e5,
+              source_message_id: "1700000100000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000100000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var screenView = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 17000002e5,
+    data: { title: "Checkout", path: "/checkout" },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: {
+    settings: { eventType: "screen_view" }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "screen_view",
+            data: {
+              screen_name: "page view",
+              timestamp_unixtime_ms: 17000002e5,
+              source_message_id: "1700000200000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000200000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var commercePurchase = {
+  in: (0, import_core.getEvent)("order complete", {
+    timestamp: 17000003e5,
+    data: { id: "ORD-300", total: 249.99, currency: "EUR" },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: {
+    settings: {
+      eventType: "commerce_event",
+      commerce: {
+        map: {
+          currency_code: "data.currency",
+          product_action: {
+            map: {
+              action: { value: "purchase" },
+              transaction_id: "data.id",
+              total_amount: "data.total"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "commerce_event",
+            data: {
+              currency_code: "EUR",
+              product_action: {
+                action: "purchase",
+                transaction_id: "ORD-300",
+                total_amount: 249.99
+              },
+              timestamp_unixtime_ms: 17000003e5,
+              source_message_id: "1700000300000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000300000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var identityAndAttributes = {
+  in: (0, import_core.getEvent)("form submit", {
+    timestamp: 17000004e5,
+    data: { type: "newsletter" },
+    user: {
+      id: "user-123",
+      email: "user@example.com"
+    },
+    source: { type: "server", id: "https://example.com", previous_id: "" }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "custom_event",
+            data: {
+              event_name: "form submit",
+              custom_event_type: "other",
+              timestamp_unixtime_ms: 17000004e5,
+              source_message_id: "1700000400000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123",
+          email: "user@example.com"
+        },
+        source_request_id: "1700000400000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});

package/dist/examples/index.mjs

@@ -0,0 +1,205 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+var mockSendServer = async () => {
+  return {
+    ok: true,
+    data: {}
+  };
+};
+var push = {
+  sendServer: mockSendServer
+};
+var simulation = ["sendServer"];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  commercePurchase: () => commercePurchase,
+  customEvent: () => customEvent,
+  identityAndAttributes: () => identityAndAttributes,
+  screenView: () => screenView
+});
+import { getEvent } from "@walkeros/core";
+var ENDPOINT = "https://s2s.mparticle.com/v2/events";
+var OPTIONS = {
+  headers: {
+    // Basic base64('key:secret')
+    Authorization: "Basic a2V5OnNlY3JldA==",
+    "Content-Type": "application/json"
+  }
+};
+var customEvent = {
+  in: getEvent("product view", {
+    timestamp: 17000001e5,
+    data: { id: "SKU-A1", name: "Shoe", price: 129.99 },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "custom_event",
+            data: {
+              event_name: "product view",
+              custom_event_type: "other",
+              timestamp_unixtime_ms: 17000001e5,
+              source_message_id: "1700000100000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000100000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var screenView = {
+  in: getEvent("page view", {
+    timestamp: 17000002e5,
+    data: { title: "Checkout", path: "/checkout" },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: {
+    settings: { eventType: "screen_view" }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "screen_view",
+            data: {
+              screen_name: "page view",
+              timestamp_unixtime_ms: 17000002e5,
+              source_message_id: "1700000200000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000200000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var commercePurchase = {
+  in: getEvent("order complete", {
+    timestamp: 17000003e5,
+    data: { id: "ORD-300", total: 249.99, currency: "EUR" },
+    user: { id: "user-123" },
+    source: { type: "server", id: "https://shop.example.com", previous_id: "" }
+  }),
+  mapping: {
+    settings: {
+      eventType: "commerce_event",
+      commerce: {
+        map: {
+          currency_code: "data.currency",
+          product_action: {
+            map: {
+              action: { value: "purchase" },
+              transaction_id: "data.id",
+              total_amount: "data.total"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "commerce_event",
+            data: {
+              currency_code: "EUR",
+              product_action: {
+                action: "purchase",
+                transaction_id: "ORD-300",
+                total_amount: 249.99
+              },
+              timestamp_unixtime_ms: 17000003e5,
+              source_message_id: "1700000300000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123"
+        },
+        source_request_id: "1700000300000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+var identityAndAttributes = {
+  in: getEvent("form submit", {
+    timestamp: 17000004e5,
+    data: { type: "newsletter" },
+    user: {
+      id: "user-123",
+      email: "user@example.com"
+    },
+    source: { type: "server", id: "https://example.com", previous_id: "" }
+  }),
+  mapping: void 0,
+  out: [
+    [
+      "sendServer",
+      ENDPOINT,
+      JSON.stringify({
+        events: [
+          {
+            event_type: "custom_event",
+            data: {
+              event_name: "form submit",
+              custom_event_type: "other",
+              timestamp_unixtime_ms: 17000004e5,
+              source_message_id: "1700000400000-gr0up-1"
+            }
+          }
+        ],
+        environment: "production",
+        user_identities: {
+          customer_id: "user-123",
+          email: "user@example.com"
+        },
+        source_request_id: "1700000400000-gr0up-1"
+      }),
+      OPTIONS
+    ]
+  ]
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.d.mts

@@ -0,0 +1,240 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer, sendServer } from '@walkeros/server-core';
+
+/**
+ * mParticle data pod. Determines the regional endpoint used for the Events
+ * API. Defaults to `us1`. See {@link buildEndpoint} in `batch.ts`.
+ */
+type Pod = 'us1' | 'us2' | 'eu1' | 'au1';
+/**
+ * mParticle environment for the batch. `production` routes to production
+ * data streams; `development` sends to debug/verify streams.
+ */
+type Environment = 'production' | 'development';
+/**
+ * Event type used for the outgoing mParticle event. Defaults to
+ * `custom_event` when not explicitly mapped via rule settings.
+ */
+type EventType = 'custom_event' | 'screen_view' | 'commerce_event';
+/**
+ * mParticle custom event type (category) for `custom_event`s. Defaults to
+ * `other` when not specified.
+ */
+type CustomEventType = 'navigation' | 'location' | 'search' | 'transaction' | 'user_content' | 'user_preference' | 'social' | 'media' | 'attribution' | 'other';
+/**
+ * mParticle product action verbs for commerce events.
+ */
+type ProductActionType = 'add_to_cart' | 'remove_from_cart' | 'checkout' | 'checkout_option' | 'click' | 'view_detail' | 'purchase' | 'refund' | 'add_to_wishlist' | 'remove_from_wishlist';
+interface Settings {
+    /** mParticle input feed API key. */
+    apiKey: string;
+    /** mParticle input feed API secret. */
+    apiSecret: string;
+    /** Data pod selecting the regional endpoint. Default: `us1`. */
+    pod?: Pod;
+    /** Environment the batch targets. Default: `production`. */
+    environment?: Environment;
+    /**
+     * Mapping that resolves to `user_identities` per batch. Each entry value
+     * is a walkerOS mapping value; the resolved object is placed into the
+     * mParticle batch `user_identities` envelope.
+     */
+    userIdentities?: Mapping$1.Map;
+    /**
+     * Mapping that resolves to `user_attributes` per batch.
+     */
+    userAttributes?: Mapping$1.Value;
+    /**
+     * Optional static consent state passthrough — shape is forwarded verbatim
+     * to `consent_state` on the batch.
+     */
+    consent?: ConsentState;
+    /** walkerOS mapping value resolving to the client IP for the batch. */
+    ip?: Mapping$1.Value;
+    /**
+     * Optional request correlation id. When omitted, falls back to `event.id`.
+     */
+    sourceRequestId?: Mapping$1.Value;
+}
+type InitSettings = Partial<Settings>;
+/**
+ * Per-rule mapping settings. Determines which mParticle event shape is
+ * produced for this walkerOS event and allows per-event identity overrides.
+ */
+interface Mapping {
+    /** Event type. Default: `custom_event`. */
+    eventType?: EventType;
+    /** Custom event type category for `custom_event`. Default: `other`. */
+    customEventType?: CustomEventType;
+    /** Commerce mapping resolving to ProductAction and related fields. */
+    commerce?: Mapping$1.Value;
+    /** Per-event override for `user_identities`. Merged over settings. */
+    userIdentities?: Mapping$1.Map;
+    /** Per-event override for `user_attributes`. */
+    userAttributes?: Mapping$1.Value;
+}
+interface Env extends DestinationServer.Env {
+    sendServer?: typeof sendServer;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+interface Destination extends DestinationServer.Destination<Types> {
+    init: DestinationServer.InitFn<Types>;
+}
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type InitFn = DestinationServer.InitFn<Types>;
+type PushFn = DestinationServer.PushFn<Types>;
+type PartialConfig = DestinationServer.PartialConfig<Types>;
+type PushEvents = DestinationServer.PushEvents<Mapping>;
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+/**
+ * Top-level mParticle batch payload posted to
+ * `https://s2s.{pod}.mparticle.com/v2/events`.
+ * https://docs.mparticle.com/developers/server/http/
+ */
+interface MParticleBatch {
+    events: MParticleEvent[];
+    user_identities?: Record<string, string | number>;
+    user_attributes?: Record<string, unknown>;
+    environment: Environment;
+    schema_version?: number;
+    ip?: string;
+    source_request_id?: string;
+    consent_state?: ConsentState;
+    context?: Record<string, unknown>;
+}
+type MParticleEvent = {
+    event_type: 'custom_event';
+    data: CustomEventData;
+} | {
+    event_type: 'screen_view';
+    data: ScreenViewEventData;
+} | {
+    event_type: 'commerce_event';
+    data: CommerceEventData;
+};
+interface CommonEventData {
+    timestamp_unixtime_ms?: number;
+    source_message_id?: string;
+    session_uuid?: string;
+    custom_attributes?: Record<string, unknown>;
+    custom_flags?: Record<string, unknown>;
+    location?: Record<string, unknown>;
+}
+interface CustomEventData extends CommonEventData {
+    event_name: string;
+    custom_event_type: CustomEventType;
+}
+interface ScreenViewEventData extends CommonEventData {
+    screen_name?: string;
+}
+interface CommerceEventData extends CommonEventData {
+    product_action?: ProductAction;
+    promotion_action?: PromotionAction;
+    product_impressions?: ProductImpression[];
+    currency_code?: string;
+    is_non_interactive?: boolean;
+}
+interface ProductAction {
+    action: ProductActionType;
+    transaction_id?: string;
+    total_amount?: number;
+    tax_amount?: number;
+    shipping_amount?: number;
+    coupon_code?: string;
+    affiliation?: string;
+    checkout_step?: number;
+    checkout_options?: string;
+    products?: Product[];
+}
+interface Product {
+    id?: string;
+    name?: string;
+    brand?: string;
+    category?: string;
+    variant?: string;
+    position?: number;
+    price?: number;
+    quantity?: number;
+    coupon_code?: string;
+    total_product_amount?: number;
+    custom_attributes?: Record<string, unknown>;
+}
+interface PromotionAction {
+    action: 'view' | 'click';
+    promotions?: Array<{
+        id?: string;
+        name?: string;
+        creative?: string;
+        position?: string;
+    }>;
+}
+interface ProductImpression {
+    product_impression_list?: string;
+    products?: Product[];
+}
+/**
+ * mParticle consent state envelope forwarded verbatim on the batch.
+ * https://docs.mparticle.com/developers/server/http/#consent-state
+ */
+interface ConsentState {
+    gdpr?: Record<string, GDPRConsentState>;
+    ccpa?: {
+        data_sale_opt_out?: CCPAConsentState;
+    };
+}
+interface GDPRConsentState {
+    consented: boolean;
+    document?: string;
+    timestamp_unixtime_ms?: number;
+    location?: string;
+    hardware_id?: string;
+}
+interface CCPAConsentState {
+    consented: boolean;
+    document?: string;
+    timestamp_unixtime_ms?: number;
+    location?: string;
+    hardware_id?: string;
+}
+
+type index_CCPAConsentState = CCPAConsentState;
+type index_CommerceEventData = CommerceEventData;
+type index_CommonEventData = CommonEventData;
+type index_Config = Config;
+type index_ConsentState = ConsentState;
+type index_CustomEventData = CustomEventData;
+type index_CustomEventType = CustomEventType;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_Environment = Environment;
+type index_EventType = EventType;
+type index_GDPRConsentState = GDPRConsentState;
+type index_InitFn = InitFn;
+type index_InitSettings = InitSettings;
+type index_MParticleBatch = MParticleBatch;
+type index_MParticleEvent = MParticleEvent;
+type index_Mapping = Mapping;
+type index_PartialConfig = PartialConfig;
+type index_Pod = Pod;
+type index_Product = Product;
+type index_ProductAction = ProductAction;
+type index_ProductActionType = ProductActionType;
+type index_ProductImpression = ProductImpression;
+type index_PromotionAction = PromotionAction;
+type index_PushEvents = PushEvents;
+type index_PushFn = PushFn;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_ScreenViewEventData = ScreenViewEventData;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_CCPAConsentState as CCPAConsentState, index_CommerceEventData as CommerceEventData, index_CommonEventData as CommonEventData, index_Config as Config, index_ConsentState as ConsentState, index_CustomEventData as CustomEventData, index_CustomEventType as CustomEventType, index_Destination as Destination, index_Env as Env, index_Environment as Environment, index_EventType as EventType, index_GDPRConsentState as GDPRConsentState, index_InitFn as InitFn, index_InitSettings as InitSettings, index_MParticleBatch as MParticleBatch, index_MParticleEvent as MParticleEvent, index_Mapping as Mapping, index_PartialConfig as PartialConfig, index_Pod as Pod, index_Product as Product, index_ProductAction as ProductAction, index_ProductActionType as ProductActionType, index_ProductImpression as ProductImpression, index_PromotionAction as PromotionAction, index_PushEvents as PushEvents, index_PushFn as PushFn, index_Rule as Rule, index_Rules as Rules, index_ScreenViewEventData as ScreenViewEventData, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationMParticle: Destination;
+
+export { index as DestinationMParticle, destinationMParticle as default, destinationMParticle };