@esri/hub-common 9.47.0 → 9.48.0

package/dist/es2017/org/fetchOrgLimits.js

@@ -0,0 +1,32 @@
+import { request } from "@esri/arcgis-rest-request";
+/**
+ * Generic function to fetch org limits
+ * @param orgId
+ * @param limitsType
+ * @param limitName
+ * @param options
+ * @returns
+ */
+export function fetchOrgLimits(orgId, limitsType, limitName, options) {
+    const portal = options.authentication.portal;
+    const url = `${portal}/portals/${orgId}/limits?limitsType=${limitsType}&limitName=${limitName}&f=json`;
+    return request(url, options);
+}
+/**
+ * Fetch the maximum number of groups a user can create in an org
+ * @param orgId
+ * @param options
+ * @returns
+ */
+export function fetchMaxNumUserGroupsLimit(orgId, options) {
+    return fetchOrgLimits(orgId, "Groups", "MaxNumUserGroups", options)
+        .then((response) => {
+        return response.limitValue;
+    })
+        .catch((_) => {
+        // it's possible that the org doesn't have this property set, and
+        // the api will return a 500 error. So we just return the default value
+        return 512;
+    });
+}
+//# sourceMappingURL=fetchOrgLimits.js.map

package/dist/es2017/org/fetchOrgLimits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchOrgLimits.js","sourceRoot":"","sources":["../../../src/org/fetchOrgLimits.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AA2BpD;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAa,EACb,UAAwB,EACxB,SAAiB,EACjB,OAA4B;IAE5B,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC;IAC7C,MAAM,GAAG,GAAG,GAAG,MAAM,YAAY,KAAK,sBAAsB,UAAU,cAAc,SAAS,SAAS,CAAC;IACvG,OAAO,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,KAAa,EACb,OAA4B;IAE5B,OAAO,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC;SAChE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,iEAAiE;QACjE,uEAAuE;QACvE,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/es2017/org/index.js

@@ -1,2 +1,3 @@
 export * from "./fetch-org";
+export * from "./fetchOrgLimits";
 //# sourceMappingURL=index.js.map

package/dist/es2017/org/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}

package/dist/esm/org/fetchOrgLimits.js

@@ -0,0 +1,32 @@
+import { request } from "@esri/arcgis-rest-request";
+/**
+ * Generic function to fetch org limits
+ * @param orgId
+ * @param limitsType
+ * @param limitName
+ * @param options
+ * @returns
+ */
+export function fetchOrgLimits(orgId, limitsType, limitName, options) {
+    var portal = options.authentication.portal;
+    var url = portal + "/portals/" + orgId + "/limits?limitsType=" + limitsType + "&limitName=" + limitName + "&f=json";
+    return request(url, options);
+}
+/**
+ * Fetch the maximum number of groups a user can create in an org
+ * @param orgId
+ * @param options
+ * @returns
+ */
+export function fetchMaxNumUserGroupsLimit(orgId, options) {
+    return fetchOrgLimits(orgId, "Groups", "MaxNumUserGroups", options)
+        .then(function (response) {
+        return response.limitValue;
+    })
+        .catch(function (_) {
+        // it's possible that the org doesn't have this property set, and
+        // the api will return a 500 error. So we just return the default value
+        return 512;
+    });
+}
+//# sourceMappingURL=fetchOrgLimits.js.map

package/dist/esm/org/fetchOrgLimits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchOrgLimits.js","sourceRoot":"","sources":["../../../src/org/fetchOrgLimits.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AA2BpD;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAa,EACb,UAAwB,EACxB,SAAiB,EACjB,OAA4B;IAE5B,IAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC;IAC7C,IAAM,GAAG,GAAM,MAAM,iBAAY,KAAK,2BAAsB,UAAU,mBAAc,SAAS,YAAS,CAAC;IACvG,OAAO,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,KAAa,EACb,OAA4B;IAE5B,OAAO,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC;SAChE,IAAI,CAAC,UAAC,QAAQ;QACb,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC,CAAC;SACD,KAAK,CAAC,UAAC,CAAC;QACP,iEAAiE;QACjE,uEAAuE;QACvE,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/esm/org/index.js

@@ -1,2 +1,3 @@
 export * from "./fetch-org";
+export * from "./fetchOrgLimits";
 //# sourceMappingURL=index.js.map

package/dist/esm/org/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC"}

package/dist/node/org/fetchOrgLimits.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchMaxNumUserGroupsLimit = exports.fetchOrgLimits = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+/**
+ * Generic function to fetch org limits
+ * @param orgId
+ * @param limitsType
+ * @param limitName
+ * @param options
+ * @returns
+ */
+function fetchOrgLimits(orgId, limitsType, limitName, options) {
+    const portal = options.authentication.portal;
+    const url = `${portal}/portals/${orgId}/limits?limitsType=${limitsType}&limitName=${limitName}&f=json`;
+    return arcgis_rest_request_1.request(url, options);
+}
+exports.fetchOrgLimits = fetchOrgLimits;
+/**
+ * Fetch the maximum number of groups a user can create in an org
+ * @param orgId
+ * @param options
+ * @returns
+ */
+function fetchMaxNumUserGroupsLimit(orgId, options) {
+    return fetchOrgLimits(orgId, "Groups", "MaxNumUserGroups", options)
+        .then((response) => {
+        return response.limitValue;
+    })
+        .catch((_) => {
+        // it's possible that the org doesn't have this property set, and
+        // the api will return a 500 error. So we just return the default value
+        return 512;
+    });
+}
+exports.fetchMaxNumUserGroupsLimit = fetchMaxNumUserGroupsLimit;
+//# sourceMappingURL=fetchOrgLimits.js.map

package/dist/node/org/fetchOrgLimits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchOrgLimits.js","sourceRoot":"","sources":["../../../src/org/fetchOrgLimits.ts"],"names":[],"mappings":";;;AACA,mEAAoD;AA2BpD;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,KAAa,EACb,UAAwB,EACxB,SAAiB,EACjB,OAA4B;IAE5B,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC;IAC7C,MAAM,GAAG,GAAG,GAAG,MAAM,YAAY,KAAK,sBAAsB,UAAU,cAAc,SAAS,SAAS,CAAC;IACvG,OAAO,6BAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAC/B,CAAC;AATD,wCASC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,KAAa,EACb,OAA4B;IAE5B,OAAO,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC;SAChE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjB,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,iEAAiE;QACjE,uEAAuE;QACvE,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACP,CAAC;AAbD,gEAaC"}

package/dist/node/org/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./fetch-org"), exports);
+tslib_1.__exportStar(require("./fetchOrgLimits"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/org/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,2DAAiC"}

package/dist/types/org/fetchOrgLimits.d.ts

@@ -0,0 +1,35 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+export declare type OrgLimitType = "ScheduleTask" | "Collaboration" | "Community" | "Groups" | "Content";
+/**
+ * Definiton of the org limits response.
+ */
+export interface IOrgLimit {
+    /**
+     * Preset limit types
+     */
+    type: OrgLimitType;
+    /**
+     * Not constrained as there are too many to list
+     */
+    name: string;
+    /**
+     * value of the limit
+     */
+    limitValue: number;
+}
+/**
+ * Generic function to fetch org limits
+ * @param orgId
+ * @param limitsType
+ * @param limitName
+ * @param options
+ * @returns
+ */
+export declare function fetchOrgLimits(orgId: string, limitsType: OrgLimitType, limitName: string, options: IUserRequestOptions): Promise<IOrgLimit>;
+/**
+ * Fetch the maximum number of groups a user can create in an org
+ * @param orgId
+ * @param options
+ * @returns
+ */
+export declare function fetchMaxNumUserGroupsLimit(orgId: string, options: IUserRequestOptions): Promise<number>;

package/dist/types/org/index.d.ts

@@ -1 +1,2 @@
 export * from "./fetch-org";
+export * from "./fetchOrgLimits";

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.46.1 - Tue Jul 19 2022 15:08:51 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.47.0 - Wed Jul 20 2022 22:15:24 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -10011,6 +10011,37 @@
         return getPortal(orgId, __assign(__assign({}, options), { portal: basePortalUrl }));
     };
 
+    /**
+     * Generic function to fetch org limits
+     * @param orgId
+     * @param limitsType
+     * @param limitName
+     * @param options
+     * @returns
+     */
+    function fetchOrgLimits(orgId, limitsType, limitName, options) {
+        var portal = options.authentication.portal;
+        var url = portal + "/portals/" + orgId + "/limits?limitsType=" + limitsType + "&limitName=" + limitName + "&f=json";
+        return request(url, options);
+    }
+    /**
+     * Fetch the maximum number of groups a user can create in an org
+     * @param orgId
+     * @param options
+     * @returns
+     */
+    function fetchMaxNumUserGroupsLimit(orgId, options) {
+        return fetchOrgLimits(orgId, "Groups", "MaxNumUserGroups", options)
+            .then(function (response) {
+            return response.limitValue;
+        })
+            .catch(function (_) {
+            // it's possible that the org doesn't have this property set, and
+            // the api will return a 500 error. So we just return the default value
+            return 512;
+        });
+    }
+
     /**
      * Parse metadataxml into json object
      * @param metadataXml
@@ -20545,8 +20576,10 @@
     exports.fetchContent = fetchContent;
     exports.fetchHubTranslation = fetchHubTranslation;
     exports.fetchImageAsBlob = fetchImageAsBlob;
+    exports.fetchMaxNumUserGroupsLimit = fetchMaxNumUserGroupsLimit;
     exports.fetchModelFromItem = fetchModelFromItem;
     exports.fetchOrg = fetchOrg;
+    exports.fetchOrgLimits = fetchOrgLimits;
     exports.fetchProject = fetchProject;
     exports.fetchSite = fetchSite;
     exports.fetchSiteModel = fetchSiteModel;