@transcend-io/cli 4.12.0 → 4.13.0

package/README.md

@@ -5,14 +5,22 @@
 
 - [Overview](#overview)
 - [Installation](#installation)
-- [Authentication](#authentication)
 - [transcend.yml](#transcendyml)
 - [Usage](#usage)
   - [tr-pull](#tr-pull)
+    - [Authentication](#authentication)
+    - [Usage](#usage-1)
   - [tr-push](#tr-push)
+    - [Authentication](#authentication-1)
+    - [Usage](#usage-2)
     - [CI Integration](#ci-integration)
     - [Dynamic Variables](#dynamic-variables)
   - [tr-discover-silos](#tr-discover-silos)
+    - [Authentication](#authentication-2)
+    - [Usage](#usage-3)
+  - [tr-request-upload](#tr-request-upload)
+    - [Authentication](#authentication-3)
+  - [Usage](#usage-4)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -34,6 +42,7 @@ yarn add -D @transcend-io/cli
 yarn tr-pull --auth=xxx
 yarn tr-push --auth=xxx
 yarn tr-discover-silos --auth=xxx
+yarn tr-request-upload --auth=xxx
 ```
 
 or
@@ -46,6 +55,7 @@ npm i -D @transcend-io/cli
 tr-pull --auth=xxx
 tr-push --auth=xxx
 tr-discover-silos --auth=xxx
+tr-request-upload --auth=xxx
 ```
 
 alternatively, you can install the cli globally on your machine:
@@ -58,21 +68,9 @@ npm i -g @transcend-io/cli
 tr-pull --auth=xxx
 tr-push --auth=xxx
 tr-discover-silos --auth=xxx
+tr-request-upload --auth=xxx
 ```
 
-## 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 needs the following scopes:
-
-- Manage Data Map
-- Manage Request Identity Verification
-- Connect Data Silos
-- Manage Data Subject Request Settings
-- View API Keys
-- Manage Email Templates
-
 ## transcend.yml
 
 Within your git repositories, you can define a file `transcend.yml`. This file allows you define part of your Data Map in code. Using the cli, you can sync that configuration back to the Transcend Admin Dashboard (https://app.transcend.io/privacy-requests/connected-services).
@@ -175,6 +173,22 @@ This command can be helpful if you are looking to:
 - Copy parts of your Data Map from one Transcend instance into another instance
 - Generate a transcend.yml file as a starting point to maintain parts of your Data Map in code
 
+#### 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 needs the following scopes:
+
+- View Data Map
+- View Identity Verification Settings
+- View Data Subject Request Settings
+- View API Keys
+- View Email Templates
+
+_Note: The scopes for tr-push are comprehensive of the scopes for tr-pull_
+
+#### Usage
+
 ```sh
 # Writes out file to ./transcend.yml
 tr-pull --auth=<api-key>
@@ -217,6 +231,21 @@ Note: This command will overwrite the existing transcend.yml file that you have
 
 Given a transcend.yml file, sync the contents up to your connected services view (https://app.transcend.io/privacy-requests/connected-services).
 
+#### 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 needs the following scopes:
+
+- Manage Data Map
+- Manage Request Identity Verification
+- Connect Data Silos
+- Manage Data Subject Request Settings
+- View API Keys
+- Manage Email Templates
+
+#### Usage
+
 ```sh
 # Looks for file at ./transcend.yml
 tr-push --auth=<api-key>
@@ -327,6 +356,17 @@ Transcend can help scan dependency management files to help detect new data silo
 
 To get started, you'll need to add a data silo for the corresponding project type with "silo discovery" plugin enabled. For example, if you want to scan a JavaScript project, add a JavaScript package.json data silo. You can do this in the Transcend admin-dashboard (or via this CLI tooling).
 
+#### 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 needs the following scopes:
+
+- Manage Assigned Data Inventory
+- [Data Silo for Scanner]
+
+#### Usage
+
 Then, you'll need to grab that `dataSiloId` and a Transcend API key and pass it to the CLI. Using JavaScript package.json as an example:
 
 ```sh
@@ -344,3 +384,86 @@ You can include additional arguments as well:
 | dataSiloID | The UUID of the corresponding data silo.                                                                                                                             |
 | auth       | Transcend API key.                                                                                                                                                   |
 | fileGlobs  | You can pass a [glob syntax pattern(s)](https://github.com/mrmlnc/fast-glob) to specify additional file paths to scan in addition to the default (ex: package.json). |
+
+### tr-request-upload
+
+If you need to upload a set of requests from a CSV, you can run this command.
+This command uses [inquirer](https://github.com/SBoudrias/Inquirer.js/) to prompt the user to
+map the shape of the CSV to the shape of the Transcend API. There is no requirement for the
+shape of the incoming CSV, as the script will handle the mapping process.
+
+The script will also produce a JSON cache file, that allows for the mappings to be preserved between runs.
+This can be useful if you have the same CSV shape that needs to be imported multiple times.
+Once the mapping process is done once, it does not need to be done again.
+
+Additionally, the JSON cache file will store the result of any privacy requests that fail to be uploaded.
+This allows for the script to continue uploading requests even if some requests error out. The script
+user can then inspect the errors, and decide whether it is necessary to re-run those requests.
+
+https://user-images.githubusercontent.com/10264973/205434290-85cd3ce7-cc6f-44fc-83ca-3bb8fde4d589.mov
+
+#### 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 needs the following scopes:
+
+- Submit New Data Subject Request
+- View Identity Verification Settings
+- View Global Attributes
+
+### Usage
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv
+```
+
+For self-hosted sombras that use an internal key:
+
+```sh
+yarn tr-request-upload --auth=<api-key> --sombraAuth=<sombra-internal-key> --file=/Users/michaelfarrell/Desktop/test.csv
+```
+
+Run without being prompted to filter requests
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --skipFilterStep=true
+```
+
+Perform a dry run to see what will be uploaded, without calling the Transcend API to upload the request
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --dryRun=true
+```
+
+Mark the uploaded requests as test requests
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --isTest=true
+```
+
+Send email communications to the users throughout the request lifecycle.
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --isSilent=false
+```
+
+Send email verification to user before request continues.
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv \
+   --isSilent=false --emailIsVerified=false
+```
+
+Increase the concurrency (defaults to 20)
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --concurrency=20
+```
+
+Tag all uploaded requests with an attribute
+
+```sh
+yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv \
+  --attributes=Tags:transcend-bulk-upload;my-customer-tag,Customer:acme-corp
+```

package/build/cli-request-upload.d.ts

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

package/build/cli-request-upload.d.ts.map

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

package/build/cli-request-upload.js

@@ -0,0 +1,57 @@
+#!/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 requests_1 = require("./requests");
+/**
+ * Upload a CSV of Privacy Requests.
+ *
+ * Requirements:
+ *
+ * 1. Create API key with follow scopes: https://app.transcend.io/infrastructure/api-keys
+ *    - "Submit New Data Subject Request"
+ *    - "View Identity Verification Settings"
+ *    - "View Global Attributes"
+ * 2. Invite a new user into the dashboard with no scopes but email/password login (needed for diffie hellman channel)
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-request-upload.ts --auth=asd123 \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv \
+ *   --skipFilterStep=true --isTest=true
+ *
+ * Standard usage:
+ * yarn tr-request-upload --auth=asd123 \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv \
+ *   --skipFilterStep=true --isTest=true
+ */
+async function main() {
+    // Parse command line arguments
+    const { file = './requests.csv', transcendApiUrl = 'https://api.transcend.io', cacheFilepath = './transcend-privacy-requests-cache.json', auth, sombraAuth, concurrency = '20', isTest = 'false', isSilent = 'true', emailIsVerified = 'true', dryRun = 'false', skipFilterStep = 'false', attributes = 'Tags:transcend-bulk-upload', } = (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=asd123'));
+        process.exit(1);
+    }
+    // Upload privacy requests
+    await (0, requests_1.uploadPrivacyRequestsFromCsv)({
+        cacheFilepath,
+        file,
+        auth,
+        sombraAuth,
+        concurrency: parseInt(concurrency, 10),
+        transcendApiUrl,
+        attributes: (0, requests_1.splitCsvToList)(attributes),
+        skipFilterStep: skipFilterStep === 'true',
+        isSilent: isSilent === 'true',
+        emailIsVerified: emailIsVerified === 'true',
+        isTest: isTest === 'true',
+        dryRun: dryRun === 'true',
+    });
+}
+main();
+//# sourceMappingURL=cli-request-upload.js.map

package/build/cli-request-upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-request-upload.js","sourceRoot":"","sources":["../src/cli-request-upload.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,yCAA0E;AAE1E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,gBAAgB,EACvB,eAAe,GAAG,0BAA0B,EAC5C,aAAa,GAAG,yCAAyC,EACzD,IAAI,EACJ,UAAU,EACV,WAAW,GAAG,IAAI,EAClB,MAAM,GAAG,OAAO,EAChB,QAAQ,GAAG,MAAM,EACjB,eAAe,GAAG,MAAM,EACxB,MAAM,GAAG,OAAO,EAChB,cAAc,GAAG,OAAO,EACxB,UAAU,GAAG,4BAA4B,GAC1C,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,2EAA2E,CAC5E,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,0BAA0B;IAC1B,MAAM,IAAA,uCAA4B,EAAC;QACjC,aAAa;QACb,IAAI;QACJ,IAAI;QACJ,UAAU;QACV,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QACtC,eAAe;QACf,UAAU,EAAE,IAAA,yBAAc,EAAC,UAAU,CAAC;QACtC,cAAc,EAAE,cAAc,KAAK,MAAM;QACzC,QAAQ,EAAE,QAAQ,KAAK,MAAM;QAC7B,eAAe,EAAE,eAAe,KAAK,MAAM;QAC3C,MAAM,EAAE,MAAM,KAAK,MAAM;QACzB,MAAM,EAAE,MAAM,KAAK,MAAM;KAC1B,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/graphql/fetchAllAttributeKeys.d.ts

@@ -0,0 +1,15 @@
+import { GraphQLClient } from 'graphql-request';
+export interface AttributeKey {
+    /** ID of attribute key */
+    id: string;
+    /** Name of attribute key */
+    name: string;
+}
+/**
+ * Fetch all attribute keys enabled for privacy requests
+ *
+ * @param client - GraphQL client
+ * @returns All attribute keys in the organization
+ */
+export declare function fetchAllRequestAttributeKeys(client: GraphQLClient): Promise<AttributeKey[]>;
+//# sourceMappingURL=fetchAllAttributeKeys.d.ts.map

package/build/graphql/fetchAllAttributeKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchAllAttributeKeys.d.ts","sourceRoot":"","sources":["../../src/graphql/fetchAllAttributeKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD,MAAM,WAAW,YAAY;IAC3B,0BAA0B;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;CACd;AAID;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,YAAY,EAAE,CAAC,CA0BzB"}

package/build/graphql/fetchAllAttributeKeys.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchAllRequestAttributeKeys = void 0;
+const gqls_1 = require("./gqls");
+const makeGraphQLRequest_1 = require("./makeGraphQLRequest");
+const PAGE_SIZE = 20;
+/**
+ * Fetch all attribute keys enabled for privacy requests
+ *
+ * @param client - GraphQL client
+ * @returns All attribute keys in the organization
+ */
+async function fetchAllRequestAttributeKeys(client) {
+    const attributeKeys = [];
+    let offset = 0;
+    // Try to fetch an enricher with the same title
+    let shouldContinue = false;
+    do {
+        const { attributeKeys: { nodes },
+        // eslint-disable-next-line no-await-in-loop
+         } = await (0, makeGraphQLRequest_1.makeGraphQLRequest)(client, gqls_1.ATTRIBUTE_KEYS_REQUESTS, {
+            first: PAGE_SIZE,
+            offset,
+        });
+        attributeKeys.push(...nodes);
+        offset += PAGE_SIZE;
+        shouldContinue = nodes.length === PAGE_SIZE;
+    } while (shouldContinue);
+    return attributeKeys;
+}
+exports.fetchAllRequestAttributeKeys = fetchAllRequestAttributeKeys;
+//# sourceMappingURL=fetchAllAttributeKeys.js.map

package/build/graphql/fetchAllAttributeKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchAllAttributeKeys.js","sourceRoot":"","sources":["../../src/graphql/fetchAllAttributeKeys.ts"],"names":[],"mappings":";;;AACA,iCAAiD;AACjD,6DAA0D;AAS1D,MAAM,SAAS,GAAG,EAAE,CAAC;AAErB;;;;;GAKG;AACI,KAAK,UAAU,4BAA4B,CAChD,MAAqB;IAErB,MAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,+CAA+C;IAC/C,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,GAAG;QACD,MAAM,EACJ,aAAa,EAAE,EAAE,KAAK,EAAE;QACxB,4CAA4C;UAC7C,GAAG,MAAM,IAAA,uCAAkB,EAMzB,MAAM,EAAE,8BAAuB,EAAE;YAClC,KAAK,EAAE,SAAS;YAChB,MAAM;SACP,CAAC,CAAC;QACH,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC;QACpB,cAAc,GAAG,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC;KAC7C,QAAQ,cAAc,EAAE;IAEzB,OAAO,aAAa,CAAC;AACvB,CAAC;AA5BD,oEA4BC"}

package/build/graphql/gqls/attributeKey.d.ts

@@ -0,0 +1,2 @@
+export declare const ATTRIBUTE_KEYS_REQUESTS: string;
+//# sourceMappingURL=attributeKey.d.ts.map

package/build/graphql/gqls/attributeKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributeKey.d.ts","sourceRoot":"","sources":["../../../src/graphql/gqls/attributeKey.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,uBAAuB,QAanC,CAAC"}

package/build/graphql/gqls/attributeKey.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ATTRIBUTE_KEYS_REQUESTS = void 0;
+const graphql_request_1 = require("graphql-request");
+exports.ATTRIBUTE_KEYS_REQUESTS = (0, graphql_request_1.gql) `
+  query TranscendCliAttributeKeys($first: Int!, $offset: Int!) {
+    attributeKeys(
+      filterBy: { enabledOnRequests: true }
+      first: $first
+      offset: $offset
+    ) {
+      nodes {
+        id
+        name
+      }
+    }
+  }
+`;
+//# sourceMappingURL=attributeKey.js.map

package/build/graphql/gqls/attributeKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributeKey.js","sourceRoot":"","sources":["../../../src/graphql/gqls/attributeKey.ts"],"names":[],"mappings":";;;AAAA,qDAAsC;AAEzB,QAAA,uBAAuB,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;CAazC,CAAC"}

package/build/graphql/gqls/enricher.d.ts

@@ -1,4 +1,14 @@
 export declare const ENRICHERS: string;
+export interface Initializer {
+    /** ID of enricher */
+    id: string;
+    /** Identifiers */
+    identifiers: {
+        /** Name of identifier */
+        name: string;
+    }[];
+}
+export declare const INITIALIZER: string;
 export declare const CREATE_ENRICHER: string;
 export declare const UPDATE_ENRICHER: string;
 //# sourceMappingURL=enricher.d.ts.map

package/build/graphql/gqls/enricher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enricher.d.ts","sourceRoot":"","sources":["../../../src/graphql/gqls/enricher.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,QAkBrB,CAAC;AAEF,eAAO,MAAM,eAAe,QAyB3B,CAAC;AAEF,eAAO,MAAM,eAAe,QA0B3B,CAAC"}
+{"version":3,"file":"enricher.d.ts","sourceRoot":"","sources":["../../../src/graphql/gqls/enricher.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,QAkBrB,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,kBAAkB;IAClB,WAAW,EAAE;QACX,yBAAyB;QACzB,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;CACL;AAED,eAAO,MAAM,WAAW,QASvB,CAAC;AAEF,eAAO,MAAM,eAAe,QAyB3B,CAAC;AAEF,eAAO,MAAM,eAAe,QA0B3B,CAAC"}

package/build/graphql/gqls/enricher.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UPDATE_ENRICHER = exports.CREATE_ENRICHER = exports.ENRICHERS = void 0;
+exports.UPDATE_ENRICHER = exports.CREATE_ENRICHER = exports.INITIALIZER = exports.ENRICHERS = void 0;
 const graphql_request_1 = require("graphql-request");
 exports.ENRICHERS = (0, graphql_request_1.gql) `
   query TranscendCliEnrichers($title: String, $first: Int!, $offset: Int!) {
@@ -21,6 +21,16 @@ exports.ENRICHERS = (0, graphql_request_1.gql) `
     }
   }
 `;
+exports.INITIALIZER = (0, graphql_request_1.gql) `
+  query TranscendCliInitializer {
+    initializer {
+      id
+      identifiers {
+        name
+      }
+    }
+  }
+`;
 exports.CREATE_ENRICHER = (0, graphql_request_1.gql) `
   mutation TranscendCliCreateEnricher(
     $title: String!

package/build/graphql/gqls/enricher.js.map

@@ -1 +1 @@
-{"version":3,"file":"enricher.js","sourceRoot":"","sources":["../../../src/graphql/gqls/enricher.ts"],"names":[],"mappings":";;;AAAA,qDAAsC;AAEzB,QAAA,SAAS,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;CAkB3B,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;CAyBjC,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BjC,CAAC"}
+{"version":3,"file":"enricher.js","sourceRoot":"","sources":["../../../src/graphql/gqls/enricher.ts"],"names":[],"mappings":";;;AAAA,qDAAsC;AAEzB,QAAA,SAAS,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;CAkB3B,CAAC;AAYW,QAAA,WAAW,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;CAS7B,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;CAyBjC,CAAC;AAEW,QAAA,eAAe,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BjC,CAAC"}

package/build/graphql/gqls/index.d.ts

@@ -7,4 +7,5 @@ export * from './apiKey';
 export * from './siloDiscovery';
 export * from './template';
 export * from './organization';
+export * from './attributeKey';
 //# sourceMappingURL=index.d.ts.map

package/build/graphql/gqls/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/graphql/gqls/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/graphql/gqls/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC"}

package/build/graphql/gqls/index.js

@@ -19,4 +19,5 @@ __exportStar(require("./apiKey"), exports);
 __exportStar(require("./siloDiscovery"), exports);
 __exportStar(require("./template"), exports);
 __exportStar(require("./organization"), exports);
+__exportStar(require("./attributeKey"), exports);
 //# sourceMappingURL=index.js.map

package/build/graphql/gqls/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/graphql/gqls/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,6CAA2B;AAC3B,+CAA6B;AAC7B,gDAA8B;AAC9B,2CAAyB;AACzB,kDAAgC;AAChC,6CAA2B;AAC3B,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/graphql/gqls/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,8CAA4B;AAC5B,6CAA2B;AAC3B,6CAA2B;AAC3B,+CAA6B;AAC7B,gDAA8B;AAC9B,2CAAyB;AACzB,kDAAgC;AAChC,6CAA2B;AAC3B,iDAA+B;AAC/B,iDAA+B"}

package/build/graphql/index.d.ts

@@ -12,4 +12,5 @@ export * from './makeGraphQLRequest';
 export * from './createSombraGotInstance';
 export * from './buildTranscendGraphQLClient';
 export * from './gqls';
+export * from './fetchAllAttributeKeys';
 //# sourceMappingURL=index.d.ts.map

package/build/graphql/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/graphql/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/graphql/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,QAAQ,CAAC;AACvB,cAAc,yBAAyB,CAAC"}

package/build/graphql/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./makeGraphQLRequest"), exports);
 __exportStar(require("./createSombraGotInstance"), exports);
 __exportStar(require("./buildTranscendGraphQLClient"), exports);
 __exportStar(require("./gqls"), exports);
+__exportStar(require("./fetchAllAttributeKeys"), exports);
 //# sourceMappingURL=index.js.map

package/build/graphql/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/graphql/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,iDAA+B;AAC/B,sDAAoC;AACpC,qDAAmC;AACnC,+DAA6C;AAC7C,iEAA+C;AAC/C,kDAAgC;AAChC,kDAAgC;AAChC,+DAA6C;AAC7C,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,gEAA8C;AAC9C,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/graphql/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+DAA6C;AAC7C,iDAA+B;AAC/B,sDAAoC;AACpC,qDAAmC;AACnC,+DAA6C;AAC7C,iEAA+C;AAC/C,kDAAgC;AAChC,kDAAgC;AAChC,+DAA6C;AAC7C,kDAAgC;AAChC,uDAAqC;AACrC,4DAA0C;AAC1C,gEAA8C;AAC9C,yCAAuB;AACvB,0DAAwC"}

package/build/requests/constants.d.ts

@@ -1,5 +1,7 @@
 import * as t from 'io-ts';
-export declare const NONE = "NONE";
+export declare const NONE: "[NONE]";
+export declare const BULK_APPLY: "[APPLY VALUE TO ALL ROWS]";
+export declare const BLANK: "<blank>";
 /**
  * Column names to map
  */
@@ -21,10 +23,16 @@ export declare enum ColumnName {
     /** The title of the dataSiloIds column */
     DataSiloIds = "dataSiloIds"
 }
+/** These parameters are required in the Transcend DSR API */
 export declare const IS_REQUIRED: {
     [k in ColumnName]: boolean;
 };
+/** These parameters can be specified for the entire CSV set if needed */
+export declare const CAN_APPLY_IN_BULK: {
+    [k in ColumnName]?: boolean;
+};
 export declare const CachedFileState: t.TypeC<{
+    /** Mapping between the default request input column names and the CSV column name for that input */
     columnNames: t.PartialC<{
         email: t.StringC;
         coreIdentifier: t.StringC;
@@ -35,6 +43,11 @@ export declare const CachedFileState: t.TypeC<{
         createdAt: t.StringC;
         dataSiloIds: t.StringC;
     }>;
+    /** Mapping between the identifier names and the CSV column name for that input */
+    identifierNames: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between the request attribute inputs and the CSV column name for that input */
+    attributeNames: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between CSV request type and Transcend Request Action */
     requestTypeToRequestAction: t.RecordC<t.StringC, t.KeyofC<{
         ACCESS: unknown;
         ERASURE: unknown;
@@ -56,7 +69,9 @@ export declare const CachedFileState: t.TypeC<{
         TRACKING_OPT_OUT: unknown;
         CUSTOM_OPT_OUT: unknown;
     }>>;
+    /** Mapping between CSV data subject type and the name of the data subject in Transcend */
     subjectTypeToSubjectName: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between language imported and Transcend locale code */
     languageToLocale: t.RecordC<t.StringC, t.KeyofC<{
         en: unknown;
         ar: unknown;
@@ -120,19 +135,22 @@ export declare const CachedFileState: t.TypeC<{
         "he-IL": unknown;
         "en-NZ": unknown;
     }>>;
-    failingRequests: t.ArrayC<t.RecordC<t.StringC, t.AnyC>>;
+    /** Mapping between request status in import to Transcend request status */
     statusToRequestStatus: t.RecordC<t.StringC, t.KeyofC<{
-        NONE: unknown;
+        "[NONE]": unknown;
         FAILED_VERIFICATION: unknown;
         COMPLETED: unknown;
         CANCELED: unknown;
         SECONDARY_COMPLETED: unknown;
         REVOKED: unknown;
     }>>;
+    /** Set of privacy requests that failed to upload */
+    failingRequests: t.ArrayC<t.RecordC<t.StringC, t.AnyC>>;
 }>;
 /** Type override */
 export declare type CachedFileState = t.TypeOf<typeof CachedFileState>;
 export declare const CachedState: t.RecordC<t.StringC, t.TypeC<{
+    /** Mapping between the default request input column names and the CSV column name for that input */
     columnNames: t.PartialC<{
         email: t.StringC;
         coreIdentifier: t.StringC;
@@ -143,6 +161,11 @@ export declare const CachedState: t.RecordC<t.StringC, t.TypeC<{
         createdAt: t.StringC;
         dataSiloIds: t.StringC;
     }>;
+    /** Mapping between the identifier names and the CSV column name for that input */
+    identifierNames: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between the request attribute inputs and the CSV column name for that input */
+    attributeNames: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between CSV request type and Transcend Request Action */
     requestTypeToRequestAction: t.RecordC<t.StringC, t.KeyofC<{
         ACCESS: unknown;
         ERASURE: unknown;
@@ -164,7 +187,9 @@ export declare const CachedState: t.RecordC<t.StringC, t.TypeC<{
         TRACKING_OPT_OUT: unknown;
         CUSTOM_OPT_OUT: unknown;
     }>>;
+    /** Mapping between CSV data subject type and the name of the data subject in Transcend */
     subjectTypeToSubjectName: t.RecordC<t.StringC, t.StringC>;
+    /** Mapping between language imported and Transcend locale code */
     languageToLocale: t.RecordC<t.StringC, t.KeyofC<{
         en: unknown;
         ar: unknown;
@@ -228,14 +253,16 @@ export declare const CachedState: t.RecordC<t.StringC, t.TypeC<{
         "he-IL": unknown;
         "en-NZ": unknown;
     }>>;
-    failingRequests: t.ArrayC<t.RecordC<t.StringC, t.AnyC>>;
+    /** Mapping between request status in import to Transcend request status */
     statusToRequestStatus: t.RecordC<t.StringC, t.KeyofC<{
-        NONE: unknown;
+        "[NONE]": unknown;
         FAILED_VERIFICATION: unknown;
         COMPLETED: unknown;
         CANCELED: unknown;
         SECONDARY_COMPLETED: unknown;
         REVOKED: unknown;
     }>>;
+    /** Set of privacy requests that failed to upload */
+    failingRequests: t.ArrayC<t.RecordC<t.StringC, t.AnyC>>;
 }>>;
 //# sourceMappingURL=constants.d.ts.map

package/build/requests/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/requests/constants.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,eAAO,MAAM,IAAI,SAAS,CAAC;AAE3B;;GAEG;AACH,oBAAY,UAAU;IACpB,oCAAoC;IACpC,KAAK,UAAU;IACf,8CAA8C;IAC9C,cAAc,mBAAmB;IACjC,0CAA0C;IAC1C,WAAW,gBAAgB;IAC3B,0CAA0C;IAC1C,WAAW,gBAAgB;IAC3B,qCAAqC;IACrC,MAAM,WAAW;IACjB,4CAA4C;IAC5C,aAAa,kBAAkB;IAC/B,wCAAwC;IACxC,SAAS,cAAc;IACvB,0CAA0C;IAC1C,WAAW,gBAAgB;CAC5B;AAED,eAAO,MAAM,WAAW,EAAE;KAAG,CAAC,IAAI,UAAU,GAAG,OAAO;CASrD,CAAC;AAGF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAU1B,CAAC;AAEH,oBAAoB;AACpB,oBAAY,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAsC,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/requests/constants.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,eAAO,MAAM,IAAI,UAAoB,CAAC;AACtC,eAAO,MAAM,UAAU,6BAAuC,CAAC;AAC/D,eAAO,MAAM,KAAK,WAAqB,CAAC;AAExC;;GAEG;AACH,oBAAY,UAAU;IACpB,oCAAoC;IACpC,KAAK,UAAU;IACf,8CAA8C;IAC9C,cAAc,mBAAmB;IACjC,0CAA0C;IAC1C,WAAW,gBAAgB;IAC3B,0CAA0C;IAC1C,WAAW,gBAAgB;IAC3B,qCAAqC;IACrC,MAAM,WAAW;IACjB,4CAA4C;IAC5C,aAAa,kBAAkB;IAC/B,wCAAwC;IACxC,SAAS,cAAc;IACvB,0CAA0C;IAC1C,WAAW,gBAAgB;CAC5B;AAED,6DAA6D;AAC7D,eAAO,MAAM,WAAW,EAAE;KAAG,CAAC,IAAI,UAAU,GAAG,OAAO;CASrD,CAAC;AAEF,yEAAyE;AACzE,eAAO,MAAM,iBAAiB,EAAE;KAAG,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,OAAO;CAG5D,CAAC;AAGF,eAAO,MAAM,eAAe;IAC1B,oGAAoG;;;;;;;;;;;IAEpG,kFAAkF;;IAElF,0FAA0F;;IAE1F,oEAAoE;;;;;;;;;;;;;;;;;;;;;;IAEpE,0FAA0F;;IAE1F,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAElE,2EAA2E;;;;;;;;;IAK3E,oDAAoD;;EAEpD,CAAC;AAEH,oBAAoB;AACpB,oBAAY,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D,eAAO,MAAM,WAAW;IAxBtB,oGAAoG;;;;;;;;;;;IAEpG,kFAAkF;;IAElF,0FAA0F;;IAE1F,oEAAoE;;;;;;;;;;;;;;;;;;;;;;IAEpE,0FAA0F;;IAE1F,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAElE,2EAA2E;;;;;;;;;IAK3E,oDAAoD;;GAOQ,CAAC"}

package/build/requests/constants.js

@@ -19,12 +19,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CachedState = exports.CachedFileState = exports.IS_REQUIRED = exports.ColumnName = exports.NONE = void 0;
+exports.CachedState = exports.CachedFileState = exports.CAN_APPLY_IN_BULK = exports.IS_REQUIRED = exports.ColumnName = exports.BLANK = exports.BULK_APPLY = exports.NONE = void 0;
 const type_utils_1 = require("@transcend-io/type-utils");
 const internationalization_1 = require("@transcend-io/internationalization");
 const privacy_types_1 = require("@transcend-io/privacy-types");
 const t = __importStar(require("io-ts"));
-exports.NONE = 'NONE';
+exports.NONE = '[NONE]';
+exports.BULK_APPLY = '[APPLY VALUE TO ALL ROWS]';
+exports.BLANK = '<blank>';
 /**
  * Column names to map
  */
@@ -47,6 +49,7 @@ var ColumnName;
     /** The title of the dataSiloIds column */
     ColumnName["DataSiloIds"] = "dataSiloIds";
 })(ColumnName = exports.ColumnName || (exports.ColumnName = {}));
+/** These parameters are required in the Transcend DSR API */
 exports.IS_REQUIRED = {
     [ColumnName.Email]: false,
     [ColumnName.CoreIdentifier]: true,
@@ -57,14 +60,29 @@ exports.IS_REQUIRED = {
     [ColumnName.DataSiloIds]: false,
     [ColumnName.Locale]: false,
 };
+/** These parameters can be specified for the entire CSV set if needed */
+exports.CAN_APPLY_IN_BULK = {
+    [ColumnName.RequestType]: true,
+    [ColumnName.SubjectType]: true,
+};
 // Cache state
 exports.CachedFileState = t.type({
+    /** Mapping between the default request input column names and the CSV column name for that input */
     columnNames: t.partial((0, type_utils_1.applyEnum)(ColumnName, () => t.string)),
+    /** Mapping between the identifier names and the CSV column name for that input */
+    identifierNames: t.record(t.string, t.string),
+    /** Mapping between the request attribute inputs and the CSV column name for that input */
+    attributeNames: t.record(t.string, t.string),
+    /** Mapping between CSV request type and Transcend Request Action */
     requestTypeToRequestAction: t.record(t.string, (0, type_utils_1.valuesOf)(privacy_types_1.RequestAction)),
+    /** Mapping between CSV data subject type and the name of the data subject in Transcend */
     subjectTypeToSubjectName: t.record(t.string, t.string),
+    /** Mapping between language imported and Transcend locale code */
     languageToLocale: t.record(t.string, (0, type_utils_1.valuesOf)(internationalization_1.LanguageKey)),
-    failingRequests: t.array(t.record(t.string, t.any)),
+    /** Mapping between request status in import to Transcend request status */
     statusToRequestStatus: t.record(t.string, (0, type_utils_1.valuesOf)({ ...privacy_types_1.CompletedRequestStatus, [exports.NONE]: exports.NONE })),
+    /** Set of privacy requests that failed to upload */
+    failingRequests: t.array(t.record(t.string, t.any)),
 });
 exports.CachedState = t.record(t.string, exports.CachedFileState);
 //# sourceMappingURL=constants.js.map