npm - @salesforce/plugin-limits - Versions diffs - 2.0.12 → 2.1.0 - Mend

@salesforce/plugin-limits 2.0.12 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/README.md +1 -1
package/lib/commands/limits/api/display.d.ts +18 -0
package/lib/commands/limits/api/display.js +50 -0
package/lib/commands/limits/api/display.js.map +1 -0
package/lib/commands/limits/recordcounts/display.d.ts +17 -0
package/lib/commands/limits/recordcounts/display.js +60 -0
package/lib/commands/limits/recordcounts/display.js.map +1 -0
package/messages/display.md +13 -0
package/messages/recordcounts.md +17 -0
package/oclif.manifest.json +1 -1
package/package.json +30 -26
package/schemas/limits-api-display.json +25 -0
package/schemas/limits-recordcounts-display.json +25 -0
package/lib/commands/force/limits/api/display.d.ts +0 -13
package/lib/commands/force/limits/api/display.js +0 -44
package/lib/commands/force/limits/api/display.js.map +0 -1
package/lib/commands/force/limits/recordcounts/display.d.ts +0 -13
package/lib/commands/force/limits/recordcounts/display.js +0 -62
package/lib/commands/force/limits/recordcounts/display.js.map +0 -1
package/messages/display.json +0 -4
package/messages/recordcounts.json +0 -9

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # plugin-limits
-[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-limits.svg?label=@salesforce/plugin-limits)](https://www.npmjs.com/package/@salesforce/plugin-limits) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-limits/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-limits/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-limits.svg)](https://npmjs.org/package/@salesforce/plugin-limits) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-limits/main/LICENSE.txt)
+[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-limits.svg?label=@salesforce/plugin-limits)](https://www.npmjs.com/package/@salesforce/plugin-limits) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-limits.svg)](https://npmjs.org/package/@salesforce/plugin-limits) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-limits/main/LICENSE.txt)
 A command to display the api limits of your org

package/lib/commands/limits/api/display.d.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+declare type ApiLimit = {
+    name: string;
+    max: number;
+    remaining: number;
+};
+export declare type ApiLimits = ApiLimit[];
+export declare class LimitsApiDisplayCommand extends SfCommand<ApiLimits> {
+    static aliases: string[];
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static flags: {
+        'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+    };
+    run(): Promise<ApiLimits>;
+}
+export {};

package/lib/commands/limits/api/display.js ADDED Viewed

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitsApiDisplayCommand = 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("os");
+const core_1 = require("@salesforce/core");
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-limits', 'display');
+class LimitsApiDisplayCommand extends sf_plugins_core_1.SfCommand {
+    async run() {
+        try {
+            const { flags } = await this.parse(LimitsApiDisplayCommand);
+            const conn = flags['target-org'].getConnection();
+            const getUrl = `${conn.instanceUrl}/services/data/v${conn.version}/limits`;
+            const result = await conn.request(getUrl);
+            const limits = Object.entries(result).map(([name, { Max, Remaining }]) => ({
+                name,
+                max: Max,
+                remaining: Remaining,
+            }));
+            this.table(limits, { name: { header: 'Name' }, remaining: { header: 'Remaining' }, max: { header: 'Max' } });
+            return limits;
+        }
+        catch (err) {
+            if (err instanceof Error || typeof err === 'string') {
+                throw core_1.SfError.wrap(err);
+            }
+            throw err;
+        }
+    }
+}
+exports.LimitsApiDisplayCommand = LimitsApiDisplayCommand;
+LimitsApiDisplayCommand.aliases = ['force:limits:api:display', 'org:list:api-limits'];
+LimitsApiDisplayCommand.summary = messages.getMessage('description');
+LimitsApiDisplayCommand.description = messages.getMessage('description');
+LimitsApiDisplayCommand.examples = messages.getMessage('examples').split(os.EOL);
+LimitsApiDisplayCommand.flags = {
+    'target-org': sf_plugins_core_1.Flags.requiredOrg({
+        char: 'o',
+        aliases: ['targetusername', 'u'],
+        summary: messages.getMessage('targetOrg'),
+    }),
+};
+//# sourceMappingURL=display.js.map

package/lib/commands/limits/api/display.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"display.js","sourceRoot":"","sources":["../../../../src/commands/limits/api/display.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,2CAAqD;AACrD,iEAA+D;AAE/D,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAC;AAiB/E,MAAa,uBAAwB,SAAQ,2BAAoB;IAaxD,KAAK,CAAC,GAAG;QACd,IAAI;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,EAAE,CAAC;YACjD,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,mBAAmB,IAAI,CAAC,OAAO,SAAS,CAAC;YAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,MAAM,CAAC,CAAC;YAClD,MAAM,MAAM,GAAc,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBACpF,IAAI;gBACJ,GAAG,EAAE,GAAG;gBACR,SAAS,EAAE,SAAS;aACrB,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAE7G,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,KAAK,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACnD,MAAM,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;;AAlCH,0DAmCC;AAlCe,+BAAO,GAAG,CAAC,0BAA0B,EAAE,qBAAqB,CAAC,CAAC;AACrD,+BAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC7C,mCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,gCAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAClE,6BAAK,GAAG;IACpB,YAAY,EAAE,uBAAK,CAAC,WAAW,CAAC;QAC9B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC;QAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;KAC1C,CAAC;CACH,CAAC"}

package/lib/commands/limits/recordcounts/display.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export declare type RecordCount = {
+    name: string;
+    count: number;
+};
+export declare type RecordCounts = RecordCount[];
+export declare class LimitsRecordCountsDisplayCommand extends SfCommand<RecordCounts> {
+    static readonly aliases: string[];
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static flags: {
+        sobject: import("@oclif/core/lib/interfaces").OptionFlag<string[]>;
+        'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org>;
+    };
+    run(): Promise<RecordCounts>;
+}

package/lib/commands/limits/recordcounts/display.js ADDED Viewed

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LimitsRecordCountsDisplayCommand = 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("os");
+const core_1 = require("@salesforce/core");
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-limits', 'recordcounts');
+class LimitsRecordCountsDisplayCommand extends sf_plugins_core_1.SfCommand {
+    async run() {
+        try {
+            const { flags } = await this.parse(LimitsRecordCountsDisplayCommand);
+            const conn = flags['target-org'].getConnection();
+            const sobjectsPassed = flags.sobject.map((sobject) => sobject.split(',')).flat();
+            const sobjectsQuery = sobjectsPassed.length > 0 ? `=${sobjectsPassed.join()}` : '';
+            const geturl = `${conn.baseUrl()}/limits/recordCount?sObjects${sobjectsQuery}`;
+            const result = await conn.request(geturl);
+            const recordCounts = result.sObjects
+                .filter((record) => (sobjectsPassed.length > 0 ? sobjectsPassed.includes(record.name) : result.sObjects))
+                .sort((a, b) => a.name.localeCompare(b.name));
+            this.table(recordCounts, {
+                name: { header: 'sObject' },
+                count: { header: 'Record Count' },
+            });
+            return recordCounts;
+        }
+        catch (err) {
+            if (err instanceof Error || typeof err === 'string') {
+                throw core_1.SfError.wrap(err);
+            }
+            throw err;
+        }
+    }
+}
+exports.LimitsRecordCountsDisplayCommand = LimitsRecordCountsDisplayCommand;
+LimitsRecordCountsDisplayCommand.aliases = ['force:limits:recordcounts:display', 'org:list:sobject:record-counts'];
+LimitsRecordCountsDisplayCommand.summary = messages.getMessage('description');
+LimitsRecordCountsDisplayCommand.description = messages.getMessage('description');
+LimitsRecordCountsDisplayCommand.examples = messages.getMessage('examples').split(os.EOL);
+LimitsRecordCountsDisplayCommand.flags = {
+    sobject: sf_plugins_core_1.Flags.string({
+        char: 's',
+        summary: messages.getMessage('sobjectFlagDescription'),
+        aliases: ['sobjecttype'],
+        multiple: true,
+        default: [],
+    }),
+    'target-org': sf_plugins_core_1.Flags.requiredOrg({
+        char: 'o',
+        aliases: ['targetusername', 'u'],
+        summary: messages.getMessage('targetOrg'),
+    }),
+};
+//# sourceMappingURL=display.js.map

package/lib/commands/limits/recordcounts/display.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"display.js","sourceRoot":"","sources":["../../../../src/commands/limits/recordcounts/display.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,2CAAqD;AACrD,iEAA+D;AAE/D,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAC;AAapF,MAAa,gCAAiC,SAAQ,2BAAuB;IAqBpE,KAAK,CAAC,GAAG;QACd,IAAI;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YACrE,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,EAAE,CAAC;YACjD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACjF,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnF,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,+BAA+B,aAAa,EAAE,CAAC;YAC/E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,MAAM,CAAC,CAAC;YAElD,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ;iBACjC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;iBACxG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAEhD,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE;gBACvB,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE;gBAC3B,KAAK,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;aAClC,CAAC,CAAC;YACH,OAAO,YAAY,CAAC;SACrB;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,KAAK,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACnD,MAAM,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;;AA7CH,4EA8CC;AA7CwB,wCAAO,GAAG,CAAC,mCAAmC,EAAE,gCAAgC,CAAC,CAAC;AAClF,wCAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC7C,4CAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,yCAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAElE,sCAAK,GAAG;IACpB,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;QACtD,OAAO,EAAE,CAAC,aAAa,CAAC;QACxB,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,YAAY,EAAE,uBAAK,CAAC,WAAW,CAAC;QAC9B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC;QAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;KAC1C,CAAC;CACH,CAAC"}

package/messages/display.md ADDED Viewed

@@ -0,0 +1,13 @@
+# description
+display current org’s limits
+When you execute this command in a project, it provides limit information for your default scratch org.",
+# examples
+- <%= config.bin %> <%= command.id %>
+- <%= config.bin %> <%= command.id %> --target-org me@my.org
+# targetOrg
+Login username or alias for the target org.

package/messages/recordcounts.md ADDED Viewed

@@ -0,0 +1,17 @@
+# description
+display record counts for the specified standard and custom objects\nUse this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the '--sobjecttype' parameter.",
+# examples
+- <%= config.bin %> <%= command.id %>
+- <%= config.bin %> <%= command.id %> --sobject Account --sobject Contact,Lead,Opportunity
+- <%= config.bin %> <%= command.id %> --sobject Account,Contact --target-org me@my.org
+# sobjectFlagDescription
+comma-separated list of API names of standard or custom objects for which to display record counts
+# targetOrg
+Login username or alias for the target org.

package/oclif.manifest.json CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":"2.0~~.12~~","commands":{"~~force:~~limits:api:display":{"id":"~~force:~~limits:api:display","description":"display current org’s limits\nWhen you execute this command in a project, it provides limit information for your default scratch org.","~~usage":"<%= command.id %> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]"~~,"pluginName":"@salesforce/plugin-limits","pluginType":"core","aliases":[],"~~examples":["$ sfdx~~ force:limits:api:display","~~$ sfdx force~~:~~limits~~:api:~~display~~ -u me@my.org"],"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)","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~~"~~},"apiversion"~~:{~~"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"~~}},"args":[]},"~~force:~~limits:recordcounts:display":{"id":"~~force:~~limits:recordcounts:display","description":"display record counts for the specified standard and custom objects\nUse this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the '--sobjecttype' parameter.","~~usage":"<%= command.id %> [-s <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace\|debug\|info\|warn\|error\|fatal\|TRACE\|DEBUG\|INFO\|WARN\|ERROR\|FATAL]"~~,"pluginName":"@salesforce/plugin-limits","pluginType":"core","aliases":[],"examples":["$ ~~sfdx~~ ~~force:limits:recordcounts:display~~","$ ~~sfdx~~ ~~force:limits:recordcounts:display~~ -s Account,Contact,Lead,Opportunity","$ ~~sfdx~~ ~~force:limits:recordcounts:display~~ -s Account,Contact -u me@my.org"],"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)","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~~"~~},"apiversion"~~:{~~"name":"apiversion","type":"option","description":"override the api version used for api requests made by this command"~~}~~,"sobjecttype":{"name":"sobjecttype","type":"option","char":"s","description":"comma-separated list of API names of standard or custom objects for which to display record counts"~~}},"args":[]}}}
1	+ {"version":"2.1.0","commands":{"limits:api:display":{"id":"limits:api:display","description":"display current org’s limits\nWhen you execute this command in a project, it provides limit information for your default scratch org.\",","pluginName":"@salesforce/plugin-limits","pluginType":"core","aliases":["force:limits:api:display","org:list:api-limits"],"examples":["<%= config.bin %> <%= command.id %>","<%= config.bin %> <%= command.id %> --target-org me@my.org"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","default":{}}},"args":[]},"limits:recordcounts:display":{"id":"limits:recordcounts:display","description":"display record counts for the specified standard and custom objects\\nUse this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the '--sobjecttype' parameter.\",","pluginName":"@salesforce/plugin-limits","pluginType":"core","aliases":["force:limits:recordcounts:display","org:list:sobject:record-counts"],"examples":["<%= config.bin %> <%= command.id %>","<%= config.bin %> <%= command.id %> --sobject Account --sobject Contact,Lead,Opportunity","<%= config.bin %> <%= command.id %> --sobject Account,Contact --target-org me@my.org"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","allowNo":false},"sobject":{"name":"sobject","type":"option","char":"s","default":[]},"target-org":{"name":"target-org","type":"option","char":"o","default":{}}},"args":[]}}}

package/package.json CHANGED Viewed

@@ -1,35 +1,38 @@
 {
     "name": "@salesforce/plugin-limits",
     "description": "commands to display api limits to your org",
-    "version": "2.0.12",
+    "version": "2.1.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "main": "lib/index.js",
     "dependencies": {
-        "@oclif/core": "^1.20.0",
-        "@salesforce/command": "^5.2.22",
-        "@salesforce/core": "^3.31.16",
+        "@salesforce/core": "^3.31.18",
+        "@salesforce/kit": "^1.8.0",
+        "@salesforce/sf-plugins-core": "^1.17.4",
+        "@salesforce/ts-types": "^1.7.1",
         "tslib": "^2"
     },
     "devDependencies": {
         "@oclif/plugin-command-snapshot": "^3",
+        "@oclif/test": "^2.2.10",
         "@salesforce/cli-plugins-testkit": "^3.2.6",
-        "@salesforce/dev-config": "^3.0.0",
+        "@salesforce/dev-config": "^3.1.0",
         "@salesforce/dev-scripts": "^3.1.0",
-        "@salesforce/plugin-command-reference": "^1.4.7",
+        "@salesforce/plugin-command-reference": "^2.2.8",
         "@salesforce/prettier-config": "^0.0.2",
-        "@salesforce/ts-sinon": "1.4.0",
-        "@typescript-eslint/eslint-plugin": "^5.41.0",
-        "@typescript-eslint/parser": "^5.42.0",
-        "chai": "^4.2.0",
-        "eslint": "^8.26.0",
+        "@salesforce/ts-sinon": "^1.4.2",
+        "@typescript-eslint/eslint-plugin": "^5.42.1",
+        "@typescript-eslint/parser": "^5.42.1",
+        "chai": "^4.3.7",
+        "eslint": "^8.27.0",
         "eslint-config-prettier": "^8.5.0",
         "eslint-config-salesforce": "^1.1.0",
         "eslint-config-salesforce-license": "^0.1.6",
         "eslint-config-salesforce-typescript": "^1.1.1",
-        "eslint-plugin-header": "^3.0.0",
+        "eslint-plugin-header": "^3.1.1",
         "eslint-plugin-import": "2.26.0",
         "eslint-plugin-jsdoc": "^39.3.14",
+        "eslint-plugin-sf-plugin": "^1.1.5",
         "husky": "^7.0.4",
         "mocha": "^9.1.3",
         "nyc": "^15.1.0",
@@ -37,7 +40,8 @@
         "pretty-quick": "^3.1.0",
         "shx": "0.3.4",
         "sinon": "10.0.0",
-        "ts-node": "^10.0.0",
+        "swc": "^1.0.11",
+        "ts-node": "^10.4.0",
         "typescript": "^4.8.4"
     },
     "config": {},
@@ -47,7 +51,8 @@
     "files": [
         "/lib",
         "/messages",
-        "/oclif.manifest.json"
+        "/oclif.manifest.json",
+        "/schemas"
     ],
     "homepage": "https://github.com/salesforcecli/plugin-limits",
     "keywords": [
@@ -70,16 +75,14 @@
             "@salesforce/plugin-command-reference"
         ],
         "topics": {
-            "force": {
-                "external": true,
+            "limits": {
+                "description": "display current org’s limits",
                 "subtopics": {
-                    "limits": {
-                        "description": "display current org’s limits",
-                        "subtopics": {
-                            "api": {
-                                "description": "display current org’s api limits"
-                            }
-                        }
+                    "api": {
+                        "description": "display current org’s api limits"
+                    },
+                    "recordcounts": {
+                        "description": "display record counts for the current"
                     }
                 }
             }
@@ -96,13 +99,14 @@
         "format": "sf-format",
         "lint": "sf-lint",
         "postpack": "shx rm -f oclif.manifest.json",
-        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
+        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference && yarn test:json-schema",
         "prepack": "sf-prepack",
         "prepare": "sf-install",
         "pretest": "sf-compile-test",
         "test": "sf-test",
         "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
         "test:deprecation-policy": "./bin/dev snapshot:compare",
+        "test:json-schema": "./bin/dev schema:compare",
         "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
         "version": "oclif-dev readme"
     },
@@ -110,7 +114,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.0.12.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.0.12.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.1.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-limits/2.1.0.sig"
     }
 }

package/schemas/limits-api-display.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/ApiLimits",
+  "definitions": {
+    "ApiLimits": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "max": {
+            "type": "number"
+          },
+          "remaining": {
+            "type": "number"
+          }
+        },
+        "required": ["name", "max", "remaining"],
+        "additionalProperties": false
+      }
+    }
+  }
+}

package/schemas/limits-recordcounts-display.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/RecordCounts",
+  "definitions": {
+    "RecordCounts": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/RecordCount"
+      }
+    },
+    "RecordCount": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "count": {
+          "type": "number"
+        }
+      },
+      "required": ["name", "count"],
+      "additionalProperties": false
+    }
+  }
+}

package/lib/commands/force/limits/api/display.d.ts DELETED Viewed

@@ -1,13 +0,0 @@
-import { SfdxCommand } from '@salesforce/command';
-declare type ApiLimit = {
-    name: string;
-    max: number;
-    remaining: number;
-};
-export declare class LimitsApiDisplayCommand extends SfdxCommand {
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly requiresUsername = true;
-    run(): Promise<ApiLimit[]>;
-}
-export {};

package/lib/commands/force/limits/api/display.js DELETED Viewed

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LimitsApiDisplayCommand = 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("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-limits', 'display');
-class LimitsApiDisplayCommand extends command_1.SfdxCommand {
-    async run() {
-        try {
-            const conn = this.org.getConnection();
-            const geturl = `${conn.instanceUrl}/services/data/v${conn.version}/limits`;
-            const result = await conn.request(geturl);
-            const limits = [];
-            Object.keys(result).map((limitName) => {
-                limits.push({
-                    name: limitName,
-                    max: result[limitName].Max,
-                    remaining: result[limitName].Remaining,
-                });
-            });
-            this.ux.table(limits, { name: { header: 'Name' }, remaining: { header: 'Remaining' }, max: { header: 'Max' } });
-            return limits;
-        }
-        catch (err) {
-            if (err instanceof Error || typeof err === 'string') {
-                throw core_1.SfError.wrap(err);
-            }
-            throw err;
-        }
-    }
-}
-exports.LimitsApiDisplayCommand = LimitsApiDisplayCommand;
-LimitsApiDisplayCommand.description = messages.getMessage('description');
-LimitsApiDisplayCommand.examples = messages.getMessage('examples').split(os.EOL);
-LimitsApiDisplayCommand.requiresUsername = true;
-//# sourceMappingURL=display.js.map

package/lib/commands/force/limits/api/display.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"display.js","sourceRoot":"","sources":["../../../../../src/commands/force/limits/api/display.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,iDAAkD;AAClD,2CAAqD;AAErD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAC;AAe/E,MAAa,uBAAwB,SAAQ,qBAAW;IAK/C,KAAK,CAAC,GAAG;QACd,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,mBAAmB,IAAI,CAAC,OAAO,SAAS,CAAC;YAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,MAAM,CAAC,CAAC;YAClD,MAAM,MAAM,GAAe,EAAE,CAAC;YAE9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;gBACpC,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,SAAS;oBACf,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG;oBAC1B,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAEhH,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,KAAK,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACnD,MAAM,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;;AA7BH,0DA8BC;AA7BwB,mCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,gCAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AACzD,wCAAgB,GAAG,IAAI,CAAC"}

package/lib/commands/force/limits/recordcounts/display.d.ts DELETED Viewed

@@ -1,13 +0,0 @@
-import { FlagsConfig, SfdxCommand, SfdxResult } from '@salesforce/command';
-export interface RecordCount {
-    name: string;
-    count: number;
-}
-export declare class LimitsRecordCountsDisplayCommand extends SfdxCommand {
-    static readonly description: string;
-    static readonly examples: string[];
-    static readonly requiresUsername = true;
-    static readonly result: SfdxResult;
-    protected static readonly flagsConfig: FlagsConfig;
-    run(): Promise<RecordCount[]>;
-}

package/lib/commands/force/limits/recordcounts/display.js DELETED Viewed

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LimitsRecordCountsDisplayCommand = 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("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-limits', 'recordcounts');
-class LimitsRecordCountsDisplayCommand extends command_1.SfdxCommand {
-    async run() {
-        try {
-            const sobjectsPassed = this.flags.sobjecttype;
-            const sobjectsQuery = sobjectsPassed ? `=${sobjectsPassed.join()}` : '';
-            const conn = this.org.getConnection();
-            const geturl = `${conn.baseUrl()}/limits/recordCount?sObjects${sobjectsQuery}`;
-            const result = await conn.request(geturl);
-            // if an object is requested, but there's 0 of them on the server, append that object to the result
-            if (sobjectsPassed) {
-                sobjectsPassed.forEach((name) => {
-                    if (!result.sObjects.find((record) => record.name === name)) {
-                        result.sObjects.push({ name, count: 0 });
-                    }
-                });
-            }
-            return result.sObjects;
-        }
-        catch (err) {
-            if (err instanceof Error || typeof err === 'string') {
-                throw core_1.SfError.wrap(err);
-            }
-            throw err;
-        }
-    }
-}
-exports.LimitsRecordCountsDisplayCommand = LimitsRecordCountsDisplayCommand;
-LimitsRecordCountsDisplayCommand.description = messages.getMessage('commandDescription');
-LimitsRecordCountsDisplayCommand.examples = messages.getMessage('examples').split(os.EOL);
-LimitsRecordCountsDisplayCommand.requiresUsername = true;
-LimitsRecordCountsDisplayCommand.result = {
-    tableColumnData: {
-        name: { header: 'sObject' },
-        count: { header: 'Record Count' },
-    },
-    display() {
-        if (Array.isArray(this.data) && this.data.length) {
-            this.ux.table(this.data, this.tableColumnData);
-        }
-    },
-};
-LimitsRecordCountsDisplayCommand.flagsConfig = {
-    sobjecttype: command_1.flags.array({
-        char: 's',
-        description: messages.getMessage('sobjecttypeFlagDescription'),
-    }),
-};
-//# sourceMappingURL=display.js.map

package/lib/commands/force/limits/recordcounts/display.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"display.js","sourceRoot":"","sources":["../../../../../src/commands/force/limits/recordcounts/display.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,iDAAkF;AAClF,2CAAqD;AAErD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAC;AAWpF,MAAa,gCAAiC,SAAQ,qBAAW;IAuBxD,KAAK,CAAC,GAAG;QACd,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,WAAuB,CAAC;YAC1D,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAExE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACtC,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,+BAA+B,aAAa,EAAE,CAAC;YAC/E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,MAAM,CAAC,CAAC;YAElD,mGAAmG;YACnG,IAAI,cAAc,EAAE;gBAClB,cAAc,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;wBAC3D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;qBAC1C;gBACH,CAAC,CAAC,CAAC;aACJ;YAED,OAAO,MAAM,CAAC,QAAQ,CAAC;SACxB;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,KAAK,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACnD,MAAM,cAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;;AAhDH,4EAiDC;AAhDwB,4CAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AACxD,yCAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AACzD,iDAAgB,GAAG,IAAI,CAAC;AACxB,uCAAM,GAAe;IAC1C,eAAe,EAAE;QACf,IAAI,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;KAClC;IACD,OAAO;QACL,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;SAChD;IACH,CAAC;CACF,CAAC;AAEwB,4CAAW,GAAgB;IACnD,WAAW,EAAE,eAAK,CAAC,KAAK,CAAC;QACvB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;KAC/D,CAAC;CACH,CAAC"}

package/messages/display.json DELETED Viewed

@@ -1,4 +0,0 @@
-{
-  "description": "display current org’s limits\nWhen you execute this command in a project, it provides limit information for your default scratch org.",
-  "examples": ["$ sfdx force:limits:api:display", "$ sfdx force:limits:api:display -u me@my.org"]
-}

package/messages/recordcounts.json DELETED Viewed

@@ -1,9 +0,0 @@
-{
-  "commandDescription": "display record counts for the specified standard and custom objects\nUse this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in Setup. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the '--sobjecttype' parameter.",
-  "examples": [
-    "$ sfdx force:limits:recordcounts:display",
-    "$ sfdx force:limits:recordcounts:display -s Account,Contact,Lead,Opportunity",
-    "$ sfdx force:limits:recordcounts:display -s Account,Contact -u me@my.org"
-  ],
-  "sobjecttypeFlagDescription": "comma-separated list of API names of standard or custom objects for which to display record counts"
-}