@contentpass/react-native-contentpass 0.2.5 → 0.3.0

package/README.md

@@ -37,9 +37,12 @@ npx expo prebuild
 
 ### Initialization
 Wrap your app's root component with ContentpassSdkProvider. The provider requires a configuration object (contentpassConfig) with the following properties:
-- `propertyId` - Your unique property ID
+- `propertyId` - Your unique property ID (ask Contentpass team for details)
+- `planId` - The ID of the plan you want to check the user's subscription status against (ask Contentpass team for details)
 - `issuer` - The OAuth 2.0 server URL (e.g. `https://my.contentpass.net`)
 - `redirectUrl` - the redirect URL of your app to which the OAuth2 server will redirect after the authentication
+- `samplingRate` - Optional: The rate at which the SDK will send impression events for unauthenticated users. Default is 0.05 (5%)
+- `logLevel` - Optional: The log level for the SDK. By default logger is disabled. Possible values are 'info', 'warn', 'error' and 'debug'
 
 
 ```jsx
@@ -47,9 +50,12 @@ import React from 'react';
 import { ContentpassSdkProvider } from '@contentpass/react-native-contentpass';
 
 const contentpassConfig = {
-  propertyId: 'your-property-id',
+  propertyId: 'property-id',
+  planId: 'plan-id',
   issuer: 'https://my.contentpass.net',
   redirectUrl: 'com.yourapp://oauthredirect',
+  samplingRate: 0.1,
+  logLevel: 'info'
 };
 
 const App = () => {
@@ -70,6 +76,10 @@ The SDK exposes the following methods through the `useContentpassSdk` hook:
 Initiates the OAuth 2.0 authentication process via a modal interface. It validates the user’s active Contentpass subscriptions
 upon successful authentication.
 
+### countImpression
+Tracks and increments the impression count for the current user. This method should be invoked whenever a user views a
+piece of content. It applies to all users, whether authenticated or unauthenticated.
+
 ### registerObserver
 Registers a callback function to listen for changes in the user’s authentication and subscription status. The observer function
 receives a state object describing the current status (see the exported [ContentpassState](./src/types/ContentpassState.ts) type).
@@ -94,6 +104,7 @@ import { Button, View } from 'react-native';
 const YourApp = () => {
   const {
     authenticate,
+    countImpression,
     registerObserver,
     unregisterObserver,
     logout,
@@ -115,15 +126,20 @@ const YourApp = () => {
   return (
     <View>
       <Button onPress={authenticate} title={'Authenticate'} />
+      <Button onPress={countImpression} title={'Count Impression'} />
     </View>
   );
 };
 ```
 
+## Integration with Sourcepoint SDK
+
+See the [Sourcepoint SDK documentation](docs/SOURCEPOINT_SDK_INTEGRATION.md) for information on integrating the Contentpass SDK with the Sourcepoint SDK.
 
 ## Contributing
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+See the [contributing guide](docs/CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
 
 ## License
 

package/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/docs/CONTRIBUTING.md

@@ -0,0 +1,137 @@
+# Contributing
+
+Contributions are always welcome, no matter how large or small!
+
+We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).
+
+## Development workflow
+
+This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
+
+- The library package in the root directory.
+- An example app in the `example/` directory.
+- An expo example app in the `expoExample/` directory.
+- A shared frontend code for example apps in the `sharedExample/` directory.
+
+To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
+
+```sh
+yarn
+```
+
+> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
+
+The [example app](/example/) and [expo example app](/expoExample/) demonstrates usage of the library. You need to run it to test any changes you make.
+
+It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example apps.
+Changes to the library's JavaScript code will be reflected in the example apps without a rebuild, but native code changes will require a rebuild of the example app.
+
+If you want to use Android Studio or XCode to edit the native code, you can open the
+- `example/android`
+- `example/ios`
+- `expoExample/android`
+- `expoExample/ios`
+directories respectively in those editors. To edit the Objective-C or Swift files, open `ios/ContentpassExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > contentpass-react-native-contentpass`.
+
+To edit the Java or Kotlin files, open `android` in Android studio and find the source files at `@contentpass/react-native-contentpass` under `Android`.
+
+You can use various commands from the root directory to work with the project.
+
+To start the packager:
+
+```sh
+yarn example start
+```
+
+OR
+
+```sh
+yarn expo-example start
+```
+
+To run the example app on Android:
+
+```sh
+yarn example android
+```
+
+OR
+
+```sh
+yarn expo-example android
+```
+
+To run the example app on iOS:
+
+```sh
+yarn example ios
+```
+
+OR
+
+```sh
+yarn expo-example ios
+```
+
+Make sure your code passes TypeScript, ESLint and Prettier. Run the following to verify:
+
+```sh
+yarn typecheck
+yarn lint
+yarn prettier:check
+```
+
+To fix formatting errors, run the following:
+
+```sh
+yarn lint --fix
+```
+
+Remember to add tests for your change if possible. Run the unit tests by:
+
+```sh
+yarn test
+```
+
+### Commit message convention
+
+We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
+
+- `fix`: bug fixes, e.g. fix crash due to deprecated method.
+- `feat`: new features, e.g. add new method to the module.
+- `refactor`: code refactor, e.g. migrate from class components to hooks.
+- `docs`: changes into documentation, e.g. add usage example for the module..
+- `test`: adding or updating tests, e.g. add integration tests using detox.
+- `chore`: tooling changes, e.g. change CI config.
+
+Our pre-commit hooks verify that your commit message matches this format when committing.
+
+### Linting and tests
+
+[ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
+
+We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing.
+
+Our pre-commit hooks verify that the linter and tests pass when committing.
+
+### Publishing to npm
+
+We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
+
+To publish new versions, run the following:
+
+```sh
+yarn release
+```
+
+### Sending a pull request
+
+> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
+
+When you're sending a pull request:
+
+- Prefer small pull requests focused on one change.
+- Verify that linters and tests are passing.
+- Review the documentation to make sure it looks good.
+- Follow the pull request template when opening a pull request.
+- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.

package/docs/SOURCEPOINT_SDK_INTEGRATION.md

@@ -0,0 +1,112 @@
+# Integration with Sourcepoint SDK
+The Contentpass SDK can be seamlessly integrated with the Sourcepoint SDK to manage consent. Since the Sourcepoint SDK
+is a separate React Native package, you must install it independently. For detailed guidance, refer to the
+[Sourcepoint SDK documentation](https://github.com/SourcePointUSA/react-native-sourcepoint-cmp).
+
+
+## Setting Up Sourcepoint
+To use the Sourcepoint SDK, follow these steps:
+
+1. Create a Sourcepoint Account: Set up a Sourcepoint account and create a property with the type APP.
+2. Configure the Property, ensure the property includes:
+   - Campaigns
+   - Partition Sets
+   - Scenarios (with the `acps` parameter — see [here](https://docs.contentpass.net/docs/onboarding/cmp/sourcepoint#4-sourcepoint-contentpass-integration) for details)
+   - Messages
+
+For more information, consult the [Sourcepoint documentation](https://docs.sourcepoint.com/hc/en-us).
+
+A newly created property should resemble the following example:
+![sourcepoint-property-example.png](./assets/sourcepoint-property-example.png)
+
+### Adding a Custom Action to Sourcepoint Messages
+To integrate the Sourcepoint SDK with the Contentpass SDK, you must define a custom action in Sourcepoint Messages:
+1. Navigate to `Messages` > `GDPR Messages` > `Web / Webview (TCF)`.
+2. Edit the relevant message and add a custom action to the login button, such as `cp('login')`.
+3. This custom action will authenticate users through the Contentpass SDK.
+
+Example configuration:
+![sourcepoint-button-config.png](./assets/sourcepoint-button-config.png)
+
+## Code Integration
+After setting up Sourcepoint, install its SDK package. Use the following code to integrate Contentpass and Sourcepoint
+SDKs in your app.
+
+### Important note
+After creating a property in Sourcepoint, you must wait approximately 15 minutes before it becomes available for use
+with the `@sourcepoint/react-native-cmp` package. This delay allows the configuration to propagate.
+
+### Implementation
+Install the Sourcepoint SDK package, then use the following code to integrate the two SDKs in your app:
+
+```jsx
+import { useEffect, useRef, useState } from 'react';
+import { SPConsentManager } from '@sourcepoint/react-native-cmp';
+import { ContentpassStateType, useContentpassSdk } from '@contentpass/react-native-contentpass';
+
+const sourcePointConfig = {
+  accountId: 'SOURCEPOINT_ACCOUNT_ID',
+  propertyId: 'SOURCEPOINT_PROPERTY_ID',
+  propertyName: 'SOURCEPOINT_PROPERTY_NAME',
+};
+
+const setupSourcepoint = (hasValidSubscription) => {
+  const { accountId, propertyName, propertyId } = sourcePointConfig;
+  const spConsentManager = new SPConsentManager();
+
+  spConsentManager.build(accountId, propertyId, propertyName, {
+    gdpr: {
+      targetingParams: {
+        acps: hasValidSubscription ? 'true' : 'false',
+      },
+    },
+  });
+
+  return spConsentManager;
+};
+
+const App = () => {
+  const [authResult, setAuthResult] = useState();
+  const contentpassSdk = useContentpassSdk();
+  const spConsentManager = useRef();
+
+  useEffect(() => {
+    const onContentpassStateChange = (state) => {
+      setAuthResult(state);
+    };
+
+    contentpassSdk.registerObserver(onContentpassStateChange);
+
+    return () => {
+      contentpassSdk.unregisterObserver(onContentpassStateChange);
+    };
+  }, [contentpassSdk]);
+
+  useEffect(() => {
+    // wait for the authResult to be set before setting up Sourcepoint
+    if (!authResult || authResult.state === ContentpassStateType.INITIALISING) {
+      return;
+    }
+
+    spConsentManager.current = setupSourcepoint(
+      authResult.hasValidSubscription || false
+    );
+
+    spConsentManager.current?.onAction((action) => {
+      if (action.customActionId === "cp('login')") {
+        contentpassSdk.authenticate()
+      }
+    });
+
+    spConsentManager.current?.loadMessage();
+
+    return () => {
+      spConsentManager.current?.dispose();
+    };
+  }, [authResult, contentpassSdk]);
+
+  return (
+    //   Your app content
+  )
+}
+```

package/docs/sourcepoint-patches/@sourcepoint-react-native-cmp-npm-0.3.0-2434c31dc9.patch

@@ -0,0 +1,78 @@
+diff --git a/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpModule.kt b/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpModule.kt
+index deb04fb18dbd8adffcb225801ad35b3154a3c7ad..4d372d921cbae6163179435feb9c821e3c37134b 100644
+--- a/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpModule.kt
++++ b/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpModule.kt
+@@ -119,6 +119,7 @@ class RNSourcepointCmpModule internal constructor(context: ReactApplicationConte
+   override fun onAction(view: View, consentAction: ConsentAction): ConsentAction {
+     sendEvent(SDKEvent.onAction, createMap().apply {
+       putString("actionType", RNSourcepointActionType.from(consentAction.actionType).name)
++      putString("customActionId", consentAction.customActionId ?: "")
+     })
+     return consentAction
+   }
+diff --git a/ios/RNSourcepointCmp.swift b/ios/RNSourcepointCmp.swift
+index 556b56618c847ad8aeaf9cdc680813cc26b732a9..ba7d707232d72fe5038ec05fb6fdb8e27216e4ee 100644
+--- a/ios/RNSourcepointCmp.swift
++++ b/ios/RNSourcepointCmp.swift
+@@ -69,7 +69,10 @@ extension RNSourcepointCmp: SPDelegate {
+     func onAction(_ action: SPAction, from controller: UIViewController) {
+         RNSourcepointCmp.shared?.sendEvent(
+             withName: "onAction",
+-            body: ["actionType": RNSourcepointActionType(from: action.type).rawValue]
++            body: [
++                "actionType": RNSourcepointActionType(from: action.type).rawValue,
++                "customActionId": action.customActionId ?? "",
++            ]
+         )
+     }
+ 
+diff --git a/lib/typescript/src/index.d.ts b/lib/typescript/src/index.d.ts
+index 1602516717becd5ec0a8e5036ad2d821110af96f..67bb9e5153b7489c5ead4dcd056b502b71bc2a7d 100644
+--- a/lib/typescript/src/index.d.ts
++++ b/lib/typescript/src/index.d.ts
+@@ -12,6 +12,7 @@ export declare class SPConsentManager implements Spec {
+     loadUSNatPrivacyManager(pmId: string): void;
+     onAction(callback: (body: {
+         actionType: SPActionType;
++        customActionId: string;
+     }) => void): void;
+     onSPUIReady(callback: () => void): void;
+     onSPUIFinished(callback: () => void): void;
+diff --git a/lib/typescript/src/types.d.ts b/lib/typescript/src/types.d.ts
+index a15f7a06c3e0635168987a44a33009ff42bbd31c..a035a72af14f32adf0ff88f959eb8c517ffaea47 100644
+--- a/lib/typescript/src/types.d.ts
++++ b/lib/typescript/src/types.d.ts
+@@ -86,6 +86,7 @@ export interface Spec extends TurboModule {
+     loadUSNatPrivacyManager(pmId: string): void;
+     onAction(callback: (body: {
+         actionType: SPActionType;
++        customActionId: string;
+     }) => void): void;
+     onSPUIReady(callback: () => void): void;
+     onSPUIFinished(callback: () => void): void;
+diff --git a/src/index.ts b/src/index.ts
+index b3e76b15572c56f1a4e54068b90243d6dd028e18..a03d87fea4a93edb6bf904c99d32b029b840bade 100644
+--- a/src/index.ts
++++ b/src/index.ts
+@@ -67,7 +67,7 @@ export class SPConsentManager implements Spec {
+     RNSourcepointCmp.loadUSNatPrivacyManager(pmId);
+   }
+ 
+-  onAction(callback: (body: { actionType: SPActionType }) => void): void {
++  onAction(callback: (body: { actionType: SPActionType, customActionId: string }) => void): void {
+     this.emitter.removeAllListeners('onAction');
+     this.emitter.addListener('onAction', callback);
+   }
+diff --git a/src/types.ts b/src/types.ts
+index 26ac3d8162c0534af98e2a20d237856195fe5a10..4257aff5ed128988c7d3fba60545672966162b20 100644
+--- a/src/types.ts
++++ b/src/types.ts
+@@ -113,7 +113,7 @@ export interface Spec extends TurboModule {
+   loadGDPRPrivacyManager(pmId: string): void;
+   loadUSNatPrivacyManager(pmId: string): void;
+ 
+-  onAction(callback: (body: { actionType: SPActionType }) => void): void;
++  onAction(callback: (body: { actionType: SPActionType, customActionId: string }) => void): void;
+   onSPUIReady(callback: () => void): void;
+   onSPUIFinished(callback: () => void): void;
+   onFinished(callback: () => void): void;

package/docs/sourcepoint-patches/@sourcepoint-react-native-cmp-patch-34fca36663.patch

@@ -0,0 +1,13 @@
+diff --git a/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpTypes.kt b/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpTypes.kt
+index bb8c6c37adc3d7980c7e92268b98b9d97ef8de40..3d67b3a3f44743c4542a1966e66e1af3ea93c555 100644
+--- a/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpTypes.kt
++++ b/android/src/main/java/com/sourcepoint/reactnativecmp/RNSourcepointCmpTypes.kt
+@@ -16,7 +16,7 @@ data class SPCampaign(
+   val rawTargetingParam: ReadableMap?,
+   val supportLegacyUSPString: Boolean
+ ) {
+-  val targetingParams = rawTargetingParam?.toHashMap()?.map { TargetingParam(it.key, it.toString()) } ?: emptyList()
++  val targetingParams = rawTargetingParam?.toHashMap()?.map { TargetingParam(it.key, it.value.toString()) } ?: emptyList()
+ }
+ 
+ data class SPCampaigns(