@esri/hub-common 9.38.0 → 9.41.0

package/dist/node/users/_internal/enrichments.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchUserEnrichments = void 0;
+const __1 = require("../..");
+const _enrichments_1 = require("../../items/_enrichments");
+const OperationStack_1 = require("../../OperationStack");
+const utils_1 = require("../../utils");
+const enrichUserOrg = (input) => {
+    const { data, stack, requestOptions } = input;
+    const opId = stack.start("enrichUserOrg");
+    const options = Object.assign(Object.assign({}, requestOptions), { 
+        // In order to get the correct response, we must pass options.portal
+        // as a base portal url (e.g., www.arcgis.com, qaext.arcgis.com, etc)
+        // **not** an org portal (i.e. org.maps.arcgis.com).
+        portal: `${__1.getPortalBaseFromOrgUrl(requestOptions.portal)}/sharing/rest` });
+    // TODO: Add Caching
+    // Had implemented a simple caching system, but it leads to unstable
+    // tests because we can't deterministically clear it
+    // if (!orgCache[data.user.orgId]) {
+    //   orgCache[data.user.orgId] = fetchOrg(data.user.orgId, options);
+    // }
+    // return (orgCache[data.user.orgId] as Promise<IPortal>)
+    return __1.fetchOrg(data.user.orgId, options)
+        .then((results) => {
+        stack.finish(opId);
+        return {
+            data: Object.assign(Object.assign({}, data), {
+                org: results,
+            }),
+            stack,
+            requestOptions,
+        };
+    })
+        .catch((error) => handleEnrichmentError(error, input, opId));
+};
+/**
+ * Simple cache for user org's. This does not expire
+ * but that seems reasonable as Org props rarely change
+ */
+// This works find at run-time, but it's a problem in tests
+// where we are validating calls. Will work with Randy to
+// create something that's more robust
+// const orgCache: Record<string, any> = {};
+// add the error to the content.errors,
+// log current stack operation as finished with an error
+// and return output that can be piped into the next operation
+const handleEnrichmentError = (error, input, opId) => {
+    const { data, stack, requestOptions } = input;
+    stack.finish(opId, { error });
+    return {
+        data: Object.assign(Object.assign({}, data), { errors: _enrichments_1.getEnrichmentErrors(error, data.errors) }),
+        stack,
+        requestOptions,
+    };
+};
+/**
+ * Available enrichments for Groups
+ */
+const groupEnrichementOperations = {
+    org: enrichUserOrg,
+};
+/**
+ * Fetch enrichments for Users
+ * @param group
+ * @param enrichments
+ * @param requestOptions
+ * @returns
+ */
+function fetchUserEnrichments(user, enrichments, requestOptions) {
+    // create a pipeline of enrichment operations
+    const operations = enrichments.reduce((ops, enrichment) => {
+        const operation = groupEnrichementOperations[enrichment];
+        // only include the enrichments that we know how to fetch
+        operation && ops.push(operation);
+        return ops;
+    }, []);
+    const pipeline = utils_1.createOperationPipeline(operations);
+    // execute pipeline and return the item and enrichments
+    return pipeline({
+        data: { user },
+        stack: new OperationStack_1.default(),
+        requestOptions,
+    }).then((output) => {
+        // TODO: send telemetry so we have info on what enrichments are requested and possible errors
+        return output.data;
+    });
+}
+exports.fetchUserEnrichments = fetchUserEnrichments;
+//# sourceMappingURL=enrichments.js.map

package/dist/node/users/_internal/enrichments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrichments.js","sourceRoot":"","sources":["../../../../src/users/_internal/enrichments.ts"],"names":[],"mappings":";;;AACA,6BAA0D;AAC1D,2DAA+D;AAC/D,yDAAkD;AAElD,uCAAiE;AAgCjE,MAAM,aAAa,GAAG,CACpB,KAAqC,EACI,EAAE;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAC1C,MAAM,OAAO,mCACR,cAAc;QACjB,oEAAoE;QACpE,qEAAqE;QACrE,oDAAoD;QACpD,MAAM,EAAE,GAAG,2BAAuB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GACzE,CAAC;IACF,oBAAoB;IACpB,oEAAoE;IACpE,oDAAoD;IACpD,oCAAoC;IACpC,oEAAoE;IACpE,IAAI;IAEJ,yDAAyD;IACzD,OAAO,YAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;SACtC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAChB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO;YACL,IAAI,kCACC,IAAI,GACJ;gBACD,GAAG,EAAE,OAAO;aACb,CACF;YACD,KAAK;YACL,cAAc;SACf,CAAC;IACJ,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF;;;GAGG;AACH,2DAA2D;AAC3D,yDAAyD;AACzD,sCAAsC;AACtC,4CAA4C;AAE5C,uCAAuC;AACvC,wDAAwD;AACxD,8DAA8D;AAC9D,MAAM,qBAAqB,GAAG,CAC5B,KAAqB,EACrB,KAAqC,EACrC,IAAY,EACoB,EAAE;IAClC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IAC9C,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9B,OAAO;QACL,IAAI,kCACC,IAAI,KACP,MAAM,EAAE,kCAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,GAChD;QACD,KAAK;QACL,cAAc;KACf,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,0BAA0B,GAA8B;IAC5D,GAAG,EAAE,aAAa;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAClC,IAAW,EACX,WAA6B,EAC7B,cAAmC;IAEnC,6CAA6C;IAC7C,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;QACxD,MAAM,SAAS,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;QACzD,yDAAyD;QACzD,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,MAAM,QAAQ,GAAG,+BAAuB,CAAsB,UAAU,CAAC,CAAC;IAC1E,uDAAuD;IACvD,OAAO,QAAQ,CAAC;QACd,IAAI,EAAE,EAAE,IAAI,EAAE;QACd,KAAK,EAAE,IAAI,wBAAc,EAAE;QAC3B,cAAc;KACf,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACjB,6FAA6F;QAC7F,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC;AAtBD,oDAsBC"}

package/dist/node/users/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./HubUsers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/users/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B"}

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

@@ -1,6 +1,6 @@
-import { IItem } from "@esri/arcgis-rest-portal";
-import { ILayerDefinition, ISpatialReference } from "@esri/arcgis-rest-types";
-import { IHubContent } from "../core";
+import { IItem, IPortal } from "@esri/arcgis-rest-portal";
+import { ILayerDefinition, ISpatialReference, IUser } from "@esri/arcgis-rest-types";
+import { IHubContent, PublisherSource } from "../core";
 import { IHubGeography, GeographyProvenance, IHubRequestOptions } from "../types";
 import { IHubAdditionalResource } from "../core/types/IHubAdditionalResource";
 /**
@@ -49,6 +49,14 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     publishedDate: Date;
     publishedDateSource?: string;
     updateFrequency?: string;
+    publisher?: {
+        name?: string;
+        username?: string;
+        nameSource: PublisherSource;
+        organization?: string;
+        orgId?: string;
+        organizationSource: PublisherSource;
+    };
     portalHomeUrl?: string;
     portalApiUrl?: string;
     portalDataUrl?: string;
@@ -85,8 +93,8 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     };
     metadata?: any;
     groupIds?: string[];
-    ownerUser?: import("@esri/arcgis-rest-portal").IUser;
-    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
+    ownerUser?: IUser;
+    org?: Partial<IPortal>;
     errors?: import("../types").IEnrichmentErrorInfo[];
     server?: Partial<import("@esri/arcgis-rest-feature-layer").IFeatureServiceDefinition>;
     layers?: Partial<ILayerDefinition>[];
@@ -284,4 +292,45 @@ export declare const getAdditionalResourceUrl: (resource: IAGOAdditionalResource
  * @returns the correct extent in a bbox format, or undefined
  */
 export declare const determineExtent: (item: IItem, extentEnrichment?: any, layer?: ILayerDefinition) => any;
+/**
+ * @private
+ *
+ * Extracts the first contact from a given formal item metadata path.
+ * This is particularly helpful if the contact path is either an object or an array.
+ *
+ * Note: the raw contact object must have the following properties:
+ * - `rpIndName`: name of the individual
+ * - `rpOrgName`: name of the individual's organization
+ *
+ * @param metadata formal item metadata
+ * @param path path to the contact object/array
+ * @returns
+ */
+export declare const extractFirstContact: (metadata: any, path: string) => {
+    individualName: any;
+    organizationName: any;
+};
+/**
+ * Determines the correct orgId for an item.
+ * Note: it's undocumented, but the portal API will return orgId for items... sometimes.
+ *
+ * @param item
+ * @param ownerUser item owner's hydrated user object
+ */
+export declare const getItemOrgId: (item: IItem, ownerUser?: IUser) => any;
+/**
+ * Calculates the Publisher display info for the given item.
+ * Utilizes this fallback pattern:
+ * 1) Formal Item Metadata > Resource > Citation > Contact
+ * 2) Formal Item Metadata > Resource > Contact
+ * 3) Item’s Owner and Org Name
+ * 4) Undefined (Item Owner / Org are private and we can't access additional info)
+ *
+ * @param item
+ * @param metadata
+ * @param org portal info of the item's organization
+ * @param ownerUser the item owner's hydrated user
+ * @returns
+ */
+export declare const getPublisherInfo: (item: IItem, metadata?: any, org?: Partial<IPortal>, ownerUser?: IUser) => any;
 export {};

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

@@ -5,6 +5,12 @@ import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubItemEntity } from ".";
 import { IHubContentEnrichments } from "./IHubContentEnrichments";
 import { IHubAdditionalResource } from "./IHubAdditionalResource";
+export declare enum PublisherSource {
+    CitationContact = "metadata.resource.citation.contact",
+    ResourceContact = "metadata.resource.contact",
+    ItemOwner = "item.owner",
+    None = "none"
+}
 /**
  * Data model for content
  */
@@ -61,6 +67,21 @@ export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IIt
     publishedDateSource?: string;
     /** Frequency at which the content is updated */
     updateFrequency?: string;
+    /**
+     * Info to display about the content's publisher. Follows this fallback pattern:
+     * 1) Formal Item Metadata > Resource > Citation > Contact
+     * 2) Formal Item Metadata > Resource > Contact
+     * 3) Item’s Owner and Org Name
+     * 4) Undefined (Item Owner / Org are private and we can't access additional info)
+     */
+    publisher?: {
+        name?: string;
+        username?: string;
+        nameSource: PublisherSource;
+        organization?: string;
+        orgId?: string;
+        organizationSource: PublisherSource;
+    };
     /** URL of the resource's page in the Portal Home application */
     portalHomeUrl?: string;
     /** URL of the Portal API endpoint for the resource */

package/dist/types/index.d.ts

@@ -25,6 +25,8 @@ export * from "./util";
 export * from "./utils";
 export * from "./Hub";
 export * from "./pages";
+export * from "./org";
+export * from "./users";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/org/fetch-org.d.ts

@@ -0,0 +1,9 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Fetches the portal for a given org.
+ *
+ * @param orgId
+ * @param options request options
+ * @returns
+ */
+export declare const fetchOrg: (orgId: string, options?: IRequestOptions) => Promise<import("@esri/arcgis-rest-portal").IPortal>;

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

@@ -0,0 +1 @@
+export * from "./fetch-org";

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

@@ -0,0 +1,8 @@
+import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "../types";
+/**
+ * @private
+ * Portal Search implementation for Users
+ * @param filterGroups
+ * @param options
+ */
+export declare function portalSearchUsers(filterGroups: Array<IFilterGroup<"user">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,6 +1,6 @@
 import { ICollection } from "./ICollection";
 import { IFacet } from "./IFacet";
-import { Filter, FilterType, ISortOption } from "./types";
+import { Filter, FilterType, IFilterGroup, ISortOption } from "./types";
 /**
  * Catalog is the definition which powers what options
  * are available in a Gallery. It controls not only
@@ -13,7 +13,11 @@ import { Filter, FilterType, ISortOption } from "./types";
  * ```ts
  * const simpleCatalog:Catalog = {
  *   title: "Select Map",
- *   filter: {
+ *   filters: [
+ *    {
+ *     fitlerType: "item",
+ *      operation: "AND",
+ *      fitlers
  *     filterType: "content",
  *     type: "Web Map",
  *     owner: "jsmith"
@@ -57,10 +61,17 @@ export interface ICatalog {
      * Title for the Gallery
      */
     title?: string;
+    /**
+     * Scope is a set of FilterGroups which define the limits of the Catalog.
+     * Typically it is just a set of group ids, but it may be arbitrarily complex.
+     * If one was to "search a catalog", this is the description of what would be returned.
+     */
+    scope?: Array<IFilterGroup<FilterType>>;
     /**
      * Filter defines the "scope" of the Catalog, typically a set of groups or orgids
+     * DEPRECATED: Use `scope`
      */
-    filter: Filter<FilterType>;
+    filter?: Filter<FilterType>;
     /**
      * Sort options to be shown in the Gallery
      */

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

@@ -1,5 +1,5 @@
 import { IFacet } from "./IFacet";
-import { Filter, FilterType, ISortOption } from "./types";
+import { Filter, FilterType, IFilterGroup, ISortOption } from "./types";
 /**
  * A Collection is a subset of a Catalog, but can be used independently
  * in Galleries
@@ -11,12 +11,18 @@ export interface ICollection {
      * Filter Type used in this collection
      */
     filterType?: FilterType;
+    /**
+     * Scope is a set of FilterGroups which define the limits of the Collection.
+     * Typically it is just a set of group ids, but it may be arbitrarily complex.
+     * If one was to "search the collection", this is the description of what would be returned.
+     */
+    scope?: Array<IFilterGroup<FilterType>>;
     /**
      * Specify the includes to be requested when working with this collection
      */
     include?: string[];
-    defaultQuery?: string;
     sortOption: ISortOption;
-    filter: Filter<FilterType>;
     facets?: IFacet[];
+    filter?: Filter<FilterType>;
+    defaultQuery?: string;
 }

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

@@ -40,6 +40,7 @@ export interface IFilterTypeMap {
     item: IItemFilter;
     user: IUserFilterDefinition;
     group: IGroupFilterDefinition;
+    groupMember: IGroupMemberFilterDefinition;
     event: IEventFilterDefinition;
     /**
      * DEPRECATED use item
@@ -127,7 +128,7 @@ export interface IUserFilterDefinition {
     email?: string | string[] | IMatchOptions;
     firstname?: string | string[] | IMatchOptions;
     fullname?: string | string[] | IMatchOptions;
-    groups?: string | string[] | IMatchOptions;
+    group?: string | string[] | IMatchOptions;
     lastlogin?: IDateRange<number> | IRelativeDate;
     lastname?: string | string[] | IMatchOptions;
     modified?: IDateRange<number> | IRelativeDate;
@@ -135,6 +136,21 @@ export interface IUserFilterDefinition {
     term?: string;
     userlicensetype?: string | string[] | IMatchOptions;
     username?: string | string[] | IMatchOptions;
+    emailstatus?: string | string[] | IMatchOptions;
+    provider?: string | string[] | IMatchOptions;
+}
+/**
+ * These properties must all be passed through
+ * so they are sent in separate fields and *not*
+ * serialized into a q
+ * Also `joined` does not take the same format as
+ * dates in `q`
+ */
+export interface IGroupMemberFilterDefinition {
+    memberType?: "admin" | "member";
+    joined?: IDateRange<number> | IRelativeDate;
+    name?: string | string[] | IMatchOptions;
+    orgIds?: string | string[] | IMatchOptions;
 }
 export interface IGroupFilterDefinition {
     access?: string | string[] | IMatchOptions;

package/dist/types/urls/getUserHomeUrl.d.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../types";
+/**
+ * Return the URL of the user's page in the Portal Home application
+ * @param username The username
+ * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
+ * @returns URL to the user's profile, defaults to `https://www.arcgis.com/home/user.html?user={username}`
+ */
+export declare function getUserHomeUrl(username: string, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

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

@@ -16,6 +16,7 @@ export * from "./convert-urls-to-anchor-tags";
 export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
 export * from "./getGroupHomeUrl";
+export * from "./getUserHomeUrl";
 /**
  *
  * @param url

package/dist/types/users/HubUsers.d.ts

@@ -0,0 +1,11 @@
+import { IUser } from "@esri/arcgis-rest-types";
+import { IHubSearchResult } from "../search";
+import { IHubRequestOptions } from "../types";
+/**
+ * Enrich a User object
+ * @param user
+ * @param includes
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichUserSearchResult(user: IUser, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/users/_internal/enrichments.d.ts

@@ -0,0 +1,28 @@
+import { IUser, IPortal } from "@esri/arcgis-rest-portal";
+import { IEnrichmentErrorInfo, IHubRequestOptions } from "../../types";
+/**
+ * Possible additional properties available through enrichments
+ */
+export interface IUserEnrichments {
+    org?: IPortal;
+    /**
+     * Any errors encountered when fetching enrichments
+     * see https://github.com/ArcGIS/hub-indexer/blob/master/docs/errors.md#response-formatting-for-errors
+     */
+    errors?: IEnrichmentErrorInfo[];
+}
+export declare type UserEnrichment = keyof IUserEnrichments;
+/**
+ * Merging of the Enrichment and the User
+ */
+export interface IUserAndEnrichments extends IUserEnrichments {
+    user: IUser;
+}
+/**
+ * Fetch enrichments for Users
+ * @param group
+ * @param enrichments
+ * @param requestOptions
+ * @returns
+ */
+export declare function fetchUserEnrichments(user: IUser, enrichments: UserEnrichment[], requestOptions?: IHubRequestOptions): Promise<IUserAndEnrichments>;

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

@@ -0,0 +1 @@
+export * from "./HubUsers";