@transcend-io/cli 4.72.0 → 4.74.0

package/README.md

@@ -73,22 +73,30 @@
     - [Authentication](#authentication-15)
     - [Arguments](#arguments-15)
     - [Usage](#usage-16)
-  - [tr-pull-consent-metrics](#tr-pull-consent-metrics)
+  - [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
     - [Authentication](#authentication-16)
     - [Arguments](#arguments-16)
     - [Usage](#usage-17)
-  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
+  - [tr-pull-consent-metrics](#tr-pull-consent-metrics)
     - [Authentication](#authentication-17)
     - [Arguments](#arguments-17)
     - [Usage](#usage-18)
-  - [tr-generate-api-keys](#tr-generate-api-keys)
+  - [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
     - [Authentication](#authentication-18)
     - [Arguments](#arguments-18)
     - [Usage](#usage-19)
-  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+  - [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
     - [Authentication](#authentication-19)
     - [Arguments](#arguments-19)
     - [Usage](#usage-20)
+  - [tr-generate-api-keys](#tr-generate-api-keys)
+    - [Authentication](#authentication-20)
+    - [Arguments](#arguments-20)
+    - [Usage](#usage-21)
+  - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
+    - [Authentication](#authentication-21)
+    - [Arguments](#arguments-21)
+    - [Usage](#usage-22)
 - [Proxy usage](#proxy-usage)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -123,8 +131,10 @@ yarn tr-mark-request-data-silos-completed --auth=$TRANSCEND_API_KEY
 yarn tr-skip-request-data-silos --auth=$TRANSCEND_API_KEY
 yarn tr-retry-request-data-silos --auth=$TRANSCEND_API_KEY
 yarn tr-update-consent-manager --auth=$TRANSCEND_API_KEY
+yarn tr-consent-managers-to-business-entities --auth=$TRANSCEND_API_KEY
 yarn tr-pull-consent-metrics --auth=$TRANSCEND_API_KEY
 yarn tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY
+yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY
 yarn tr-generate-api-keys --auth=$TRANSCEND_API_KEY
 yarn tr-build-xdi-sync-endpoint --auth=$TRANSCEND_API_KEY
 ```
@@ -152,6 +162,7 @@ tr-skip-request-data-silos --auth=$TRANSCEND_API_KEY
 tr-retry-request-data-silos --auth=$TRANSCEND_API_KEY
 tr-update-consent-manager --auth=$TRANSCEND_API_KEY
 tr-pull-consent-metrics --auth=$TRANSCEND_API_KEY
+tr-consent-managers-to-business-entities --auth=$TRANSCEND_API_KEY
 tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY
 tr-generate-api-keys --auth=$TRANSCEND_API_KEY
 tr-build-xdi-sync-endpoint --auth=$TRANSCEND_API_KEY
@@ -1457,6 +1468,35 @@ tr-generate-api-keys  --email=test@transcend.io --password=$TRANSCEND_PASSWORD -
 yarn tr-update-consent-manager  --auth=./transcend-api-keys.json --deploy=true
 ```
 
+### tr-consent-managers-to-business-entities
+
+This command allows for converting a folder or Consent Manager `transcend.yml` files into a single `transcend.yml` file where each consent manager configuration is a Business Entity in the data inventory.
+
+#### Authentication
+
+No authentication is required to run this command. It reads and writes files from local disk.
+
+#### Arguments
+
+| Argument                | Description                                                            | Type                 | Default                          | Required |
+| ----------------------- | ---------------------------------------------------------------------- | -------------------- | -------------------------------- | -------- |
+| consentManagerYmlFolder | Path to the folder of Consent Manager `transcend.yml` files to combine | string - folder-path | N/A                              | true     |
+| output                  | Path to the output `transcend.yml` with business entity configuration  | string - file-path   | ./combined-business-entities.yml | false    |
+
+#### Usage
+
+Combine files in folder `./working/consent-managers/` to file `./combined-business-entities.yml`
+
+```sh
+yarn tr-consent-managers-to-business-entities --consentManagerYmlFolder=./working/consent-managers/
+```
+
+Specify custom output file
+
+```sh
+yarn tr-consent-managers-to-business-entities --consentManagerYmlFolder=./working/consent-managers/ --output=./custom.yml
+```
+
 ### tr-pull-consent-metrics
 
 This command allows for pulling consent manager metrics for a Transcend account, or a set of Transcend accounts.
@@ -1574,6 +1614,61 @@ Specifying the backend URL, needed for US hosted backend infrastructure.
 yarn tr-upload-data-flows-from-csv --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io
 ```
 
+### tr-upload-cookies-from-csv
+
+This command allows for uploading cookies from CSV
+
+Step 1) Download the CSV of cookies that you want to edit from the Admin Dashboard under [Consent Manager -> Cookies](https://app.transcend.io/consent-manager/cookies). You can download cookies from both the "Triage" and "Approved" tabs.
+
+Step 2) You can edit the contents of the CSV file as needed. You may adjust the "Purpose" column, adjust the "Notes" column, add "Owners" and "Teams" or even add custom columns with additional metadata.
+
+Step 3) Upload the modified CSV file back into the dashboard with the command `yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --file=./approved-flows.csv --trackerStatus=LIVE`
+
+#### Authentication
+
+In order to use this cli, you will first need to generate an API key on the Transcend Admin Dashboard (https://app.transcend.io/infrastructure/api-keys).
+
+The API key must have the following scopes:
+
+- "Manage Cookies"
+
+#### Arguments
+
+| Argument      | Description                                                                                             | Type                 | Default                  | Required |
+| ------------- | ------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------ | -------- |
+| auth          | The Transcend API key with the scopes necessary for the command.                                        | string               | N/A                      | true     |
+| trackerStatus | Whether or not to upload the cookies into the "Approved" tab (LIVE) or the "Triage" tab (NEEDS_REVIEW). | ConsentTrackerStatus | N/A                      | true     |
+| file          | Path to the CSV file to upload                                                                          | string - file-path   | ./cookies.csv            | false    |
+| transcendUrl  | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting.                           | string - URL         | https://api.transcend.io | false    |
+
+Note: You `trackerStatus` can be specified on a per cookie basis by adding a column named "Status" to the CSV. The values should be of type `ConsentTrackerStatus` - which is `LIVE` or `NEEDS_REVIEW`.
+
+#### Usage
+
+Upload the file of cookies in `./cookies.csv` into the ["Approved" tab](https://app.transcend.io/consent-manager/cookies/approved).
+
+```sh
+yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --trackerStatus=LIVE
+```
+
+Upload the file of cookies in `./cookies.csv` into the ["Triage" tab](https://app.transcend.io/consent-manager/cookies).
+
+```sh
+yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --trackerStatus=NEEDS_REVIEW
+```
+
+Specifying the CSV file to read from:
+
+```sh
+yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --trackerStatus=LIVE --file=./custom/my-cookies.csv
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY --transcendUrl=https://api.us.transcend.io
+```
+
 ### tr-generate-api-keys
 
 This command allows for creating API keys across multiple Transcend instances. This is useful for customers that are managing many Transcend instances and need to regularly create, cycle or delete API keys across all of their instances. Unlike the other commands that rely on API key authentication, this command relies upon username/password authentication. This command will spit out the API keys into a [JSON file](./examples/api-keys.json), and that JSON file can be used in subsequent cli commands.

package/build/cli-consent-managers-to-business-entities.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env/node
+export {};
+//# sourceMappingURL=cli-consent-managers-to-business-entities.d.ts.map

package/build/cli-consent-managers-to-business-entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-consent-managers-to-business-entities.d.ts","sourceRoot":"","sources":["../src/cli-consent-managers-to-business-entities.ts"],"names":[],"mappings":""}

package/build/cli-consent-managers-to-business-entities.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env/node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_keys_1 = require("./api-keys");
+const consent_manager_1 = require("./consent-manager");
+const readTranscendYaml_1 = require("./readTranscendYaml");
+const path_1 = require("path");
+const yargs_parser_1 = __importDefault(require("yargs-parser"));
+const colors_1 = __importDefault(require("colors"));
+const logger_1 = require("./logger");
+const fs_1 = require("fs");
+/**
+ * Combines folder of consent manager `transcend.yml` files into a single `transcend.yml` file
+ * where each consent manager configuration is created as a business entity.
+ *
+ * yarn ts-node ./src/cli-consent-managers-to-business-entities.ts \
+ *   --consentManagerYmlFolder=./working/consent-managers/ \
+ *   --output=./combined-business-entities.yml
+ *
+ * Standard usage:
+ * yarn tr-consent-managers-to-business-entities \
+ *   --consentManagerYmlFolder=./working/consent-managers/ \
+ *   --output=./combined-business-entities.yml
+ */
+function main() {
+    // Parse command line arguments
+    const { consentManagerYmlFolder, output = './combined-business-entities.yml', } = (0, yargs_parser_1.default)(process.argv.slice(2));
+    // Ensure folder is passed to consentManagerYmlFolder
+    if (!consentManagerYmlFolder) {
+        logger_1.logger.error(colors_1.default.red('Missing required arg: --consentManagerYmlFolder=./working/consent-managers/'));
+        process.exit(1);
+    }
+    // Ensure file is passed
+    if (!(0, fs_1.existsSync)(consentManagerYmlFolder) ||
+        !(0, fs_1.lstatSync)(consentManagerYmlFolder).isDirectory()) {
+        logger_1.logger.error(colors_1.default.red(`Folder does not exist: "${consentManagerYmlFolder}"`));
+        process.exit(1);
+    }
+    // Read in each consent manager configuration
+    const inputs = (0, api_keys_1.listFiles)(consentManagerYmlFolder).map((directory) => {
+        const { 'consent-manager': consentManager } = (0, readTranscendYaml_1.readTranscendYaml)((0, path_1.join)(consentManagerYmlFolder, directory));
+        return { name: directory, input: consentManager };
+    });
+    // Convert to business entities
+    const businessEntities = (0, consent_manager_1.consentManagersToBusinessEntities)(inputs);
+    // write to disk
+    (0, readTranscendYaml_1.writeTranscendYaml)(output, {
+        'business-entities': businessEntities,
+    });
+    logger_1.logger.info(colors_1.default.green(`Successfully wrote ${businessEntities.length} business entities to file "${output}"`));
+}
+main();
+//# sourceMappingURL=cli-consent-managers-to-business-entities.js.map

package/build/cli-consent-managers-to-business-entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-consent-managers-to-business-entities.js","sourceRoot":"","sources":["../src/cli-consent-managers-to-business-entities.ts"],"names":[],"mappings":";;;;;;AACA,yCAAuC;AACvC,uDAAsE;AACtE,2DAA4E;AAC5E,+BAA4B;AAC5B,gEAAiC;AACjC,oDAA4B;AAC5B,qCAAkC;AAClC,2BAA2C;AAE3C;;;;;;;;;;;;GAYG;AACH,SAAS,IAAI;IACX,+BAA+B;IAC/B,MAAM,EACJ,uBAAuB,EACvB,MAAM,GAAG,kCAAkC,GAC5C,GAAG,IAAA,sBAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAA8B,CAAC;IAE9D,qDAAqD;IACrD,IAAI,CAAC,uBAAuB,EAAE;QAC5B,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,6EAA6E,CAC9E,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,wBAAwB;IACxB,IACE,CAAC,IAAA,eAAU,EAAC,uBAAuB,CAAC;QACpC,CAAC,IAAA,cAAS,EAAC,uBAAuB,CAAC,CAAC,WAAW,EAAE,EACjD;QACA,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CAAC,2BAA2B,uBAAuB,GAAG,CAAC,CAClE,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,6CAA6C;IAC7C,MAAM,MAAM,GAAG,IAAA,oBAAS,EAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QAClE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAA,qCAAiB,EAC7D,IAAA,WAAI,EAAC,uBAAuB,EAAE,SAAS,CAAC,CACzC,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,IAAA,mDAAiC,EAAC,MAAM,CAAC,CAAC;IAEnE,gBAAgB;IAChB,IAAA,sCAAkB,EAAC,MAAM,EAAE;QACzB,mBAAmB,EAAE,gBAAgB;KACtC,CAAC,CAAC;IAEH,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,KAAK,CACV,sBAAsB,gBAAgB,CAAC,MAAM,+BAA+B,MAAM,GAAG,CACtF,CACF,CAAC;AACJ,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/cli-upload-cookies-from-csv.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli-upload-cookies-from-csv.d.ts.map

package/build/cli-upload-cookies-from-csv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-upload-cookies-from-csv.d.ts","sourceRoot":"","sources":["../src/cli-upload-cookies-from-csv.ts"],"names":[],"mappings":""}

package/build/cli-upload-cookies-from-csv.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_parser_1 = __importDefault(require("yargs-parser"));
+const colors_1 = __importDefault(require("colors"));
+const logger_1 = require("./logger");
+const consent_manager_1 = require("./consent-manager");
+const privacy_types_1 = require("@transcend-io/privacy-types");
+const constants_1 = require("./constants");
+/**
+ * Upload a CSV of cookies
+ *
+ * Requires an API key with follow scopes: https://app.transcend.io/infrastructure/api-keys
+ *    - "Manage Consent Manager"
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-upload-cookies-from-csv.ts --auth=$TRANSCEND_API_KEY \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv \
+ *   --trackerStatus=LIVE
+ *
+ * Standard usage:
+ * yarn tr-upload-cookies-from-csv --auth=$TRANSCEND_API_KEY \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv \
+ *   --trackerStatus=LIVE
+ */
+async function main() {
+    // Parse command line arguments
+    const { auth, trackerStatus, file = 'cookies.csv', transcendUrl = constants_1.DEFAULT_TRANSCEND_API, } = (0, yargs_parser_1.default)(process.argv.slice(2));
+    // Ensure auth is passed
+    if (!auth) {
+        logger_1.logger.error(colors_1.default.red('A Transcend API key must be provided. You can specify using --auth=$TRANSCEND_API_KEY'));
+        process.exit(1);
+    }
+    // Ensure trackerStatus is passed
+    const VALID_TRACKER_OPTIONS = Object.values(privacy_types_1.ConsentTrackerStatus);
+    if (!trackerStatus) {
+        logger_1.logger.error(colors_1.default.red('The trackerStatus must be provided. You can specify using --trackerStatus=LIVE. ' +
+            `Valid options include: ${VALID_TRACKER_OPTIONS.join(',')}`));
+        process.exit(1);
+    }
+    const consentTrackerStatus = trackerStatus;
+    if (!VALID_TRACKER_OPTIONS.includes(consentTrackerStatus)) {
+        logger_1.logger.error(colors_1.default.red(`The trackerStatus option was invalid, got: "${trackerStatus}". You can specify using --trackerStatus=LIVE. ` +
+            `Valid options include: ${VALID_TRACKER_OPTIONS.join(',')}`));
+        process.exit(1);
+    }
+    // Upload cookies
+    await (0, consent_manager_1.uploadCookiesFromCsv)({
+        auth,
+        trackerStatus: consentTrackerStatus,
+        file,
+        transcendUrl,
+    });
+}
+main();
+//# sourceMappingURL=cli-upload-cookies-from-csv.js.map

package/build/cli-upload-cookies-from-csv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-upload-cookies-from-csv.js","sourceRoot":"","sources":["../src/cli-upload-cookies-from-csv.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,uDAAyD;AACzD,+DAAmE;AACnE,2CAAoD;AAEpD;;;;;;;;;;;;;;;GAeG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,EACJ,aAAa,EACb,IAAI,GAAG,aAAa,EACpB,YAAY,GAAG,iCAAqB,GACrC,GAAG,IAAA,sBAAK,EAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAA8B,CAAC;IAE9D,wBAAwB;IACxB,IAAI,CAAC,IAAI,EAAE;QACT,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,uFAAuF,CACxF,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,iCAAiC;IACjC,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,oCAAoB,CAAC,CAAC;IAClE,IAAI,CAAC,aAAa,EAAE;QAClB,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,kFAAkF;YAChF,0BAA0B,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC9D,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,MAAM,oBAAoB,GAAG,aAAqC,CAAC;IACnE,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE;QACzD,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,+CAA+C,aAAa,iDAAiD;YAC3G,0BAA0B,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC9D,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,iBAAiB;IACjB,MAAM,IAAA,sCAAoB,EAAC;QACzB,IAAI;QACJ,aAAa,EAAE,oBAAoB;QACnC,IAAI;QACJ,YAAY;KACb,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/codecs.d.ts

@@ -63378,4 +63378,26 @@ export declare const DataFlowCsvInput: t.IntersectionC<[t.TypeC<{
 }>, t.RecordC<t.StringC, t.StringC>]>;
 /** Type override */
 export type DataFlowCsvInput = t.TypeOf<typeof DataFlowCsvInput>;
+export declare const CookieCsvInput: t.IntersectionC<[t.TypeC<{
+    /** The value of the cookie */
+    Name: t.StringC;
+    /** The CSV of purposes mapped to that cookie */
+    Purpose: t.StringC;
+}>, t.PartialC<{
+    /** The service that the cookie relates to */
+    Service: t.StringC;
+    /** Notes and descriptions for the cookie */
+    Notes: t.StringC;
+    /** Set of cookie owners */
+    Owners: t.StringC;
+    /** Set of cookie team owners */
+    Teams: t.StringC;
+    /** LIVE vs NEEDS_REVIEW aka Approved vs Triage  */
+    Status: t.KeyofC<{
+        LIVE: unknown;
+        NEEDS_REVIEW: unknown;
+    }>;
+}>, t.RecordC<t.StringC, t.StringC>]>;
+/** Type override */
+export type CookieCsvInput = t.TypeOf<typeof CookieCsvInput>;
 //# sourceMappingURL=codecs.d.ts.map