@capgo/capacitor-contentsquare

Capacitor 8 wrapper for the official Contentsquare mobile SDKs.

This package keeps the official Contentsquare Capacitor API shape while updating the plugin packaging for Capacitor 8, Swift Package Manager, and Capgo's standard plugin template.

The upstream product documentation is available at docs.contentsquare.com/en/capacitor/.

This is a community Capacitor 8 port. Contentsquare's official package currently targets Capacitor 7, but the documented API surface remains the same.

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-contentsquare` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

bun add @capgo/capacitor-contentsquare
bunx cap sync

import { ContentsquarePlugin, CurrencyCode } from '@capgo/capacitor-contentsquare';

await ContentsquarePlugin.optIn();

await ContentsquarePlugin.sendScreenName('Home');

await ContentsquarePlugin.sendTransaction({
  transactionValue: 10,
  transactionCurrency: CurrencyCode.EUR,
  transactionId: 'order-42',
});

await ContentsquarePlugin.sendDynamicVar({
  dynVarKey: 'store',
  dynVarValue: 'rome',
});

To enable Contentsquare in-app features on iOS, your host app still needs the upstream deeplink wiring described in the official docs:

1. Add the cs-$(PRODUCT_BUNDLE_IDENTIFIER) URL scheme to the app.
2. Forward incoming Contentsquare URLs with Contentsquare.handle(url: url) from your AppDelegate, SceneDelegate, or SwiftUI onOpenURL.

• optIn()
• optOut()
• sendScreenName(...)
• sendTransaction(...)
• sendDynamicVar(...)
• excludeURLForReplay(...)
• setPIISelectors(...)
• setCapturedElementsSelector(...)
• Interfaces
• Enums

Public Contentsquare API for Capacitor applications.

optIn() => Promise<void>

Marks the user as opted in and starts tracking.

optOut() => Promise<void>

Stops tracking, clears local Contentsquare state, and opts the user out.

sendScreenName(name: string) => Promise<void>

Sends a screenview event for the current screen.

sendTransaction(transactionItem: TransactionItem) => Promise<void>

Sends a transaction to Contentsquare.

sendDynamicVar(dynamicVarItem: DynamicVarItem) => Promise<void>

Sends a dynamic variable.

The value must be either a string or a non-negative integer.

excludeURLForReplay(url: string) => Promise<void>

Excludes URLs matching the provided JavaScript regular expression literal from Session Replay.

Example: "/checkout/".

setPIISelectors(pii: PIIConfig) => Promise<void>

Applies Session Replay masking rules to specific selectors and attributes.

setCapturedElementsSelector(elements: string) => Promise<void>

Allows specific elements to be captured even when the current page is masked.

Transaction payload sent to Contentsquare.

Dynamic variable payload.

Selector and attribute masking configuration for Session Replay.

Attribute masking rule used by setPIISelectors.