@salesforce/plugin-sobject 0.0.8

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

@@ -0,0 +1,28 @@
+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';
+export declare const directoryPrompt: (packageDirs: NamedPackageDir[]) => Promise<ListQuestion>;
+export declare const pluralPrompt: (label: string) => Question;
+export declare const apiNamePrompt: (label: string, objectType: ObjectType) => Question;
+export declare const descriptionPrompt: {
+    type: string;
+    message: string;
+    name: string;
+    validate: (input: string) => true | string;
+};
+/** Ask about the name/type for the Name field, with a followup for AutoNumber format if AutoNumber is chosen  */
+export declare const namePrompts: (label: string) => Array<Question | ListQuestion>;
+/**
+ *
+ * @param packageDirs
+ * @param name The "name" property of the Inquirer answer object.  Supports use of the question for multiple scenarios
+ */
+export declare const objectPrompt: (packageDirs: NamedPackageDir[], name?: 'object' | 'referenceTo', message?: string) => Promise<ListQuestion>;
+export declare const integerValidation: (value: number, min: number, max: number) => true | string;
+/**
+ * recursively keep adding picklist values until the user says to stop
+ */
+export declare const picklistPrompts: () => Promise<Omit<ValueSet, 'valueSettings'>>;
+export {};

package/lib/shared/prompts/prompts.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.picklistPrompts = exports.integerValidation = exports.objectPrompt = exports.namePrompts = exports.descriptionPrompt = exports.apiNamePrompt = exports.pluralPrompt = exports.directoryPrompt = exports.makeNameApiCompatible = void 0;
+const inquirer_1 = require("inquirer");
+const core_1 = require("@salesforce/core");
+const fs_1 = require("../fs");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.load('@salesforce/plugin-sobject', 'prompts.shared', [
+    'directory',
+    'pluralLabel',
+    'apiName',
+    'description',
+    'nameFieldPrompts.autoNumberFormat',
+    'nameFieldPrompts.label',
+    'nameFieldPrompts.type',
+    'object',
+    'picklist.first',
+    'picklist.additional',
+    'numberValidationMin',
+    'numberValidationMax',
+    'error.noDescription',
+]);
+const makeNameApiCompatible = (input) => input.replace(/ /g, '').replace(/-/g, '_').replace(/_{2,}/g, '_');
+exports.makeNameApiCompatible = makeNameApiCompatible;
+const getSuffix = (objectType) => {
+    switch (objectType) {
+        case 'CustomObject':
+        case 'CustomField':
+            return '__c';
+        case 'PlatformEvent':
+            return '__e';
+    }
+};
+const directoryPrompt = async (packageDirs) => ({
+    type: 'list',
+    message: messages.getMessage('directory'),
+    name: 'directory',
+    choices: await (0, fs_1.getDirectoriesThatContainObjects)(packageDirs.map((pd) => pd.path)),
+});
+exports.directoryPrompt = directoryPrompt;
+const pluralPrompt = (label) => ({
+    type: 'input',
+    message: messages.getMessage('pluralLabel'),
+    name: 'pluralLabel',
+    default: `${label}s`,
+});
+exports.pluralPrompt = pluralPrompt;
+const apiNamePrompt = (label, objectType) => ({
+    type: 'input',
+    message: messages.getMessage('apiName'),
+    name: 'fullName',
+    default: `${(0, exports.makeNameApiCompatible)(label)}${getSuffix(objectType)}`,
+});
+exports.apiNamePrompt = apiNamePrompt;
+exports.descriptionPrompt = {
+    type: 'input',
+    message: messages.getMessage('description'),
+    name: 'description',
+    validate: (input) => (input.length ? true : messages.getMessage('error.noDescription')),
+};
+/** Ask about the name/type for the Name field, with a followup for AutoNumber format if AutoNumber is chosen  */
+const namePrompts = (label) => [
+    {
+        type: 'input',
+        message: messages.getMessage('nameFieldPrompts.label'),
+        name: 'nameFieldLabel',
+        default: `${label} Name`,
+    },
+    {
+        type: 'list',
+        message: messages.getMessage('nameFieldPrompts.type'),
+        name: 'nameFieldType',
+        default: 'Text',
+        choices: ['Text', 'AutoNumber'],
+    },
+    {
+        type: 'input',
+        when: (answers) => answers.nameFieldType === 'AutoNumber',
+        message: messages.getMessage('nameFieldPrompts.autoNumberFormat'),
+        name: 'autoNumberFormat',
+        default: `${label}-{0}`,
+    },
+];
+exports.namePrompts = namePrompts;
+/**
+ *
+ * @param packageDirs
+ * @param name The "name" property of the Inquirer answer object.  Supports use of the question for multiple scenarios
+ */
+const objectPrompt = async (packageDirs, name = 'object', message = messages.getMessage('object')) => ({
+    type: 'list',
+    message,
+    name,
+    choices: (await (0, fs_1.getObjectDirectories)(packageDirs.map((pd) => pd.path)))
+        .sort()
+        .map((objDir) => ({ value: objDir, name: objDir.split('/').pop() })),
+});
+exports.objectPrompt = objectPrompt;
+const integerValidation = (value, min, max) => {
+    if (value < min)
+        return messages.getMessage('numberValidationMin', [value, min]);
+    if (value > max)
+        return messages.getMessage('numberValidationMax', [value, max]);
+    return true;
+};
+exports.integerValidation = integerValidation;
+/**
+ * recursively keep adding picklist values until the user says to stop
+ */
+const picklistPrompts = async () => {
+    const output = [];
+    let keepAsking = true;
+    while (keepAsking) {
+        // the very definition of needing a loop for an await
+        // eslint-disable-next-line no-await-in-loop
+        const response = await (0, inquirer_1.prompt)({
+            type: 'input',
+            name: 'picklistValue',
+            validate: (input) => (output.find((v) => v.fullName === input) ? `${input} already exists` : true),
+            message: output.length === 0 ? messages.getMessage('picklist.first') : messages.getMessage('picklist.additional'),
+        });
+        if (response.picklistValue === undefined || response.picklistValue === '') {
+            keepAsking = false;
+        }
+        else {
+            output.push({
+                fullName: response.picklistValue,
+                label: response.picklistValue,
+                default: output.length === 0,
+            });
+        }
+    }
+    return {
+        valueSetDefinition: {
+            value: output,
+            sorted: true,
+        },
+    };
+};
+exports.picklistPrompts = picklistPrompts;
+//# sourceMappingURL=prompts.js.map

package/lib/shared/prompts/prompts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/shared/prompts/prompts.ts"],"names":[],"mappings":";;;AAOA,uCAA0D;AAE1D,2CAA4C;AAC5C,8BAA+E;AAE/E,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,gBAAgB,EAAE;IAC7E,WAAW;IACX,aAAa;IACb,SAAS;IACT,aAAa;IACb,mCAAmC;IACnC,wBAAwB;IACxB,uBAAuB;IACvB,QAAQ;IACR,gBAAgB;IAChB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;IACrB,qBAAqB;CACtB,CAAC,CAAC;AAEI,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAU,EAAE,CAC7D,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AADvD,QAAA,qBAAqB,yBACkC;AAGpE,MAAM,SAAS,GAAG,CAAC,UAAsB,EAAU,EAAE;IACnD,QAAQ,UAAU,EAAE;QAClB,KAAK,cAAc,CAAC;QACpB,KAAK,aAAa;YAChB,OAAO,KAAK,CAAC;QACf,KAAK,eAAe;YAClB,OAAO,KAAK,CAAC;KAChB;AACH,CAAC,CAAC;AACK,MAAM,eAAe,GAAG,KAAK,EAAE,WAA8B,EAAyB,EAAE,CAAC,CAAC;IAC/F,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;IACzC,IAAI,EAAE,WAAW;IACjB,OAAO,EAAE,MAAM,IAAA,qCAAgC,EAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;CAClF,CAAC,CAAC;AALU,QAAA,eAAe,mBAKzB;AAEI,MAAM,YAAY,GAAG,CAAC,KAAa,EAAY,EAAE,CAAC,CAAC;IACxD,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC;IAC3C,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,GAAG,KAAK,GAAG;CACrB,CAAC,CAAC;AALU,QAAA,YAAY,gBAKtB;AAEI,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,UAAsB,EAAY,EAAE,CAAC,CAAC;IACjF,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC;IACvC,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,GAAG,IAAA,6BAAqB,EAAC,KAAK,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,EAAE;CACnE,CAAC,CAAC;AALU,QAAA,aAAa,iBAKvB;AAEU,QAAA,iBAAiB,GAAG;IAC/B,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC;IAC3C,IAAI,EAAE,aAAa;IACnB,QAAQ,EAAE,CAAC,KAAa,EAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;CAC/G,CAAC;AAEF,iHAAiH;AAC1G,MAAM,WAAW,GAAG,CAAC,KAAa,EAAkC,EAAE,CAAC;IAC5E;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;QACtD,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,GAAG,KAAK,OAAO;KACzB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACrD,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,MAAM;QACf,OAAO,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;KAChC;IACD;QACE,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,CAAC,OAAiD,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,KAAK,YAAY;QACnG,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mCAAmC,CAAC;QACjE,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,GAAG,KAAK,MAAM;KACxB;CACF,CAAC;AArBW,QAAA,WAAW,eAqBtB;AACF;;;;GAIG;AACI,MAAM,YAAY,GAAG,KAAK,EAC/B,WAA8B,EAC9B,OAAiC,QAAQ,EACzC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,EAChB,EAAE,CAAC,CAAC;IAC3B,IAAI,EAAE,MAAM;IACZ,OAAO;IACP,IAAI;IACJ,OAAO,EAAE,CAAC,MAAM,IAAA,yBAAoB,EAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;SACpE,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;CACvE,CAAC,CAAC;AAXU,QAAA,YAAY,gBAWtB;AAEI,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAiB,EAAE;IAC1F,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,QAAQ,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACjF,IAAI,KAAK,GAAG,GAAG;QAAE,OAAO,QAAQ,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACjF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAJW,QAAA,iBAAiB,qBAI5B;AAEF;;GAEG;AAEI,MAAM,eAAe,GAAG,KAAK,IAA8C,EAAE;IAClF,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,IAAI,UAAU,GAAG,IAAI,CAAC;IAEtB,OAAO,UAAU,EAAE;QACjB,qDAAqD;QACrD,4CAA4C;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAA4B;YACvD,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,eAAe;YACrB,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1G,OAAO,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;SAClH,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,aAAa,KAAK,SAAS,IAAI,QAAQ,CAAC,aAAa,KAAK,EAAE,EAAE;YACzE,UAAU,GAAG,KAAK,CAAC;SACpB;aAAM;YACL,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,QAAQ,CAAC,aAAa;gBAChC,KAAK,EAAE,QAAQ,CAAC,aAAa;gBAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;aAC7B,CAAC,CAAC;SACJ;KACF;IAED,OAAO;QACL,kBAAkB,EAAE;YAClB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,IAAI;SACb;KACF,CAAC;AACJ,CAAC,CAAC;AA/BW,QAAA,eAAe,mBA+B1B"}

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

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

package/lib/shared/prompts/relationshipField.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.relationshipFieldPrompts = void 0;
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const path = require("path");
+const inquirer_1 = require("inquirer");
+const core_1 = require("@salesforce/core");
+const fs_1 = require("../fs");
+const prompts_1 = require("./prompts");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.load('@salesforce/plugin-sobject', 'prompts.relationship', [
+    'objectPrompt',
+    'lookupDeleteConstraint',
+    'lookupDeleteConstraint.setNull',
+    'lookupDeleteConstraint.restrict',
+    'lookupDeleteConstraint.cascade',
+    'writeRequiresMasterRead',
+    'reparentableMasterDetail',
+]);
+const relationshipFieldPrompts = async ({ type, packageDirs, childObjectFolderPath, }) => {
+    const childObjectXml = await (0, fs_1.getObjectXmlByFolderAsJson)(childObjectFolderPath);
+    const response = await (0, inquirer_1.prompt)([
+        // prompt the user to select from objects in local source
+        await (0, prompts_1.objectPrompt)(packageDirs, 'referenceTo', messages.getMessage('objectPrompt')),
+        {
+            type: 'input',
+            name: 'relationshipLabel',
+            message: 'Relationship label',
+            default: childObjectXml.pluralLabel,
+        },
+        {
+            type: 'input',
+            name: 'relationshipName',
+            message: 'Relationship name',
+            default: (answers) => (0, prompts_1.makeNameApiCompatible)(answers.relationshipLabel),
+        },
+        // lookup-only
+        {
+            type: 'list',
+            name: 'deleteConstraint',
+            message: messages.getMessage('lookupDeleteConstraint'),
+            when: type === 'Lookup',
+            default: 'SetNull',
+            choices: [
+                {
+                    value: 'SetNull',
+                    name: messages.getMessage('lookupDeleteConstraint.setNull'),
+                },
+                {
+                    value: 'Restrict',
+                    name: messages.getMessage('lookupDeleteConstraint.restrict'),
+                },
+                {
+                    value: 'Cascade',
+                    name: messages.getMessage('lookupDeleteConstraint.cascade'),
+                },
+            ],
+        },
+        // master-detail only
+        {
+            type: 'confirm',
+            name: 'reparentableMasterDetail',
+            message: messages.getMessage('reparentableMasterDetail'),
+            when: type === 'MasterDetail',
+            default: false,
+        },
+        {
+            type: 'confirm',
+            name: 'writeRequiresMasterRead',
+            message: messages.getMessage('writeRequiresMasterRead'),
+            when: type === 'MasterDetail',
+            default: false,
+        },
+    ]);
+    return {
+        ...response,
+        referenceTo: response.referenceTo.split(path.sep).pop(),
+    };
+};
+exports.relationshipFieldPrompts = relationshipFieldPrompts;
+//# sourceMappingURL=relationshipField.js.map

package/lib/shared/prompts/relationshipField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relationshipField.js","sourceRoot":"","sources":["../../../src/shared/prompts/relationshipField.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,6BAA6B;AAE7B,uCAAkC;AAElC,2CAA4C;AAC5C,8BAAmD;AACnD,uCAAgE;AAEhE,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,4BAA4B,EAAE,sBAAsB,EAAE;IACnF,cAAc;IACd,wBAAwB;IACxB,gCAAgC;IAChC,iCAAiC;IACjC,gCAAgC;IAChC,yBAAyB;IACzB,0BAA0B;CAC3B,CAAC,CAAC;AAaI,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAC7C,IAAI,EACJ,WAAW,EACX,qBAAqB,GAKtB,EAAwC,EAAE;IACzC,MAAM,cAAc,GAAG,MAAM,IAAA,+BAA0B,EAAC,qBAAqB,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,MAAM,IAAA,iBAAM,EAA8B;QACzD,yDAAyD;QACzD,MAAM,IAAA,sBAAY,EAAC,WAAW,EAAE,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACnF;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,mBAAmB;YACzB,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,cAAc,CAAC,WAAW;SACpC;QACD;YACE,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,CAAC,OAAoC,EAAE,EAAE,CAAC,IAAA,+BAAqB,EAAC,OAAO,CAAC,iBAAiB,CAAC;SACpG;QACD,cAAc;QACd;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YACtD,IAAI,EAAE,IAAI,KAAK,QAAQ;YACvB,OAAO,EAAE,SAAS;YAClB,OAAO,EAAE;gBACP;oBACE,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,gCAAgC,CAAC;iBAC5D;gBACD;oBACE,KAAK,EAAE,UAAU;oBACjB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC;iBAC7D;gBACD;oBACE,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,gCAAgC,CAAC;iBAC5D;aACF;SACF;QACD,qBAAqB;QACrB;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,0BAA0B;YAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;YACxD,IAAI,EAAE,IAAI,KAAK,cAAc;YAC7B,OAAO,EAAE,KAAK;SACf;QACD;YACE,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,yBAAyB;YAC/B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;YACvD,IAAI,EAAE,IAAI,KAAK,cAAc;YAC7B,OAAO,EAAE,KAAK;SACf;KACF,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,QAAQ;QACX,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE;KACxD,CAAC;AACJ,CAAC,CAAC;AApEW,QAAA,wBAAwB,4BAoEnC"}

package/lib/shared/types.d.ts

@@ -0,0 +1,25 @@
+import { CustomObject, CustomField } from 'jsforce/api/metadata';
+/** Used to capture the types for NameField in the inquirer prompts */
+export declare type NameFieldResponse = {
+    nameFieldType: 'Text' | 'AutoNumber';
+    nameFieldLabel: 'string';
+    autoNumberFormat?: string;
+};
+/** Used by classical CustomObject */
+declare 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'>;
+/**
+ * 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'> & {
+    nameField: NameField;
+};
+export {};

package/lib/shared/types.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/shared/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

package/messages/flags.md

@@ -0,0 +1,11 @@
+# error.labelLength
+
+Invalid label: %s. Label must be at least 2 characters.
+
+# error.objectDirectory
+
+Invalid object path: %s. Choose a folder inside a /objects/ folder in your project.
+
+# error.tabsDirectory
+
+Invalid tabs path: %s. Choose a folder ending with /tabs in your project.

package/messages/generate.event.md

@@ -0,0 +1,21 @@
+# 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.
+
+# flags.label.summary
+
+The platform event's label.
+
+# examples
+
+- Create a platform event with the specified label:
+
+  <%= config.bin %> <%= command.id %> --label "My Platform Event"
+
+# prompts.publishBehavior
+
+Do you want platform events to publish after a transaction completes, or immediately?

package/messages/generate.field.md

@@ -0,0 +1,81 @@
+# 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.
+
+You 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.
+
+# flags.label.summary
+
+The field's label.
+
+# flags.object.summary
+
+The directory that contains the object's source files.
+
+# flags.object.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"
+
+If you don't specify this flag, the command prompts you to choose from your local objects.
+
+# examples
+
+- Create a field with the specified label; the command prompts you for the object:
+
+  <%= config.bin %> <%= command.id %> --label "My Field"
+
+- Specify the local path to the object's folder:
+
+  <%= config.bin %> <%= command.id %> --label "My Field" --object force-app/main/default/objects/MyObject__c
+
+# prompts.type
+
+Field type:
+
+# prompts.startingNumber
+
+Starting number:
+
+# prompts.defaultValue
+
+Default checkbox value:
+
+# prompts.scale
+
+Number of decimal places:
+
+# prompts.precision
+
+Total number of digits, including the decimal places:
+
+# prompts.inlineHelpText
+
+Help text (the text displayed when users hover over the Info icon next to this field):
+
+# prompts.required
+
+Does this field always require a value in order to save a record? (Tip: consider using layouts instead to require a value)
+
+# prompts.externalId
+
+Should this field be set as the unique record identifier from an external system?
+
+# prompts.securityClassification
+
+Security classification (how sensitive is this field's content):
+
+# error.bigObjects
+
+This command doesn't support big objects.
+
+# error.cmdt
+
+This command doesn't support custom metadata types.
+
+# success
+
+Created %s.

package/messages/generate.object.md

@@ -0,0 +1,58 @@
+# 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.
+
+All 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.
+
+To reduce the number of prompts, use the "--use-default-features" flag to automatically enable some features, such as reporting and search on the object.
+
+# flags.label.summary
+
+The custom object's label.
+
+# flags.use-default-features.summary
+
+Enable all optional features without prompting.
+
+# flags.use-default-features.description
+
+Enables these features:
+
+* Search: Allows users to find the custom object's records when they search, including SOSL.
+* Feeds: Enables feed tracking.
+* Reports: Allows reporting of the data in the custom object records.
+* History: Enables object history tracking.
+* Activities: Allows users to associate tasks and scheduled calendar events related to the custom object records.
+* Bulk API: With Sharing and Streaming API, classifies the custom object as an Enterprise Application object.
+* Sharing: With Bulk API and Streaming API, classifies the custom object as an Enterprise Application object.
+* Streaming API: With Bulk API and Sharing, classifies the custom object as an Enterprise Application object.
+
+# examples
+
+- Create a custom object with the specified label and be prompted for additional information:
+
+  <%= config.bin %> <%= command.id %> --label "My Object"
+
+- Create a custom object and enable optional features without prompting:
+
+  <%= config.bin %> <%= command.id %> --label "My Object" --use-default-features
+
+# success
+
+Created %s.
+
+# success.advice
+
+The first time you deploy your new custom object to a source-tracking org, the org creates additional properties and sets new defaults on it. For this reason, we recommend that you immediately retrieve the custom object so your local source files are updated with this new information.
+
+# success.field
+
+Run this command to add a field to your object: sf generate metadata field --object %s --label "Your Field"
+
+# prompts.sharingModel
+
+Org-wide sharing model (default access level for the object's records):

package/messages/generate.tab.md

@@ -0,0 +1,39 @@
+# 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.
+
+This 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.
+
+# flags.object.summary
+
+API name of the custom object you're generating a tab for.
+
+# flags.object.description
+
+The API name for a custom object always ends in "__c", such as "MyObject__c".
+
+# flags.directory.summary
+
+Path to a "tabs" directory that will contain the source files for your new tab.
+
+# flags.icon.summary
+
+Number from 1 to 100 that specifies the color scheme and icon for the custom tab.
+
+# flags.icon.description
+
+See https://lightningdesignsystem.com/icons/\#custom for the available icons.
+
+# examples
+
+- Create a tab on the MyObject__c custom object:
+
+  <%= config.bin %> <%= command.id %> --object MyObject__c --icon 54 --directory force-app/main/default/tabs
+
+# success
+
+Generated a tab file at %s.

package/messages/prompts.relationship.md

@@ -0,0 +1,27 @@
+# objectPrompt
+
+What is the parent object for this relationship field?
+
+# lookupDeleteConstraint
+
+What happens to this field when the parent is deleted?
+
+# lookupDeleteConstraint.setNull
+
+Clear the value of this field.
+
+# lookupDeleteConstraint.restrict
+
+Don't allow the parent record from being deleted if there are lookup fields that refer to it.
+
+# lookupDeleteConstraint.cascade
+
+Delete the lookup record and the associated lookup fields.
+
+# writeRequiresMasterRead
+
+Allow write access if the parent is readable?
+
+# reparentableMasterDetail
+
+Allow reparenting to a different parent record?

package/messages/prompts.shared.md

@@ -0,0 +1,51 @@
+# directory
+
+Which local directory do you want to store the source files for this new object?
+
+# pluralLabel
+
+Plural label:
+
+# apiName
+
+API name (custom objects and fields must end in "__c" and platform events in "__e"):
+
+# description
+
+Description (great developers write great descriptions):  
+
+# error.noDescription
+
+Please enter a description. Your future self and others will thank you.
+
+# nameFieldPrompts.label
+
+What do you want to call the required Name field?
+
+# nameFieldPrompts.type
+
+What's the type of the required Name field?
+
+# nameFieldPrompts.autoNumberFormat
+
+Auto number format:
+
+# object
+
+Which object is this new field for?
+
+# picklist.first
+
+Enter the first picklist value, which will also be the default: 
+
+# picklist.additional
+
+Enter the next picklist value, or press RETURN to stop adding picklist values.
+
+# numberValidationMin
+
+%s is too low. Minimum value is %s.
+
+# numberValidationMax
+
+%s is too high. Maximum value is %s.

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.0.8","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,"_enableJsonFlag":false},"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,"_enableJsonFlag":false},"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,"_enableJsonFlag":false},"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}}}