@salesforce/plugin-sobject 1.1.19 → 1.1.21

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.
package/README.md CHANGED
@@ -107,190 +107,8 @@ sf plugins
107
107
 
108
108
  <!-- commands -->
109
109
 
110
- - [`sf schema generate field`](#sf-schema-generate-field)
111
- - [`sf schema generate platformevent`](#sf-schema-generate-platformevent)
112
- - [`sf schema generate sobject`](#sf-schema-generate-sobject)
113
- - [`sf schema generate tab`](#sf-schema-generate-tab)
110
+ # Command Topics
114
111
 
115
- ## `sf schema generate field`
116
-
117
- Generate metadata source files for a new custom field on a specified object.
118
-
119
- ```
120
- USAGE
121
- $ sf schema generate field -l <value> [-o <value>]
122
-
123
- FLAGS
124
- -l, --label=<value> (required) The field's label.
125
- -o, --object=<value> The directory that contains the object's source files.
126
-
127
- DESCRIPTION
128
- Generate metadata source files for a new custom field on a specified object.
129
-
130
- This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
131
- field's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other field
132
- properties, such as its API name.
133
-
134
- You can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the
135
- source files for the object must already exist in your local project before you run this command. If you create a
136
- relationship field, the source files for the parent object must also exist in your local directory. Use the command
137
- "sf metadata retrieve -m CustomObject:<object>" to retrieve source files for both standard and custom objects from
138
- your org. To create a custom object, run the "sf generate metadata sobject" command or use the Object Manager UI in
139
- your Salesforce org.
140
-
141
- ALIASES
142
- $ sf generate metadata field
143
-
144
- EXAMPLES
145
- Create a field with the specified label; the command prompts you for the object:
146
-
147
- $ sf schema generate field --label "My Field"
148
-
149
- Specify the local path to the object's folder:
150
-
151
- $ sf schema generate field --label "My Field" --object force-app/main/default/objects/MyObject__c
152
-
153
- FLAG DESCRIPTIONS
154
- -o, --object=<value> The directory that contains the object's source files.
155
-
156
- The object source files in your local project are grouped in a directoy with the same name as the object. Custom
157
- object names always end in "__c". An example of the object directory for the Account standard object is
158
- "force-app/main/default/objects/Account" An example custom object directory is
159
- "force-app/main/default/objects/MyObject__c"
160
-
161
- If you don't specify this flag, the command prompts you to choose from your local objects.
162
- ```
163
-
164
- _See code: [src/commands/schema/generate/field.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.1.19/src/commands/schema/generate/field.ts)_
165
-
166
- ## `sf schema generate platformevent`
167
-
168
- Generate metadata source files for a new platform event.
169
-
170
- ```
171
- USAGE
172
- $ sf schema generate platformevent -l <value>
173
-
174
- FLAGS
175
- -l, --label=<value> (required) The platform event's label.
176
-
177
- DESCRIPTION
178
- Generate metadata source files for a new platform event.
179
-
180
- This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
181
- event's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other event
182
- properties, such as its API name.
183
-
184
- ALIASES
185
- $ sf generate metadata platformevent
186
-
187
- EXAMPLES
188
- Create a platform event with the specified label:
189
-
190
- $ sf schema generate platformevent --label "My Platform Event"
191
- ```
192
-
193
- _See code: [src/commands/schema/generate/platformevent.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.1.19/src/commands/schema/generate/platformevent.ts)_
194
-
195
- ## `sf schema generate sobject`
196
-
197
- Generate metadata source files for a new custom object.
198
-
199
- ```
200
- USAGE
201
- $ sf schema generate sobject -l <value> [-f]
202
-
203
- FLAGS
204
- -f, --use-default-features Enable all optional features without prompting.
205
- -l, --label=<value> (required) The custom object's label.
206
-
207
- DESCRIPTION
208
- Generate metadata source files for a new custom object.
209
-
210
- This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
211
- object's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other
212
- object properties, such as its API name and plural label.
213
-
214
- All Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of
215
- the Name field. Run the "sf metadata generate field" command to create additional fields for the object.
216
-
217
- To reduce the number of prompts, use the "--use-default-features" flag to automatically enable some features, such as
218
- reporting and search on the object.
219
-
220
- ALIASES
221
- $ sf generate metadata sobject
222
-
223
- EXAMPLES
224
- Create a custom object with the specified label and be prompted for additional information:
225
-
226
- $ sf schema generate sobject --label "My Object"
227
-
228
- Create a custom object and enable optional features without prompting:
229
-
230
- $ sf schema generate sobject --label "My Object" --use-default-features
231
-
232
- FLAG DESCRIPTIONS
233
- -f, --use-default-features Enable all optional features without prompting.
234
-
235
- Enables these features:
236
-
237
- - Search: Allows users to find the custom object's records when they search, including SOSL.
238
- - Feeds: Enables feed tracking.
239
- - Reports: Allows reporting of the data in the custom object records.
240
- - History: Enables object history tracking.
241
- - Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.
242
- - Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.
243
- - Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.
244
- - Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
245
- ```
246
-
247
- _See code: [src/commands/schema/generate/sobject.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.1.19/src/commands/schema/generate/sobject.ts)_
248
-
249
- ## `sf schema generate tab`
250
-
251
- Generate the metadata source files for a new custom tab on a custom object.
252
-
253
- ```
254
- USAGE
255
- $ sf schema generate tab -o <value> -d <value> -i <value> [--json]
256
-
257
- FLAGS
258
- -d, --directory=<value> (required) Path to a "tabs" directory that will contain the source files for your new tab.
259
- -i, --icon=<value> (required) [default: 1] Number from 1 to 100 that specifies the color scheme and icon for the
260
- custom tab.
261
- -o, --object=<value> (required) API name of the custom object you're generating a tab for.
262
-
263
- GLOBAL FLAGS
264
- --json Format output as json.
265
-
266
- DESCRIPTION
267
- Generate the metadata source files for a new custom tab on a custom object.
268
-
269
- Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as
270
- an item in the app’s navigation bar and in the App Launcher.
271
-
272
- This command must be run in a Salesforce DX project directory. You must pass all required information to it with the
273
- required flags. The source files for the custom object for which you're generating a tab don't need to exist in your
274
- local project.
275
-
276
- ALIASES
277
- $ sf generate metadata tab
278
-
279
- EXAMPLES
280
- Create a tab on the `MyObject__c` custom object:
281
-
282
- $ sf schema generate tab --object `MyObject__c` --icon 54 --directory force-app/main/default/tabs
283
-
284
- FLAG DESCRIPTIONS
285
- -i, --icon=<value> Number from 1 to 100 that specifies the color scheme and icon for the custom tab.
286
-
287
- See https://lightningdesignsystem.com/icons/#custom for the available icons.
288
-
289
- -o, --object=<value> API name of the custom object you're generating a tab for.
290
-
291
- The API name for a custom object always ends in `__c`, such as `MyObject__c`.
292
- ```
293
-
294
- _See code: [src/commands/schema/generate/tab.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.1.19/src/commands/schema/generate/tab.ts)_
112
+ - [`sf schema`](docs/schema.md) - Generate metadata files.
295
113
 
296
114
  <!-- commandsstop -->
package/oclif.lock CHANGED
@@ -1847,10 +1847,10 @@
1847
1847
  wordwrap "^1.0.0"
1848
1848
  wrap-ansi "^7.0.0"
1849
1849
 
1850
- "@oclif/core@^3.15.1", "@oclif/core@^3.19.1", "@oclif/core@^3.19.2", "@oclif/core@^3.19.6", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0":
1851
- version "3.23.0"
1852
- resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.23.0.tgz#d0ccc5f99c376e4bcfce04e8e94efae8417a53f8"
1853
- integrity sha512-giQ/8Ft8yXWg4IyPVtynPb7ihoQsa3A/1Q53UIJIhh+8k+EedE3lJ01yn6sq6Ha35IGqsG1WhkeHzlJIuldEaw==
1850
+ "@oclif/core@^3.15.1", "@oclif/core@^3.19.1", "@oclif/core@^3.19.2", "@oclif/core@^3.19.6", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0", "@oclif/core@^3.25.2":
1851
+ version "3.25.2"
1852
+ resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.25.2.tgz#a26d56abe5686c57c1e973957777bd2ae324e973"
1853
+ integrity sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==
1854
1854
  dependencies:
1855
1855
  "@types/cli-progress" "^3.11.5"
1856
1856
  ansi-escapes "^4.3.2"
@@ -2045,10 +2045,10 @@
2045
2045
  strip-ansi "6.0.1"
2046
2046
  ts-retry-promise "^0.8.0"
2047
2047
 
2048
- "@salesforce/core@^6.4.1", "@salesforce/core@^6.5.3", "@salesforce/core@^6.6.0", "@salesforce/core@^6.7.0", "@salesforce/core@^6.7.1":
2049
- version "6.7.1"
2050
- resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.7.1.tgz#4dcfb62bc3d488462ea6e9438ff092cf202c1696"
2051
- integrity sha512-SxscNdH2l+K5LmqH9XrosX+fjhPkMLN3hsG50sWQi7DbaI1Z0FGAKVOmVe6fZZsUsVNThKvZ+159IwwtxHWY6w==
2048
+ "@salesforce/core@^6.4.1", "@salesforce/core@^6.5.3", "@salesforce/core@^6.6.0", "@salesforce/core@^6.7.0", "@salesforce/core@^6.7.1", "@salesforce/core@^6.7.3":
2049
+ version "6.7.3"
2050
+ resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-6.7.3.tgz#5d8f30c40ac3cebb898c8e845fe9a067bc729268"
2051
+ integrity sha512-uU+PuZZGXxByhvnXLH1V3eY5P1caw401dIZ/QvhzYxoP/alPLk7dpChnZNJYH5Rw3dc/AhSPw+eg0cvUyjhP1Q==
2052
2052
  dependencies:
2053
2053
  "@salesforce/kit" "^3.0.15"
2054
2054
  "@salesforce/schemas" "^1.6.1"
@@ -3332,12 +3332,7 @@
3332
3332
  dependencies:
3333
3333
  "@types/node" "*"
3334
3334
 
3335
- "@types/semver@^7.5.0":
3336
- version "7.5.6"
3337
- resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.6.tgz#c65b2bfce1bec346582c07724e3f8c1017a20339"
3338
- integrity sha512-dn1l8LaMea/IjDoHNd9J52uBbInB796CDffS6VdIxvqYCPSG0V0DzHp76GpaWnlhg88uYyPbXCDIowa86ybd5A==
3339
-
3340
- "@types/semver@^7.5.8":
3335
+ "@types/semver@^7.5.0", "@types/semver@^7.5.8":
3341
3336
  version "7.5.8"
3342
3337
  resolved "https://registry.yarnpkg.com/@types/semver/-/semver-7.5.8.tgz#8268a8c57a3e4abd25c165ecd36237db7948a55e"
3343
3338
  integrity sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==
@@ -272,5 +272,5 @@
272
272
  ]
273
273
  }
274
274
  },
275
- "version": "1.1.19"
275
+ "version": "1.1.21"
276
276
  }
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-sobject",
3
3
  "description": "Create objects, fields, tabs, etc",
4
- "version": "1.1.19",
4
+ "version": "1.1.21",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
8
  "@inquirer/confirm": "^2.0.17",
9
9
  "@inquirer/input": "^1.2.16",
10
10
  "@inquirer/select": "^1.3.3",
11
- "@oclif/core": "^3.23.0",
12
- "@salesforce/core": "^6.5.3",
11
+ "@oclif/core": "^3.25.2",
12
+ "@salesforce/core": "^6.7.3",
13
13
  "@salesforce/kit": "^3.0.15",
14
14
  "@salesforce/sf-plugins-core": "^7.1.14",
15
15
  "fast-glob": "^3.3.2",
@@ -212,7 +212,7 @@
212
212
  "exports": "./lib/index.js",
213
213
  "type": "module",
214
214
  "sfdx": {
215
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/1.1.19.crt",
216
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/1.1.19.sig"
215
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/1.1.21.crt",
216
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/1.1.21.sig"
217
217
  }
218
218
  }