@pdfbutler/migration-cli 0.0.26 → 0.0.28

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.
Files changed (51) hide show
  1. package/README.md +193 -30
  2. package/lib/commands/butler/pb/admincredentials.d.ts +0 -5
  3. package/lib/commands/butler/pb/admincredentials.js +46 -115
  4. package/lib/commands/butler/pb/admincredentials.js.map +1 -1
  5. package/lib/commands/butler/pb/adminsettings.d.ts +1 -7
  6. package/lib/commands/butler/pb/adminsettings.js +41 -110
  7. package/lib/commands/butler/pb/adminsettings.js.map +1 -1
  8. package/lib/commands/butler/pb/export.d.ts +10 -8
  9. package/lib/commands/butler/pb/export.js +302 -312
  10. package/lib/commands/butler/pb/export.js.map +1 -1
  11. package/lib/commands/butler/pb/exportdatasource.d.ts +27 -0
  12. package/lib/commands/butler/pb/exportdatasource.js +161 -0
  13. package/lib/commands/butler/pb/exportdatasource.js.map +1 -0
  14. package/lib/commands/butler/pb/exportpack.d.ts +0 -5
  15. package/lib/commands/butler/pb/exportpack.js +60 -142
  16. package/lib/commands/butler/pb/exportpack.js.map +1 -1
  17. package/lib/commands/butler/pb/import.d.ts +16 -9
  18. package/lib/commands/butler/pb/import.js +400 -267
  19. package/lib/commands/butler/pb/import.js.map +1 -1
  20. package/lib/commands/butler/pb/importdatasource.d.ts +30 -0
  21. package/lib/commands/butler/pb/importdatasource.js +250 -0
  22. package/lib/commands/butler/pb/importdatasource.js.map +1 -0
  23. package/lib/commands/butler/pb/importpack.d.ts +0 -5
  24. package/lib/commands/butler/pb/importpack.js +57 -138
  25. package/lib/commands/butler/pb/importpack.js.map +1 -1
  26. package/lib/commands/butler/sb/export/signtemplate.d.ts +23 -0
  27. package/lib/commands/butler/sb/export/signtemplate.js +111 -0
  28. package/lib/commands/butler/sb/export/signtemplate.js.map +1 -0
  29. package/lib/commands/butler/sb/import/signtemplate.d.ts +23 -0
  30. package/lib/commands/butler/sb/import/signtemplate.js +108 -0
  31. package/lib/commands/butler/sb/import/signtemplate.js.map +1 -0
  32. package/lib/utils/authentication.d.ts +4 -0
  33. package/lib/utils/authentication.js +69 -0
  34. package/lib/utils/authentication.js.map +1 -0
  35. package/lib/utils/constants.d.ts +137 -0
  36. package/lib/utils/constants.js +141 -0
  37. package/lib/utils/constants.js.map +1 -0
  38. package/lib/utils/extract-templates.d.ts +1 -0
  39. package/lib/utils/extract-templates.js +89 -0
  40. package/lib/utils/extract-templates.js.map +1 -0
  41. package/lib/utils/logger.d.ts +9 -0
  42. package/lib/utils/logger.js +51 -0
  43. package/lib/utils/logger.js.map +1 -0
  44. package/messages/butler.pb.export.md +4 -0
  45. package/messages/butler.pb.exportdatasource.md +51 -0
  46. package/messages/butler.pb.import.md +4 -0
  47. package/messages/butler.pb.importdatasource.md +51 -0
  48. package/messages/butler.sb.export.signtemplate.md +35 -0
  49. package/messages/butler.sb.import.signtemplate.md +35 -0
  50. package/oclif.manifest.json +321 -48
  51. package/package.json +223 -215
@@ -0,0 +1,51 @@
1
+ # summary
2
+
3
+ Import PDF Butler DataSource records into your organization.
4
+
5
+ # description
6
+
7
+ Use this command to import DataSource records from JSON files exported by the DataSource export command.
8
+
9
+ # flags.target.summary
10
+
11
+ The Salesforce org username credentials to connect to the target org.
12
+
13
+ # flags.id.summary
14
+
15
+ The DataSource ID to import. For bulk import, enter multiple IDs separated by whitespaces.
16
+
17
+ # flags.parents.summary
18
+
19
+ Automatically resolve and import parent DataSources first, then child DataSources.
20
+
21
+ # flags.folder.summary
22
+
23
+ The folder that contains the exported DataSource JSON files.
24
+
25
+ # flags.auth-env-var.summary
26
+
27
+ PDF Butler credentials for backend authentication.
28
+
29
+ # flags.endpoint.summary
30
+
31
+ PDF Butler endpoint URL.
32
+
33
+ # flags.stage.summary
34
+
35
+ CADMUS stage for backend operations.
36
+
37
+ # flags.logs.summary
38
+
39
+ Enable detailed logs for the import process.
40
+
41
+ # flags.session.summary
42
+
43
+ Salesforce Session ID for authentication.
44
+
45
+ # flags.instance.summary
46
+
47
+ Salesforce Instance URL for authentication.
48
+
49
+ # examples
50
+
51
+ - <%= config.bin %> <%= command.id %> -t my-org -i "00Dak00000A4YWn_a0Bak00000MZcAb" -f "./export/ds"
@@ -0,0 +1,35 @@
1
+ # summary
2
+
3
+ Export Sign Request Template records from your organization.
4
+
5
+ # description
6
+
7
+ Use this command to export one or more Sign Request Templates and save them locally as JSON files.
8
+
9
+ # flags.target.summary
10
+
11
+ The Salesforce org username credentials to connect to the target org.
12
+
13
+ # flags.id.summary
14
+
15
+ The Customer Template ID to export. For bulk export, enter multiple IDs separated by whitespaces.
16
+
17
+ # flags.folder.summary
18
+
19
+ The output root folder path. Files will be saved to the signRequestTemplates subfolder.
20
+
21
+ # flags.logs.summary
22
+
23
+ Enable detailed logs for the export process.
24
+
25
+ # flags.session.summary
26
+
27
+ Salesforce Session ID for authentication.
28
+
29
+ # flags.instance.summary
30
+
31
+ Salesforce Instance URL for authentication.
32
+
33
+ # examples
34
+
35
+ - sf butler:sb:export:signtemplate -t my-org --id "a0Bxx0000000011 a0Bxx0000000012" -f "./export/sb"
@@ -0,0 +1,35 @@
1
+ # summary
2
+
3
+ Import Sign Request Template records into your organization.
4
+
5
+ # description
6
+
7
+ Use this command to import Sign Request Templates from JSON files previously exported by the export command.
8
+
9
+ # flags.target.summary
10
+
11
+ The Salesforce org username credentials to connect to the target org.
12
+
13
+ # flags.id.summary
14
+
15
+ The Customer Template ID to import. For bulk import, enter multiple IDs separated by whitespaces.
16
+
17
+ # flags.folder.summary
18
+
19
+ The export root folder path that contains the signRequestTemplates subfolder.
20
+
21
+ # flags.logs.summary
22
+
23
+ Enable detailed logs for the import process.
24
+
25
+ # flags.session.summary
26
+
27
+ Salesforce Session ID for authentication.
28
+
29
+ # flags.instance.summary
30
+
31
+ Salesforce Instance URL for authentication.
32
+
33
+ # examples
34
+
35
+ - sf butler:sb:import:signtemplate -t my-org --id "a0Bxx0000000011" -f "./export/sb"
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.0.26",
2
+ "version": "0.0.28",
3
3
  "commands": {
4
4
  "butler:pb:admincredentials": {
5
5
  "id": "butler:pb:admincredentials",
@@ -10,17 +10,11 @@
10
10
  "pluginAlias": "@pdfbutler/migration-cli",
11
11
  "pluginType": "core",
12
12
  "aliases": [],
13
+ "hiddenAliases": [],
13
14
  "examples": [
14
15
  "<%= config.bin %> <%= command.id %>"
15
16
  ],
16
17
  "flags": {
17
- "json": {
18
- "name": "json",
19
- "type": "boolean",
20
- "description": "Format output as json.",
21
- "helpGroup": "GLOBAL",
22
- "allowNo": false
23
- },
24
18
  "name": {
25
19
  "name": "name",
26
20
  "type": "option",
@@ -85,17 +79,11 @@
85
79
  "pluginAlias": "@pdfbutler/migration-cli",
86
80
  "pluginType": "core",
87
81
  "aliases": [],
82
+ "hiddenAliases": [],
88
83
  "examples": [
89
84
  "<%= config.bin %> <%= command.id %>"
90
85
  ],
91
86
  "flags": {
92
- "json": {
93
- "name": "json",
94
- "type": "boolean",
95
- "description": "Format output as json.",
96
- "helpGroup": "GLOBAL",
97
- "allowNo": false
98
- },
99
87
  "url": {
100
88
  "name": "url",
101
89
  "type": "option",
@@ -152,17 +140,11 @@
152
140
  "pluginAlias": "@pdfbutler/migration-cli",
153
141
  "pluginType": "core",
154
142
  "aliases": [],
143
+ "hiddenAliases": [],
155
144
  "examples": [
156
145
  "<%= config.bin %> <%= command.id %>"
157
146
  ],
158
147
  "flags": {
159
- "json": {
160
- "name": "json",
161
- "type": "boolean",
162
- "description": "Format output as json.",
163
- "helpGroup": "GLOBAL",
164
- "allowNo": false
165
- },
166
148
  "name": {
167
149
  "name": "name",
168
150
  "type": "option",
@@ -270,6 +252,103 @@
270
252
  "type": "boolean",
271
253
  "summary": "Short Paths.",
272
254
  "allowNo": false
255
+ },
256
+ "templates": {
257
+ "name": "templates",
258
+ "type": "boolean",
259
+ "char": "m",
260
+ "summary": "Summary for templates.",
261
+ "allowNo": false
262
+ }
263
+ },
264
+ "args": {},
265
+ "isLogsActive": false
266
+ },
267
+ "butler:pb:exportdatasource": {
268
+ "id": "butler:pb:exportdatasource",
269
+ "summary": "Export PDF Butler DataSource records from your organization.",
270
+ "description": "Use this command to export DataSource records from a Salesforce org and save them locally as JSON.",
271
+ "strict": true,
272
+ "pluginName": "@pdfbutler/migration-cli",
273
+ "pluginAlias": "@pdfbutler/migration-cli",
274
+ "pluginType": "core",
275
+ "aliases": [],
276
+ "hiddenAliases": [],
277
+ "examples": [
278
+ "<%= config.bin %> <%= command.id %>"
279
+ ],
280
+ "flags": {
281
+ "target": {
282
+ "name": "target",
283
+ "type": "option",
284
+ "char": "t",
285
+ "summary": "The Salesforce org username credentials to connect to the target org.",
286
+ "required": false,
287
+ "multiple": false
288
+ },
289
+ "id": {
290
+ "name": "id",
291
+ "type": "option",
292
+ "char": "i",
293
+ "summary": "The DataSource ID to export. For bulk export, enter multiple IDs separated by whitespaces.",
294
+ "required": true,
295
+ "multiple": false
296
+ },
297
+ "folder": {
298
+ "name": "folder",
299
+ "type": "option",
300
+ "char": "f",
301
+ "summary": "The output folder path where the exported DataSource JSON files will be saved.",
302
+ "required": true,
303
+ "multiple": false
304
+ },
305
+ "auth-env-var": {
306
+ "name": "auth-env-var",
307
+ "type": "option",
308
+ "char": "a",
309
+ "summary": "PDF Butler credentials for backend authentication.",
310
+ "multiple": false
311
+ },
312
+ "endpoint": {
313
+ "name": "endpoint",
314
+ "type": "option",
315
+ "char": "e",
316
+ "summary": "PDF Butler endpoint URL.",
317
+ "multiple": false
318
+ },
319
+ "stage": {
320
+ "name": "stage",
321
+ "type": "option",
322
+ "char": "s",
323
+ "summary": "CADMUS stage for backend operations.",
324
+ "required": true,
325
+ "multiple": false
326
+ },
327
+ "logs": {
328
+ "name": "logs",
329
+ "type": "boolean",
330
+ "char": "l",
331
+ "summary": "Enable detailed logs for the export process.",
332
+ "allowNo": false
333
+ },
334
+ "parents": {
335
+ "name": "parents",
336
+ "type": "boolean",
337
+ "char": "p",
338
+ "summary": "Automatically export parent DataSources recursively when detected (without prompt).",
339
+ "allowNo": false
340
+ },
341
+ "session": {
342
+ "name": "session",
343
+ "type": "option",
344
+ "summary": "Salesforce Session ID for authentication.",
345
+ "multiple": false
346
+ },
347
+ "instance": {
348
+ "name": "instance",
349
+ "type": "option",
350
+ "summary": "Salesforce Instance URL for authentication.",
351
+ "multiple": false
273
352
  }
274
353
  },
275
354
  "args": {},
@@ -284,17 +363,11 @@
284
363
  "pluginAlias": "@pdfbutler/migration-cli",
285
364
  "pluginType": "core",
286
365
  "aliases": [],
366
+ "hiddenAliases": [],
287
367
  "examples": [
288
368
  "<%= config.bin %> <%= command.id %>"
289
369
  ],
290
370
  "flags": {
291
- "json": {
292
- "name": "json",
293
- "type": "boolean",
294
- "description": "Format output as json.",
295
- "helpGroup": "GLOBAL",
296
- "allowNo": false
297
- },
298
371
  "name": {
299
372
  "name": "name",
300
373
  "type": "option",
@@ -360,17 +433,11 @@
360
433
  "pluginAlias": "@pdfbutler/migration-cli",
361
434
  "pluginType": "core",
362
435
  "aliases": [],
436
+ "hiddenAliases": [],
363
437
  "examples": [
364
438
  "<%= config.bin %> <%= command.id %>"
365
439
  ],
366
440
  "flags": {
367
- "json": {
368
- "name": "json",
369
- "type": "boolean",
370
- "description": "Format output as json.",
371
- "helpGroup": "GLOBAL",
372
- "allowNo": false
373
- },
374
441
  "name": {
375
442
  "name": "name",
376
443
  "type": "option",
@@ -450,15 +517,105 @@
450
517
  "type": "option",
451
518
  "summary": "Instance Url.",
452
519
  "multiple": false
520
+ },
521
+ "templates": {
522
+ "name": "templates",
523
+ "type": "boolean",
524
+ "char": "m",
525
+ "summary": "Summary for templates.",
526
+ "allowNo": false
453
527
  }
454
528
  },
455
529
  "args": {},
456
- "colors": {
457
- "blue": "\u001b[34m",
458
- "green": "\u001b[32m",
459
- "red": "\u001b[31m",
460
- "reset": "\u001b[0m"
530
+ "isLogsActive": false
531
+ },
532
+ "butler:pb:importdatasource": {
533
+ "id": "butler:pb:importdatasource",
534
+ "summary": "Import PDF Butler DataSource records into your organization.",
535
+ "description": "Use this command to import DataSource records from JSON files exported by the DataSource export command.",
536
+ "strict": true,
537
+ "pluginName": "@pdfbutler/migration-cli",
538
+ "pluginAlias": "@pdfbutler/migration-cli",
539
+ "pluginType": "core",
540
+ "aliases": [],
541
+ "hiddenAliases": [],
542
+ "examples": [
543
+ "<%= config.bin %> <%= command.id %> -t my-org -i \"00Dak00000A4YWn_a0Bak00000MZcAb\" -f \"./export/ds\""
544
+ ],
545
+ "flags": {
546
+ "target": {
547
+ "name": "target",
548
+ "type": "option",
549
+ "char": "t",
550
+ "summary": "The Salesforce org username credentials to connect to the target org.",
551
+ "required": false,
552
+ "multiple": false
553
+ },
554
+ "auth-env-var": {
555
+ "name": "auth-env-var",
556
+ "type": "option",
557
+ "char": "a",
558
+ "summary": "PDF Butler credentials for backend authentication.",
559
+ "multiple": false
560
+ },
561
+ "endpoint": {
562
+ "name": "endpoint",
563
+ "type": "option",
564
+ "char": "e",
565
+ "summary": "PDF Butler endpoint URL.",
566
+ "multiple": false
567
+ },
568
+ "stage": {
569
+ "name": "stage",
570
+ "type": "option",
571
+ "char": "s",
572
+ "summary": "CADMUS stage for backend operations.",
573
+ "multiple": false
574
+ },
575
+ "folder": {
576
+ "name": "folder",
577
+ "type": "option",
578
+ "char": "f",
579
+ "summary": "The folder that contains the exported DataSource JSON files.",
580
+ "required": true,
581
+ "multiple": false
582
+ },
583
+ "logs": {
584
+ "name": "logs",
585
+ "type": "boolean",
586
+ "char": "l",
587
+ "summary": "Enable detailed logs for the import process.",
588
+ "allowNo": false
589
+ },
590
+ "id": {
591
+ "name": "id",
592
+ "type": "option",
593
+ "char": "i",
594
+ "summary": "The DataSource ID to import. For bulk import, enter multiple IDs separated by whitespaces.",
595
+ "required": true,
596
+ "multiple": false
597
+ },
598
+ "parents": {
599
+ "name": "parents",
600
+ "type": "boolean",
601
+ "char": "p",
602
+ "summary": "Automatically resolve and import parent DataSources first, then child DataSources.",
603
+ "allowNo": false
604
+ },
605
+ "session": {
606
+ "name": "session",
607
+ "type": "option",
608
+ "summary": "Salesforce Session ID for authentication.",
609
+ "multiple": false
610
+ },
611
+ "instance": {
612
+ "name": "instance",
613
+ "type": "option",
614
+ "summary": "Salesforce Instance URL for authentication.",
615
+ "multiple": false
616
+ }
461
617
  },
618
+ "args": {},
462
619
  "isLogsActive": false
463
620
  },
464
621
  "butler:pb:importpack": {
@@ -470,17 +627,11 @@
470
627
  "pluginAlias": "@pdfbutler/migration-cli",
471
628
  "pluginType": "core",
472
629
  "aliases": [],
630
+ "hiddenAliases": [],
473
631
  "examples": [
474
632
  "<%= config.bin %> <%= command.id %>"
475
633
  ],
476
634
  "flags": {
477
- "json": {
478
- "name": "json",
479
- "type": "boolean",
480
- "description": "Format output as json.",
481
- "helpGroup": "GLOBAL",
482
- "allowNo": false
483
- },
484
635
  "name": {
485
636
  "name": "name",
486
637
  "type": "option",
@@ -536,6 +687,128 @@
536
687
  },
537
688
  "args": {},
538
689
  "isLogsActive": false
690
+ },
691
+ "butler:sb:export:signtemplate": {
692
+ "id": "butler:sb:export:signtemplate",
693
+ "summary": "Export Sign Request Template records from your organization.",
694
+ "description": "Use this command to export one or more Sign Request Templates and save them locally as JSON files.",
695
+ "strict": true,
696
+ "pluginName": "@pdfbutler/migration-cli",
697
+ "pluginAlias": "@pdfbutler/migration-cli",
698
+ "pluginType": "core",
699
+ "aliases": [],
700
+ "hiddenAliases": [],
701
+ "examples": [
702
+ "sf butler:sb:export:signtemplate -t my-org --id \"a0Bxx0000000011 a0Bxx0000000012\" -f \"./export/sb\""
703
+ ],
704
+ "flags": {
705
+ "target": {
706
+ "name": "target",
707
+ "type": "option",
708
+ "char": "t",
709
+ "summary": "The Salesforce org username credentials to connect to the target org.",
710
+ "required": false,
711
+ "multiple": false
712
+ },
713
+ "id": {
714
+ "name": "id",
715
+ "type": "option",
716
+ "char": "i",
717
+ "summary": "The Customer Template ID to export. For bulk export, enter multiple IDs separated by whitespaces.",
718
+ "required": true,
719
+ "multiple": false
720
+ },
721
+ "folder": {
722
+ "name": "folder",
723
+ "type": "option",
724
+ "char": "f",
725
+ "summary": "The output root folder path. Files will be saved to the signRequestTemplates subfolder.",
726
+ "required": true,
727
+ "multiple": false
728
+ },
729
+ "logs": {
730
+ "name": "logs",
731
+ "type": "boolean",
732
+ "char": "l",
733
+ "summary": "Enable detailed logs for the export process.",
734
+ "allowNo": false
735
+ },
736
+ "session": {
737
+ "name": "session",
738
+ "type": "option",
739
+ "summary": "Salesforce Session ID for authentication.",
740
+ "multiple": false
741
+ },
742
+ "instance": {
743
+ "name": "instance",
744
+ "type": "option",
745
+ "summary": "Salesforce Instance URL for authentication.",
746
+ "multiple": false
747
+ }
748
+ },
749
+ "args": {},
750
+ "isLogsActive": false
751
+ },
752
+ "butler:sb:import:signtemplate": {
753
+ "id": "butler:sb:import:signtemplate",
754
+ "summary": "Import Sign Request Template records into your organization.",
755
+ "description": "Use this command to import Sign Request Templates from JSON files previously exported by the export command.",
756
+ "strict": true,
757
+ "pluginName": "@pdfbutler/migration-cli",
758
+ "pluginAlias": "@pdfbutler/migration-cli",
759
+ "pluginType": "core",
760
+ "aliases": [],
761
+ "hiddenAliases": [],
762
+ "examples": [
763
+ "sf butler:sb:import:signtemplate -t my-org --id \"a0Bxx0000000011\" -f \"./export/sb\""
764
+ ],
765
+ "flags": {
766
+ "target": {
767
+ "name": "target",
768
+ "type": "option",
769
+ "char": "t",
770
+ "summary": "The Salesforce org username credentials to connect to the target org.",
771
+ "required": false,
772
+ "multiple": false
773
+ },
774
+ "id": {
775
+ "name": "id",
776
+ "type": "option",
777
+ "char": "i",
778
+ "summary": "The Customer Template ID to import. For bulk import, enter multiple IDs separated by whitespaces.",
779
+ "required": true,
780
+ "multiple": false
781
+ },
782
+ "folder": {
783
+ "name": "folder",
784
+ "type": "option",
785
+ "char": "f",
786
+ "summary": "The export root folder path that contains the signRequestTemplates subfolder.",
787
+ "required": true,
788
+ "multiple": false
789
+ },
790
+ "logs": {
791
+ "name": "logs",
792
+ "type": "boolean",
793
+ "char": "l",
794
+ "summary": "Enable detailed logs for the import process.",
795
+ "allowNo": false
796
+ },
797
+ "session": {
798
+ "name": "session",
799
+ "type": "option",
800
+ "summary": "Salesforce Session ID for authentication.",
801
+ "multiple": false
802
+ },
803
+ "instance": {
804
+ "name": "instance",
805
+ "type": "option",
806
+ "summary": "Salesforce Instance URL for authentication.",
807
+ "multiple": false
808
+ }
809
+ },
810
+ "args": {},
811
+ "isLogsActive": false
539
812
  }
540
813
  }
541
814
  }