@salesforce/plugin-schema 2.3.33 → 3.0.1

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,17 +1,11 @@
1
1
  {
2
- "version": "2.3.33",
3
2
  "commands": {
4
3
  "sobject:describe": {
5
- "id": "sobject:describe",
6
- "summary": "Display the metadata for a standard or custom object or a Tooling API object.",
7
- "description": "The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.",
8
- "strict": true,
9
- "pluginName": "@salesforce/plugin-schema",
10
- "pluginAlias": "@salesforce/plugin-schema",
11
- "pluginType": "core",
12
4
  "aliases": [
13
5
  "force:schema:sobject:describe"
14
6
  ],
7
+ "args": {},
8
+ "description": "The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.",
15
9
  "examples": [
16
10
  "Display the metadata of the \"Account\" standard object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Account",
17
11
  "Display the metadata of the \"MyObject__c\" custom object in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org",
@@ -19,135 +13,235 @@
19
13
  ],
20
14
  "flags": {
21
15
  "json": {
22
- "name": "json",
23
- "type": "boolean",
24
16
  "description": "Format output as json.",
25
17
  "helpGroup": "GLOBAL",
26
- "allowNo": false
18
+ "name": "json",
19
+ "allowNo": false,
20
+ "type": "boolean"
27
21
  },
28
22
  "target-org": {
29
- "name": "target-org",
30
- "type": "option",
31
- "char": "o",
32
- "summary": "Username or alias of the target org.",
33
- "required": true,
34
- "multiple": false,
35
23
  "aliases": [
36
24
  "targetusername",
37
25
  "u"
38
- ]
26
+ ],
27
+ "char": "o",
28
+ "deprecateAliases": true,
29
+ "name": "target-org",
30
+ "noCacheDefault": true,
31
+ "required": true,
32
+ "summary": "Username or alias of the target org.",
33
+ "hasDynamicHelp": true,
34
+ "multiple": false,
35
+ "type": "option"
39
36
  },
40
37
  "api-version": {
41
- "name": "api-version",
42
- "type": "option",
43
- "description": "Override the api version used for api requests made by this command",
44
- "multiple": false,
45
38
  "aliases": [
46
39
  "apiversion"
47
- ]
40
+ ],
41
+ "deprecateAliases": true,
42
+ "description": "Override the api version used for api requests made by this command",
43
+ "name": "api-version",
44
+ "hasDynamicHelp": false,
45
+ "multiple": false,
46
+ "type": "option"
48
47
  },
49
48
  "loglevel": {
50
- "name": "loglevel",
51
- "type": "option",
52
- "hidden": true,
53
- "multiple": false,
54
49
  "deprecated": {
55
50
  "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."
56
- }
51
+ },
52
+ "hidden": true,
53
+ "name": "loglevel",
54
+ "hasDynamicHelp": false,
55
+ "multiple": false,
56
+ "type": "option"
57
57
  },
58
58
  "sobject": {
59
- "name": "sobject",
60
- "type": "option",
59
+ "aliases": [
60
+ "sobjecttype"
61
+ ],
61
62
  "char": "s",
62
- "summary": "API name of the object to describe.",
63
+ "name": "sobject",
63
64
  "required": true,
65
+ "summary": "API name of the object to describe.",
66
+ "hasDynamicHelp": false,
64
67
  "multiple": false,
65
- "aliases": [
66
- "sobjecttype"
67
- ]
68
+ "type": "option"
68
69
  },
69
70
  "use-tooling-api": {
70
- "name": "use-tooling-api",
71
- "type": "boolean",
71
+ "aliases": [
72
+ "usetoolingapi"
73
+ ],
72
74
  "char": "t",
75
+ "name": "use-tooling-api",
73
76
  "summary": "Use Tooling API to display metadata for Tooling API objects.",
74
77
  "allowNo": false,
75
- "aliases": [
76
- "usetoolingapi"
77
- ]
78
+ "type": "boolean"
78
79
  }
79
80
  },
80
- "args": {},
81
- "hasDynamicHelp": true
82
- },
83
- "sobject:list": {
84
- "id": "sobject:list",
85
- "summary": "List all Salesforce objects of a specified category.",
86
- "description": "You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.",
87
- "strict": true,
88
- "pluginName": "@salesforce/plugin-schema",
81
+ "hasDynamicHelp": true,
82
+ "hiddenAliases": [],
83
+ "id": "sobject:describe",
89
84
  "pluginAlias": "@salesforce/plugin-schema",
85
+ "pluginName": "@salesforce/plugin-schema",
90
86
  "pluginType": "core",
87
+ "strict": true,
88
+ "summary": "Display the metadata for a standard or custom object or a Tooling API object.",
89
+ "enableJsonFlag": true,
90
+ "SF_ENV": "SF_ENV",
91
+ "isESM": true,
92
+ "relativePath": [
93
+ "lib",
94
+ "commands",
95
+ "sobject",
96
+ "describe.js"
97
+ ],
98
+ "aliasPermutations": [
99
+ "force:schema:sobject:describe",
100
+ "schema:force:sobject:describe",
101
+ "schema:sobject:force:describe",
102
+ "schema:sobject:describe:force",
103
+ "force:sobject:schema:describe",
104
+ "sobject:force:schema:describe",
105
+ "sobject:schema:force:describe",
106
+ "sobject:schema:describe:force",
107
+ "force:sobject:describe:schema",
108
+ "sobject:force:describe:schema",
109
+ "sobject:describe:force:schema",
110
+ "sobject:describe:schema:force",
111
+ "force:schema:describe:sobject",
112
+ "schema:force:describe:sobject",
113
+ "schema:describe:force:sobject",
114
+ "schema:describe:sobject:force",
115
+ "force:describe:schema:sobject",
116
+ "describe:force:schema:sobject",
117
+ "describe:schema:force:sobject",
118
+ "describe:schema:sobject:force",
119
+ "force:describe:sobject:schema",
120
+ "describe:force:sobject:schema",
121
+ "describe:sobject:force:schema",
122
+ "describe:sobject:schema:force"
123
+ ],
124
+ "permutations": [
125
+ "sobject:describe",
126
+ "describe:sobject"
127
+ ]
128
+ },
129
+ "sobject:list": {
91
130
  "aliases": [
92
131
  "force:schema:sobject:list"
93
132
  ],
133
+ "args": {},
134
+ "description": "You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.",
94
135
  "examples": [
95
136
  "List all objects in your default org:\n<%= config.bin %> <%= command.id %> --sobject all",
96
137
  "List only custom objects in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject custom --target-org my-scratch-org"
97
138
  ],
98
139
  "flags": {
99
140
  "json": {
100
- "name": "json",
101
- "type": "boolean",
102
141
  "description": "Format output as json.",
103
142
  "helpGroup": "GLOBAL",
104
- "allowNo": false
143
+ "name": "json",
144
+ "allowNo": false,
145
+ "type": "boolean"
105
146
  },
106
147
  "target-org": {
107
- "name": "target-org",
108
- "type": "option",
109
- "char": "o",
110
- "summary": "Username or alias of the target org.",
111
- "required": true,
112
- "multiple": false,
113
148
  "aliases": [
114
149
  "targetusername",
115
150
  "u"
116
- ]
151
+ ],
152
+ "char": "o",
153
+ "deprecateAliases": true,
154
+ "name": "target-org",
155
+ "noCacheDefault": true,
156
+ "required": true,
157
+ "summary": "Username or alias of the target org.",
158
+ "hasDynamicHelp": true,
159
+ "multiple": false,
160
+ "type": "option"
117
161
  },
118
162
  "api-version": {
119
- "name": "api-version",
120
- "type": "option",
121
- "description": "Override the api version used for api requests made by this command",
122
- "multiple": false,
123
163
  "aliases": [
124
164
  "apiversion"
125
- ]
165
+ ],
166
+ "deprecateAliases": true,
167
+ "description": "Override the api version used for api requests made by this command",
168
+ "name": "api-version",
169
+ "hasDynamicHelp": false,
170
+ "multiple": false,
171
+ "type": "option"
126
172
  },
127
173
  "loglevel": {
128
- "name": "loglevel",
129
- "type": "option",
130
- "hidden": true,
131
- "multiple": false,
132
174
  "deprecated": {
133
175
  "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."
134
- }
176
+ },
177
+ "hidden": true,
178
+ "name": "loglevel",
179
+ "hasDynamicHelp": false,
180
+ "multiple": false,
181
+ "type": "option"
135
182
  },
136
183
  "sobject": {
137
- "name": "sobject",
138
- "type": "option",
139
- "char": "s",
140
- "summary": "Category of objects to list.",
141
- "multiple": false,
142
- "default": "ALL",
143
184
  "aliases": [
144
185
  "sobjecttypecategory",
145
186
  "c"
146
- ]
187
+ ],
188
+ "char": "s",
189
+ "name": "sobject",
190
+ "summary": "Category of objects to list.",
191
+ "default": "ALL",
192
+ "hasDynamicHelp": false,
193
+ "multiple": false,
194
+ "type": "option"
147
195
  }
148
196
  },
149
- "args": {},
150
- "hasDynamicHelp": true
197
+ "hasDynamicHelp": true,
198
+ "hiddenAliases": [],
199
+ "id": "sobject:list",
200
+ "pluginAlias": "@salesforce/plugin-schema",
201
+ "pluginName": "@salesforce/plugin-schema",
202
+ "pluginType": "core",
203
+ "strict": true,
204
+ "summary": "List all Salesforce objects of a specified category.",
205
+ "enableJsonFlag": true,
206
+ "SF_ENV": "SF_ENV",
207
+ "isESM": true,
208
+ "relativePath": [
209
+ "lib",
210
+ "commands",
211
+ "sobject",
212
+ "list.js"
213
+ ],
214
+ "aliasPermutations": [
215
+ "force:schema:sobject:list",
216
+ "schema:force:sobject:list",
217
+ "schema:sobject:force:list",
218
+ "schema:sobject:list:force",
219
+ "force:sobject:schema:list",
220
+ "sobject:force:schema:list",
221
+ "sobject:schema:force:list",
222
+ "sobject:schema:list:force",
223
+ "force:sobject:list:schema",
224
+ "sobject:force:list:schema",
225
+ "sobject:list:force:schema",
226
+ "sobject:list:schema:force",
227
+ "force:schema:list:sobject",
228
+ "schema:force:list:sobject",
229
+ "schema:list:force:sobject",
230
+ "schema:list:sobject:force",
231
+ "force:list:schema:sobject",
232
+ "list:force:schema:sobject",
233
+ "list:schema:force:sobject",
234
+ "list:schema:sobject:force",
235
+ "force:list:sobject:schema",
236
+ "list:force:sobject:schema",
237
+ "list:sobject:force:schema",
238
+ "list:sobject:schema:force"
239
+ ],
240
+ "permutations": [
241
+ "sobject:list",
242
+ "list:sobject"
243
+ ]
151
244
  }
152
- }
245
+ },
246
+ "version": "3.0.1"
153
247
  }
package/package.json CHANGED
@@ -1,72 +1,52 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-schema",
3
3
  "description": "Commands to interact with salesforce sobject schemas",
4
- "version": "2.3.33",
4
+ "version": "3.0.1",
5
5
  "author": "Salesforce",
6
- "main": "lib/index.js",
7
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
8
7
  "dependencies": {
9
- "@oclif/core": "^2.15.0",
8
+ "@oclif/core": "^3.10.4",
10
9
  "@salesforce/core": "^5.3.10",
11
- "@salesforce/sf-plugins-core": "^3.1.23",
12
- "tslib": "^2"
10
+ "@salesforce/sf-plugins-core": "^4.0.0"
13
11
  },
14
12
  "devDependencies": {
15
- "@oclif/plugin-command-snapshot": "^4.0.15",
16
- "@oclif/plugin-help": "^5.2.20",
17
- "@salesforce/cli-plugins-testkit": "^4.4.7",
18
- "@salesforce/dev-config": "^4.1.0",
19
- "@salesforce/dev-scripts": "^5.12.2",
20
- "@salesforce/plugin-command-reference": "^3.0.44",
21
- "@salesforce/prettier-config": "^0.0.3",
22
- "@salesforce/ts-sinon": "1.4.17",
23
- "@swc/core": "^1.3.32",
24
- "@typescript-eslint/eslint-plugin": "^5.62.0",
25
- "@typescript-eslint/parser": "^5.62.0",
26
- "chai": "^4.3.10",
27
- "eslint": "^8.52.0",
28
- "eslint-config-prettier": "^8.10.0",
29
- "eslint-config-salesforce": "^2.0.2",
30
- "eslint-config-salesforce-license": "^0.2.0",
31
- "eslint-config-salesforce-typescript": "^2.0.0",
32
- "eslint-plugin-header": "^3.1.1",
33
- "eslint-plugin-import": "2.29.0",
34
- "eslint-plugin-jsdoc": "^46.8.2",
35
- "eslint-plugin-sf-plugin": "^1.16.12",
36
- "husky": "^7.0.4",
37
- "mocha": "^9.1.3",
38
- "nyc": "^15.1.0",
39
- "oclif": "^3.17.2",
40
- "prettier": "^2.8.8",
41
- "pretty-quick": "^3.1.0",
13
+ "@oclif/plugin-command-snapshot": "^5.0.1",
14
+ "@oclif/plugin-help": "^6.0.5",
15
+ "@salesforce/cli-plugins-testkit": "^5.0.2",
16
+ "@salesforce/dev-scripts": "^6.0.3",
17
+ "@salesforce/plugin-command-reference": "^3.0.45",
18
+ "@salesforce/ts-sinon": "1.4.19",
19
+ "eslint-plugin-sf-plugin": "^1.16.14",
20
+ "oclif": "^4.0.3",
42
21
  "shx": "0.3.4",
43
- "sinon": "10.0.0",
44
- "ts-node": "^10.0.0",
45
- "typescript": "^5.2.2",
46
- "wireit": "^0.14.1"
22
+ "ts-node": "^10.9.1",
23
+ "typescript": "^5.2.2"
47
24
  },
48
25
  "config": {},
49
26
  "engines": {
50
- "node": ">=16.0.0"
27
+ "node": ">=18.0.0"
51
28
  },
52
29
  "files": [
53
30
  "/lib",
54
31
  "/messages",
55
32
  "/oclif.manifest.json",
56
- "/schemas"
33
+ "/schemas",
34
+ "/oclif.lock"
57
35
  ],
58
36
  "homepage": "https://github.com/salesforcecli/plugin-schema",
59
37
  "keywords": [
60
38
  "force",
61
39
  "salesforce",
62
- "sfdx",
63
40
  "salesforcedx",
41
+ "sf",
42
+ "sf-plugin",
43
+ "sfdx",
64
44
  "sfdx-plugin"
65
45
  ],
66
46
  "license": "BSD-3-Clause",
67
47
  "oclif": {
68
48
  "commands": "./lib/commands",
69
- "bin": "sfdx",
49
+ "bin": "sf",
70
50
  "devPlugins": [
71
51
  "@oclif/plugin-help",
72
52
  "@oclif/plugin-command-snapshot",
@@ -84,19 +64,21 @@
84
64
  }
85
65
  }
86
66
  }
87
- }
67
+ },
68
+ "flexibleTaxonomy": true,
69
+ "topicSeparator": " "
88
70
  },
89
71
  "repository": "salesforcecli/plugin-schema",
90
72
  "scripts": {
91
73
  "build": "wireit",
92
74
  "clean": "sf-clean",
93
75
  "clean-all": "sf-clean all",
94
- "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
76
+ "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json oclif.lock",
95
77
  "compile": "wireit",
96
78
  "docs": "sf-docs",
97
79
  "format": "wireit",
98
80
  "lint": "wireit",
99
- "postpack": "shx rm -f oclif.manifest.json",
81
+ "postpack": "shx rm -f oclif.manifest.json oclif.lock",
100
82
  "prepack": "sf-prepack",
101
83
  "prepare": "sf-install",
102
84
  "test": "wireit",
@@ -183,7 +165,7 @@
183
165
  "output": []
184
166
  },
185
167
  "test:command-reference": {
186
- "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
168
+ "command": "ts-node \"./bin/dev.js\" commandreference:generate --erroronwarnings",
187
169
  "files": [
188
170
  "src/**/*.ts",
189
171
  "messages/**",
@@ -194,7 +176,7 @@
194
176
  ]
195
177
  },
196
178
  "test:deprecation-policy": {
197
- "command": "\"./bin/dev\" snapshot:compare",
179
+ "command": "ts-node \"./bin/dev.js\" snapshot:compare",
198
180
  "files": [
199
181
  "src/**/*.ts"
200
182
  ],
@@ -204,7 +186,7 @@
204
186
  ]
205
187
  },
206
188
  "test:json-schema": {
207
- "command": "\"./bin/dev\" schema:compare",
189
+ "command": "ts-node \"./bin/dev.js\" schema:compare",
208
190
  "files": [
209
191
  "src/**/*.ts",
210
192
  "schemas"
@@ -212,8 +194,10 @@
212
194
  "output": []
213
195
  }
214
196
  },
197
+ "exports": "./lib/index.js",
198
+ "type": "module",
215
199
  "sfdx": {
216
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.33.crt",
217
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.3.33.sig"
200
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/3.0.1.crt",
201
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/3.0.1.sig"
218
202
  }
219
203
  }