Add new tracker for React Native (snowplow#1371)

Author: matus-tomlein

.github/workflows/change_check.yml

@@ -50,6 +50,10 @@ jobs:
  working-directory: ./trackers/node-tracker
  run: api-extractor run
 
+ - name: Check for API changes to @snowplow/react-native-tracker
+ working-directory: ./trackers/react-native-tracker
+ run: api-extractor run
+
  - name: Check bundle size using bundlemon
  run: npx bundlemon@1.4.0
  env:

.github/workflows/publish.yml

@@ -75,10 +75,17 @@ jobs:
  api-extractor run
  api-documenter markdown --input-folder temp --output-folder ../../api-docs/docs/node-tracker/markdown
 
+ - name: Create API documentation for @snowplow/react-native-tracker
+ working-directory: ./trackers/react-native-tracker
+ run: |
+ api-extractor run
+ api-documenter markdown --input-folder temp --output-folder ../../api-docs/docs/node-tracker/markdown
+
  - name: Apply API documentation updates
  run: |
  git add api-docs/docs/browser-tracker
  git add api-docs/docs/node-tracker
+ git add api-docs/docs/react-native-tracker
  git commit --no-verify --allow-empty -m "Applying documentation updates."
  git push
 

.github/workflows/publish_prerelease.yml

@@ -75,6 +75,12 @@ jobs:
  api-extractor run
  api-documenter markdown --input-folder temp --output-folder docs/markdown
 
+ - name: Create API documentation for @snowplow/react-native-tracker
+ working-directory: ./trackers/react-native-tracker
+ run: |
+ api-extractor run
+ api-documenter markdown --input-folder temp --output-folder docs/markdown
+
  - name: Rush Publish
  run: node common/scripts/install-run-rush.js publish --apply --include-all --publish --tag next --set-access-level public --ignore-git-hooks
 

.gitignore

@@ -67,6 +67,7 @@ common/autoinstallers/*/.npmrc
 # API Extractor
 trackers/browser-tracker/temp/
 trackers/node-tracker/temp/
+trackers/react-native-tracker/temp/
 
 # Distribution files
 dist
@@ -80,4 +81,4 @@ trackers/javascript-tracker/test/local/serve/
 .DS_Store
 
 # gitleaks file
-findings.json
+findings.json

api-docs/docs/browser-tracker/browser-tracker.api.md

@@ -170,6 +170,7 @@ export interface CorePlugin {
  afterTrack?: (payload: Payload) => void;
  beforeTrack?: (payloadBuilder: PayloadBuilder) => void;
  contexts?: () => SelfDescribingJson[];
+ deactivatePlugin?: (core: TrackerCore) => void;
  filter?: (payload: Payload) => boolean;
  logger?: (logger: Logger) => void;
 }
@@ -546,6 +547,7 @@ export interface TrackerCore {
  addPayloadPair: (key: string, value: unknown) => void;
  addPlugin(configuration: CorePluginConfiguration): void;
  clearGlobalContexts(): void;
+ deactivate(): void;
  getBase64Encoding(): boolean;
  removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive | string>): void;
  resetPayloadPairs(dict: Payload): void;

api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.deactivateplugin.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [CorePlugin](./browser-tracker.coreplugin.md) &gt; [deactivatePlugin](./browser-tracker.coreplugin.deactivateplugin.md)
+
+## CorePlugin.deactivatePlugin property
+
+Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created.
+
+<b>Signature:</b>
+
+```typescript
+deactivatePlugin?: (core: TrackerCore) => void;
+```

api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.md

@@ -20,6 +20,7 @@ interface CorePlugin
 | [afterTrack?](./browser-tracker.coreplugin.aftertrack.md) | (payload: Payload) =&gt; void | <i>(Optional)</i> Called just after the trackerCore callback fires |
 | [beforeTrack?](./browser-tracker.coreplugin.beforetrack.md) | (payloadBuilder: PayloadBuilder) =&gt; void | <i>(Optional)</i> Called before the <code>filter</code> method is called and before the trackerCore callback fires (if the filter passes) |
 | [contexts?](./browser-tracker.coreplugin.contexts.md) | () =&gt; SelfDescribingJson\[\] | <i>(Optional)</i> Called when constructing the context for each event Useful for adding additional context to events |
+| [deactivatePlugin?](./browser-tracker.coreplugin.deactivateplugin.md) | (core: TrackerCore) =&gt; void | <i>(Optional)</i> Called when the tracker is being destroyed. Should be used to clean up any resources or listeners that the plugin has created. |
 | [filter?](./browser-tracker.coreplugin.filter.md) | (payload: Payload) =&gt; boolean | <i>(Optional)</i> Called before the payload is sent to the callback to decide whether to send the payload or skip it |
 | [logger?](./browser-tracker.coreplugin.logger.md) | (logger: Logger) =&gt; void | <i>(Optional)</i> Passed a logger instance which can be used to send log information to the active logger |
 

api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md

@@ -45,6 +45,5 @@ newTracker('sp1', 'collector.my-website.com', {
  plugins: [ PerformanceTimingPlugin(), AdTrackingPlugin() ],
  stateStorageStrategy: 'cookieAndLocalStorage'
 });
-
 ```
 

api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.deactivate.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [TrackerCore](./browser-tracker.trackercore.md) &gt; [deactivate](./browser-tracker.trackercore.deactivate.md)
+
+## TrackerCore.deactivate() method
+
+Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events.
+
+<b>Signature:</b>
+
+```typescript
+deactivate(): void;
+```
+<b>Returns:</b>
+
+void
+

api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.md

@@ -27,6 +27,7 @@ interface TrackerCore
 | [addPayloadDict(dict)](./browser-tracker.trackercore.addpayloaddict.md) | Merges a dictionary into payloadPairs |
 | [addPlugin(configuration)](./browser-tracker.trackercore.addplugin.md) | Add a plugin into the plugin collection after Core has already been initialised |
 | [clearGlobalContexts()](./browser-tracker.trackercore.clearglobalcontexts.md) | Removes all global contexts |
+| [deactivate()](./browser-tracker.trackercore.deactivate.md) | Deactivate tracker core including all plugins. This is useful for cleaning up resources or listeners that have been created. Once deactivated, the tracker won't be able to track any events. |
 | [getBase64Encoding()](./browser-tracker.trackercore.getbase64encoding.md) | Get current base64 encoding state |
 | [removeGlobalContexts(contexts)](./browser-tracker.trackercore.removeglobalcontexts.md) | Removes previously added global context, performs a deep comparison of the contexts or conditional contexts |
 | [resetPayloadPairs(dict)](./browser-tracker.trackercore.resetpayloadpairs.md) | Replace payloadPairs with a new dictionary |