@salesforce/plugin-sobject 1.1.21 → 1.2.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.
- package/README.md +194 -2
- package/lib/commands/schema/generate/tab.js.map +1 -1
- package/lib/shared/prompts/fields/text.js +1 -1
- package/lib/shared/prompts/fields/text.js.map +1 -1
- package/npm-shrinkwrap.json +13356 -0
- package/oclif.lock +1318 -3953
- package/oclif.manifest.json +33 -1
- package/package.json +14 -15
package/README.md
CHANGED
|
@@ -107,8 +107,200 @@ sf plugins
|
|
|
107
107
|
|
|
108
108
|
<!-- commands -->
|
|
109
109
|
|
|
110
|
-
|
|
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)
|
|
111
114
|
|
|
112
|
-
|
|
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> [--flags-dir <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
|
+
GLOBAL FLAGS
|
|
128
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
129
|
+
|
|
130
|
+
DESCRIPTION
|
|
131
|
+
Generate metadata source files for a new custom field on a specified object.
|
|
132
|
+
|
|
133
|
+
This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
|
|
134
|
+
field's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other field
|
|
135
|
+
properties, such as its API name.
|
|
136
|
+
|
|
137
|
+
You can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the
|
|
138
|
+
source files for the object must already exist in your local project before you run this command. If you create a
|
|
139
|
+
relationship field, the source files for the parent object must also exist in your local directory. Use the command
|
|
140
|
+
"sf metadata retrieve -m CustomObject:<object>" to retrieve source files for both standard and custom objects from
|
|
141
|
+
your org. To create a custom object, run the "sf generate metadata sobject" command or use the Object Manager UI in
|
|
142
|
+
your Salesforce org.
|
|
143
|
+
|
|
144
|
+
ALIASES
|
|
145
|
+
$ sf generate metadata field
|
|
146
|
+
|
|
147
|
+
EXAMPLES
|
|
148
|
+
Create a field with the specified label; the command prompts you for the object:
|
|
149
|
+
|
|
150
|
+
$ sf schema generate field --label "My Field"
|
|
151
|
+
|
|
152
|
+
Specify the local path to the object's folder:
|
|
153
|
+
|
|
154
|
+
$ sf schema generate field --label "My Field" --object force-app/main/default/objects/MyObject__c
|
|
155
|
+
|
|
156
|
+
FLAG DESCRIPTIONS
|
|
157
|
+
-o, --object=<value> The directory that contains the object's source files.
|
|
158
|
+
|
|
159
|
+
The object source files in your local project are grouped in a directoy with the same name as the object. Custom
|
|
160
|
+
object names always end in "__c". An example of the object directory for the Account standard object is
|
|
161
|
+
"force-app/main/default/objects/Account" An example custom object directory is
|
|
162
|
+
"force-app/main/default/objects/MyObject__c"
|
|
163
|
+
|
|
164
|
+
If you don't specify this flag, the command prompts you to choose from your local objects.
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
_See code: [src/commands/schema/generate/field.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.2.1/src/commands/schema/generate/field.ts)_
|
|
168
|
+
|
|
169
|
+
## `sf schema generate platformevent`
|
|
170
|
+
|
|
171
|
+
Generate metadata source files for a new platform event.
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
USAGE
|
|
175
|
+
$ sf schema generate platformevent -l <value> [--flags-dir <value>]
|
|
176
|
+
|
|
177
|
+
FLAGS
|
|
178
|
+
-l, --label=<value> (required) The platform event's label.
|
|
179
|
+
|
|
180
|
+
GLOBAL FLAGS
|
|
181
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
182
|
+
|
|
183
|
+
DESCRIPTION
|
|
184
|
+
Generate metadata source files for a new platform event.
|
|
185
|
+
|
|
186
|
+
This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
|
|
187
|
+
event's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other event
|
|
188
|
+
properties, such as its API name.
|
|
189
|
+
|
|
190
|
+
ALIASES
|
|
191
|
+
$ sf generate metadata platformevent
|
|
192
|
+
|
|
193
|
+
EXAMPLES
|
|
194
|
+
Create a platform event with the specified label:
|
|
195
|
+
|
|
196
|
+
$ sf schema generate platformevent --label "My Platform Event"
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
_See code: [src/commands/schema/generate/platformevent.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.2.1/src/commands/schema/generate/platformevent.ts)_
|
|
200
|
+
|
|
201
|
+
## `sf schema generate sobject`
|
|
202
|
+
|
|
203
|
+
Generate metadata source files for a new custom object.
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
USAGE
|
|
207
|
+
$ sf schema generate sobject -l <value> [--flags-dir <value>] [-f]
|
|
208
|
+
|
|
209
|
+
FLAGS
|
|
210
|
+
-f, --use-default-features Enable all optional features without prompting.
|
|
211
|
+
-l, --label=<value> (required) The custom object's label.
|
|
212
|
+
|
|
213
|
+
GLOBAL FLAGS
|
|
214
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
215
|
+
|
|
216
|
+
DESCRIPTION
|
|
217
|
+
Generate metadata source files for a new custom object.
|
|
218
|
+
|
|
219
|
+
This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the
|
|
220
|
+
object's label with the "--label" flag. The command uses this label to provide intelligent suggestions for other
|
|
221
|
+
object properties, such as its API name and plural label.
|
|
222
|
+
|
|
223
|
+
All Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of
|
|
224
|
+
the Name field. Run the "sf metadata generate field" command to create additional fields for the object.
|
|
225
|
+
|
|
226
|
+
To reduce the number of prompts, use the "--use-default-features" flag to automatically enable some features, such as
|
|
227
|
+
reporting and search on the object.
|
|
228
|
+
|
|
229
|
+
ALIASES
|
|
230
|
+
$ sf generate metadata sobject
|
|
231
|
+
|
|
232
|
+
EXAMPLES
|
|
233
|
+
Create a custom object with the specified label and be prompted for additional information:
|
|
234
|
+
|
|
235
|
+
$ sf schema generate sobject --label "My Object"
|
|
236
|
+
|
|
237
|
+
Create a custom object and enable optional features without prompting:
|
|
238
|
+
|
|
239
|
+
$ sf schema generate sobject --label "My Object" --use-default-features
|
|
240
|
+
|
|
241
|
+
FLAG DESCRIPTIONS
|
|
242
|
+
-f, --use-default-features Enable all optional features without prompting.
|
|
243
|
+
|
|
244
|
+
Enables these features:
|
|
245
|
+
|
|
246
|
+
- Search: Allows users to find the custom object's records when they search, including SOSL.
|
|
247
|
+
- Feeds: Enables feed tracking.
|
|
248
|
+
- Reports: Allows reporting of the data in the custom object records.
|
|
249
|
+
- History: Enables object history tracking.
|
|
250
|
+
- Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.
|
|
251
|
+
- Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.
|
|
252
|
+
- Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.
|
|
253
|
+
- Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
_See code: [src/commands/schema/generate/sobject.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.2.1/src/commands/schema/generate/sobject.ts)_
|
|
257
|
+
|
|
258
|
+
## `sf schema generate tab`
|
|
259
|
+
|
|
260
|
+
Generate the metadata source files for a new custom tab on a custom object.
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
USAGE
|
|
264
|
+
$ sf schema generate tab -o <value> -d <value> -i <value> [--json] [--flags-dir <value>]
|
|
265
|
+
|
|
266
|
+
FLAGS
|
|
267
|
+
-d, --directory=<value> (required) Path to a "tabs" directory that will contain the source files for your new tab.
|
|
268
|
+
-i, --icon=<value> (required) [default: 1] Number from 1 to 100 that specifies the color scheme and icon for the
|
|
269
|
+
custom tab.
|
|
270
|
+
-o, --object=<value> (required) API name of the custom object you're generating a tab for.
|
|
271
|
+
|
|
272
|
+
GLOBAL FLAGS
|
|
273
|
+
--flags-dir=<value> Import flag values from a directory.
|
|
274
|
+
--json Format output as json.
|
|
275
|
+
|
|
276
|
+
DESCRIPTION
|
|
277
|
+
Generate the metadata source files for a new custom tab on a custom object.
|
|
278
|
+
|
|
279
|
+
Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as
|
|
280
|
+
an item in the app’s navigation bar and in the App Launcher.
|
|
281
|
+
|
|
282
|
+
This command must be run in a Salesforce DX project directory. You must pass all required information to it with the
|
|
283
|
+
required flags. The source files for the custom object for which you're generating a tab don't need to exist in your
|
|
284
|
+
local project.
|
|
285
|
+
|
|
286
|
+
ALIASES
|
|
287
|
+
$ sf generate metadata tab
|
|
288
|
+
|
|
289
|
+
EXAMPLES
|
|
290
|
+
Create a tab on the `MyObject__c` custom object:
|
|
291
|
+
|
|
292
|
+
$ sf schema generate tab --object `MyObject__c` --icon 54 --directory force-app/main/default/tabs
|
|
293
|
+
|
|
294
|
+
FLAG DESCRIPTIONS
|
|
295
|
+
-i, --icon=<value> Number from 1 to 100 that specifies the color scheme and icon for the custom tab.
|
|
296
|
+
|
|
297
|
+
See https://lightningdesignsystem.com/icons/#custom for the available icons.
|
|
298
|
+
|
|
299
|
+
-o, --object=<value> API name of the custom object you're generating a tab for.
|
|
300
|
+
|
|
301
|
+
The API name for a custom object always ends in `__c`, such as `MyObject__c`.
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
_See code: [src/commands/schema/generate/tab.ts](https://github.com/salesforcecli/plugin-sobject/blob/1.2.1/src/commands/schema/generate/tab.ts)_
|
|
113
305
|
|
|
114
306
|
<!-- commandsstop -->
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tab.js","sourceRoot":"","sources":["../../../../src/commands/schema/generate/tab.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"tab.js","sourceRoot":"","sources":["../../../../src/commands/schema/generate/tab.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,4BAA4B,EAAE,cAAc,CAAC,CAAC;AAOrF,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,SAA4B;IAC5D,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,eAAe,GAAG,IAAI,CAAC;IACvC,MAAM,CAAU,OAAO,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACpD,MAAM,CAAU,gBAAgB,GAAG,IAAI,CAAC;IAExC,MAAM,CAAU,KAAK,GAAG;QAC7B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;YACpD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YAC5D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;SACf,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;YACzB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;SAC5C,CAAC;QACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC;YAClB,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,GAAG;YACR,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC3D,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,KAAK,CAAC,MAAM,eAAe,CAAC,CAAC;QAE3E,MAAM,GAAG,GAA6B;YACpC,YAAY,EAAE,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;SACzE,CAAC;QACF,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;QACzF,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO;YACL,GAAG;YACH,IAAI,EAAE,OAAO;SACd,CAAC;IACJ,CAAC;;AAGH,MAAM,OAAO,GAAG;IACd,oBAAoB;IACpB,uBAAuB;IACvB,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,mBAAmB;IACnB,gBAAgB;IAChB,iBAAiB;IACjB,kBAAkB;IAClB,eAAe;IACf,kBAAkB;IAClB,oBAAoB;IACpB,0BAA0B;IAC1B,oBAAoB;IACpB,kBAAkB;IAClB,eAAe;IACf,eAAe;IACf,kBAAkB;IAClB,kBAAkB;IAClB,sBAAsB;IACtB,sBAAsB;IACtB,kBAAkB;IAClB,gBAAgB;IAChB,kBAAkB;IAClB,mBAAmB;IACnB,oBAAoB;IACpB,uBAAuB;IACvB,kBAAkB;IAClB,eAAe;IACf,gBAAgB;IAChB,kBAAkB;IAClB,gBAAgB;IAChB,mBAAmB;IACnB,cAAc;IACd,gBAAgB;IAChB,gBAAgB;IAChB,iBAAiB;IACjB,iBAAiB;IACjB,kBAAkB;IAClB,kBAAkB;IAClB,iBAAiB;IACjB,mBAAmB;IACnB,mBAAmB;IACnB,gBAAgB;IAChB,sBAAsB;IACtB,mBAAmB;IACnB,wBAAwB;IACxB,2BAA2B;IAC3B,kBAAkB;IAClB,oBAAoB;IACpB,iBAAiB;IACjB,gBAAgB;IAChB,kBAAkB;IAClB,eAAe;IACf,oBAAoB;IACpB,kBAAkB;IAClB,oBAAoB;IACpB,eAAe;IACf,0BAA0B;IAC1B,sBAAsB;IACtB,gBAAgB;IAChB,sBAAsB;IACtB,wBAAwB;IACxB,eAAe;IACf,kBAAkB;IAClB,kBAAkB;IAClB,qBAAqB;IACrB,iBAAiB;IACjB,qBAAqB;IACrB,sBAAsB;IACtB,4BAA4B;IAC5B,qBAAqB;IACrB,gBAAgB;IAChB,gBAAgB;IAChB,oBAAoB;IACpB,qBAAqB;IACrB,kBAAkB;IAClB,kBAAkB;IAClB,gBAAgB;IAChB,yBAAyB;IACzB,iBAAiB;IACjB,gBAAgB;IAChB,gBAAgB;IAChB,uBAAuB;IACvB,qBAAqB;IACrB,uBAAuB;IACvB,cAAc;IACd,qBAAqB;IACrB,uBAAuB;IACvB,kBAAkB;IAClB,iBAAiB;IACjB,0BAA0B;IAC1B,mBAAmB;IACnB,kBAAkB;IAClB,iBAAiB;IACjB,0BAA0B;IAC1B,oBAAoB;IACpB,mBAAmB;IACnB,kBAAkB;CACnB,CAAC"}
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
import input from '@inquirer/input';
|
|
8
8
|
import { integerValidation } from '../functions.js';
|
|
9
|
-
const MAX_LONG_TEXT_LENGTH =
|
|
9
|
+
const MAX_LONG_TEXT_LENGTH = 131_072;
|
|
10
10
|
const MAX_TEXT_LENGTH = 255;
|
|
11
11
|
export const lengthPrompt = async (type) => type === 'Text'
|
|
12
12
|
? Number(await input({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/shared/prompts/fields/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,oBAAoB,GAAG,
|
|
1
|
+
{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/shared/prompts/fields/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,MAAM,iBAAiB,CAAC;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,oBAAoB,GAAG,OAAO,CAAC;AACrC,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,IAAY,EAA+B,EAAE,CAC9E,IAAI,KAAK,MAAM;IACb,CAAC,CAAC,MAAM,CACJ,MAAM,KAAK,CAAC;QACV,OAAO,EAAE,eAAe,eAAe,GAAG;QAC1C,OAAO,EAAE,eAAe,CAAC,QAAQ,EAAE;QACnC,QAAQ,EAAE,iBAAiB,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;KAC9D,CAAC,CACH;IACH,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,cAAc;QAC5C,CAAC,CAAC,MAAM,CACJ,MAAM,KAAK,CAAC;YACV,OAAO,EAAE,eAAe,oBAAoB,GAAG;YAC/C,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;YACxC,QAAQ,EAAE,iBAAiB,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC;SACnE,CAAC,CACH;QACH,CAAC,CAAC,SAAS,CAAC;AAEhB,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,IAAY,EAA+B,EAAE,CACnF,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,cAAc;IACxC,CAAC,CAAC,MAAM,CACJ,MAAM,KAAK,CAAC;QACV,OAAO,EAAE,eAAe;QACxB,QAAQ,EAAE,iBAAiB,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QAClD,OAAO,EAAE,GAAG;KACb,CAAC,CACH;IACH,CAAC,CAAC,SAAS,CAAC"}
|