@esri/hub-common 9.39.0 → 9.41.1

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/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;
@@ -145,6 +161,7 @@ export interface IGroupFilterDefinition {
     orgid?: string | string[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     searchUserAccess?: "groupMember";
+    searchUserName?: string;
     tags?: string | string[] | IMatchOptions;
     term?: string;
     title?: 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";