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

package/README.md

@@ -1,7 +1,7 @@
 # LinkedIn Web Destination for walkerOS
 
 Forward walkerOS events as LinkedIn Insight Tag conversions
-(`window.lintrk('track', ...)`) — opt-in, per-event, with value + currency +
+(`window.lintrk('track', ...)`) - opt-in, per-event, with value + currency +
 deduplication support.
 
 ## Source Code
@@ -18,22 +18,22 @@ deduplication support.
 
 ## Features
 
-- **Opt-in conversion forwarding** — only events with
+- **Opt-in conversion forwarding** - only events with
   `mapping.settings.conversion` fire a `lintrk('track')` call. Unmapped events
   are silently ignored (Campaign Manager requires pre-registered conversion
   rules).
-- **Automatic page view + retargeting** — the Insight Tag script fires its own
+- **Automatic page view + retargeting** - the Insight Tag script fires its own
   page view on load for audience building. The destination does not suppress or
   duplicate it.
-- **Conversion value + currency** — `data.total`-style mappings with a currency
+- **Conversion value + currency** - `data.total`-style mappings with a currency
   fallback via `{ key, value }` syntax (defaults to `"EUR"`).
-- **Deduplication ready** — maps the walkerOS event `id` to LinkedIn's
+- **Deduplication ready** - maps the walkerOS event `id` to LinkedIn's
   `event_id`, ready for cross-channel deduplication with a future server
   (Conversions API) destination.
-- **Consent-gated** — LinkedIn requires `marketing` consent. The collector's
+- **Consent-gated** - LinkedIn requires `marketing` consent. The collector's
   `config.consent` gate blocks events until granted; deferred script injection
   is supported via `loadScript: true`.
-- **Script-tag loader** — no npm SDK dependency. The destination injects
+- **Script-tag loader** - no npm SDK dependency. The destination injects
   `https://snap.licdn.com/li.lms-analytics/insight.min.js` at runtime (opt-in
   via `loadScript: true`), or you can embed the Insight Tag snippet in your HTML
   and leave `loadScript: false`.
@@ -86,7 +86,7 @@ npm install @walkeros/web-destination-linkedin
 | Key       | Type       | Required | Notes                                                                                                                                                                                          |
 | --------- | ---------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `apiKey`  | `string`   | yes      | LinkedIn Partner ID (numeric string, e.g. `"123456"`). Find it in Campaign Manager → Insight Tag → Manage Insight Tag.                                                                         |
-| `include` | `string[]` | no       | Event sections made available for mapping resolution. Present for consistency with other destinations — `lintrk()` only accepts four fixed fields, so included data is not automatically sent. |
+| `include` | `string[]` | no       | Event sections made available for mapping resolution. Present for consistency with other destinations - `lintrk()` only accepts four fixed fields, so included data is not automatically sent. |
 
 ### Mapping (per-event)
 
@@ -108,7 +108,7 @@ npm install @walkeros/web-destination-linkedin
 LinkedIn is an **opt-in conversion platform**. Every tracked event must
 reference a pre-created Conversion Rule in Campaign Manager via its numeric
 `conversion_id`. Events without an explicit `mapping.settings.conversion` are
-silently ignored — they produce zero `lintrk` calls.
+silently ignored - they produce zero `lintrk` calls.
 
 This is the opposite of analytics destinations (Amplitude, Clarity, PostHog)
 which forward every event by default.
@@ -137,13 +137,13 @@ which forward every event by default.
 Resolves to:
 `lintrk('track', { conversion_id: 67890, conversion_value: 555, currency: 'EUR', event_id: '<walker-event-id>' })`.
 
-### Skipping a fully configured rule
+### Suppressing a fully configured rule
 
 ```json
 "mapping": {
   "form": {
     "submit": {
-      "skip": true,
+      "silent": true,
       "settings": {
         "conversion": { "map": { "id": { "value": 12345 } } }
       }
@@ -152,8 +152,8 @@ Resolves to:
 }
 ```
 
-`mapping.skip: true` suppresses the call while keeping the rule on disk for
-quick reactivation. Alternatively, simply omit `settings.conversion` —
+`mapping.silent: true` suppresses the call while keeping the rule on disk for
+quick reactivation. Alternatively, simply omit `settings.conversion` -
 LinkedIn's opt-in model makes that equivalent.
 
 ## Consent
@@ -168,7 +168,7 @@ consent (not analytics):
 ```
 
 walkerOS's collector blocks all events to this destination until `marketing` is
-granted. When consent is later revoked, walkerOS stops sending events — the
+granted. When consent is later revoked, walkerOS stops sending events - the
 LinkedIn Insight Tag itself has no `opt_out()` API, so the tag remains loaded
 but receives no further calls.
 
@@ -181,7 +181,7 @@ when an `on('consent')` event grants marketing.
 
 ## No identity tracking
 
-LinkedIn identity on the web is cookie-based — the Insight Tag manages its own
+LinkedIn identity on the web is cookie-based - the Insight Tag manages its own
 first-party cookies and matches visitors against LinkedIn member profiles
 server-side. There is no `lintrk('identify', ...)` API. The destination does
 **not** forward user IDs, emails, phone numbers, or the `li_fat_id` click ID.

package/dist/dev.d.mts

@@ -120,7 +120,7 @@ declare namespace env {
  * Examples may optionally override destination-level settings for a test.
  * The test runner reads `settings` from the example and merges it into the
  * base destination settings (on top of the fixed `apiKey`). Rarely needed
- * for LinkedIn — conversion config lives on the rule, not destination-level.
+ * for LinkedIn - conversion config lives on the rule, not destination-level.
  */
 type LinkedInStepExample = Flow.StepExample & {
     settings?: Partial<Settings>;
@@ -130,12 +130,12 @@ type LinkedInStepExample = Flow.StepExample & {
  *
  * LinkedIn's core behavioral difference from analytics destinations: events
  * without `mapping.settings.conversion` produce ZERO lintrk() calls. The
- * destination is opt-in — each conversion must reference a pre-created
+ * destination is opt-in - each conversion must reference a pre-created
  * Conversion Rule from Campaign Manager.
  */
 declare const unmappedEventIgnored: LinkedInStepExample;
 /**
- * Simplest possible conversion — just a `conversion_id` from Campaign Manager.
+ * Simplest possible conversion - just a `conversion_id` from Campaign Manager.
  *
  * Form submission → LinkedIn Lead conversion. The mapping resolves `id` as a
  * literal value (no walker event field needed). The destination translates
@@ -143,18 +143,18 @@ declare const unmappedEventIgnored: LinkedInStepExample;
  */
 declare const simpleConversionId: LinkedInStepExample;
 /**
- * Full e-commerce conversion — every supported lintrk field populated.
+ * Full e-commerce conversion - every supported lintrk field populated.
  *
  * mapping config uses short walkerOS keys (`id`, `value`, `currency`, `eventId`);
  * the destination translates them to the vendor parameter names
  * (`conversion_id`, `conversion_value`, `currency`, `event_id`).
  *
- * Currency uses the walkerOS fallback syntax: `{ key, value }` — pull from
+ * Currency uses the walkerOS fallback syntax: `{ key, value }` - pull from
  * `data.currency` first, fall back to `"EUR"` if absent. The default
  * `order complete` fixture from `getEvent` already sets `data.currency: "EUR"`,
  * so the resolved value is "EUR" here.
  *
- * `eventId` maps from the walkerOS event.id — stable per event, unique, and
+ * `eventId` maps from the walkerOS event.id - stable per event, unique, and
  * ready for deduplication with a future server (Conversions API) destination.
  */
 declare const orderCompleteFullConversion: LinkedInStepExample;
@@ -162,7 +162,7 @@ declare const orderCompleteFullConversion: LinkedInStepExample;
  * Page view as an explicit conversion.
  *
  * LinkedIn's Insight Tag automatically fires a page view on load for
- * retargeting / audience building — that call is NOT something the
+ * retargeting / audience building - that call is NOT something the
  * destination controls. This example tests the OTHER case: mapping a
  * specific walkerOS `page view` event to a Campaign Manager KEY_PAGE_VIEW
  * conversion rule, which fires an EXPLICIT lintrk('track') call in addition
@@ -170,23 +170,23 @@ declare const orderCompleteFullConversion: LinkedInStepExample;
  */
 declare const pageViewConversion: LinkedInStepExample;
 /**
- * Middle-funnel LEAD conversion — demo request without monetary value.
+ * Middle-funnel LEAD conversion - demo request without monetary value.
  *
  * LinkedIn's conversion types include LEAD, CONTACT, SIGN_UP, etc. The
  * destination is agnostic to the type (set in Campaign Manager, not at call
- * time) — all we forward is the conversion_id. This fixture exercises the
+ * time) - all we forward is the conversion_id. This fixture exercises the
  * "id + eventId only" shape.
  */
 declare const demoRequestLead: LinkedInStepExample;
 /**
- * rule.skip — fully-configured conversion rule temporarily disabled.
+ * rule.silent - fully-configured conversion rule temporarily disabled.
  *
- * The rule has a valid `conversion.map` but `skip: true` tells the destination
+ * The rule has a valid `conversion.map` but `silent: true` tells the destination
  * to produce zero calls. This is distinct from the opt-in default (no
- * `conversion` at all): skip explicitly keeps the rule on disk for quick
+ * `conversion` at all): silent explicitly keeps the rule on disk for quick
  * reactivation without deleting it.
  */
-declare const conversionSkipped: LinkedInStepExample;
+declare const conversionSilenced: LinkedInStepExample;
 /**
  * Falsy `id` → entire lintrk call is skipped.
  *
@@ -194,21 +194,21 @@ declare const conversionSkipped: LinkedInStepExample;
  * NOT call lintrk at all. This protects against misconfigured mappings
  * (e.g. pulling id from a non-existent field).
  *
- * Here we map `id` from `data.nonexistentField` — it resolves to undefined,
+ * Here we map `id` from `data.nonexistentField` - it resolves to undefined,
  * so zero calls are produced.
  */
 declare const missingConversionIdIgnored: LinkedInStepExample;
 /**
- * Partial conversion — value missing → omitted from the lintrk call.
+ * Partial conversion - value missing → omitted from the lintrk call.
  *
  * The rule asks for `value: 'data.missingTotal'` (undefined), `currency`
  * (undefined), and `eventId: 'id'` (present). Only `conversion_id` and
- * `event_id` appear in the final call — no `conversion_value`, no `currency`.
+ * `event_id` appear in the final call - no `conversion_value`, no `currency`.
  */
 declare const partialFieldsOmitted: LinkedInStepExample;
 
 type step_LinkedInStepExample = LinkedInStepExample;
-declare const step_conversionSkipped: typeof conversionSkipped;
+declare const step_conversionSilenced: typeof conversionSilenced;
 declare const step_demoRequestLead: typeof demoRequestLead;
 declare const step_missingConversionIdIgnored: typeof missingConversionIdIgnored;
 declare const step_orderCompleteFullConversion: typeof orderCompleteFullConversion;
@@ -217,7 +217,7 @@ declare const step_partialFieldsOmitted: typeof partialFieldsOmitted;
 declare const step_simpleConversionId: typeof simpleConversionId;
 declare const step_unmappedEventIgnored: typeof unmappedEventIgnored;
 declare namespace step {
-  export { type step_LinkedInStepExample as LinkedInStepExample, step_conversionSkipped as conversionSkipped, step_demoRequestLead as demoRequestLead, step_missingConversionIdIgnored as missingConversionIdIgnored, step_orderCompleteFullConversion as orderCompleteFullConversion, step_pageViewConversion as pageViewConversion, step_partialFieldsOmitted as partialFieldsOmitted, step_simpleConversionId as simpleConversionId, step_unmappedEventIgnored as unmappedEventIgnored };
+  export { type step_LinkedInStepExample as LinkedInStepExample, step_conversionSilenced as conversionSilenced, step_demoRequestLead as demoRequestLead, step_missingConversionIdIgnored as missingConversionIdIgnored, step_orderCompleteFullConversion as orderCompleteFullConversion, step_pageViewConversion as pageViewConversion, step_partialFieldsOmitted as partialFieldsOmitted, step_simpleConversionId as simpleConversionId, step_unmappedEventIgnored as unmappedEventIgnored };
 }
 
 declare const index_env: typeof env;

package/dist/dev.d.ts

@@ -120,7 +120,7 @@ declare namespace env {
  * Examples may optionally override destination-level settings for a test.
  * The test runner reads `settings` from the example and merges it into the
  * base destination settings (on top of the fixed `apiKey`). Rarely needed
- * for LinkedIn — conversion config lives on the rule, not destination-level.
+ * for LinkedIn - conversion config lives on the rule, not destination-level.
  */
 type LinkedInStepExample = Flow.StepExample & {
     settings?: Partial<Settings>;
@@ -130,12 +130,12 @@ type LinkedInStepExample = Flow.StepExample & {
  *
  * LinkedIn's core behavioral difference from analytics destinations: events
  * without `mapping.settings.conversion` produce ZERO lintrk() calls. The
- * destination is opt-in — each conversion must reference a pre-created
+ * destination is opt-in - each conversion must reference a pre-created
  * Conversion Rule from Campaign Manager.
  */
 declare const unmappedEventIgnored: LinkedInStepExample;
 /**
- * Simplest possible conversion — just a `conversion_id` from Campaign Manager.
+ * Simplest possible conversion - just a `conversion_id` from Campaign Manager.
  *
  * Form submission → LinkedIn Lead conversion. The mapping resolves `id` as a
  * literal value (no walker event field needed). The destination translates
@@ -143,18 +143,18 @@ declare const unmappedEventIgnored: LinkedInStepExample;
  */
 declare const simpleConversionId: LinkedInStepExample;
 /**
- * Full e-commerce conversion — every supported lintrk field populated.
+ * Full e-commerce conversion - every supported lintrk field populated.
  *
  * mapping config uses short walkerOS keys (`id`, `value`, `currency`, `eventId`);
  * the destination translates them to the vendor parameter names
  * (`conversion_id`, `conversion_value`, `currency`, `event_id`).
  *
- * Currency uses the walkerOS fallback syntax: `{ key, value }` — pull from
+ * Currency uses the walkerOS fallback syntax: `{ key, value }` - pull from
  * `data.currency` first, fall back to `"EUR"` if absent. The default
  * `order complete` fixture from `getEvent` already sets `data.currency: "EUR"`,
  * so the resolved value is "EUR" here.
  *
- * `eventId` maps from the walkerOS event.id — stable per event, unique, and
+ * `eventId` maps from the walkerOS event.id - stable per event, unique, and
  * ready for deduplication with a future server (Conversions API) destination.
  */
 declare const orderCompleteFullConversion: LinkedInStepExample;
@@ -162,7 +162,7 @@ declare const orderCompleteFullConversion: LinkedInStepExample;
  * Page view as an explicit conversion.
  *
  * LinkedIn's Insight Tag automatically fires a page view on load for
- * retargeting / audience building — that call is NOT something the
+ * retargeting / audience building - that call is NOT something the
  * destination controls. This example tests the OTHER case: mapping a
  * specific walkerOS `page view` event to a Campaign Manager KEY_PAGE_VIEW
  * conversion rule, which fires an EXPLICIT lintrk('track') call in addition
@@ -170,23 +170,23 @@ declare const orderCompleteFullConversion: LinkedInStepExample;
  */
 declare const pageViewConversion: LinkedInStepExample;
 /**
- * Middle-funnel LEAD conversion — demo request without monetary value.
+ * Middle-funnel LEAD conversion - demo request without monetary value.
  *
  * LinkedIn's conversion types include LEAD, CONTACT, SIGN_UP, etc. The
  * destination is agnostic to the type (set in Campaign Manager, not at call
- * time) — all we forward is the conversion_id. This fixture exercises the
+ * time) - all we forward is the conversion_id. This fixture exercises the
  * "id + eventId only" shape.
  */
 declare const demoRequestLead: LinkedInStepExample;
 /**
- * rule.skip — fully-configured conversion rule temporarily disabled.
+ * rule.silent - fully-configured conversion rule temporarily disabled.
  *
- * The rule has a valid `conversion.map` but `skip: true` tells the destination
+ * The rule has a valid `conversion.map` but `silent: true` tells the destination
  * to produce zero calls. This is distinct from the opt-in default (no
- * `conversion` at all): skip explicitly keeps the rule on disk for quick
+ * `conversion` at all): silent explicitly keeps the rule on disk for quick
  * reactivation without deleting it.
  */
-declare const conversionSkipped: LinkedInStepExample;
+declare const conversionSilenced: LinkedInStepExample;
 /**
  * Falsy `id` → entire lintrk call is skipped.
  *
@@ -194,21 +194,21 @@ declare const conversionSkipped: LinkedInStepExample;
  * NOT call lintrk at all. This protects against misconfigured mappings
  * (e.g. pulling id from a non-existent field).
  *
- * Here we map `id` from `data.nonexistentField` — it resolves to undefined,
+ * Here we map `id` from `data.nonexistentField` - it resolves to undefined,
  * so zero calls are produced.
  */
 declare const missingConversionIdIgnored: LinkedInStepExample;
 /**
- * Partial conversion — value missing → omitted from the lintrk call.
+ * Partial conversion - value missing → omitted from the lintrk call.
  *
  * The rule asks for `value: 'data.missingTotal'` (undefined), `currency`
  * (undefined), and `eventId: 'id'` (present). Only `conversion_id` and
- * `event_id` appear in the final call — no `conversion_value`, no `currency`.
+ * `event_id` appear in the final call - no `conversion_value`, no `currency`.
  */
 declare const partialFieldsOmitted: LinkedInStepExample;
 
 type step_LinkedInStepExample = LinkedInStepExample;
-declare const step_conversionSkipped: typeof conversionSkipped;
+declare const step_conversionSilenced: typeof conversionSilenced;
 declare const step_demoRequestLead: typeof demoRequestLead;
 declare const step_missingConversionIdIgnored: typeof missingConversionIdIgnored;
 declare const step_orderCompleteFullConversion: typeof orderCompleteFullConversion;
@@ -217,7 +217,7 @@ declare const step_partialFieldsOmitted: typeof partialFieldsOmitted;
 declare const step_simpleConversionId: typeof simpleConversionId;
 declare const step_unmappedEventIgnored: typeof unmappedEventIgnored;
 declare namespace step {
-  export { type step_LinkedInStepExample as LinkedInStepExample, step_conversionSkipped as conversionSkipped, step_demoRequestLead as demoRequestLead, step_missingConversionIdIgnored as missingConversionIdIgnored, step_orderCompleteFullConversion as orderCompleteFullConversion, step_pageViewConversion as pageViewConversion, step_partialFieldsOmitted as partialFieldsOmitted, step_simpleConversionId as simpleConversionId, step_unmappedEventIgnored as unmappedEventIgnored };
+  export { type step_LinkedInStepExample as LinkedInStepExample, step_conversionSilenced as conversionSilenced, step_demoRequestLead as demoRequestLead, step_missingConversionIdIgnored as missingConversionIdIgnored, step_orderCompleteFullConversion as orderCompleteFullConversion, step_pageViewConversion as pageViewConversion, step_partialFieldsOmitted as partialFieldsOmitted, step_simpleConversionId as simpleConversionId, step_unmappedEventIgnored as unmappedEventIgnored };
 }
 
 declare const index_env: typeof env;