@esri/hub-common 17.19.0 → 17.20.0

package/dist/node/sites/_internal/applyCatalogStructureMigration.js

@@ -4,22 +4,31 @@ exports.applyCatalogStructureMigration = void 0;
 const get_with_default_1 = require("../../objects/get-with-default");
 const upgradeCatalogSchema_1 = require("../../search/upgradeCatalogSchema");
 const util_1 = require("../../util");
+const get_prop_1 = require("../../objects/get-prop");
 /**
  * Add the default catalog structure to the Site model
- * Note: This in-memory migration is only applies via `fetchSite(..):IHubSite` and not
- * the older `getSiteById(...):IModel`. Changes made in this migration will not be
- * persisted to AGO until all other parts of the application stop relying on the legacy
- * catalog implementation
  * @param model
  * @returns
  */
 function applyCatalogStructureMigration(model) {
-    const siteCatalog = get_with_default_1.getWithDefault(model.data, "catalog", {});
+    const siteCatalog = get_with_default_1.getWithDefault(model, "data.catalog", {});
     // This _shouldn't_ happen, but some of our testing sites might have this
     // migration already persisted in AGO. In that case, we ignore and move on
     if (!siteCatalog.schemaVersion) {
         const clonedModel = util_1.cloneObject(model);
         clonedModel.data.catalog = upgradeCatalogSchema_1.upgradeCatalogSchema(siteCatalog);
+        // The umbrella site needs a special predicate added to the catalog to ensure
+        // that its item scope only includes results shared to open data groups.
+        // We also don't want to include the groups from the site model
+        if (get_prop_1.getProp(clonedModel, "data.values.isUmbrella")) {
+            clonedModel.data.catalog.scopes.item.filters = [
+                {
+                    predicates: [{ openData: true }],
+                },
+            ];
+            // The umbrella site doesn't have an event scope
+            clonedModel.data.catalog.scopes.event.filters = [];
+        }
         // applyCatalogSchema sets the catalog to `Default Catalog` but this fn previously
         // set it to `Default Site Catalog`. Overriding title to `Default Site Catalog` here
         // to prevent any potential regressions

package/dist/node/sites/_internal/applyCatalogStructureMigration.js.map

@@ -1 +1 @@
-{"version":3,"file":"applyCatalogStructureMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/applyCatalogStructureMigration.ts"],"names":[],"mappings":";;;AAAA,qEAAgE;AAChE,4EAAyE;AAEzE,qCAAyC;AAEzC;;;;;;;;GAQG;AACH,SAAgB,8BAA8B,CAAC,KAAa;IAC1D,MAAM,WAAW,GAAG,iCAAc,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC9D,yEAAyE;IACzE,0EAA0E;IAC1E,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;QAC9B,MAAM,WAAW,GAAG,kBAAW,CAAC,KAAK,CAAC,CAAC;QACvC,WAAW,CAAC,IAAI,CAAC,OAAO,GAAG,2CAAoB,CAAC,WAAW,CAAC,CAAC;QAC7D,kFAAkF;QAClF,oFAAoF;QACpF,uCAAuC;QACvC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,sBAAsB,CAAC;QACxD,OAAO,WAAW,CAAC;KACpB;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAdD,wEAcC"}
+{"version":3,"file":"applyCatalogStructureMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/applyCatalogStructureMigration.ts"],"names":[],"mappings":";;;AAAA,qEAAgE;AAChE,4EAAyE;AAEzE,qCAAyC;AACzC,qDAAiD;AAGjD;;;;GAIG;AACH,SAAgB,8BAA8B,CAAC,KAAa;IAC1D,MAAM,WAAW,GAAG,iCAAc,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,CAG3D,CAAC;IACF,yEAAyE;IACzE,0EAA0E;IAC1E,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;QAC9B,MAAM,WAAW,GAAG,kBAAW,CAAC,KAAK,CAAC,CAAC;QACvC,WAAW,CAAC,IAAI,CAAC,OAAO,GAAG,2CAAoB,CAAC,WAAW,CAAC,CAAC;QAE7D,6EAA6E;QAC7E,wEAAwE;QACxE,+DAA+D;QAC/D,IAAI,kBAAO,CAAC,WAAW,EAAE,wBAAwB,CAAC,EAAE;YACjD,WAAW,CAAC,IAAI,CAAC,OAAuB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,GAAG;gBAC9D;oBACE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;iBACjC;aACF,CAAC;YACF,gDAAgD;YAC/C,WAAW,CAAC,IAAI,CAAC,OAAuB,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC;SACrE;QAED,kFAAkF;QAClF,oFAAoF;QACpF,uCAAuC;QACtC,WAAW,CAAC,IAAI,CAAC,OAAuB,CAAC,KAAK,GAAG,sBAAsB,CAAC;QACzE,OAAO,WAAW,CAAC;KACpB;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AA/BD,wEA+BC"}

package/dist/node/sites/_internal/applyDefaultCollectionMigration.js

@@ -22,8 +22,15 @@ const searchCategoriesToCollections_1 = require("../searchCategoriesToCollection
  */
 function applyDefaultCollectionMigration(model) {
     const searchCategories = objects_1.getWithDefault(model.data, "values.searchCategories", undefined);
-    model.data.catalog.collections =
-        searchCategoriesToCollections_1.searchCategoriesToCollections(searchCategories);
+    const collections = searchCategoriesToCollections_1.searchCategoriesToCollections(searchCategories);
+    // The umbrella site needs to have every collection visible by default,
+    // unlike other sites that have the "site" collection hidden by default.
+    if (objects_1.getProp(model, "data.values.isUmbrella")) {
+        collections.forEach((c) => {
+            c.displayConfig.hidden = false;
+        });
+    }
+    objects_1.setProp("data.catalog.collections", collections, model);
     return model;
 }
 exports.applyDefaultCollectionMigration = applyDefaultCollectionMigration;

package/dist/node/sites/_internal/applyDefaultCollectionMigration.js.map

@@ -1 +1 @@
-{"version":3,"file":"applyDefaultCollectionMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/applyDefaultCollectionMigration.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAE/C,oFAAiF;AAEjF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,+BAA+B,CAAC,KAAa;IAC3D,MAAM,gBAAgB,GAAG,wBAAc,CACrC,KAAK,CAAC,IAAI,EACV,yBAAyB,EACzB,SAAS,CACV,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW;QAC5B,6DAA6B,CAAC,gBAAgB,CAAC,CAAC;IAElD,OAAO,KAAK,CAAC;AACf,CAAC;AAVD,0EAUC"}
+{"version":3,"file":"applyDefaultCollectionMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/applyDefaultCollectionMigration.ts"],"names":[],"mappings":";;;AAAA,2CAAiE;AAEjE,oFAAiF;AAIjF;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,+BAA+B,CAAC,KAAa;IAC3D,MAAM,gBAAgB,GAAG,wBAAc,CACrC,KAAK,CAAC,IAAI,EACV,yBAAyB,EACzB,SAAS,CACY,CAAC;IAExB,MAAM,WAAW,GACf,6DAA6B,CAAC,gBAAgB,CAAC,CAAC;IAElD,uEAAuE;IACvE,wEAAwE;IACxE,IAAI,iBAAO,CAAC,KAAK,EAAE,wBAAwB,CAAC,EAAE;QAC5C,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACxB,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,KAAK,CAAC;QACjC,CAAC,CAAC,CAAC;KACJ;IAED,iBAAO,CAAC,0BAA0B,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;IAExD,OAAO,KAAK,CAAC;AACf,CAAC;AArBD,0EAqBC"}

package/dist/types/content/_internal/internalContentUtils.d.ts

@@ -44,7 +44,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
         control?: import("../../hub-types").AccessControl;
         groups?: import("@esri/arcgis-rest-portal").IGroup[];
     };
-    family?: "map" | "template" | "document" | "content" | "initiative" | "project" | "site" | "discussion" | "event" | "organization" | "channel" | "app" | "dataset" | "feedback" | "people" | "team" | "eventAttendee";
+    family?: "map" | "template" | "document" | "content" | "initiative" | "project" | "site" | "discussion" | "event" | "organization" | "channel" | "eventAttendee" | "app" | "dataset" | "feedback" | "people" | "team";
     categories?: string[];
     isDownloadable: boolean;
     structuredLicense?: import("../..").IStructuredLicense;

package/dist/types/content/get-family.d.ts

@@ -4,7 +4,7 @@ import { HubFamily } from "../hub-types";
  * @param type item type
  * @returns Hub family
  */
-export declare function getFamily(type: string): "map" | "template" | "document" | "content" | "initiative" | "project" | "site" | "discussion" | "event" | "organization" | "channel" | "app" | "dataset" | "feedback" | "people" | "team" | "eventAttendee";
+export declare function getFamily(type: string): "map" | "template" | "document" | "content" | "initiative" | "project" | "site" | "discussion" | "event" | "organization" | "channel" | "eventAttendee" | "app" | "dataset" | "feedback" | "people" | "team";
 /**
  * return the types associated with a provided Hub Family
  * Overrides are provided to match getFamily implementation

package/dist/types/hub-types.d.ts

@@ -283,21 +283,6 @@ export interface IHubTeam extends IGroup {
         [key: string]: any;
     };
 }
-/**
- * Defines a generic search response interface with parameterized result type
- * for different types of searches
- *
- * total - total number of results
- * results - potentially paginated list of results
- * hasNext - boolean flag for if there are any more pages ofresults
- * next - invokable function for obtaining next page of results
- */
-export interface ISearchResponse<T> {
-    total: number;
-    results: T[];
-    hasNext: boolean;
-    next: (params?: any) => Promise<ISearchResponse<T>>;
-}
 /**
  * BEGIN CONTENT UPLOAD RELATED TYPES
  * Please note that the below enum/types are duplicated from the AGO

package/dist/types/search/_internal/commonHelpers/getNextPortalCallback.d.ts

@@ -0,0 +1,15 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubSearchResponse } from "../../types/IHubSearchResponse";
+import { IPagingParams } from "@esri/arcgis-rest-portal";
+declare type ICommonNextOptions = IRequestOptions & IPagingParams;
+/**
+ * @private
+ * Create a `.next()` function for portal search type
+ * @param request
+ * @param nextStart
+ * @param total
+ * @param fn
+ * @returns
+ */
+export declare function getNextPortalCallback<I extends ICommonNextOptions, O>(request: I, nextStart: number, total: number, fn: (r: I) => Promise<IHubSearchResponse<O>>): () => Promise<IHubSearchResponse<O>>;
+export {};

package/dist/types/search/_internal/portalSearchItems.d.ts

@@ -48,17 +48,6 @@ interface IWellKnownItemPredicates {
     $page: IPredicate[];
 }
 export declare const WellKnownItemPredicates: IWellKnownItemPredicates;
-/**
- * @private
- * Add filter blocks from a well-known item collection if indicated.
- * This is meant to simplify query construction for common use cases.
- *
- * Only exported for testing.
- *
- * @param query query to add collection filters to
- * @returns a copy of the query with the additional filters
- */
-export declare function applyWellKnownCollectionFilters(query: IQuery): IQuery;
 /**
  * @private
  * Convert a Filter Group to expand well-known type filters

package/dist/types/search/types/IHubCatalog.d.ts

@@ -1,5 +1,4 @@
 import { CARD_TITLE_TAGS, CORNERS, DROP_SHADOWS } from "../../core/schemas/shared/enums";
-import { WellKnownCollection } from "../wellKnownCatalog";
 export declare type CatalogType = "content" | "exclusion";
 export interface IHubCatalog {
     /**
@@ -38,10 +37,8 @@ export interface IHubCatalog {
      */
     displayConfig?: ICatalogDisplayConfig;
 }
-export interface ICatalogScope extends Partial<Record<EntityType, IQuery>> {
-}
-export interface ICatalogDisplayConfig extends Partial<Record<EntityType, IGalleryDisplayConfig>> {
-}
+export declare type ICatalogScope = Partial<Record<EntityType, IQuery>>;
+export declare type ICatalogDisplayConfig = Partial<Record<EntityType, IGalleryDisplayConfig>>;
 export interface IHubCollection {
     /**
      * String to show in the UI. translated.
@@ -91,13 +88,6 @@ export interface IQuery {
      * ensure we query the correct API
      */
     targetEntity: EntityType;
-    /**
-     * An id for a well known collection that the query should use.
-     *
-     * Note: The collection's filters will be used _in addition_ to
-     * any existing filters within the IQuery.filters array
-     */
-    collection?: WellKnownCollection;
     /**
      * Filters that make up the query
      */

package/dist/types/search/types/IHubSearchResponse.d.ts

@@ -26,7 +26,7 @@ export interface IHubSearchResponse<T> {
     /**
      * Function that fetches the next page of results
      */
-    next: (params?: any) => Promise<IHubSearchResponse<T>>;
+    next: () => Promise<IHubSearchResponse<T>>;
     /**
      * Array of requested aggregations
      */

package/dist/types/search/utils.d.ts

@@ -1,7 +1,6 @@
-import { IUser, ArcGISIdentityManager } from "@esri/arcgis-rest-request";
-import { IGroup, ISearchGroupUsersOptions, ISearchOptions, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
+import { IUser } from "@esri/arcgis-rest-request";
+import { IGroup, SearchQueryBuilder } from "@esri/arcgis-rest-portal";
 import { IHubSite } from "../core";
-import { ISearchResponse } from "../hub-types";
 import { IHubSearchResult } from "./types";
 import { IPredicate, IQuery } from "./types/IHubCatalog";
 import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis, Kilobyte } from "./types/types";
@@ -41,16 +40,6 @@ export declare function valueToMatchOptions(value: string | string[] | IMatchOpt
  * @returns
  */
 export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;
-/**
- * @private
- * Create a `.next()` function for a type
- * @param request
- * @param nextStart
- * @param total
- * @param fn
- * @returns
- */
-export declare function getNextFunction<T>(request: ISearchOptions | ISearchGroupUsersOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): (authentication?: ArcGISIdentityManager) => Promise<ISearchResponse<T>>;
 /**
  * Construct a the full url to a group thumbnail
  *

package/dist/types/sites/_internal/applyCatalogStructureMigration.d.ts

@@ -1,10 +1,6 @@
 import { IModel } from "../../hub-types";
 /**
  * Add the default catalog structure to the Site model
- * Note: This in-memory migration is only applies via `fetchSite(..):IHubSite` and not
- * the older `getSiteById(...):IModel`. Changes made in this migration will not be
- * persisted to AGO until all other parts of the application stop relying on the legacy
- * catalog implementation
  * @param model
  * @returns
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "17.19.0",
+  "version": "17.20.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",