@salesforce/plugin-sobject 0.0.38 → 0.0.39

package/lib/commands/generate/metadata/field.d.ts

@@ -1,11 +1,11 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { CustomField } from 'jsforce/api/metadata';
 declare const supportedFieldTypesCustomObject: readonly ["AutoNumber", "Checkbox", "Currency", "DateTime", "Date", "Email", "Html", "Location", "LongTextArea", "Lookup", "MasterDetail", "Number", "Phone", "Picklist", "Text", "Time", "Url"];
-declare type SaveableCustomField = Pick<CustomField, 'label' | 'description' | 'trackHistory' | 'inlineHelpText' | 'required' | 'fullName' | 'type' | 'scale' | 'precision' | 'visibleLines' | 'length'> & {
+type SaveableCustomField = Pick<CustomField, 'label' | 'description' | 'trackHistory' | 'inlineHelpText' | 'required' | 'fullName' | 'type' | 'scale' | 'precision' | 'visibleLines' | 'length'> & {
     displayLocationInDecimal?: boolean;
     type: typeof supportedFieldTypesCustomObject[number];
 };
-export declare type FieldGenerateResult = {
+export type FieldGenerateResult = {
     field: SaveableCustomField;
     path: string;
 };

package/lib/commands/generate/metadata/platformevent.d.ts

@@ -1,6 +1,6 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { SaveablePlatformEvent } from '../../../shared/types';
-export declare type PlatformEventGenerateResult = {
+export type PlatformEventGenerateResult = {
     object: SaveablePlatformEvent;
     path: string;
 };

package/lib/commands/generate/metadata/sobject.d.ts

@@ -1,6 +1,6 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { SaveableCustomObject } from '../../../shared/types';
-export declare type CustomObjectGenerateResult = {
+export type CustomObjectGenerateResult = {
     object: SaveableCustomObject;
     path: string;
 };

package/lib/commands/generate/metadata/tab.d.ts

@@ -1,6 +1,6 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { CustomTab } from 'jsforce/api/metadata';
-export declare type GenerateTabResult = {
+export type GenerateTabResult = {
     tab: Pick<CustomTab, 'customObject' | 'motif'>;
     path: string;
 };

package/lib/shared/prompts/prompts.d.ts

@@ -2,7 +2,7 @@ import { NamedPackageDir } from '@salesforce/core';
 import { Question, ListQuestion } from 'inquirer';
 import { ValueSet } from 'jsforce/api/metadata';
 export declare const makeNameApiCompatible: (input: string) => string;
-declare type ObjectType = 'CustomObject' | 'PlatformEvent' | 'CustomField';
+type ObjectType = 'CustomObject' | 'PlatformEvent' | 'CustomField';
 export declare const directoryPrompt: (packageDirs: NamedPackageDir[]) => Promise<ListQuestion>;
 export declare const pluralPrompt: (label: string) => Question;
 export declare const apiNamePrompt: (label: string, objectType: ObjectType) => Question;

package/lib/shared/prompts/relationshipField.d.ts

@@ -1,6 +1,6 @@
 import { NamedPackageDir } from '@salesforce/core';
 import { CustomField } from 'jsforce/api/metadata';
-declare type RelationshipFieldProperties = Pick<CustomField, 'referenceTo' | 'relationshipLabel' | 'relationshipName' | 'deleteConstraint' | 'reparentableMasterDetail' | 'writeRequiresMasterRead' | 'relationshipOrder'>;
+type RelationshipFieldProperties = Pick<CustomField, 'referenceTo' | 'relationshipLabel' | 'relationshipName' | 'deleteConstraint' | 'reparentableMasterDetail' | 'writeRequiresMasterRead' | 'relationshipOrder'>;
 export declare const relationshipFieldPrompts: ({ type, packageDirs, childObjectFolderPath, }: {
     type: 'MasterDetail' | 'Lookup';
     packageDirs: NamedPackageDir[];

package/lib/shared/types.d.ts

@@ -1,25 +1,25 @@
 import { CustomObject, CustomField } from 'jsforce/api/metadata';
 /** Used to capture the types for NameField in the inquirer prompts */
-export declare type NameFieldResponse = {
+export type NameFieldResponse = {
     nameFieldType: 'Text' | 'AutoNumber';
     nameFieldLabel: 'string';
     autoNumberFormat?: string;
 };
 /** Used by classical CustomObject */
-declare type NameField = Pick<CustomField, 'label' | 'type' | 'displayFormat'>;
+type NameField = Pick<CustomField, 'label' | 'type' | 'displayFormat'>;
 /**
  * There are a lot of properties that we don't, and some that jsforce thinks are mandatory that aren't.
  * Many apply to the various sub-species (mdt, external, events)
  *
  * This type represents a PlatformEvent that can deploy.
- */ export declare type SaveablePlatformEvent = Pick<CustomObject, 'fullName' | 'label' | 'deploymentStatus' | 'description' | 'pluralLabel' | 'eventType' | 'publishBehavior'>;
+ */ export type SaveablePlatformEvent = Pick<CustomObject, 'fullName' | 'label' | 'deploymentStatus' | 'description' | 'pluralLabel' | 'eventType' | 'publishBehavior'>;
 /**
  * There are a lot of properties that we don't, and some that jsforce thinks are mandatory that aren't.
  * Many apply to the various sub-species (mdt, external, events)
  *
  * This type represents a "classical" CustomObject subset that can deploy.
  */
-export declare type SaveableCustomObject = Pick<CustomObject, 'label' | 'deploymentStatus' | 'description' | 'enableHistory' | 'enableActivities' | 'enableBulkApi' | 'enableFeeds' | 'enableReports' | 'enableSearch' | 'enableStreamingApi' | 'enableSharing' | 'pluralLabel' | 'sharingModel' | 'fullName'> & {
+export type SaveableCustomObject = Pick<CustomObject, 'label' | 'deploymentStatus' | 'description' | 'enableHistory' | 'enableActivities' | 'enableBulkApi' | 'enableFeeds' | 'enableReports' | 'enableSearch' | 'enableStreamingApi' | 'enableSharing' | 'pluralLabel' | 'sharingModel' | 'fullName'> & {
     nameField: NameField;
 };
 export {};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.0.38","commands":{"generate:metadata:field":{"id":"generate:metadata:field","summary":"Generate metadata source files for a new custom field on a specified object.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the field's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other field properties, such as its API name.\n\nYou can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the source files for the object must already exist in your local project before you run this command. If you create a relationship field, the source files for the parent object must also exist in your local directory.  Use the command \"sf metadata retrieve -m CustomObject:<object>\" to retrieve source files for both standard and custom objects from your org.  To create a custom object, run the \"sf generate metadata sobject\" command or use the Object Manager UI in your Salesforce org.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a field with the specified label; the command prompts you for the object:\n<%= config.bin %> <%= command.id %> --label \"My Field\"","Specify the local path to the object's folder:\n<%= config.bin %> <%= command.id %> --label \"My Field\" --object force-app/main/default/objects/MyObject__c"],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The field's label.","required":true,"multiple":false},"object":{"name":"object","type":"option","char":"o","summary":"The directory that contains the object's source files.","description":"The object source files in your local project are grouped in a directoy with the same name as the object. Custom object names always end in \"__c\". An example of the object directory for the Account standard object is \"force-app/main/default/objects/Account\" An example custom object directory is \"force-app/main/default/objects/MyObject__c\"\n\nIf you don't specify this flag, the command prompts you to choose from your local objects.","multiple":false}},"args":[],"requiresProject":true},"generate:metadata:platformevent":{"id":"generate:metadata:platformevent","summary":"Generate metadata source files for a new platform event.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the event's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other event properties, such as its API name.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a platform event with the specified label:\n<%= config.bin %> <%= command.id %> --label \"My Platform Event\""],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The platform event's label.","required":true,"multiple":false}},"args":[],"requiresProject":true},"generate:metadata:sobject":{"id":"generate:metadata:sobject","summary":"Generate metadata source files for a new custom object.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the object's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other object properties, such as its API name and plural label.\n\nAll Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of the Name field. Run the \"sf metadata generate field\" command to create additional fields for the object.\n\nTo reduce the number of prompts, use the \"--use-default-features\" flag to automatically enable some features, such as reporting and search on the object.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a custom object with the specified label and be prompted for additional information:\n<%= config.bin %> <%= command.id %> --label \"My Object\"","Create a custom object and enable optional features without prompting:\n<%= config.bin %> <%= command.id %> --label \"My Object\" --use-default-features"],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The custom object's label.","required":true,"multiple":false},"use-default-features":{"name":"use-default-features","type":"boolean","char":"f","summary":"Enable all optional features without prompting.","description":"Enables these features:\n\n* Search: Allows users to find the custom object's records when they search, including SOSL.\n* Feeds: Enables feed tracking.\n* Reports: Allows reporting of the data in the custom object records.\n* History: Enables object history tracking.\n* Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.\n* Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.\n* Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.\n* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.","allowNo":false}},"args":[],"requiresProject":true},"generate:metadata:tab":{"id":"generate:metadata:tab","summary":"Generate the metadata source files for a new custom tab on a custom object.","description":"Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as an item in the app’s navigation bar and in the App Launcher.\n\nThis command must be run in a Salesforce DX project directory. You must pass all required information to it with the required flags. The source files for the custom object for which you're generating a tab don't need to exist in your local project.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a tab on the MyObject__c custom object:\n<%= config.bin %> <%= command.id %> --object MyObject__c --icon 54 --directory force-app/main/default/tabs"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"object":{"name":"object","type":"option","char":"o","summary":"API name of the custom object you're generating a tab for.","description":"The API name for a custom object always ends in \"__c\", such as \"MyObject__c\".","required":true,"multiple":false},"directory":{"name":"directory","type":"option","char":"d","summary":"Path to a \"tabs\" directory that will contain the source files for your new tab.","required":true,"multiple":false},"icon":{"name":"icon","type":"option","char":"i","summary":"Number from 1 to 100 that specifies the color scheme and icon for the custom tab.","description":"See https://lightningdesignsystem.com/icons/\\#custom for the available icons.","required":true,"multiple":false,"default":1}},"args":[],"requiresProject":true}}}
+{"version":"0.0.39","commands":{"generate:metadata:field":{"id":"generate:metadata:field","summary":"Generate metadata source files for a new custom field on a specified object.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the field's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other field properties, such as its API name.\n\nYou can generate a custom field on either a standard object, such as Account, or a custom object. In both cases, the source files for the object must already exist in your local project before you run this command. If you create a relationship field, the source files for the parent object must also exist in your local directory.  Use the command \"sf metadata retrieve -m CustomObject:<object>\" to retrieve source files for both standard and custom objects from your org.  To create a custom object, run the \"sf generate metadata sobject\" command or use the Object Manager UI in your Salesforce org.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a field with the specified label; the command prompts you for the object:\n<%= config.bin %> <%= command.id %> --label \"My Field\"","Specify the local path to the object's folder:\n<%= config.bin %> <%= command.id %> --label \"My Field\" --object force-app/main/default/objects/MyObject__c"],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The field's label.","required":true,"multiple":false},"object":{"name":"object","type":"option","char":"o","summary":"The directory that contains the object's source files.","description":"The object source files in your local project are grouped in a directoy with the same name as the object. Custom object names always end in \"__c\". An example of the object directory for the Account standard object is \"force-app/main/default/objects/Account\" An example custom object directory is \"force-app/main/default/objects/MyObject__c\"\n\nIf you don't specify this flag, the command prompts you to choose from your local objects.","multiple":false}},"args":[],"requiresProject":true},"generate:metadata:platformevent":{"id":"generate:metadata:platformevent","summary":"Generate metadata source files for a new platform event.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the event's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other event properties, such as its API name.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a platform event with the specified label:\n<%= config.bin %> <%= command.id %> --label \"My Platform Event\""],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The platform event's label.","required":true,"multiple":false}},"args":[],"requiresProject":true},"generate:metadata:sobject":{"id":"generate:metadata:sobject","summary":"Generate metadata source files for a new custom object.","description":"This command is interactive and must be run in a Salesforce DX project directory. You're required to specify the object's label with the \"--label\" flag. The command uses this label to provide intelligent suggestions for other object properties, such as its API name and plural label.\n\nAll Salesforce objects are required to have a Name field, so this command also prompts you for the label and type of the Name field. Run the \"sf metadata generate field\" command to create additional fields for the object.\n\nTo reduce the number of prompts, use the \"--use-default-features\" flag to automatically enable some features, such as reporting and search on the object.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a custom object with the specified label and be prompted for additional information:\n<%= config.bin %> <%= command.id %> --label \"My Object\"","Create a custom object and enable optional features without prompting:\n<%= config.bin %> <%= command.id %> --label \"My Object\" --use-default-features"],"flags":{"label":{"name":"label","type":"option","char":"l","summary":"The custom object's label.","required":true,"multiple":false},"use-default-features":{"name":"use-default-features","type":"boolean","char":"f","summary":"Enable all optional features without prompting.","description":"Enables these features:\n\n* Search: Allows users to find the custom object's records when they search, including SOSL.\n* Feeds: Enables feed tracking.\n* Reports: Allows reporting of the data in the custom object records.\n* History: Enables object history tracking.\n* Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.\n* Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.\n* Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.\n* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.","allowNo":false}},"args":[],"requiresProject":true},"generate:metadata:tab":{"id":"generate:metadata:tab","summary":"Generate the metadata source files for a new custom tab on a custom object.","description":"Custom tabs let you display custom object data or other web content in Salesforce. Custom tabs appear in Salesforce as an item in the app’s navigation bar and in the App Launcher.\n\nThis command must be run in a Salesforce DX project directory. You must pass all required information to it with the required flags. The source files for the custom object for which you're generating a tab don't need to exist in your local project.","strict":true,"pluginName":"@salesforce/plugin-sobject","pluginAlias":"@salesforce/plugin-sobject","pluginType":"core","state":"beta","aliases":[],"examples":["Create a tab on the MyObject__c custom object:\n<%= config.bin %> <%= command.id %> --object MyObject__c --icon 54 --directory force-app/main/default/tabs"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"object":{"name":"object","type":"option","char":"o","summary":"API name of the custom object you're generating a tab for.","description":"The API name for a custom object always ends in \"__c\", such as \"MyObject__c\".","required":true,"multiple":false},"directory":{"name":"directory","type":"option","char":"d","summary":"Path to a \"tabs\" directory that will contain the source files for your new tab.","required":true,"multiple":false},"icon":{"name":"icon","type":"option","char":"i","summary":"Number from 1 to 100 that specifies the color scheme and icon for the custom tab.","description":"See https://lightningdesignsystem.com/icons/\\#custom for the available icons.","required":true,"multiple":false,"default":1}},"args":[],"requiresProject":true}}}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-sobject",
     "description": "Create objects, fields, tabs, etc",
-    "version": "0.0.38",
+    "version": "0.0.39",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
@@ -11,7 +11,7 @@
         "@salesforce/sf-plugins-core": "^1.19.0",
         "change-case": "^4.1.2",
         "fast-glob": "^3.2.12",
-        "fast-xml-parser": "^4.0.12",
+        "fast-xml-parser": "^4.0.13",
         "inquirer": "^8.2.5",
         "js2xmlparser": "^4.0.2",
         "tslib": "^2"
@@ -24,7 +24,7 @@
         "@salesforce/dev-scripts": "^3.1.0",
         "@salesforce/plugin-command-reference": "^2.2.8",
         "@salesforce/prettier-config": "^0.0.2",
-        "@salesforce/ts-sinon": "1.4.2",
+        "@salesforce/ts-sinon": "1.4.3",
         "@swc/core": "^1.3.24",
         "@types/inquirer": "^8.2.0",
         "@types/shelljs": "^0.8.11",
@@ -34,7 +34,7 @@
         "eslint": "^8.30.0",
         "eslint-config-prettier": "^8.5.0",
         "eslint-config-salesforce": "^1.1.0",
-        "eslint-config-salesforce-license": "^0.1.6",
+        "eslint-config-salesforce-license": "^0.2.0",
         "eslint-config-salesforce-typescript": "^1.1.1",
         "eslint-plugin-header": "^3.0.0",
         "eslint-plugin-import": "2.26.0",
@@ -50,7 +50,7 @@
         "shx": "0.3.4",
         "sinon": "10.0.0",
         "ts-node": "^10.9.1",
-        "typescript": "^4.8.4"
+        "typescript": "^4.9.4"
     },
     "config": {},
     "engines": {
@@ -120,7 +120,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/0.0.38.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/0.0.38.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/0.0.39.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-sobject/0.0.39.sig"
     }
 }