@walkeros/web-destination-meta 0.0.0-next-20251219153324

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elbWalker GmbH
+
+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.

package/README.md

@@ -0,0 +1,96 @@
+<p align="left">
+  <a href="https://www.walkeros.io">
+    <img title="elbwalker" src="https://www.walkeros.io/img/elbwalker_logo.png" width="256px"/>
+  </a>
+</p>
+
+# Meta Pixel Destination for walkerOS
+
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/meta)
+&bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-meta)
+
+This package provides a Meta Pixel (formerly Facebook Pixel) destination for
+walkerOS. It sends events to Meta Pixel to track visitor activity and
+conversions for Facebook and Instagram advertising campaigns.
+
+walkerOS follows a **source → collector → destination** architecture. This Meta
+Pixel destination receives processed events from the walkerOS collector and
+transforms them into Meta's Pixel API format, handling conversion events, custom
+events, and audience building data to optimize your Meta advertising campaigns.
+
+## Installation
+
+```sh
+npm install @walkeros/web-destination-meta
+```
+
+## Quick Start
+
+Configure in your Flow JSON:
+
+```json
+{
+  "version": 1,
+  "flows": {
+    "default": {
+      "web": {},
+      "destinations": {
+        "meta": {
+          "package": "@walkeros/web-destination-meta",
+          "config": {
+            "settings": { "pixelId": "1234567890" },
+            "loadScript": true
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+Or programmatically:
+
+```typescript
+import { startFlow } from '@walkeros/collector';
+import { destinationMeta } from '@walkeros/web-destination-meta';
+
+const { elb } = await startFlow({
+  destinations: [
+    {
+      destination: destinationMeta,
+      config: {
+        settings: { pixelId: '1234567890' },
+        loadScript: true,
+      },
+    },
+  ],
+});
+```
+
+## Configuration
+
+| Name         | Type      | Description                                                       | Required | Example        |
+| ------------ | --------- | ----------------------------------------------------------------- | -------- | -------------- |
+| `pixelId`    | `string`  | Your Meta Pixel ID from Facebook Business Manager                 | Yes      | `'1234567890'` |
+| `loadScript` | `boolean` | Whether to automatically load the Meta Pixel script (fbevents.js) | No       | `true`         |
+
+## Type Definitions
+
+See [src/types/](./src/types/) for TypeScript interfaces.
+
+## Related
+
+- [Website Documentation](https://www.walkeros.io/docs/destinations/web/meta/)
+- [Destination Interface](../../../core/src/types/destination.ts)
+
+## Contribute
+
+Feel free to contribute by submitting an
+[issue](https://github.com/elbwalker/walkerOS/issues), starting a
+[discussion](https://github.com/elbwalker/walkerOS/discussions), or getting in
+[contact](https://calendly.com/elb-alexander/30min).
+
+## License
+
+This project is licensed under the MIT License.

package/dist/dev.d.mts

@@ -0,0 +1,161 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { Mapping as Mapping$2 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+/**
+ * Meta Pixel ID
+ * Must be a numeric string (Facebook Pixel IDs are numeric)
+ */
+declare const PixelId: z.ZodString;
+/**
+ * Meta Pixel Standard Event Names
+ * https://developers.facebook.com/docs/meta-pixel/reference
+ */
+declare const StandardEventName: z.ZodEnum<{
+    PageView: "PageView";
+    AddPaymentInfo: "AddPaymentInfo";
+    AddToCart: "AddToCart";
+    AddToWishlist: "AddToWishlist";
+    CompleteRegistration: "CompleteRegistration";
+    Contact: "Contact";
+    CustomizeProduct: "CustomizeProduct";
+    Donate: "Donate";
+    FindLocation: "FindLocation";
+    InitiateCheckout: "InitiateCheckout";
+    Lead: "Lead";
+    Purchase: "Purchase";
+    Schedule: "Schedule";
+    Search: "Search";
+    StartTrial: "StartTrial";
+    SubmitApplication: "SubmitApplication";
+    Subscribe: "Subscribe";
+    ViewContent: "ViewContent";
+}>;
+/**
+ * Custom Event Name
+ * Any string for custom tracking
+ */
+declare const CustomEventName: z.ZodString;
+
+declare const SettingsSchema: z.ZodObject<{
+    pixelId: z.ZodString;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    track: z.ZodOptional<z.ZodEnum<{
+        PageView: "PageView";
+        AddPaymentInfo: "AddPaymentInfo";
+        AddToCart: "AddToCart";
+        AddToWishlist: "AddToWishlist";
+        CompleteRegistration: "CompleteRegistration";
+        Contact: "Contact";
+        CustomizeProduct: "CustomizeProduct";
+        Donate: "Donate";
+        FindLocation: "FindLocation";
+        InitiateCheckout: "InitiateCheckout";
+        Lead: "Lead";
+        Purchase: "Purchase";
+        Schedule: "Schedule";
+        Search: "Search";
+        StartTrial: "StartTrial";
+        SubmitApplication: "SubmitApplication";
+        Subscribe: "Subscribe";
+        ViewContent: "ViewContent";
+    }>>;
+    trackCustom: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Mapping$1 = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping$1: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_CustomEventName: typeof CustomEventName;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_PixelId: typeof PixelId;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_StandardEventName: typeof StandardEventName;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { index$1_CustomEventName as CustomEventName, type Mapping$1 as Mapping, index$1_MappingSchema as MappingSchema, index$1_PixelId as PixelId, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_StandardEventName as StandardEventName, mapping$1 as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        _fbq?: facebook.Pixel.Event;
+        fbq?: facebook.Pixel.Event;
+    }
+}
+interface Mapping {
+    track?: StandardEventNames;
+    trackCustom?: string;
+}
+interface Env extends DestinationWeb.Env {
+    window: {
+        fbq: facebook.Pixel.Event;
+        _fbq?: facebook.Pixel.Event;
+    };
+    document: {
+        createElement: (tagName: string) => Element;
+        head: {
+            appendChild: (node: unknown) => void;
+        };
+    };
+}
+type Rule = Mapping$2.Rule<Mapping>;
+type StandardEventNames = 'PageView' | 'AddPaymentInfo' | 'AddToCart' | 'AddToWishlist' | 'CompleteRegistration' | 'Contact' | 'CustomizeProduct' | 'Donate' | 'FindLocation' | 'InitiateCheckout' | 'Lead' | 'Purchase' | 'Schedule' | 'Search' | 'StartTrial' | 'SubmitApplication' | 'Subscribe' | 'ViewContent' | string;
+
+declare const init: Env | undefined;
+declare const push: Env;
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_init as init, env_push as push };
+}
+
+declare function Purchase$1(): unknown[];
+declare function AddToCart$1(): unknown[];
+declare function InitiateCheckout$1(): unknown[];
+declare function ViewContent$1(): unknown[];
+
+declare namespace events {
+  export { AddToCart$1 as AddToCart, InitiateCheckout$1 as InitiateCheckout, Purchase$1 as Purchase, ViewContent$1 as ViewContent };
+}
+
+declare const Purchase: Rule;
+declare const AddToCart: Rule;
+declare const InitiateCheckout: Rule;
+declare const ViewContent: Rule;
+declare const config: {
+    order: {
+        complete: Rule;
+    };
+    product: {
+        view: Rule;
+        add: Rule;
+    };
+    cart: {
+        view: Rule;
+    };
+};
+
+declare const mapping_AddToCart: typeof AddToCart;
+declare const mapping_InitiateCheckout: typeof InitiateCheckout;
+declare const mapping_Purchase: typeof Purchase;
+declare const mapping_ViewContent: typeof ViewContent;
+declare const mapping_config: typeof config;
+declare namespace mapping {
+  export { mapping_AddToCart as AddToCart, mapping_InitiateCheckout as InitiateCheckout, mapping_Purchase as Purchase, mapping_ViewContent as ViewContent, mapping_config as config };
+}
+
+declare const index_env: typeof env;
+declare const index_events: typeof events;
+declare const index_mapping: typeof mapping;
+declare namespace index {
+  export { index_env as env, index_events as events, index_mapping as mapping };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,161 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { Mapping as Mapping$2 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+/**
+ * Meta Pixel ID
+ * Must be a numeric string (Facebook Pixel IDs are numeric)
+ */
+declare const PixelId: z.ZodString;
+/**
+ * Meta Pixel Standard Event Names
+ * https://developers.facebook.com/docs/meta-pixel/reference
+ */
+declare const StandardEventName: z.ZodEnum<{
+    PageView: "PageView";
+    AddPaymentInfo: "AddPaymentInfo";
+    AddToCart: "AddToCart";
+    AddToWishlist: "AddToWishlist";
+    CompleteRegistration: "CompleteRegistration";
+    Contact: "Contact";
+    CustomizeProduct: "CustomizeProduct";
+    Donate: "Donate";
+    FindLocation: "FindLocation";
+    InitiateCheckout: "InitiateCheckout";
+    Lead: "Lead";
+    Purchase: "Purchase";
+    Schedule: "Schedule";
+    Search: "Search";
+    StartTrial: "StartTrial";
+    SubmitApplication: "SubmitApplication";
+    Subscribe: "Subscribe";
+    ViewContent: "ViewContent";
+}>;
+/**
+ * Custom Event Name
+ * Any string for custom tracking
+ */
+declare const CustomEventName: z.ZodString;
+
+declare const SettingsSchema: z.ZodObject<{
+    pixelId: z.ZodString;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+declare const MappingSchema: z.ZodObject<{
+    track: z.ZodOptional<z.ZodEnum<{
+        PageView: "PageView";
+        AddPaymentInfo: "AddPaymentInfo";
+        AddToCart: "AddToCart";
+        AddToWishlist: "AddToWishlist";
+        CompleteRegistration: "CompleteRegistration";
+        Contact: "Contact";
+        CustomizeProduct: "CustomizeProduct";
+        Donate: "Donate";
+        FindLocation: "FindLocation";
+        InitiateCheckout: "InitiateCheckout";
+        Lead: "Lead";
+        Purchase: "Purchase";
+        Schedule: "Schedule";
+        Search: "Search";
+        StartTrial: "StartTrial";
+        SubmitApplication: "SubmitApplication";
+        Subscribe: "Subscribe";
+        ViewContent: "ViewContent";
+    }>>;
+    trackCustom: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Mapping$1 = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping$1: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_CustomEventName: typeof CustomEventName;
+declare const index$1_MappingSchema: typeof MappingSchema;
+declare const index$1_PixelId: typeof PixelId;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_StandardEventName: typeof StandardEventName;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { index$1_CustomEventName as CustomEventName, type Mapping$1 as Mapping, index$1_MappingSchema as MappingSchema, index$1_PixelId as PixelId, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_StandardEventName as StandardEventName, mapping$1 as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        _fbq?: facebook.Pixel.Event;
+        fbq?: facebook.Pixel.Event;
+    }
+}
+interface Mapping {
+    track?: StandardEventNames;
+    trackCustom?: string;
+}
+interface Env extends DestinationWeb.Env {
+    window: {
+        fbq: facebook.Pixel.Event;
+        _fbq?: facebook.Pixel.Event;
+    };
+    document: {
+        createElement: (tagName: string) => Element;
+        head: {
+            appendChild: (node: unknown) => void;
+        };
+    };
+}
+type Rule = Mapping$2.Rule<Mapping>;
+type StandardEventNames = 'PageView' | 'AddPaymentInfo' | 'AddToCart' | 'AddToWishlist' | 'CompleteRegistration' | 'Contact' | 'CustomizeProduct' | 'Donate' | 'FindLocation' | 'InitiateCheckout' | 'Lead' | 'Purchase' | 'Schedule' | 'Search' | 'StartTrial' | 'SubmitApplication' | 'Subscribe' | 'ViewContent' | string;
+
+declare const init: Env | undefined;
+declare const push: Env;
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_init as init, env_push as push };
+}
+
+declare function Purchase$1(): unknown[];
+declare function AddToCart$1(): unknown[];
+declare function InitiateCheckout$1(): unknown[];
+declare function ViewContent$1(): unknown[];
+
+declare namespace events {
+  export { AddToCart$1 as AddToCart, InitiateCheckout$1 as InitiateCheckout, Purchase$1 as Purchase, ViewContent$1 as ViewContent };
+}
+
+declare const Purchase: Rule;
+declare const AddToCart: Rule;
+declare const InitiateCheckout: Rule;
+declare const ViewContent: Rule;
+declare const config: {
+    order: {
+        complete: Rule;
+    };
+    product: {
+        view: Rule;
+        add: Rule;
+    };
+    cart: {
+        view: Rule;
+    };
+};
+
+declare const mapping_AddToCart: typeof AddToCart;
+declare const mapping_InitiateCheckout: typeof InitiateCheckout;
+declare const mapping_Purchase: typeof Purchase;
+declare const mapping_ViewContent: typeof ViewContent;
+declare const mapping_config: typeof config;
+declare namespace mapping {
+  export { mapping_AddToCart as AddToCart, mapping_InitiateCheckout as InitiateCheckout, mapping_Purchase as Purchase, mapping_ViewContent as ViewContent, mapping_config as config };
+}
+
+declare const index_env: typeof env;
+declare const index_events: typeof events;
+declare const index_mapping: typeof mapping;
+declare namespace index {
+  export { index_env as env, index_events as events, index_mapping as mapping };
+}
+
+export { index as examples, index$1 as schemas };