@esri/hub-common 14.20.0 → 14.21.1

package/dist/types/discussions/utils.d.ts

@@ -1,5 +1,7 @@
 import { IGroup, IItem } from "@esri/arcgis-rest-types";
 import { IHubContent, IHubItemEntity } from "../core";
+import { IChannel, SharingAccess } from "./api/types";
+import { IQuery } from "../search";
 /**
  * Utility to determine if a given IGroup, IItem, IHubContent, or IHubItemEntity
  * is discussable.
@@ -14,3 +16,54 @@ export declare function isDiscussable(subject: Partial<IGroup | IItem | IHubCont
  * @returns {string[]} updated list of type keywords
  */
 export declare function setDiscussableKeyword(typeKeywords: string[], discussable: boolean): string[];
+/**
+ * Determines if the given channel is considered to be a `public` channel, supporting both
+ * legacy permissions and V2 ACL model.
+ * @param channel An IChannel record
+ * @returns true if the channel is considered `public`
+ */
+export declare function isPublicChannel(channel: IChannel): boolean;
+/**
+ * Determines if the given channel is considered to be an `org` channel, supporting both
+ * legacy permissions and V2 ACL model.
+ * @param channel An IChannel record
+ * @returns true if the channel is considered `org`
+ */
+export declare function isOrgChannel(channel: IChannel): boolean;
+/**
+ * Determines if the given channel is considered to be a `private` channel, supporting both
+ * legacy permissions and V2 ACL model.
+ * @param channel An IChannel record
+ * @returns true if the channel is considered `private`
+ */
+export declare function isPrivateChannel(channel: IChannel): boolean;
+/**
+ * Determines the given channel's access, supporting both legacy permissions and V2 ACL
+ * model.
+ * @param channel An IChannel record
+ * @returns `public`, `org` or `private`
+ */
+export declare function getChannelAccess(channel: IChannel): SharingAccess;
+/**
+ * Returns an array of org ids configured for the channel, supporting both legacy permissions
+ * and V2 ACL model.
+ * @param channel An IChannel record
+ * @returns an array of org ids for the given channel
+ */
+export declare function getChannelOrgIds(channel: IChannel): string[];
+/**
+ * Returns an array of group ids configured for the channel, supporting both legacy permissions
+ * and V2 ACL model.
+ * @param channel An IChannel record
+ * @returns an array of group ids for the given channel
+ */
+export declare function getChannelGroupIds(channel: IChannel): string[];
+/**
+ * A utility method used to build an IQuery to search for users that are permitted to be at-mentioned for the given channel.
+ * @param input An array of strings to search for. Each string is mapped to `username` and `fullname`, filters as an OR condition
+ * @param channel An IChannel record
+ * @param currentUsername The currently authenticated user's username
+ * @param options An IHubSearchOptions object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult>
+ */
+export declare function getChannelUsersQuery(inputs: string[], channel: IChannel, currentUsername?: string): IQuery;

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

@@ -1,9 +1,53 @@
 import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
 /**
  * @private
- * Portal Search Implementation for Users
- * @param filterGroups
- * @param options
- * @returns
+ *
+ * Portal Search Implementation for Users within the currently authenticated user's organization.
+ * Automatically adds "org.name as OrgName" enrichment
+ *
+ * DEPRECATED: This method will be deprecated in a future release, as it's not ideal to impose default enrichments in all
+ * cases. When this method is depreated, all places that currently call `hubSearch` with a `targetEntity` of `user` will
+ * need to be updated to use the `portalUser` `targetEntity` and explicitly pass `"org.name as OrgName"` in `inclues` to
+ * preserve that enrichment, if needed. E.g.
+ *
+ * ```js
+ * // before
+ * await hubSearch(
+ *   { targetEntity: "user", ... },
+ *   { start: 1, ... },
+ * );
+ *
+ * // after
+ * await hubSearch(
+ *   { targetEntity: "portalUser", ... },
+ *   { start: 1, include: ["org.name as OrgName", ...], ... },
+ * );
+ * ```
+ *
+ * @param query An IQuery object representing the query to serialize
+ * @param options An IHubSearchOptions of search options
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> of users results
  */
-export declare function portalSearchUsers(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare function searchPortalUsersLegacy(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+/**
+ * @private
+ *
+ * Portal Search Implementation for Users within the currently authenticated user's organization.
+ * No enrichments added by default.
+ *
+ * @param query An IQuery object representing the query to serialize
+ * @param options An IHubSearchOptions of search options
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> of users results
+ */
+export declare function searchPortalUsers(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+/**
+ * @private
+ *
+ * Community Search Implementation for Users within in any organization.
+ * No enrichments added by default.
+ *
+ * @param query An IQuery object representing the query to serialize
+ * @param options An IHubSearchOptions of search options
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> of users results
+ */
+export declare function searchCommunityUsers(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -50,7 +50,7 @@ export interface IHubCollection {
      */
     targetEntity: EntityType;
 }
-export declare type EntityType = "item" | "group" | "user" | "groupMember" | "event" | "channel";
+export declare type EntityType = "item" | "group" | "user" | "portalUser" | "communityUser" | "groupMember" | "event" | "channel";
 /**
  * @private
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.20.0",
+  "version": "14.21.1",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",