@salesforce/plugin-custom-metadata 3.1.18 → 3.1.19

package/README.md

@@ -71,336 +71,9 @@ sfdx plugins
 
 <!-- commands -->
 
-- [`sf cmdt generate field`](#sf-cmdt-generate-field)
-- [`sf cmdt generate fromorg`](#sf-cmdt-generate-fromorg)
-- [`sf cmdt generate object`](#sf-cmdt-generate-object)
-- [`sf cmdt generate record`](#sf-cmdt-generate-record)
-- [`sf cmdt generate records`](#sf-cmdt-generate-records)
+# Command Topics
 
-## `sf cmdt generate field`
-
-Generate a field for a custom metadata type based on the provided field type.
-
-```
-USAGE
-  $ sf cmdt generate field -n <value> -f
-    Checkbox|Date|DateTime|Email|Number|Percent|Phone|Picklist|Text|TextArea|LongTextArea|Url [--json] [-p <value>] [-s
-    <value>] [-l <value>] [-d <value>]
-
-FLAGS
-  -d, --output-directory=<value>    Directory to store newly-created field definition files.
-  -f, --type=<option>               (required) Type of the field.
-                                    <options: Checkbox|Date|DateTime|Email|Number|Percent|Phone|Picklist|Text|TextArea|L
-                                    ongTextArea|Url>
-  -l, --label=<value>               Label for the field.
-  -n, --name=<value>                (required) Unique name for the field.
-  -p, --picklist-values=<value>...  Picklist values; required for picklist fields.
-  -s, --decimal-places=<value>      Number of decimal places to use for number or percent fields.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Generate a field for a custom metadata type based on the provided field type.
-
-  Similar to a custom object, a custom metadata type has a list of custom fields that represent aspects of the metadata.
-
-  This command creates a metadata file that describes the new custom metadata type field. By default, the file is
-  created in a "fields" directory in the current directory. Use the --output-directory to generate the file in the
-  directory that contains the custom metadata type metdata files, such as "force-app/main/default/objects/MyCmdt__mdt"
-  for the custom metadata type called MyCmdt.
-
-ALIASES
-  $ sf force cmdt field create
-  $ sf cmdt field create
-
-EXAMPLES
-  Generate a metadata file for a custom checkbox field and add the file to the MyCmdt__mdt/fields directory:
-
-    $ sf cmdt generate field --name MyCheckboxField --type Checkbox --output-directory \
-      force-app/main/default/objects/MyCmdt__mdt
-
-  Generate a metadata file for a custom picklist field and add a few values:
-
-    $ sf cmdt generate field --name MyPicklistField --type Picklist --picklist-values A --picklist-values B \
-      --picklist-values C --output-directory force-app/main/default/objects/MyCmdt__mdt
-
-  Generate a metadata file for a custom number field and specify 2 decimal places:
-
-    $ sf cmdt generate field --name MyNumberField --type Number --decimal-places 2 --output-directory \
-      force-app/main/default/objects/MyCmdt__mdt
-
-FLAG DESCRIPTIONS
-  -d, --output-directory=<value>  Directory to store newly-created field definition files.
-
-    New files are automatically created in the "fields" directory. The location can be an absolute path or relative to
-    the current working directory. The default is the current directory.
-
-  -f, --type=Checkbox|Date|DateTime|Email|Number|Percent|Phone|Picklist|Text|TextArea|LongTextArea|Url
-
-    Type of the field.
-
-    You can't use this command to create a custom metadata type field of type "Metadata Relationship". Use the
-    Salesforce Setup UI instead.
-
-  -s, --decimal-places=<value>  Number of decimal places to use for number or percent fields.
-
-    The value must be greater than or equal to zero. Default value is 0.
-```
-
-_See code: [src/commands/cmdt/generate/field.ts](https://github.com/salesforcecli/plugin-custom-metadata/blob/3.1.18/src/commands/cmdt/generate/field.ts)_
-
-## `sf cmdt generate fromorg`
-
-Generate a custom metadata type and all its records from a Salesforce object.
-
-```
-USAGE
-  $ sf cmdt generate fromorg -o <value> -n <value> -s <value> [--json] [--api-version <value>] [-l <value>] [-p <value>]
-    [-v PackageProtected|Protected|Public] [-i] [-d <value>] [-r <value>]
-
-FLAGS
-  -d, --type-output-directory=<value>  [default: force-app/main/default/objects] Directory to store newly-created custom
-                                       metadata type files.
-  -i, --ignore-unsupported             Ignore unsupported field types.
-  -l, --label=<value>                  Label for the custom metadata type.
-  -n, --dev-name=<value>               (required) Name of the custom metadata type.
-  -o, --target-org=<value>             (required) Username or alias of the target org. Not required if the `target-org`
-                                       configuration variable is already set.
-  -p, --plural-label=<value>           Plural version of the label value; if blank, uses label.
-  -r, --records-output-dir=<value>     [default: force-app/main/default/customMetadata] Directory to store newly-created
-                                       custom metadata record files.
-  -s, --sobject=<value>                (required) API name of the source Salesforce object used to generate the custom
-                                       metadata type.
-  -v, --visibility=<option>            [default: Public] Who can see the custom metadata type.
-                                       <options: PackageProtected|Protected|Public>
-      --api-version=<value>            Override the api version used for api requests made by this command
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Generate a custom metadata type and all its records from a Salesforce object.
-
-  Use this command to migrate existing custom objects or custom settings in an org to custom metadata types. If a field
-  of the Salesforce object is of an unsupported type, the field type is automatically converted to text. Run "sf cmdt
-  generate field --help" to see the list of supported cmdt field types, listed in the --type flag summary. Use the
-  --ignore-unsupported to ignore these fields.
-
-  This command creates the metadata files that describe the new custom metadata type and its fields in the
-  "force-app/main/default/objects/TypeName__mdt" directory by default, where "TypeName" is the value of the required
-  --dev-name flag. Use --type-output-directory to create them in a different directory.
-
-ALIASES
-  $ sf force cmdt generate
-
-EXAMPLES
-  Generate a custom metadata type from a custom object called MySourceObject__c in your default org:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --sobject MySourceObject__c
-
-  Generate a custom metadata type from a custom object in an org with alias my-scratch-org; ignore unsupported field
-  types instead of converting them to text:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --sobject MySourceObject__c --ignore-unsupported --target-org \
-      my-scratch-org
-
-  Generate a protected custom metadata type from a custom object:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --sobject MySourceObject__c --visibility Protected
-
-  Generate a protected custom metadata type from a custom setting with a specific singular and plural label:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --label "My CMDT" --plural-label "My CMDTs" --sobject \
-      MySourceSetting__c --visibility Protected
-
-  Generate a custom metadata type and put the resulting metadata files in the specified directory:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --sobject MySourceObject__c --type-output-directory \
-      path/to/my/cmdt/directory
-
-  Generate a custom metadata type and put the resulting record metadata file(s) in the specified directory:
-
-    $ sf cmdt generate fromorg --dev-name MyCMDT --sobject MySourceObject__c --records-output-dir \
-      path/to/my/cmdt/record/directory
-
-FLAG DESCRIPTIONS
-  -i, --ignore-unsupported  Ignore unsupported field types.
-
-    In this context, "ignore" means that the fields aren't created. The default behavior is to create fields of type
-    text and convert the field values to text.
-
-  -v, --visibility=PackageProtected|Protected|Public  Who can see the custom metadata type.
-
-    For more information on what each option means, see this topic in Salesforce Help:
-    https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.
-```
-
-_See code: [src/commands/cmdt/generate/fromorg.ts](https://github.com/salesforcecli/plugin-custom-metadata/blob/3.1.18/src/commands/cmdt/generate/fromorg.ts)_
-
-## `sf cmdt generate object`
-
-Generate a new custom metadata type in the current project.
-
-```
-USAGE
-  $ sf cmdt generate object -n <value> [--json] [-l <value>] [-p <value>] [-v PackageProtected|Protected|Public] [-d
-    <value>]
-
-FLAGS
-  -d, --output-directory=<value>  Directory to store the newly-created custom metadata type files
-  -l, --label=<value>             Label for the custom metadata type.
-  -n, --type-name=<value>         (required) Unique object name for the custom metadata type.
-  -p, --plural-label=<value>      Plural version of the label value; if blank, uses label.
-  -v, --visibility=<option>       [default: Public] Who can see the custom metadata type.
-                                  <options: PackageProtected|Protected|Public>
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Generate a new custom metadata type in the current project.
-
-  This command creates a metadata file that describes the new custom metadata type. By default, the file is created in
-  the MyCustomType__mdt directory in the current directory, where MyCustomType is the value of the required --type-name
-  flag. Use the --output-directory to generate the file in a package directory with other custom metadata types, such as
-  "force-app/main/default/objects".
-
-ALIASES
-  $ sf force cmdt create
-  $ sf cmdt create
-
-EXAMPLES
-  Generate a custom metadata type with developer name 'MyCustomType'; this name is also used as the label:
-
-    $ sf cmdt generate object --type-name MyCustomType
-
-  Generate a protected custom metadata type with a specific label:
-
-    $ sf cmdt generate object --type-name MyCustomType --label "Custom Type" --plural-label "Custom Types" \
-      --visibility Protected
-
-FLAG DESCRIPTIONS
-  -d, --output-directory=<value>  Directory to store the newly-created custom metadata type files
-
-    The location can be an absolute path or relative to the current working directory. The default is the current
-    directory.
-
-  -n, --type-name=<value>  Unique object name for the custom metadata type.
-
-    The name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin
-    with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
-
-  -v, --visibility=PackageProtected|Protected|Public  Who can see the custom metadata type.
-
-    For more information on what each option means, see this topic in Salesforce Help:
-    https://help.salesforce.com/s/articleView?id=sf.custommetadatatypes_ui_create.htm&type=5.
-```
-
-_See code: [src/commands/cmdt/generate/object.ts](https://github.com/salesforcecli/plugin-custom-metadata/blob/3.1.18/src/commands/cmdt/generate/object.ts)_
-
-## `sf cmdt generate record`
-
-Generate a new record for a given custom metadata type in the current project.
-
-```
-USAGE
-  $ sf cmdt generate record -t <value> -n <value> [--json] [-l <value>] [-p true|false] [-i <value>] [-d <value>]
-
-FLAGS
-  -d, --output-directory=<value>  [default: force-app/main/default/customMetadata] Directory to store newly-created
-                                  custom metadata record files.
-  -i, --input-directory=<value>   [default: force-app/main/default/objects] Directory from which to get the custom
-                                  metadata type definition from.
-  -l, --label=<value>             Label for the new record.
-  -n, --record-name=<value>       (required) Name of the new record.
-  -p, --protected=<option>        [default: false] Protect the record when it's in a managed package.
-                                  <options: true|false>
-  -t, --type-name=<value>         (required) API name of the custom metadata type to create a record for; must end in
-                                  "__mdt".
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Generate a new record for a given custom metadata type in the current project.
-
-  The custom metadata type must already exist in your project. You must specify a name for the new record. Use
-  name=value pairs to specify the values for the fields, such as MyTextField="some text here" or MyNumberField=32.
-
-ALIASES
-  $ sf force cmdt record create
-  $ sf cmdt record create
-
-EXAMPLES
-  Create a record metadata file for custom metadata type 'MyCMT' with specified values for two custom fields:
-
-    $ sf cmdt generate record --type-name MyCMT__mdt --record-name MyRecord My_Custom_Field_1=Foo \
-      My_Custom_Field_2=Bar
-
-  Create a protected record metadata file for custom metadata type 'MyCMT' with a specific label and values specified
-  for two custom fields:
-
-    $ sf cmdt generate record --type-name MyCMT__mdt --record-name MyRecord --label "My Record" --protected true \
-      My_Custom_Field_1=Foo My_Custom_Field_2=Bar
-
-FLAG DESCRIPTIONS
-  -p, --protected=true|false  Protect the record when it's in a managed package.
-
-    Protected records can only be accessed by code in the same managed package namespace.
-```
-
-_See code: [src/commands/cmdt/generate/record.ts](https://github.com/salesforcecli/plugin-custom-metadata/blob/3.1.18/src/commands/cmdt/generate/record.ts)_
-
-## `sf cmdt generate records`
-
-Generate new custom metadata type records from a CSV file.
-
-```
-USAGE
-  $ sf cmdt generate records -f <value> -t <value> [--json] [-i <value>] [-d <value>] [-n <value>]
-
-FLAGS
-  -d, --output-directory=<value>  [default: force-app/main/default/customMetadata] Directory to store newly-created
-                                  custom metadata record files.
-  -f, --csv=<value>               (required) Pathname of the CSV file.
-  -i, --input-directory=<value>   [default: force-app/main/default/objects] Directory from which to get the custom
-                                  metadata type definition from.
-  -n, --name-column=<value>       [default: Name] Column used to determine the name of the record.
-  -t, --type-name=<value>         (required) API name of the custom metadata type to create a record for.
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Generate new custom metadata type records from a CSV file.
-
-  The custom metadata type must already exist in your project. By default, the Name column is used to determine the
-  record name; use the --name-column flag to specify a different column.
-
-ALIASES
-  $ sf force cmdt record insert
-  $ sf cmdt record insert
-
-EXAMPLES
-  Generate record metadata files from values in a CSV file for the custom metadata type MyCmdt. Use 'Name' as the
-  column that specifies the record name:
-
-    $ sf cmdt generate records --csv path/to/my.csv --type-name MyCmdt
-
-  Generate record metadata files from a CSV file in the directory different from the default, and use 'PrimaryKey' as
-  the column that specifies the record name:
-
-    $ sf cmdt generate records --csv path/to/my.csv --type-name MyCmdt --input-directory path/to/my/cmdt/directory \
-      --name-column "PrimaryKey"
-
-FLAG DESCRIPTIONS
-  -t, --type-name=<value>  API name of the custom metadata type to create a record for.
-
-    The '__mdt' suffix is appended to the end of the name if it's omitted.
-```
-
-_See code: [src/commands/cmdt/generate/records.ts](https://github.com/salesforcecli/plugin-custom-metadata/blob/3.1.18/src/commands/cmdt/generate/records.ts)_
+- [`sf cmdt`](docs/cmdt.md) - Generate custom metadata types and their records.
 
 <!-- commandsstop -->
 

package/npm-shrinkwrap.json

@@ -1,15 +1,15 @@
 {
   "name": "@salesforce/plugin-custom-metadata",
-  "version": "3.1.18",
+  "version": "3.1.19",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/plugin-custom-metadata",
-      "version": "3.1.18",
+      "version": "3.1.19",
       "license": "BSD-3-Clause",
       "dependencies": {
-        "@oclif/core": "^3.19.2",
+        "@oclif/core": "^3.26.0",
         "@salesforce/core": "^6.5.1",
         "@salesforce/sf-plugins-core": "^7.1.15",
         "csv-parse": "^5.5.5",
@@ -3919,9 +3919,9 @@
       }
     },
     "node_modules/@oclif/core": {
-      "version": "3.25.2",
-      "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.25.2.tgz",
-      "integrity": "sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==",
+      "version": "3.26.0",
+      "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.26.0.tgz",
+      "integrity": "sha512-TpMdfD4tfA2tVVbd4l0PrP02o5KoUXYmudBbTC7CeguDo/GLoprw4uL8cMsaVA26+cbcy7WYtOEydQiHVtJixA==",
       "license": "MIT",
       "dependencies": {
         "@types/cli-progress": "^3.11.5",

package/oclif.lock

@@ -1778,10 +1778,10 @@
     wordwrap "^1.0.0"
     wrap-ansi "^7.0.0"
 
-"@oclif/core@^3.15.1", "@oclif/core@^3.19.2", "@oclif/core@^3.20.0", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0":
-  version "3.25.2"
-  resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.25.2.tgz#a26d56abe5686c57c1e973957777bd2ae324e973"
-  integrity sha512-OkW/cNa/3DhoCz2YlSpymVe8DXqkoRaLY4SPTVqNVzR4R1dFBE5KoCtuwKwnhxYLCRCqaViPgRnB5K26f0MnjA==
+"@oclif/core@^3.15.1", "@oclif/core@^3.19.2", "@oclif/core@^3.20.0", "@oclif/core@^3.21.0", "@oclif/core@^3.23.0", "@oclif/core@^3.26.0":
+  version "3.26.0"
+  resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.26.0.tgz#959d5e9f13f4ad6a4e98235ad125189df9ee4279"
+  integrity sha512-TpMdfD4tfA2tVVbd4l0PrP02o5KoUXYmudBbTC7CeguDo/GLoprw4uL8cMsaVA26+cbcy7WYtOEydQiHVtJixA==
   dependencies:
     "@types/cli-progress" "^3.11.5"
     ansi-escapes "^4.3.2"

package/oclif.manifest.json

@@ -810,5 +810,5 @@
       ]
     }
   },
-  "version": "3.1.18"
+  "version": "3.1.19"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-custom-metadata",
     "description": "Tools for working with custom metadata types and their records.",
-    "version": "3.1.18",
+    "version": "3.1.19",
     "contributors": [
         {
             "name": "Carolyn Grabill",
@@ -42,7 +42,7 @@
     ],
     "bugs": "https://github.com/salesforcecli/plugin-custom-metadata/issues",
     "dependencies": {
-        "@oclif/core": "^3.19.2",
+        "@oclif/core": "^3.26.0",
         "@salesforce/core": "^6.5.1",
         "@salesforce/sf-plugins-core": "^7.1.15",
         "csv-parse": "^5.5.5",
@@ -242,7 +242,7 @@
     "type": "module",
     "author": "Salesforce",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/3.1.18.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/3.1.18.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/3.1.19.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-custom-metadata/3.1.19.sig"
     }
 }