@transcend-io/cli 6.13.2 → 6.14.2

package/README.md

@@ -147,6 +147,7 @@
     - [Authentication](#authentication-34)
     - [Arguments](#arguments-33)
     - [Usage](#usage-34)
+  - [tr-sync-ot](#tr-sync-ot)
   - [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
     - [Authentication](#authentication-35)
     - [Arguments](#arguments-34)
@@ -176,7 +177,7 @@ yarn add -D @transcend-io/cli
 
 # cli commands available within package
 yarn tr-pull --auth=$TRANSCEND_API_KEY
-yarn tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
+yarn tr-sync-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
 yarn tr-push --auth=$TRANSCEND_API_KEY
 yarn tr-scan-packages --auth=$TRANSCEND_API_KEY
 yarn tr-discover-silos --auth=$TRANSCEND_API_KEY
@@ -217,7 +218,7 @@ npm i -D @transcend-io/cli
 
 # cli commands available within package
 tr-pull --auth=$TRANSCEND_API_KEY
-tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
+tr-sync-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=$ONE_TRUST_HOSTNAME --file=$ONE_TRUST_OUTPUT_FILE
 tr-push --auth=$TRANSCEND_API_KEY
 tr-scan-packages --auth=$TRANSCEND_API_KEY
 tr-discover-silos --auth=$TRANSCEND_API_KEY
@@ -577,9 +578,9 @@ tr-pull --auth=./transcend-api-keys.json --resources=consentManager --file=./tra
 
 Note: This command will overwrite the existing transcend.yml file that you have locally.
 
-### tr-pull-ot
+### tr-sync-ot
 
-Pulls resources from a OneTrust instance. For now, it only supports retrieving OneTrust Assessments. It sends a request to the [Get List of Assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget) endpoint to fetch a list of all Assessments in your account. Then, it queries the [Get Assessment](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget) and [Get Risk](https://developer.onetrust.com/onetrust/reference/getriskusingget) endpoints to enrich these assessments with more details such as respondents, approvers, assessment questions and responses, and assessment risks. Finally, it syncs the enriched resources to disk in the specified file and format.
+Pulls resources from a OneTrust and syncs them to a Transcend instance. For now, it only supports retrieving OneTrust Assessments. It sends a request to the [Get List of Assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget) endpoint to fetch a list of all Assessments in your account. Then, it queries the [Get Assessment](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget), [Get Risk](https://developer.onetrust.com/onetrust/reference/getriskusingget), and [Get User](https://developer.onetrust.com/onetrust/reference/getuserbyid) endpoints to enrich these assessments with more details such as respondents, approvers, assessment questions and responses, and assessment risks. Finally, it syncs the enriched resources to disk in the specified file and format.
 
 This command can be helpful if you are looking to:
 
@@ -593,25 +594,51 @@ In order to use this command, you will need to generate a OneTrust OAuth Token w
 - [GET /v2/assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget)
 - [GET /v2/assessments/{assessmentId}/export](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget)
 - [GET /risks/{riskId}](https://developer.onetrust.com/onetrust/reference/getriskusingget)
+- [GET /v2/Users/{userId}](https://developer.onetrust.com/onetrust/reference/getuserusingget)
 
 To learn how to generate the token, see the [OAuth 2.0 Scopes](https://developer.onetrust.com/onetrust/reference/oauth-20-scopes) and [Generate Access Token](https://developer.onetrust.com/onetrust/reference/getoauthtoken) pages.
 
+If syncing the resources to Transcend, you will also need to generate an API key on the Transcend Admin Dashboard (https://app.transcend.io/infrastructure/api-keys).
+
+The API key needs the following scopes when pushing the various resource types:
+
+| Resource    | Scope              |
+| ----------- | ------------------ |
+| assessments | Manage Assessments |
+
 #### Arguments
 
-| Argument   | Description                                                                                       | Type    | Default     | Required |
-| ---------- | ------------------------------------------------------------------------------------------------- | ------- | ----------- | -------- |
-| auth       | The OAuth access token with the scopes necessary to access the OneTrust Public APIs.              | string  | N/A         | true     |
-| hostname   | The domain of the OneTrust environment from which to pull the resource (e.g. trial.onetrust.com). | string  | N/A         | true     |
-| file       | Path to the file to pull the resource into. Its format must match the fileFormat argument.        | string  | N/A         | true     |
-| fileFormat | The format of the output file. For now, only json is supported.                                   | string  | json        | false    |
-| resource   | The resource to pull from OneTrust. For now, only assessments is supported.                       | string  | assessments | false    |
-| debug      | Whether to print detailed logs in case of error.                                                  | boolean | false       | false    |
+| Argument      | Description                                                                                       | Type         | Default                  | Required |
+| ------------- | ------------------------------------------------------------------------------------------------- | ------------ | ------------------------ | -------- |
+| hostname      | The domain of the OneTrust environment from which to pull the resource (e.g. trial.onetrust.com). | string       | N/A                      | true     |
+| oneTrustAuth  | The OAuth access token with the scopes necessary to access the OneTrust Public APIs.              | string       | N/A                      | true     |
+| transcendAuth | The Transcend API Key to with the scopes necessary to access Transcend's Public APIs.             | string       | N/A                      | false    |
+| transcendUrl  | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting.                     | string - URL | https://api.transcend.io | false    |
+| file          | Path to the file to pull the resource into. Its format must match the fileFormat argument.        | string       | N/A                      | false    |
+| fileFormat    | The format of the output file.                                                                    | string       | json                     | false    |
+| resource      | The resource to pull from OneTrust. For now, only assessments is supported.                       | string       | assessments              | false    |
+| dryRun        | Whether to export the resource to a file rather than sync to Transcend.                           | boolean      | false                    | false    |
+| debug         | Whether to print detailed logs in case of error.                                                  | boolean      | false                    | false    |
 
 #### Usage
 
+```sh
+# Syncs all assessments from the OneTrust instance to Transcend
+tr-sync-ot --hostname=trial.onetrust.com --oneTrustAuth=$ONE_TRUST_OAUTH_TOKEN --transcendAuth=$TRANSCEND_API_KEY
+```
+
+Alternatively, you can set dryRun to true and sync the resource to disk:
+
+```sh
+# Writes out file to ./oneTrustAssessments.csv
+tr-sync-ot --hostname=trial.onetrust.com --oneTrustAuth=$ONE_TRUST_OAUTH_TOKEN --dryRun=true --file=./oneTrustAssessments.csv
+```
+
+You can also sync to disk in json format:
+
 ```sh
 # Writes out file to ./oneTrustAssessments.json
-tr-pull-ot --auth=$ONE_TRUST_OAUTH_TOKEN --hostname=trial.onetrust.com --file=./oneTrustAssessments.json
+tr-sync-ot --hostname=trial.onetrust.com --oneTrustAuth=$ONE_TRUST_OAUTH_TOKEN --dryRun=true --fileFormat=json --file=./oneTrustAssessments.json
 ```
 
 ### tr-push

package/build/cli-sync-ot.d.ts

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

package/build/cli-sync-ot.d.ts.map

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

package/build/cli-sync-ot.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 logger_1 = require("./logger");
+const colors_1 = __importDefault(require("colors"));
+const oneTrust_1 = require("./oneTrust");
+const enums_1 = require("./enums");
+const syncOneTrustAssessments_1 = require("./oneTrust/helpers/syncOneTrustAssessments");
+const graphql_1 = require("./graphql");
+/**
+ * Pull configuration from OneTrust down locally to disk
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-sync-ot.ts --hostname=customer.my.onetrust.com --oneTrustAuth=$ONE_TRUST_OAUTH_TOKEN --transcendAuth=$TRANSCEND_API_KEY
+ *
+ * Standard usage
+ * yarn cli-sync-ot --hostname=customer.my.onetrust.com --oneTrustAuth=$ONE_TRUST_OAUTH_TOKEN --transcendAuth=$TRANSCEND_API_KEY
+ */
+async function main() {
+    const { file, fileFormat, hostname, oneTrustAuth, transcendAuth, transcendUrl, resource, 
+    // debug,
+    dryRun, } = (0, oneTrust_1.parseCliSyncOtArguments)();
+    // use the hostname and auth token to instantiate a client to talk to OneTrust
+    const oneTrust = (0, oneTrust_1.createOneTrustGotInstance)({ hostname, auth: oneTrustAuth });
+    // try {
+    if (resource === enums_1.OneTrustPullResource.Assessments) {
+        await (0, syncOneTrustAssessments_1.syncOneTrustAssessments)({
+            oneTrust,
+            file,
+            fileFormat,
+            dryRun,
+            ...(transcendAuth && transcendUrl
+                ? {
+                    transcend: (0, graphql_1.buildTranscendGraphQLClient)(transcendUrl, transcendAuth),
+                }
+                : {}),
+        });
+    }
+    // } catch (err) {
+    //   logger.error(
+    //     colors.red(
+    //       `An error occurred syncing the resource ${resource} from OneTrust: ${
+    //         debug ? err.stack : err.message
+    //       }`,
+    //     ),
+    //   );
+    //   process.exit(1);
+    // }
+    // Indicate success
+    logger_1.logger.info(colors_1.default.green(`Successfully synced OneTrust ${resource} to ${dryRun ? `disk at "${file}"` : 'Transcend'}!`));
+}
+main();
+//# sourceMappingURL=cli-sync-ot.js.map

package/build/cli-sync-ot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-sync-ot.js","sourceRoot":"","sources":["../src/cli-sync-ot.ts"],"names":[],"mappings":";;;;;;AACA,qCAAkC;AAElC,oDAA4B;AAC5B,yCAAgF;AAChF,mCAA+C;AAC/C,wFAAqF;AACrF,uCAAwD;AAExD;;;;;;;;GAQG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,EACJ,IAAI,EACJ,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,QAAQ;IACR,SAAS;IACT,MAAM,GACP,GAAG,IAAA,kCAAuB,GAAE,CAAC;IAE9B,8EAA8E;IAC9E,MAAM,QAAQ,GAAG,IAAA,oCAAyB,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAE7E,QAAQ;IACR,IAAI,QAAQ,KAAK,4BAAoB,CAAC,WAAW,EAAE;QACjD,MAAM,IAAA,iDAAuB,EAAC;YAC5B,QAAQ;YACR,IAAI;YACJ,UAAU;YACV,MAAM;YACN,GAAG,CAAC,aAAa,IAAI,YAAY;gBAC/B,CAAC,CAAC;oBACE,SAAS,EAAE,IAAA,qCAA2B,EAAC,YAAY,EAAE,aAAa,CAAC;iBACpE;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAC;KACJ;IACD,kBAAkB;IAClB,kBAAkB;IAClB,kBAAkB;IAClB,8EAA8E;IAC9E,0CAA0C;IAC1C,YAAY;IACZ,SAAS;IACT,OAAO;IACP,qBAAqB;IACrB,IAAI;IAEJ,mBAAmB;IACnB,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,KAAK,CACV,gCAAgC,QAAQ,OACtC,MAAM,CAAC,CAAC,CAAC,YAAY,IAAI,GAAG,CAAC,CAAC,CAAC,WACjC,GAAG,CACJ,CACF,CAAC;AACJ,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/codecs.d.ts

@@ -47156,6 +47156,10 @@ export declare const RiskLogicInput: t.IntersectionC<[t.TypeC<{
 }>, t.PartialC<{
     /** The risk level to assign to the question */
     'risk-level': t.StringC;
+    /** The risk matrix column to assign to a question. */
+    'risk-matrix-column': t.StringC;
+    /** The risk matrix row to assign to a question. */
+    'risk-matrix-row': t.StringC;
 }>]>;
 /** Type override */
 export type RiskLogicInput = t.TypeOf<typeof RiskLogicInput>;
@@ -47256,6 +47260,10 @@ export declare const AssessmentSectionQuestionInput: t.IntersectionC<[t.TypeC<{
     }>, t.PartialC<{
         /** The risk level to assign to the question */
         'risk-level': t.StringC;
+        /** The risk matrix column to assign to a question. */
+        'risk-matrix-column': t.StringC;
+        /** The risk matrix row to assign to a question. */
+        'risk-matrix-row': t.StringC;
     }>]>>;
     /** Risk category titles for the question */
     'risk-categories': t.ArrayC<t.StringC>;
@@ -47467,6 +47475,10 @@ export declare const AssessmentSectionInput: t.IntersectionC<[t.TypeC<{
         }>, t.PartialC<{
             /** The risk level to assign to the question */
             'risk-level': t.StringC;
+            /** The risk matrix column to assign to a question. */
+            'risk-matrix-column': t.StringC;
+            /** The risk matrix row to assign to a question. */
+            'risk-matrix-row': t.StringC;
         }>]>>;
         /** Risk category titles for the question */
         'risk-categories': t.ArrayC<t.StringC>;
@@ -47710,6 +47722,10 @@ export declare const AssessmentTemplateInput: t.IntersectionC<[t.TypeC<{
             }>, t.PartialC<{
                 /** The risk level to assign to the question */
                 'risk-level': t.StringC;
+                /** The risk matrix column to assign to a question. */
+                'risk-matrix-column': t.StringC;
+                /** The risk matrix row to assign to a question. */
+                'risk-matrix-row': t.StringC;
             }>]>>;
             /** Risk category titles for the question */
             'risk-categories': t.ArrayC<t.StringC>;
@@ -48015,6 +48031,10 @@ export declare const AssessmentInput: t.IntersectionC<[t.TypeC<{
             }>, t.PartialC<{
                 /** The risk level to assign to the question */
                 'risk-level': t.StringC;
+                /** The risk matrix column to assign to a question. */
+                'risk-matrix-column': t.StringC;
+                /** The risk matrix row to assign to a question. */
+                'risk-matrix-row': t.StringC;
             }>]>>;
             /** Risk category titles for the question */
             'risk-categories': t.ArrayC<t.StringC>;
@@ -88567,6 +88587,10 @@ export declare const TranscendInput: t.PartialC<{
                 }>, t.PartialC<{
                     /** The risk level to assign to the question */
                     'risk-level': t.StringC;
+                    /** The risk matrix column to assign to a question. */
+                    'risk-matrix-column': t.StringC;
+                    /** The risk matrix row to assign to a question. */
+                    'risk-matrix-row': t.StringC;
                 }>]>>;
                 /** Risk category titles for the question */
                 'risk-categories': t.ArrayC<t.StringC>;
@@ -88840,6 +88864,10 @@ export declare const TranscendInput: t.PartialC<{
                 }>, t.PartialC<{
                     /** The risk level to assign to the question */
                     'risk-level': t.StringC;
+                    /** The risk matrix column to assign to a question. */
+                    'risk-matrix-column': t.StringC;
+                    /** The risk matrix row to assign to a question. */
+                    'risk-matrix-row': t.StringC;
                 }>]>>;
                 /** Risk category titles for the question */
                 'risk-categories': t.ArrayC<t.StringC>;
@@ -89332,5 +89360,23 @@ export declare const PathfinderPromptRunMetadata: t.PartialC<{
 }>;
 /** Type override */
 export type PathfinderPromptRunMetadata = t.TypeOf<typeof PathfinderPromptRunMetadata>;
+/** Input for importing multiple OneTrust assessment forms into Transcend */
+export declare const ImportOnetrustAssessmentsInput: t.PartialC<{
+    /** 'The rows of the CSV file.' */
+    rows: t.ArrayC<t.TypeC<{
+        /** A list of columns within this row. */
+        columns: t.ArrayC<t.IntersectionC<[t.TypeC<{
+            /** The title of the column */
+            title: t.StringC;
+        }>, t.PartialC<{
+            /** The optional value of the column */
+            value: t.StringC;
+        }>]>>;
+    }>>;
+    /** 'The json record representing the assessment.' */
+    json: t.StringC;
+}>;
+/** Type override */
+export type ImportOnetrustAssessmentsInput = t.TypeOf<typeof ImportOnetrustAssessmentsInput>;
 export {};
 //# sourceMappingURL=codecs.d.ts.map