@esri/hub-common 9.17.1 → 9.18.0

package/dist/types/projects/HubProjects.d.ts

@@ -1,4 +1,5 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { Filter, IHubSearchOptions, ISearchResponse } from "..";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
 export declare const HUB_PROJECT_ITEM_TYPE = "Web Mapping Application";
@@ -22,10 +23,11 @@ export declare function updateProject(project: IHubProject, requestOptions: IUse
  * @param identifier item id or slug
  * @param requestOptions
  */
-export declare function getProject(identifier: string, requestOptions: IRequestOptions): Promise<IHubProject>;
+export declare function fetchProject(identifier: string, requestOptions: IRequestOptions): Promise<IHubProject>;
 /**
  * Remove a Hub Project
  * @param id
  * @param requestOptions
  */
 export declare function destroyProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+export declare function searchProjects(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubProject>>;

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.17.0 - Thu Feb 17 2022 19:38:03 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.17.1 - Fri Feb 18 2022 21:45:18 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -8275,6 +8275,28 @@
             return clone;
         });
     }
+    /**
+     * Given an Item, fetch the data json and return an IModel
+     * @param item
+     * @param requestOptions
+     * @returns
+     */
+    function fetchModelFromItem(item, requestOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            var data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, getItemData(item.id, requestOptions)];
+                    case 1:
+                        data = _a.sent();
+                        return [2 /*return*/, {
+                                item: item,
+                                data: data,
+                            }];
+                }
+            });
+        });
+    }
 
     /**
      * To streamline passing of either a model id or the model itself, we use this function
@@ -9049,19 +9071,43 @@
      * @returns
      */
     function getItemBySlug(slug, requestOptions) {
+        return findItemsBySlug({ slug: slug }, requestOptions).then(function (results) {
+            if (results.length) {
+                return results[0];
+            }
+            else {
+                return null;
+            }
+        });
+    }
+    /**
+     * Find items by slug typeKeywords.
+     *
+     * Optional exclude parameter accepts the id of an item we expect to
+     * have this particular slug. This is used during update calls
+     * where we don't know if the slug specifically has been updated, but we
+     * don't want a false-postive from the item we are updating
+     *
+     * @param slug
+     * @param requestOptions
+     * @returns
+     */
+    function findItemsBySlug(slugInfo, requestOptions) {
         var opts = {
             q: "",
-            filter: "typekeywords:\"slug|" + slug + "\"",
+            filter: "typekeywords:\"slug|" + slugInfo.slug + "\"",
             authentication: requestOptions.authentication,
         };
+        // We need to check for other items w/ a slug during
+        // the update calls. For those scenarios we are interested
+        // in any _other_ items which may have a specific slug
+        // but not one specific item
+        if (slugInfo.exclude) {
+            opts.q = "NOT id:" + slugInfo.exclude;
+        }
         return searchItems(opts)
             .then(function (response) {
-            if (response.results.length) {
-                return response.results[0];
-            }
-            else {
-                return null;
-            }
+            return response.results;
         })
             .catch(function (e) {
             throw Error("Error in getItemBySlug " + e);
@@ -9079,20 +9125,20 @@
      * @param step
      * @returns
      */
-    function getUniqueSlug(slug, requestOptions, step) {
+    function getUniqueSlug(slugInfo, requestOptions, step) {
         if (step === void 0) { step = 0; }
-        var combined = slug;
+        var combinedSlug = slugInfo.slug;
         if (step) {
-            combined = slug + "-" + step;
+            combinedSlug = slugInfo.slug + "-" + step;
         }
-        return getItemBySlug(combined, requestOptions)
-            .then(function (result) {
-            if (result) {
+        return findItemsBySlug({ slug: combinedSlug, exclude: slugInfo.existingId }, requestOptions)
+            .then(function (results) {
+            if (results.length) {
                 step++;
-                return getUniqueSlug(slug, requestOptions, step);
+                return getUniqueSlug(slugInfo, requestOptions, step);
             }
             else {
-                return combined;
+                return combinedSlug;
             }
         })
             .catch(function (e) {
@@ -9143,6 +9189,48 @@
         return template;
     }
 
+    /**
+     * Upload a file to be used as the thumbnail for an item
+     * @param id
+     * @param file
+     * @param filename
+     * @param requestOptions
+     */
+    function setItemThumbnail(id, file, filename, requestOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            var opts, response, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        opts = __assign({ item: {
+                                id: id,
+                            }, params: {
+                                thumbnail: file,
+                            }, filename: filename }, requestOptions);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, updateItem(opts)];
+                    case 2:
+                        response = _a.sent();
+                        if (!response.success) {
+                            throw new HubError("Set Project Thumbnail", "Unknown error setting thumbnail.");
+                        }
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_1 = _a.sent();
+                        if (err_1 instanceof Error) {
+                            throw new HubError("Set Project Thumbnail", err_1.message, err_1);
+                        }
+                        else {
+                            throw new HubError("Set Project Thumbnail", "Unknown error setting thumbnail.");
+                        }
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    }
+
     /**
      * Manage forward and backward property mappings to
      * streamline conversion between the Hub entities, and
@@ -9246,6 +9334,7 @@
         name: "No title provided",
         tags: [],
         typeKeywords: ["IHubProject", "HubProject"],
+        status: "inactive",
     };
     /**
      * Default values for a new HubProject Model
@@ -9257,7 +9346,7 @@
             description: "No Description Provided",
             snippet: "",
             tags: [],
-            typeKeywords: [],
+            typeKeywords: ["Hub Project"],
             properties: {
                 slug: "",
             },
@@ -9265,7 +9354,6 @@
         data: {
             display: "about",
             timeline: {},
-            org: {},
             status: "inactive",
             contacts: [],
             schemaVersion: 1,
@@ -9346,7 +9434,7 @@
                         }
                         // Ensure slug is  unique
                         _a = project;
-                        return [4 /*yield*/, getUniqueSlug(project.slug, requestOptions)];
+                        return [4 /*yield*/, getUniqueSlug({ slug: project.slug }, requestOptions)];
                     case 1:
                         // Ensure slug is  unique
                         _a.slug = _b.sent();
@@ -9376,15 +9464,11 @@
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        // verify that the slug is unique
-                        // TODO: if the slug has not changed, we don't want to do this because
-                        // the existing item will cause this to increment
+                        // verify that the slug is unique, excluding the current project
                         _a = project;
-                        return [4 /*yield*/, getUniqueSlug(project.slug, requestOptions)];
+                        return [4 /*yield*/, getUniqueSlug({ slug: project.slug, existingId: project.id }, requestOptions)];
                     case 1:
-                        // verify that the slug is unique
-                        // TODO: if the slug has not changed, we don't want to do this because
-                        // the existing item will cause this to increment
+                        // verify that the slug is unique, excluding the current project
                         _a.slug = _b.sent();
                         return [4 /*yield*/, getModel(project.id, requestOptions)];
                     case 2:
@@ -9407,7 +9491,7 @@
      * @param identifier item id or slug
      * @param requestOptions
      */
-    function getProject(identifier, requestOptions) {
+    function fetchProject(identifier, requestOptions) {
         var getPrms;
         if (isGuid(identifier)) {
             // get item by id
@@ -9415,12 +9499,20 @@
         }
         else {
             // search for item using filter=typekeywords:slug|identifier
+            // although we could leverage searchProjects with an appropriate filter
+            // getModelBySlug is a generalized function that works for any type
             getPrms = getModelBySlug(identifier, requestOptions);
         }
         return getPrms.then(function (model) {
             // transform the model into a HubProject
             var mapper = new PropertyMapper(getProjectPropertyMap());
             var project = mapper.modelToObject(model, {});
+            var token;
+            if (requestOptions.authentication) {
+                var us = requestOptions.authentication;
+                token = us.token;
+            }
+            project.thumbnailUrl = getItemThumbnailUrl(model.item, requestOptions, token);
             return project;
         });
     }
@@ -9448,13 +9540,88 @@
     // i.e. delegate to searchContent or just do an item search
     // and convert to IHubProject objects.
     //
-    // export async function searchProjects(
-    //   filter: Filter<"content">,
-    //   opts: IHubSearchOptions
-    // ): Promise<ISearchResponse<IHubProject>> {
-    //   return _searchContent(filter, opts).then((results) => {
-    //   })
-    // }
+    function searchProjects(filter, options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var scopingFilter, projectFilter, expanded, so;
+            return __generator(this, function (_b) {
+                scopingFilter = {
+                    filterType: "content",
+                    typekeywords: {
+                        exact: ["HubProject"],
+                    },
+                };
+                projectFilter = mergeContentFilter([scopingFilter, filter]);
+                expanded = expandContentFilter(projectFilter);
+                so = serializeContentFilterForPortal(expanded);
+                // Aggregations
+                if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
+                    so.countFields = options.aggregations.join(",");
+                    so.countSize = 200;
+                }
+                // copy over various options
+                if (options.num) {
+                    so.num = options.num;
+                }
+                if (options.sortField) {
+                    so.sortField = options.sortField;
+                }
+                if (options.sortOrder) {
+                    so.sortOrder = options.sortOrder;
+                }
+                if (options.site) {
+                    so.site = cloneObject$1(options.site);
+                }
+                if (options.authentication) {
+                    so.authentication = options.authentication;
+                }
+                return [2 /*return*/, searchPortalProjects(so)];
+            });
+        });
+    }
+    /**
+     * Internal fn that takes
+     * @param searchOptions
+     * @returns
+     */
+    function searchPortalProjects(searchOptions) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, hasNext, modelPromises, models, mapper, token, us, projects;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, searchItems(searchOptions)];
+                    case 1:
+                        response = _a.sent();
+                        hasNext = response.nextStart > -1;
+                        modelPromises = response.results.map(function (itm) {
+                            return fetchModelFromItem(itm, {
+                                authentication: searchOptions.authentication,
+                            });
+                        });
+                        return [4 /*yield*/, Promise.all(modelPromises)];
+                    case 2:
+                        models = _a.sent();
+                        mapper = new PropertyMapper(getProjectPropertyMap());
+                        if (searchOptions.authentication) {
+                            us = searchOptions.authentication;
+                            token = us.token;
+                        }
+                        projects = models.map(function (m) {
+                            var prj = mapper.modelToObject(m, {});
+                            prj.thumbnailUrl = getItemThumbnailUrl(m.item, { authentication: searchOptions.authentication }, token);
+                            return prj;
+                        });
+                        return [2 /*return*/, {
+                                total: response.total,
+                                results: projects,
+                                facets: [],
+                                hasNext: hasNext,
+                                next: getNextFunction(searchOptions, response.nextStart, response.total, searchPortalProjects),
+                            }];
+                }
+            });
+        });
+    }
 
     /**
      * Centralized functions used to manage IHubProject instances
@@ -9563,6 +9730,18 @@
                 });
             });
         };
+        // DEPRECATED IN FAVOR OF .fetch()
+        // TODO: REMOVE AT NEXT MAJOR
+        /* istanbul ignore next */
+        HubProjectManager.prototype.get = function (identifier, requestOptions) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    // tslint:disable-next-line
+                    console.warn("HubProjectManager.get is deprecated and will be removed. Use .fetch() instead.");
+                    return [2 /*return*/, this.fetch(identifier, requestOptions)];
+                });
+            });
+        };
         /**
          * Fetch a Project via id or it's slug
          *
@@ -9577,10 +9756,51 @@
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
                     if (requestOptions || this.context.requestOptions) {
-                        return [2 /*return*/, getProject(identifier, requestOptions || this.context.requestOptions)];
+                        return [2 /*return*/, fetchProject(identifier, requestOptions || this.context.requestOptions)];
                     }
                     else {
-                        throw new HubError("Get Project", "Can not retrieve context.requestOptions from Context Manager. HubProjectManager is configured incorrectly.");
+                        throw new HubError("Fetch Project", "Can not retrieve context.requestOptions from Context Manager. HubProjectManager is configured incorrectly.");
+                    }
+                });
+            });
+        };
+        /**
+         * Search for Projects
+         *
+         * @param filter
+         * @param options
+         */
+        HubProjectManager.prototype.search = function (filter, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    // if we were not passed auth, and we have a session, use it
+                    if (!options.authentication && this.context.session) {
+                        options.authentication = this.context.session;
+                    }
+                    return [2 /*return*/, searchProjects(filter, options)];
+                });
+            });
+        };
+        /**
+         * Set the thumbnail for the Project
+         * @param id
+         * @param file
+         * @param filename
+         * @param requestOptions
+         * @returns
+         */
+        HubProjectManager.prototype.updateThumbnail = function (project, file, filename, requestOptions) {
+            return __awaiter(this, void 0, void 0, function () {
+                var ro;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            ro = requestOptions || this.context.userRequestOptions;
+                            return [4 /*yield*/, setItemThumbnail(project.id, file, filename, ro)];
+                        case 1:
+                            _a.sent();
+                            // get the item so we have updated props and timestamps
+                            return [2 /*return*/, this.fetch(project.id, requestOptions)];
                     }
                 });
             });
@@ -12076,21 +12296,19 @@
      *
      * myHub.context.currentUser //=> {username: "casey", ...} as IUser
      *
-     * const projectStore = await myHub.getProjectStore();
-     *
-     * const pavingProject = await projectStore.create({name: "12th Street Paving"});
+     * const pavingProject = await myHub.projects.create({name: "12th Street Paving"});
      * pavingProject.summary = "This is the 2024 planned paving of 12th Street, between 8th and 11th Ave";
-     * await projectStore.update(pavingProject);
+     * await myHub.projects.update(pavingProject);
      * ```
      *
-     * This is a convenience class. Hub Stores can be created
+     * This is a convenience class. Hub Managers can be created
      * directly, or the underlying functions can be imported an used
      * as need for scenarios where these class structures introduce
      * unwanted complexity
      */
     var Hub = /** @class */ (function () {
         /**
-         * Private so we can employ a factory function should we need
+         * Private so we can employ a factory function to do
          * async work during creation
          * @param contextManager
          */
@@ -12098,9 +12316,7 @@
             this._contextManager = contextManager;
         }
         /**
-         * Factory function to construct a new HubProjectStore instance.
-         *
-         * Note: Used so that we could do async actions in the ctor.
+         * Factory function to construct a new Hub instance.
          * @param contextManager
          * @returns
          */
@@ -12134,7 +12350,7 @@
         });
         Object.defineProperty(Hub.prototype, "projects", {
             /**
-             * Create a Project Store connected to the current Hub
+             * HubProjectManager for the current Hub
              * @returns
              */
             get: function () {
@@ -12566,9 +12782,12 @@
     exports.fetchAndUploadThumbnail = fetchAndUploadThumbnail;
     exports.fetchHubTranslation = fetchHubTranslation;
     exports.fetchImageAsBlob = fetchImageAsBlob;
+    exports.fetchModelFromItem = fetchModelFromItem;
+    exports.fetchProject = fetchProject;
     exports.fetchSite = fetchSite;
     exports.filterBy = filterBy;
     exports.findBy = findBy;
+    exports.findItemsBySlug = findItemsBySlug;
     exports.flattenArray = flattenArray;
     exports.generateRandomString = generateRandomString;
     exports.getCategory = getCategory;
@@ -12609,7 +12828,6 @@
     exports.getPortalApiUrl = getPortalApiUrl;
     exports.getPortalBaseFromOrgUrl = getPortalBaseFromOrgUrl;
     exports.getPortalUrl = getPortalUrl;
-    exports.getProject = getProject;
     exports.getProp = getProp;
     exports.getProps = getProps;
     exports.getProxyUrl = getProxyUrl;
@@ -12681,6 +12899,7 @@
     exports.replaceItemId = replaceItemId;
     exports.runRevertableTask = runRevertableTask;
     exports.saveSession = saveSession;
+    exports.searchProjects = searchProjects;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
     exports.serializeDateRange = serializeDateRange;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;
@@ -12692,6 +12911,7 @@
     exports.setContentHubId = setContentHubId;
     exports.setContentSiteUrls = setContentSiteUrls;
     exports.setContentType = setContentType;
+    exports.setItemThumbnail = setItemThumbnail;
     exports.setProp = setProp;
     exports.setSlugKeyword = setSlugKeyword;
     exports.shareItemToGroups = shareItemToGroups;