@walkeros/web-destination-pinterest 3.4.2 → 4.0.0-next-1777463920154

package/README.md

@@ -17,19 +17,19 @@ tracking, enhanced matching, and dynamic retargeting.
 
 ## Features
 
-- **Standard event taxonomy** — explicit `mapping.name` rename to Pinterest's
+- **Standard event taxonomy** - explicit `mapping.name` rename to Pinterest's
   lowercase concatenated names (`pagevisit`, `addtocart`, `checkout`,
   `viewcontent`, `lead`, `signup`, `search`, `custom`, ...).
-- **Inline `line_items` for multi-product** — single
+- **Inline `line_items` for multi-product** - single
   `pintrk('track', 'checkout', { line_items: [...] })` call (NOT N separate
   calls). Built via the standard walkerOS `loop` mapping syntax.
-- **Enhanced matching** — strict allow-list of `em` (email) and `external_id`.
-  The Pinterest JS tag auto-hashes `em` with SHA-256 — the destination passes
+- **Enhanced matching** - strict allow-list of `em` (email) and `external_id`.
+  The Pinterest JS tag auto-hashes `em` with SHA-256 - the destination passes
   raw values through and never hashes.
-- **Auto `event_id` for dedup** — every `pintrk('track', ...)` call attaches the
+- **Auto `event_id` for dedup** - every `pintrk('track', ...)` call attaches the
   walkerOS event `id` as `event_id`, ready for cross-channel deduplication with
   a future server (Conversions API) destination.
-- **Consent-aware suppression** — `on('consent')` flips a runtime state flag.
+- **Consent-aware suppression** - `on('consent')` flips a runtime state flag.
   After revocation, subsequent track calls are suppressed even though Pinterest
   has no `opt_in`/`opt_out` SDK API.
 
@@ -84,7 +84,7 @@ npm install @walkeros/web-destination-pinterest
 | `apiKey`     | `string`                | yes      | Pinterest Tag ID (numeric string, e.g. `"2612345678901"`). Found in Pinterest Ads Manager under Conversions → Pinterest Tag. Passed to `pintrk('load', tagId)`.              |
 | `pageview`   | `boolean`               | no       | Fire `pintrk('page')` once in init after `core.js` loads. Default `true`. Set `false` when walkerOS sources already emit page view events to avoid a duplicate initial fire. |
 | `identify`   | `Mapping.Value`         | no       | Mapping value resolving to `{ em?, external_id? }`. Resolved on the first event and fired via `pintrk('set', data)` whenever the resolved identity changes.                  |
-| `include`    | `string[]`              | no       | Sections to forward as prefixed properties in track payloads. Pinterest expects specific parameter names — explicit `mapping.data` is usually preferred over `include`.      |
+| `include`    | `string[]`              | no       | Sections to forward as prefixed properties in track payloads. Pinterest expects specific parameter names - explicit `mapping.data` is usually preferred over `include`.      |
 | `loadScript` | `boolean` (on `config`) | no       | If `true`, the destination injects `https://s.pinimg.com/ct/core.js` on init. Set `false` when the host page already loads the Pinterest Tag snippet.                        |
 
 ### Mapping (per-event)
@@ -95,12 +95,12 @@ npm install @walkeros/web-destination-pinterest
 | `data` (top-level)  | `EventData`             | Standard walkerOS data resolution. The resolved object is sent verbatim as the third arg to `track()`.                                          |
 | `settings.identify` | `{ em?, external_id? }` | Per-event identity override. Fires `pintrk('set', data)` BEFORE the track call when the resolved identity differs from the current state.       |
 | `settings.include`  | `string[]`              | Overrides destination-level `include` for this rule.                                                                                            |
-| `skip`              | `boolean`               | Process side effects (identify) but suppress the default `pintrk('track', ...)` call.                                                           |
+| `silent`            | `boolean`               | Process side effects (identify) but suppress the default `pintrk('track', ...)` call.                                                           |
 
 ## Event Mapping
 
 Pinterest expects lowercase concatenated event names. The destination never
-auto-maps — every conversion event needs an explicit `mapping.name`.
+auto-maps - every conversion event needs an explicit `mapping.name`.
 
 | walkerOS event   | Pinterest event | Notes                                                                              |
 | ---------------- | --------------- | ---------------------------------------------------------------------------------- |
@@ -155,7 +155,7 @@ the JS tag:
 
 | Field         | Source                             | Notes                                                    |
 | ------------- | ---------------------------------- | -------------------------------------------------------- |
-| `em`          | `data.email` / `user.email` / etc. | Pinterest auto-hashes — pass raw email, do NOT pre-hash. |
+| `em`          | `data.email` / `user.email` / etc. | Pinterest auto-hashes - pass raw email, do NOT pre-hash. |
 | `external_id` | `data.id` / `user.id`              | Stable user identifier. Auto-hashed by Pinterest.        |
 
 The destination strictly limits to these two fields. CAPI-only fields (`ph`,
@@ -181,7 +181,7 @@ destination and are intentionally not accepted here.
 }
 ```
 
-Identity is diffed against the destination's runtime state —
+Identity is diffed against the destination's runtime state -
 `pintrk('set', ...)` only fires when the resolved identity actually changes.
 Destination-level `settings.identify` is resolved lazily on the first event
 (init has no event to bind to), so `pintrk('load', tagId)` is called without an
@@ -189,7 +189,7 @@ identity object.
 
 ## Consent
 
-Pinterest is an advertising platform — the Pinterest Tag falls under
+Pinterest is an advertising platform - the Pinterest Tag falls under
 **marketing** consent:
 
 ```json
@@ -209,15 +209,15 @@ implements consent revocation as a runtime suppression flag:
 3. If consent is later re-granted (all required keys `true`), the flag flips
    back and tracking resumes.
 
-The Pinterest Tag itself stays loaded throughout — only the walkerOS bridge goes
+The Pinterest Tag itself stays loaded throughout - only the walkerOS bridge goes
 silent.
 
-### Skipping a fully configured rule
+### Suppressing the default track on a fully configured rule
 
 ```json
 "user": {
   "update": {
-    "skip": true,
+    "silent": true,
     "settings": {
       "identify": {
         "map": { "em": "data.email", "external_id": "data.id" }
@@ -227,7 +227,7 @@ silent.
 }
 ```
 
-`mapping.skip: true` processes side effects (the `pintrk('set', ...)` identity
+`mapping.silent: true` processes side effects (the `pintrk('set', ...)` identity
 update) but suppresses the default `pintrk('track', ...)` call. Useful when you
 only want to refresh enhanced matching without firing a conversion.
 

package/dist/dev.d.mts

@@ -138,24 +138,24 @@ declare namespace env {
  *   - Zero SDK calls: out = []
  */
 /**
- * Default event forwarding — no rule. Without a mapping.name, the walkerOS
+ * Default event forwarding - no rule. Without a mapping.name, the walkerOS
  * event name is forwarded as-is. Pinterest accepts it but won't match a
  * standard conversion event. event_id is auto-attached for deduplication.
  */
 declare const defaultForward: Flow.StepExample;
 /**
- * Wildcard ignore pattern — the standard walkerOS way to suppress noisy
+ * Wildcard ignore pattern - the standard walkerOS way to suppress noisy
  * events. `mapping.ignore: true` at rule level produces zero SDK calls.
  */
 declare const wildcardIgnored: Flow.StepExample;
 /**
  * Standard Pinterest event rename via mapping.name. walkerOS "page view"
  * → Pinterest "pagevisit". The ONLY way to get Pinterest to recognize
- * a conversion event — the destination never auto-maps.
+ * a conversion event - the destination never auto-maps.
  */
 declare const pageViewRename: Flow.StepExample;
 /**
- * Search — walkerOS site search → Pinterest "search" with search_query.
+ * Search - walkerOS site search → Pinterest "search" with search_query.
  * Illustrates single-field mapping.data resolution.
  */
 declare const siteSearch: Flow.StepExample;
@@ -168,7 +168,7 @@ declare const productViewContent: Flow.StepExample;
  */
 declare const productAddToCart: Flow.StepExample;
 /**
- * Multi-product checkout — the canonical Pinterest ecommerce pattern.
+ * Multi-product checkout - the canonical Pinterest ecommerce pattern.
  */
 declare const orderCompleteCheckout: Flow.StepExample;
 /**
@@ -176,25 +176,25 @@ declare const orderCompleteCheckout: Flow.StepExample;
  */
 declare const userLoginLead: Flow.StepExample;
 /**
- * mapping.skip — processes side effects (identify set) but suppresses
+ * mapping.silent - processes side effects (identify set) but suppresses
  * the default pintrk('track', ...) call.
  */
-declare const identifyOnlySkip: Flow.StepExample;
+declare const identifyOnlySilent: Flow.StepExample;
 /**
- * Consent revocation — walkerOS walker consent { marketing: false }.
+ * Consent revocation - walkerOS walker consent { marketing: false }.
  * The destination's on('consent') handler flips the runtime state flag
  * and stops calling pintrk('track', ...) for subsequent events.
  */
 declare const consentRevoke: Flow.StepExample;
 /**
- * Consent grant — explicit opt-in.
+ * Consent grant - explicit opt-in.
  */
 declare const consentGrant: Flow.StepExample;
 
 declare const step_consentGrant: typeof consentGrant;
 declare const step_consentRevoke: typeof consentRevoke;
 declare const step_defaultForward: typeof defaultForward;
-declare const step_identifyOnlySkip: typeof identifyOnlySkip;
+declare const step_identifyOnlySilent: typeof identifyOnlySilent;
 declare const step_orderCompleteCheckout: typeof orderCompleteCheckout;
 declare const step_pageViewRename: typeof pageViewRename;
 declare const step_productAddToCart: typeof productAddToCart;
@@ -203,7 +203,7 @@ declare const step_siteSearch: typeof siteSearch;
 declare const step_userLoginLead: typeof userLoginLead;
 declare const step_wildcardIgnored: typeof wildcardIgnored;
 declare namespace step {
-  export { step_consentGrant as consentGrant, step_consentRevoke as consentRevoke, step_defaultForward as defaultForward, step_identifyOnlySkip as identifyOnlySkip, step_orderCompleteCheckout as orderCompleteCheckout, step_pageViewRename as pageViewRename, step_productAddToCart as productAddToCart, step_productViewContent as productViewContent, step_siteSearch as siteSearch, step_userLoginLead as userLoginLead, step_wildcardIgnored as wildcardIgnored };
+  export { step_consentGrant as consentGrant, step_consentRevoke as consentRevoke, step_defaultForward as defaultForward, step_identifyOnlySilent as identifyOnlySilent, step_orderCompleteCheckout as orderCompleteCheckout, step_pageViewRename as pageViewRename, step_productAddToCart as productAddToCart, step_productViewContent as productViewContent, step_siteSearch as siteSearch, step_userLoginLead as userLoginLead, step_wildcardIgnored as wildcardIgnored };
 }
 
 declare const index_env: typeof env;

package/dist/dev.d.ts

@@ -138,24 +138,24 @@ declare namespace env {
  *   - Zero SDK calls: out = []
  */
 /**
- * Default event forwarding — no rule. Without a mapping.name, the walkerOS
+ * Default event forwarding - no rule. Without a mapping.name, the walkerOS
  * event name is forwarded as-is. Pinterest accepts it but won't match a
  * standard conversion event. event_id is auto-attached for deduplication.
  */
 declare const defaultForward: Flow.StepExample;
 /**
- * Wildcard ignore pattern — the standard walkerOS way to suppress noisy
+ * Wildcard ignore pattern - the standard walkerOS way to suppress noisy
  * events. `mapping.ignore: true` at rule level produces zero SDK calls.
  */
 declare const wildcardIgnored: Flow.StepExample;
 /**
  * Standard Pinterest event rename via mapping.name. walkerOS "page view"
  * → Pinterest "pagevisit". The ONLY way to get Pinterest to recognize
- * a conversion event — the destination never auto-maps.
+ * a conversion event - the destination never auto-maps.
  */
 declare const pageViewRename: Flow.StepExample;
 /**
- * Search — walkerOS site search → Pinterest "search" with search_query.
+ * Search - walkerOS site search → Pinterest "search" with search_query.
  * Illustrates single-field mapping.data resolution.
  */
 declare const siteSearch: Flow.StepExample;
@@ -168,7 +168,7 @@ declare const productViewContent: Flow.StepExample;
  */
 declare const productAddToCart: Flow.StepExample;
 /**
- * Multi-product checkout — the canonical Pinterest ecommerce pattern.
+ * Multi-product checkout - the canonical Pinterest ecommerce pattern.
  */
 declare const orderCompleteCheckout: Flow.StepExample;
 /**
@@ -176,25 +176,25 @@ declare const orderCompleteCheckout: Flow.StepExample;
  */
 declare const userLoginLead: Flow.StepExample;
 /**
- * mapping.skip — processes side effects (identify set) but suppresses
+ * mapping.silent - processes side effects (identify set) but suppresses
  * the default pintrk('track', ...) call.
  */
-declare const identifyOnlySkip: Flow.StepExample;
+declare const identifyOnlySilent: Flow.StepExample;
 /**
- * Consent revocation — walkerOS walker consent { marketing: false }.
+ * Consent revocation - walkerOS walker consent { marketing: false }.
  * The destination's on('consent') handler flips the runtime state flag
  * and stops calling pintrk('track', ...) for subsequent events.
  */
 declare const consentRevoke: Flow.StepExample;
 /**
- * Consent grant — explicit opt-in.
+ * Consent grant - explicit opt-in.
  */
 declare const consentGrant: Flow.StepExample;
 
 declare const step_consentGrant: typeof consentGrant;
 declare const step_consentRevoke: typeof consentRevoke;
 declare const step_defaultForward: typeof defaultForward;
-declare const step_identifyOnlySkip: typeof identifyOnlySkip;
+declare const step_identifyOnlySilent: typeof identifyOnlySilent;
 declare const step_orderCompleteCheckout: typeof orderCompleteCheckout;
 declare const step_pageViewRename: typeof pageViewRename;
 declare const step_productAddToCart: typeof productAddToCart;
@@ -203,7 +203,7 @@ declare const step_siteSearch: typeof siteSearch;
 declare const step_userLoginLead: typeof userLoginLead;
 declare const step_wildcardIgnored: typeof wildcardIgnored;
 declare namespace step {
-  export { step_consentGrant as consentGrant, step_consentRevoke as consentRevoke, step_defaultForward as defaultForward, step_identifyOnlySkip as identifyOnlySkip, step_orderCompleteCheckout as orderCompleteCheckout, step_pageViewRename as pageViewRename, step_productAddToCart as productAddToCart, step_productViewContent as productViewContent, step_siteSearch as siteSearch, step_userLoginLead as userLoginLead, step_wildcardIgnored as wildcardIgnored };
+  export { step_consentGrant as consentGrant, step_consentRevoke as consentRevoke, step_defaultForward as defaultForward, step_identifyOnlySilent as identifyOnlySilent, step_orderCompleteCheckout as orderCompleteCheckout, step_pageViewRename as pageViewRename, step_productAddToCart as productAddToCart, step_productViewContent as productViewContent, step_siteSearch as siteSearch, step_userLoginLead as userLoginLead, step_wildcardIgnored as wildcardIgnored };
 }
 
 declare const index_env: typeof env;