@transcend-io/cli 4.14.0 → 4.15.0

package/README.md

@@ -21,6 +21,9 @@
   - [tr-request-upload](#tr-request-upload)
     - [Authentication](#authentication-3)
   - [Usage](#usage-4)
+  - [tr-pull-cron-identifiers](#tr-pull-cron-identifiers)
+    - [Authentication](#authentication-4)
+  - [Usage](#usage-5)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -43,6 +46,7 @@ yarn tr-pull --auth=xxx
 yarn tr-push --auth=xxx
 yarn tr-discover-silos --auth=xxx
 yarn tr-request-upload --auth=xxx
+yarn tr-pull-cron-identifiers --auth=xxx
 ```
 
 or
@@ -56,6 +60,7 @@ tr-pull --auth=xxx
 tr-push --auth=xxx
 tr-discover-silos --auth=xxx
 tr-request-upload --auth=xxx
+tr-pull-cron-identifiers --auth=xxx
 ```
 
 alternatively, you can install the cli globally on your machine:
@@ -191,38 +196,38 @@ _Note: The scopes for tr-push are comprehensive of the scopes for tr-pull_
 
 ```sh
 # Writes out file to ./transcend.yml
-tr-pull --auth=<api-key>
+tr-pull --auth=$TRANSCEND_API_KEY
 ```
 
 An alternative file destination can be specified:
 
 ```sh
 # Writes out file to ./custom/location.yml
-tr-pull --auth=<api-key> --file=./custom/location.yml
+tr-pull --auth=$TRANSCEND_API_KEY --file=./custom/location.yml
 ```
 
 Or a specific data silo(s) can be pulled in:
 
 ```sh
-tr-pull --auth=<api-key> --dataSiloIds=710fec3c-7bcc-4c9e-baff-bf39f9bec43e
+tr-pull --auth=$TRANSCEND_API_KEY --dataSiloIds=710fec3c-7bcc-4c9e-baff-bf39f9bec43e
 ```
 
 Or a specific types of data silo(s) can be pulled in:
 
 ```sh
-tr-pull --auth=<api-key> --integrationNames=salesforce,snowflake
+tr-pull --auth=$TRANSCEND_API_KEY --integrationNames=salesforce,snowflake
 ```
 
 Or with a specific page size (max 100)
 
 ```sh
-tr-pull --auth=<api-key> --integrationNames=salesforce,snowflake --pageSize=30
+tr-pull --auth=$TRANSCEND_API_KEY --integrationNames=salesforce,snowflake --pageSize=30
 ```
 
 Or with debug logs
 
 ```sh
-tr-pull --auth=<api-key> --integrationNames=salesforce,snowflake --debug=true
+tr-pull --auth=$TRANSCEND_API_KEY --integrationNames=salesforce,snowflake --debug=true
 ```
 
 Note: This command will overwrite the existing transcend.yml file that you have locally.
@@ -248,14 +253,14 @@ The API key needs the following scopes:
 
 ```sh
 # Looks for file at ./transcend.yml
-tr-push --auth=<api-key>
+tr-push --auth=$TRANSCEND_API_KEY
 ```
 
 An alternative file destination can be specified:
 
 ```sh
 # Looks for file at custom location ./custom/location.yml
-tr-push --auth=<api-key> --file=./custom/location.yml
+tr-push --auth=$TRANSCEND_API_KEY --file=./custom/location.yml
 ```
 
 Some things to note about this sync process:
@@ -315,7 +320,7 @@ If you are using this cli to sync your Data Map between multiple Transcend insta
 The `tr-push` command takes in a parameter `variables`. This is a CSV of `key:value` pairs.
 
 ```sh
-tr-push --auth=<api-key> --variables=domain:acme.com,stage:staging
+tr-push --auth=$TRANSCEND_API_KEY --variables=domain:acme.com,stage:staging
 ```
 
 This command could fill out multiple parameters in a yaml file like [./examples/multi-instance.yml](./examples/multi-instance.yml), copied below:
@@ -415,74 +420,131 @@ The API key needs the following scopes:
 ### Usage
 
 ```sh
-yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY --file=/Users/transcend/Desktop/test.csv
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY --file=/Users/transcend/Desktop/test.csv \
+ --transcendApiUrl=https://api.us.transcend.io
 ```
 
 Run without being prompted to filter requests
 
 ```sh
-yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --skipFilterStep=true
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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 \
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/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 \
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/Desktop/test.csv \
   --attributes=Tags:transcend-cli;my-customer-tag,Customer:acme-corp
 ```
 
 Clear out the cache of failed and successful requests
 
 ```sh
-yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv \
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/Desktop/test.csv \
  --clearFailingRequests=true --clearSuccessfulRequests=true --clearDuplicateRequests=true
 ```
 
 Specify default country code for phone numbers
 
 ```sh
-yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --defaultPhoneCountryCode=44
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/Desktop/test.csv --defaultPhoneCountryCode=44
 ```
 
 Include debug logs - warning, this logs out personal data.
 
 ```sh
-yarn tr-request-upload --auth=<api-key> --file=/Users/michaelfarrell/Desktop/test.csv --debug=true
+yarn tr-request-upload --auth=$TRANSCEND_API_KEY --file=/Users/transcend/Desktop/test.csv --debug=true
+```
+
+### tr-pull-cron-identifiers
+
+If you are using the cron job integration, you can run this command to pull the outstanding identifiers
+for the data silo to a CSV.
+
+Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.
+
+https://user-images.githubusercontent.com/10264973/205483055-f4050645-bdf5-4ea2-8464-3183abd63074.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 must be associated to the ID of the integration/data silo that is being operated on.
+
+### Usage
+
+```sh
+yarn tr-pull-cron-identifiers --auth=$TRANSCEND_API_KEY -dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f \
+   --requestType=ERASURE
+```
+
+Pull to a specific file location
+
+```sh
+yarn tr-pull-cron-identifiers --auth=$TRANSCEND_API_KEY -dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f --requestType=ERASURE \
+   --file=/Users/transcend/Desktop/test.csv
+```
+
+For self-hosted sombras that use an internal key:
+
+```sh
+yarn tr-pull-cron-identifiers --auth=$TRANSCEND_API_KEY -dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f \
+   --requestType=ERASURE --sombraAuth=$SOMBRA_INTERNAL_KEY
+```
+
+Specifying the backend URL, needed for US hosted backend infrastructure.
+
+```sh
+yarn tr-pull-cron-identifiers --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY --file=/Users/transcend/Desktop/test.csv \
+ --transcendApiUrl=https://api.us.transcend.io
+```
+
+Specifying the page limit, defaults to 100.
+
+```sh
+yarn tr-pull-cron-identifiers --auth=$TRANSCEND_API_KEY --sombraAuth=$SOMBRA_INTERNAL_KEY --file=/Users/transcend/Desktop/test.csv \
+ --pageLimit=300
 ```

package/build/cli-pull-cron-identifiers.d.ts

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

package/build/cli-pull-cron-identifiers.d.ts.map

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

package/build/cli-pull-cron-identifiers.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 yargs_parser_1 = __importDefault(require("yargs-parser"));
+const colors_1 = __importDefault(require("colors"));
+const logger_1 = require("./logger");
+const cron_1 = require("./cron");
+const privacy_types_1 = require("@transcend-io/privacy-types");
+/**
+ * Pull the set of active identifiers for a cron job silo.
+ *
+ * Requires an API key with scope for the cron integration being checked on.
+ *
+ * Dev Usage:
+ * yarn ts-node ./src/cli-pull-cron-identifiers.ts --auth=asd123 \
+ *   --dataSiloId=92636cda-b7c6-48c6-b1b1-2df574596cbc \
+ *   --requestType=ERASURE \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv
+ *
+ * Standard usage:
+ * yarn tr-pull-cron-identifiers --auth=asd123  \
+ *   --dataSiloId=92636cda-b7c6-48c6-b1b1-2df574596cbc \
+ *   --requestType=ERASURE \
+ *   --file=/Users/michaelfarrell/Desktop/test.csv
+ */
+async function main() {
+    // Parse command line arguments
+    const { file = './cron-identifiers.csv', transcendApiUrl = 'https://api.transcend.io', auth, sombraAuth, dataSiloId, requestType, pageLimit = '100', } = (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);
+    }
+    // Validate request type
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (!Object.values(privacy_types_1.RequestAction).includes(requestType)) {
+        logger_1.logger.error(colors_1.default.red(`Failed to parse requestType:"${requestType}".\n` +
+            `Expected one of: \n${Object.values(privacy_types_1.RequestAction).join('\n')}`));
+        process.exit(1);
+    }
+    // Upload privacy requests
+    await (0, cron_1.pullCronIdentifiersToCsv)({
+        file,
+        transcendApiUrl,
+        pageLimit: parseInt(pageLimit, 10),
+        requestType: requestType,
+        auth,
+        sombraAuth,
+        dataSiloId,
+    });
+}
+main();
+//# sourceMappingURL=cli-pull-cron-identifiers.js.map

package/build/cli-pull-cron-identifiers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-pull-cron-identifiers.js","sourceRoot":"","sources":["../src/cli-pull-cron-identifiers.ts"],"names":[],"mappings":";;;;;;AAEA,gEAAiC;AACjC,oDAA4B;AAE5B,qCAAkC;AAClC,iCAAkD;AAClD,+DAA4D;AAE5D;;;;;;;;;;;;;;;;GAgBG;AACH,KAAK,UAAU,IAAI;IACjB,+BAA+B;IAC/B,MAAM,EACJ,IAAI,GAAG,wBAAwB,EAC/B,eAAe,GAAG,0BAA0B,EAC5C,IAAI,EACJ,UAAU,EACV,UAAU,EACV,WAAW,EACX,SAAS,GAAG,KAAK,GAClB,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,wBAAwB;IACxB,8DAA8D;IAC9D,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,QAAQ,CAAC,WAAkB,CAAC,EAAE;QAC9D,eAAM,CAAC,KAAK,CACV,gBAAM,CAAC,GAAG,CACR,gCAAgC,WAAW,MAAM;YAC/C,sBAAsB,MAAM,CAAC,MAAM,CAAC,6BAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAClE,CACF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,0BAA0B;IAC1B,MAAM,IAAA,+BAAwB,EAAC;QAC7B,IAAI;QACJ,eAAe;QACf,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;QAClC,WAAW,EAAE,WAA4B;QACzC,IAAI;QACJ,UAAU;QACV,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC"}

package/build/cli-request-upload.js

@@ -11,13 +11,10 @@ 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
+ * Requires an 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 \

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

@@ -1 +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,KAAK,EACnB,MAAM,GAAG,OAAO,EAChB,QAAQ,GAAG,MAAM,EACjB,uBAAuB,GAAG,GAAG,EAAE,MAAM;IACrC,eAAe,GAAG,MAAM,EACxB,sBAAsB,GAAG,OAAO,EAChC,uBAAuB,GAAG,OAAO,EACjC,oBAAoB,GAAG,OAAO,EAC9B,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,OAAO,EACf,cAAc,GAAG,OAAO,EACxB,UAAU,GAAG,oBAAoB,GAClC,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,oBAAoB,EAAE,oBAAoB,KAAK,MAAM;QACrD,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QACtC,eAAe;QACf,uBAAuB;QACvB,UAAU,EAAE,IAAA,yBAAc,EAAC,UAAU,CAAC;QACtC,sBAAsB,EAAE,sBAAsB,KAAK,MAAM;QACzD,uBAAuB,EAAE,uBAAuB,KAAK,MAAM;QAC3D,KAAK,EAAE,KAAK,KAAK,MAAM;QACvB,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"}
+{"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;;;;;;;;;;;;;;;;;GAiBG;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,KAAK,EACnB,MAAM,GAAG,OAAO,EAChB,QAAQ,GAAG,MAAM,EACjB,uBAAuB,GAAG,GAAG,EAAE,MAAM;IACrC,eAAe,GAAG,MAAM,EACxB,sBAAsB,GAAG,OAAO,EAChC,uBAAuB,GAAG,OAAO,EACjC,oBAAoB,GAAG,OAAO,EAC9B,MAAM,GAAG,OAAO,EAChB,KAAK,GAAG,OAAO,EACf,cAAc,GAAG,OAAO,EACxB,UAAU,GAAG,oBAAoB,GAClC,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,oBAAoB,EAAE,oBAAoB,KAAK,MAAM;QACrD,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QACtC,eAAe;QACf,uBAAuB;QACvB,UAAU,EAAE,IAAA,yBAAc,EAAC,UAAU,CAAC;QACtC,sBAAsB,EAAE,sBAAsB,KAAK,MAAM;QACzD,uBAAuB,EAAE,uBAAuB,KAAK,MAAM;QAC3D,KAAK,EAAE,KAAK,KAAK,MAAM;QACvB,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/cron/index.d.ts

@@ -0,0 +1,4 @@
+export * from './pullCronIdentifiersToCsv';
+export * from './pullCronPageOfIdentifiers';
+export * from './writeCsv';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cron/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,YAAY,CAAC"}

package/build/cron/index.js

@@ -0,0 +1,16 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pullCronIdentifiersToCsv"), exports);
+__exportStar(require("./pullCronPageOfIdentifiers"), exports);
+__exportStar(require("./writeCsv"), exports);
+//# sourceMappingURL=index.js.map

package/build/cron/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cron/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAA2C;AAC3C,8DAA4C;AAC5C,6CAA2B"}

package/build/cron/pullCronIdentifiersToCsv.d.ts

@@ -0,0 +1,24 @@
+import { CronIdentifier } from './pullCronPageOfIdentifiers';
+import { RequestAction } from '@transcend-io/privacy-types';
+/**
+ * Pull the set of cron job identifiers to CSV
+ *
+ * @param options - Options
+ */
+export declare function pullCronIdentifiersToCsv({ file, dataSiloId, auth, sombraAuth, requestType, pageLimit, transcendApiUrl, }: {
+    /** CSV file path */
+    file: string;
+    /** Transcend API key authentication */
+    auth: string;
+    /** Data Silo ID to pull down jobs for */
+    dataSiloId: string;
+    /** The request action to fetch */
+    requestType: RequestAction;
+    /** Page limit when fetching identifiers */
+    pageLimit?: number;
+    /** API URL for Transcend backend */
+    transcendApiUrl?: string;
+    /** Sombra API key authentication */
+    sombraAuth?: string;
+}): Promise<CronIdentifier[]>;
+//# sourceMappingURL=pullCronIdentifiersToCsv.d.ts.map

package/build/cron/pullCronIdentifiersToCsv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullCronIdentifiersToCsv.d.ts","sourceRoot":"","sources":["../../src/cron/pullCronIdentifiersToCsv.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,cAAc,EACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAI5D;;;;GAIG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,UAAU,EACV,WAAW,EACX,SAAe,EACf,eAA4C,GAC7C,EAAE;IACD,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,WAAW,EAAE,aAAa,CAAC;IAC3B,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAwD5B"}

package/build/cron/pullCronIdentifiersToCsv.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pullCronIdentifiersToCsv = void 0;
+const graphql_1 = require("../graphql");
+const colors_1 = __importDefault(require("colors"));
+const pullCronPageOfIdentifiers_1 = require("./pullCronPageOfIdentifiers");
+const writeCsv_1 = require("./writeCsv");
+const logger_1 = require("../logger");
+/**
+ * Pull the set of cron job identifiers to CSV
+ *
+ * @param options - Options
+ */
+async function pullCronIdentifiersToCsv({ file, dataSiloId, auth, sombraAuth, requestType, pageLimit = 100, transcendApiUrl = 'https://api.transcend.io', }) {
+    // Create sombra instance to communicate with
+    const sombra = await (0, graphql_1.createSombraGotInstance)(transcendApiUrl, auth, sombraAuth);
+    logger_1.logger.info(colors_1.default.magenta(`Pulling identifier for data silo: ${dataSiloId} of type ${requestType}`));
+    let offset = 0;
+    const identifiers = [];
+    let shouldContinue = true;
+    // Fetch a page of identifiers
+    while (shouldContinue) {
+        // eslint-disable-next-line no-await-in-loop
+        const pageIdentifiers = await (0, pullCronPageOfIdentifiers_1.pullCronPageOfIdentifiers)(sombra, {
+            dataSiloId,
+            limit: pageLimit,
+            offset,
+            requestType,
+        });
+        identifiers.push(...pageIdentifiers);
+        shouldContinue = pageIdentifiers.length === pageLimit;
+        offset += pageLimit;
+    }
+    logger_1.logger.info(colors_1.default.magenta(`Found: ${identifiers.length} outstanding identifiers to parse`));
+    // Write out to CSV
+    (0, writeCsv_1.writeCsv)(file, identifiers.map((identifier) => ({
+        ...identifier,
+        attributes: identifier.attributes
+            .map((attr) => `${attr.key}:${attr.values.join(';')}`)
+            .join(','),
+    })));
+    logger_1.logger.info(colors_1.default.green(`Successfully wrote ${identifiers.length} identifiers to file "${file}"`));
+    return identifiers;
+}
+exports.pullCronIdentifiersToCsv = pullCronIdentifiersToCsv;
+//# sourceMappingURL=pullCronIdentifiersToCsv.js.map

package/build/cron/pullCronIdentifiersToCsv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullCronIdentifiersToCsv.js","sourceRoot":"","sources":["../../src/cron/pullCronIdentifiersToCsv.ts"],"names":[],"mappings":";;;;;;AAAA,wCAAqD;AACrD,oDAA4B;AAC5B,2EAGqC;AAErC,yCAAsC;AACtC,sCAAmC;AAEnC;;;;GAIG;AACI,KAAK,UAAU,wBAAwB,CAAC,EAC7C,IAAI,EACJ,UAAU,EACV,IAAI,EACJ,UAAU,EACV,WAAW,EACX,SAAS,GAAG,GAAG,EACf,eAAe,GAAG,0BAA0B,GAgB7C;IACC,6CAA6C;IAC7C,MAAM,MAAM,GAAG,MAAM,IAAA,iCAAuB,EAC1C,eAAe,EACf,IAAI,EACJ,UAAU,CACX,CAAC;IAEF,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,OAAO,CACZ,qCAAqC,UAAU,YAAY,WAAW,EAAE,CACzE,CACF,CAAC;IAEF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,IAAI,cAAc,GAAG,IAAI,CAAC;IAE1B,8BAA8B;IAC9B,OAAO,cAAc,EAAE;QACrB,4CAA4C;QAC5C,MAAM,eAAe,GAAG,MAAM,IAAA,qDAAyB,EAAC,MAAM,EAAE;YAC9D,UAAU;YACV,KAAK,EAAE,SAAS;YAChB,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;QACH,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC;QACrC,cAAc,GAAG,eAAe,CAAC,MAAM,KAAK,SAAS,CAAC;QACtD,MAAM,IAAI,SAAS,CAAC;KACrB;IAED,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,OAAO,CACZ,UAAU,WAAW,CAAC,MAAM,mCAAmC,CAChE,CACF,CAAC;IAEF,mBAAmB;IACnB,IAAA,mBAAQ,EACN,IAAI,EACJ,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC/B,GAAG,UAAU;QACb,UAAU,EAAE,UAAU,CAAC,UAAU;aAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;aACrD,IAAI,CAAC,GAAG,CAAC;KACb,CAAC,CAAC,CACJ,CAAC;IAEF,eAAM,CAAC,IAAI,CACT,gBAAM,CAAC,KAAK,CACV,sBAAsB,WAAW,CAAC,MAAM,yBAAyB,IAAI,GAAG,CACzE,CACF,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AA/ED,4DA+EC"}

package/build/cron/pullCronPageOfIdentifiers.d.ts

@@ -0,0 +1,46 @@
+import * as t from 'io-ts';
+import { RequestAction } from '@transcend-io/privacy-types';
+import type { Got } from 'got';
+export declare const CronIdentifier: t.TypeC<{
+    /** The identifier value */
+    identifier: t.StringC;
+    /** The type of identifier */
+    type: t.StringC;
+    /** The core identifier of the request */
+    coreIdentifier: t.StringC;
+    /** The ID of the underlying data silo */
+    dataSiloId: t.StringC;
+    /** The ID of the underlying request */
+    requestId: t.StringC;
+    /** The request nonce */
+    nonce: t.StringC;
+    /** The time the request was created */
+    /** The number of days until the request is overdue */
+    daysUntilOverdue: t.NumberC;
+    /** Request attributes */
+    attributes: t.ArrayC<t.TypeC<{
+        key: t.StringC;
+        values: t.ArrayC<t.StringC>;
+    }>>;
+}>;
+/** Type override */
+export declare type CronIdentifier = t.TypeOf<typeof CronIdentifier>;
+/**
+ * Pull a offset of identifiers for a cron job
+ *
+ * @see https://docs.transcend.io/docs/api-reference/GET/v1/data-silo/(id)/pending-requests/(type)
+ * @param sombra - Sombra instance configured to make requests
+ * @param options - Additional options
+ * @returns Successfully submitted request
+ */
+export declare function pullCronPageOfIdentifiers(sombra: Got, { dataSiloId, limit, offset, requestType, }: {
+    /** Data Silo ID */
+    dataSiloId: string;
+    /** Type of request */
+    requestType: RequestAction;
+    /** Number of identifiers to pull in */
+    limit?: number;
+    /** Page to pull in */
+    offset?: number;
+}): Promise<CronIdentifier[]>;
+//# sourceMappingURL=pullCronPageOfIdentifiers.d.ts.map

package/build/cron/pullCronPageOfIdentifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullCronPageOfIdentifiers.d.ts","sourceRoot":"","sources":["../../src/cron/pullCronPageOfIdentifiers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/B,eAAO,MAAM,cAAc;IACzB,2BAA2B;;IAE3B,6BAA6B;;IAE7B,yCAAyC;;IAEzC,yCAAyC;;IAEzC,uCAAuC;;IAEvC,wBAAwB;;IAExB,uCAAuC;IAEvC,sDAAsD;;IAEtD,yBAAyB;;;;;EAOzB,CAAC;AAEH,oBAAoB;AACpB,oBAAY,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D;;;;;;;GAOG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,GAAG,EACX,EACE,UAAU,EACV,KAAW,EACX,MAAU,EACV,WAAW,GACZ,EAAE;IACD,mBAAmB;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB;IACtB,WAAW,EAAE,aAAa,CAAC;IAC3B,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GACA,OAAO,CAAC,cAAc,EAAE,CAAC,CAkB3B"}

package/build/cron/pullCronPageOfIdentifiers.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pullCronPageOfIdentifiers = exports.CronIdentifier = void 0;
+const t = __importStar(require("io-ts"));
+const type_utils_1 = require("@transcend-io/type-utils");
+exports.CronIdentifier = t.type({
+    /** The identifier value */
+    identifier: t.string,
+    /** The type of identifier */
+    type: t.string,
+    /** The core identifier of the request */
+    coreIdentifier: t.string,
+    /** The ID of the underlying data silo */
+    dataSiloId: t.string,
+    /** The ID of the underlying request */
+    requestId: t.string,
+    /** The request nonce */
+    nonce: t.string,
+    /** The time the request was created */
+    // requestCreatedAt: t.string, TODO
+    /** The number of days until the request is overdue */
+    daysUntilOverdue: t.number,
+    /** Request attributes */
+    attributes: t.array(t.type({
+        key: t.string,
+        values: t.array(t.string),
+    })),
+});
+/**
+ * Pull a offset of identifiers for a cron job
+ *
+ * @see https://docs.transcend.io/docs/api-reference/GET/v1/data-silo/(id)/pending-requests/(type)
+ * @param sombra - Sombra instance configured to make requests
+ * @param options - Additional options
+ * @returns Successfully submitted request
+ */
+async function pullCronPageOfIdentifiers(sombra, { dataSiloId, limit = 100, offset = 0, requestType, }) {
+    // Make the GraphQL request
+    const response = await sombra
+        .get(`v1/data-silo/${dataSiloId}/pending-requests/${requestType}`, {
+        searchParams: {
+            offset,
+            limit,
+        },
+    })
+        .json();
+    const { items } = (0, type_utils_1.decodeCodec)(t.type({
+        items: t.array(exports.CronIdentifier),
+    }), response);
+    return items;
+}
+exports.pullCronPageOfIdentifiers = pullCronPageOfIdentifiers;
+//# sourceMappingURL=pullCronPageOfIdentifiers.js.map

package/build/cron/pullCronPageOfIdentifiers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullCronPageOfIdentifiers.js","sourceRoot":"","sources":["../../src/cron/pullCronPageOfIdentifiers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,yDAAuD;AAI1C,QAAA,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC;IACnC,2BAA2B;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM;IACpB,6BAA6B;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM;IACd,yCAAyC;IACzC,cAAc,EAAE,CAAC,CAAC,MAAM;IACxB,yCAAyC;IACzC,UAAU,EAAE,CAAC,CAAC,MAAM;IACpB,uCAAuC;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM;IACnB,wBAAwB;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM;IACf,uCAAuC;IACvC,mCAAmC;IACnC,sDAAsD;IACtD,gBAAgB,EAAE,CAAC,CAAC,MAAM;IAC1B,yBAAyB;IACzB,UAAU,EAAE,CAAC,CAAC,KAAK,CACjB,CAAC,CAAC,IAAI,CAAC;QACL,GAAG,EAAE,CAAC,CAAC,MAAM;QACb,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;KAC1B,CAAC,CACH;CACF,CAAC,CAAC;AAKH;;;;;;;GAOG;AACI,KAAK,UAAU,yBAAyB,CAC7C,MAAW,EACX,EACE,UAAU,EACV,KAAK,GAAG,GAAG,EACX,MAAM,GAAG,CAAC,EACV,WAAW,GAUZ;IAED,2BAA2B;IAC3B,MAAM,QAAQ,GAAG,MAAM,MAAM;SAC1B,GAAG,CAAC,gBAAgB,UAAU,qBAAqB,WAAW,EAAE,EAAE;QACjE,YAAY,EAAE;YACZ,MAAM;YACN,KAAK;SACN;KACF,CAAC;SACD,IAAI,EAAE,CAAC;IAEV,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,wBAAW,EAC3B,CAAC,CAAC,IAAI,CAAC;QACL,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAc,CAAC;KAC/B,CAAC,EACF,QAAQ,CACT,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAnCD,8DAmCC"}

package/build/cron/writeCsv.d.ts

@@ -0,0 +1,9 @@
+import { ObjByString } from '@transcend-io/type-utils';
+/**
+ * Write a csv to file
+ *
+ * @param filePath - File to write out to
+ * @param data - Data to write
+ */
+export declare function writeCsv(filePath: string, data: ObjByString[]): Promise<void>;
+//# sourceMappingURL=writeCsv.d.ts.map

package/build/cron/writeCsv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeCsv.d.ts","sourceRoot":"","sources":["../../src/cron/writeCsv.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;;;GAKG;AACH,wBAAsB,QAAQ,CAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,WAAW,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC,CAaf"}

package/build/cron/writeCsv.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeCsv = void 0;
+const fastcsv = __importStar(require("fast-csv"));
+const fs_1 = require("fs");
+/**
+ * Write a csv to file
+ *
+ * @param filePath - File to write out to
+ * @param data - Data to write
+ */
+async function writeCsv(filePath, data) {
+    const ws = (0, fs_1.createWriteStream)(filePath);
+    await new Promise((resolve, reject) => {
+        try {
+            fastcsv
+                .write(data, { headers: true })
+                .pipe(ws)
+                .on('error', reject)
+                .on('end', () => resolve(true));
+        }
+        catch (err) {
+            reject(err);
+        }
+    });
+}
+exports.writeCsv = writeCsv;
+//# sourceMappingURL=writeCsv.js.map

package/build/cron/writeCsv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeCsv.js","sourceRoot":"","sources":["../../src/cron/writeCsv.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAoC;AACpC,2BAAuC;AAIvC;;;;;GAKG;AACI,KAAK,UAAU,QAAQ,CAC5B,QAAgB,EAChB,IAAmB;IAEnB,MAAM,EAAE,GAAG,IAAA,sBAAiB,EAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACpC,IAAI;YACF,OAAO;iBACJ,KAAK,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;iBAC9B,IAAI,CAAC,EAAE,CAAC;iBACR,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;iBACnB,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;SACnC;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,CAAC,GAAG,CAAC,CAAC;SACb;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,4BAgBC"}