@walkeros/web-destination-meta
Version:
Meta pixel web destination for walkerOS
1 lines • 12.7 kB
Source Map (JSON)
{"version":3,"sources":["../src/setup.ts","../src/types/index.ts","../src/examples/index.ts","../src/examples/events.ts","../src/examples/mapping.ts","../src/index.ts"],"sourcesContent":["export function addScript(\n src = 'https://connect.facebook.net/en_US/fbevents.js',\n) {\n const script = document.createElement('script');\n script.src = src;\n script.async = true;\n document.head.appendChild(script);\n}\n\ninterface FBQFunction {\n (...args: unknown[]): void;\n callMethod?: (this: FBQFunction, ...args: unknown[]) => void;\n queue: unknown[];\n push: FBQFunction;\n loaded: boolean;\n version: string;\n}\n\nexport function setup() {\n const w = window as unknown as {\n fbq?: FBQFunction;\n _fbq?: FBQFunction;\n };\n if (w.fbq as unknown) return;\n\n const n = function (...args: unknown[]): void {\n n.callMethod ? n.callMethod.apply(n, args) : n.queue.push(args);\n } as FBQFunction;\n\n w.fbq = n;\n if (!w._fbq) w._fbq = n;\n n.push = n;\n n.loaded = true;\n n.version = '2.0';\n n.queue = [];\n}\n","import type { Mapping as WalkerOSMapping, Elb } from '@walkeros/core';\nimport type { DestinationWeb } from '@walkeros/web-core';\n\ndeclare global {\n // Augment the global WalkerOS namespace with destination-specific types\n namespace WalkerOS {\n interface Elb extends Elb.RegisterDestination<Destination, Config> {}\n }\n\n interface Window {\n _fbq?: facebook.Pixel.Event;\n fbq?: facebook.Pixel.Event;\n }\n}\n\nexport type Destination = DestinationWeb.Destination<Settings, Mapping>;\nexport type Config = DestinationWeb.Config<Settings, Mapping>;\n\n// Destination-specific settings (internal usage)\nexport interface Settings {\n pixelId?: string; // Required pixel id\n}\n\n// Single event transformation rule\nexport interface Mapping {\n track?: StandardEventNames; // Name of a standard event to track\n trackCustom?: string; // Name of a custom event to track\n}\n\nexport type Rule = WalkerOSMapping.Rule<Mapping>;\nexport type Rules = WalkerOSMapping.Rules<Rule>;\n\nexport type StandardEventNames =\n | 'PageView'\n | 'AddPaymentInfo'\n | 'AddToCart'\n | 'AddToWishlist'\n | 'CompleteRegistration'\n | 'Contact'\n | 'CustomizeProduct'\n | 'Donate'\n | 'FindLocation'\n | 'InitiateCheckout'\n | 'Lead'\n | 'Purchase'\n | 'Schedule'\n | 'Search'\n | 'StartTrial'\n | 'SubmitApplication'\n | 'Subscribe'\n | 'ViewContent'\n | string;\n","import * as events from './events';\nimport * as mapping from './mapping';\n\nexport const destinationMetaExamples = {\n events,\n mapping,\n};\n","import { getEvent } from '@walkeros/core';\n\nexport function Purchase(): unknown[] {\n const event = getEvent('order complete');\n\n return [\n 'track',\n 'Purchase',\n {\n value: event.data.total,\n currency: 'EUR',\n contents: event.nested\n .filter((item) => item.type === 'product')\n .map((item) => ({ id: item.data.id, quantity: 1 })),\n content_type: 'product',\n num_items: 2,\n },\n { eventID: event.id },\n ];\n}\n\nexport function AddToCart(): unknown[] {\n const event = getEvent('product add');\n\n return [\n 'track',\n 'AddToCart',\n {\n currency: 'EUR',\n value: event.data.price,\n contents: [{ id: event.data.id, quantity: 1 }],\n content_type: 'product',\n },\n { eventID: event.id },\n ];\n}\n\nexport function InitiateCheckout(): unknown[] {\n const event = getEvent('cart view');\n\n return [\n 'track',\n 'InitiateCheckout',\n {\n currency: 'EUR',\n value: event.data.value,\n contents: event.nested\n .filter((entity) => entity.type === 'product')\n .map((entity) => ({\n id: entity.data.id,\n quantity: entity.data.quantity,\n })),\n num_items: event.nested.filter((item) => item.type === 'product').length,\n },\n { eventID: event.id },\n ];\n}\n\nexport function ViewContent(): unknown[] {\n const event = getEvent('product view');\n\n return [\n 'track',\n 'ViewContent',\n {\n currency: 'EUR',\n value: event.data.price,\n contents: [{ id: event.data.id, quantity: 1 }],\n content_type: 'product',\n },\n { eventID: event.id },\n ];\n}\n","import type { Mapping, WalkerOS } from '@walkeros/core';\nimport type { DestinationMeta } from '..';\nimport { isObject } from '@walkeros/core';\n\nexport const Purchase: DestinationMeta.Rule = {\n name: 'Purchase',\n data: {\n map: {\n value: 'data.total',\n currency: { value: 'EUR' },\n contents: {\n loop: [\n 'nested',\n {\n condition: (entity) =>\n isObject(entity) && entity.type === 'product',\n map: {\n id: 'data.id',\n quantity: { key: 'data.quantity', value: 1 },\n },\n },\n ],\n },\n content_type: { value: 'product' },\n num_items: {\n fn: (event) =>\n (event as WalkerOS.Event).nested.filter(\n (item) => item.type === 'product',\n ).length,\n },\n },\n },\n};\n\nexport const AddToCart: DestinationMeta.Rule = {\n name: 'AddToCart',\n data: {\n map: {\n value: 'data.price',\n currency: { value: 'EUR' },\n contents: {\n set: [\n {\n map: {\n id: 'data.id',\n quantity: { key: 'data.quantity', value: 1 },\n },\n },\n ],\n },\n content_type: { value: 'product' },\n },\n },\n};\n\nexport const InitiateCheckout: DestinationMeta.Rule = {\n name: 'InitiateCheckout',\n data: {\n map: {\n value: 'data.value',\n currency: { value: 'EUR' },\n contents: {\n loop: [\n 'nested',\n {\n condition: (entity) =>\n isObject(entity) && entity.type === 'product',\n map: {\n id: 'data.id',\n quantity: { key: 'data.quantity', value: 1 },\n },\n },\n ],\n },\n num_items: {\n fn: (event) =>\n (event as WalkerOS.Event).nested.filter(\n (item) => item.type === 'product',\n ).length,\n },\n },\n },\n};\n\nexport const ViewContent: DestinationMeta.Rule = {\n name: 'ViewContent',\n data: {\n map: {\n value: 'data.price',\n currency: { value: 'EUR' },\n content_type: { value: 'product' },\n contents: {\n set: [\n {\n map: {\n id: 'data.id',\n quantity: { key: 'data.quantity', value: 1 },\n },\n },\n ],\n },\n },\n },\n};\n\nexport const config = {\n order: { complete: Purchase },\n product: { view: ViewContent, add: AddToCart },\n cart: { view: InitiateCheckout },\n} satisfies DestinationMeta.Rules;\n","import type { Settings, Destination } from './types';\nimport { addScript, setup } from './setup';\nimport { isObject } from '@walkeros/core';\n\n// Types\nexport * as DestinationMeta from './types';\n\n// Examples\nexport * as destinationMetaExamples from './examples';\n\nexport const destinationMeta: Destination = {\n type: 'meta-pixel',\n\n config: {},\n\n init({ config, wrap }) {\n const { settings = {} as Partial<Settings>, loadScript } = config;\n const { pixelId } = settings;\n\n // Load Meta Pixel script if required (fbevents.js)\n if (loadScript) addScript();\n\n // Required pixel id\n if (!pixelId) return false;\n\n // fbq function setup\n setup();\n\n const fbq = wrap('fbq', window.fbq);\n fbq('init', pixelId);\n },\n\n push(event, { config, mapping = {}, data, wrap }) {\n const { track, trackCustom } = mapping.settings || {};\n const fbq = wrap('fbq', window.fbq);\n\n // page view\n if (event.event === 'page view' && !mapping.settings) {\n // Define a custom mapping\n event.event = 'PageView';\n }\n\n const eventName = track || trackCustom || event.event;\n\n fbq(\n trackCustom ? 'trackCustom' : 'track',\n String(eventName),\n isObject(data) ? data : {},\n { eventID: event.id },\n );\n },\n};\n\nexport default destinationMeta;\n"],"mappings":";;;;;;;AAAO,SAAS,UACd,MAAM,kDACN;AACA,QAAM,SAAS,SAAS,cAAc,QAAQ;AAC9C,SAAO,MAAM;AACb,SAAO,QAAQ;AACf,WAAS,KAAK,YAAY,MAAM;AAClC;AAWO,SAAS,QAAQ;AACtB,QAAMA,KAAI;AAIV,MAAIA,GAAE,IAAgB;AAEtB,QAAMC,KAAI,YAAa,MAAuB;AAC5C,IAAAA,GAAE,aAAaA,GAAE,WAAW,MAAMA,IAAG,IAAI,IAAIA,GAAE,MAAM,KAAK,IAAI;AAAA,EAChE;AAEA,EAAAD,GAAE,MAAMC;AACR,MAAI,CAACD,GAAE,KAAM,CAAAA,GAAE,OAAOC;AACtB,EAAAA,GAAE,OAAOA;AACT,EAAAA,GAAE,SAAS;AACX,EAAAA,GAAE,UAAU;AACZ,EAAAA,GAAE,QAAQ,CAAC;AACb;A;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACnCA;;;ACAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEO,SAAS,WAAsB;AACpC,QAAM,QAAQ,EAAS,gBAAgB;AAEvC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,MACE,OAAO,MAAM,KAAK;AAAA,MAClB,UAAU;AAAA,MACV,UAAU,MAAM,OACb,OAAO,CAAC,SAAS,KAAK,SAAS,SAAS,EACxC,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,KAAK,IAAI,UAAU,EAAE,EAAE;AAAA,MACpD,cAAc;AAAA,MACd,WAAW;AAAA,IACb;AAAA,IACA,EAAE,SAAS,MAAM,GAAG;AAAA,EACtB;AACF;AAEO,SAAS,YAAuB;AACrC,QAAM,QAAQ,EAAS,aAAa;AAEpC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,MACE,UAAU;AAAA,MACV,OAAO,MAAM,KAAK;AAAA,MAClB,UAAU,CAAC,EAAE,IAAI,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;AAAA,MAC7C,cAAc;AAAA,IAChB;AAAA,IACA,EAAE,SAAS,MAAM,GAAG;AAAA,EACtB;AACF;AAEO,SAAS,mBAA8B;AAC5C,QAAM,QAAQ,EAAS,WAAW;AAElC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,MACE,UAAU;AAAA,MACV,OAAO,MAAM,KAAK;AAAA,MAClB,UAAU,MAAM,OACb,OAAO,CAAC,WAAW,OAAO,SAAS,SAAS,EAC5C,IAAI,CAAC,YAAY;AAAA,QAChB,IAAI,OAAO,KAAK;AAAA,QAChB,UAAU,OAAO,KAAK;AAAA,MACxB,EAAE;AAAA,MACJ,WAAW,MAAM,OAAO,OAAO,CAAC,SAAS,KAAK,SAAS,SAAS,EAAE;AAAA,IACpE;AAAA,IACA,EAAE,SAAS,MAAM,GAAG;AAAA,EACtB;AACF;AAEO,SAAS,cAAyB;AACvC,QAAM,QAAQ,EAAS,cAAc;AAErC,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,MACE,UAAU;AAAA,MACV,OAAO,MAAM,KAAK;AAAA,MAClB,UAAU,CAAC,EAAE,IAAI,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;AAAA,MAC7C,cAAc;AAAA,IAChB;AAAA,IACA,EAAE,SAAS,MAAM,GAAG;AAAA,EACtB;AACF;;;ACxEA;AAAA;AAAA,mBAAAC;AAAA,EAAA,wBAAAC;AAAA,EAAA,gBAAAC;AAAA,EAAA,mBAAAC;AAAA,EAAA;AAAA;AAIO,IAAMC,YAAiC;AAAA,EAC5C,MAAM;AAAA,EACN,MAAM;AAAA,IACJ,KAAK;AAAA,MACH,OAAO;AAAA,MACP,UAAU,EAAE,OAAO,MAAM;AAAA,MACzB,UAAU;AAAA,QACR,MAAM;AAAA,UACJ;AAAA,UACA;AAAA,YACE,WAAW,CAAC,WACV,EAAS,MAAM,KAAK,OAAO,SAAS;AAAA,YACtC,KAAK;AAAA,cACH,IAAI;AAAA,cACJ,UAAU,EAAE,KAAK,iBAAiB,OAAO,EAAE;AAAA,YAC7C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,EAAE,OAAO,UAAU;AAAA,MACjC,WAAW;AAAA,QACT,IAAI,CAAC,UACF,MAAyB,OAAO;AAAA,UAC/B,CAAC,SAAS,KAAK,SAAS;AAAA,QAC1B,EAAE;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAMC,aAAkC;AAAA,EAC7C,MAAM;AAAA,EACN,MAAM;AAAA,IACJ,KAAK;AAAA,MACH,OAAO;AAAA,MACP,UAAU,EAAE,OAAO,MAAM;AAAA,MACzB,UAAU;AAAA,QACR,KAAK;AAAA,UACH;AAAA,YACE,KAAK;AAAA,cACH,IAAI;AAAA,cACJ,UAAU,EAAE,KAAK,iBAAiB,OAAO,EAAE;AAAA,YAC7C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,EAAE,OAAO,UAAU;AAAA,IACnC;AAAA,EACF;AACF;AAEO,IAAMC,oBAAyC;AAAA,EACpD,MAAM;AAAA,EACN,MAAM;AAAA,IACJ,KAAK;AAAA,MACH,OAAO;AAAA,MACP,UAAU,EAAE,OAAO,MAAM;AAAA,MACzB,UAAU;AAAA,QACR,MAAM;AAAA,UACJ;AAAA,UACA;AAAA,YACE,WAAW,CAAC,WACV,EAAS,MAAM,KAAK,OAAO,SAAS;AAAA,YACtC,KAAK;AAAA,cACH,IAAI;AAAA,cACJ,UAAU,EAAE,KAAK,iBAAiB,OAAO,EAAE;AAAA,YAC7C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,WAAW;AAAA,QACT,IAAI,CAAC,UACF,MAAyB,OAAO;AAAA,UAC/B,CAAC,SAAS,KAAK,SAAS;AAAA,QAC1B,EAAE;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAMC,eAAoC;AAAA,EAC/C,MAAM;AAAA,EACN,MAAM;AAAA,IACJ,KAAK;AAAA,MACH,OAAO;AAAA,MACP,UAAU,EAAE,OAAO,MAAM;AAAA,MACzB,cAAc,EAAE,OAAO,UAAU;AAAA,MACjC,UAAU;AAAA,QACR,KAAK;AAAA,UACH;AAAA,YACE,KAAK;AAAA,cACH,IAAI;AAAA,cACJ,UAAU,EAAE,KAAK,iBAAiB,OAAO,EAAE;AAAA,YAC7C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,SAAS;AAAA,EACpB,OAAO,EAAE,UAAUH,UAAS;AAAA,EAC5B,SAAS,EAAE,MAAMG,cAAa,KAAKF,WAAU;AAAA,EAC7C,MAAM,EAAE,MAAMC,kBAAiB;AACjC;;;AF1GO,IAAM,0BAA0B;AAAA,EACrC;AAAA,EACA;AACF;;;AGIO,IAAM,kBAA+B;AAAA,EAC1C,MAAM;AAAA,EAEN,QAAQ,CAAC;AAAA,EAET,KAAK,EAAE,QAAAE,SAAQ,KAAK,GAAG;AACrB,UAAM,EAAE,WAAW,CAAC,GAAwB,WAAW,IAAIA;AAC3D,UAAM,EAAE,QAAQ,IAAI;AAGpB,QAAI,WAAY,WAAU;AAG1B,QAAI,CAAC,QAAS,QAAO;AAGrB,UAAM;AAEN,UAAM,MAAM,KAAK,OAAO,OAAO,GAAG;AAClC,QAAI,QAAQ,OAAO;AAAA,EACrB;AAAA,EAEA,KAAK,OAAO,EAAE,QAAAA,SAAQ,UAAU,CAAC,GAAG,MAAM,KAAK,GAAG;AAChD,UAAM,EAAE,OAAO,YAAY,IAAI,QAAQ,YAAY,CAAC;AACpD,UAAM,MAAM,KAAK,OAAO,OAAO,GAAG;AAGlC,QAAI,MAAM,UAAU,eAAe,CAAC,QAAQ,UAAU;AAEpD,YAAM,QAAQ;AAAA,IAChB;AAEA,UAAM,YAAY,SAAS,eAAe,MAAM;AAEhD;AAAA,MACE,cAAc,gBAAgB;AAAA,MAC9B,OAAO,SAAS;AAAA,MAChB,EAAS,IAAI,IAAI,OAAO,CAAC;AAAA,MACzB,EAAE,SAAS,MAAM,GAAG;AAAA,IACtB;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":["w","n","AddToCart","InitiateCheckout","Purchase","ViewContent","Purchase","AddToCart","InitiateCheckout","ViewContent","config"]}