@transcend-io/cli 7.0.0-alpha.7 → 7.0.0-alpha.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -41
- package/dist/bin/bash-complete.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/bin/deprecated-command.js +1 -1
- package/dist/{chunk-PNOEWENG.js → chunk-3KYYR6WM.js} +1 -1
- package/dist/{chunk-MLF3XCRS.js → chunk-4W2NF2OS.js} +1 -1
- package/dist/{chunk-IQZKONXI.js → chunk-5SI3ACV3.js} +1 -1
- package/dist/{chunk-DLIWRRVR.js → chunk-64RBCV3H.js} +20 -16
- package/dist/{chunk-NYDK4VPA.js → chunk-FXYTXR6R.js} +1 -1
- package/dist/{chunk-5TDUSKDZ.js → chunk-HXMONGHM.js} +1 -1
- package/dist/{chunk-AYMLP7SL.js → chunk-HXYCZ5UY.js} +1 -1
- package/dist/{chunk-LE6MXFBT.js → chunk-MBAKYLJ3.js} +1 -1
- package/dist/{chunk-QXOUJ7DT.js → chunk-SVDDU4R6.js} +1 -1
- package/dist/{chunk-QAPBYN24.js → chunk-TD5AG6IF.js} +1 -1
- package/dist/{chunk-4HZHZ32O.js → chunk-UPHD5UAO.js} +1 -1
- package/dist/{chunk-F5KKB33H.js → chunk-UVJSNZM5.js} +1 -1
- package/dist/{chunk-T4AGEIE3.js → chunk-XQTNSPJ3.js} +1 -1
- package/dist/{impl-URMADXQA.js → impl-2AQG2DEN.js} +1 -1
- package/dist/{impl-KQ2R65SG.js → impl-2CT4WQB5.js} +1 -1
- package/dist/{impl-LNLKIPIP.js → impl-4KGHP2BC.js} +1 -1
- package/dist/{impl-22YTZZ5H.js → impl-75Y3OM5Z.js} +1 -1
- package/dist/{impl-IDWP2NIG.js → impl-AKN4Q3ON.js} +1 -1
- package/dist/{impl-ZBWVSFDE.js → impl-B45RAXAK.js} +1 -1
- package/dist/{impl-7W6EBZXZ.js → impl-C4HUZZJO.js} +1 -1
- package/dist/{impl-UV5ERXN5.js → impl-DHTPY5AB.js} +1 -1
- package/dist/{impl-ISWFGOUS.js → impl-FCRKJBOS.js} +1 -1
- package/dist/{impl-JRA6GN3V.js → impl-GUEUJOOC.js} +1 -1
- package/dist/{impl-MFDS7DPF.js → impl-H57BW5MO.js} +1 -1
- package/dist/{impl-W454HAAT.js → impl-HCNN3NZK.js} +1 -1
- package/dist/{impl-YJ2FK37I.js → impl-IME3ONWF.js} +1 -1
- package/dist/{impl-52S3Z4ZE.js → impl-L3UJQJZ6.js} +1 -1
- package/dist/{impl-UYCGE2TQ.js → impl-LC3UNIDE.js} +1 -1
- package/dist/{impl-YT7F6KTN.js → impl-LEZFRF7Y.js} +1 -1
- package/dist/impl-LJLXQ3QL.js +1 -0
- package/dist/{impl-YBSUR2MT.js → impl-MZ6D4BQ3.js} +1 -1
- package/dist/{impl-GSXYV2XR.js → impl-NKKIQKJ6.js} +1 -1
- package/dist/impl-OQFT2DYM.js +1 -0
- package/dist/{impl-NVBTQCSL.js → impl-OQUKAZLQ.js} +1 -1
- package/dist/{impl-TLUPGHWG.js → impl-P63ATAHR.js} +1 -1
- package/dist/{impl-6J4LHKU5.js → impl-PATZGQVZ.js} +1 -1
- package/dist/{impl-ZXDLJ2TY.js → impl-PWZF46AT.js} +1 -1
- package/dist/{impl-ZEEUCWKF.js → impl-QD62F5PJ.js} +1 -1
- package/dist/{impl-4WQTM3GN.js → impl-S5PLONJN.js} +1 -1
- package/dist/{impl-PS2DUGWP.js → impl-SBN3KA7O.js} +1 -1
- package/dist/{impl-QYJFDBIV.js → impl-T4ODLBML.js} +1 -1
- package/dist/{impl-7C43442T.js → impl-TG65PIBJ.js} +1 -1
- package/dist/impl-UQR3O4M3.js +1 -0
- package/dist/impl-V5KJW35Z.js +1 -0
- package/dist/{impl-K2ZB3AKB.js → impl-WLQF5X2U.js} +1 -1
- package/dist/{impl-CLLZCY76.js → impl-X6FJHMP5.js} +1 -1
- package/dist/{impl-46IFTUCW.js → impl-XRYV4FW7.js} +1 -1
- package/dist/{impl-QTDGR3SU.js → impl-YFDEKBXT.js} +1 -1
- package/dist/{impl-Q65ZCWEQ.js → impl-YQW4KNXL.js} +1 -1
- package/dist/{impl-75FHAT4R.js → impl-YWNLYZI4.js} +1 -1
- package/dist/{impl-QR3ARAMQ.js → impl-ZBLHGXKD.js} +1 -1
- package/dist/index.js +1 -1
- package/package.json +3 -2
- package/dist/impl-ICGIPWVJ.js +0 -1
- package/dist/impl-ULVQLOA5.js +0 -1
- package/dist/impl-VT26YO3N.js +0 -1
package/README.md
CHANGED
|
@@ -32,8 +32,6 @@
|
|
|
32
32
|
- [`transcend consent upload-cookies-from-csv`](#transcend-consent-upload-cookies-from-csv)
|
|
33
33
|
- [`transcend consent upload-data-flows-from-csv`](#transcend-consent-upload-data-flows-from-csv)
|
|
34
34
|
- [`transcend consent upload-preferences`](#transcend-consent-upload-preferences)
|
|
35
|
-
- [`transcend consent consent-manager-service-json-to-yml`](#transcend-consent-consent-manager-service-json-to-yml)
|
|
36
|
-
- [`transcend consent consent-managers-to-business-entities`](#transcend-consent-consent-managers-to-business-entities)
|
|
37
35
|
- [`transcend inventory pull`](#transcend-inventory-pull)
|
|
38
36
|
- [Scopes](#scopes)
|
|
39
37
|
- [Usage](#usage-1)
|
|
@@ -49,6 +47,8 @@
|
|
|
49
47
|
- [`transcend inventory pull-unstructured-discovery-files`](#transcend-inventory-pull-unstructured-discovery-files)
|
|
50
48
|
- [`transcend inventory derive-data-silos-from-data-flows`](#transcend-inventory-derive-data-silos-from-data-flows)
|
|
51
49
|
- [`transcend inventory derive-data-silos-from-data-flows-cross-instance`](#transcend-inventory-derive-data-silos-from-data-flows-cross-instance)
|
|
50
|
+
- [`transcend inventory consent-manager-service-json-to-yml`](#transcend-inventory-consent-manager-service-json-to-yml)
|
|
51
|
+
- [`transcend inventory consent-managers-to-business-entities`](#transcend-inventory-consent-managers-to-business-entities)
|
|
52
52
|
- [`transcend admin generate-api-keys`](#transcend-admin-generate-api-keys)
|
|
53
53
|
- [Usage](#usage-4)
|
|
54
54
|
- [`transcend migration sync-ot`](#transcend-migration-sync-ot)
|
|
@@ -572,7 +572,7 @@ FLAGS
|
|
|
572
572
|
[--sombraAuth] The Sombra internal key, use for additional authentication when self-hosting Sombra
|
|
573
573
|
[--pageLimit] The page limit to use when pulling in pages of identifiers [default = 100]
|
|
574
574
|
[--skipRequestCount] Whether to skip the count of all outstanding requests. This is required to render the progress bar, but can take a long time to run if you have a large number of outstanding requests to process. In that case, we recommend setting skipRequestCount=true so that you can still proceed with fetching the identifiers [default = false]
|
|
575
|
-
[--chunkSize] Maximum number of rows per CSV file. For large datasets, the output will be automatically split into multiple files to avoid file system size limits. Each file will contain at most this many rows [default =
|
|
575
|
+
[--chunkSize] Maximum number of rows per CSV file. For large datasets, the output will be automatically split into multiple files to avoid file system size limits. Each file will contain at most this many rows [default = 10000]
|
|
576
576
|
-h --help Print help information and exit
|
|
577
577
|
```
|
|
578
578
|
|
|
@@ -583,7 +583,7 @@ USAGE
|
|
|
583
583
|
transcend request cron mark-identifiers-completed (--auth value) (--dataSiloId value) [--file value] [--transcendUrl value] [--sombraAuth value]
|
|
584
584
|
transcend request cron mark-identifiers-completed --help
|
|
585
585
|
|
|
586
|
-
This command takes the output of
|
|
586
|
+
This command takes the output of "transcend request cron pull-identifiers" and notifies Transcend that all of the requests in the CSV have been processed.
|
|
587
587
|
This is used in the workflow like:
|
|
588
588
|
|
|
589
589
|
1. Pull identifiers to CSV:
|
|
@@ -834,42 +834,6 @@ Specifying the backend URL, needed for US hosted backend infrastructure:
|
|
|
834
834
|
transcend consent upload-preferences --auth=$TRANSCEND_API_KEY --partition=4d1c5daa-90b7-4d18-aa40-f86a43d2c726 --consentUrl=https://consent.us.transcend.io
|
|
835
835
|
```
|
|
836
836
|
|
|
837
|
-
### `transcend consent consent-manager-service-json-to-yml`
|
|
838
|
-
|
|
839
|
-
```txt
|
|
840
|
-
USAGE
|
|
841
|
-
transcend consent consent-manager-service-json-to-yml [--file value] [--output value]
|
|
842
|
-
transcend consent consent-manager-service-json-to-yml --help
|
|
843
|
-
|
|
844
|
-
Import the services from an airgap.js file into a Transcend instance.
|
|
845
|
-
|
|
846
|
-
Step 1) Run `await airgap.getMetadata()` on a site with airgap
|
|
847
|
-
Step 2) Right click on the printed object, and click `Copy object`
|
|
848
|
-
Step 3) Place output of file in a file named `services.json`
|
|
849
|
-
Step 4) Run `transcend consent consent-manager-service-json-to-yml --file=./services.json --output=./transcend.yml`
|
|
850
|
-
Step 5) Run `transcend inventory push --auth=$TRANSCEND_API_KEY --file=./transcend.yml --classifyService=true`
|
|
851
|
-
|
|
852
|
-
FLAGS
|
|
853
|
-
[--file] Path to the services.json file, output of await airgap.getMetadata() [default = ./services.json]
|
|
854
|
-
[--output] Path to the output transcend.yml to write to [default = ./transcend.yml]
|
|
855
|
-
-h --help Print help information and exit
|
|
856
|
-
```
|
|
857
|
-
|
|
858
|
-
### `transcend consent consent-managers-to-business-entities`
|
|
859
|
-
|
|
860
|
-
```txt
|
|
861
|
-
USAGE
|
|
862
|
-
transcend consent consent-managers-to-business-entities (--consentManagerYmlFolder value) [--output value]
|
|
863
|
-
transcend consent consent-managers-to-business-entities --help
|
|
864
|
-
|
|
865
|
-
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.
|
|
866
|
-
|
|
867
|
-
FLAGS
|
|
868
|
-
--consentManagerYmlFolder Path to the folder of Consent Manager transcend.yml files to combine
|
|
869
|
-
[--output] Path to the output transcend.yml with business entity configuration [default = ./combined-business-entities.yml]
|
|
870
|
-
-h --help Print help information and exit
|
|
871
|
-
```
|
|
872
|
-
|
|
873
837
|
### `transcend inventory pull`
|
|
874
838
|
|
|
875
839
|
```txt
|
|
@@ -1383,6 +1347,42 @@ FLAGS
|
|
|
1383
1347
|
-h --help Print help information and exit
|
|
1384
1348
|
```
|
|
1385
1349
|
|
|
1350
|
+
### `transcend inventory consent-manager-service-json-to-yml`
|
|
1351
|
+
|
|
1352
|
+
```txt
|
|
1353
|
+
USAGE
|
|
1354
|
+
transcend inventory consent-manager-service-json-to-yml [--file value] [--output value]
|
|
1355
|
+
transcend inventory consent-manager-service-json-to-yml --help
|
|
1356
|
+
|
|
1357
|
+
Import the services from an airgap.js file into a Transcend instance.
|
|
1358
|
+
|
|
1359
|
+
Step 1) Run `await airgap.getMetadata()` on a site with airgap
|
|
1360
|
+
Step 2) Right click on the printed object, and click `Copy object`
|
|
1361
|
+
Step 3) Place output of file in a file named `services.json`
|
|
1362
|
+
Step 4) Run `transcend consent consent-manager-service-json-to-yml --file=./services.json --output=./transcend.yml`
|
|
1363
|
+
Step 5) Run `transcend inventory push --auth=$TRANSCEND_API_KEY --file=./transcend.yml --classifyService=true`
|
|
1364
|
+
|
|
1365
|
+
FLAGS
|
|
1366
|
+
[--file] Path to the services.json file, output of await airgap.getMetadata() [default = ./services.json]
|
|
1367
|
+
[--output] Path to the output transcend.yml to write to [default = ./transcend.yml]
|
|
1368
|
+
-h --help Print help information and exit
|
|
1369
|
+
```
|
|
1370
|
+
|
|
1371
|
+
### `transcend inventory consent-managers-to-business-entities`
|
|
1372
|
+
|
|
1373
|
+
```txt
|
|
1374
|
+
USAGE
|
|
1375
|
+
transcend inventory consent-managers-to-business-entities (--consentManagerYmlFolder value) [--output value]
|
|
1376
|
+
transcend inventory consent-managers-to-business-entities --help
|
|
1377
|
+
|
|
1378
|
+
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.
|
|
1379
|
+
|
|
1380
|
+
FLAGS
|
|
1381
|
+
--consentManagerYmlFolder Path to the folder of Consent Manager transcend.yml files to combine
|
|
1382
|
+
[--output] Path to the output transcend.yml with business entity configuration [default = ./combined-business-entities.yml]
|
|
1383
|
+
-h --help Print help information and exit
|
|
1384
|
+
```
|
|
1385
|
+
|
|
1386
1386
|
### `transcend admin generate-api-keys`
|
|
1387
1387
|
|
|
1388
1388
|
```txt
|
|
@@ -1636,4 +1636,4 @@ export async function main(): Promise<void> {
|
|
|
1636
1636
|
|
|
1637
1637
|
## Proxy usage
|
|
1638
1638
|
|
|
1639
|
-
If you are trying to use the cli inside a corporate firewall and need to send traffic through a proxy, you can do so via the `http_proxy` environment variable
|
|
1639
|
+
If you are trying to use the cli inside a corporate firewall and need to send traffic through a proxy, you can do so via the `http_proxy` environment variable,with a command like `http_proxy=http://localhost:5051 transcend inventory pull --auth=$TRANSCEND_API_KEY`.
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{a as s}from"../chunk-XMGVDVM2.js";import{a as o}from"../chunk-
|
|
2
|
+
import{a as s}from"../chunk-XMGVDVM2.js";import{a as o}from"../chunk-64RBCV3H.js";import"../chunk-5SI3ACV3.js";import"../chunk-APA5PR4U.js";import"../chunk-4W2NF2OS.js";import"../chunk-EZCJGIOS.js";import{proposeCompletions as r}from"@stricli/core";var t=process.argv.slice(3);process.env.COMP_LINE?.endsWith(" ")&&t.push("");await r(o,t,s(process));try{for(let{completion:p}of await r(o,t,s(process)))process.stdout.write(`${p}
|
|
3
3
|
`)}catch{}
|
package/dist/bin/cli.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{a as o}from"../chunk-XMGVDVM2.js";import{a as r}from"../chunk-
|
|
2
|
+
import{a as o}from"../chunk-XMGVDVM2.js";import{a as r}from"../chunk-64RBCV3H.js";import"../chunk-5SI3ACV3.js";import"../chunk-APA5PR4U.js";import"../chunk-4W2NF2OS.js";import"../chunk-EZCJGIOS.js";import{run as i}from"@stricli/core";await i(r,process.argv.slice(2),o(process));
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import{a as n}from"../chunk-
|
|
2
|
+
import{a as n}from"../chunk-64RBCV3H.js";import"../chunk-5SI3ACV3.js";import{a as r}from"../chunk-OERYFLN2.js";import"../chunk-APA5PR4U.js";import"../chunk-4W2NF2OS.js";import"../chunk-EZCJGIOS.js";import{generateHelpTextForAllCommands as c}from"@stricli/core";var s={"tr-build-xdi-sync-endpoint":["consent","build-xdi-sync-endpoint"],"tr-consent-manager-service-json-to-yml":["inventory","consent-manager-service-json-to-yml"],"tr-consent-managers-to-business-entities":["inventory","consent-managers-to-business-entities"],"tr-cron-mark-identifiers-completed":["request","cron","mark-identifiers-completed"],"tr-cron-pull-identifiers":["request","cron","pull-identifiers"],"tr-derive-data-silos-from-data-flows":["inventory","derive-data-silos-from-data-flows"],"tr-derive-data-silos-from-data-flows-cross-instance":["inventory","derive-data-silos-from-data-flows-cross-instance"],"tr-discover-silos":["inventory","discover-silos"],"tr-generate-api-keys":["admin","generate-api-keys"],"tr-manual-enrichment-pull-identifiers":["request","preflight","pull-identifiers"],"tr-manual-enrichment-push-identifiers":["request","preflight","push-identifiers"],"tr-mark-request-data-silos-completed":["request","system","mark-request-data-silos-completed"],"tr-pull":["inventory","pull"],"tr-pull-consent-metrics":["consent","pull-consent-metrics"],"tr-pull-consent-preferences":["consent","pull-consent-preferences"],"tr-pull-datapoints":["inventory","pull-datapoints"],"tr-pull-pull-unstructured-discovery-files":["inventory","pull-unstructured-discovery-files"],"tr-push":["inventory","push"],"tr-request-approve":["request","approve"],"tr-request-cancel":["request","cancel"],"tr-request-download-files":["request","download-files"],"tr-request-enricher-restart":["request","enricher-restart"],"tr-request-export":["request","export"],"tr-request-mark-silent":["request","mark-silent"],"tr-request-notify-additional-time":["request","notify-additional-time"],"tr-request-reject-unverified-identifiers":["request","reject-unverified-identifiers"],"tr-request-restart":["request","restart"],"tr-request-upload":["request","upload"],"tr-retry-request-data-silos":["request","system","retry-request-data-silos"],"tr-scan-packages":["inventory","scan-packages"],"tr-skip-preflight-jobs":["request","skip-preflight-jobs"],"tr-skip-request-data-silos":["request","system","skip-request-data-silos"],"tr-sync-ot":["migration","sync-ot"],"tr-update-consent-manager":["consent","update-consent-manager"],"tr-upload-consent-preferences":["consent","upload-consent-preferences"],"tr-upload-cookies-from-csv":["consent","upload-cookies-from-csv"],"tr-upload-data-flows-from-csv":["consent","upload-data-flows-from-csv"],"tr-upload-preferences":["consent","upload-preferences"]};function m(t){return c(n).find(o=>o[0]===`${n.config.name} ${t.join(" ")}`)?.[1]}function i(t){r.log("[DEPRECATION NOTICE]");let e=s[t];if(!e){let a=Object.entries(s).map(([d,l])=>`\`${d}\` -> \`${n.config.name} ${l.join(" ")}\``).join(`
|
|
3
3
|
`);r.log(`This command is deprecated as of v7.0.0. Here is a list of new commands, mapped to their legacy command names:
|
|
4
4
|
${a}`);return}r.log(`\`${t}\` is deprecated as of v7.0.0.
|
|
5
5
|
Use \`${n.config.name} ${e.join(" ")}\` instead.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{_b as S,a as w,f as $,i as B,j as T,l as R}from"./chunk-
|
|
1
|
+
import{_b as S,a as w,f as $,i as B,j as T,l as R}from"./chunk-MBAKYLJ3.js";import{a as i}from"./chunk-OERYFLN2.js";import{keyBy as O,uniq as A,chunk as U,sortBy as G}from"lodash-es";import{SubDataPointDataSubCategoryGuessStatus as _}from"@transcend-io/privacy-types";import h from"cli-progress";import{gql as L}from"graphql-request";import f from"colors";async function q(u,{dataSiloIds:e=[],includeGuessedCategories:l,includeAttributes:a,parentCategories:c=[],subCategories:t=[],pageSize:p=1e3}={}){let n=[],m=new Date().getTime(),d=new h.SingleBar({},h.Presets.shades_classic),s={...c.length>0?{category:c}:{},...t.length>0?{subCategoryIds:t}:{},...c.length+t.length>0&&!l?{status:_.Approved}:{},...e.length>0?{dataSilos:e}:{}},{subDataPoints:{totalCount:o}}=await S(u,$,{filterBy:s});i.info(f.magenta("[Step 1/3] Pulling in all subdatapoints")),d.start(o,0);let y=0,D=!1,r,b=0;do try{let{subDataPoints:{nodes:P}}=await S(u,L`
|
|
2
2
|
query TranscendCliSubDataPointCsvExport(
|
|
3
3
|
$filterBy: SubDataPointFiltersInput
|
|
4
4
|
$first: Int!
|
|
@@ -1 +1 @@
|
|
|
1
|
-
var s="A command line interface for programmatic operations across Transcend.",n="7.0.0-alpha.
|
|
1
|
+
var s="A command line interface for programmatic operations across Transcend.",n="7.0.0-alpha.8";export{s as a,n as b};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{d as a}from"./chunk-EZCJGIOS.js";import{buildCommand as c,numberParser as p}from"@stricli/core";import{ConsentTrackerStatus as l}from"@transcend-io/privacy-types";import{ScopeName as u,TRANSCEND_SCOPES as i}from"@transcend-io/privacy-types";function m(e){if(!/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(e))throw new Error(`Invalid UUID format: ${e}`);return e}function n(e){try{return new URL(e).toString().replace(/\/$/,"")}catch{throw new Error(`Invalid URL format: ${e}`)}}function h(e){return e.split(",").map(r=>r.trim()).filter(r=>r.length>0)}function g(e){let r=new Date(e);if(Number.isNaN(r.getTime()))throw new TypeError(`Invalid date: ${e}. Try using the ISO 8601 format (YYYY-MM-DDTHH:MM:SS.SSSZ)`);return r}var o=({scopes:e,requiresSiloScope:r=!1})=>{let t={kind:"parsed",parse:String,brief:"The Transcend API key."};return r&&(t.brief+=" This key must be associated with the data silo(s) being operated on."),e==="Varies"?{...t,brief:`${t.brief} The scopes required will vary depending on the operation performed. If in doubt, the ${i[u.FullAdmin].title} scope will always work.`}:e.length===0?{...t,brief:`${t.brief} No scopes are required for this command.`}:{...t,brief:`${t.brief} Requires scopes: ${e.map(d=>`"${i[d].title}"`).join(", ")}`}},s=(e="https://api.transcend.io")=>({kind:"parsed",parse:n,brief:"URL of the Transcend backend. Use https://api.us.transcend.io for US hosting",default:e}),k=()=>({kind:"parsed",parse:String,brief:"The Sombra internal key, use for additional authentication when self-hosting Sombra",optional:!0});var f=["dataSilos","enrichers","templates","apiKeys"],U=Object.values(l),v=c({loader:async()=>{let{pull:e}=await import("./impl-
|
|
1
|
+
import{d as a}from"./chunk-EZCJGIOS.js";import{buildCommand as c,numberParser as p}from"@stricli/core";import{ConsentTrackerStatus as l}from"@transcend-io/privacy-types";import{ScopeName as u,TRANSCEND_SCOPES as i}from"@transcend-io/privacy-types";function m(e){if(!/^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(e))throw new Error(`Invalid UUID format: ${e}`);return e}function n(e){try{return new URL(e).toString().replace(/\/$/,"")}catch{throw new Error(`Invalid URL format: ${e}`)}}function h(e){return e.split(",").map(r=>r.trim()).filter(r=>r.length>0)}function g(e){let r=new Date(e);if(Number.isNaN(r.getTime()))throw new TypeError(`Invalid date: ${e}. Try using the ISO 8601 format (YYYY-MM-DDTHH:MM:SS.SSSZ)`);return r}var o=({scopes:e,requiresSiloScope:r=!1})=>{let t={kind:"parsed",parse:String,brief:"The Transcend API key."};return r&&(t.brief+=" This key must be associated with the data silo(s) being operated on."),e==="Varies"?{...t,brief:`${t.brief} The scopes required will vary depending on the operation performed. If in doubt, the ${i[u.FullAdmin].title} scope will always work.`}:e.length===0?{...t,brief:`${t.brief} No scopes are required for this command.`}:{...t,brief:`${t.brief} Requires scopes: ${e.map(d=>`"${i[d].title}"`).join(", ")}`}},s=(e="https://api.transcend.io")=>({kind:"parsed",parse:n,brief:"URL of the Transcend backend. Use https://api.us.transcend.io for US hosting",default:e}),k=()=>({kind:"parsed",parse:String,brief:"The Sombra internal key, use for additional authentication when self-hosting Sombra",optional:!0});var f=["dataSilos","enrichers","templates","apiKeys"],U=Object.values(l),v=c({loader:async()=>{let{pull:e}=await import("./impl-SBN3KA7O.js");return e},parameters:{flags:{auth:o({scopes:"Varies"}),resources:{kind:"enum",values:["all",...Object.values(a)],brief:`The different resource types to pull in. Defaults to ${f.join(",")}.`,variadic:",",optional:!0},file:{kind:"parsed",parse:String,brief:"Path to the YAML file to pull into",default:"./transcend.yml"},transcendUrl:s(),dataSiloIds:{kind:"parsed",parse:String,variadic:",",brief:"The UUIDs of the data silos that should be pulled into the YAML file",optional:!0},integrationNames:{kind:"parsed",parse:String,variadic:",",brief:"The types of integrations to pull down",optional:!0},trackerStatuses:{kind:"enum",values:Object.values(l),variadic:",",brief:"The statuses of consent manager trackers to pull down. Defaults to all statuses.",optional:!0},pageSize:{kind:"parsed",parse:p,brief:"The page size to use when paginating over the API",default:"50"},skipDatapoints:{kind:"boolean",brief:"When true, skip pulling in datapoints alongside data silo resource",default:!1},skipSubDatapoints:{kind:"boolean",brief:"When true, skip pulling in subDatapoints alongside data silo resource",default:!1},includeGuessedCategories:{kind:"boolean",brief:"When true, included guessed data categories that came from the content classifier",default:!1},debug:{kind:"boolean",brief:"Set to true to include debug logs while pulling the configuration",default:!1}}},docs:{brief:"Pull metadata from Transcend into transcend.yml",fullDescription:`Generates a transcend.yml by pulling the configuration from your Transcend instance.
|
|
2
2
|
|
|
3
3
|
The API key needs various scopes depending on the resources being pulled (see the CLI's README for more details).
|
|
4
4
|
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import{a as s,b as n,c as g,d as a,e as t,f as r,g as o,j as k}from"./chunk-
|
|
1
|
+
import{a as s,b as n,c as g,d as a,e as t,f as r,g as o,j as k}from"./chunk-5SI3ACV3.js";import{a as i}from"./chunk-APA5PR4U.js";import{a as h,b}from"./chunk-4W2NF2OS.js";import{b as m,c as f}from"./chunk-EZCJGIOS.js";import{buildInstallCommand as fr,buildUninstallCommand as hr}from"@stricli/auto-complete";import{buildApplication as br,buildRouteMap as gr}from"@stricli/core";import{buildRouteMap as we}from"@stricli/core";import{buildCommand as Se}from"@stricli/core";var y=Se({loader:async()=>{let{generateApiKeys:e}=await import("./impl-WLQF5X2U.js");return e},parameters:{flags:{email:{kind:"parsed",parse:String,brief:"The email address that you use to log into Transcend"},password:{kind:"parsed",parse:String,brief:"The password for your account login"},apiKeyTitle:{kind:"parsed",parse:String,brief:"The title of the API key being generated or destroyed"},file:{kind:"parsed",parse:String,brief:"The file where API keys should be written to"},scopes:{kind:"parsed",parse:String,variadic:",",brief:"The list of scopes that should be given to the API key"},deleteExistingApiKey:{kind:"boolean",brief:"When true, if an API key exists with the specified apiKeyTitle, the existing API key is deleted",default:!0},createNewApiKey:{kind:"boolean",brief:"When true, new API keys will be created. Set to false if you simply want to delete all API keys with a title",default:!0},parentOrganizationId:{kind:"parsed",parse:s,brief:"Filter for only a specific organization by ID, returning all child accounts associated with that organization",optional:!0},transcendUrl:r()}},docs:{brief:"Generate API keys",fullDescription:`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.
|
|
2
2
|
|
|
3
3
|
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, and that JSON file can be used in subsequent cli commands.
|
|
4
4
|
|
|
5
|
-
Authentication requires your email and password for the Transcend account. This command will only generate API keys for Transcend instances where you have the permission to "Manage API Keys".`}});var S=
|
|
5
|
+
Authentication requires your email and password for the Transcend account. This command will only generate API keys for Transcend instances where you have the permission to "Manage API Keys".`}});var S=we({routes:{"generate-api-keys":y},docs:{brief:"Admin commands"}});import{buildRouteMap as Le}from"@stricli/core";import{buildCommand as ve}from"@stricli/core";import{ScopeName as Ce}from"@transcend-io/privacy-types";var w=ve({loader:async()=>{let{buildXdiSyncEndpoint:e}=await import("./impl-AKN4Q3ON.js");return e},parameters:{flags:{auth:t({scopes:[Ce.ViewConsentManager]}),xdiLocation:{kind:"parsed",parse:String,brief:"The location of the XDI that will be loaded by the generated sync endpoint"},file:{kind:"parsed",parse:String,brief:"The HTML file path where the sync endpoint should be written",default:"./sync-endpoint.html"},removeIpAddresses:{kind:"boolean",brief:"When true, remove IP addresses from the domain list",default:!0},domainBlockList:{kind:"parsed",parse:g,brief:"The set of domains that should be excluded from the sync endpoint. Comma-separated list.",default:"localhost"},xdiAllowedCommands:{kind:"parsed",parse:String,brief:"The allowed set of XDI commands",default:"ConsentManager:Sync"},transcendUrl:r()}},docs:{brief:"Build XDI sync endpoint",fullDescription:"This command allows for building of the XDI Sync Endpoint across a set of Transcend accounts."}});import{buildCommand as Te}from"@stricli/core";import{ScopeName as qe}from"@transcend-io/privacy-types";var v=Te({loader:async()=>{let{pullConsentMetrics:e}=await import("./impl-PWZF46AT.js");return e},parameters:{flags:{auth:t({scopes:[qe.ViewConsentManager]}),start:{kind:"parsed",parse:a,brief:"The start date to pull metrics from"},end:{kind:"parsed",parse:a,brief:"The end date to pull metrics until",optional:!0},folder:{kind:"parsed",parse:String,brief:"The folder to save metrics to",default:"./consent-metrics/"},bin:{kind:"parsed",parse:String,brief:"The bin metric when pulling data (1h or 1d)",default:"1d"},transcendUrl:r()}},docs:{brief:"Pull consent metrics",fullDescription:"This command allows for pulling consent manager metrics for a Transcend account, or a set of Transcend accounts.\n\nBy default, the consent metrics will be written to a folder named `consent-metrics` within the directory where you run the command. You can override the location that these CSVs are written to using the flag `--folder=./my-folder/`. This folder will contain a set of CSV files:\n\n- `CONSENT_CHANGES_TIMESERIES_optIn.csv` -> this is a feed containing the number of explicit opt in events that happen - these are calls to `airgap.setConsent(event, { SaleOfInfo: true });`\n- `CONSENT_CHANGES_TIMESERIES_optOut.csv` -> this is a feed containing the number of explicit opt out events that happen - these are calls to `airgap.setConsent(event, { SaleOfInfo: false });`\n- `CONSENT_SESSIONS_BY_REGIME_Default.csv` -> this contains the number of sessions detected for the bin period\n- `PRIVACY_SIGNAL_TIMESERIES_DNT.csv` -> the number of DNT signals detected.\n- `PRIVACY_SIGNAL_TIMESERIES_GPC.csv` -> the number of GPC signals detected."}});import{buildCommand as Pe,numberParser as Ae}from"@stricli/core";import{ScopeName as De}from"@transcend-io/privacy-types";var C=Pe({loader:async()=>{let{pullConsentPreferences:e}=await import("./impl-GUEUJOOC.js");return e},parameters:{flags:{auth:t({scopes:[De.ViewManagedConsentDatabaseAdminApi]}),partition:{kind:"parsed",parse:String,brief:"The partition key to download consent preferences to"},sombraAuth:o(),file:{kind:"parsed",parse:String,brief:"Path to the CSV file to save preferences to",default:"./preferences.csv"},transcendUrl:r(),timestampBefore:{kind:"parsed",parse:a,brief:"Filter for consents updated this time",optional:!0},timestampAfter:{kind:"parsed",parse:a,brief:"Filter for consents updated after this time",optional:!0},identifiers:{kind:"parsed",parse:String,variadic:",",brief:"Filter for specific identifiers",optional:!0},concurrency:{kind:"parsed",parse:Ae,brief:"The concurrency to use when downloading consents in parallel",default:"100"}}},docs:{brief:"Pull consent preferences",fullDescription:"This command allows for pull of consent preferences from the Managed Consent Database."}});import{buildCommand as Re}from"@stricli/core";import{ConsentBundleType as Ie,ScopeName as Ue}from"@transcend-io/privacy-types";var T=Re({loader:async()=>{let{updateConsentManager:e}=await import("./impl-4KGHP2BC.js");return e},parameters:{flags:{auth:t({scopes:[Ue.ManageConsentManagerDeveloperSettings]}),bundleTypes:{kind:"enum",values:Object.values(Ie),brief:"The bundle types to deploy. Defaults to PRODUCTION,TEST.",variadic:","},deploy:{kind:"boolean",brief:"When true, deploy the Consent Manager after updating the version",default:!1},transcendUrl:r()}},docs:{brief:"Update consent manager",fullDescription:"This command allows for updating Consent Manager to latest version. The Consent Manager bundle can also be deployed using this command."}});import{buildCommand as Ve,numberParser as xe}from"@stricli/core";var q=Ve({loader:async()=>{let{uploadConsentPreferences:e}=await import("./impl-UQR3O4M3.js");return e},parameters:{flags:{base64EncryptionKey:{kind:"parsed",parse:String,brief:"The encryption key used to encrypt the userId"},base64SigningKey:{kind:"parsed",parse:String,brief:"The signing key used to prove authentication of consent request"},partition:{kind:"parsed",parse:String,brief:"The partition key to download consent preferences to"},file:{kind:"parsed",parse:String,brief:"The file to pull consent preferences from",default:"./preferences.csv"},consentUrl:{kind:"parsed",parse:n,brief:"URL of the Transcend Consent backend. Use https://consent.us.transcend.io for US hosting",default:"https://consent.transcend.io"},concurrency:{kind:"parsed",parse:xe,brief:"The concurrency to use when uploading requests in parallel",default:"100"}}},docs:{brief:"Upload consent preferences to the Managed Consent Database",fullDescription:"This command allows for updating of consent preferences to the Managed Consent Database."}});import{buildCommand as Me}from"@stricli/core";import{ConsentTrackerStatus as Oe,ScopeName as Ne}from"@transcend-io/privacy-types";var P=Me({loader:async()=>{let{uploadCookiesFromCsv:e}=await import("./impl-V5KJW35Z.js");return e},parameters:{flags:{auth:t({scopes:[Ne.ManageDataFlow]}),trackerStatus:{kind:"enum",values:Object.values(Oe),brief:"The status of the cookies you will upload."},file:{kind:"parsed",parse:String,brief:"Path to the CSV file to upload",default:"./cookies.csv"},transcendUrl:r()}},docs:{brief:"Upload cookies from CSV",fullDescription:`Upload cookies from CSV. This command allows for uploading of cookies from CSV.
|
|
6
6
|
|
|
7
7
|
Step 1) Download the CSV of cookies that you want to edit from the Admin Dashboard under [Consent Management -> Cookies](https://app.transcend.io/consent-manager/cookies). You can download cookies from both the "Triage" and "Approved" tabs.
|
|
8
8
|
|
|
9
9
|
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.
|
|
10
10
|
|
|
11
|
-
Step 3) Upload the modified CSV file back into the dashboard with this command.`}});import{buildCommand as
|
|
11
|
+
Step 3) Upload the modified CSV file back into the dashboard with this command.`}});import{buildCommand as je}from"@stricli/core";import{ConsentTrackerStatus as Ee,ScopeName as Fe}from"@transcend-io/privacy-types";var A=je({loader:async()=>{let{uploadDataFlowsFromCsv:e}=await import("./impl-OQFT2DYM.js");return e},parameters:{flags:{auth:t({scopes:[Fe.ManageDataFlow]}),trackerStatus:{kind:"enum",values:Object.values(Ee),brief:"The status of the data flows you will upload."},file:{kind:"parsed",parse:String,brief:"Path to the CSV file to upload",default:"./data-flows.csv"},classifyService:{kind:"boolean",brief:"When true, automatically assign the service for a data flow based on the domain that is specified",default:!1},transcendUrl:r()}},docs:{brief:"Upload data flows from CSV",fullDescription:`Upload data flows from CSV. This command allows for uploading of data flows from CSV.
|
|
12
12
|
|
|
13
13
|
Step 1) Download the CSV of data flows that you want to edit from the Admin Dashboard under [Consent Management -> Data Flows](https://app.transcend.io/consent-manager/data-flows). You can download data flows from both the "Triage" and "Approved" tabs.
|
|
14
14
|
|
|
15
15
|
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.
|
|
16
16
|
|
|
17
|
-
Step 3) Upload the modified CSV file back into the dashboard with this command.`}});import{buildCommand as
|
|
17
|
+
Step 3) Upload the modified CSV file back into the dashboard with this command.`}});import{buildCommand as Be,numberParser as We}from"@stricli/core";import{ScopeName as d}from"@transcend-io/privacy-types";var D=Be({loader:async()=>{let{uploadPreferences:e}=await import("./impl-FCRKJBOS.js");return e},parameters:{flags:{auth:t({scopes:[d.ManageStoredPreferences,d.ViewManagedConsentDatabaseAdminApi,d.ViewPreferenceStoreSettings]}),partition:{kind:"parsed",parse:String,brief:"The partition key to download consent preferences to"},sombraAuth:o(),consentUrl:{kind:"parsed",parse:n,brief:"URL of the Transcend backend. Use https://consent.us.transcend.io for US hosting",default:"https://consent.transcend.io"},file:{kind:"parsed",parse:String,brief:"Path to the CSV file to load preferences from",optional:!0},directory:{kind:"parsed",parse:String,brief:"Path to the directory of CSV files to load preferences from",optional:!0},dryRun:{kind:"boolean",brief:"Whether to do a dry run only - will write results to receiptFilepath without updating Transcend",default:!1},skipExistingRecordCheck:{kind:"boolean",brief:"Whether to skip the check for existing records. SHOULD ONLY BE USED FOR INITIAL UPLOAD",default:!1},receiptFileDir:{kind:"parsed",parse:String,brief:"Directory path where the response receipts should be saved",default:"./receipts"},skipWorkflowTriggers:{kind:"boolean",brief:"Whether to skip workflow triggers when uploading to preference store",default:!1},forceTriggerWorkflows:{kind:"boolean",brief:"Whether to force trigger workflows for existing consent records",default:!1},skipConflictUpdates:{kind:"boolean",brief:"Whether to skip uploading of any records where the preference store and file have a hard conflict",default:!1},isSilent:{kind:"boolean",brief:"Whether to skip sending emails in workflows",default:!0},attributes:{kind:"parsed",parse:String,brief:"Attributes to add to any DSR request if created. Comma-separated list of key:value pairs.",default:"Tags:transcend-cli,Source:transcend-cli"},receiptFilepath:{kind:"parsed",parse:String,brief:"Store resulting, continuing where left off",default:"./preference-management-upload-receipts.json"},concurrency:{kind:"parsed",parse:We,brief:"The concurrency to use when uploading in parallel",default:"10"}}},docs:{brief:"Upload preference management data to your Preference Store",fullDescription:`Upload preference management data to your Preference Store.
|
|
18
18
|
|
|
19
19
|
This command prompts you 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.
|
|
20
20
|
|
|
21
|
-
The script will also produce a JSON cache file that allows for the mappings to be preserved between runs.`}});var R=
|
|
21
|
+
The script will also produce a JSON cache file that allows for the mappings to be preserved between runs.`}});var R=Le({routes:{"build-xdi-sync-endpoint":w,"pull-consent-metrics":v,"pull-consent-preferences":C,"update-consent-manager":T,"upload-consent-preferences":q,"upload-cookies-from-csv":P,"upload-data-flows-from-csv":A,"upload-preferences":D},docs:{brief:"Consent commands"}});import{buildRouteMap as st}from"@stricli/core";import{buildCommand as Ye}from"@stricli/core";var I=Ye({loader:async()=>{let{deriveDataSilosFromDataFlowsCrossInstance:e}=await import("./impl-YQW4KNXL.js");return e},parameters:{flags:{auth:t({scopes:[]}),dataFlowsYmlFolder:{kind:"parsed",parse:String,brief:"The folder that contains data flow yml files"},output:{kind:"parsed",parse:String,brief:"The output transcend.yml file containing the data silo configurations",default:"./transcend.yml"},ignoreYmls:{kind:"parsed",parse:String,variadic:",",brief:"The set of yml files that should be skipped when uploading",optional:!0},transcendUrl:r()}},docs:{brief:"Derive data silos from data flows cross instance",fullDescription:"Given a folder of data flow transcend.yml configurations, convert those configurations to a single transcend.yml configurations of all related data silos."}});import{buildCommand as _e}from"@stricli/core";var U=_e({loader:async()=>{let{deriveDataSilosFromDataFlows:e}=await import("./impl-B45RAXAK.js");return e},parameters:{flags:{auth:t({scopes:[]}),dataFlowsYmlFolder:{kind:"parsed",parse:String,brief:"The folder that contains data flow yml files"},dataSilosYmlFolder:{kind:"parsed",parse:String,brief:"The folder that contains data silo yml files"},ignoreYmls:{kind:"parsed",parse:String,variadic:",",brief:"The set of yml files that should be skipped when uploading",optional:!0},transcendUrl:r()}},docs:{brief:"Derive data silos from data flows",fullDescription:"Given a folder of data flow transcend.yml configurations, convert those configurations to set of data silo transcend.yml configurations."}});import{buildCommand as Ge}from"@stricli/core";import{ScopeName as Ke}from"@transcend-io/privacy-types";var V=Ge({loader:async()=>{let{discoverSilos:e}=await import("./impl-TG65PIBJ.js");return e},parameters:{flags:{scanPath:{kind:"parsed",parse:String,brief:"File path in the project to scan"},dataSiloId:{kind:"parsed",parse:s,brief:"The UUID of the corresponding data silo"},auth:t({scopes:[Ke.ManageAssignedDataInventory],requiresSiloScope:!0}),fileGlobs:{kind:"parsed",parse:String,brief:"You can pass a glob syntax pattern(s) to specify additional file paths to scan. Comma-separated list of globs.",default:""},ignoreDirs:{kind:"parsed",parse:String,brief:"Comma-separated list of directories to ignore.",default:""},transcendUrl:r()}},docs:{brief:"Scan dependency management files to discover new data silos.",fullDescription:`We support scanning for new data silos in JavaScript, Python, Gradle, and CocoaPods projects.
|
|
22
22
|
|
|
23
|
-
To get started, add a data silo for the corresponding project type with the "silo discovery" plugin enabled. For example, if you want to scan a JavaScript project, add a package.json data silo. Then, specify the data silo ID in the "--dataSiloId" parameter.`}});import{buildCommand as
|
|
23
|
+
To get started, add a data silo for the corresponding project type with the "silo discovery" plugin enabled. For example, if you want to scan a JavaScript project, add a package.json data silo. Then, specify the data silo ID in the "--dataSiloId" parameter.`}});import{buildCommand as ze}from"@stricli/core";import{DataCategoryType as Je,ScopeName as $e}from"@transcend-io/privacy-types";var x=ze({loader:async()=>{let{pullDatapoints:e}=await import("./impl-YFDEKBXT.js");return e},parameters:{flags:{auth:t({scopes:[$e.ViewDataInventory]}),file:{kind:"parsed",parse:String,brief:"The file to save datapoints to",default:"./datapoints.csv"},transcendUrl:r(),dataSiloIds:{kind:"parsed",parse:String,variadic:",",brief:"List of data silo IDs to filter by",optional:!0},includeAttributes:{kind:"boolean",brief:"Whether to include attributes in the output",default:!1},includeGuessedCategories:{kind:"boolean",brief:"Whether to include guessed categories in the output",default:!1},parentCategories:{kind:"enum",values:Object.values(Je),brief:"List of parent categories to filter by",variadic:",",optional:!0},subCategories:{kind:"parsed",parse:String,brief:"List of subcategories to filter by",variadic:",",optional:!0}}},docs:{brief:"Export the datapoints from your Data Inventory into a CSV."}});import{buildCommand as Xe}from"@stricli/core";import{ScopeName as He,UnstructuredSubDataPointRecommendationStatus as Qe}from"@transcend-io/privacy-types";var M=Xe({loader:async()=>{let{pullUnstructuredDiscoveryFiles:e}=await import("./impl-YWNLYZI4.js");return e},parameters:{flags:{auth:t({scopes:[He.ViewDataInventory]}),file:{kind:"parsed",parse:String,brief:"The file to save datapoints to",default:"./unstructured-discovery-files.csv"},transcendUrl:r(),dataSiloIds:{kind:"parsed",parse:String,brief:"List of data silo IDs to filter by",variadic:",",optional:!0},subCategories:{kind:"parsed",parse:String,brief:"List of data categories to filter by",variadic:",",optional:!0},status:{kind:"enum",values:Object.values(Qe),brief:"List of classification statuses to filter by",variadic:",",optional:!0},includeEncryptedSnippets:{kind:"boolean",brief:"Whether to include encrypted snippets of the entries classified",default:!1}}},docs:{brief:"Pull unstructured discovery files",fullDescription:"This command allows for pulling Unstructured Discovery into a CSV."}});import{buildCommand as Ze,numberParser as et}from"@stricli/core";var O=Ze({loader:async()=>{let{push:e}=await import("./impl-C4HUZZJO.js");return e},parameters:{flags:{auth:t({scopes:"Varies"}),file:{kind:"parsed",parse:String,brief:"Path to the YAML file to push from",default:"./transcend.yml"},transcendUrl:r(),pageSize:{kind:"parsed",parse:et,brief:"The page size to use when paginating over the API",default:"50"},variables:{kind:"parsed",parse:String,brief:"The variables to template into the YAML file when pushing configuration. Comma-separated list of key:value pairs.",default:""},publishToPrivacyCenter:{kind:"boolean",brief:"When true, publish the configuration to the Privacy Center",default:!1},classifyService:{kind:"boolean",brief:"When true, automatically assign the service for a data flow based on the domain that is specified",default:!1},deleteExtraAttributeValues:{kind:"boolean",brief:"When true and syncing attributes, delete any extra attributes instead of just upserting",default:!1}}},docs:{brief:"Push metadata from transcend.yml to Transcend",fullDescription:"Given a transcend.yml file, sync the contents up to your Transcend instance."}});import{buildCommand as tt}from"@stricli/core";import{ScopeName as rt}from"@transcend-io/privacy-types";var N=tt({loader:async()=>{let{scanPackages:e}=await import("./impl-HCNN3NZK.js");return e},parameters:{flags:{auth:t({scopes:[rt.ManageCodeScanning]}),scanPath:{kind:"parsed",parse:String,brief:"File path in the project to scan",default:"./"},ignoreDirs:{kind:"parsed",parse:String,variadic:",",brief:"List of directories to ignore in scan",optional:!0},repositoryName:{kind:"parsed",parse:String,brief:"Name of the git repository that the package should be tied to",optional:!0},transcendUrl:r()}},docs:{brief:"Scan dependency management files to inventory code dependencies.",fullDescription:`Transcend scans packages and dependencies for the following frameworks:
|
|
24
24
|
|
|
25
25
|
- package.json
|
|
26
26
|
- requirements.txt & setup.py
|
|
@@ -36,20 +36,20 @@ This command will scan the folder you point at to look for any of these files. O
|
|
|
36
36
|
- repository name
|
|
37
37
|
- package names
|
|
38
38
|
- dependency names and versions
|
|
39
|
-
- package descriptions`}});import{buildCommand as
|
|
39
|
+
- package descriptions`}});import{buildCommand as at}from"@stricli/core";var j=at({loader:async()=>{let{consentManagerServiceJsonToYml:e}=await import("./impl-NYB4YSNU.js");return e},parameters:{flags:{file:{kind:"parsed",parse:String,brief:"Path to the services.json file, output of await airgap.getMetadata()",default:"./services.json"},output:{kind:"parsed",parse:String,brief:"Path to the output transcend.yml to write to",default:"./transcend.yml"}}},docs:{brief:"Convert consent manager services to transcend.yml",fullDescription:`Import the services from an airgap.js file into a Transcend instance.
|
|
40
40
|
|
|
41
41
|
Step 1) Run \`await airgap.getMetadata()\` on a site with airgap
|
|
42
42
|
Step 2) Right click on the printed object, and click \`Copy object\`
|
|
43
43
|
Step 3) Place output of file in a file named \`services.json\`
|
|
44
44
|
Step 4) Run \`${i} consent consent-manager-service-json-to-yml --file=./services.json --output=./transcend.yml\`
|
|
45
|
-
Step 5) Run \`${i} inventory push --auth=$TRANSCEND_API_KEY --file=./transcend.yml --classifyService=true\``}});import{buildCommand as
|
|
45
|
+
Step 5) Run \`${i} inventory push --auth=$TRANSCEND_API_KEY --file=./transcend.yml --classifyService=true\``}});import{buildCommand as ot}from"@stricli/core";var E=ot({loader:async()=>{let{consentManagersToBusinessEntities:e}=await import("./impl-XRYV4FW7.js");return e},parameters:{flags:{consentManagerYmlFolder:{kind:"parsed",parse:String,brief:"Path to the folder of Consent Manager transcend.yml files to combine"},output:{kind:"parsed",parse:String,brief:"Path to the output transcend.yml with business entity configuration",default:"./combined-business-entities.yml"}}},docs:{brief:"Convert consent managers to business entities",fullDescription:"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."}});var F=st({routes:{pull:k,push:O,"scan-packages":N,"discover-silos":V,"pull-datapoints":x,"pull-unstructured-discovery-files":M,"derive-data-silos-from-data-flows":U,"derive-data-silos-from-data-flows-cross-instance":I,"consent-manager-service-json-to-yml":j,"consent-managers-to-business-entities":E},docs:{brief:"Inventory commands"}});import{buildRouteMap as dt}from"@stricli/core";import{buildCommand as it}from"@stricli/core";import{ScopeName as nt}from"@transcend-io/privacy-types";var B=it({loader:async()=>{let{syncOt:e}=await import("./impl-OQUKAZLQ.js");return e},parameters:{flags:{hostname:{kind:"parsed",parse:String,brief:"The domain of the OneTrust environment from which to pull the resource",optional:!0},oneTrustAuth:{kind:"parsed",parse:String,brief:"The OAuth access token with the scopes necessary to access the OneTrust Public APIs",optional:!0},source:{kind:"enum",values:Object.values(f),brief:"Whether to read the assessments from OneTrust or from a file",default:"oneTrust"},transcendAuth:{...t({scopes:[nt.ManageAssessments]}),optional:!0},transcendUrl:r(),file:{kind:"parsed",parse:String,brief:"Path to the file to pull the resource into. Must be a json file!",optional:!0},resource:{kind:"enum",values:Object.values(m),brief:"The resource to pull from OneTrust. For now, only assessments is supported",default:"assessments"},dryRun:{kind:"boolean",brief:"Whether to export the resource to a file rather than sync to Transcend",default:!1},debug:{kind:"boolean",brief:"Whether to print detailed logs in case of error",default:!1}}},docs:{brief:"Sync OneTrust data",fullDescription:`Pulls resources from a OneTrust and syncs them to a Transcend instance. For now, it only supports retrieving OneTrust Assessments.
|
|
46
46
|
|
|
47
47
|
This command can be helpful if you are looking to:
|
|
48
48
|
- Pull resources from your OneTrust account.
|
|
49
49
|
- Migrate your resources from your OneTrust account to Transcend.
|
|
50
50
|
|
|
51
51
|
OneTrust authentication requires an OAuth Token with scope for accessing the assessment endpoints.
|
|
52
|
-
If syncing the resources to Transcend, you will also need to generate an API key on the Transcend Admin Dashboard.`}});var W=
|
|
52
|
+
If syncing the resources to Transcend, you will also need to generate an API key on the Transcend Admin Dashboard.`}});var W=dt({routes:{"sync-ot":B},docs:{brief:"Migration commands"}});import{buildRouteMap as mr}from"@stricli/core";import{buildCommand as lt,numberParser as ut}from"@stricli/core";import{RequestAction as pt,RequestOrigin as ct,ScopeName as l}from"@transcend-io/privacy-types";var L=lt({loader:async()=>{let{approve:e}=await import("./impl-PATZGQVZ.js");return e},parameters:{flags:{auth:t({scopes:[l.RequestApproval,l.ViewRequests,l.ManageRequestCompilation]}),actions:{kind:"enum",values:Object.values(pt),variadic:",",brief:"The request actions to approve"},origins:{kind:"enum",values:Object.values(ct),variadic:",",brief:"The request origins to approve",optional:!0},silentModeBefore:{kind:"parsed",parse:a,brief:"Any requests made before this date should be marked as silent mode",optional:!0},createdAtBefore:{kind:"parsed",parse:a,brief:"Approve requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Approve requests that were submitted after this time",optional:!0},transcendUrl:r(),concurrency:{kind:"parsed",parse:ut,brief:"The concurrency to use when uploading requests in parallel",default:"50"}}},docs:{brief:"Bulk approve a set of privacy requests",fullDescription:"Bulk approve a set of privacy requests from the DSR Automation -> Incoming Requests tab."}});import{buildCommand as mt,numberParser as ft}from"@stricli/core";import{RequestAction as ht,RequestStatus as bt,ScopeName as Y}from"@transcend-io/privacy-types";var _=mt({loader:async()=>{let{cancel:e}=await import("./impl-2CT4WQB5.js");return e},parameters:{flags:{auth:t({scopes:[Y.ViewRequests,Y.RequestApproval]}),actions:{kind:"enum",values:Object.values(ht),variadic:",",brief:"The request actions to cancel"},statuses:{kind:"enum",values:Object.values(bt),variadic:",",brief:"The request statuses to cancel. Comma-separated list.",optional:!0},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to cancel",optional:!0},silentModeBefore:{kind:"parsed",parse:a,brief:"Any requests made before this date should be marked as silent mode for canceling to skip email sending",optional:!0},createdAtBefore:{kind:"parsed",parse:a,brief:"Cancel requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Cancel requests that were submitted after this time",optional:!0},cancellationTitle:{kind:"parsed",parse:String,brief:"The title of the email template that should be sent to the requests upon cancelation",default:"Request Canceled"},transcendUrl:r(),concurrency:{kind:"parsed",parse:ft,brief:"The concurrency to use when uploading requests in parallel",default:"50"}}},docs:{brief:"Bulk cancel a set of privacy requests",fullDescription:"Bulk cancel a set of privacy requests from the DSR Automation -> Incoming Requests tab."}});import{buildRouteMap as vt}from"@stricli/core";import{buildCommand as gt}from"@stricli/core";var G=gt({loader:async()=>{let{markIdentifiersCompleted:e}=await import("./impl-ZBLHGXKD.js");return e},parameters:{flags:{auth:t({scopes:[],requiresSiloScope:!0}),dataSiloId:{kind:"parsed",parse:s,brief:"The ID of the data silo to pull in"},file:{kind:"parsed",parse:String,brief:"Path to the CSV file where identifiers will be written to",default:"./cron-identifiers.csv"},transcendUrl:r(),sombraAuth:o()}},docs:{brief:"Mark identifiers as completed after processing.",fullDescription:`This command takes the output of "${i} request cron pull-identifiers" and notifies Transcend that all of the requests in the CSV have been processed.
|
|
53
53
|
This is used in the workflow like:
|
|
54
54
|
|
|
55
55
|
1. Pull identifiers to CSV:
|
|
@@ -58,14 +58,18 @@ This is used in the workflow like:
|
|
|
58
58
|
3. Notify Transcend of completion
|
|
59
59
|
${i} request cron mark-identifiers-completed --auth=$TRANSCEND_API_KEY --dataSiloId=70810f2e-cf90-43f6-9776-901a5950599f --file=./outstanding-requests.csv
|
|
60
60
|
|
|
61
|
-
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.`}});import{buildCommand as
|
|
61
|
+
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.`}});import{buildCommand as kt,numberParser as K}from"@stricli/core";import{RequestAction as yt}from"@transcend-io/privacy-types";var z=kt({loader:async()=>{let{pullIdentifiers:e}=await import("./impl-LEZFRF7Y.js");return e},parameters:{flags:{auth:t({scopes:[],requiresSiloScope:!0}),dataSiloId:{kind:"parsed",parse:s,brief:"The ID of the data silo to pull in"},actions:{kind:"enum",values:Object.values(yt),variadic:",",brief:"The request actions to restart"},file:{kind:"parsed",parse:String,brief:"Path to the CSV file where identifiers will be written to",default:"./cron-identifiers.csv"},transcendUrl:r(),sombraAuth:o(),pageLimit:{kind:"parsed",parse:K,brief:"The page limit to use when pulling in pages of identifiers",default:"100"},skipRequestCount:{kind:"boolean",brief:"Whether to skip the count of all outstanding requests. This is required to render the progress bar, but can take a long time to run if you have a large number of outstanding requests to process. In that case, we recommend setting skipRequestCount=true so that you can still proceed with fetching the identifiers",default:!1},chunkSize:{kind:"parsed",parse:K,brief:"Maximum number of rows per CSV file. For large datasets, the output will be automatically split into multiple files to avoid file system size limits. Each file will contain at most this many rows",default:"10000"}}},docs:{brief:"Pull identifiers of outstanding requests for a data silo to a CSV.",fullDescription:`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.
|
|
62
62
|
|
|
63
63
|
For large datasets, the output will be automatically split into multiple CSV files to avoid file system size limits. Use the --chunkSize parameter to control the maximum number of rows per file.
|
|
64
64
|
|
|
65
|
-
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.`}});
|
|
65
|
+
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.`}});import{buildCommand as St,numberParser as J}from"@stricli/core";import{RequestAction as wt}from"@transcend-io/privacy-types";var $=St({loader:async()=>{let{pullProfiles:e}=await import("./impl-LJLXQ3QL.js");return e},parameters:{flags:{auth:t({scopes:[],requiresSiloScope:!0}),cronDataSiloId:{kind:"parsed",parse:s,brief:"The ID of the cron data silo to pull in"},targetDataSiloId:{kind:"parsed",parse:s,brief:"The ID of the target data silo to pull in"},actions:{kind:"enum",values:Object.values(wt),variadic:",",brief:"The request actions to restart"},file:{kind:"parsed",parse:String,brief:"Path to the CSV file where identifiers will be written to",default:"./cron-identifiers.csv"},fileTarget:{kind:"parsed",parse:String,brief:"Path to the CSV file where identifiers will be written to",default:"./cron-identifiers-target.csv"},transcendUrl:r(),sombraAuth:o(),pageLimit:{kind:"parsed",parse:J,brief:"The page limit to use when pulling in pages of identifiers",default:"100"},skipRequestCount:{kind:"boolean",brief:"Whether to skip the count of all outstanding requests. This is required to render the progress bar, but can take a long time to run if you have a large number of outstanding requests to process. In that case, we recommend setting skipRequestCount=true so that you can still proceed with fetching the identifiers",default:!1},chunkSize:{kind:"parsed",parse:J,brief:"Maximum number of rows per CSV file. For large datasets, the output will be automatically split into multiple files to avoid file system size limits. Each file will contain at most this many rows",default:"10000"}}},docs:{brief:"Pull profiles of outstanding requests for a data silo to a CSV.",fullDescription:`If you are using the cron job integration, you can run this command to pull the outstanding profiles for the data silo to a CSV.
|
|
66
|
+
|
|
67
|
+
For large datasets, the output will be automatically split into multiple CSV files to avoid file system size limits. Use the --chunkSize parameter to control the maximum number of rows per file.
|
|
68
|
+
|
|
69
|
+
Read more at https://docs.transcend.io/docs/integrations/cron-job-integration.`}});var X=vt({routes:{"pull-identifiers":z,"pull-profiles":$,"mark-identifiers-completed":G},docs:{brief:"Cron commands"}});import{buildCommand as Ct,numberParser as Tt}from"@stricli/core";import{RequestStatus as qt,ScopeName as u}from"@transcend-io/privacy-types";var H=Ct({loader:async()=>{let{downloadFiles:e}=await import("./impl-IME3ONWF.js");return e},parameters:{flags:{auth:t({scopes:[u.ViewRequestCompilation,u.ViewRequests,u.RequestApproval]}),sombraAuth:o(),concurrency:{kind:"parsed",parse:Tt,brief:"The concurrency to use when downloading requests in parallel",default:"10"},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to download",optional:!0},statuses:{kind:"enum",values:Object.values(qt),variadic:",",brief:"The request statuses to download. Comma-separated list. Defaults to APPROVING,DOWNLOADABLE.",optional:!0},folderPath:{kind:"parsed",parse:String,brief:"The folder to download files to",default:"./dsr-files"},createdAtBefore:{kind:"parsed",parse:a,brief:"Download requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Download requests that were submitted after this time",optional:!0},approveAfterDownload:{kind:"boolean",brief:"If the request is in status=APPROVING, approve the request after its downloaded",default:!1},transcendUrl:r()}},docs:{brief:"Download the files associated with a Data Subject Access Request (DSAR)",fullDescription:"Download the files associated with a Data Subject Access Request (DSAR) from DSR Automation -> Incoming Requests tab."}});import{buildCommand as Pt,numberParser as At}from"@stricli/core";import{RequestAction as Dt,RequestEnricherStatus as Rt,ScopeName as It}from"@transcend-io/privacy-types";var Q=Pt({loader:async()=>{let{enricherRestart:e}=await import("./impl-2AQG2DEN.js");return e},parameters:{flags:{auth:t({scopes:[It.ManageRequestCompilation]}),enricherId:{kind:"parsed",parse:String,brief:"The ID of the enricher to restart"},actions:{kind:"enum",values:Object.values(Dt),variadic:",",brief:"The request action to restart",optional:!0},requestEnricherStatuses:{kind:"enum",values:Object.values(Rt),variadic:",",brief:"The request enricher statuses to restart",optional:!0},transcendUrl:r(),concurrency:{kind:"parsed",parse:At,brief:"The concurrency to use when uploading requests in parallel",default:"15"},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to restart",optional:!0},createdAtBefore:{kind:"parsed",parse:a,brief:"Restart requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Restart requests that were submitted after this time",optional:!0}}},docs:{brief:"Bulk restart a particular enricher across a series of DSRs",fullDescription:`Bulk restart a particular enricher across a series of DSRs.
|
|
66
70
|
|
|
67
71
|
The API key needs the following scopes:
|
|
68
|
-
- Manage Request Compilation`}});import{buildCommand as
|
|
72
|
+
- Manage Request Compilation`}});import{buildCommand as Ut,numberParser as Z}from"@stricli/core";import{RequestAction as Vt,RequestStatus as xt,ScopeName as ee}from"@transcend-io/privacy-types";var te=Ut({loader:async()=>{let{_export:e}=await import("./impl-L3UJQJZ6.js");return e},parameters:{flags:{auth:t({scopes:[ee.ViewRequests,ee.ViewRequestCompilation]}),sombraAuth:o(),actions:{kind:"enum",values:Object.values(Vt),variadic:",",brief:"The request actions to export",optional:!0},statuses:{kind:"enum",values:Object.values(xt),variadic:",",brief:"The request statuses to export",optional:!0},transcendUrl:r(),file:{kind:"parsed",parse:String,brief:"Path to the CSV file where identifiers will be written to",default:"./transcend-request-export.csv"},concurrency:{kind:"parsed",parse:Z,brief:"The concurrency to use when uploading requests in parallel",default:"100"},createdAtBefore:{kind:"parsed",parse:a,brief:"Pull requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Pull requests that were submitted after this time",optional:!0},showTests:{kind:"boolean",brief:"Filter for test requests or production requests - when not provided, pulls both",optional:!0},pageLimit:{kind:"parsed",parse:Z,brief:"The page limit to use when pulling in pages of requests",default:"100"}}},docs:{brief:"Export privacy requests and request identifiers to a CSV file",fullDescription:"Export privacy requests and request identifiers to a CSV file."}});import{buildCommand as Mt,numberParser as Ot}from"@stricli/core";import{RequestAction as Nt,RequestStatus as jt,ScopeName as Et}from"@transcend-io/privacy-types";var re=Mt({loader:async()=>{let{markSilent:e}=await import("./impl-75Y3OM5Z.js");return e},parameters:{flags:{auth:t({scopes:[Et.ManageRequestCompilation]}),actions:{kind:"enum",values:Object.values(Nt),variadic:",",brief:"The request actions to mark silent"},statuses:{kind:"enum",values:Object.values(jt),variadic:",",brief:"The request statuses to mark silent. Comma-separated list. Defaults to REQUEST_MADE,WAITING,ENRICHING,COMPILING,DELAYED,APPROVING,SECONDARY,SECONDARY_APPROVING.",optional:!0},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to mark silent",optional:!0},createdAtBefore:{kind:"parsed",parse:a,brief:"Mark silent requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Mark silent requests that were submitted after this time",optional:!0},transcendUrl:r(),concurrency:{kind:"parsed",parse:Ot,brief:"The concurrency to use when uploading requests in parallel",default:"50"}}},docs:{brief:"Bulk update a set of privacy requests to be in silent mode",fullDescription:"Bulk update a set of privacy requests from the DSR Automation -> Incoming Requests tab to be in silent mode."}});import{buildCommand as Ft,numberParser as p}from"@stricli/core";import{RequestAction as Bt,ScopeName as ae}from"@transcend-io/privacy-types";var oe=Ft({loader:async()=>{let{notifyAdditionalTime:e}=await import("./impl-NKKIQKJ6.js");return e},parameters:{flags:{auth:t({scopes:[ae.ViewRequests,ae.RequestApproval]}),createdAtBefore:{kind:"parsed",parse:a,brief:"Notify requests that are open but submitted before this time"},createdAtAfter:{kind:"parsed",parse:a,brief:"Notify requests that are open but submitted after this time",optional:!0},actions:{kind:"enum",values:Object.values(Bt),variadic:",",brief:"The request actions to notify",optional:!0},daysLeft:{kind:"parsed",parse:p,brief:"Only notify requests that have less than this number of days until they are considered expired",default:"10"},days:{kind:"parsed",parse:p,brief:"The number of days to adjust the expiration of the request to",default:"45"},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to notify",optional:!0},emailTemplate:{kind:"parsed",parse:String,brief:"The title of the email template that should be sent to the requests",default:"Additional Time Needed"},transcendUrl:r(),concurrency:{kind:"parsed",parse:p,brief:"The concurrency to use when uploading requests in parallel",default:"50"}}},docs:{brief:"Bulk notify a set of privacy requests that more time is needed",fullDescription:"Bulk notify a set of privacy requests from the DSR Automation -> Incoming Requests tab that more time is needed to complete the request. Note any request in silent mode will not be emailed."}});import{buildRouteMap as Kt}from"@stricli/core";import{buildCommand as Wt,numberParser as Lt}from"@stricli/core";import{RequestAction as Yt,ScopeName as se}from"@transcend-io/privacy-types";var ie=Wt({loader:async()=>{let{pullIdentifiers:e}=await import("./impl-S5PLONJN.js");return e},parameters:{flags:{auth:t({scopes:[se.ViewRequests,se.ViewRequestCompilation]}),sombraAuth:o(),transcendUrl:r(),file:{kind:"parsed",parse:String,brief:"Path to the CSV file where requests will be written to",default:"./manual-enrichment-identifiers.csv"},actions:{kind:"enum",values:Object.values(Yt),variadic:",",brief:"The request actions to pull for",optional:!0},concurrency:{kind:"parsed",parse:Lt,brief:"The concurrency to use when uploading requests in parallel",default:"100"}}},docs:{brief:"Pull identifiers for manual enrichment",fullDescription:`This command pulls down the set of privacy requests that are currently pending manual enrichment.
|
|
69
73
|
|
|
70
74
|
This is useful for the following workflow:
|
|
71
75
|
|
|
@@ -73,7 +77,7 @@ This is useful for the following workflow:
|
|
|
73
77
|
${i} request preflight pull-identifiers --file=./enrichment-requests.csv
|
|
74
78
|
2. Fill out the CSV with additional identifiers
|
|
75
79
|
3. Push updated back to Transcend
|
|
76
|
-
${i} request preflight push-identifiers --file=./enrichment-requests.csv`}});import{buildCommand as
|
|
80
|
+
${i} request preflight push-identifiers --file=./enrichment-requests.csv`}});import{buildCommand as _t,numberParser as Gt}from"@stricli/core";import{ScopeName as ne}from"@transcend-io/privacy-types";var de=_t({loader:async()=>{let{pushIdentifiers:e}=await import("./impl-X6FJHMP5.js");return e},parameters:{flags:{auth:t({scopes:[ne.ManageRequestIdentities,ne.ManageRequestCompilation]}),enricherId:{kind:"parsed",parse:s,brief:"The ID of the Request Enricher to upload to"},sombraAuth:o(),transcendUrl:r(),file:{kind:"parsed",parse:String,brief:"Path to the CSV file where requests will be written to",default:"./manual-enrichment-identifiers.csv"},markSilent:{kind:"boolean",brief:"When true, set requests into silent mode before enriching",default:!1},concurrency:{kind:"parsed",parse:Gt,brief:"The concurrency to use when uploading requests in parallel",default:"100"}}},docs:{brief:"Push identifiers for manual enrichment",fullDescription:`This command push up a set of identifiers for a set of requests pending manual enrichment.
|
|
77
81
|
|
|
78
82
|
This is useful for the following workflow:
|
|
79
83
|
|
|
@@ -81,9 +85,9 @@ This is useful for the following workflow:
|
|
|
81
85
|
${i} request preflight pull-identifiers --file=./enrichment-requests.csv
|
|
82
86
|
2. Fill out the CSV with additional identifiers
|
|
83
87
|
3. Push updated back to Transcend
|
|
84
|
-
${i} request preflight push-identifiers --file=./enrichment-requests.csv`}});var
|
|
85
|
-
This command is useful with the "Bulk Response" UI. The CSV is expected to have 1 column named "Request Id".`}});import{buildCommand as
|
|
88
|
+
${i} request preflight push-identifiers --file=./enrichment-requests.csv`}});var le=Kt({routes:{"pull-identifiers":ie,"push-identifiers":de},docs:{brief:"Preflight commands"}});import{buildCommand as zt}from"@stricli/core";import{RequestAction as Jt,ScopeName as $t}from"@transcend-io/privacy-types";var ue=zt({loader:async()=>{let{rejectUnverifiedIdentifiers:e}=await import("./impl-DHTPY5AB.js");return e},parameters:{flags:{auth:t({scopes:[$t.ManageRequestCompilation]}),identifierNames:{kind:"parsed",parse:String,variadic:",",brief:"The names of identifiers to clear out"},actions:{kind:"enum",values:Object.values(Jt),variadic:",",brief:"The request action to restart",optional:!0},transcendUrl:r()}},docs:{brief:"Bulk clear out any request identifiers that are unverified",fullDescription:"Bulk clear out any request identifiers that are unverified."}});import{buildCommand as Xt,numberParser as Ht}from"@stricli/core";import{RequestAction as Qt,RequestStatus as Zt,ScopeName as pe}from"@transcend-io/privacy-types";var ce=Xt({loader:async()=>{let{restart:e}=await import("./impl-T4ODLBML.js");return e},parameters:{flags:{auth:t({scopes:[pe.MakeDataSubjectRequest,pe.ViewRequestCompilation]}),actions:{kind:"enum",values:Object.values(Qt),variadic:",",brief:"The request actions to restart"},statuses:{kind:"enum",values:Object.values(Zt),variadic:",",brief:"The request statuses to restart"},transcendUrl:r(),requestReceiptFolder:{kind:"parsed",parse:String,brief:"The path to the folder where receipts of each upload are stored",default:"./privacy-request-upload-receipts"},sombraAuth:o(),concurrency:{kind:"parsed",parse:Ht,brief:"The concurrency to use when uploading requests in parallel",default:"15"},requestIds:{kind:"parsed",parse:String,variadic:",",brief:"Specify the specific request IDs to restart",optional:!0},emailIsVerified:{kind:"boolean",brief:"Indicate whether the primary email address is verified. Set to false to send a verification email",default:!0},createdAt:{kind:"parsed",parse:a,brief:"Restart requests that were submitted before a specific date",optional:!0},silentModeBefore:{kind:"parsed",parse:a,brief:"Requests older than this date should be marked as silent mode",optional:!0},createdAtBefore:{kind:"parsed",parse:a,brief:"Restart requests that were submitted before this time",optional:!0},createdAtAfter:{kind:"parsed",parse:a,brief:"Restart requests that were submitted after this time",optional:!0},sendEmailReceipt:{kind:"boolean",brief:"Send email receipts to the restarted requests",default:!1},copyIdentifiers:{kind:"boolean",brief:"Copy over all enriched identifiers from the initial request",default:!1},skipWaitingPeriod:{kind:"boolean",brief:"Skip queued state of request and go straight to compiling",default:!1}}},docs:{brief:"Bulk update a set of privacy requests based on a set of request filters",fullDescription:"Bulk update a set of privacy requests based on a set of request filters."}});import{buildCommand as er}from"@stricli/core";import{ScopeName as tr}from"@transcend-io/privacy-types";var me=er({loader:async()=>{let{skipPreflightJobs:e}=await import("./impl-MZ6D4BQ3.js");return e},parameters:{flags:{auth:t({scopes:[tr.ManageRequestCompilation]}),enricherIds:{kind:"parsed",parse:String,variadic:",",brief:"The ID of the enrichers to skip privacy request jobs for"},transcendUrl:r()}},docs:{brief:"Skip preflight jobs",fullDescription:"This command allows for bulk skipping preflight checks."}});import{buildRouteMap as ur}from"@stricli/core";import{buildCommand as rr}from"@stricli/core";import{ScopeName as ar}from"@transcend-io/privacy-types";var fe=rr({loader:async()=>{let{markRequestDataSilosCompleted:e}=await import("./impl-H57BW5MO.js");return e},parameters:{flags:{auth:t({scopes:[ar.ManageRequestCompilation]}),dataSiloId:{kind:"parsed",parse:s,brief:"The ID of the data silo to pull in"},file:{kind:"parsed",parse:String,brief:'Path to the CSV file where identifiers will be written to. The CSV is expected to have 1 column named "Request Id".',default:"./request-identifiers.csv"},transcendUrl:r()}},docs:{brief:"Mark request data silos as completed",fullDescription:`This command takes in a CSV of Request IDs as well as a Data Silo ID and marks all associated privacy request jobs as completed.
|
|
89
|
+
This command is useful with the "Bulk Response" UI. The CSV is expected to have 1 column named "Request Id".`}});import{buildCommand as or}from"@stricli/core";import{RequestAction as sr,ScopeName as ir}from"@transcend-io/privacy-types";var he=or({loader:async()=>{let{retryRequestDataSilos:e}=await import("./impl-QD62F5PJ.js");return e},parameters:{flags:{auth:t({scopes:[ir.ManageRequestCompilation]}),dataSiloId:{kind:"parsed",parse:s,brief:"The ID of the data silo to pull in"},actions:{kind:"enum",values:Object.values(sr),variadic:",",brief:"The request actions to restart"},transcendUrl:r()}},docs:{brief:"Retry request data silos",fullDescription:'This command allows for bulk restarting a set of data silos jobs for open privacy requests. This is equivalent to clicking the "Wipe and Retry" button for a particular data silo across a set of privacy requests.'}});import{buildCommand as nr}from"@stricli/core";import{RequestStatus as dr,ScopeName as lr}from"@transcend-io/privacy-types";var be=nr({loader:async()=>{let{skipRequestDataSilos:e}=await import("./impl-P63ATAHR.js");return e},parameters:{flags:{auth:t({scopes:[lr.ManageRequestCompilation]}),dataSiloId:{kind:"parsed",parse:s,brief:"The ID of the data silo to skip privacy request jobs for"},transcendUrl:r(),statuses:{kind:"enum",values:Object.values(dr),variadic:",",brief:"The request statuses to skip"},status:{kind:"enum",values:["SKIPPED","RESOLVED"],brief:"The status to set the request data silo job to",default:"SKIPPED"}}},docs:{brief:"Skip request data silos",fullDescription:"This command allows for bulk skipping all open privacy request jobs for a particular data silo. This command is useful if you want to disable a data silo and then clear out any active privacy requests that are still queued up for that data silo."}});var ge=ur({routes:{"mark-request-data-silos-completed":fe,"retry-request-data-silos":he,"skip-request-data-silos":be},docs:{brief:"System commands"}});import{buildCommand as pr,numberParser as cr}from"@stricli/core";import{ScopeName as c}from"@transcend-io/privacy-types";var ke=pr({loader:async()=>{let{upload:e}=await import("./impl-LC3UNIDE.js");return e},parameters:{flags:{auth:t({scopes:[c.MakeDataSubjectRequest,c.ViewRequestIdentitySettings,c.ViewGlobalAttributes]}),file:{kind:"parsed",parse:String,brief:"Path to the CSV file of requests to upload",default:"./requests.csv"},transcendUrl:r(),cacheFilepath:{kind:"parsed",parse:String,brief:"The path to the JSON file encoding the metadata used to map the CSV shape to Transcend API",default:"./transcend-privacy-requests-cache.json"},requestReceiptFolder:{kind:"parsed",parse:String,brief:"The path to the folder where receipts of each upload are stored",default:"./privacy-request-upload-receipts"},sombraAuth:o(),concurrency:{kind:"parsed",parse:cr,brief:"The concurrency to use when uploading requests in parallel",default:"50"},attributes:{kind:"parsed",parse:String,brief:"Tag all of the requests with the following attributes. Format: key1:value1;value2,key2:value3;value4",default:"Tags:transcend-cli"},isTest:{kind:"boolean",brief:"Flag whether the requests being uploaded are test requests or regular requests",default:!1},isSilent:{kind:"boolean",brief:"Flag whether the requests being uploaded should be submitted in silent mode",default:!0},skipSendingReceipt:{kind:"boolean",brief:"Flag whether to skip sending of the receipt email",default:!1},emailIsVerified:{kind:"boolean",brief:"Indicate whether the email address being uploaded is pre-verified. Set to false to send a verification email",default:!0},skipFilterStep:{kind:"boolean",brief:"When true, skip the interactive step to filter down the CSV",default:!1},dryRun:{kind:"boolean",brief:"When true, perform a dry run of the upload instead of calling the API to submit the requests",default:!1},debug:{kind:"boolean",brief:"Debug logging",default:!1},defaultPhoneCountryCode:{kind:"parsed",parse:String,brief:"When uploading phone numbers, if the phone number is missing a country code, assume this country code",default:"1"}}},docs:{brief:"Upload a set of requests from a CSV",fullDescription:`Upload a set of requests from a CSV.
|
|
86
90
|
|
|
87
91
|
This command prompts you 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.
|
|
88
92
|
|
|
89
|
-
The script will also produce a JSON cache file that allows for the mappings to be preserved between runs.`}});var
|
|
93
|
+
The script will also produce a JSON cache file that allows for the mappings to be preserved between runs.`}});var ye=mr({routes:{approve:L,upload:ke,"download-files":H,cancel:_,restart:ce,"notify-additional-time":oe,"mark-silent":re,"enricher-restart":Q,"reject-unverified-identifiers":ue,export:te,"skip-preflight-jobs":me,system:ge,preflight:le,cron:X},docs:{brief:"All commands related to DSR requests"}});var kr=gr({routes:{request:ye,consent:R,inventory:F,admin:S,migration:W,install:fr("@transcend-io/transcend",{bash:"__@transcend-io/cli_bash_complete"}),uninstall:hr("@transcend-io/transcend",{bash:!0})},docs:{brief:h,hideRoute:{install:!0,uninstall:!0}}}),Ei=br(kr,{name:i,versionInfo:{currentVersion:b}});export{Ei as a};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{c as _}from"./chunk-RBOBI6B6.js";import{n as A,q as x}from"./chunk-
|
|
1
|
+
import{c as _}from"./chunk-RBOBI6B6.js";import{n as A,q as x}from"./chunk-SVDDU4R6.js";import{Ae as O,Be as D,_ as T,_b as j,b as R,pe as y,qe as E,ye as L}from"./chunk-MBAKYLJ3.js";import{a as r}from"./chunk-OERYFLN2.js";import{e as b}from"./chunk-APA5PR4U.js";import{RequestStatus as U}from"@transcend-io/privacy-types";import k from"colors";import{groupBy as G,uniq as Q}from"lodash-es";async function te({file:u,auth:s,sombraAuth:g,requestActions:f=[],concurrency:p=100,transcendUrl:n=b}){let o=y(n,s),e=await E(n,s,g);r.info(k.magenta(`Pulling manual enrichment requests, filtered for actions: ${f.join(",")}`));let d=await L(o,{actions:f,statuses:[U.Enriching]}),i=[];await R(d,async t=>{let c=await D(o,{requestId:t.id});if(c.filter(({status:m})=>m==="ACTION_REQUIRED")){let m=await O(o,e,{requestId:t.id});i.push({...t,requestIdentifiers:m,requestEnrichers:c})}},{concurrency:p});let l=i.map(({attributeValues:t,requestIdentifiers:c,requestEnrichers:I,...m})=>({...m,...Object.entries(G(c,"name")).reduce((w,[P,$])=>Object.assign(w,{[P]:$.map(({value:C})=>C).join(",")}),{}),...Object.entries(G(t,"attributeKey.name")).reduce((w,[P,$])=>Object.assign(w,{[P]:$.map(({name:C})=>C).join(",")}),{})})),a=Q(l.map(t=>Object.keys(t)).flat());return _(u,l,a),r.info(k.green(`Successfully wrote ${i.length} requests to file "${u}"`)),i}import*as q from"io-ts";import{uniq as F}from"lodash-es";import v from"colors";var S="https://app.transcend.io/privacy-requests/incoming-requests/",M=q.record(q.string,q.string);async function N(u,{id:s,...g},f,p){if(!s){let e=`Request ID must be provided to enricher request.${p?` Found error in row: ${p}`:""}`;throw r.error(v.red(e)),new Error(e)}let n=s.toLowerCase(),o=Object.entries(g).reduce((e,[d,i])=>F(A(i)).length===0?e:Object.assign(e,{[d]:F(A(i)).map(a=>({value:d==="email"?a.toLowerCase():a}))}),{});try{return await u.post("v1/enrich-identifiers",{headers:{"x-transcend-request-id":n,"x-transcend-enricher-id":f},json:{enrichedIdentifiers:o}}).json(),r.error(v.green(`Successfully enriched request: ${S}${n}`)),!0}catch(e){if(typeof e.response.body=="string"&&e.response.body.includes("Cannot update a resolved RequestEnricher"))return r.warn(v.magenta(`Skipped enrichment for request: ${S}${n}, request is no longer in the enriching phase.`)),!1;throw r.error(v.red(`Failed to enricher identifiers for request with id: ${S}${n} - ${e.message} - ${e.response.body}`)),e}}import h from"colors";async function ge({file:u,auth:s,sombraAuth:g,enricherId:f,markSilent:p,concurrency:n=100,transcendUrl:o=b}){let e=await E(o,s,g),d=y(o,s);r.info(h.magenta(`Reading "${u}" from disk`));let i=x(u,M);r.info(h.magenta(`Enriching "${i.length}" privacy requests.`));let l=0,a=0,t=0;if(await R(i,async(c,I)=>{try{p&&(await j(d,T,{input:{id:c.id,isSilent:!0}}),r.info(h.magenta(`Mark request as silent mode - ${c.id}`))),await N(e,c,f,I)?l+=1:a+=1}catch{t+=1}},{concurrency:n}),r.info(h.green(`Successfully notified Transcend!
|
|
2
2
|
Success count: ${l}.`)),a>0&&r.info(h.magenta(`Skipped count: ${a}.`)),t>0)throw r.info(h.red(`Error Count: ${t}.`)),new Error(`Failed to enrich: ${t} requests.`);return i.length}export{te as a,M as b,N as c,ge as d};
|