@pdfbutler/migration-cli 0.0.27 → 0.0.29

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 (61) hide show
  1. package/README.md +332 -45
  2. package/lib/commands/butler/pb/admincredentials.js +37 -37
  3. package/lib/commands/butler/pb/admincredentials.js.map +1 -1
  4. package/lib/commands/butler/pb/adminsettings.d.ts +1 -2
  5. package/lib/commands/butler/pb/adminsettings.js +32 -32
  6. package/lib/commands/butler/pb/adminsettings.js.map +1 -1
  7. package/lib/commands/butler/pb/export.d.ts +12 -4
  8. package/lib/commands/butler/pb/export.js +333 -200
  9. package/lib/commands/butler/pb/export.js.map +1 -1
  10. package/lib/commands/butler/pb/exportdatasource.d.ts +28 -0
  11. package/lib/commands/butler/pb/exportdatasource.js +163 -0
  12. package/lib/commands/butler/pb/exportdatasource.js.map +1 -0
  13. package/lib/commands/butler/pb/exportpack.d.ts +15 -0
  14. package/lib/commands/butler/pb/exportpack.js +282 -68
  15. package/lib/commands/butler/pb/exportpack.js.map +1 -1
  16. package/lib/commands/butler/pb/import.d.ts +17 -3
  17. package/lib/commands/butler/pb/import.js +403 -192
  18. package/lib/commands/butler/pb/import.js.map +1 -1
  19. package/lib/commands/butler/pb/importdatasource.d.ts +31 -0
  20. package/lib/commands/butler/pb/importdatasource.js +252 -0
  21. package/lib/commands/butler/pb/importdatasource.js.map +1 -0
  22. package/lib/commands/butler/pb/importpack.d.ts +23 -0
  23. package/lib/commands/butler/pb/importpack.js +391 -69
  24. package/lib/commands/butler/pb/importpack.js.map +1 -1
  25. package/lib/commands/butler/sb/export/signtemplate.d.ts +23 -0
  26. package/lib/commands/butler/sb/export/signtemplate.js +111 -0
  27. package/lib/commands/butler/sb/export/signtemplate.js.map +1 -0
  28. package/lib/commands/butler/sb/import/signtemplate.d.ts +23 -0
  29. package/lib/commands/butler/sb/import/signtemplate.js +108 -0
  30. package/lib/commands/butler/sb/import/signtemplate.js.map +1 -0
  31. package/lib/utils/authentication.d.ts +3 -1
  32. package/lib/utils/authentication.js +13 -17
  33. package/lib/utils/authentication.js.map +1 -1
  34. package/lib/utils/constants.d.ts +134 -89
  35. package/lib/utils/constants.js +65 -20
  36. package/lib/utils/constants.js.map +1 -1
  37. package/lib/utils/extract-templates.d.ts +1 -0
  38. package/lib/utils/extract-templates.js +89 -0
  39. package/lib/utils/extract-templates.js.map +1 -0
  40. package/lib/utils/id-map.d.ts +1 -0
  41. package/lib/utils/id-map.js +22 -0
  42. package/lib/utils/id-map.js.map +1 -0
  43. package/lib/utils/ids.d.ts +2 -0
  44. package/lib/utils/ids.js +21 -0
  45. package/lib/utils/ids.js.map +1 -0
  46. package/lib/utils/logger.d.ts +2 -1
  47. package/lib/utils/logger.js +15 -7
  48. package/lib/utils/logger.js.map +1 -1
  49. package/lib/utils/pack-docconfigs.d.ts +4 -0
  50. package/lib/utils/pack-docconfigs.js +77 -0
  51. package/lib/utils/pack-docconfigs.js.map +1 -0
  52. package/messages/butler.pb.export.md +4 -0
  53. package/messages/butler.pb.exportdatasource.md +51 -0
  54. package/messages/butler.pb.exportpack.md +24 -0
  55. package/messages/butler.pb.import.md +4 -0
  56. package/messages/butler.pb.importdatasource.md +51 -0
  57. package/messages/butler.pb.importpack.md +24 -0
  58. package/messages/butler.sb.export.signtemplate.md +35 -0
  59. package/messages/butler.sb.import.signtemplate.md +35 -0
  60. package/oclif.manifest.json +437 -46
  61. package/package.json +223 -215
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "0.0.27",
2
+ "version": "0.0.29",
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",
@@ -198,10 +180,17 @@
198
180
  },
199
181
  "backend": {
200
182
  "name": "backend",
201
- "type": "boolean",
183
+ "type": "option",
202
184
  "char": "b",
203
185
  "summary": "Summary for backend.",
204
- "allowNo": false
186
+ "required": false,
187
+ "multiple": false,
188
+ "options": [
189
+ "full",
190
+ "only",
191
+ "none"
192
+ ],
193
+ "default": "full"
205
194
  },
206
195
  "auth-env-var": {
207
196
  "name": "auth-env-var",
@@ -270,11 +259,109 @@
270
259
  "type": "boolean",
271
260
  "summary": "Short Paths.",
272
261
  "allowNo": false
262
+ },
263
+ "templates": {
264
+ "name": "templates",
265
+ "type": "boolean",
266
+ "char": "m",
267
+ "summary": "Summary for templates.",
268
+ "allowNo": false
273
269
  }
274
270
  },
275
271
  "args": {},
276
272
  "isLogsActive": false
277
273
  },
274
+ "butler:pb:exportdatasource": {
275
+ "id": "butler:pb:exportdatasource",
276
+ "summary": "Export PDF Butler DataSource records from your organization.",
277
+ "description": "Use this command to export DataSource records from a Salesforce org and save them locally as JSON.",
278
+ "strict": true,
279
+ "pluginName": "@pdfbutler/migration-cli",
280
+ "pluginAlias": "@pdfbutler/migration-cli",
281
+ "pluginType": "core",
282
+ "aliases": [],
283
+ "hiddenAliases": [],
284
+ "examples": [
285
+ "<%= config.bin %> <%= command.id %>"
286
+ ],
287
+ "flags": {
288
+ "target": {
289
+ "name": "target",
290
+ "type": "option",
291
+ "char": "t",
292
+ "summary": "The Salesforce org username credentials to connect to the target org.",
293
+ "required": false,
294
+ "multiple": false
295
+ },
296
+ "id": {
297
+ "name": "id",
298
+ "type": "option",
299
+ "char": "i",
300
+ "summary": "The DataSource ID to export. For bulk export, enter multiple IDs separated by whitespaces.",
301
+ "required": true,
302
+ "multiple": false
303
+ },
304
+ "folder": {
305
+ "name": "folder",
306
+ "type": "option",
307
+ "char": "f",
308
+ "summary": "The output folder path where the exported DataSource JSON files will be saved.",
309
+ "required": true,
310
+ "multiple": false
311
+ },
312
+ "auth-env-var": {
313
+ "name": "auth-env-var",
314
+ "type": "option",
315
+ "char": "a",
316
+ "summary": "PDF Butler credentials for backend authentication.",
317
+ "multiple": false
318
+ },
319
+ "endpoint": {
320
+ "name": "endpoint",
321
+ "type": "option",
322
+ "char": "e",
323
+ "summary": "PDF Butler endpoint URL.",
324
+ "multiple": false
325
+ },
326
+ "stage": {
327
+ "name": "stage",
328
+ "type": "option",
329
+ "char": "s",
330
+ "summary": "CADMUS stage for backend operations.",
331
+ "required": true,
332
+ "multiple": false
333
+ },
334
+ "logs": {
335
+ "name": "logs",
336
+ "type": "boolean",
337
+ "char": "l",
338
+ "summary": "Enable detailed logs for the export process.",
339
+ "allowNo": false
340
+ },
341
+ "parents": {
342
+ "name": "parents",
343
+ "type": "boolean",
344
+ "char": "p",
345
+ "summary": "Automatically export parent DataSources recursively when detected (without prompt).",
346
+ "allowNo": false
347
+ },
348
+ "session": {
349
+ "name": "session",
350
+ "type": "option",
351
+ "summary": "Salesforce Session ID for authentication.",
352
+ "multiple": false
353
+ },
354
+ "instance": {
355
+ "name": "instance",
356
+ "type": "option",
357
+ "summary": "Salesforce Instance URL for authentication.",
358
+ "multiple": false
359
+ }
360
+ },
361
+ "args": {},
362
+ "dataSourcesFolderName": "dataSources",
363
+ "isLogsActive": false
364
+ },
278
365
  "butler:pb:exportpack": {
279
366
  "id": "butler:pb:exportpack",
280
367
  "summary": "Summary of a command.",
@@ -284,17 +371,11 @@
284
371
  "pluginAlias": "@pdfbutler/migration-cli",
285
372
  "pluginType": "core",
286
373
  "aliases": [],
374
+ "hiddenAliases": [],
287
375
  "examples": [
288
376
  "<%= config.bin %> <%= command.id %>"
289
377
  ],
290
378
  "flags": {
291
- "json": {
292
- "name": "json",
293
- "type": "boolean",
294
- "description": "Format output as json.",
295
- "helpGroup": "GLOBAL",
296
- "allowNo": false
297
- },
298
379
  "name": {
299
380
  "name": "name",
300
381
  "type": "option",
@@ -335,6 +416,57 @@
335
416
  "summary": "Logs.",
336
417
  "allowNo": false
337
418
  },
419
+ "auth-env-var": {
420
+ "name": "auth-env-var",
421
+ "type": "option",
422
+ "char": "a",
423
+ "summary": "Auth env var.",
424
+ "multiple": false
425
+ },
426
+ "endpoint": {
427
+ "name": "endpoint",
428
+ "type": "option",
429
+ "char": "e",
430
+ "summary": "Endpoint URL.",
431
+ "multiple": false
432
+ },
433
+ "stage": {
434
+ "name": "stage",
435
+ "type": "option",
436
+ "char": "s",
437
+ "summary": "Stage.",
438
+ "required": false,
439
+ "multiple": false
440
+ },
441
+ "unzip": {
442
+ "name": "unzip",
443
+ "type": "boolean",
444
+ "char": "u",
445
+ "summary": "Unzip backend archives.",
446
+ "allowNo": false
447
+ },
448
+ "templates": {
449
+ "name": "templates",
450
+ "type": "boolean",
451
+ "char": "m",
452
+ "summary": "Include template DocConfigs.",
453
+ "allowNo": false
454
+ },
455
+ "docconfig": {
456
+ "name": "docconfig",
457
+ "type": "option",
458
+ "char": "d",
459
+ "summary": "Export related DocConfigs mode: none | pack | lead | full.",
460
+ "required": false,
461
+ "multiple": false,
462
+ "options": [
463
+ "none",
464
+ "pack",
465
+ "lead",
466
+ "full"
467
+ ],
468
+ "default": "none"
469
+ },
338
470
  "session": {
339
471
  "name": "session",
340
472
  "type": "option",
@@ -349,7 +481,8 @@
349
481
  }
350
482
  },
351
483
  "args": {},
352
- "isLogsActive": false
484
+ "isLogsActive": false,
485
+ "processedDocConfigIds": {}
353
486
  },
354
487
  "butler:pb:import": {
355
488
  "id": "butler:pb:import",
@@ -360,17 +493,11 @@
360
493
  "pluginAlias": "@pdfbutler/migration-cli",
361
494
  "pluginType": "core",
362
495
  "aliases": [],
496
+ "hiddenAliases": [],
363
497
  "examples": [
364
498
  "<%= config.bin %> <%= command.id %>"
365
499
  ],
366
500
  "flags": {
367
- "json": {
368
- "name": "json",
369
- "type": "boolean",
370
- "description": "Format output as json.",
371
- "helpGroup": "GLOBAL",
372
- "allowNo": false
373
- },
374
501
  "name": {
375
502
  "name": "name",
376
503
  "type": "option",
@@ -450,9 +577,106 @@
450
577
  "type": "option",
451
578
  "summary": "Instance Url.",
452
579
  "multiple": false
580
+ },
581
+ "templates": {
582
+ "name": "templates",
583
+ "type": "boolean",
584
+ "char": "m",
585
+ "summary": "Summary for templates.",
586
+ "allowNo": false
587
+ }
588
+ },
589
+ "args": {},
590
+ "isLogsActive": false
591
+ },
592
+ "butler:pb:importdatasource": {
593
+ "id": "butler:pb:importdatasource",
594
+ "summary": "Import PDF Butler DataSource records into your organization.",
595
+ "description": "Use this command to import DataSource records from JSON files exported by the DataSource export command.",
596
+ "strict": true,
597
+ "pluginName": "@pdfbutler/migration-cli",
598
+ "pluginAlias": "@pdfbutler/migration-cli",
599
+ "pluginType": "core",
600
+ "aliases": [],
601
+ "hiddenAliases": [],
602
+ "examples": [
603
+ "<%= config.bin %> <%= command.id %> -t my-org -i \"00Dak00000A4YWn_a0Bak00000MZcAb\" -f \"./export/ds\""
604
+ ],
605
+ "flags": {
606
+ "target": {
607
+ "name": "target",
608
+ "type": "option",
609
+ "char": "t",
610
+ "summary": "The Salesforce org username credentials to connect to the target org.",
611
+ "required": false,
612
+ "multiple": false
613
+ },
614
+ "auth-env-var": {
615
+ "name": "auth-env-var",
616
+ "type": "option",
617
+ "char": "a",
618
+ "summary": "PDF Butler credentials for backend authentication.",
619
+ "multiple": false
620
+ },
621
+ "endpoint": {
622
+ "name": "endpoint",
623
+ "type": "option",
624
+ "char": "e",
625
+ "summary": "PDF Butler endpoint URL.",
626
+ "multiple": false
627
+ },
628
+ "stage": {
629
+ "name": "stage",
630
+ "type": "option",
631
+ "char": "s",
632
+ "summary": "CADMUS stage for backend operations.",
633
+ "multiple": false
634
+ },
635
+ "folder": {
636
+ "name": "folder",
637
+ "type": "option",
638
+ "char": "f",
639
+ "summary": "The folder that contains the exported DataSource JSON files.",
640
+ "required": true,
641
+ "multiple": false
642
+ },
643
+ "logs": {
644
+ "name": "logs",
645
+ "type": "boolean",
646
+ "char": "l",
647
+ "summary": "Enable detailed logs for the import process.",
648
+ "allowNo": false
649
+ },
650
+ "id": {
651
+ "name": "id",
652
+ "type": "option",
653
+ "char": "i",
654
+ "summary": "The DataSource ID to import. For bulk import, enter multiple IDs separated by whitespaces.",
655
+ "required": true,
656
+ "multiple": false
657
+ },
658
+ "parents": {
659
+ "name": "parents",
660
+ "type": "boolean",
661
+ "char": "p",
662
+ "summary": "Automatically resolve and import parent DataSources first, then child DataSources.",
663
+ "allowNo": false
664
+ },
665
+ "session": {
666
+ "name": "session",
667
+ "type": "option",
668
+ "summary": "Salesforce Session ID for authentication.",
669
+ "multiple": false
670
+ },
671
+ "instance": {
672
+ "name": "instance",
673
+ "type": "option",
674
+ "summary": "Salesforce Instance URL for authentication.",
675
+ "multiple": false
453
676
  }
454
677
  },
455
678
  "args": {},
679
+ "dataSourcesFolderName": "dataSources",
456
680
  "isLogsActive": false
457
681
  },
458
682
  "butler:pb:importpack": {
@@ -464,17 +688,11 @@
464
688
  "pluginAlias": "@pdfbutler/migration-cli",
465
689
  "pluginType": "core",
466
690
  "aliases": [],
691
+ "hiddenAliases": [],
467
692
  "examples": [
468
693
  "<%= config.bin %> <%= command.id %>"
469
694
  ],
470
695
  "flags": {
471
- "json": {
472
- "name": "json",
473
- "type": "boolean",
474
- "description": "Format output as json.",
475
- "helpGroup": "GLOBAL",
476
- "allowNo": false
477
- },
478
696
  "name": {
479
697
  "name": "name",
480
698
  "type": "option",
@@ -515,6 +733,56 @@
515
733
  "summary": "Logs.",
516
734
  "allowNo": false
517
735
  },
736
+ "auth-env-var": {
737
+ "name": "auth-env-var",
738
+ "type": "option",
739
+ "char": "a",
740
+ "summary": "Auth env var.",
741
+ "multiple": false
742
+ },
743
+ "endpoint": {
744
+ "name": "endpoint",
745
+ "type": "option",
746
+ "char": "e",
747
+ "summary": "Endpoint URL.",
748
+ "multiple": false
749
+ },
750
+ "stage": {
751
+ "name": "stage",
752
+ "type": "option",
753
+ "char": "s",
754
+ "summary": "Stage.",
755
+ "required": false,
756
+ "multiple": false
757
+ },
758
+ "templates": {
759
+ "name": "templates",
760
+ "type": "boolean",
761
+ "char": "m",
762
+ "summary": "Include template DocConfigs.",
763
+ "allowNo": false
764
+ },
765
+ "clone": {
766
+ "name": "clone",
767
+ "type": "boolean",
768
+ "char": "c",
769
+ "summary": "Clone DocConfigs instead of updating existing.",
770
+ "allowNo": false
771
+ },
772
+ "docconfig": {
773
+ "name": "docconfig",
774
+ "type": "option",
775
+ "char": "d",
776
+ "summary": "Import DocConfigs mode: pack | lead | full.",
777
+ "required": false,
778
+ "multiple": false,
779
+ "options": [
780
+ "pack",
781
+ "lead",
782
+ "full"
783
+ ],
784
+ "default": "full"
785
+ },
518
786
  "session": {
519
787
  "name": "session",
520
788
  "type": "option",
@@ -529,6 +797,129 @@
529
797
  }
530
798
  },
531
799
  "args": {},
800
+ "isLogsActive": false,
801
+ "importedDocConfigIds": {}
802
+ },
803
+ "butler:sb:export:signtemplate": {
804
+ "id": "butler:sb:export:signtemplate",
805
+ "summary": "Export Sign Request Template records from your organization.",
806
+ "description": "Use this command to export one or more Sign Request Templates and save them locally as JSON files.",
807
+ "strict": true,
808
+ "pluginName": "@pdfbutler/migration-cli",
809
+ "pluginAlias": "@pdfbutler/migration-cli",
810
+ "pluginType": "core",
811
+ "aliases": [],
812
+ "hiddenAliases": [],
813
+ "examples": [
814
+ "sf butler:sb:export:signtemplate -t my-org --id \"a0Bxx0000000011 a0Bxx0000000012\" -f \"./export/sb\""
815
+ ],
816
+ "flags": {
817
+ "target": {
818
+ "name": "target",
819
+ "type": "option",
820
+ "char": "t",
821
+ "summary": "The Salesforce org username credentials to connect to the target org.",
822
+ "required": false,
823
+ "multiple": false
824
+ },
825
+ "id": {
826
+ "name": "id",
827
+ "type": "option",
828
+ "char": "i",
829
+ "summary": "The Customer Template ID to export. For bulk export, enter multiple IDs separated by whitespaces.",
830
+ "required": true,
831
+ "multiple": false
832
+ },
833
+ "folder": {
834
+ "name": "folder",
835
+ "type": "option",
836
+ "char": "f",
837
+ "summary": "The output root folder path. Files will be saved to the signRequestTemplates subfolder.",
838
+ "required": true,
839
+ "multiple": false
840
+ },
841
+ "logs": {
842
+ "name": "logs",
843
+ "type": "boolean",
844
+ "char": "l",
845
+ "summary": "Enable detailed logs for the export process.",
846
+ "allowNo": false
847
+ },
848
+ "session": {
849
+ "name": "session",
850
+ "type": "option",
851
+ "summary": "Salesforce Session ID for authentication.",
852
+ "multiple": false
853
+ },
854
+ "instance": {
855
+ "name": "instance",
856
+ "type": "option",
857
+ "summary": "Salesforce Instance URL for authentication.",
858
+ "multiple": false
859
+ }
860
+ },
861
+ "args": {},
862
+ "isLogsActive": false
863
+ },
864
+ "butler:sb:import:signtemplate": {
865
+ "id": "butler:sb:import:signtemplate",
866
+ "summary": "Import Sign Request Template records into your organization.",
867
+ "description": "Use this command to import Sign Request Templates from JSON files previously exported by the export command.",
868
+ "strict": true,
869
+ "pluginName": "@pdfbutler/migration-cli",
870
+ "pluginAlias": "@pdfbutler/migration-cli",
871
+ "pluginType": "core",
872
+ "aliases": [],
873
+ "hiddenAliases": [],
874
+ "examples": [
875
+ "sf butler:sb:import:signtemplate -t my-org --id \"a0Bxx0000000011\" -f \"./export/sb\""
876
+ ],
877
+ "flags": {
878
+ "target": {
879
+ "name": "target",
880
+ "type": "option",
881
+ "char": "t",
882
+ "summary": "The Salesforce org username credentials to connect to the target org.",
883
+ "required": false,
884
+ "multiple": false
885
+ },
886
+ "id": {
887
+ "name": "id",
888
+ "type": "option",
889
+ "char": "i",
890
+ "summary": "The Customer Template ID to import. For bulk import, enter multiple IDs separated by whitespaces.",
891
+ "required": true,
892
+ "multiple": false
893
+ },
894
+ "folder": {
895
+ "name": "folder",
896
+ "type": "option",
897
+ "char": "f",
898
+ "summary": "The export root folder path that contains the signRequestTemplates subfolder.",
899
+ "required": true,
900
+ "multiple": false
901
+ },
902
+ "logs": {
903
+ "name": "logs",
904
+ "type": "boolean",
905
+ "char": "l",
906
+ "summary": "Enable detailed logs for the import process.",
907
+ "allowNo": false
908
+ },
909
+ "session": {
910
+ "name": "session",
911
+ "type": "option",
912
+ "summary": "Salesforce Session ID for authentication.",
913
+ "multiple": false
914
+ },
915
+ "instance": {
916
+ "name": "instance",
917
+ "type": "option",
918
+ "summary": "Salesforce Instance URL for authentication.",
919
+ "multiple": false
920
+ }
921
+ },
922
+ "args": {},
532
923
  "isLogsActive": false
533
924
  }
534
925
  }