@esri/hub-common 9.31.3 → 9.33.0

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/IHubSearchResponse.d.ts

@@ -0,0 +1,17 @@
+import { IFacet } from "./IFacet";
+/**
+ * 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 IHubSearchResponse<T> {
+    total: number;
+    results: T[];
+    hasNext: boolean;
+    next: (params?: any) => Promise<IHubSearchResponse<T>>;
+    facets?: IFacet[];
+}

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,8 @@ export * from "./ICatalog";
 export * from "./ICollection";
 export * from "./IFacet";
 export * from "./IFacetOption";
+export * from "./IHubApiSearchRequest";
+export * from "./IHubSearchOptions";
+export * from "./IHubSearchResult";
+export * from "./IHubSearchResponse";
 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,27 @@ import { IFacet } from "./IFacet";
 export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
     filterType: T;
 };
+export interface IFilterGroup<T extends FilterType> {
+    operation?: "AND" | "OR";
+    filters: Array<Filter<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;
+    /**
+     * DEPRECATED use item
+     */
     content: IContentFilterDefinition;
     user: IUserFilterDefinition;
     group: IGroupFilterDefinition;
@@ -40,17 +55,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 +214,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/search/utils.d.ts

@@ -69,6 +69,7 @@ export declare function mergeSearchOptions(so1: ISearchOptions, so2: ISearchOpti
 /**
  * @private
  * Serialize a `MatchOptions` into `q` or `filter` on an `ISearchOptions`
+ * DEPRECATED: Serialization should be handled in filter-utils.ts
  * @param key
  * @param opts
  * @returns

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.32.1 - Thu May 19 2022 17:14:39 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6885,7 +6885,7 @@
      */
     var isDataSourceOfItem = function (resource, item) {
         var serviceUrl = item.url && parseServiceUrl(item.url);
-        return serviceUrl && resource.linkage.includes(serviceUrl);
+        return (serviceUrl && resource.linkage && resource.linkage.includes(serviceUrl));
     };
     /**
      * Returns the url for an additional resource.
@@ -13141,11 +13141,12 @@
     /**
      * @private
      * Serialize a `MatchOptions` into `q` or `filter` on an `ISearchOptions`
+     * DEPRECATED: Serialization should be handled in filter-utils.ts
      * @param key
      * @param opts
      * @returns
      */
-    function serializeMatchOptions(key, opts) {
+    function serializeMatchOptions$1(key, opts) {
         var result = {
             q: "",
             filter: "",
@@ -13170,7 +13171,7 @@
             var groupFilterableFields = ["title", "typekeywords", "owner"];
             var filterableFields = __spreadArrays(userFilterableFields, itemFilterableFields, groupFilterableFields);
             if (filterableFields.includes(key)) {
-                result.filter = serializeStringOrArray("AND", key, opts.exact);
+                result.filter = serializeStringOrArray$1("AND", key, opts.exact);
             }
             else {
                 // Treat it the same as .all
@@ -13196,18 +13197,18 @@
         }
         // Handle the other props
         if (opts.any) {
-            result.q = serializeStringOrArray("OR", key, opts.any);
+            result.q = serializeStringOrArray$1("OR", key, opts.any);
         }
         if (opts.all) {
             result.q =
                 (result.q ? result.q + " AND " : "") +
-                    serializeStringOrArray("AND", key, opts.all);
+                    serializeStringOrArray$1("AND", key, opts.all);
         }
         if (opts.not) {
             // negate the entries if they are not
             result.q =
                 (result.q ? result.q + " AND " : "") +
-                    serializeStringOrArray("OR", "-" + key, opts.not);
+                    serializeStringOrArray$1("OR", "-" + key, opts.not);
         }
         return result;
     }
@@ -13218,7 +13219,7 @@
      * @param range
      * @returns
      */
-    function serializeDateRange(key, range) {
+    function serializeDateRange$1(key, range) {
         return {
             q: key + ":[" + range.from + " TO " + range.to + "]",
             filter: "",
@@ -13232,10 +13233,13 @@
      * @param value
      * @returns
      */
-    function serializeStringOrArray(join, key, value) {
+    function serializeStringOrArray$1(join, key, value) {
         var q = "";
         if (Array.isArray(value)) {
-            q = "(" + key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\")";
+            q = key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\"";
+            if (value.length > 1) {
+                q = "(" + q + ")";
+            }
         }
         else {
             q = key + ":\"" + value + "\"";
@@ -13716,11 +13720,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions may go into either q or filter
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         return result;
@@ -15966,11 +15970,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // searchUserAccess is also a top-level property
@@ -16099,11 +16103,11 @@
             var key = _a[0], value = _a[1];
             // MatchOptions fields
             if (!specialProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+                result = mergeSearchOptions(result, serializeMatchOptions$1(key, value), "AND");
             }
             // Dates only go into q
             if (dateProps.includes(key)) {
-                result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+                result = mergeSearchOptions(result, serializeDateRange$1(key, value), "AND");
             }
         });
         // disabled is also a top-level property
@@ -16604,6 +16608,154 @@
         return catalog;
     }
 
+    /**
+     * Expand a Filter into it's more expressive structure so it can be
+     * serialized deterministically.
+     *
+     * Props with type `string | string[] | MatchOptions` expand into `IMatchOptions`
+     * Props relative-dates are expanded into formal date-ranges
+     * @param filter
+     * @returns
+     */
+    function expandFilter(filter) {
+        var result = {};
+        var dateProps = ["created", "modified", "lastlogin"];
+        var copyProps = ["filterType", "term", "searchUserAccess"];
+        var nonMatchOptionsFields = __spreadArrays(dateProps, copyProps);
+        // Do the conversion
+        Object.entries(filter).forEach(function (_a) {
+            var key = _a[0], value = _a[1];
+            // Handle MatchOptions fields
+            if (!nonMatchOptionsFields.includes(key)) {
+                // setProp side-steps typescript complaining
+                setProp(key, valueToMatchOptions(value), result);
+            }
+            // Handle Date fields
+            if (dateProps.includes(key)) {
+                var dateFieldValue = cloneObject$1(getProp(filter, key));
+                if (getProp(filter, key + ".type") === "relative-date") {
+                    setProp(key, relativeDateToDateRange(dateFieldValue), result);
+                }
+                else {
+                    setProp(key, dateFieldValue, result);
+                }
+            }
+            // Handle fields that are just copied forward
+            if (copyProps.includes(key) && filter.hasOwnProperty(key)) {
+                setProp(key, value, result);
+            }
+        });
+        return result;
+    }
+    /**
+     * Serialize a FilterGroup of any type for Portal
+     * @param filterGroups
+     * @returns
+     */
+    function serializeFilterGroupsForPortal(filterGroups) {
+        var result = {
+            q: "",
+            filter: "",
+        };
+        result.q = filterGroups.map(serializeGroup).join(" AND ");
+        return result;
+    }
+    /**
+     * Serialize the filters in a FitlerGroup into a Portal Query
+     * @param group
+     * @returns
+     */
+    function serializeGroup(group) {
+        var operation = group.operation || "AND";
+        var filters = group.filters.map(expandFilter);
+        return filters.map(serializeFilter).join(" " + operation + " ");
+    }
+    /**
+     * Serialize a Filter into a Portal Query
+     * @param filter
+     * @returns
+     */
+    function serializeFilter(filter) {
+        var dateProps = ["created", "modified"];
+        var specialProps = __spreadArrays(["filterType", "searchUserAccess", "term"], dateProps);
+        // TODO: Look at using reduce vs .map and remove the `.filter`
+        var stringFilters = Object.entries(filter)
+            .map(function (_a) {
+            var key = _a[0], value = _a[1];
+            if (!specialProps.includes(key)) {
+                return serializeMatchOptions(key, value);
+            }
+            if (dateProps.includes(key)) {
+                return serializeDateRange(key, value);
+            }
+            if (key === "term") {
+                return value;
+            }
+        })
+            .filter(function (e) { return e !== undefined; });
+        // eslint-disable-next-line unicorn/prefer-ternary
+        if (stringFilters.length > 1) {
+            return "(" + stringFilters.join(" AND ") + ")";
+        }
+        else {
+            return stringFilters[0];
+        }
+    }
+    /**
+     * Serialize MatchOptions into portal syntax
+     * @param key
+     * @param value
+     * @returns
+     */
+    function serializeMatchOptions(key, value) {
+        var result = "";
+        if (value.any) {
+            result = "" + serializeStringOrArray("OR", key, value.any);
+        }
+        if (value.all) {
+            result =
+                (result ? result + " AND " : "") +
+                    ("" + serializeStringOrArray("AND", key, value.all));
+        }
+        if (value.not) {
+            // negate the entries if they are not
+            result =
+                (result ? result + " AND " : "") +
+                    ("" + serializeStringOrArray("OR", "-" + key, value.not));
+        }
+        // TODO HANDLE EXACT
+        return result;
+    }
+    /**
+     * Serialize a date-range into Portal syntax
+     * @param key
+     * @param range
+     * @returns
+     */
+    function serializeDateRange(key, range) {
+        return key + ":[" + range.from + " TO " + range.to + "]";
+    }
+    /**
+     * Serialize a `string` or `string[]` into a string
+     * @param join
+     * @param key
+     * @param value
+     * @returns
+     */
+    function serializeStringOrArray(join, key, value) {
+        var q = "";
+        if (Array.isArray(value)) {
+            q = key + ":\"" + value.join("\" " + join + " " + key + ":\"") + "\"";
+            if (value.length > 1) {
+                q = "(" + q + ")";
+            }
+        }
+        else {
+            q = key + ":\"" + value + "\"";
+        }
+        return q;
+    }
+
     /**
      * Add telemetry config object
      * @private
@@ -18487,6 +18639,7 @@
     exports.expandApi = expandApi;
     exports.expandApis = expandApis;
     exports.expandContentFilter = expandContentFilter;
+    exports.expandFilter = expandFilter;
     exports.expandGroupFilter = expandGroupFilter;
     exports.expandTypeField = expandTypeField;
     exports.expandUserFilter = expandUserFilter;
@@ -18629,12 +18782,13 @@
     exports.searchSites = searchSites;
     exports.serializeCollectionState = serializeCollectionState;
     exports.serializeContentFilterForPortal = serializeContentFilterForPortal;
-    exports.serializeDateRange = serializeDateRange;
+    exports.serializeDateRange = serializeDateRange$1;
+    exports.serializeFilterGroupsForPortal = serializeFilterGroupsForPortal;
     exports.serializeGroupFilterForPortal = serializeGroupFilterForPortal;
-    exports.serializeMatchOptions = serializeMatchOptions;
+    exports.serializeMatchOptions = serializeMatchOptions$1;
     exports.serializeModel = serializeModel;
     exports.serializeSpatialReference = serializeSpatialReference;
-    exports.serializeStringOrArray = serializeStringOrArray;
+    exports.serializeStringOrArray = serializeStringOrArray$1;
     exports.serializeUserFilterForPortal = serializeUserFilterForPortal;
     exports.setContentHubId = setContentHubId;
     exports.setContentSiteUrls = setContentSiteUrls;