sf-raven 1.2.2 → 1.3.0

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.
@@ -130,15 +130,12 @@
130
130
  "display.js"
131
131
  ]
132
132
  },
133
- "raven:event:subscribe": {
133
+ "raven:deploy:cancel": {
134
134
  "aliases": [],
135
135
  "args": {},
136
- "description": "Platform Events are printed to the terminal. An optional flag can be used to relay events from a given relayid. Defaut timeout is 3 minutes, but can be extended to 30 minutes.",
136
+ "description": "Query the target org for pending or in-progress deploy requests, select one from an interactive list, confirm the cancellation, and submit an asynchronous deploy cancel request.",
137
137
  "examples": [
138
- "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e",
139
- "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --replayid 21980378",
140
- "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --timeout 10",
141
- "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --replayid 21980378 --timeout 10"
138
+ "Cancel a deploy in the default org:\n\n<%= config.bin %> <%= command.id %>\n\nCancel a deploy in a specific org:\n\n<%= config.bin %> <%= command.id %> --target-org dev"
142
139
  ],
143
140
  "flags": {
144
141
  "json": {
@@ -160,63 +157,39 @@
160
157
  "char": "o",
161
158
  "name": "target-org",
162
159
  "noCacheDefault": true,
163
- "required": true,
164
- "summary": "Login username or alias for the target org.",
160
+ "summary": "Login username or alias for the target org. Uses the default org when omitted.",
165
161
  "hasDynamicHelp": true,
166
162
  "multiple": false,
167
163
  "type": "option"
168
- },
169
- "event": {
170
- "char": "e",
171
- "name": "event",
172
- "required": true,
173
- "summary": "The name of the Platform Event that you want to subscribe with '/event/' prefix eg. /event/My_Event\\_\\_e.",
174
- "hasDynamicHelp": false,
175
- "multiple": false,
176
- "type": "option"
177
- },
178
- "replayid": {
179
- "char": "r",
180
- "name": "replayid",
181
- "summary": "The replay id to replay events from eg. 21980378.",
182
- "hasDynamicHelp": false,
183
- "multiple": false,
184
- "type": "option"
185
- },
186
- "timeout": {
187
- "char": "t",
188
- "name": "timeout",
189
- "summary": "How long to subscribe for before timing out in minutes eg. 10. Default is 3 minutes.",
190
- "default": 3,
191
- "hasDynamicHelp": false,
192
- "multiple": false,
193
- "type": "option"
194
164
  }
195
165
  },
196
166
  "hasDynamicHelp": true,
197
167
  "hiddenAliases": [],
198
- "id": "raven:event:subscribe",
168
+ "id": "raven:deploy:cancel",
199
169
  "pluginAlias": "sf-raven",
200
170
  "pluginName": "sf-raven",
201
171
  "pluginType": "core",
202
172
  "strict": true,
203
- "summary": "Subscribe to Platform Events.",
173
+ "summary": "Cancel a pending or in-progress Salesforce deploy.",
204
174
  "enableJsonFlag": true,
205
175
  "isESM": true,
206
176
  "relativePath": [
207
177
  "lib",
208
178
  "commands",
209
179
  "raven",
210
- "event",
211
- "subscribe.js"
180
+ "deploy",
181
+ "cancel.js"
212
182
  ]
213
183
  },
214
- "raven:deploy:cancel": {
184
+ "raven:event:subscribe": {
215
185
  "aliases": [],
216
186
  "args": {},
217
- "description": "Query the target org for pending or in-progress deploy requests, select one from an interactive list, confirm the cancellation, and submit an asynchronous deploy cancel request.",
187
+ "description": "Platform Events are printed to the terminal. An optional flag can be used to relay events from a given relayid. Defaut timeout is 3 minutes, but can be extended to 30 minutes.",
218
188
  "examples": [
219
- "Cancel a deploy in the default org:\n\n<%= config.bin %> <%= command.id %>\n\nCancel a deploy in a specific org:\n\n<%= config.bin %> <%= command.id %> --target-org dev"
189
+ "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e",
190
+ "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --replayid 21980378",
191
+ "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --timeout 10",
192
+ "<%= config.bin %> <%= command.id %> --target-org dev --event /event/My_Event\\_\\_e --replayid 21980378 --timeout 10"
220
193
  ],
221
194
  "flags": {
222
195
  "json": {
@@ -238,34 +211,61 @@
238
211
  "char": "o",
239
212
  "name": "target-org",
240
213
  "noCacheDefault": true,
241
- "summary": "Login username or alias for the target org. Uses the default org when omitted.",
214
+ "required": true,
215
+ "summary": "Login username or alias for the target org.",
242
216
  "hasDynamicHelp": true,
243
217
  "multiple": false,
244
218
  "type": "option"
219
+ },
220
+ "event": {
221
+ "char": "e",
222
+ "name": "event",
223
+ "required": true,
224
+ "summary": "The name of the Platform Event that you want to subscribe with '/event/' prefix eg. /event/My_Event\\_\\_e.",
225
+ "hasDynamicHelp": false,
226
+ "multiple": false,
227
+ "type": "option"
228
+ },
229
+ "replayid": {
230
+ "char": "r",
231
+ "name": "replayid",
232
+ "summary": "The replay id to replay events from eg. 21980378.",
233
+ "hasDynamicHelp": false,
234
+ "multiple": false,
235
+ "type": "option"
236
+ },
237
+ "timeout": {
238
+ "char": "t",
239
+ "name": "timeout",
240
+ "summary": "How long to subscribe for before timing out in minutes eg. 10. Default is 3 minutes.",
241
+ "default": 3,
242
+ "hasDynamicHelp": false,
243
+ "multiple": false,
244
+ "type": "option"
245
245
  }
246
246
  },
247
247
  "hasDynamicHelp": true,
248
248
  "hiddenAliases": [],
249
- "id": "raven:deploy:cancel",
249
+ "id": "raven:event:subscribe",
250
250
  "pluginAlias": "sf-raven",
251
251
  "pluginName": "sf-raven",
252
252
  "pluginType": "core",
253
253
  "strict": true,
254
- "summary": "Cancel a pending or in-progress Salesforce deploy.",
254
+ "summary": "Subscribe to Platform Events.",
255
255
  "enableJsonFlag": true,
256
256
  "isESM": true,
257
257
  "relativePath": [
258
258
  "lib",
259
259
  "commands",
260
260
  "raven",
261
- "deploy",
262
- "cancel.js"
261
+ "event",
262
+ "subscribe.js"
263
263
  ]
264
264
  },
265
265
  "raven:pull:remote": {
266
266
  "aliases": [],
267
267
  "args": {},
268
- "description": "List supported metadata components that exist in the target org but are not present in the local project. Org-only components are prefixed with a cloud marker in fzf. Press Tab to select multiple components, then Enter to retrieve them.",
268
+ "description": "Select a configured metadata type, then list components of that type that exist in the target org but are not present in the local project. Org-only components are prefixed with a cloud marker in fzf. Press Tab to select multiple components, then Enter to retrieve them.",
269
269
  "examples": [
270
270
  "Retrieve selected remote-only metadata from the default org:\n\n<%= config.bin %> <%= command.id %>\n\nRetrieve selected remote-only metadata from a specific org:\n\n<%= config.bin %> <%= command.id %> --target-org dev"
271
271
  ],
@@ -552,7 +552,148 @@
552
552
  "display",
553
553
  "recordtypes.js"
554
554
  ]
555
+ },
556
+ "raven:pull:remote:type:add": {
557
+ "aliases": [],
558
+ "args": {},
559
+ "description": "List metadata types available in the target org and select one or more to add to this project's `sf raven pull remote` configuration. Press Tab to select multiple types in fzf, then Enter to save them.",
560
+ "examples": [
561
+ "Add metadata types from the default org:\n\n<%= config.bin %> <%= command.id %>\n\nAdd metadata types from a specific org:\n\n<%= config.bin %> <%= command.id %> --target-org dev"
562
+ ],
563
+ "flags": {
564
+ "json": {
565
+ "description": "Format output as json.",
566
+ "helpGroup": "GLOBAL",
567
+ "name": "json",
568
+ "allowNo": false,
569
+ "type": "boolean"
570
+ },
571
+ "flags-dir": {
572
+ "helpGroup": "GLOBAL",
573
+ "name": "flags-dir",
574
+ "summary": "Import flag values from a directory.",
575
+ "hasDynamicHelp": false,
576
+ "multiple": false,
577
+ "type": "option"
578
+ },
579
+ "target-org": {
580
+ "char": "o",
581
+ "name": "target-org",
582
+ "required": false,
583
+ "summary": "Login username or alias for the target org. Uses the default org when omitted.",
584
+ "hasDynamicHelp": false,
585
+ "multiple": false,
586
+ "type": "option"
587
+ }
588
+ },
589
+ "hasDynamicHelp": false,
590
+ "hiddenAliases": [],
591
+ "id": "raven:pull:remote:type:add",
592
+ "pluginAlias": "sf-raven",
593
+ "pluginName": "sf-raven",
594
+ "pluginType": "core",
595
+ "strict": true,
596
+ "summary": "Add metadata types supported by remote pull.",
597
+ "enableJsonFlag": true,
598
+ "isESM": true,
599
+ "relativePath": [
600
+ "lib",
601
+ "commands",
602
+ "raven",
603
+ "pull",
604
+ "remote",
605
+ "type",
606
+ "add.js"
607
+ ]
608
+ },
609
+ "raven:pull:remote:type:list": {
610
+ "aliases": [],
611
+ "args": {},
612
+ "description": "Display the metadata types that `sf raven pull remote` can inspect. If no project configuration has been saved yet, the list is derived from metadata types already present in the local project.",
613
+ "examples": [
614
+ "List supported remote pull metadata types:\n\n<%= config.bin %> <%= command.id %>"
615
+ ],
616
+ "flags": {
617
+ "json": {
618
+ "description": "Format output as json.",
619
+ "helpGroup": "GLOBAL",
620
+ "name": "json",
621
+ "allowNo": false,
622
+ "type": "boolean"
623
+ },
624
+ "flags-dir": {
625
+ "helpGroup": "GLOBAL",
626
+ "name": "flags-dir",
627
+ "summary": "Import flag values from a directory.",
628
+ "hasDynamicHelp": false,
629
+ "multiple": false,
630
+ "type": "option"
631
+ }
632
+ },
633
+ "hasDynamicHelp": false,
634
+ "hiddenAliases": [],
635
+ "id": "raven:pull:remote:type:list",
636
+ "pluginAlias": "sf-raven",
637
+ "pluginName": "sf-raven",
638
+ "pluginType": "core",
639
+ "strict": true,
640
+ "summary": "List metadata types supported by remote pull.",
641
+ "enableJsonFlag": true,
642
+ "isESM": true,
643
+ "relativePath": [
644
+ "lib",
645
+ "commands",
646
+ "raven",
647
+ "pull",
648
+ "remote",
649
+ "type",
650
+ "list.js"
651
+ ]
652
+ },
653
+ "raven:pull:remote:type:remove": {
654
+ "aliases": [],
655
+ "args": {},
656
+ "description": "Select one or more metadata types to remove from this project's `sf raven pull remote` configuration. Press Tab to select multiple types in fzf, then Enter to save the updated list.",
657
+ "examples": [
658
+ "Remove metadata types from remote pull:\n\n<%= config.bin %> <%= command.id %>"
659
+ ],
660
+ "flags": {
661
+ "json": {
662
+ "description": "Format output as json.",
663
+ "helpGroup": "GLOBAL",
664
+ "name": "json",
665
+ "allowNo": false,
666
+ "type": "boolean"
667
+ },
668
+ "flags-dir": {
669
+ "helpGroup": "GLOBAL",
670
+ "name": "flags-dir",
671
+ "summary": "Import flag values from a directory.",
672
+ "hasDynamicHelp": false,
673
+ "multiple": false,
674
+ "type": "option"
675
+ }
676
+ },
677
+ "hasDynamicHelp": false,
678
+ "hiddenAliases": [],
679
+ "id": "raven:pull:remote:type:remove",
680
+ "pluginAlias": "sf-raven",
681
+ "pluginName": "sf-raven",
682
+ "pluginType": "core",
683
+ "strict": true,
684
+ "summary": "Remove metadata types supported by remote pull.",
685
+ "enableJsonFlag": true,
686
+ "isESM": true,
687
+ "relativePath": [
688
+ "lib",
689
+ "commands",
690
+ "raven",
691
+ "pull",
692
+ "remote",
693
+ "type",
694
+ "remove.js"
695
+ ]
555
696
  }
556
697
  },
557
- "version": "1.2.2"
698
+ "version": "1.3.0"
558
699
  }
package/package.json CHANGED
@@ -1,33 +1,46 @@
1
1
  {
2
2
  "name": "sf-raven",
3
3
  "description": "A custom sf plugin built by @tomcarman",
4
- "version": "1.2.2",
4
+ "version": "1.3.0",
5
5
  "dependencies": {
6
- "@inquirer/select": "^2.4.2",
6
+ "@inquirer/select": "2.4.2",
7
7
  "@oclif/core": "^4.0.14",
8
8
  "@salesforce/core": "^8.2.3",
9
9
  "@salesforce/kit": "^3.1.6",
10
10
  "@salesforce/sf-plugins-core": "^11.3.12",
11
+ "@salesforce/source-deploy-retrieve": "^12.36.1",
11
12
  "@salesforce/ts-types": "^2.0.10",
12
- "dayjs": "^1.11.10",
13
+ "dayjs": "^1.11.20",
13
14
  "jsforce": "^3.3.1",
14
15
  "node-emoji": "^2.1.3",
15
16
  "pinst": "^3.0.0"
16
17
  },
17
18
  "private": false,
18
19
  "devDependencies": {
19
- "@oclif/plugin-command-snapshot": "^5.2.3",
20
+ "@oclif/plugin-command-snapshot": "^5.3.21",
20
21
  "@salesforce/cli-plugins-testkit": "^5.3.58",
21
22
  "@salesforce/dev-scripts": "^10.2.4",
22
23
  "@types/js-yaml": "^4.0.9",
23
24
  "@types/node": "^20.19.41",
24
- "eslint-plugin-sf-plugin": "^1.19.1",
25
+ "eslint-plugin-sf-plugin": "^1.20.33",
25
26
  "husky": "^9.1.1",
26
27
  "oclif": "^4.23.7",
27
- "shx": "0.3.4",
28
+ "shx": "0.4.0",
28
29
  "ts-node": "^10.9.2",
29
30
  "typescript": "^5.9.3",
30
- "wireit": "^0.14.5"
31
+ "wireit": "^0.14.12"
32
+ },
33
+ "overrides": {
34
+ "linkinator": {
35
+ "glob": "12.0.0"
36
+ },
37
+ "wireit": {
38
+ "brace-expansion": "5.0.6"
39
+ }
40
+ },
41
+ "resolutions": {
42
+ "linkinator/glob": "12.0.0",
43
+ "wireit/brace-expansion": "5.0.6"
31
44
  },
32
45
  "engines": {
33
46
  "node": ">=18.0.0"
@@ -94,6 +107,30 @@
94
107
  }
95
108
  }
96
109
  },
110
+ "pull": {
111
+ "description": "Commands relating to retrieving metadata.",
112
+ "subtopics": {
113
+ "remote": {
114
+ "description": "Commands relating to retrieving metadata that exists in the org but not locally.",
115
+ "subtopics": {
116
+ "type": {
117
+ "description": "Commands relating to remote pull metadata types.",
118
+ "subtopics": {
119
+ "add": {
120
+ "description": "Add metadata types supported by remote pull."
121
+ },
122
+ "list": {
123
+ "description": "List metadata types supported by remote pull."
124
+ },
125
+ "remove": {
126
+ "description": "Remove metadata types supported by remote pull."
127
+ }
128
+ }
129
+ }
130
+ }
131
+ }
132
+ }
133
+ },
97
134
  "query": {
98
135
  "description": "Commands relating to SOQL queries.",
99
136
  "subtopics": {