@esri/hub-common 9.31.3 → 9.32.0

package/dist/es2017/core/types/index.js

@@ -15,4 +15,5 @@ export * from "./IHubSiteTheme";
 export * from "./IHubTimeline";
 export * from "./IItemEnrichments";
 export * from "./IServerEnrichments";
+export * from "./types";
 //# sourceMappingURL=index.js.map

package/dist/es2017/core/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,SAAS,CAAC"}

package/dist/es2017/core/types/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/es2017/core/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/core/types/types.ts"],"names":[],"mappings":""}

package/dist/es2017/search/types/IHubApiSearchRequest.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubApiSearchRequest.js.map

package/dist/es2017/search/types/IHubApiSearchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubApiSearchRequest.js","sourceRoot":"","sources":["../../../../src/search/types/IHubApiSearchRequest.ts"],"names":[],"mappings":""}

package/dist/es2017/search/types/IHubSearchOptions.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubSearchOptions.js.map

package/dist/es2017/search/types/IHubSearchOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchOptions.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchOptions.ts"],"names":[],"mappings":""}

package/dist/es2017/search/types/IHubSearchResult.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubSearchResult.js.map

package/dist/es2017/search/types/IHubSearchResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchResult.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchResult.ts"],"names":[],"mappings":""}

package/dist/es2017/search/types/index.js

@@ -2,5 +2,8 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubApiSearchRequest";
+export * from "./IHubSearchOptions";
+export * from "./IHubSearchResult";
 export * from "./types";
 //# sourceMappingURL=index.js.map

package/dist/es2017/search/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}

package/dist/esm/core/types/index.js

@@ -15,4 +15,5 @@ export * from "./IHubSiteTheme";
 export * from "./IHubTimeline";
 export * from "./IItemEnrichments";
 export * from "./IServerEnrichments";
+export * from "./types";
 //# sourceMappingURL=index.js.map

package/dist/esm/core/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,SAAS,CAAC"}

package/dist/esm/core/types/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/esm/core/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/core/types/types.ts"],"names":[],"mappings":""}

package/dist/esm/search/types/IHubApiSearchRequest.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubApiSearchRequest.js.map

package/dist/esm/search/types/IHubApiSearchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubApiSearchRequest.js","sourceRoot":"","sources":["../../../../src/search/types/IHubApiSearchRequest.ts"],"names":[],"mappings":""}

package/dist/esm/search/types/IHubSearchOptions.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubSearchOptions.js.map

package/dist/esm/search/types/IHubSearchOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchOptions.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchOptions.ts"],"names":[],"mappings":""}

package/dist/esm/search/types/IHubSearchResult.js

@@ -0,0 +1 @@
+//# sourceMappingURL=IHubSearchResult.js.map

package/dist/esm/search/types/IHubSearchResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchResult.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchResult.ts"],"names":[],"mappings":""}

package/dist/esm/search/types/index.js

@@ -2,5 +2,8 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubApiSearchRequest";
+export * from "./IHubSearchOptions";
+export * from "./IHubSearchResult";
 export * from "./types";
 //# sourceMappingURL=index.js.map

package/dist/esm/search/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC"}

package/dist/node/core/types/index.js

@@ -18,4 +18,5 @@ tslib_1.__exportStar(require("./IHubSiteTheme"), exports);
 tslib_1.__exportStar(require("./IHubTimeline"), exports);
 tslib_1.__exportStar(require("./IItemEnrichments"), exports);
 tslib_1.__exportStar(require("./IServerEnrichments"), exports);
+tslib_1.__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/core/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,mEAAyC;AACzC,2DAAiC;AACjC,8DAAoC;AACpC,sDAA4B;AAC5B,sDAA4B;AAC5B,2DAAiC;AACjC,2DAAiC;AACjC,kEAAwC;AACxC,uDAA6B;AAC7B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,0DAAgC;AAChC,yDAA+B;AAC/B,6DAAmC;AACnC,+DAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/types/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,mEAAyC;AACzC,2DAAiC;AACjC,8DAAoC;AACpC,sDAA4B;AAC5B,sDAA4B;AAC5B,2DAAiC;AACjC,2DAAiC;AACjC,kEAAwC;AACxC,uDAA6B;AAC7B,qDAA2B;AAC3B,wDAA8B;AAC9B,qDAA2B;AAC3B,0DAAgC;AAChC,yDAA+B;AAC/B,6DAAmC;AACnC,+DAAqC;AACrC,kDAAwB"}

package/dist/node/core/types/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/node/core/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/core/types/types.ts"],"names":[],"mappings":""}

package/dist/node/search/types/IHubApiSearchRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHubApiSearchRequest.js.map

package/dist/node/search/types/IHubApiSearchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubApiSearchRequest.js","sourceRoot":"","sources":["../../../../src/search/types/IHubApiSearchRequest.ts"],"names":[],"mappings":""}

package/dist/node/search/types/IHubSearchOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHubSearchOptions.js.map

package/dist/node/search/types/IHubSearchOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchOptions.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchOptions.ts"],"names":[],"mappings":""}

package/dist/node/search/types/IHubSearchResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHubSearchResult.js.map

package/dist/node/search/types/IHubSearchResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubSearchResult.js","sourceRoot":"","sources":["../../../../src/search/types/IHubSearchResult.ts"],"names":[],"mappings":""}

package/dist/node/search/types/index.js

@@ -5,5 +5,8 @@ tslib_1.__exportStar(require("./ICatalog"), exports);
 tslib_1.__exportStar(require("./ICollection"), exports);
 tslib_1.__exportStar(require("./IFacet"), exports);
 tslib_1.__exportStar(require("./IFacetOption"), exports);
+tslib_1.__exportStar(require("./IHubApiSearchRequest"), exports);
+tslib_1.__exportStar(require("./IHubSearchOptions"), exports);
+tslib_1.__exportStar(require("./IHubSearchResult"), exports);
 tslib_1.__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/search/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,wDAA8B;AAC9B,mDAAyB;AACzB,yDAA+B;AAC/B,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/search/types/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,wDAA8B;AAC9B,mDAAyB;AACzB,yDAA+B;AAC/B,iEAAuC;AACvC,8DAAoC;AACpC,6DAAmC;AACnC,kDAAwB"}

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

@@ -78,6 +78,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     updatedDate: Date;
     updatedDateSource: string;
     type: string;
+    source?: string;
     statistics?: any;
     data?: {
         [propName: string]: any;

package/dist/types/core/types/IHubEntityBase.d.ts

@@ -14,8 +14,8 @@ export interface IHubEntityBase {
      */
     name: string;
     /**
-     * Simple summary of the Entity.
-     * For items, this is typically the `snippet` property.
+     * Sanitized summary derived from item.snippet, item.description,
+     * group.description, user.description, event.description etc
      */
     summary?: string;
     /**
@@ -23,11 +23,14 @@ export interface IHubEntityBase {
      */
     createdDate: Date;
     /**
-     * Source of the creation date
+     * Source of the creation date as a property path
+     * e.q `item.created`
      */
     createdDateSource: string;
     /**
-     * Date the entity was last updated
+     * Date when the entity was last updated
+     * Depending on the entity, this could be derived
+     * in many different ways
      */
     updatedDate: Date;
     /**
@@ -35,7 +38,14 @@ export interface IHubEntityBase {
      */
     updatedDateSource: string;
     /**
-     * Type of entity
+     * For Item backed results, this will be `item.type`
+     * Otherwise it will be "Group", "User", "Event" etc
      */
     type: string;
+    /**
+     * Source of the entity.
+     * Exact logic for this tbd, but the intent is to allow the
+     * result to be attributed to something other than "owner"
+     */
+    source?: string;
 }

package/dist/types/core/types/IHubEntityManager.d.ts

@@ -1,6 +1,7 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { Filter, IHubSearchOptions } from "../../search/types/types";
+import { Filter } from "../../search/types/types";
+import { IHubSearchOptions } from "../../search/types/IHubSearchOptions";
 import { ISearchResponse } from "../../types";
 /**
  * Baseline CRUD+Search functions required for all Store classes

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

@@ -15,3 +15,4 @@ export * from "./IHubSiteTheme";
 export * from "./IHubTimeline";
 export * from "./IItemEnrichments";
 export * from "./IServerEnrichments";
+export * from "./types";

package/dist/types/core/types/types.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Access level for Platform Entities
+ */
+export declare type AccessLevel = "public" | "shared" | "org" | "private";

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

@@ -1,15 +1,56 @@
 import { IFacetOption } from "./IFacetOption";
+/**
+ * Definition of a Facet shown in the Gallery UI.
+ *
+ * If a `field` is specified, the Facet will be "dynamic" in that
+ * it will request aggregations for the field and use the returned
+ * values to create the FacetOptions.
+ *
+ * `Facet` contains and array if `FacetOptions`. When selected
+ * in the UI, a FilterGroup is constructed from the `Facet.operation`
+ * and the `Filters` are from the selected `FacetOptions`.
+ */
 export interface IFacet {
-    label: string;
-    key: string;
-    aggField?: string;
+    /**
+     * Translated label for the facet
+     */
+    label?: string;
+    /**
+     * Unique key, used for query params and telemetry
+     */
+    key?: string;
+    /**
+     * field to generate the facet from
+     */
+    field?: string;
+    /**
+     * limit of aggregates returned. Max 200
+     */
     aggLimit?: number;
-    display: "single-select" | "multi-select" | "date-range" | "histogram";
+    /**
+     * Display for this facet. Not all facets will be compatible with all displays
+     */
+    display?: "map" | "single-select" | "multi-select" | "date-range" | "histogram";
+    /**
+     * State of the Facet
+     */
     state?: "open" | "closed";
+    /**
+     * Individual options for this Facet
+     */
     options?: IFacetOption[];
-    operation?: ("OR" | "AND")[];
+    /**
+     * Operation is passed into the FilterGroup that is constructed
+     * when the Facet is serialized.
+     * Implemetations should default to "OR" if not specified
+     */
+    operation?: "OR" | "AND";
+    /**
+     * Number of facet options to show by default. Only applies to `multi-select`, and defaults to all.
+     */
     optionLimit?: number;
     accordionClosed?: boolean;
     type?: "single-select" | "multi-select" | "date-range" | "histogram";
     pageSize?: number;
+    aggField?: string;
 }

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

@@ -1,8 +1,30 @@
 import { Filter, FilterType } from "./types";
+/**
+ * Facet Option shown in the UI as either a radio button or checkbox
+ */
 export interface IFacetOption {
+    /**
+     * Translated label for the option
+     */
     label: string;
+    /**
+     * Unique key, used for query params and telemetry
+     */
     key: string;
+    /**
+     * For aggregate based Facets, the count of entries in the index with this value
+     */
     count?: number;
+    /**
+     * Is this option selected when the UI loads
+     */
     selected: boolean;
-    filter: Filter<FilterType>;
+    /**
+     * Filters to be applied when this option is selected
+     */
+    filters?: Array<Filter<FilterType>>;
+    /**
+     * DEPRECATED: Filter to be applied when this option is selected
+     */
+    filter?: Filter<FilterType>;
 }

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

@@ -0,0 +1,16 @@
+import { Filter, IFilterGroup, FilterType } from "./types";
+import { IHubSearchOptions } from "./IHubSearchOptions";
+/**
+ * Structure for making Hub API Search Requests
+ */
+export interface IHubApiSearchRequest {
+    /**
+     * Can be a string like `term:"water"`, a single filter like `{ filterType: "item", term: "water" }`
+     * or an array of IFilterGroups, which allows for complex queries.
+     */
+    q: string | Filter<FilterType> | Array<IFilterGroup<FilterType>>;
+    /**
+     * Search options like the number of results to return, sorting, aggregations etc
+     */
+    options: IHubSearchOptions;
+}

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

@@ -0,0 +1,26 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { IModel } from "../..";
+import { NamedApis, IApiDefinition } from "./types";
+/**
+ * Requestable Enrichments
+ */
+export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
+/**
+ * Search Options
+ */
+export interface IHubSearchOptions {
+    aggFields?: string[];
+    aggLimit?: number;
+    api?: NamedApis | IApiDefinition;
+    authentication?: UserSession;
+    bbox?: string;
+    enrichments?: Enrichments[];
+    fields?: string;
+    num?: number;
+    page?: string;
+    sortField?: string;
+    sortOrder?: "desc" | "asc";
+    start?: number;
+    aggregations?: string[];
+    site?: IModel;
+}

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

@@ -0,0 +1,60 @@
+import { HubFamily, IHubGeography } from "../..";
+import { AccessLevel, IHubEntityBase } from "../../core";
+/**
+ * Standardized light-weight search result structure, applicable to all
+ * types of search results - users, groups, content, events etc
+ */
+export interface IHubSearchResult extends IHubEntityBase {
+    /**
+     * Access level of the backing entity
+     */
+    access: AccessLevel;
+    /**
+     * Hub Family
+     */
+    family: HubFamily;
+    /**
+     * Owner; Applies to Items and Groups
+     */
+    owner?: string;
+    /**
+     * Fully qualified thumbnail url for items, groups, users
+     * Will not have the token appended. Consuming app needs to
+     * check the value of `access` and apply the token as needed
+     */
+    thumbnailUrl: string;
+    /**
+     * Hash of pre-computed urls
+     */
+    urls: {
+        /**
+         * Canononical ArcGIS Online Url for this entity (if applicable)
+         */
+        portalHome?: string;
+        /**
+         * Relative url, which can be appended to a Site's root Url
+         * e.g. /datasets/3ef8c7a, or /events/june-meeting
+         * This is much easier than passing a Site into the search
+         * system so the full url can be computed
+         */
+        relative: string;
+        /**
+         * Allow for arbitrary other urls, including `.customUrl` which
+         * can ben generated client-side in the gallery via a callback
+         */
+        [key: string]: string;
+    };
+    /**
+     * Geometry connected to this entity
+     * For items, it will default to the extent,
+     * but may be derived from a boundary resource
+     * or the extent of a layer
+     */
+    geometry?: IHubGeography;
+    /**
+     * Optional metadata hash
+     * Any specified enrichments will be attached in here, as well
+     * as tags, typekeywords and culture
+     */
+    metadata?: Record<string, any>;
+}

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

@@ -2,4 +2,7 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubApiSearchRequest";
+export * from "./IHubSearchOptions";
+export * from "./IHubSearchResult";
 export * from "./types";

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

@@ -1,5 +1,5 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, IModel } from "../..";
+import { IHubContent, AccessLevel } from "../..";
 import { IFacet } from "./IFacet";
 /**
  * Generic filter used with various search functions.
@@ -24,12 +24,20 @@ import { IFacet } from "./IFacet";
 export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
     filterType: T;
 };
+/**
+ * Groups of filters with an operation specifying how the
+ * filters should be connected when serialized
+ */
+export interface IFilterGroup<T extends FilterType> {
+    operation?: "AND" | "OR";
+    filters: Array<Filter<T>>;
+}
 /**
  * Defines the valid FilterTypes for use with `Filter<T extends FilterType>`
  * See [Filter](../Filter)
  */
 export interface IFilterTypeMap {
-    any: IAnyFilterDefinition;
+    item: IItemFilter;
     content: IContentFilterDefinition;
     user: IUserFilterDefinition;
     group: IGroupFilterDefinition;
@@ -40,17 +48,22 @@ export declare type FilterType = keyof IFilterTypeMap;
  * Common set of fields that are reasonable to apply at the
  * top level of a Catalog
  */
-export interface IAnyFilterDefinition {
-    title?: string | string[] | IMatchOptions;
-    access?: string | string[] | IMatchOptions;
+export interface IItemFilter {
+    access?: AccessLevel | AccessLevel[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
-    modified?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
+    snippet?: string | string[] | IMatchOptions;
     group?: string | string[] | IMatchOptions;
+    id?: string | string[] | IMatchOptions;
+    modified?: IDateRange<number> | IRelativeDate;
     orgid?: string | string[] | IMatchOptions;
-    type?: string | NamedContentFilter | Array<string | NamedContentFilter> | IMatchOptions;
+    term?: string;
+    title?: string | string[] | IMatchOptions;
+    type?: string | string[] | IMatchOptions;
+    typekeywords?: string | string[] | IMatchOptions;
+    [key: string]: any;
 }
 /**
  * Fields related to Content based searches
@@ -194,24 +207,6 @@ export interface IMatchOptions {
      */
     exact?: string | string[];
 }
-/**
- * Search Options
- */
-export interface IHubSearchOptions {
-    site?: IModel;
-    authentication?: UserSession;
-    sortField?: string;
-    sortOrder?: "desc" | "asc";
-    page?: string;
-    start?: number;
-    num?: number;
-    aggFields?: string[];
-    aggLimit?: number;
-    bbox?: string;
-    fields?: string;
-    api?: NamedApis | IApiDefinition;
-    aggregations?: string[];
-}
 /**
  * searchContent return
  */

package/dist/types/types.d.ts

@@ -134,7 +134,7 @@ export declare type IRevertableTaskResult = IRevertableTaskSuccess | IRevertable
  * DEPRECATED: Use HubFamily instead
  */
 export declare type HubType = "member" | "team" | "event" | "dataset" | "document" | "map" | "app" | "site" | "initiative" | "template" | "organization";
-export declare type HubFamily = "people" | "team" | "event" | "dataset" | "document" | "feedback" | "map" | "app" | "site" | "initiative" | "template" | "content";
+export declare type HubFamily = "app" | "content" | "dataset" | "document" | "event" | "feedback" | "initiative" | "map" | "people" | "site" | "team" | "template";
 /**
  * Visibility levels of a Hub resource
  */

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.31.2 - Thu May 12 2022 23:19:02 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.31.3 - Tue May 17 2022 15:35:53 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "9.31.3",
+  "version": "9.32.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "unpkg": "dist/umd/common.umd.js",