@walkeros/web-destination-piano 4.1.2

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,103 @@
+<p align="left">
+  <a href="https://www.walkeros.io">
+    <img alt="walkerOS" title="walkerOS" src="https://www.walkeros.io/img/walkerOS_logo.svg" width="256px"/>
+  </a>
+</p>
+
+# @walkeros/web-destination-piano
+
+Send walkerOS events to Piano Analytics.
+
+[Documentation](https://www.walkeros.io/docs/destinations/web/piano) &bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-piano)
+&bull;
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/piano)
+
+This destination forwards collector-processed events to the official
+[Piano Analytics JavaScript SDK](https://github.com/at-internet/piano-analytics-js)
+(`pa`) via `pa.sendEvent`.
+
+## Installation
+
+```bash
+npm install @walkeros/web-destination-piano
+```
+
+## Quick start
+
+```json
+{
+  "version": 4,
+  "flows": {
+    "default": {
+      "config": {
+        "platform": "web"
+      },
+      "destinations": {
+        "piano": {
+          "package": "@walkeros/web-destination-piano",
+          "config": {
+            "loadScript": true,
+            "settings": {
+              "site": 123456789,
+              "collectDomain": "https://example.pa-cd.com"
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+With `loadScript: true` the destination loads the Piano SDK script and calls
+`pa.setConfigurations({ site, collectDomain })` on init. If you load the SDK
+yourself, omit `loadScript` and make sure `pa` is available on `window`.
+
+## Settings
+
+| Setting         | Type     | Required | Description                                                  |
+| --------------- | -------- | -------- | ------------------------------------------------------------ |
+| `site`          | `number` | yes      | Piano Analytics site id, from your collection settings.      |
+| `collectDomain` | `string` | yes      | Collection domain endpoint, like `https://xxxxxxx.pa-cd.com` |
+| `options`       | `object` | no       | Additional Piano `setConfigurations` options merged on init. |
+
+## Mapping
+
+Each event is mapped to a Piano event name and a property object, then sent with
+`pa.sendEvent(name, data)`. Piano uses dot-notation event names like
+`page.display`.
+
+| walkerOS event   | Piano event                | Notes                       |
+| ---------------- | -------------------------- | --------------------------- |
+| `page view`      | `page.display`             | Page name and chapter.      |
+| `order complete` | `transaction.confirmation` | Transaction id and revenue. |
+
+```json
+{
+  "mapping": {
+    "page": {
+      "view": {
+        "name": "page.display",
+        "data": { "map": { "page": "data.title" } }
+      }
+    }
+  }
+}
+```
+
+## Documentation
+
+Full configuration, mapping, and examples live in the docs:
+**https://www.walkeros.io/docs/destinations/web/piano**
+
+## 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
+
+MIT

package/dist/dev.d.mts

@@ -0,0 +1,100 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { WalkerOS, Flow } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    site: z.ZodNumber;
+    collectDomain: z.ZodString;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+/**
+ * Piano Mapping Schema
+ * Piano has no event-level mapping configuration
+ */
+declare const MappingSchema: z.ZodObject<{}, z.core.$strip>;
+/**
+ * Type inference from MappingSchema
+ */
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        pa?: PianoAnalytics;
+    }
+}
+/**
+ * Surface of the official Piano Analytics browser SDK (the `pa` global from
+ * https://tag.aticdn.net/piano-analytics.js). Only the methods this
+ * destination calls are declared; the SDK exposes more.
+ */
+interface PianoAnalytics {
+    setConfigurations(configurations: WalkerOS.AnyObject): void;
+    sendEvent(name: string, data?: WalkerOS.AnyObject): void;
+    sendEvents(events: ReadonlyArray<{
+        name: string;
+        data?: WalkerOS.AnyObject;
+    }>): void;
+}
+interface Env extends DestinationWeb.Env {
+    window?: {
+        pa?: PianoAnalytics;
+    };
+}
+
+/** SDK not yet present: init must tolerate a missing `pa`. */
+declare const init$1: Env;
+/** SDK present: used for capturing setConfigurations/sendEvent calls. */
+declare const push: Env;
+/**
+ * Simulation tracking paths
+ * Specifies which function calls to track during simulation
+ */
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { init$1 as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Destination bootstrap.
+ * init configures the Piano `pa` SDK with the site id and collection domain
+ * via setConfigurations.
+ */
+declare const init: Flow.StepExample;
+declare const pageView: Flow.StepExample;
+declare const purchase: Flow.StepExample;
+declare const customEvent: Flow.StepExample;
+
+declare const step_customEvent: typeof customEvent;
+declare const step_init: typeof init;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_customEvent as customEvent, step_init as init, step_pageView as pageView, step_purchase as purchase };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,100 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { WalkerOS, Flow } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    site: z.ZodNumber;
+    collectDomain: z.ZodString;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+/**
+ * Piano Mapping Schema
+ * Piano has no event-level mapping configuration
+ */
+declare const MappingSchema: z.ZodObject<{}, z.core.$strip>;
+/**
+ * Type inference from MappingSchema
+ */
+type Mapping = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping: _walkeros_core_dev.JSONSchema;
+
+type index$1_Mapping = Mapping;
+declare const index$1_MappingSchema: typeof MappingSchema;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_mapping: typeof mapping;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type index$1_Mapping as Mapping, index$1_MappingSchema as MappingSchema, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, index$1_mapping as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        pa?: PianoAnalytics;
+    }
+}
+/**
+ * Surface of the official Piano Analytics browser SDK (the `pa` global from
+ * https://tag.aticdn.net/piano-analytics.js). Only the methods this
+ * destination calls are declared; the SDK exposes more.
+ */
+interface PianoAnalytics {
+    setConfigurations(configurations: WalkerOS.AnyObject): void;
+    sendEvent(name: string, data?: WalkerOS.AnyObject): void;
+    sendEvents(events: ReadonlyArray<{
+        name: string;
+        data?: WalkerOS.AnyObject;
+    }>): void;
+}
+interface Env extends DestinationWeb.Env {
+    window?: {
+        pa?: PianoAnalytics;
+    };
+}
+
+/** SDK not yet present: init must tolerate a missing `pa`. */
+declare const init$1: Env;
+/** SDK present: used for capturing setConfigurations/sendEvent calls. */
+declare const push: Env;
+/**
+ * Simulation tracking paths
+ * Specifies which function calls to track during simulation
+ */
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { init$1 as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Destination bootstrap.
+ * init configures the Piano `pa` SDK with the site id and collection domain
+ * via setConfigurations.
+ */
+declare const init: Flow.StepExample;
+declare const pageView: Flow.StepExample;
+declare const purchase: Flow.StepExample;
+declare const customEvent: Flow.StepExample;
+
+declare const step_customEvent: typeof customEvent;
+declare const step_init: typeof init;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_customEvent as customEvent, step_init as init, step_pageView as pageView, step_purchase as purchase };
+}
+
+declare const index_env: typeof env;
+declare const index_step: typeof step;
+declare namespace index {
+  export { index_env as env, index_step as step };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.js

@@ -0,0 +1 @@
+"use strict";var e,t=Object.defineProperty,a=Object.getOwnPropertyDescriptor,i=Object.getOwnPropertyNames,n=Object.prototype.hasOwnProperty,o=(e,a)=>{for(var i in a)t(e,i,{get:a[i],enumerable:!0})},r={};o(r,{examples:()=>g,schemas:()=>c}),module.exports=(e=r,((e,o,r,c)=>{if(o&&"object"==typeof o||"function"==typeof o)for(let s of i(o))n.call(e,s)||s===r||t(e,s,{get:()=>o[s],enumerable:!(c=a(o,s))||c.enumerable});return e})(t({},"__esModule",{value:!0}),e));var c={};o(c,{MappingSchema:()=>l,SettingsSchema:()=>d,mapping:()=>u,settings:()=>m});var s=require("@walkeros/core/dev"),p=require("@walkeros/core/dev"),d=p.z.object({site:p.z.number().describe("Piano Analytics site id (numeric), from your collection settings"),collectDomain:p.z.string().describe("Collection domain endpoint, like https://xxxxxxx.pa-cd.com"),options:p.z.record(p.z.string(),p.z.unknown()).describe("Additional Piano setConfigurations options merged on init").optional()}),l=require("@walkeros/core/dev").z.object({}),m=(0,s.zodToSchema)(d),u=(0,s.zodToSchema)(l),g={};o(g,{env:()=>v,step:()=>y});var v={};o(v,{init:()=>h,push:()=>f,simulation:()=>b});var w=()=>{};var h={window:{}},f={window:{pa:{setConfigurations:w,sendEvent:w,sendEvents:w}}},b=["call:window.pa.sendEvent"],y={};o(y,{customEvent:()=>O,init:()=>x,pageView:()=>z,purchase:()=>k});var P=require("@walkeros/core"),E={site:123456789,collectDomain:"https://example.pa-cd.com"},x={title:"Initialization",description:"Destination bootstrap configures Piano with the site id and collection domain.",in:{settings:E},out:[["pa.setConfigurations",E]]},z={title:"Page view",description:"A page view fires a Piano page.display event with the page name and chapter.",in:(0,P.getEvent)("page view",{timestamp:1700000200}),mapping:{name:"page.display",data:{map:{page:"data.title",page_chapter1:"globals.pagegroup"}}},out:[["pa.sendEvent","page.display",{page:"walkerOS documentation",page_chapter1:"docs"}]]},k={title:"Purchase",description:"A completed order fires a Piano transaction.confirmation event with the transaction id, revenue and currency.",in:(0,P.getEvent)("order complete",{timestamp:1700000201}),mapping:{name:"transaction.confirmation",data:{map:{transaction_id:"data.id",revenue:"data.total",currency:"data.currency"}}},out:[["pa.sendEvent","transaction.confirmation",{transaction_id:"0rd3r1d",revenue:555,currency:"EUR"}]]},O={title:"Custom event",description:"A generic entity action fires a custom Piano event with mapped properties.",in:(0,P.getEvent)("entity action",{timestamp:1700000202}),mapping:{name:"click.action",data:{map:{label:"data.string",value:"data.number"}}},out:[["pa.sendEvent","click.action",{label:"foo",value:1}]]};//# sourceMappingURL=dev.js.map

package/dist/dev.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dev.ts","../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["export * as schemas from './schemas';\nexport * as examples from './examples';\n","import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  site: z\n    .number()\n    .describe('Piano Analytics site id (numeric), from your collection settings'),\n  collectDomain: z\n    .string()\n    .describe('Collection domain endpoint, like https://xxxxxxx.pa-cd.com'),\n  options: z\n    .record(z.string(), z.unknown())\n    .describe('Additional Piano setConfigurations options merged on init')\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\n/**\n * Piano Mapping Schema\n * Piano has no event-level mapping configuration\n */\nexport const MappingSchema = z.object({});\n\n/**\n * Type inference from MappingSchema\n */\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type { Env, PianoAnalytics } from '../types';\n\n/**\n * Example environment configurations for the Piano destination.\n *\n * These environments provide standardized mock structures for testing and\n * development without loading the real Piano SDK. They satisfy the `Env`\n * interface directly, so no type casts are needed.\n */\n\nconst noop = () => {};\n\n/** A no-op Piano SDK whose methods are wrapped by `mockEnv` to capture calls. */\nfunction mockPa(): PianoAnalytics {\n  return {\n    setConfigurations: noop,\n    sendEvent: noop,\n    sendEvents: noop,\n  };\n}\n\n/** SDK not yet present: init must tolerate a missing `pa`. */\nexport const init: Env = {\n  window: {},\n};\n\n/** SDK present: used for capturing setConfigurations/sendEvent calls. */\nexport const push: Env = {\n  window: {\n    pa: mockPa(),\n  },\n};\n\n/**\n * Simulation tracking paths\n * Specifies which function calls to track during simulation\n */\nexport const simulation = [\n  'call:window.pa.sendEvent', // Track Piano sendEvent calls\n];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\n\nconst settings = {\n  site: 123456789,\n  collectDomain: 'https://example.pa-cd.com',\n};\n\n/**\n * Destination bootstrap.\n * init configures the Piano `pa` SDK with the site id and collection domain\n * via setConfigurations.\n */\nexport const init: Flow.StepExample = {\n  title: 'Initialization',\n  description:\n    'Destination bootstrap configures Piano with the site id and collection domain.',\n  in: {\n    settings,\n  },\n  out: [['pa.setConfigurations', settings]],\n};\n\nexport const pageView: Flow.StepExample = {\n  title: 'Page view',\n  description:\n    'A page view fires a Piano page.display event with the page name and chapter.',\n  in: getEvent('page view', { timestamp: 1700000200 }),\n  mapping: {\n    name: 'page.display',\n    data: {\n      map: {\n        page: 'data.title',\n        page_chapter1: 'globals.pagegroup',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'page.display',\n      {\n        page: 'walkerOS documentation',\n        page_chapter1: 'docs',\n      },\n    ],\n  ],\n};\n\nexport const purchase: Flow.StepExample = {\n  title: 'Purchase',\n  description:\n    'A completed order fires a Piano transaction.confirmation event with the transaction id, revenue and currency.',\n  in: getEvent('order complete', { timestamp: 1700000201 }),\n  mapping: {\n    name: 'transaction.confirmation',\n    data: {\n      map: {\n        transaction_id: 'data.id',\n        revenue: 'data.total',\n        currency: 'data.currency',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'transaction.confirmation',\n      {\n        transaction_id: '0rd3r1d',\n        revenue: 555,\n        currency: 'EUR',\n      },\n    ],\n  ],\n};\n\nexport const customEvent: Flow.StepExample = {\n  title: 'Custom event',\n  description:\n    'A generic entity action fires a custom Piano event with mapped properties.',\n  in: getEvent('entity action', { timestamp: 1700000202 }),\n  mapping: {\n    name: 'click.action',\n    data: {\n      map: {\n        label: 'data.string',\n        value: 'data.number',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'click.action',\n      {\n        label: 'foo',\n        value: 1,\n      },\n    ],\n  ],\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,cAA4B;;;ACA5B,iBAAkB;AAEX,IAAM,iBAAiB,aAAE,OAAO;AAAA,EACrC,MAAM,aACH,OAAO,EACP,SAAS,kEAAkE;AAAA,EAC9E,eAAe,aACZ,OAAO,EACP,SAAS,4DAA4D;AAAA,EACxE,SAAS,aACN,OAAO,aAAE,OAAO,GAAG,aAAE,QAAQ,CAAC,EAC9B,SAAS,2DAA2D,EACpE,SAAS;AACd,CAAC;;;ACbD,IAAAC,cAAkB;AAMX,IAAM,gBAAgB,cAAE,OAAO,CAAC,CAAC;;;AFEjC,IAAM,eAAW,yBAAY,cAAc;AAC3C,IAAM,cAAU,yBAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,IAAM,OAAO,MAAM;AAAC;AAGpB,SAAS,SAAyB;AAChC,SAAO;AAAA,IACL,mBAAmB;AAAA,IACnB,WAAW;AAAA,IACX,YAAY;AAAA,EACd;AACF;AAGO,IAAM,OAAY;AAAA,EACvB,QAAQ,CAAC;AACX;AAGO,IAAM,OAAY;AAAA,EACvB,QAAQ;AAAA,IACN,IAAI,OAAO;AAAA,EACb;AACF;AAMO,IAAM,aAAa;AAAA,EACxB;AAAA;AACF;;;ACvCA;AAAA;AAAA;AAAA,cAAAC;AAAA,EAAA;AAAA;AAAA;AACA,kBAAyB;AAEzB,IAAMC,YAAW;AAAA,EACf,MAAM;AAAA,EACN,eAAe;AACjB;AAOO,IAAMD,QAAyB;AAAA,EACpC,OAAO;AAAA,EACP,aACE;AAAA,EACF,IAAI;AAAA,IACF,UAAAC;AAAA,EACF;AAAA,EACA,KAAK,CAAC,CAAC,wBAAwBA,SAAQ,CAAC;AAC1C;AAEO,IAAM,WAA6B;AAAA,EACxC,OAAO;AAAA,EACP,aACE;AAAA,EACF,QAAI,sBAAS,aAAa,EAAE,WAAW,WAAW,CAAC;AAAA,EACnD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,MAAM;AAAA,QACN,eAAe;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,eAAe;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,WAA6B;AAAA,EACxC,OAAO;AAAA,EACP,aACE;AAAA,EACF,QAAI,sBAAS,kBAAkB,EAAE,WAAW,WAAW,CAAC;AAAA,EACxD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,gBAAgB;AAAA,QAChB,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,gBAAgB;AAAA,QAChB,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,cAAgC;AAAA,EAC3C,OAAO;AAAA,EACP,aACE;AAAA,EACF,QAAI,sBAAS,iBAAiB,EAAE,WAAW,WAAW,CAAC;AAAA,EACvD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,OAAO;AAAA,QACP,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;","names":["import_dev","import_dev","init","settings"]}

package/dist/dev.mjs

@@ -0,0 +1 @@
+var e=Object.defineProperty,t=(t,a)=>{for(var i in a)e(t,i,{get:a[i],enumerable:!0})},a={};t(a,{MappingSchema:()=>s,SettingsSchema:()=>o,mapping:()=>p,settings:()=>c});import{zodToSchema as i}from"@walkeros/core/dev";import{z as n}from"@walkeros/core/dev";var o=n.object({site:n.number().describe("Piano Analytics site id (numeric), from your collection settings"),collectDomain:n.string().describe("Collection domain endpoint, like https://xxxxxxx.pa-cd.com"),options:n.record(n.string(),n.unknown()).describe("Additional Piano setConfigurations options merged on init").optional()});import{z as r}from"@walkeros/core/dev";var s=r.object({}),c=i(o),p=i(s),d={};t(d,{env:()=>m,step:()=>w});var m={};t(m,{init:()=>g,push:()=>u,simulation:()=>v});var l=()=>{};var g={window:{}},u={window:{pa:{setConfigurations:l,sendEvent:l,sendEvents:l}}},v=["call:window.pa.sendEvent"],w={};t(w,{customEvent:()=>k,init:()=>b,pageView:()=>y,purchase:()=>x});import{getEvent as f}from"@walkeros/core";var h={site:123456789,collectDomain:"https://example.pa-cd.com"},b={title:"Initialization",description:"Destination bootstrap configures Piano with the site id and collection domain.",in:{settings:h},out:[["pa.setConfigurations",h]]},y={title:"Page view",description:"A page view fires a Piano page.display event with the page name and chapter.",in:f("page view",{timestamp:1700000200}),mapping:{name:"page.display",data:{map:{page:"data.title",page_chapter1:"globals.pagegroup"}}},out:[["pa.sendEvent","page.display",{page:"walkerOS documentation",page_chapter1:"docs"}]]},x={title:"Purchase",description:"A completed order fires a Piano transaction.confirmation event with the transaction id, revenue and currency.",in:f("order complete",{timestamp:1700000201}),mapping:{name:"transaction.confirmation",data:{map:{transaction_id:"data.id",revenue:"data.total",currency:"data.currency"}}},out:[["pa.sendEvent","transaction.confirmation",{transaction_id:"0rd3r1d",revenue:555,currency:"EUR"}]]},k={title:"Custom event",description:"A generic entity action fires a custom Piano event with mapped properties.",in:f("entity action",{timestamp:1700000202}),mapping:{name:"click.action",data:{map:{label:"data.string",value:"data.number"}}},out:[["pa.sendEvent","click.action",{label:"foo",value:1}]]};export{d as examples,a as schemas};//# sourceMappingURL=dev.mjs.map

package/dist/dev.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas/index.ts","../src/schemas/settings.ts","../src/schemas/mapping.ts","../src/examples/index.ts","../src/examples/env.ts","../src/examples/step.ts"],"sourcesContent":["import { zodToSchema } from '@walkeros/core/dev';\nimport { SettingsSchema } from './settings';\nimport { MappingSchema } from './mapping';\n\nexport { SettingsSchema, type Settings } from './settings';\nexport { MappingSchema, type Mapping } from './mapping';\n\n// JSON Schema\nexport const settings = zodToSchema(SettingsSchema);\nexport const mapping = zodToSchema(MappingSchema);\n","import { z } from '@walkeros/core/dev';\n\nexport const SettingsSchema = z.object({\n  site: z\n    .number()\n    .describe('Piano Analytics site id (numeric), from your collection settings'),\n  collectDomain: z\n    .string()\n    .describe('Collection domain endpoint, like https://xxxxxxx.pa-cd.com'),\n  options: z\n    .record(z.string(), z.unknown())\n    .describe('Additional Piano setConfigurations options merged on init')\n    .optional(),\n});\n\nexport type Settings = z.infer<typeof SettingsSchema>;\n","import { z } from '@walkeros/core/dev';\n\n/**\n * Piano Mapping Schema\n * Piano has no event-level mapping configuration\n */\nexport const MappingSchema = z.object({});\n\n/**\n * Type inference from MappingSchema\n */\nexport type Mapping = z.infer<typeof MappingSchema>;\n","export * as env from './env';\nexport * as step from './step';\n","import type { Env, PianoAnalytics } from '../types';\n\n/**\n * Example environment configurations for the Piano destination.\n *\n * These environments provide standardized mock structures for testing and\n * development without loading the real Piano SDK. They satisfy the `Env`\n * interface directly, so no type casts are needed.\n */\n\nconst noop = () => {};\n\n/** A no-op Piano SDK whose methods are wrapped by `mockEnv` to capture calls. */\nfunction mockPa(): PianoAnalytics {\n  return {\n    setConfigurations: noop,\n    sendEvent: noop,\n    sendEvents: noop,\n  };\n}\n\n/** SDK not yet present: init must tolerate a missing `pa`. */\nexport const init: Env = {\n  window: {},\n};\n\n/** SDK present: used for capturing setConfigurations/sendEvent calls. */\nexport const push: Env = {\n  window: {\n    pa: mockPa(),\n  },\n};\n\n/**\n * Simulation tracking paths\n * Specifies which function calls to track during simulation\n */\nexport const simulation = [\n  'call:window.pa.sendEvent', // Track Piano sendEvent calls\n];\n","import type { Flow } from '@walkeros/core';\nimport { getEvent } from '@walkeros/core';\n\nconst settings = {\n  site: 123456789,\n  collectDomain: 'https://example.pa-cd.com',\n};\n\n/**\n * Destination bootstrap.\n * init configures the Piano `pa` SDK with the site id and collection domain\n * via setConfigurations.\n */\nexport const init: Flow.StepExample = {\n  title: 'Initialization',\n  description:\n    'Destination bootstrap configures Piano with the site id and collection domain.',\n  in: {\n    settings,\n  },\n  out: [['pa.setConfigurations', settings]],\n};\n\nexport const pageView: Flow.StepExample = {\n  title: 'Page view',\n  description:\n    'A page view fires a Piano page.display event with the page name and chapter.',\n  in: getEvent('page view', { timestamp: 1700000200 }),\n  mapping: {\n    name: 'page.display',\n    data: {\n      map: {\n        page: 'data.title',\n        page_chapter1: 'globals.pagegroup',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'page.display',\n      {\n        page: 'walkerOS documentation',\n        page_chapter1: 'docs',\n      },\n    ],\n  ],\n};\n\nexport const purchase: Flow.StepExample = {\n  title: 'Purchase',\n  description:\n    'A completed order fires a Piano transaction.confirmation event with the transaction id, revenue and currency.',\n  in: getEvent('order complete', { timestamp: 1700000201 }),\n  mapping: {\n    name: 'transaction.confirmation',\n    data: {\n      map: {\n        transaction_id: 'data.id',\n        revenue: 'data.total',\n        currency: 'data.currency',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'transaction.confirmation',\n      {\n        transaction_id: '0rd3r1d',\n        revenue: 555,\n        currency: 'EUR',\n      },\n    ],\n  ],\n};\n\nexport const customEvent: Flow.StepExample = {\n  title: 'Custom event',\n  description:\n    'A generic entity action fires a custom Piano event with mapped properties.',\n  in: getEvent('entity action', { timestamp: 1700000202 }),\n  mapping: {\n    name: 'click.action',\n    data: {\n      map: {\n        label: 'data.string',\n        value: 'data.number',\n      },\n    },\n  },\n  out: [\n    [\n      'pa.sendEvent',\n      'click.action',\n      {\n        label: 'foo',\n        value: 1,\n      },\n    ],\n  ],\n};\n"],"mappings":";;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAS,mBAAmB;;;ACA5B,SAAS,SAAS;AAEX,IAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,MAAM,EACH,OAAO,EACP,SAAS,kEAAkE;AAAA,EAC9E,eAAe,EACZ,OAAO,EACP,SAAS,4DAA4D;AAAA,EACxE,SAAS,EACN,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,EAC9B,SAAS,2DAA2D,EACpE,SAAS;AACd,CAAC;;;ACbD,SAAS,KAAAA,UAAS;AAMX,IAAM,gBAAgBA,GAAE,OAAO,CAAC,CAAC;;;AFEjC,IAAM,WAAW,YAAY,cAAc;AAC3C,IAAM,UAAU,YAAY,aAAa;;;AGThD;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,IAAM,OAAO,MAAM;AAAC;AAGpB,SAAS,SAAyB;AAChC,SAAO;AAAA,IACL,mBAAmB;AAAA,IACnB,WAAW;AAAA,IACX,YAAY;AAAA,EACd;AACF;AAGO,IAAM,OAAY;AAAA,EACvB,QAAQ,CAAC;AACX;AAGO,IAAM,OAAY;AAAA,EACvB,QAAQ;AAAA,IACN,IAAI,OAAO;AAAA,EACb;AACF;AAMO,IAAM,aAAa;AAAA,EACxB;AAAA;AACF;;;ACvCA;AAAA;AAAA;AAAA,cAAAC;AAAA,EAAA;AAAA;AAAA;AACA,SAAS,gBAAgB;AAEzB,IAAMC,YAAW;AAAA,EACf,MAAM;AAAA,EACN,eAAe;AACjB;AAOO,IAAMD,QAAyB;AAAA,EACpC,OAAO;AAAA,EACP,aACE;AAAA,EACF,IAAI;AAAA,IACF,UAAAC;AAAA,EACF;AAAA,EACA,KAAK,CAAC,CAAC,wBAAwBA,SAAQ,CAAC;AAC1C;AAEO,IAAM,WAA6B;AAAA,EACxC,OAAO;AAAA,EACP,aACE;AAAA,EACF,IAAI,SAAS,aAAa,EAAE,WAAW,WAAW,CAAC;AAAA,EACnD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,MAAM;AAAA,QACN,eAAe;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,MAAM;AAAA,QACN,eAAe;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,WAA6B;AAAA,EACxC,OAAO;AAAA,EACP,aACE;AAAA,EACF,IAAI,SAAS,kBAAkB,EAAE,WAAW,WAAW,CAAC;AAAA,EACxD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,gBAAgB;AAAA,QAChB,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,gBAAgB;AAAA,QAChB,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACF;AAEO,IAAM,cAAgC;AAAA,EAC3C,OAAO;AAAA,EACP,aACE;AAAA,EACF,IAAI,SAAS,iBAAiB,EAAE,WAAW,WAAW,CAAC;AAAA,EACvD,SAAS;AAAA,IACP,MAAM;AAAA,IACN,MAAM;AAAA,MACJ,KAAK;AAAA,QACH,OAAO;AAAA,QACP,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EACA,KAAK;AAAA,IACH;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,QACE,OAAO;AAAA,QACP,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;","names":["z","init","settings"]}

package/dist/examples/index.d.mts

@@ -0,0 +1,62 @@
+import { WalkerOS, Flow } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare global {
+    interface Window {
+        pa?: PianoAnalytics;
+    }
+}
+/**
+ * Surface of the official Piano Analytics browser SDK (the `pa` global from
+ * https://tag.aticdn.net/piano-analytics.js). Only the methods this
+ * destination calls are declared; the SDK exposes more.
+ */
+interface PianoAnalytics {
+    setConfigurations(configurations: WalkerOS.AnyObject): void;
+    sendEvent(name: string, data?: WalkerOS.AnyObject): void;
+    sendEvents(events: ReadonlyArray<{
+        name: string;
+        data?: WalkerOS.AnyObject;
+    }>): void;
+}
+interface Env extends DestinationWeb.Env {
+    window?: {
+        pa?: PianoAnalytics;
+    };
+}
+
+/** SDK not yet present: init must tolerate a missing `pa`. */
+declare const init$1: Env;
+/** SDK present: used for capturing setConfigurations/sendEvent calls. */
+declare const push: Env;
+/**
+ * Simulation tracking paths
+ * Specifies which function calls to track during simulation
+ */
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { init$1 as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Destination bootstrap.
+ * init configures the Piano `pa` SDK with the site id and collection domain
+ * via setConfigurations.
+ */
+declare const init: Flow.StepExample;
+declare const pageView: Flow.StepExample;
+declare const purchase: Flow.StepExample;
+declare const customEvent: Flow.StepExample;
+
+declare const step_customEvent: typeof customEvent;
+declare const step_init: typeof init;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_customEvent as customEvent, step_init as init, step_pageView as pageView, step_purchase as purchase };
+}
+
+export { env, step };

package/dist/examples/index.d.ts

@@ -0,0 +1,62 @@
+import { WalkerOS, Flow } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare global {
+    interface Window {
+        pa?: PianoAnalytics;
+    }
+}
+/**
+ * Surface of the official Piano Analytics browser SDK (the `pa` global from
+ * https://tag.aticdn.net/piano-analytics.js). Only the methods this
+ * destination calls are declared; the SDK exposes more.
+ */
+interface PianoAnalytics {
+    setConfigurations(configurations: WalkerOS.AnyObject): void;
+    sendEvent(name: string, data?: WalkerOS.AnyObject): void;
+    sendEvents(events: ReadonlyArray<{
+        name: string;
+        data?: WalkerOS.AnyObject;
+    }>): void;
+}
+interface Env extends DestinationWeb.Env {
+    window?: {
+        pa?: PianoAnalytics;
+    };
+}
+
+/** SDK not yet present: init must tolerate a missing `pa`. */
+declare const init$1: Env;
+/** SDK present: used for capturing setConfigurations/sendEvent calls. */
+declare const push: Env;
+/**
+ * Simulation tracking paths
+ * Specifies which function calls to track during simulation
+ */
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { init$1 as init, env_push as push, env_simulation as simulation };
+}
+
+/**
+ * Destination bootstrap.
+ * init configures the Piano `pa` SDK with the site id and collection domain
+ * via setConfigurations.
+ */
+declare const init: Flow.StepExample;
+declare const pageView: Flow.StepExample;
+declare const purchase: Flow.StepExample;
+declare const customEvent: Flow.StepExample;
+
+declare const step_customEvent: typeof customEvent;
+declare const step_init: typeof init;
+declare const step_pageView: typeof pageView;
+declare const step_purchase: typeof purchase;
+declare namespace step {
+  export { step_customEvent as customEvent, step_init as init, step_pageView as pageView, step_purchase as purchase };
+}
+
+export { env, step };

package/dist/examples/index.js

@@ -0,0 +1,156 @@
+"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, {
+  init: () => init,
+  push: () => push,
+  simulation: () => simulation
+});
+var noop = () => {
+};
+function mockPa() {
+  return {
+    setConfigurations: noop,
+    sendEvent: noop,
+    sendEvents: noop
+  };
+}
+var init = {
+  window: {}
+};
+var push = {
+  window: {
+    pa: mockPa()
+  }
+};
+var simulation = [
+  "call:window.pa.sendEvent"
+  // Track Piano sendEvent calls
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  customEvent: () => customEvent,
+  init: () => init2,
+  pageView: () => pageView,
+  purchase: () => purchase
+});
+var import_core = require("@walkeros/core");
+var settings = {
+  site: 123456789,
+  collectDomain: "https://example.pa-cd.com"
+};
+var init2 = {
+  title: "Initialization",
+  description: "Destination bootstrap configures Piano with the site id and collection domain.",
+  in: {
+    settings
+  },
+  out: [["pa.setConfigurations", settings]]
+};
+var pageView = {
+  title: "Page view",
+  description: "A page view fires a Piano page.display event with the page name and chapter.",
+  in: (0, import_core.getEvent)("page view", { timestamp: 1700000200 }),
+  mapping: {
+    name: "page.display",
+    data: {
+      map: {
+        page: "data.title",
+        page_chapter1: "globals.pagegroup"
+      }
+    }
+  },
+  out: [
+    [
+      "pa.sendEvent",
+      "page.display",
+      {
+        page: "walkerOS documentation",
+        page_chapter1: "docs"
+      }
+    ]
+  ]
+};
+var purchase = {
+  title: "Purchase",
+  description: "A completed order fires a Piano transaction.confirmation event with the transaction id, revenue and currency.",
+  in: (0, import_core.getEvent)("order complete", { timestamp: 1700000201 }),
+  mapping: {
+    name: "transaction.confirmation",
+    data: {
+      map: {
+        transaction_id: "data.id",
+        revenue: "data.total",
+        currency: "data.currency"
+      }
+    }
+  },
+  out: [
+    [
+      "pa.sendEvent",
+      "transaction.confirmation",
+      {
+        transaction_id: "0rd3r1d",
+        revenue: 555,
+        currency: "EUR"
+      }
+    ]
+  ]
+};
+var customEvent = {
+  title: "Custom event",
+  description: "A generic entity action fires a custom Piano event with mapped properties.",
+  in: (0, import_core.getEvent)("entity action", { timestamp: 1700000202 }),
+  mapping: {
+    name: "click.action",
+    data: {
+      map: {
+        label: "data.string",
+        value: "data.number"
+      }
+    }
+  },
+  out: [
+    [
+      "pa.sendEvent",
+      "click.action",
+      {
+        label: "foo",
+        value: 1
+      }
+    ]
+  ]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});