@salesforce/plugin-limits 2.3.41 → 3.0.2

package/README.md

@@ -70,20 +70,20 @@ sfdx plugins
 
 <!-- commands -->
 
-- [`sfdx limits:api:display`](#sfdx-limitsapidisplay)
-- [`sfdx limits:recordcounts:display`](#sfdx-limitsrecordcountsdisplay)
+- [`sf org list limits`](#sf-org-list-limits)
+- [`sf org list sobject record-counts`](#sf-org-list-sobject-record-counts)
 
-## `sfdx limits:api:display`
+## `sf org list limits`
 
 Display information about limits in your org.
 
 ```
 USAGE
-  $ sfdx limits:api:display -o <value> [--json] [--api-version <value>]
+  $ sf org list limits -o <value> [--json] [--api-version <value>]
 
 FLAGS
-  -o, --target-org=<value>  (required) Username or alias of the target org.
-  --api-version=<value>     Override the api version used for api requests made by this command
+  -o, --target-org=<value>   (required) Username or alias of the target org.
+      --api-version=<value>  Override the api version used for api requests made by this command
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -96,33 +96,33 @@ DESCRIPTION
   https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm.
 
 ALIASES
-  $ sfdx force:limits:api:display
-  $ sfdx org:list:limits
+  $ sf force limits api display
+  $ sf limits api display
 
 EXAMPLES
   Display limits in your default org:
 
-    $ sfdx limits:api:display
+    $ sf org list limits
 
   Display limits in the org with alias "my-scratch-org":
 
-    $ sfdx limits:api:display --target-org my-scratch-org
+    $ sf org list limits --target-org my-scratch-org
 ```
 
-_See code: [src/commands/limits/api/display.ts](https://github.com/salesforcecli/plugin-limits/blob/2.3.41/src/commands/limits/api/display.ts)_
+_See code: [src/commands/org/list/limits.ts](https://github.com/salesforcecli/plugin-limits/blob/3.0.2/src/commands/org/list/limits.ts)_
 
-## `sfdx limits:recordcounts:display`
+## `sf org list sobject record-counts`
 
 Display record counts for the specified standard or custom objects.
 
 ```
 USAGE
-  $ sfdx limits:recordcounts:display -o <value> [--json] [-s <value>] [--api-version <value>]
+  $ sf org list sobject record-counts -o <value> [--json] [-s <value>] [--api-version <value>]
 
 FLAGS
-  -o, --target-org=<value>  (required) Username or alias of the target org.
-  -s, --sobject=<value>...  [default: ] API name of the standard or custom object for which to display record counts.
-  --api-version=<value>     Override the api version used for api requests made by this command
+  -o, --target-org=<value>   (required) Username or alias of the target org.
+  -s, --sobject=<value>...   [default: ] API name of the standard or custom object for which to display record counts.
+      --api-version=<value>  Override the api version used for api requests made by this command
 
 GLOBAL FLAGS
   --json  Format output as json.
@@ -136,23 +136,23 @@ DESCRIPTION
   available record counts, run the command without the --sobject flag.
 
 ALIASES
-  $ sfdx force:limits:recordcounts:display
-  $ sfdx org:list:sobject:record-counts
+  $ sf force limits recordcounts display
+  $ sf limits recordcounts display
 
 EXAMPLES
   Display all available record counts in your default org:
 
-    $ sfdx limits:recordcounts:display
+    $ sf org list sobject record-counts
 
   Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:
 
-    $ sfdx limits:recordcounts:display --sobject Account --sobject Contact --sobject Lead --sobject Opportunity
+    $ sf org list sobject record-counts --sobject Account --sobject Contact --sobject Lead --sobject Opportunity
 
   Display record counts for the Account and Lead objects for the org with alias "my-scratch-org":
 
-    $ sfdx limits:recordcounts:display --sobject Account --sobject Lead --target-org my-scratch-org
+    $ sf org list sobject record-counts --sobject Account --sobject Lead --target-org my-scratch-org
 ```
 
-_See code: [src/commands/limits/recordcounts/display.ts](https://github.com/salesforcecli/plugin-limits/blob/2.3.41/src/commands/limits/recordcounts/display.ts)_
+_See code: [src/commands/org/list/sobject/record-counts.ts](https://github.com/salesforcecli/plugin-limits/blob/3.0.2/src/commands/org/list/sobject/record-counts.ts)_
 
 <!-- commandsstop -->

package/lib/commands/org/list/limits.d.ts

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

package/lib/commands/org/list/limits.js

@@ -0,0 +1,44 @@
+/*
+ * 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
+ */
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Messages, SfError } from '@salesforce/core';
+import { SfCommand, orgApiVersionFlagWithDeprecations, loglevel, requiredOrgFlagWithDeprecations, } from '@salesforce/sf-plugins-core';
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
+const messages = Messages.loadMessages('@salesforce/plugin-limits', 'display');
+export class LimitsApiDisplayCommand extends SfCommand {
+    static aliases = ['force:limits:api:display', 'limits:api:display'];
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'target-org': requiredOrgFlagWithDeprecations,
+        'api-version': orgApiVersionFlagWithDeprecations,
+        loglevel,
+    };
+    async run() {
+        try {
+            const { flags } = await this.parse(LimitsApiDisplayCommand);
+            const conn = flags['target-org'].getConnection(flags['api-version']);
+            const result = await conn.request('/limits');
+            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 SfError.wrap(err);
+            }
+            throw err;
+        }
+    }
+}
+//# sourceMappingURL=limits.js.map

package/lib/commands/org/list/limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limits.js","sourceRoot":"","sources":["../../../../src/commands/org/list/limits.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,SAAS,EACT,iCAAiC,EACjC,QAAQ,EACR,+BAA+B,GAChC,MAAM,6BAA6B,CAAC;AAErC,QAAQ,CAAC,uBAAuB,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC1E,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,SAAS,CAAC,CAAC;AAiB/E,MAAM,OAAO,uBAAwB,SAAQ,SAAoB;IACxD,MAAM,CAAU,OAAO,GAAG,CAAC,0BAA0B,EAAE,oBAAoB,CAAC,CAAC;IAC7E,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5D,MAAM,CAAU,KAAK,GAAG;QAC7B,YAAY,EAAE,+BAA+B;QAC7C,aAAa,EAAE,iCAAiC;QAChD,QAAQ;KACT,CAAC;IAEK,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,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAS,SAAS,CAAC,CAAC;YACrD,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,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC"}

package/lib/commands/org/list/sobject/record-counts.d.ts

@@ -0,0 +1,19 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type RecordCount = {
+    name: string;
+    count: number;
+};
+export 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 readonly flags: {
+        sobject: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'target-org': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'api-version': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        loglevel: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<RecordCounts>;
+}

package/lib/commands/org/list/sobject/record-counts.js

@@ -0,0 +1,53 @@
+/*
+ * 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
+ */
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Messages, SfError } from '@salesforce/core';
+import { arrayWithDeprecation, loglevel, orgApiVersionFlagWithDeprecations, requiredOrgFlagWithDeprecations, SfCommand, } from '@salesforce/sf-plugins-core';
+Messages.importMessagesDirectory(dirname(fileURLToPath(import.meta.url)));
+const messages = Messages.loadMessages('@salesforce/plugin-limits', 'recordcounts');
+export class LimitsRecordCountsDisplayCommand extends SfCommand {
+    static aliases = ['force:limits:recordcounts:display', 'limits:recordcounts:display'];
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        sobject: arrayWithDeprecation({
+            char: 's',
+            summary: messages.getMessage('flags.sobject.summary'),
+            aliases: ['sobjecttype'],
+            default: [],
+        }),
+        'target-org': requiredOrgFlagWithDeprecations,
+        'api-version': orgApiVersionFlagWithDeprecations,
+        loglevel,
+    };
+    async run() {
+        try {
+            const { flags } = await this.parse(LimitsRecordCountsDisplayCommand);
+            const conn = flags['target-org'].getConnection(flags['api-version']);
+            const sobjectsQuery = flags.sobject.length > 0 ? `=${flags.sobject.join()}` : '';
+            const geturl = `/limits/recordCount?sObjects${sobjectsQuery}`;
+            const result = await conn.request(geturl);
+            const recordCounts = result.sObjects
+                .filter((record) => (flags.sobject.length > 0 ? flags.sobject.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 SfError.wrap(err);
+            }
+            throw err;
+        }
+    }
+}
+//# sourceMappingURL=record-counts.js.map

package/lib/commands/org/list/sobject/record-counts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-counts.js","sourceRoot":"","sources":["../../../../../src/commands/org/list/sobject/record-counts.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,oBAAoB,EACpB,QAAQ,EACR,iCAAiC,EACjC,+BAA+B,EAC/B,SAAS,GACV,MAAM,6BAA6B,CAAC;AAErC,QAAQ,CAAC,uBAAuB,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC1E,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAC;AAapF,MAAM,OAAO,gCAAiC,SAAQ,SAAuB;IACpE,MAAM,CAAU,OAAO,GAAG,CAAC,mCAAmC,EAAE,6BAA6B,CAAC,CAAC;IAC/F,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,OAAO,EAAE,oBAAoB,CAAC;YAC5B,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;YACrD,OAAO,EAAE,CAAC,aAAa,CAAC;YACxB,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,YAAY,EAAE,+BAA+B;QAC7C,aAAa,EAAE,iCAAiC;QAChD,QAAQ;KACT,CAAC;IAEK,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,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;YACrE,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjF,MAAM,MAAM,GAAG,+BAA+B,aAAa,EAAE,CAAC;YAC9D,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,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;iBACtG,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,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzB;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC"}

package/lib/index.d.ts

@@ -1,2 +1,2 @@
 declare const _default: {};
-export = _default;
+export default _default;

package/lib/index.js

@@ -1,9 +1,8 @@
-"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
  */
-module.exports = {};
+export default {};
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AAEH,iBAAS,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,EAAE,CAAC"}

package/messages/display.md

@@ -15,7 +15,3 @@ For each limit, this command returns the maximum allocation and the remaining al
 - Display limits in the org with alias "my-scratch-org":
 
   <%= config.bin %> <%= command.id %> --target-org my-scratch-org
-
-# targetOrg
-
-Login username or alias for the target org.

package/messages/recordcounts.md

@@ -20,10 +20,6 @@ Use this command to get an approximate count of the records in standard or custo
 
   <%= config.bin %> <%= command.id %> --sobject Account --sobject Lead --target-org my-scratch-org
 
-# sobjectFlagDescription
+# flags.sobject.summary
 
 API name of the standard or custom object for which to display record counts.
-
-# targetOrg
-
-Login username or alias for the target org.