@salesforce/plugin-schema 2.1.19 → 2.2.0

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2022, Salesforce.com, Inc.
+Copyright (c) 2023, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/commands/sobject/describe.d.ts

@@ -0,0 +1,16 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+import { DescribeSObjectResult } from 'jsforce';
+export declare class SObjectDescribe extends SfCommand<DescribeSObjectResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly aliases: string[];
+    static flags: {
+        'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+        'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        sobject: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        'use-tooling-api': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<DescribeSObjectResult>;
+}

package/lib/commands/sobject/describe.js

@@ -0,0 +1,46 @@
+"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 });
+exports.SObjectDescribe = void 0;
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-schema', 'describe');
+class SObjectDescribe extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(SObjectDescribe);
+        const conn = flags['target-org'].getConnection(flags['api-version']);
+        const description = flags['use-tooling-api']
+            ? await conn.tooling.describe(flags.sobject)
+            : await conn.describe(flags.sobject);
+        this.styledJSON(description);
+        return description;
+    }
+}
+exports.SObjectDescribe = SObjectDescribe;
+SObjectDescribe.summary = messages.getMessage('summary');
+SObjectDescribe.description = messages.getMessage('description');
+SObjectDescribe.examples = messages.getMessages('examples');
+SObjectDescribe.aliases = ['force:schema:sobject:describe'];
+SObjectDescribe.flags = {
+    'target-org': sf_plugins_core_1.requiredOrgFlagWithDeprecations,
+    'api-version': sf_plugins_core_1.orgApiVersionFlagWithDeprecations,
+    loglevel: sf_plugins_core_1.loglevel,
+    sobject: sf_plugins_core_1.Flags.string({
+        char: 's',
+        required: true,
+        summary: messages.getMessage('flags.sobject.summary'),
+        aliases: ['sobjecttype'],
+    }),
+    'use-tooling-api': sf_plugins_core_1.Flags.boolean({
+        char: 't',
+        summary: messages.getMessage('flags.tooling-api.summary'),
+        aliases: ['usetoolingapi'],
+    }),
+};
+//# sourceMappingURL=describe.js.map

package/lib/commands/sobject/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../../src/commands/sobject/describe.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,iEAMqC;AAErC,2CAA4C;AAG5C,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC;AAEhF,MAAa,eAAgB,SAAQ,2BAAgC;IAsB5D,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAErE,MAAM,WAAW,GAAG,KAAK,CAAC,iBAAiB,CAAC;YAC1C,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;YAC5C,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvC,IAAI,CAAC,UAAU,CAAC,WAAsB,CAAC,CAAC;QAExC,OAAO,WAAW,CAAC;IACrB,CAAC;;AAjCH,0CAkCC;AAjCwB,uBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,2BAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,wBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAC5C,uBAAO,GAAG,CAAC,+BAA+B,CAAC,CAAC;AACrD,qBAAK,GAAG;IACpB,YAAY,EAAE,iDAA+B;IAC7C,aAAa,EAAE,mDAAiC;IAChD,QAAQ,EAAR,0BAAQ;IACR,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACrD,OAAO,EAAE,CAAC,aAAa,CAAC;KACzB,CAAC;IACF,iBAAiB,EAAE,uBAAK,CAAC,OAAO,CAAC;QAC/B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;QACzD,OAAO,EAAE,CAAC,eAAe,CAAC;KAC3B,CAAC;CACH,CAAC"}

package/lib/commands/sobject/list.d.ts

@@ -0,0 +1,20 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export declare enum SObjectType {
+    ALL = 0,
+    STANDARD = 1,
+    CUSTOM = 2
+}
+export type SObjectListResult = string[];
+export declare class SObjectList extends SfCommand<SObjectListResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly aliases: string[];
+    static flags: {
+        'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+        'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        sobject: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+    };
+    run(): Promise<SObjectListResult>;
+}

package/lib/commands/sobject/list.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SObjectList = exports.SObjectType = 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 os = require("node:os");
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-schema', 'list');
+var SObjectType;
+(function (SObjectType) {
+    SObjectType[SObjectType["ALL"] = 0] = "ALL";
+    SObjectType[SObjectType["STANDARD"] = 1] = "STANDARD";
+    SObjectType[SObjectType["CUSTOM"] = 2] = "CUSTOM";
+})(SObjectType = exports.SObjectType || (exports.SObjectType = {}));
+class SObjectList extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(SObjectList);
+        const category = flags.sobject.toUpperCase();
+        const type = SObjectType[category];
+        const allDescriptions = await flags['target-org'].getConnection(flags['api-version']).describeGlobal();
+        const sobjects = allDescriptions.sobjects
+            .filter((sobject) => {
+            const isCustom = sobject.custom;
+            return (type === SObjectType.ALL ||
+                (type === SObjectType.CUSTOM && isCustom) ||
+                (type === SObjectType.STANDARD && !isCustom));
+        })
+            .map((sobject) => sobject.name);
+        if (sobjects.length) {
+            this.log(sobjects.join(os.EOL));
+        }
+        else {
+            this.log(messages.getMessage('noTypeFound', [SObjectType[type]]));
+        }
+        return sobjects;
+    }
+}
+exports.SObjectList = SObjectList;
+SObjectList.summary = messages.getMessage('summary');
+SObjectList.description = messages.getMessage('description');
+SObjectList.examples = messages.getMessages('examples');
+SObjectList.aliases = ['force:schema:sobject:list'];
+SObjectList.flags = {
+    'target-org': sf_plugins_core_1.requiredOrgFlagWithDeprecations,
+    'api-version': sf_plugins_core_1.orgApiVersionFlagWithDeprecations,
+    loglevel: sf_plugins_core_1.loglevel,
+    sobject: sf_plugins_core_1.Flags.string({
+        char: 's',
+        default: 'ALL',
+        summary: messages.getMessage('flags.sobject.summary'),
+        aliases: ['sobjecttypecategory', 'c'],
+        parse: (val) => {
+            const lowercasedType = val.toLowerCase();
+            if (!['all', 'standard', 'custom'].includes(lowercasedType)) {
+                throw messages.createError('invalid-sobject-type');
+            }
+            return Promise.resolve(lowercasedType);
+        },
+    }),
+};
+//# sourceMappingURL=list.js.map

package/lib/commands/sobject/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../src/commands/sobject/list.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,8BAA8B;AAC9B,iEAMqC;AACrC,2CAA4C;AAE5C,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;AAE5E,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,2CAAG,CAAA;IACH,qDAAQ,CAAA;IACR,iDAAM,CAAA;AACR,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAID,MAAa,WAAY,SAAQ,2BAA4B;IAwBpD,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAA8B,CAAC;QACzE,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEnC,MAAM,eAAe,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,cAAc,EAAE,CAAC;QAEvG,MAAM,QAAQ,GAAG,eAAe,CAAC,QAAQ;aACtC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YAClB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;YAChC,OAAO,CACL,IAAI,KAAK,WAAW,CAAC,GAAG;gBACxB,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,IAAI,QAAQ,CAAC;gBACzC,CAAC,IAAI,KAAK,WAAW,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,CAC7C,CAAC;QACJ,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,QAAQ,CAAC,MAAM,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;SACjC;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACnE;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;;AAlDH,kCAmDC;AAlDwB,mBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,uBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,oBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAC5C,mBAAO,GAAG,CAAC,2BAA2B,CAAC,CAAC;AACjD,iBAAK,GAAG;IACpB,YAAY,EAAE,iDAA+B;IAC7C,aAAa,EAAE,mDAAiC;IAChD,QAAQ,EAAR,0BAAQ;IACR,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACrD,OAAO,EAAE,CAAC,qBAAqB,EAAE,GAAG,CAAC;QACrC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,cAAc,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;YACzC,IAAI,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBAC3D,MAAM,QAAQ,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;aACpD;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACzC,CAAC;KACF,CAAC;CACH,CAAC"}

package/messages/describe.md

@@ -0,0 +1,31 @@
+# summary
+
+Display the metadata for a standard or custom object or a Tooling API object.
+
+# description
+
+The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.
+
+This command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.
+
+# examples
+
+- Display the metadata of the "Account" standard object in your default org:
+
+  <%= config.bin %> <%= command.id %> --sobject Account
+
+- Display the metadata of the "MyObject__c" custom object in the org with alias "my-scratch-org":
+
+  <%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org
+
+- Display the metadata of the ApexCodeCoverage Tooling API object in your default org:
+
+  <%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api
+
+# flags.sobject.summary
+
+API name of the object to describe.
+
+# flags.tooling-api.summary
+
+Use Tooling API to display metadata for Tooling API objects.

package/messages/list.md

@@ -0,0 +1,29 @@
+# summary
+
+List all Salesforce objects of a specified category.
+
+# description
+
+You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.
+
+# examples
+
+- List all objects in your default org:
+
+  <%= config.bin %> <%= command.id %> --sobject all
+
+- List only custom objects in the org with alias "my-scratch-org":
+
+  <%= config.bin %> <%= command.id %> --sobject custom --target-org my-scratch-org
+
+# flags.sobject.summary
+
+Category of objects to list.
+
+# invalid-sobject-type
+
+"--sobject" flag can be set only to <all|custom|standard>."
+
+# noTypeFound
+
+No %s objects found.

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.19","commands":{"force:schema:sobject:describe":{"id":"force:schema:sobject:describe","description":"displays the metadata for a standard or custom object","strict":true,"usage":"<%= command.id %> -s <string> [-t] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":[],"examples":["$ sfdx force:schema:sobject:describe -s Account","$ sfdx force:schema:sobject:describe -s MyObject__c","$ sfdx force:schema:sobject:describe -s ApexClass -t"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"the API name of the object to describe","required":true,"multiple":false},"usetoolingapi":{"name":"usetoolingapi","type":"boolean","char":"t","description":"execute with Tooling API","allowNo":false}},"args":[],"flagsConfig":{"sobjecttype":{"kind":"string","char":"s","required":true,"description":"the API name of the object to describe","input":[],"multiple":false,"type":"option"},"usetoolingapi":{"kind":"boolean","char":"t","description":"execute with Tooling API","allowNo":false,"type":"boolean"}},"requiresUsername":true},"force:schema:sobject:list":{"id":"force:schema:sobject:list","description":"list all objects of a specified category","strict":true,"usage":"<%= command.id %> [-c <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":[],"examples":["$ sfdx force:schema:sobject:list -c all","$ sfdx force:schema:sobject:list -c custom","$ sfdx force:schema:sobject:list -c standard"],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"targetusername":{"name":"targetusername","type":"option","char":"u","description":"username or alias for the target org; overrides default target org","multiple":false},"apiversion":{"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command","multiple":false},"sobjecttypecategory":{"name":"sobjecttypecategory","type":"option","char":"c","description":"the type of objects to list (all|custom|standard)","multiple":false,"default":"ALL"}},"args":[],"flagsConfig":{"sobjecttypecategory":{"kind":"string","char":"c","default":"ALL","description":"the type of objects to list (all|custom|standard)","input":[],"multiple":false,"type":"option"}},"requiresUsername":true}}}
+{"version":"2.2.0","commands":{"sobject:describe":{"id":"sobject:describe","summary":"Display the metadata for a standard or custom object or a Tooling API object.","description":"The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:describe"],"examples":["Display the metadata of the \"Account\" standard object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Account","Display the metadata of the \"MyObject__c\" custom object in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org","Display the metadata of the ApexCodeCoverage Tooling API object in your default org:\n<%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the object to describe.","required":true,"multiple":false,"aliases":["sobjecttype"]},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API to display metadata for Tooling API objects.","allowNo":false,"aliases":["usetoolingapi"]}},"args":[],"hasDynamicHelp":true},"sobject:list":{"id":"sobject:list","summary":"List all Salesforce objects of a specified category.","description":"You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:list"],"examples":["List all objects in your default org:\n<%= config.bin %> <%= command.id %> --sobject all","List only custom objects in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject custom --target-org my-scratch-org"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"Category of objects to list.","multiple":false,"default":"ALL","aliases":["sobjecttypecategory","c"]}},"args":[],"hasDynamicHelp":true}}}

package/package.json

@@ -1,29 +1,30 @@
 {
     "name": "@salesforce/plugin-schema",
     "description": "Commands to interact with salesforce sobject schemas",
-    "version": "2.1.19",
+    "version": "2.2.0",
     "author": "Salesforce",
     "main": "lib/index.js",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
-        "@oclif/core": "^1.21.0",
-        "@salesforce/command": "^5.2.25",
-        "@salesforce/core": "^3.32.6",
+        "@oclif/core": "^1.20.4",
+        "@salesforce/core": "^3.32.8",
+        "@salesforce/sf-plugins-core": "^1.19.2",
         "tslib": "^2"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^3.2.11",
-        "@salesforce/cli-plugins-testkit": "^3.2.9",
+        "@oclif/plugin-command-snapshot": "^3.2.16",
+        "@oclif/plugin-help": "^5.1.22",
+        "@salesforce/cli-plugins-testkit": "^3.2.15",
         "@salesforce/dev-config": "^3.0.1",
         "@salesforce/dev-scripts": "^3.1.0",
-        "@salesforce/plugin-command-reference": "^1.5.3",
+        "@salesforce/plugin-command-reference": "^2.2.8",
         "@salesforce/prettier-config": "^0.0.2",
         "@salesforce/ts-sinon": "1.4.2",
-        "@swc/core": "^1.3.20",
+        "@swc/core": "^1.3.24",
         "@typescript-eslint/eslint-plugin": "^5.42.1",
-        "@typescript-eslint/parser": "^5.45.0",
+        "@typescript-eslint/parser": "^5.47.0",
         "chai": "^4.3.7",
-        "eslint": "^8.29.0",
+        "eslint": "^8.30.0",
         "eslint-config-prettier": "^8.5.0",
         "eslint-config-salesforce": "^1.1.0",
         "eslint-config-salesforce-license": "^0.1.6",
@@ -31,10 +32,11 @@
         "eslint-plugin-header": "^3.0.0",
         "eslint-plugin-import": "2.26.0",
         "eslint-plugin-jsdoc": "^39.6.4",
+        "eslint-plugin-sf-plugin": "^1.1.5",
         "husky": "^7.0.4",
         "mocha": "^9.1.3",
         "nyc": "^15.1.0",
-        "oclif": "^3.3.0",
+        "oclif": "^3.4.3",
         "prettier": "^2.8.1",
         "pretty-quick": "^3.1.0",
         "shx": "0.3.4",
@@ -69,17 +71,14 @@
             "@salesforce/plugin-command-reference"
         ],
         "topics": {
-            "force": {
-                "external": true,
+            "sobject": {
+                "description": "Commands to interact with Salesforce objects.",
                 "subtopics": {
-                    "schema": {
-                        "description": "List metadata types in your Salesforce org using the CLI",
-                        "longDescription": "Use the schema commands to to list metadata types within your Salesforce org using the Salesforce CLI.",
-                        "subtopics": {
-                            "sobject": {
-                                "description": "list standard object metadata types"
-                            }
-                        }
+                    "list": {
+                        "description": "List all Salesforce objects of a specified category."
+                    },
+                    "describe": {
+                        "description": "Displays the metadata for a standard or custom object."
                     }
                 }
             }
@@ -110,7 +109,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.1.19.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.1.19.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.0.sig"
     }
 }

package/lib/commands/force/schema/sobject/describe.d.ts

@@ -1,9 +0,0 @@
-import { FlagsConfig, SfdxCommand } from '@salesforce/command';
-import { DescribeSObjectResult } from 'jsforce';
-export declare class SchemaSObjectDescribe extends SfdxCommand {
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly flagsConfig: FlagsConfig;
-    static readonly requiresUsername = true;
-    run(): Promise<DescribeSObjectResult>;
-}

package/lib/commands/force/schema/sobject/describe.js

@@ -1,42 +0,0 @@
-"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 });
-exports.SchemaSObjectDescribe = void 0;
-const os = require("os");
-const command_1 = require("@salesforce/command");
-const core_1 = require("@salesforce/core");
-core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/plugin-schema', 'describe');
-class SchemaSObjectDescribe extends command_1.SfdxCommand {
-    async run() {
-        const conn = this.org.getConnection();
-        const description = this.flags.usetoolingapi
-            ? await conn.tooling.describe(this.flags.sobjecttype)
-            : await conn.describe(this.flags.sobjecttype);
-        if (!this.flags.json) {
-            this.ux.logJson(description);
-        }
-        return description;
-    }
-}
-exports.SchemaSObjectDescribe = SchemaSObjectDescribe;
-SchemaSObjectDescribe.description = messages.getMessage('description');
-SchemaSObjectDescribe.examples = messages.getMessage('examples').split(os.EOL);
-SchemaSObjectDescribe.flagsConfig = {
-    sobjecttype: command_1.flags.string({
-        char: 's',
-        required: true,
-        description: messages.getMessage('flags.objectType'),
-    }),
-    usetoolingapi: command_1.flags.boolean({
-        char: 't',
-        description: messages.getMessage('flags.useTooling'),
-    }),
-};
-SchemaSObjectDescribe.requiresUsername = true;
-//# sourceMappingURL=describe.js.map

package/lib/commands/force/schema/sobject/describe.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../../../../src/commands/force/schema/sobject/describe.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yBAAyB;AACzB,iDAAsE;AACtE,2CAAwD;AAGxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC;AAEhF,MAAa,qBAAsB,SAAQ,qBAAW;IAgB7C,KAAK,CAAC,GAAG;QACd,MAAM,IAAI,GAAe,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAClD,MAAM,WAAW,GAA0B,IAAI,CAAC,KAAK,CAAC,aAAa;YACjE,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAqB,CAAC;YAC/D,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAqB,CAAC,CAAC;QAE1D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACpB,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC9B;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;;AA3BH,sDA4BC;AA3BwB,iCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,8BAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AACzD,iCAAW,GAAgB;IAChD,WAAW,EAAE,eAAK,CAAC,MAAM,CAAC;QACxB,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;KACrD,CAAC;IACF,aAAa,EAAE,eAAK,CAAC,OAAO,CAAC;QAC3B,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;KACrD,CAAC;CACH,CAAC;AAEqB,sCAAgB,GAAG,IAAI,CAAC"}

package/lib/commands/force/schema/sobject/list.d.ts

@@ -1,13 +0,0 @@
-import { FlagsConfig, SfdxCommand } from '@salesforce/command';
-export declare enum SObjectType {
-    ALL = 0,
-    STANDARD = 1,
-    CUSTOM = 2
-}
-export declare class SchemaSobjectList extends SfdxCommand {
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly flagsConfig: FlagsConfig;
-    static readonly requiresUsername = true;
-    run(): Promise<string[]>;
-}

package/lib/commands/force/schema/sobject/list.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaSobjectList = exports.SObjectType = 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 os_1 = require("os");
-const command_1 = require("@salesforce/command");
-const core_1 = require("@salesforce/core");
-core_1.Messages.importMessagesDirectory(__dirname);
-const messages = core_1.Messages.loadMessages('@salesforce/plugin-schema', 'list');
-// eslint-disable-next-line no-shadow
-var SObjectType;
-(function (SObjectType) {
-    SObjectType[SObjectType["ALL"] = 0] = "ALL";
-    SObjectType[SObjectType["STANDARD"] = 1] = "STANDARD";
-    SObjectType[SObjectType["CUSTOM"] = 2] = "CUSTOM";
-})(SObjectType = exports.SObjectType || (exports.SObjectType = {}));
-class SchemaSobjectList extends command_1.SfdxCommand {
-    async run() {
-        const category = this.flags.sobjecttypecategory.toUpperCase();
-        const type = SObjectType[category];
-        const typeDescriptions = [];
-        const conn = this.org.getConnection();
-        const allDescriptions = await conn.describeGlobal();
-        let havePrinted = false;
-        allDescriptions.sobjects.forEach((sobject) => {
-            const isCustom = sobject.custom === true;
-            const doPrint = type === SObjectType.ALL ||
-                (type === SObjectType.CUSTOM && isCustom) ||
-                (type === SObjectType.STANDARD && !isCustom);
-            if (doPrint) {
-                havePrinted = true;
-                this.ux.log(sobject.name);
-                typeDescriptions.push(sobject.name);
-            }
-        });
-        if (!havePrinted) {
-            this.ux.log(messages.getMessage('noTypeFound', [SObjectType[type]]));
-        }
-        return typeDescriptions;
-    }
-}
-exports.SchemaSobjectList = SchemaSobjectList;
-SchemaSobjectList.description = messages.getMessage('description');
-SchemaSobjectList.examples = messages.getMessage('examples').split(os_1.EOL);
-SchemaSobjectList.flagsConfig = {
-    sobjecttypecategory: command_1.flags.string({
-        char: 'c',
-        default: 'ALL',
-        validate: (val) => {
-            const capitalized = val.toUpperCase();
-            const result = capitalized === 'ALL' || capitalized === 'STANDARD' || capitalized === 'CUSTOM';
-            if (!result) {
-                throw messages.createError('flags.invalidTypeError');
-            }
-            return result;
-        },
-        description: messages.getMessage('flags.typeDescription'),
-    }),
-};
-SchemaSobjectList.requiresUsername = true;
-//# sourceMappingURL=list.js.map

package/lib/commands/force/schema/sobject/list.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../src/commands/force/schema/sobject/list.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,2BAAyB;AACzB,iDAAsE;AACtE,2CAAwD;AAGxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;AAE5E,qCAAqC;AACrC,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,2CAAG,CAAA;IACH,qDAAQ,CAAA;IACR,iDAAM,CAAA;AACR,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,MAAa,iBAAkB,SAAQ,qBAAW;IAoBzC,KAAK,CAAC,GAAG;QACd,MAAM,QAAQ,GAAI,IAAI,CAAC,KAAK,CAAC,mBAA8B,CAAC,WAAW,EAA8B,CAAC;QACtG,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEnC,MAAM,gBAAgB,GAAa,EAAE,CAAC;QAEtC,MAAM,IAAI,GAAe,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;QAClD,MAAM,eAAe,GAAyB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE1E,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAA8B,EAAE,EAAE;YAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC;YACzC,MAAM,OAAO,GACX,IAAI,KAAK,WAAW,CAAC,GAAG;gBACxB,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,IAAI,QAAQ,CAAC;gBACzC,CAAC,IAAI,KAAK,WAAW,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/C,IAAI,OAAO,EAAE;gBACX,WAAW,GAAG,IAAI,CAAC;gBACnB,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAC1B,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;;AAjDH,8CAkDC;AAjDwB,6BAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,0BAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC;AACtD,6BAAW,GAAgB;IAChD,mBAAmB,EAAE,eAAK,CAAC,MAAM,CAAC;QAChC,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;YAChB,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,WAAW,KAAK,KAAK,IAAI,WAAW,KAAK,UAAU,IAAI,WAAW,KAAK,QAAQ,CAAC;YAC/F,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,QAAQ,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;aACtD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;KAC1D,CAAC;CACH,CAAC;AACqB,kCAAgB,GAAG,IAAI,CAAC"}

package/messages/describe.json

@@ -1,12 +0,0 @@
-{
-  "description": "displays the metadata for a standard or custom object",
-  "examples": [
-    "$ sfdx force:schema:sobject:describe -s Account",
-    "$ sfdx force:schema:sobject:describe -s MyObject__c",
-    "$ sfdx force:schema:sobject:describe -s ApexClass -t"
-  ],
-  "flags": {
-    "objectType": "the API name of the object to describe",
-    "useTooling": "execute with Tooling API"
-  }
-}

package/messages/list.json

@@ -1,13 +0,0 @@
-{
-  "description": "list all objects of a specified category",
-  "flags": {
-    "typeDescription": "the type of objects to list (all|custom|standard)",
-    "invalidTypeError": "\"Type\" flag can be set only to <all|custom|standard>."
-  },
-  "examples": [
-    "$ sfdx force:schema:sobject:list -c all",
-    "$ sfdx force:schema:sobject:list -c custom",
-    "$ sfdx force:schema:sobject:list -c standard"
-  ],
-  "noTypeFound": "No %s objects found."
-}