@esri/hub-common 9.45.6 → 9.46.0

package/package.json

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

package/dist/es2017/search/_internal/searchContentEntities.js

@@ -1,89 +0,0 @@
-import { searchItems } from "@esri/arcgis-rest-portal";
-import { expandApi, getNextFunction } from "../../search/utils";
-import { convertPortalResponseToFacets, expandContentFilter, serializeContentFilterForPortal, } from "../../search/content-utils";
-/**
- * Generic search that returns Hub Entity types converted from items
- * by the passed in `ItemToEntityFunction`
- *
- * This abstraction is used to ensure that searching from any of the
- * entity managers / modules is consistent, and returns the entity
- * types, instead of `IItem` or `IHubContent`
- *
- * @param filter
- * @param convertFn
- * @param options
- * @returns
- */
-export function searchContentEntities(filter, convertFn, options) {
-    var _a, _b;
-    // expand filter so we can serialize to either api
-    const expanded = expandContentFilter(filter);
-    const searchOptions = serializeContentFilterForPortal(expanded);
-    // DEPRECATION
-    /* istanbul ignore next */
-    if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
-        // tslint:disable-next-line:no-console
-        console.warn(`IHubSearchOptions.aggregations is deprecated. Please use .aggFields instead.`);
-        searchOptions.countFields = options.aggregations.join(",");
-        searchOptions.countSize = options.aggLimit || 10;
-    }
-    // Aggregations
-    if ((_b = options.aggFields) === null || _b === void 0 ? void 0 : _b.length) {
-        searchOptions.countFields = options.aggFields.join(",");
-        searchOptions.countSize = options.aggLimit || 10;
-    }
-    // properties to copy from IHubSearchOptions to the ISearchOptions
-    const props = [
-        "authentication",
-        "num",
-        "sortField",
-        "sortOrder",
-        "site",
-        "start",
-    ];
-    // Include "start" here
-    // copy the props over
-    props.forEach((prop) => {
-        if (options.hasOwnProperty(prop)) {
-            searchOptions[prop] = options[prop];
-        }
-    });
-    // create the entitySearchFn
-    const searchFn = createContentEntitySearchFn(convertFn);
-    // execute the search
-    // Add ArcGIS API
-    if (options.api && !options.authentication) {
-        const expandedApi = expandApi(options.api);
-        searchOptions.portal = expandedApi.url;
-    }
-    return searchFn(searchOptions);
-}
-/**
- * Return a function that holds a closure containing
- * a hub entity specific conversion function. This
- * allows the `.next()` function to use the function on
- * subsequent calls
- * @param convertFn
- * @returns
- */
-export function createContentEntitySearchFn(convertFn) {
-    // Return a function that does the search, with a closure over the
-    // conversion function. Naming this function is important as it's
-    // referenced in the `next` section below
-    return async function searchEntities(searchOptions) {
-        const response = await searchItems(searchOptions);
-        const entities = await Promise.all(response.results.map((itm) => {
-            return convertFn(itm, searchOptions);
-        }));
-        // convert aggregations into facets
-        const facets = convertPortalResponseToFacets(response);
-        return {
-            total: response.total,
-            results: entities,
-            facets,
-            hasNext: response.nextStart > -1,
-            next: getNextFunction(searchOptions, response.nextStart, response.total, searchEntities),
-        };
-    };
-}
-//# sourceMappingURL=searchContentEntities.js.map

package/dist/es2017/search/_internal/searchContentEntities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchContentEntities.js","sourceRoot":"","sources":["../../../../src/search/_internal/searchContentEntities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAMvE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EACL,6BAA6B,EAC7B,mBAAmB,EACnB,+BAA+B,GAChC,MAAM,4BAA4B,CAAC;AAUpC;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAyB,EACzB,SAAkC,EAClC,OAA0B;;IAE1B,kDAAkD;IAClD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAC;IAEhE,cAAc;IACd,0BAA0B;IAC1B,UAAI,OAAO,CAAC,YAAY,0CAAE,MAAM,EAAE;QAChC,sCAAsC;QACtC,OAAO,CAAC,IAAI,CACV,8EAA8E,CAC/E,CAAC;QACF,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3D,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IAED,eAAe;IACf,UAAI,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE;QAC7B,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IACD,kEAAkE;IAClE,MAAM,KAAK,GAAmC;QAC5C,gBAAgB;QAChB,KAAK;QACL,WAAW;QACX,WAAW;QACX,MAAM;QACN,OAAO;KACR,CAAC;IAEF,uBAAuB;IACvB,sBAAsB;IACtB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YAChC,aAAa,CAAC,IAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SAC7D;IACH,CAAC,CAAC,CAAC;IACH,4BAA4B;IAC5B,MAAM,QAAQ,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACxD,qBAAqB;IACrB,iBAAiB;IACjB,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC1C,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,aAAa,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC;KACxC;IACD,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAAkC;IAElC,kEAAkE;IAClE,iEAAiE;IACjE,yCAAyC;IACzC,OAAO,KAAK,UAAU,cAAc,CAClC,aAA6B;QAE7B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,OAAO,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CACH,CAAC;QAEF,mCAAmC;QACnC,MAAM,MAAM,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAEvD,OAAO;YACL,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO,EAAE,QAAQ;YACjB,MAAM;YACN,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;YAChC,IAAI,EAAE,eAAe,CACnB,aAAa,EACb,QAAQ,CAAC,SAAS,EAClB,QAAQ,CAAC,KAAK,EACd,cAAc,CACf;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/dist/esm/search/_internal/searchContentEntities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchContentEntities.js","sourceRoot":"","sources":["../../../../src/search/_internal/searchContentEntities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAMvE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EACL,6BAA6B,EAC7B,mBAAmB,EACnB,+BAA+B,GAChC,MAAM,4BAA4B,CAAC;AAUpC;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAyB,EACzB,SAAkC,EAClC,OAA0B;;IAE1B,kDAAkD;IAClD,IAAM,QAAQ,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC7C,IAAM,aAAa,GAAG,+BAA+B,CAAC,QAAQ,CAAC,CAAC;IAEhE,cAAc;IACd,0BAA0B;IAC1B,UAAI,OAAO,CAAC,YAAY,0CAAE,MAAM,EAAE;QAChC,sCAAsC;QACtC,OAAO,CAAC,IAAI,CACV,8EAA8E,CAC/E,CAAC;QACF,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3D,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IAED,eAAe;IACf,UAAI,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE;QAC7B,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IACD,kEAAkE;IAClE,IAAM,KAAK,GAAmC;QAC5C,gBAAgB;QAChB,KAAK;QACL,WAAW;QACX,WAAW;QACX,MAAM;QACN,OAAO;KACR,CAAC;IAEF,uBAAuB;IACvB,sBAAsB;IACtB,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI;QACjB,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YAChC,aAAa,CAAC,IAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SAC7D;IACH,CAAC,CAAC,CAAC;IACH,4BAA4B;IAC5B,IAAM,QAAQ,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACxD,qBAAqB;IACrB,iBAAiB;IACjB,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC1C,IAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,aAAa,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC;KACxC;IACD,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAAkC;IAElC,kEAAkE;IAClE,iEAAiE;IACjE,yCAAyC;IACzC,OAAO,SAAe,cAAc,CAClC,aAA6B;;;;;4BAEZ,qBAAM,WAAW,CAAC,aAAa,CAAC,EAAA;;wBAA3C,QAAQ,GAAG,SAAgC;wBAEhC,qBAAM,OAAO,CAAC,GAAG,CAChC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,GAAG;gCACvB,OAAO,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;4BACvC,CAAC,CAAC,CACH,EAAA;;wBAJK,QAAQ,GAAG,SAIhB;wBAGK,MAAM,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;wBAEvD,sBAAO;gCACL,KAAK,EAAE,QAAQ,CAAC,KAAK;gCACrB,OAAO,EAAE,QAAQ;gCACjB,MAAM,QAAA;gCACN,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;gCAChC,IAAI,EAAE,eAAe,CACnB,aAAa,EACb,QAAQ,CAAC,SAAS,EAClB,QAAQ,CAAC,KAAK,EACd,cAAc,CACf;6BACF,EAAC;;;;KACH,CAAC;AACJ,CAAC"}

package/dist/node/search/_internal/searchContentEntities.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createContentEntitySearchFn = exports.searchContentEntities = void 0;
-const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
-const utils_1 = require("../../search/utils");
-const content_utils_1 = require("../../search/content-utils");
-/**
- * Generic search that returns Hub Entity types converted from items
- * by the passed in `ItemToEntityFunction`
- *
- * This abstraction is used to ensure that searching from any of the
- * entity managers / modules is consistent, and returns the entity
- * types, instead of `IItem` or `IHubContent`
- *
- * @param filter
- * @param convertFn
- * @param options
- * @returns
- */
-function searchContentEntities(filter, convertFn, options) {
-    var _a, _b;
-    // expand filter so we can serialize to either api
-    const expanded = content_utils_1.expandContentFilter(filter);
-    const searchOptions = content_utils_1.serializeContentFilterForPortal(expanded);
-    // DEPRECATION
-    /* istanbul ignore next */
-    if ((_a = options.aggregations) === null || _a === void 0 ? void 0 : _a.length) {
-        // tslint:disable-next-line:no-console
-        console.warn(`IHubSearchOptions.aggregations is deprecated. Please use .aggFields instead.`);
-        searchOptions.countFields = options.aggregations.join(",");
-        searchOptions.countSize = options.aggLimit || 10;
-    }
-    // Aggregations
-    if ((_b = options.aggFields) === null || _b === void 0 ? void 0 : _b.length) {
-        searchOptions.countFields = options.aggFields.join(",");
-        searchOptions.countSize = options.aggLimit || 10;
-    }
-    // properties to copy from IHubSearchOptions to the ISearchOptions
-    const props = [
-        "authentication",
-        "num",
-        "sortField",
-        "sortOrder",
-        "site",
-        "start",
-    ];
-    // Include "start" here
-    // copy the props over
-    props.forEach((prop) => {
-        if (options.hasOwnProperty(prop)) {
-            searchOptions[prop] = options[prop];
-        }
-    });
-    // create the entitySearchFn
-    const searchFn = createContentEntitySearchFn(convertFn);
-    // execute the search
-    // Add ArcGIS API
-    if (options.api && !options.authentication) {
-        const expandedApi = utils_1.expandApi(options.api);
-        searchOptions.portal = expandedApi.url;
-    }
-    return searchFn(searchOptions);
-}
-exports.searchContentEntities = searchContentEntities;
-/**
- * Return a function that holds a closure containing
- * a hub entity specific conversion function. This
- * allows the `.next()` function to use the function on
- * subsequent calls
- * @param convertFn
- * @returns
- */
-function createContentEntitySearchFn(convertFn) {
-    // Return a function that does the search, with a closure over the
-    // conversion function. Naming this function is important as it's
-    // referenced in the `next` section below
-    return async function searchEntities(searchOptions) {
-        const response = await arcgis_rest_portal_1.searchItems(searchOptions);
-        const entities = await Promise.all(response.results.map((itm) => {
-            return convertFn(itm, searchOptions);
-        }));
-        // convert aggregations into facets
-        const facets = content_utils_1.convertPortalResponseToFacets(response);
-        return {
-            total: response.total,
-            results: entities,
-            facets,
-            hasNext: response.nextStart > -1,
-            next: utils_1.getNextFunction(searchOptions, response.nextStart, response.total, searchEntities),
-        };
-    };
-}
-exports.createContentEntitySearchFn = createContentEntitySearchFn;
-//# sourceMappingURL=searchContentEntities.js.map

package/dist/node/search/_internal/searchContentEntities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"searchContentEntities.js","sourceRoot":"","sources":["../../../../src/search/_internal/searchContentEntities.ts"],"names":[],"mappings":";;;AAAA,iEAAuE;AAMvE,8CAAgE;AAChE,8DAIoC;AAUpC;;;;;;;;;;;;GAYG;AACH,SAAgB,qBAAqB,CACnC,MAAyB,EACzB,SAAkC,EAClC,OAA0B;;IAE1B,kDAAkD;IAClD,MAAM,QAAQ,GAAG,mCAAmB,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,+CAA+B,CAAC,QAAQ,CAAC,CAAC;IAEhE,cAAc;IACd,0BAA0B;IAC1B,UAAI,OAAO,CAAC,YAAY,0CAAE,MAAM,EAAE;QAChC,sCAAsC;QACtC,OAAO,CAAC,IAAI,CACV,8EAA8E,CAC/E,CAAC;QACF,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3D,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IAED,eAAe;IACf,UAAI,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE;QAC7B,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;KAClD;IACD,kEAAkE;IAClE,MAAM,KAAK,GAAmC;QAC5C,gBAAgB;QAChB,KAAK;QACL,WAAW;QACX,WAAW;QACX,MAAM;QACN,OAAO;KACR,CAAC;IAEF,uBAAuB;IACvB,sBAAsB;IACtB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YAChC,aAAa,CAAC,IAA4B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SAC7D;IACH,CAAC,CAAC,CAAC;IACH,4BAA4B;IAC5B,MAAM,QAAQ,GAAG,2BAA2B,CAAC,SAAS,CAAC,CAAC;IACxD,qBAAqB;IACrB,iBAAiB;IACjB,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE;QAC1C,MAAM,WAAW,GAAG,iBAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,aAAa,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC;KACxC;IACD,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC;AACjC,CAAC;AAnDD,sDAmDC;AAED;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CACzC,SAAkC;IAElC,kEAAkE;IAClE,iEAAiE;IACjE,yCAAyC;IACzC,OAAO,KAAK,UAAU,cAAc,CAClC,aAA6B;QAE7B,MAAM,QAAQ,GAAG,MAAM,gCAAW,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,OAAO,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QACvC,CAAC,CAAC,CACH,CAAC;QAEF,mCAAmC;QACnC,MAAM,MAAM,GAAG,6CAA6B,CAAC,QAAQ,CAAC,CAAC;QAEvD,OAAO;YACL,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO,EAAE,QAAQ;YACjB,MAAM;YACN,OAAO,EAAE,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;YAChC,IAAI,EAAE,uBAAe,CACnB,aAAa,EACb,QAAQ,CAAC,SAAS,EAClB,QAAQ,CAAC,KAAK,EACd,cAAc,CACf;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAjCD,kEAiCC"}

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

@@ -1,32 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-types";
-import { ISearchResponse } from "../../types";
-import { Filter, IHubSearchOptions } from "../types";
-/**
- * Definition of `convertItemTo<T>` functions
- */
-export declare type ItemToEntityFunction<T> = (i: IItem, ro?: IRequestOptions) => Promise<T>;
-/**
- * Generic search that returns Hub Entity types converted from items
- * by the passed in `ItemToEntityFunction`
- *
- * This abstraction is used to ensure that searching from any of the
- * entity managers / modules is consistent, and returns the entity
- * types, instead of `IItem` or `IHubContent`
- *
- * @param filter
- * @param convertFn
- * @param options
- * @returns
- */
-export declare function searchContentEntities<T>(filter: Filter<"content">, convertFn: ItemToEntityFunction<T>, options: IHubSearchOptions): Promise<ISearchResponse<T>>;
-/**
- * Return a function that holds a closure containing
- * a hub entity specific conversion function. This
- * allows the `.next()` function to use the function on
- * subsequent calls
- * @param convertFn
- * @returns
- */
-export declare function createContentEntitySearchFn<T>(convertFn: ItemToEntityFunction<T>): (v: ISearchOptions) => Promise<ISearchResponse<T>>;