add source property for tracking

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.6] 2022-07-25
+
+### Added
+
+- `source` property for some methods, for events tracking
+
 ## [1.0.5] 2022-07-19
 
 ### Updated

DOCUMENTATION.md

@@ -194,6 +194,7 @@
 | payload.step | <code>Operation</code> |  | <p>Workflow step</p> |
 | payload.input | <code>Object</code> |  | <p>Sample user input</p> |
 | [payload.environment] | <code>string</code> | <code>&quot;production&quot;</code> | <p>Specifiy execution environment (<code>production</code> or <code>staging</code>). Optional. Default value <code>production</code>.</p> |
+| [payload.source] | <code>string</code> |  | <p>The source of event for tracking purposes. Optional.</p> |
 
 <a name="GrinderyClient.Connector+runAction"></a>
 
@@ -210,6 +211,7 @@
 | payload.step | <code>Operation</code> | <p>Workflow step</p> |
 | payload.input | <code>Object</code> | <p>Sample user input</p> |
 | [payload.environment] | <code>string</code> | <p>Specifiy execution environment (<code>production</code> or <code>staging</code>). Optional. Default value <code>production</code>.</p> |
+| [payload.source] | <code>string</code> | <p>The source of event for tracking purposes. Optional.</p> |
 
 <a name="GrinderyClient.Connector+callInputProvider"></a>
 
@@ -397,6 +399,7 @@
 | [payload.hutk] | <code>string</code> | <p>The tracking cookie token value used for HubSpot lead activity tracking. You can retrieve this value from the &quot;hubspotutk&quot; cookie placed in the user's browser by the HubSpot JavaScript Tracking Code. (optional)</p> |
 | [payload.pageName] | <code>string</code> | <p>The name or title of the page the submission happened on (optional)</p> |
 | [payload.ipAddress] | <code>string</code> | <p>The IP address of the visitor filling out the form (optional)</p> |
+| [payload.trackSource] | <code>string</code> | <p>The source of event for tracking purposes (optional)</p> |
 
 <a name="GrinderyClient.User+saveWalletAddress"></a>
 

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.5",
+  "version": "1.0.6",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/classes/Connector.ts

@@ -200,16 +200,19 @@ class Connector {
    * @param {Operation} payload.step - Workflow step
    * @param {Object} payload.input - Sample user input
    * @param {string} [payload.environment=production] - Specifiy execution environment (`production` or `staging`). Optional. Default value `production`.
+   * @param {string} [payload.source] - The source of event for tracking purposes. Optional.
    * @returns {Promise<Object>} Promise object with action execution payload
    */
   async testAction({
     step,
     input,
     environment,
+    source,
   }: {
     step: Operation;
     input: unknown;
     environment?: string;
+    source?: string;
   }): Promise<any> {
     if (!this.token) {
       throw new Error('Authentication required');
@@ -226,6 +229,7 @@ class Connector {
         step,
         input,
         environment: environment || 'production',
+        source: source || 'unknown',
       },
       this.token
     );
@@ -239,16 +243,19 @@ class Connector {
    * @param {Operation} payload.step - Workflow step
    * @param {Object} payload.input - Sample user input
    * @param {string} [payload.environment] - Specifiy execution environment (`production` or `staging`). Optional. Default value `production`.
+   * @param {string} [payload.source] - The source of event for tracking purposes. Optional.
    * @returns {Promise<Object>} Promise object with action execution payload
    */
   async runAction({
     step,
     input,
     environment,
+    source,
   }: {
     step: Operation;
     input: unknown;
     environment?: string;
+    source?: string;
   }): Promise<any> {
     if (!this.token) {
       throw new Error('Authentication required');
@@ -265,6 +272,7 @@ class Connector {
         step,
         input,
         environment: environment || 'production',
+        source: source || 'unknown',
       },
       this.token
     );

src/classes/User.ts

@@ -147,6 +147,7 @@ class User {
    * @param {string} [payload.hutk] - The tracking cookie token value used for HubSpot lead activity tracking. You can retrieve this value from the "hubspotutk" cookie placed in the user's browser by the HubSpot JavaScript Tracking Code. (optional)
    * @param {string} [payload.pageName] - The name or title of the page the submission happened on (optional)
    * @param {string} [payload.ipAddress] - The IP address of the visitor filling out the form (optional)
+   * @param {string} [payload.trackSource] - The source of event for tracking purposes (optional)
    * @returns {Promise<boolean>} Promise object with `true` on success
    */
   async requestEarlyAccess({
@@ -160,6 +161,7 @@ class User {
     hutk,
     pageName,
     ipAddress,
+    trackSource,
   }: {
     email: string;
     source?: string;
@@ -171,6 +173,7 @@ class User {
     hutk?: string;
     pageName?: string;
     ipAddress?: string;
+    trackSource?: string;
   }): Promise<boolean> {
     if (!this.token) {
       throw new Error('Authentication required');
@@ -194,6 +197,7 @@ class User {
         hutk: hutk || '',
         pageName: pageName || '',
         ipAddress: ipAddress || '',
+        trackSource: trackSource || 'unknown',
       },
       this.token
     );