@esri/solution-common 4.1.2 → 5.0.0

package/dist/cjs/completeItem.d.ts

@@ -1,29 +1,29 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Provides functions for accessing a complete item.
- *
- * @module completeItem
- */
-import { ICompleteItem, UserSession } from "./interfaces";
-/**
- * Gets everything about an item.
- *
- * @param itemId Id of an item whose information is sought
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with everything known about the item
- */
-export declare function getCompleteItem(itemId: string, authentication: UserSession): Promise<ICompleteItem>;
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Provides functions for accessing a complete item.
+ *
+ * @module completeItem
+ */
+import { ICompleteItem, UserSession } from "./interfaces";
+/**
+ * Gets everything about an item.
+ *
+ * @param itemId Id of an item whose information is sought
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with everything known about the item
+ */
+export declare function getCompleteItem(itemId: string, authentication: UserSession): Promise<ICompleteItem>;

package/dist/cjs/completeItem.js

@@ -1,82 +1,82 @@
-"use strict";
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCompleteItem = void 0;
-const tslib_1 = require("tslib");
-const restHelpers = tslib_1.__importStar(require("./restHelpers"));
-const restHelpersGet = tslib_1.__importStar(require("./restHelpersGet"));
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Gets everything about an item.
- *
- * @param itemId Id of an item whose information is sought
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with everything known about the item
- */
-function getCompleteItem(itemId, authentication) {
-    let itemBase;
-    let completeItem;
-    return restHelpersGet
-        .getItemBase(itemId, authentication)
-        .then((response) => {
-        itemBase = response;
-        return Promise.all([
-            restHelpersGet.getItemDataAsFile(itemId, itemBase.name, authentication),
-            restHelpersGet.getItemThumbnailAsFile(itemId, itemBase.thumbnail, false, authentication),
-            restHelpersGet.getItemMetadataAsFile(itemId, authentication),
-            restHelpersGet.getItemResourcesFiles(itemId, authentication),
-            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "forward", authentication),
-            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "reverse", authentication)
-        ]);
-    })
-        .then(responses => {
-        const [itemData, itemThumbnail, itemMetadata, itemResources, itemFwdRelatedItems, itemRevRelatedItems] = responses;
-        // Summarize what we have
-        // ----------------------
-        // (itemBase: IItem)  text/plain JSON
-        // (itemData: File)  */*
-        // (itemThumbnail: File)  image/*
-        // (itemMetadata: File)  application/xml
-        // (itemResources: File[])  list of */*
-        // (itemFwdRelatedItems: IRelatedItems[])  list of forward relationshipType/relatedItems[] pairs
-        // (itemRevRelatedItems: IRelatedItems[])  list of reverse relationshipType/relatedItems[] pairs
-        completeItem = {
-            base: itemBase,
-            data: itemData,
-            thumbnail: itemThumbnail,
-            metadata: itemMetadata,
-            resources: itemResources,
-            fwdRelatedItems: itemFwdRelatedItems,
-            revRelatedItems: itemRevRelatedItems
-        };
-        if (itemBase.type === "Feature Service") {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            return restHelpers.getFeatureServiceProperties(itemBase.url, authentication);
-        }
-        else {
-            return Promise.resolve(null);
-        }
-    })
-        .then((properties) => {
-        if (properties) {
-            completeItem.featureServiceProperties = properties;
-        }
-        return Promise.resolve(completeItem);
-    });
-}
-exports.getCompleteItem = getCompleteItem;
+"use strict";
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCompleteItem = void 0;
+const tslib_1 = require("tslib");
+const restHelpers = tslib_1.__importStar(require("./restHelpers"));
+const restHelpersGet = tslib_1.__importStar(require("./restHelpersGet"));
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Gets everything about an item.
+ *
+ * @param itemId Id of an item whose information is sought
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with everything known about the item
+ */
+function getCompleteItem(itemId, authentication) {
+    let itemBase;
+    let completeItem;
+    return restHelpersGet
+        .getItemBase(itemId, authentication)
+        .then((response) => {
+        itemBase = response;
+        return Promise.all([
+            restHelpersGet.getItemDataAsFile(itemId, itemBase.name, authentication),
+            restHelpersGet.getItemThumbnailAsFile(itemId, itemBase.thumbnail, false, authentication),
+            restHelpersGet.getItemMetadataAsFile(itemId, authentication),
+            restHelpersGet.getItemResourcesFiles(itemId, authentication),
+            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "forward", authentication),
+            restHelpersGet.getItemRelatedItemsInSameDirection(itemId, "reverse", authentication)
+        ]);
+    })
+        .then(responses => {
+        const [itemData, itemThumbnail, itemMetadata, itemResources, itemFwdRelatedItems, itemRevRelatedItems] = responses;
+        // Summarize what we have
+        // ----------------------
+        // (itemBase: IItem)  text/plain JSON
+        // (itemData: File)  */*
+        // (itemThumbnail: File)  image/*
+        // (itemMetadata: File)  application/xml
+        // (itemResources: File[])  list of */*
+        // (itemFwdRelatedItems: IRelatedItems[])  list of forward relationshipType/relatedItems[] pairs
+        // (itemRevRelatedItems: IRelatedItems[])  list of reverse relationshipType/relatedItems[] pairs
+        completeItem = {
+            base: itemBase,
+            data: itemData,
+            thumbnail: itemThumbnail,
+            metadata: itemMetadata,
+            resources: itemResources,
+            fwdRelatedItems: itemFwdRelatedItems,
+            revRelatedItems: itemRevRelatedItems
+        };
+        if (itemBase.type === "Feature Service") {
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            return restHelpers.getFeatureServiceProperties(itemBase.url, authentication);
+        }
+        else {
+            return Promise.resolve(null);
+        }
+    })
+        .then((properties) => {
+        if (properties) {
+            completeItem.featureServiceProperties = properties;
+        }
+        return Promise.resolve(completeItem);
+    });
+}
+exports.getCompleteItem = getCompleteItem;
 //# sourceMappingURL=completeItem.js.map

package/dist/cjs/create-hub-request-options.d.ts

@@ -1,29 +1,29 @@
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "./interfaces";
-import { IHubUserRequestOptions } from "@esri/hub-common";
-/**
- * Create a IHubUserRequestOptions object from
- * the UserSession
- * If passed, it will use `templateDictionary`
- * values instead of making additional requests
- *
- * @export
- * @param {UserSession} authentication
- * @param {*} templateDictionary
- * @returns {IHubUserRequestOptions}
- */
-export declare function createHubRequestOptions(authentication: UserSession, templateDictionary?: any): Promise<IHubUserRequestOptions>;
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "./interfaces";
+import { IHubUserRequestOptions } from "@esri/hub-common";
+/**
+ * Create a IHubUserRequestOptions object from
+ * the UserSession
+ * If passed, it will use `templateDictionary`
+ * values instead of making additional requests
+ *
+ * @export
+ * @param {UserSession} authentication
+ * @param {*} templateDictionary
+ * @returns {IHubUserRequestOptions}
+ */
+export declare function createHubRequestOptions(authentication: UserSession, templateDictionary?: any): Promise<IHubUserRequestOptions>;

package/dist/cjs/create-hub-request-options.js

@@ -1,64 +1,64 @@
-"use strict";
-/** @license
- * Copyright 2018 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHubRequestOptions = void 0;
-const hub_common_1 = require("@esri/hub-common");
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-/**
- * Create a IHubUserRequestOptions object from
- * the UserSession
- * If passed, it will use `templateDictionary`
- * values instead of making additional requests
- *
- * @export
- * @param {UserSession} authentication
- * @param {*} templateDictionary
- * @returns {IHubUserRequestOptions}
- */
-function createHubRequestOptions(authentication, templateDictionary = {}) {
-    // We used to pull the user
-    // the template dictionary, but ran into issues
-    // with the user.groups being filtered to groups
-    // the user owns, vs all groups the user belongs to
-    // this was problematic as we need to check if the user
-    // can add more groups, based on how close they are to
-    // the max 512 group limit.
-    // At this time we are simply fetching the user directly
-    const promises = [];
-    if (templateDictionary.organization) {
-        promises.push(Promise.resolve(templateDictionary.organization));
-    }
-    else {
-        promises.push((0, arcgis_rest_portal_1.getSelf)({ authentication }));
-    }
-    // always get the user
-    promises.push((0, arcgis_rest_portal_1.getUser)({ authentication }));
-    return Promise.all(promises).then(([pSelf, user]) => {
-        pSelf.user = user;
-        const ro = {
-            authentication,
-            portalSelf: pSelf,
-            isPortal: pSelf.isPortal
-        };
-        if (!pSelf.isPortal) {
-            ro.hubApiUrl = (0, hub_common_1.getHubUrlFromPortal)(pSelf);
-        }
-        return ro;
-    });
-}
-exports.createHubRequestOptions = createHubRequestOptions;
+"use strict";
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHubRequestOptions = void 0;
+const hub_common_1 = require("@esri/hub-common");
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+/**
+ * Create a IHubUserRequestOptions object from
+ * the UserSession
+ * If passed, it will use `templateDictionary`
+ * values instead of making additional requests
+ *
+ * @export
+ * @param {UserSession} authentication
+ * @param {*} templateDictionary
+ * @returns {IHubUserRequestOptions}
+ */
+function createHubRequestOptions(authentication, templateDictionary = {}) {
+    // We used to pull the user
+    // the template dictionary, but ran into issues
+    // with the user.groups being filtered to groups
+    // the user owns, vs all groups the user belongs to
+    // this was problematic as we need to check if the user
+    // can add more groups, based on how close they are to
+    // the max 512 group limit.
+    // At this time we are simply fetching the user directly
+    const promises = [];
+    if (templateDictionary.organization) {
+        promises.push(Promise.resolve(templateDictionary.organization));
+    }
+    else {
+        promises.push((0, arcgis_rest_portal_1.getSelf)({ authentication }));
+    }
+    // always get the user
+    promises.push((0, arcgis_rest_portal_1.getUser)({ authentication }));
+    return Promise.all(promises).then(([pSelf, user]) => {
+        pSelf.user = user;
+        const ro = {
+            authentication,
+            portalSelf: pSelf,
+            isPortal: pSelf.isPortal
+        };
+        if (!pSelf.isPortal) {
+            ro.hubApiUrl = (0, hub_common_1.getHubUrlFromPortal)(pSelf);
+        }
+        return ro;
+    });
+}
+exports.createHubRequestOptions = createHubRequestOptions;
 //# sourceMappingURL=create-hub-request-options.js.map

package/dist/cjs/deleteHelpers/deleteEmptyGroups.d.ts

@@ -1,24 +1,24 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { UserSession } from "../interfaces";
-/**
- * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
- *
- * @param groups Ids of the groups to be deleted
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with the list of successfully deleted groups
- */
-export declare function deleteEmptyGroups(groups: string[], authentication: UserSession): Promise<string[]>;
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { UserSession } from "../interfaces";
+/**
+ * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
+ *
+ * @param groups Ids of the groups to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with the list of successfully deleted groups
+ */
+export declare function deleteEmptyGroups(groups: string[], authentication: UserSession): Promise<string[]>;

package/dist/cjs/deleteHelpers/deleteEmptyGroups.js

@@ -1,42 +1,42 @@
-"use strict";
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteEmptyGroups = void 0;
-/**
- * @module deleteEmptyGroups
- */
-const deleteGroupIfEmpty_1 = require("./deleteGroupIfEmpty");
-// ------------------------------------------------------------------------------------------------------------------ //
-/**
- * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
- *
- * @param groups Ids of the groups to be deleted
- * @param authentication Credentials for the request
- * @returns Promise that will resolve with the list of successfully deleted groups
- */
-function deleteEmptyGroups(groups, authentication) {
-    if (groups.length === 0) {
-        return Promise.resolve([]);
-    }
-    // Attempt to delete each group
-    return Promise.all(groups.map(groupId => (0, deleteGroupIfEmpty_1.deleteGroupIfEmpty)(groupId, authentication))).then((responses) => {
-        // Return just the group ids that succeeded
-        return groups.filter((groupId, index) => responses[index]);
-    });
-}
-exports.deleteEmptyGroups = deleteEmptyGroups;
+"use strict";
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteEmptyGroups = void 0;
+/**
+ * @module deleteEmptyGroups
+ */
+const deleteGroupIfEmpty_1 = require("./deleteGroupIfEmpty");
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Deletes a set of empty groups if they're empty and belong to the user in the authentication.
+ *
+ * @param groups Ids of the groups to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with the list of successfully deleted groups
+ */
+function deleteEmptyGroups(groups, authentication) {
+    if (groups.length === 0) {
+        return Promise.resolve([]);
+    }
+    // Attempt to delete each group
+    return Promise.all(groups.map(groupId => (0, deleteGroupIfEmpty_1.deleteGroupIfEmpty)(groupId, authentication))).then((responses) => {
+        // Return just the group ids that succeeded
+        return groups.filter((groupId, index) => responses[index]);
+    });
+}
+exports.deleteEmptyGroups = deleteEmptyGroups;
 //# sourceMappingURL=deleteEmptyGroups.js.map

package/dist/cjs/deleteHelpers/deleteGroupIfEmpty.d.ts

@@ -1,27 +1,27 @@
-/** @license
- * Copyright 2021 Esri
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * @module deleteGroupIfEmpty
- */
-import { UserSession } from "../interfaces";
-/**
- * Deletes a group if it's empty and belongs to the specified user.
- *
- * @param groupId Id of the group to be deleted
- * @param authentication Credentials for the request
- * @returns Promise indicating if group was deleted
- */
-export declare function deleteGroupIfEmpty(groupId: string, authentication: UserSession): Promise<boolean>;
+/** @license
+ * Copyright 2021 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @module deleteGroupIfEmpty
+ */
+import { UserSession } from "../interfaces";
+/**
+ * Deletes a group if it's empty and belongs to the specified user.
+ *
+ * @param groupId Id of the group to be deleted
+ * @param authentication Credentials for the request
+ * @returns Promise indicating if group was deleted
+ */
+export declare function deleteGroupIfEmpty(groupId: string, authentication: UserSession): Promise<boolean>;