@salesforce/plugin-signups 2.6.11 → 2.6.13

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.
@@ -1,15 +1,130 @@
1
1
  {
2
2
  "commands": {
3
- "org:get:snapshot": {
3
+ "org:create:shape": {
4
4
  "aliases": [
5
- "force:org:snapshot:get"
5
+ "force:org:shape:create"
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
9
+ "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
10
10
  "examples": [
11
- "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
12
- "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
11
+ "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
12
+ ],
13
+ "flags": {
14
+ "json": {
15
+ "description": "Format output as json.",
16
+ "helpGroup": "GLOBAL",
17
+ "name": "json",
18
+ "allowNo": false,
19
+ "type": "boolean"
20
+ },
21
+ "flags-dir": {
22
+ "helpGroup": "GLOBAL",
23
+ "name": "flags-dir",
24
+ "summary": "Import flag values from a directory.",
25
+ "hasDynamicHelp": false,
26
+ "multiple": false,
27
+ "type": "option"
28
+ },
29
+ "target-org": {
30
+ "aliases": [
31
+ "targetusername",
32
+ "u"
33
+ ],
34
+ "char": "o",
35
+ "deprecateAliases": true,
36
+ "name": "target-org",
37
+ "noCacheDefault": true,
38
+ "required": true,
39
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
40
+ "hasDynamicHelp": true,
41
+ "multiple": false,
42
+ "type": "option"
43
+ },
44
+ "api-version": {
45
+ "aliases": [
46
+ "apiversion"
47
+ ],
48
+ "deprecateAliases": true,
49
+ "description": "Override the api version used for api requests made by this command",
50
+ "name": "api-version",
51
+ "hasDynamicHelp": false,
52
+ "multiple": false,
53
+ "type": "option"
54
+ },
55
+ "loglevel": {
56
+ "deprecated": {
57
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
58
+ },
59
+ "hidden": true,
60
+ "name": "loglevel",
61
+ "hasDynamicHelp": false,
62
+ "multiple": false,
63
+ "type": "option"
64
+ }
65
+ },
66
+ "hasDynamicHelp": true,
67
+ "hiddenAliases": [],
68
+ "id": "org:create:shape",
69
+ "pluginAlias": "@salesforce/plugin-signups",
70
+ "pluginName": "@salesforce/plugin-signups",
71
+ "pluginType": "core",
72
+ "strict": true,
73
+ "summary": "Create a scratch org configuration (shape) based on the specified source org.",
74
+ "enableJsonFlag": true,
75
+ "isESM": true,
76
+ "relativePath": [
77
+ "lib",
78
+ "commands",
79
+ "org",
80
+ "create",
81
+ "shape.js"
82
+ ],
83
+ "aliasPermutations": [
84
+ "force:org:shape:create",
85
+ "org:force:shape:create",
86
+ "org:shape:force:create",
87
+ "org:shape:create:force",
88
+ "force:shape:org:create",
89
+ "shape:force:org:create",
90
+ "shape:org:force:create",
91
+ "shape:org:create:force",
92
+ "force:shape:create:org",
93
+ "shape:force:create:org",
94
+ "shape:create:force:org",
95
+ "shape:create:org:force",
96
+ "force:org:create:shape",
97
+ "org:force:create:shape",
98
+ "org:create:force:shape",
99
+ "org:create:shape:force",
100
+ "force:create:org:shape",
101
+ "create:force:org:shape",
102
+ "create:org:force:shape",
103
+ "create:org:shape:force",
104
+ "force:create:shape:org",
105
+ "create:force:shape:org",
106
+ "create:shape:force:org",
107
+ "create:shape:org:force"
108
+ ],
109
+ "permutations": [
110
+ "org:create:shape",
111
+ "create:org:shape",
112
+ "create:shape:org",
113
+ "org:shape:create",
114
+ "shape:org:create",
115
+ "shape:create:org"
116
+ ]
117
+ },
118
+ "org:create:snapshot": {
119
+ "aliases": [
120
+ "force:org:snapshot:create"
121
+ ],
122
+ "args": {},
123
+ "deprecateAliases": true,
124
+ "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
125
+ "examples": [
126
+ "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
127
+ "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
13
128
  ],
14
129
  "flags": {
15
130
  "json": {
@@ -62,12 +177,37 @@
62
177
  "multiple": false,
63
178
  "type": "option"
64
179
  },
65
- "snapshot": {
66
- "char": "s",
67
- "description": "The IDs of scratch org snapshots start with 0Oo.",
68
- "name": "snapshot",
180
+ "source-org": {
181
+ "aliases": [
182
+ "sourceorg"
183
+ ],
184
+ "char": "o",
185
+ "deprecateAliases": true,
186
+ "name": "source-org",
69
187
  "required": true,
70
- "summary": "Name or ID of snapshot to retrieve.",
188
+ "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
189
+ "hasDynamicHelp": false,
190
+ "multiple": false,
191
+ "type": "option"
192
+ },
193
+ "name": {
194
+ "aliases": [
195
+ "snapshotname"
196
+ ],
197
+ "char": "n",
198
+ "deprecateAliases": true,
199
+ "name": "name",
200
+ "required": true,
201
+ "summary": "Unique name of snapshot.",
202
+ "hasDynamicHelp": false,
203
+ "multiple": false,
204
+ "type": "option"
205
+ },
206
+ "description": {
207
+ "char": "d",
208
+ "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
209
+ "name": "description",
210
+ "summary": "Description of snapshot.",
71
211
  "hasDynamicHelp": false,
72
212
  "multiple": false,
73
213
  "type": "option"
@@ -75,54 +215,54 @@
75
215
  },
76
216
  "hasDynamicHelp": true,
77
217
  "hiddenAliases": [],
78
- "id": "org:get:snapshot",
218
+ "id": "org:create:snapshot",
79
219
  "pluginAlias": "@salesforce/plugin-signups",
80
220
  "pluginName": "@salesforce/plugin-signups",
81
221
  "pluginType": "core",
82
222
  "strict": true,
83
- "summary": "Get details about a scratch org snapshot.",
223
+ "summary": "Create a snapshot of a scratch org.",
84
224
  "enableJsonFlag": true,
85
225
  "isESM": true,
86
226
  "relativePath": [
87
227
  "lib",
88
228
  "commands",
89
229
  "org",
90
- "get",
230
+ "create",
91
231
  "snapshot.js"
92
232
  ],
93
233
  "aliasPermutations": [
94
- "force:org:snapshot:get",
95
- "org:force:snapshot:get",
96
- "org:snapshot:force:get",
97
- "org:snapshot:get:force",
98
- "force:snapshot:org:get",
99
- "snapshot:force:org:get",
100
- "snapshot:org:force:get",
101
- "snapshot:org:get:force",
102
- "force:snapshot:get:org",
103
- "snapshot:force:get:org",
104
- "snapshot:get:force:org",
105
- "snapshot:get:org:force",
106
- "force:org:get:snapshot",
107
- "org:force:get:snapshot",
108
- "org:get:force:snapshot",
109
- "org:get:snapshot:force",
110
- "force:get:org:snapshot",
111
- "get:force:org:snapshot",
112
- "get:org:force:snapshot",
113
- "get:org:snapshot:force",
114
- "force:get:snapshot:org",
115
- "get:force:snapshot:org",
116
- "get:snapshot:force:org",
117
- "get:snapshot:org:force"
234
+ "force:org:snapshot:create",
235
+ "org:force:snapshot:create",
236
+ "org:snapshot:force:create",
237
+ "org:snapshot:create:force",
238
+ "force:snapshot:org:create",
239
+ "snapshot:force:org:create",
240
+ "snapshot:org:force:create",
241
+ "snapshot:org:create:force",
242
+ "force:snapshot:create:org",
243
+ "snapshot:force:create:org",
244
+ "snapshot:create:force:org",
245
+ "snapshot:create:org:force",
246
+ "force:org:create:snapshot",
247
+ "org:force:create:snapshot",
248
+ "org:create:force:snapshot",
249
+ "org:create:snapshot:force",
250
+ "force:create:org:snapshot",
251
+ "create:force:org:snapshot",
252
+ "create:org:force:snapshot",
253
+ "create:org:snapshot:force",
254
+ "force:create:snapshot:org",
255
+ "create:force:snapshot:org",
256
+ "create:snapshot:force:org",
257
+ "create:snapshot:org:force"
118
258
  ],
119
259
  "permutations": [
120
- "org:get:snapshot",
121
- "get:org:snapshot",
122
- "get:snapshot:org",
123
- "org:snapshot:get",
124
- "snapshot:org:get",
125
- "snapshot:get:org"
260
+ "org:create:snapshot",
261
+ "create:org:snapshot",
262
+ "create:snapshot:org",
263
+ "org:snapshot:create",
264
+ "snapshot:org:create",
265
+ "snapshot:create:org"
126
266
  ]
127
267
  },
128
268
  "org:delete:shape": {
@@ -384,131 +524,16 @@
384
524
  "snapshot:delete:org"
385
525
  ]
386
526
  },
387
- "org:create:shape": {
388
- "aliases": [
389
- "force:org:shape:create"
390
- ],
391
- "args": {},
392
- "deprecateAliases": true,
393
- "description": "Scratch org shapes mimic the baseline setup (features, limits, edition, and Metadata API settings) of a source org without the extraneous data and metadata.\n\nRun \"<%= config.bin %> org list shape\" to view the available org shapes and their IDs.\n\nTo create a scratch org from an org shape, include the \"sourceOrg\" property in the scratch org definition file and set it to the org ID of the source org. Then create a scratch org with the \"<%= config.bin %> org create scratch\" command.",
394
- "examples": [
395
- "Create an org shape for the source org with alias SourceOrg:\n<%= config.bin %> <%= command.id %> --target-org SourceOrg"
396
- ],
397
- "flags": {
398
- "json": {
399
- "description": "Format output as json.",
400
- "helpGroup": "GLOBAL",
401
- "name": "json",
402
- "allowNo": false,
403
- "type": "boolean"
404
- },
405
- "flags-dir": {
406
- "helpGroup": "GLOBAL",
407
- "name": "flags-dir",
408
- "summary": "Import flag values from a directory.",
409
- "hasDynamicHelp": false,
410
- "multiple": false,
411
- "type": "option"
412
- },
413
- "target-org": {
414
- "aliases": [
415
- "targetusername",
416
- "u"
417
- ],
418
- "char": "o",
419
- "deprecateAliases": true,
420
- "name": "target-org",
421
- "noCacheDefault": true,
422
- "required": true,
423
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
424
- "hasDynamicHelp": true,
425
- "multiple": false,
426
- "type": "option"
427
- },
428
- "api-version": {
429
- "aliases": [
430
- "apiversion"
431
- ],
432
- "deprecateAliases": true,
433
- "description": "Override the api version used for api requests made by this command",
434
- "name": "api-version",
435
- "hasDynamicHelp": false,
436
- "multiple": false,
437
- "type": "option"
438
- },
439
- "loglevel": {
440
- "deprecated": {
441
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
442
- },
443
- "hidden": true,
444
- "name": "loglevel",
445
- "hasDynamicHelp": false,
446
- "multiple": false,
447
- "type": "option"
448
- }
449
- },
450
- "hasDynamicHelp": true,
451
- "hiddenAliases": [],
452
- "id": "org:create:shape",
453
- "pluginAlias": "@salesforce/plugin-signups",
454
- "pluginName": "@salesforce/plugin-signups",
455
- "pluginType": "core",
456
- "strict": true,
457
- "summary": "Create a scratch org configuration (shape) based on the specified source org.",
458
- "enableJsonFlag": true,
459
- "isESM": true,
460
- "relativePath": [
461
- "lib",
462
- "commands",
463
- "org",
464
- "create",
465
- "shape.js"
466
- ],
467
- "aliasPermutations": [
468
- "force:org:shape:create",
469
- "org:force:shape:create",
470
- "org:shape:force:create",
471
- "org:shape:create:force",
472
- "force:shape:org:create",
473
- "shape:force:org:create",
474
- "shape:org:force:create",
475
- "shape:org:create:force",
476
- "force:shape:create:org",
477
- "shape:force:create:org",
478
- "shape:create:force:org",
479
- "shape:create:org:force",
480
- "force:org:create:shape",
481
- "org:force:create:shape",
482
- "org:create:force:shape",
483
- "org:create:shape:force",
484
- "force:create:org:shape",
485
- "create:force:org:shape",
486
- "create:org:force:shape",
487
- "create:org:shape:force",
488
- "force:create:shape:org",
489
- "create:force:shape:org",
490
- "create:shape:force:org",
491
- "create:shape:org:force"
492
- ],
493
- "permutations": [
494
- "org:create:shape",
495
- "create:org:shape",
496
- "create:shape:org",
497
- "org:shape:create",
498
- "shape:org:create",
499
- "shape:create:org"
500
- ]
501
- },
502
- "org:create:snapshot": {
527
+ "org:get:snapshot": {
503
528
  "aliases": [
504
- "force:org:snapshot:create"
529
+ "force:org:snapshot:get"
505
530
  ],
506
531
  "args": {},
507
532
  "deprecateAliases": true,
508
- "description": "A snapshot is a point-in-time copy of a scratch org. The copy is referenced by its unique name in a scratch org definition file.\n\nUse \"<%= config.bin %> org get snapshot\" to get details, including status, about a snapshot creation request.\n\nTo create a scratch org from a snapshot, include the \"snapshot\" option (instead of \"edition\") in the scratch org definition file and set it to the name of the snapshot. Then use \"<%= config.bin %> org create scratch\" to create the scratch org.",
533
+ "description": "Snapshot creation can take a while. Use this command with the snapshot name or ID to check its creation status. After the status changes to Active, you can use the snapshot to create scratch orgs.\n\nTo create a snapshot, use the \"<%= config.bin %> org create snapshot\" command. To retrieve a list of all snapshots, use \"<%= config.bin %> org list snapshot\".",
509
534
  "examples": [
510
- "Create a snapshot called \"Dependencies\" using the source scratch org ID and your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --source-org 00Dxx0000000000 --name Dependencies --description 'Contains PackageA v1.1.0'",
511
- "Create a snapshot called \"NightlyBranch\" using the source scratch org username and a Dev Hub org with alias NightlyDevHub:\n<%= config.bin %> <%= command.id %> --source-org myuser@myorg --name NightlyBranch --description 'Contains PkgA v2.1.0 and PkgB 3.3.0' --target-dev-hub NightlyDevHub"
535
+ "Get snapshot details using its ID and the default Dev Hub org:\n<%= config.bin %> <%= command.id %> --snapshot 0Oo...",
536
+ "Get snapshot details using its name from a Dev Hub org with alias SnapshotDevHub:\n<%= config.bin %> <%= command.id %> --snapshot Dependencies --target-dev-hub SnapshotDevHub"
512
537
  ],
513
538
  "flags": {
514
539
  "json": {
@@ -561,37 +586,12 @@
561
586
  "multiple": false,
562
587
  "type": "option"
563
588
  },
564
- "source-org": {
565
- "aliases": [
566
- "sourceorg"
567
- ],
568
- "char": "o",
569
- "deprecateAliases": true,
570
- "name": "source-org",
571
- "required": true,
572
- "summary": "ID or locally authenticated username or alias of scratch org to snapshot.",
573
- "hasDynamicHelp": false,
574
- "multiple": false,
575
- "type": "option"
576
- },
577
- "name": {
578
- "aliases": [
579
- "snapshotname"
580
- ],
581
- "char": "n",
582
- "deprecateAliases": true,
583
- "name": "name",
589
+ "snapshot": {
590
+ "char": "s",
591
+ "description": "The IDs of scratch org snapshots start with 0Oo.",
592
+ "name": "snapshot",
584
593
  "required": true,
585
- "summary": "Unique name of snapshot.",
586
- "hasDynamicHelp": false,
587
- "multiple": false,
588
- "type": "option"
589
- },
590
- "description": {
591
- "char": "d",
592
- "description": "Use this description to document the contents of the snapshot. We suggest that you include a reference point, such as a version control system tag or commit ID.",
593
- "name": "description",
594
- "summary": "Description of snapshot.",
594
+ "summary": "Name or ID of snapshot to retrieve.",
595
595
  "hasDynamicHelp": false,
596
596
  "multiple": false,
597
597
  "type": "option"
@@ -599,54 +599,54 @@
599
599
  },
600
600
  "hasDynamicHelp": true,
601
601
  "hiddenAliases": [],
602
- "id": "org:create:snapshot",
602
+ "id": "org:get:snapshot",
603
603
  "pluginAlias": "@salesforce/plugin-signups",
604
604
  "pluginName": "@salesforce/plugin-signups",
605
605
  "pluginType": "core",
606
606
  "strict": true,
607
- "summary": "Create a snapshot of a scratch org.",
607
+ "summary": "Get details about a scratch org snapshot.",
608
608
  "enableJsonFlag": true,
609
609
  "isESM": true,
610
610
  "relativePath": [
611
611
  "lib",
612
612
  "commands",
613
613
  "org",
614
- "create",
614
+ "get",
615
615
  "snapshot.js"
616
616
  ],
617
617
  "aliasPermutations": [
618
- "force:org:snapshot:create",
619
- "org:force:snapshot:create",
620
- "org:snapshot:force:create",
621
- "org:snapshot:create:force",
622
- "force:snapshot:org:create",
623
- "snapshot:force:org:create",
624
- "snapshot:org:force:create",
625
- "snapshot:org:create:force",
626
- "force:snapshot:create:org",
627
- "snapshot:force:create:org",
628
- "snapshot:create:force:org",
629
- "snapshot:create:org:force",
630
- "force:org:create:snapshot",
631
- "org:force:create:snapshot",
632
- "org:create:force:snapshot",
633
- "org:create:snapshot:force",
634
- "force:create:org:snapshot",
635
- "create:force:org:snapshot",
636
- "create:org:force:snapshot",
637
- "create:org:snapshot:force",
638
- "force:create:snapshot:org",
639
- "create:force:snapshot:org",
640
- "create:snapshot:force:org",
641
- "create:snapshot:org:force"
618
+ "force:org:snapshot:get",
619
+ "org:force:snapshot:get",
620
+ "org:snapshot:force:get",
621
+ "org:snapshot:get:force",
622
+ "force:snapshot:org:get",
623
+ "snapshot:force:org:get",
624
+ "snapshot:org:force:get",
625
+ "snapshot:org:get:force",
626
+ "force:snapshot:get:org",
627
+ "snapshot:force:get:org",
628
+ "snapshot:get:force:org",
629
+ "snapshot:get:org:force",
630
+ "force:org:get:snapshot",
631
+ "org:force:get:snapshot",
632
+ "org:get:force:snapshot",
633
+ "org:get:snapshot:force",
634
+ "force:get:org:snapshot",
635
+ "get:force:org:snapshot",
636
+ "get:org:force:snapshot",
637
+ "get:org:snapshot:force",
638
+ "force:get:snapshot:org",
639
+ "get:force:snapshot:org",
640
+ "get:snapshot:force:org",
641
+ "get:snapshot:org:force"
642
642
  ],
643
643
  "permutations": [
644
- "org:create:snapshot",
645
- "create:org:snapshot",
646
- "create:snapshot:org",
647
- "org:snapshot:create",
648
- "snapshot:org:create",
649
- "snapshot:create:org"
644
+ "org:get:snapshot",
645
+ "get:org:snapshot",
646
+ "get:snapshot:org",
647
+ "org:snapshot:get",
648
+ "snapshot:org:get",
649
+ "snapshot:get:org"
650
650
  ]
651
651
  },
652
652
  "org:list:shape": {
@@ -862,5 +862,5 @@
862
862
  ]
863
863
  }
864
864
  },
865
- "version": "2.6.11"
865
+ "version": "2.6.13"
866
866
  }
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-signups",
3
3
  "description": "Commands to interact with org shapes",
4
- "version": "2.6.11",
4
+ "version": "2.6.13",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
8
  "@oclif/core": "^4",
9
9
  "@salesforce/core": "^8.8.0",
10
10
  "@salesforce/kit": "^3.2.3",
11
- "@salesforce/sf-plugins-core": "^12.1.1",
11
+ "@salesforce/sf-plugins-core": "^12.1.3",
12
12
  "change-case": "^5.4.4"
13
13
  },
14
14
  "devDependencies": {
@@ -23,7 +23,7 @@
23
23
  "chai-string": "^1.5.0",
24
24
  "eslint-plugin-sf-plugin": "^1.20.14",
25
25
  "jsforce": "^2.0.0-beta.28",
26
- "oclif": "^4.17.17",
26
+ "oclif": "^4.17.21",
27
27
  "ts-node": "^10.9.2",
28
28
  "typescript": "^5.5.4"
29
29
  },
@@ -219,7 +219,7 @@
219
219
  "exports": "./lib/index.js",
220
220
  "type": "module",
221
221
  "sfdx": {
222
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/2.6.11.crt",
223
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/2.6.11.sig"
222
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/2.6.13.crt",
223
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-signups/2.6.13.sig"
224
224
  }
225
225
  }