@esri/hub-common 9.10.1 → 9.10.2

package/dist/es2017/search/content-utils.js

@@ -0,0 +1,416 @@
+import { cloneObject } from "..";
+import { mergeDateRange, mergeMatchOptions, mergeSearchOptions, relativeDateToDateRange, serializeDateRange, serializeMatchOptions, valueToMatchOptions, } from "./utils";
+// TODO: Implement $dataset
+const ContentFilterExpansions = {
+    $apps: [
+        {
+            type: {
+                any: [
+                    "Code Sample",
+                    "Web Mapping Application",
+                    "Mobile Application",
+                    "Application",
+                    "Desktop Application Template",
+                    "Desktop Application",
+                    "Operation View",
+                    "Dashboard",
+                    "Operations Dashboard Extension",
+                    "Workforce Project",
+                    "Insights Workbook",
+                    "Insights Page",
+                    "Insights Model",
+                    "Hub Page",
+                    "Hub Initiative",
+                    "Hub Site Application",
+                    "StoryMap",
+                    "Web Experience",
+                    "Web Experience Template",
+                    "Form",
+                ],
+                not: [
+                    "Code Attachment",
+                    "Featured Items",
+                    "Symbol Set",
+                    "Color Set",
+                    "Windows Viewer Add In",
+                    "Windows Viewer Configuration",
+                    "Map Area",
+                    "Indoors Map Configuration",
+                ],
+            },
+            typekeywords: {
+                not: ["MapAreaPackage", "SMX"],
+            },
+        },
+    ],
+    $storymap: [
+        {
+            type: "StoryMap",
+        },
+        {
+            type: "Web Mapping Application",
+            typekeywords: ["Story Map"],
+        },
+    ],
+    $dashboard: [
+        {
+            type: "Dashboard",
+            typekeywords: {
+                any: ["Dashboard"],
+                not: ["ArcGIS Operation View", "Add In", "Extension"],
+            },
+        },
+    ],
+    $dataset: [],
+    $experience: [
+        {
+            type: {
+                any: ["Web Experience"],
+                not: ["Web Experience Template"],
+            },
+        },
+    ],
+    $site: [
+        {
+            type: ["Hub Site Application", "Site Application"],
+        },
+        {
+            type: ["Web Mapping Application"],
+            typekeywords: ["hubSite"],
+        },
+    ],
+    $initiative: [
+        {
+            type: {
+                any: "Hub Initiative",
+                not: "Hub Initiative Template",
+            },
+        },
+    ],
+    $document: [
+        {
+            typekeywords: {
+                any: "Document",
+                not: ["MapAreaPackage", "SMX"],
+            },
+            type: {
+                any: [
+                    "Image",
+                    "Layout",
+                    "Desktop Style",
+                    "Project Template",
+                    "Report Template",
+                    "Pro Report",
+                    "Statistical Data Collection",
+                    "360 VR Experience",
+                    "netCDF",
+                    "PDF",
+                    "CSV",
+                    "Administrative Report",
+                    "Raster function template",
+                ],
+                not: [
+                    "Image Service",
+                    "Explorer Document",
+                    "Explorer Map",
+                    "Globe Document",
+                    "Scene Document",
+                    "Code Attachment",
+                    "Featured Items",
+                    "Symbol Set",
+                    "ColorSet",
+                    "Windows Viewer Add In",
+                    "Windows Viewer Configuration",
+                    "Map Area",
+                    "Indoors Map Configuration",
+                ],
+            },
+        },
+    ],
+};
+/**
+ * @private
+ * Convert portal search response to items
+ * @param response
+ * @returns
+ */
+export function convertPortalResponseToFacets(response) {
+    var _a;
+    const result = [];
+    if ((_a = response.aggregations) === null || _a === void 0 ? void 0 : _a.counts) {
+        response.aggregations.counts.forEach((entry) => {
+            const facet = {
+                label: entry.fieldName,
+                attribute: entry.fieldName,
+                type: "multi-select",
+            };
+            const options = [];
+            entry.fieldValues.forEach((fv) => {
+                const filter = {
+                    filterType: "content",
+                };
+                filter[entry.fieldName] = fv.value;
+                const fo = {
+                    label: fv.value,
+                    value: fv.value,
+                    count: fv.count,
+                    selected: false,
+                    filter,
+                };
+                options.push(fo);
+            });
+            facet.options = options;
+            result.push(facet);
+        });
+    }
+    return result;
+}
+/**
+ * Merge `Filter<"content">` objects
+ *
+ * Useful in components which may get partial filters from a variety of
+ * sub-components, which are then combined into a single filter prior
+ * to executing the search.
+ * @param filters
+ * @returns
+ */
+export function mergeContentFilter(filters) {
+    // expand all the filters so all prop types are consistent
+    const expanded = filters.map(expandContentFilter);
+    // now we can merge based on fields
+    const dateFields = ["created", "modified"];
+    const specialFields = ["filterType", "subFilters", "term", ...dateFields];
+    const result = expanded.reduce((acc, entry) => {
+        // process fields
+        Object.entries(entry).forEach(([key, value]) => {
+            if (acc.hasOwnProperty(key)) {
+                /* istanbul ignore else */
+                if (!specialFields.includes(key)) {
+                    acc[key] = mergeMatchOptions(acc[key], value);
+                }
+                else if (dateFields.includes(key)) {
+                    acc[key] = mergeDateRange(acc[key], value);
+                }
+                else if (key === "term") {
+                    acc[key] = `${acc[key]} ${value}`;
+                }
+                else if (key === "subFilters") {
+                    acc[key] = mergeSubFilters(acc[key], value);
+                }
+            }
+            else {
+                acc[key] = cloneObject(value);
+            }
+        });
+        return acc;
+    }, {});
+    result.filterType = "content";
+    return result;
+}
+function mergeSubFilters(sf1, sf2) {
+    // Simplistic implementation: we just merge the arrays
+    // in the future we may try to de-dupe things as a safeguard
+    return [...sf1, ...sf2];
+}
+/**
+ * Prior to serialization into the query syntax for the backing APIs, we first expand [Filters](../Filter)
+ *
+ * Filter's can express their intent in a very terse form, but to ensure consistent structures
+ * we expand them into their more verbose form.
+ *
+ * i.e. `title: "Water"` expands into `title: { any: ["Water"]}`
+ *
+ * - "well known" type values are expanded
+ *    - i.e. `type: "$storymap"` expands into two `subFilter` entries
+ * - Fields defined as `string | string[] | MatchOptions` will be converted to a `MatchOptions`
+ * - RelativeDate fields are converted to DateRange<number>
+ *
+ * @param filter
+ * @returns
+ */
+export function expandContentFilter(filter) {
+    // Expand filter.type first
+    const expandedTypeFilter = expandTypeField(filter);
+    // Expand subfilters
+    // Guard - JS Clients could send in anything...
+    if (Array.isArray(filter.subFilters)) {
+        // Convert any strings into the coresponding ContentFilterDefinition
+        expandedTypeFilter.subFilters = expandedTypeFilter.subFilters.reduce((acc, entry) => {
+            if (typeof entry === "string") {
+                // if the entry is not a key of ContentFilterExpansions
+                // we just skip over it
+                if (ContentFilterExpansions[entry]) {
+                    acc = acc.concat(ContentFilterExpansions[entry]);
+                }
+            }
+            else {
+                acc.push(entry); // should be a ContentFilterDefinition
+            }
+            return acc;
+        }, []);
+    }
+    // Convert all props into MatchOptions/DateRanges
+    return convertContentDefinitionToFilter(expandedTypeFilter);
+}
+/**
+ * @private
+ * Expand from a well-known "type" into it's longer form
+ *
+ * i.e. `type: "$storymap"` expands into two subFilters entries
+ *
+ * @param filter
+ * @returns
+ */
+export function expandTypeField(filter) {
+    const clone = cloneObject(filter);
+    // ensure subFilters is defined as an array
+    clone.subFilters = clone.subFilters || [];
+    if (clone.type) {
+        // if .type is an Array...
+        if (Array.isArray(clone.type)) {
+            // remove any well-known-keys and move their expansions into subfilters
+            clone.type = clone.type.reduce((acc, entry) => {
+                if (isWellKnownType(entry)) {
+                    // working with dynamic objects in typescript requires some assertions
+                    const key = entry;
+                    clone.subFilters = clone.subFilters.concat(lookupTypeFilters(key));
+                }
+                else {
+                    acc.push(entry);
+                }
+                return acc;
+            }, []);
+        }
+        else if (isWellKnownType(clone.type)) {
+            const key = clone.type;
+            clone.subFilters = clone.subFilters.concat(lookupTypeFilters(key));
+            delete clone.type;
+        }
+        else {
+            // Future?: implement "expansions" inside MatchOptions
+            // For now, we only attempt expansions for filter.type
+            // if it's a string, or for strings inside an array
+            // Unclear if it's of value to allow short-cuts inside MatchOptions
+        }
+    }
+    return clone;
+}
+/**
+ * Is the argument a well-known type "key"
+ *
+ * Accepts `string`, `string[]` or `IMatchOptions`
+ * but only string values can possibly be properties
+ * on `ContentFilterExpansions`
+ * @param key
+ * @returns
+ */
+function isWellKnownType(key) {
+    let result = false;
+    if (typeof key === "string") {
+        result = key in ContentFilterExpansions;
+    }
+    return result;
+}
+function lookupTypeFilters(key) {
+    return ContentFilterExpansions[key];
+}
+/**
+ * @private
+ * Convert a `ContentFilterDefinition` to a `ContentFilter`
+ *
+ * ContentFilter is a narrower version of ContentFilterDefinition, without
+ * the union types. Using a ContentFilter makes working with the structure
+ * in typescript much easier.
+ *
+ * @param filter
+ * @returns
+ */
+export function convertContentDefinitionToFilter(filter) {
+    const result = {};
+    if (filter.term) {
+        result.term = filter.term;
+    }
+    const dateProps = ["created", "modified"];
+    // Some properties should not get converted to MatchOptions
+    const specialProps = ["filterType", "subFilters", "term", ...dateProps];
+    // Do the conversion
+    Object.entries(filter).forEach(([key, value]) => {
+        if (!specialProps.includes(key)) {
+            result[key] = valueToMatchOptions(value);
+        }
+    });
+    // Special Cases
+    // subFilters; Array of ContentFilterDefinitions
+    if (filter.subFilters && Array.isArray(filter.subFilters)) {
+        // downcast - would be nice to skip this or use some other constuct
+        const sf = filter.subFilters;
+        result.subFilters = sf.map(convertContentDefinitionToFilter);
+    }
+    // Dates; Ensure they are all DateRange<number>
+    dateProps.forEach((fld) => {
+        if (filter[fld]) {
+            if (filter[fld].type === "relative-date") {
+                result[fld] = relativeDateToDateRange(filter[fld]);
+            }
+            else {
+                result[fld] = cloneObject(filter[fld]);
+            }
+        }
+    });
+    return result;
+}
+/**
+ * @private
+ * Serialize a `ContentFilter` into an `ISearchOptions` for use with `searchItems`
+ * @param filter
+ * @returns
+ */
+export function serializeContentFilterForPortal(filter) {
+    let searchOptions = convertContentFilterToSearchOptions(filter);
+    if (filter.subFilters) {
+        const subFilterOptions = filter.subFilters.reduce((acc, entry) => {
+            // Next guard is present b/c this can be used from javascript
+            // but our tests are written in typescript which prevents us
+            // from hitting the else
+            /* istanbul ignore else */
+            if (typeof entry === "object") {
+                acc = mergeSearchOptions(acc, convertContentFilterToSearchOptions(entry), "OR");
+            }
+            return acc;
+        }, { q: "", filter: "" });
+        // merge with searchOptions using AND
+        searchOptions = mergeSearchOptions(searchOptions, subFilterOptions, "AND");
+    }
+    // term is always last, and pre-pended on searchOptions.q
+    if (filter.term) {
+        searchOptions.q = `${filter.term} ${searchOptions.q}`.trim();
+    }
+    return searchOptions;
+}
+/**
+ * @private
+ * Convert a ContentFilter to a SearchOptions
+ *
+ * @param filter
+ * @returns
+ */
+export function convertContentFilterToSearchOptions(filter) {
+    let result = {
+        q: "",
+        filter: "",
+    };
+    const dateProps = ["created", "modified"];
+    const specialProps = ["filterType", "subFilters", "term", ...dateProps];
+    Object.entries(filter).forEach(([key, value]) => {
+        // MatchOptions may go into either q or filter
+        if (!specialProps.includes(key)) {
+            result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+        }
+        // Dates only go into q
+        if (dateProps.includes(key)) {
+            result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+        }
+    });
+    return result;
+}
+//# sourceMappingURL=content-utils.js.map

package/dist/es2017/search/content-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-utils.js","sourceRoot":"","sources":["../../../src/search/content-utils.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAWjC,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,SAAS,CAAC;AAEjB,2BAA2B;AAC3B,MAAM,uBAAuB,GAA6B;IACxD,KAAK,EAAE;QACL;YACE,IAAI,EAAE;gBACJ,GAAG,EAAE;oBACH,aAAa;oBACb,yBAAyB;oBACzB,oBAAoB;oBACpB,aAAa;oBACb,8BAA8B;oBAC9B,qBAAqB;oBACrB,gBAAgB;oBAChB,WAAW;oBACX,gCAAgC;oBAChC,mBAAmB;oBACnB,mBAAmB;oBACnB,eAAe;oBACf,gBAAgB;oBAChB,UAAU;oBACV,gBAAgB;oBAChB,sBAAsB;oBACtB,UAAU;oBACV,gBAAgB;oBAChB,yBAAyB;oBACzB,MAAM;iBACP;gBACD,GAAG,EAAE;oBACH,iBAAiB;oBACjB,gBAAgB;oBAChB,YAAY;oBACZ,WAAW;oBACX,uBAAuB;oBACvB,8BAA8B;oBAC9B,UAAU;oBACV,2BAA2B;iBAC5B;aACF;YACD,YAAY,EAAE;gBACZ,GAAG,EAAE,CAAC,gBAAgB,EAAE,KAAK,CAAC;aAC/B;SACF;KACF;IACD,SAAS,EAAE;QACT;YACE,IAAI,EAAE,UAAU;SACjB;QACD;YACE,IAAI,EAAE,yBAAyB;YAC/B,YAAY,EAAE,CAAC,WAAW,CAAC;SAC5B;KACF;IACD,UAAU,EAAE;QACV;YACE,IAAI,EAAE,WAAW;YACjB,YAAY,EAAE;gBACZ,GAAG,EAAE,CAAC,WAAW,CAAC;gBAClB,GAAG,EAAE,CAAC,uBAAuB,EAAE,QAAQ,EAAE,WAAW,CAAC;aACtD;SACF;KACF;IACD,QAAQ,EAAE,EAAE;IACZ,WAAW,EAAE;QACX;YACE,IAAI,EAAE;gBACJ,GAAG,EAAE,CAAC,gBAAgB,CAAC;gBACvB,GAAG,EAAE,CAAC,yBAAyB,CAAC;aACjC;SACF;KACF;IACD,KAAK,EAAE;QACL;YACE,IAAI,EAAE,CAAC,sBAAsB,EAAE,kBAAkB,CAAC;SACnD;QACD;YACE,IAAI,EAAE,CAAC,yBAAyB,CAAC;YACjC,YAAY,EAAE,CAAC,SAAS,CAAC;SAC1B;KACF;IACD,WAAW,EAAE;QACX;YACE,IAAI,EAAE;gBACJ,GAAG,EAAE,gBAAgB;gBACrB,GAAG,EAAE,yBAAyB;aAC/B;SACF;KACF;IACD,SAAS,EAAE;QACT;YACE,YAAY,EAAE;gBACZ,GAAG,EAAE,UAAU;gBACf,GAAG,EAAE,CAAC,gBAAgB,EAAE,KAAK,CAAC;aAC/B;YACD,IAAI,EAAE;gBACJ,GAAG,EAAE;oBACH,OAAO;oBACP,QAAQ;oBACR,eAAe;oBACf,kBAAkB;oBAClB,iBAAiB;oBACjB,YAAY;oBACZ,6BAA6B;oBAC7B,mBAAmB;oBACnB,QAAQ;oBACR,KAAK;oBACL,KAAK;oBACL,uBAAuB;oBACvB,0BAA0B;iBAC3B;gBACD,GAAG,EAAE;oBACH,eAAe;oBACf,mBAAmB;oBACnB,cAAc;oBACd,gBAAgB;oBAChB,gBAAgB;oBAChB,iBAAiB;oBACjB,gBAAgB;oBAChB,YAAY;oBACZ,UAAU;oBACV,uBAAuB;oBACvB,8BAA8B;oBAC9B,UAAU;oBACV,2BAA2B;iBAC5B;aACF;SACF;KACF;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAC3C,QAAsD;;IAEtD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,UAAI,QAAQ,CAAC,YAAY,0CAAE,MAAM,EAAE;QACjC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAW;gBACpB,KAAK,EAAE,KAAK,CAAC,SAAS;gBACtB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,IAAI,EAAE,cAAc;aACrB,CAAC;YAEF,MAAM,OAAO,GAAmB,EAAE,CAAC;YAEnC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;gBAC/B,MAAM,MAAM,GAAsB;oBAChC,UAAU,EAAE,SAAS;iBACtB,CAAC;gBACF,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;gBACnC,MAAM,EAAE,GAAiB;oBACvB,KAAK,EAAE,EAAE,CAAC,KAAK;oBACf,KAAK,EAAE,EAAE,CAAC,KAAK;oBACf,KAAK,EAAE,EAAE,CAAC,KAAK;oBACf,QAAQ,EAAE,KAAK;oBACf,MAAM;iBACP,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAiC;IAEjC,0DAA0D;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAClD,mCAAmC;IACnC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC3C,MAAM,aAAa,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IAE1E,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QAC5C,iBAAiB;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAC3B,0BAA0B;gBAC1B,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAChC,GAAG,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;iBAC/C;qBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACnC,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;iBAC5C;qBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;oBACzB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;iBACnC;qBAAM,IAAI,GAAG,KAAK,YAAY,EAAE;oBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;iBAC7C;aACF;iBAAM;gBACL,GAAG,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAuB,CAAC,CAAC;IAE5B,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;IAE9B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CACtB,GAAqE,EACrE,GAAqE;IAErE,sDAAsD;IACtD,4DAA4D;IAC5D,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAyB;IAC3D,2BAA2B;IAC3B,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEnD,oBAAoB;IACpB,+CAA+C;IAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACpC,oEAAoE;QACpE,kBAAkB,CAAC,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,MAAM,CAClE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,uDAAuD;gBACvD,uBAAuB;gBACvB,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE;oBAClC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC;iBAClD;aACF;iBAAM;gBACL,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,sCAAsC;aACxD;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAgC,CACjC,CAAC;KACH;IACD,iDAAiD;IACjD,OAAO,gCAAgC,CAAC,kBAAkB,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,MAAyB;IACvD,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAsB,CAAC;IACvD,2CAA2C;IAC3C,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC;IAC1C,IAAI,KAAK,CAAC,IAAI,EAAE;QACd,0BAA0B;QAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC7B,uEAAuE;YACvE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;gBAC5C,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;oBAC1B,sEAAsE;oBACtE,MAAM,GAAG,GAAG,KAA6C,CAAC;oBAC1D,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;iBACpE;qBAAM;oBACL,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACjB;gBACD,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAAc,CAAC,CAAC;SACpB;aAAM,IAAI,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACtC,MAAM,GAAG,GAAG,KAAK,CAAC,IAA4C,CAAC;YAC/D,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;YACnE,OAAO,KAAK,CAAC,IAAI,CAAC;SACnB;aAAM;YACL,sDAAsD;YACtD,sDAAsD;YACtD,mDAAmD;YACnD,mEAAmE;SACpE;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,eAAe,CAAC,GAAsC;IAC7D,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,MAAM,GAAG,GAAG,IAAI,uBAAuB,CAAC;KACzC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CACxB,GAAyC;IAEzC,OAAO,uBAAuB,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gCAAgC,CAC9C,MAAgC;IAEhC,MAAM,MAAM,GAAG,EAAoB,CAAC;IAEpC,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;KAC3B;IAED,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,YAAY,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxE,oBAAoB;IACpB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,MAAM,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,KAAK,CAAkB,CAAC;SAC3D;IACH,CAAC,CAAC,CAAC;IAEH,gBAAgB;IAChB,gDAAgD;IAChD,IAAI,MAAM,CAAC,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QACzD,mEAAmE;QACnE,MAAM,EAAE,GAAG,MAAM,CAAC,UAAwC,CAAC;QAC3D,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;KAC9D;IAED,+CAA+C;IAC/C,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACxB,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE;YACf,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,KAAK,eAAe,EAAE;gBACxC,MAAM,CAAC,GAAG,CAAC,GAAG,uBAAuB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACpD;iBAAM;gBACL,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACxC;SACF;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAC7C,MAAsB;IAEtB,IAAI,aAAa,GAAG,mCAAmC,CAAC,MAAM,CAAC,CAAC;IAEhE,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,MAAM,gBAAgB,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAC/C,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,6DAA6D;YAC7D,4DAA4D;YAC5D,wBAAwB;YACxB,0BAA0B;YAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,GAAG,GAAG,kBAAkB,CACtB,GAAG,EACH,mCAAmC,CAAC,KAAK,CAAC,EAC1C,IAAI,CACL,CAAC;aACH;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAoB,CACxC,CAAC;QACF,qCAAqC;QACrC,aAAa,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;KAC5E;IACD,yDAAyD;IACzD,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,aAAa,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;KAC9D;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mCAAmC,CACjD,MAAsB;IAEtB,IAAI,MAAM,GAAG;QACX,CAAC,EAAE,EAAE;QACL,MAAM,EAAE,EAAE;KACO,CAAC;IAEpB,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,8CAA8C;QAC9C,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,MAAM,GAAG,kBAAkB,CACzB,MAAM,EACN,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,EACjC,KAAK,CACN,CAAC;SACH;QACD,uBAAuB;QACvB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,GAAG,kBAAkB,CACzB,MAAM,EACN,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,EAC9B,KAAK,CACN,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/es2017/search/group-utils.js

@@ -0,0 +1,135 @@
+import { mergeDateRange, mergeMatchOptions, mergeSearchOptions, relativeDateToDateRange, serializeDateRange, serializeMatchOptions, valueToMatchOptions, } from ".";
+import { cloneObject, getProp, setProp } from "..";
+/**
+ *
+ * Merge `Filter<"group">` objects
+ *
+ * Useful in components which may get partial filters from a variety of
+ * sub-components, which are then combined into a single filter prior
+ * to executing the search.
+ * @param filters
+ * @returns
+ */
+export function mergeGroupFilters(filters) {
+    // expand all the filters so all prop types are consistent
+    const expanded = filters.map(expandGroupFilter);
+    // now we can merge based on fields
+    const dateFields = ["created", "modified"];
+    const specialFields = ["filterType", "term", ...dateFields];
+    // acc is initialized as Filter<group> but also needs it
+    // in the function signature... for reasons?!
+    const result = expanded.reduce((acc, entry) => {
+        // process fields
+        Object.entries(entry).forEach(([key, value]) => {
+            // Note: getProp/setProp are used to get around
+            // typescript issues with string indexing
+            if (acc.hasOwnProperty(key)) {
+                const existingValue = getProp(acc, key);
+                // if the key is not to a special field
+                if (!specialFields.includes(key)) {
+                    // treat as an IMatchOptions
+                    setProp(key, mergeMatchOptions(existingValue, value), acc);
+                }
+                else if (dateFields.includes(key)) {
+                    // treat as IDateRange
+                    setProp(key, mergeDateRange(existingValue, value), acc);
+                }
+                else if (key === "term") {
+                    // append terms
+                    acc[key] = `${acc[key]} ${value}`;
+                }
+            }
+            else {
+                // Acc does not have an entry for this yet
+                // so just clone it
+                setProp(key, cloneObject(value), acc);
+            }
+        });
+        return acc;
+    }, {
+        filterType: "group",
+    });
+    return result;
+}
+/**
+ * Prior to serialization into the query syntax for the backing APIs, we first expand [Filters](../Filter)
+ *
+ * Filter's can express their intent in a very terse form, but to ensure consistent structures
+ * we expand them into their more verbose form.
+ *
+ * i.e. `title: "Water"` expands into `title: { any: ["Water"]}`
+ *
+ * - Fields defined as `string | string[] | MatchOptions` will be converted to a `MatchOptions`
+ * - RelativeDate fields are converted to DateRange<number>
+ *
+ * @param filter
+ * @returns
+ */
+export function expandGroupFilter(filter) {
+    const result = {};
+    const dateProps = ["created", "modified"];
+    // Some properties should not get converted to MatchOptions
+    const specialProps = ["term", "searchUserAccess", ...dateProps];
+    // Do the conversion
+    Object.entries(filter).forEach(([key, value]) => {
+        // handle Matchish fields
+        if (!specialProps.includes(key)) {
+            // setProp side-steps typescript complaining
+            setProp(key, valueToMatchOptions(value), result);
+        }
+        // Handle date fields
+        if (dateProps.includes(key)) {
+            const dateFieldValue = cloneObject(getProp(filter, key));
+            if (getProp(filter, `${key}.type`) === "relative-date") {
+                setProp(key, relativeDateToDateRange(dateFieldValue), result);
+            }
+            else {
+                setProp(key, dateFieldValue, result);
+            }
+        }
+    });
+    // searchUserAccess is boolean, so we check if the prop exists
+    // vs checking if the value is truthy
+    if (filter.hasOwnProperty("searchUserAccess")) {
+        result.searchUserAccess = filter.searchUserAccess;
+    }
+    if (filter.term) {
+        result.term = filter.term;
+    }
+    return result;
+}
+/**
+ * @private
+ * Serialize an `IGroupFilterDefinition` into an `ISearchOptions` for use
+ * with `searchGroups`
+ * @param filter
+ * @returns
+ */
+export function serializeGroupFilterForPortal(filter) {
+    let result = {
+        q: "",
+        filter: "",
+    };
+    const dateProps = ["created", "modified"];
+    const specialProps = ["term", "searchUserAccess", "filterType", ...dateProps];
+    Object.entries(filter).forEach(([key, value]) => {
+        // MatchOptions fields
+        if (!specialProps.includes(key)) {
+            result = mergeSearchOptions(result, serializeMatchOptions(key, value), "AND");
+        }
+        // Dates only go into q
+        if (dateProps.includes(key)) {
+            result = mergeSearchOptions(result, serializeDateRange(key, value), "AND");
+        }
+    });
+    // searchUserAccess is also a top-level property
+    if (filter.hasOwnProperty("searchUserAccess")) {
+        result.searchUserAccess = filter.searchUserAccess;
+    }
+    // add the term
+    if (filter.term) {
+        result.q = `${filter.term} ${result.q}`.trim();
+    }
+    return result;
+}
+//# sourceMappingURL=group-utils.js.map

package/dist/es2017/search/group-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"group-utils.js","sourceRoot":"","sources":["../../../src/search/group-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,GAAG,CAAC;AACX,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAEnD;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAA+B;IAE/B,0DAA0D;IAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAChD,mCAAmC;IACnC,MAAM,UAAU,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC3C,MAAM,aAAa,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,CAAC;IAE5D,wDAAwD;IACxD,6CAA6C;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAC5B,CAAC,GAAoB,EAAE,KAAK,EAAE,EAAE;QAC9B,iBAAiB;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,+CAA+C;YAC/C,yCAAyC;YAEzC,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAC3B,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBACxC,uCAAuC;gBACvC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAChC,4BAA4B;oBAC5B,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;iBAC5D;qBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACnC,sBAAsB;oBACtB,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,aAAa,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;iBACzD;qBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;oBACzB,eAAe;oBACf,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;iBACnC;aACF;iBAAM;gBACL,0CAA0C;gBAC1C,mBAAmB;gBACnB,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;aACvC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,UAAU,EAAE,OAAO;KACD,CACrB,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAuB;IAEvB,MAAM,MAAM,GAAG,EAA4B,CAAC;IAC5C,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1C,2DAA2D;IAC3D,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAC,CAAC;IAChE,oBAAoB;IAEpB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,yBAAyB;QACzB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,4CAA4C;YAC5C,OAAO,CAAC,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;SAClD;QACD,qBAAqB;QACrB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;YACzD,IAAI,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,eAAe,EAAE;gBACtD,OAAO,CAAC,GAAG,EAAE,uBAAuB,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;aAC/D;iBAAM;gBACL,OAAO,CAAC,GAAG,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;aACtC;SACF;IACH,CAAC,CAAC,CAAC;IAEH,8DAA8D;IAC9D,qCAAqC;IACrC,IAAI,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE;QAC7C,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;KACnD;IAED,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;KAC3B;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAA8B;IAE9B,IAAI,MAAM,GAAG;QACX,CAAC,EAAE,EAAE;QACL,MAAM,EAAE,EAAE;KACO,CAAC;IAEpB,MAAM,SAAS,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC,CAAC;IAC9E,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,sBAAsB;QACtB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC/B,MAAM,GAAG,kBAAkB,CACzB,MAAM,EACN,qBAAqB,CAAC,GAAG,EAAE,KAAK,CAAC,EACjC,KAAK,CACN,CAAC;SACH;QACD,uBAAuB;QACvB,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,GAAG,kBAAkB,CACzB,MAAM,EACN,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,EAC9B,KAAK,CACN,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IACH,gDAAgD;IAChD,IAAI,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAAE;QAC7C,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;KACnD;IACD,eAAe;IACf,IAAI,MAAM,CAAC,IAAI,EAAE;QACf,MAAM,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;KAChD;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/es2017/search/hub-api-search.js

@@ -0,0 +1,19 @@
+import { hubApiRequest } from "..";
+/**
+ * Search the Hub API
+ *
+ * @param requestOptions
+ * @returns JSONAPI response
+ */
+export function hubApiSearch(requestOptions) {
+    // derive default headers if authentication
+    const authentication = requestOptions.authentication;
+    const headers = authentication &&
+        authentication.serialize && { authentication: authentication.serialize() };
+    const defaults = {
+        headers,
+        httpMethod: "POST",
+    };
+    return hubApiRequest("/search", Object.assign(Object.assign({}, defaults), requestOptions));
+}
+//# sourceMappingURL=hub-api-search.js.map

package/dist/es2017/search/hub-api-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hub-api-search.js","sourceRoot":"","sources":["../../../src/search/hub-api-search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,aAAa,EAAE,MAAM,IAAI,CAAC;AACxE;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,cAAkC;IAElC,2CAA2C;IAC3C,MAAM,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;IACrD,MAAM,OAAO,GAAG,cAAc;QAC5B,cAAc,CAAC,SAAS,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,SAAS,EAAE,EAAE,CAAC;IAC7E,MAAM,QAAQ,GAAuB;QACnC,OAAO;QACP,UAAU,EAAE,MAAM;KACnB,CAAC;IACF,OAAO,aAAa,CAAC,SAAS,kCACzB,QAAQ,GACR,cAAc,EACjB,CAAC;AACL,CAAC"}

package/dist/es2017/search/index.js

@@ -0,0 +1,10 @@
+export * from "./hub-api-search";
+export * from "./content-utils";
+export * from "./group-utils";
+export * from "./user-utils";
+export * from "./utils";
+export * from "./types";
+export * from "./_searchContent";
+export * from "./_searchGroups";
+export * from "./_searchUsers";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/search/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/dist/es2017/search/types.js

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

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

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