@esri/hub-common 18.10.0 → 18.11.0

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

@@ -7,6 +7,7 @@ const eventToSearchResult_1 = require("./hubEventsHelpers/eventToSearchResult");
 const processOptions_1 = require("./hubEventsHelpers/processOptions");
 const processFilters_1 = require("./hubEventsHelpers/processFilters");
 /**
+ * @private
  * Searches for events against the Events 3 API using the given `query` and `options`.
  * Currently supported filters include:
  *   - access: 'public' | 'private' | 'org' | Array<'public' | 'org' | 'private'>;
@@ -37,7 +38,7 @@ const processFilters_1 = require("./hubEventsHelpers/processFilters");
  *   - startDate
  * @param query An IQuery object
  * @param options An IHubSearchOptions object
- * @returns a promise that resolves a <IHubSearchResponse<IHubSearchResult> object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> object
  */
 async function hubSearchEvents(query, options) {
     const processedFilters = processFilters_1.processFilters(query.filters);

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

@@ -1 +1 @@
-{"version":3,"file":"hubSearchEvents.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchEvents.ts"],"names":[],"mappings":";;;AAIA,oDAAuD;AACvD,0EAGiD;AACjD,gFAA6E;AAC7E,sEAAmE;AACnE,sEAAmE;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACI,KAAK,UAAU,eAAe,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,gBAAgB,GAAG,+BAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,gBAAgB,GAAG,+BAAc,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,IAAI,iDACL,gBAAgB,GAChB,gBAAgB,KACnB,OAAO,EAAE,CAAC,+BAAgB,CAAC,OAAO,EAAE,+BAAgB,CAAC,QAAQ,CAAC,GAC/D,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,qBAAY,iCACjD,OAAO,CAAC,cAAc,KACzB,IAAI,IACJ,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,yCAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAC1D,CAAC;IACF,MAAM,OAAO,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC;IAC/B,OAAO;QACL,KAAK;QACL,OAAO;QACP,OAAO;QACP,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YACD,OAAO,eAAe,CAAC,KAAK,kCACvB,OAAO,KACV,KAAK,EAAE,SAAS,IAChB,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AAjCD,0CAiCC"}
+{"version":3,"file":"hubSearchEvents.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchEvents.ts"],"names":[],"mappings":";;;AAIA,oDAAuD;AACvD,0EAGiD;AACjD,gFAA6E;AAC7E,sEAAmE;AACnE,sEAAmE;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACI,KAAK,UAAU,eAAe,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,gBAAgB,GAAG,+BAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,gBAAgB,GAAG,+BAAc,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,IAAI,iDACL,gBAAgB,GAChB,gBAAgB,KACnB,OAAO,EAAE,CAAC,+BAAgB,CAAC,OAAO,EAAE,+BAAgB,CAAC,QAAQ,CAAC,GAC/D,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,qBAAY,iCACjD,OAAO,CAAC,cAAc,KACzB,IAAI,IACJ,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,yCAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAC1D,CAAC;IACF,MAAM,OAAO,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC;IAC/B,OAAO;QACL,KAAK;QACL,OAAO;QACP,OAAO;QACP,IAAI,EAAE,GAAG,EAAE;YACT,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YACD,OAAO,eAAe,CAAC,KAAK,kCACvB,OAAO,KACV,KAAK,EAAE,SAAS,IAChB,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AAjCD,0CAiCC"}

package/dist/types/channels/_internal/ChannelBusinessRules.d.ts

@@ -1,3 +1,4 @@
+import { IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
 /**
  * @private
  * An array of all supported channel permissions
@@ -17,3 +18,4 @@ export declare const ChannelNonePermission = "hub:channel:none";
  * A map of all supported channel permissions
  */
 export declare const CHANNEL_PERMISSIONS: Record<"channelRoot" | "channelCreate" | "channelDelete" | "channelEdit" | "channelView" | "channelOwner" | "channelManage" | "channelRead" | "channelWrite" | "channelReadWrite" | "channelModerate", ChannelPermission>;
+export declare const ChannelPermissionPolicies: IPermissionPolicy[];

package/dist/types/channels/_internal/ChannelUiSchemaCreate.d.ts

@@ -7,4 +7,4 @@ import { IHubChannel } from "../../core/types";
  * This defines how the schema properties should be
  * rendered in the channel editing experience
  */
-export declare const buildUiSchema: (i18nScope: string, _options: Partial<IHubChannel>, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubChannel>, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/core/schemas/internal/discussions/EntityUiSchemaDiscussionsSettings.d.ts

@@ -4,8 +4,8 @@ import { EntityEditorOptions } from "../EditorOptions";
 /**
  * Builds the UI Schema for the "settings => discussions" workspace pane
  * @param i18nScope the i18n scope for translations
- * @param options an EntityEditorOptions object
+ * @param _options an EntityEditorOptions object
  * @param context an IArcGISContext object
  * @returns a promise that resolves a UI Schema object
  */
-export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/discussions/_internal/DiscussionBusinessRules.d.ts

@@ -4,7 +4,7 @@ import { IPermissionPolicy } from "../../permissions";
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const DiscussionPermissions: readonly ["hub:discussion", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view", "hub:discussion:owner", "hub:discussion:canChangeAccess", "hub:discussion:workspace:overview", "hub:discussion:workspace:dashboard", "hub:discussion:workspace:details", "hub:discussion:workspace:settings", "hub:discussion:workspace:collaborators", "hub:discussion:workspace:discussion", "hub:discussion:workspace:metrics", "hub:discussion:workspace:settings:discussions", "hub:discussion:manage", "temp:hub:discussion:create"];
+export declare const DiscussionPermissions: readonly ["hub:discussion", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view", "hub:discussion:owner", "hub:discussion:canChangeAccess", "hub:discussion:workspace:overview", "hub:discussion:workspace:dashboard", "hub:discussion:workspace:details", "hub:discussion:workspace:settings", "hub:discussion:workspace:collaborators", "hub:discussion:workspace:metrics", "hub:discussion:workspace:settings:discussions", "hub:discussion:manage", "temp:hub:discussion:create"];
 /**
  * Discussion permission policies
  * @private

package/dist/types/discussions/api/utils/channel-permission.d.ts

@@ -1,4 +1,12 @@
-import { IChannel, IDiscussionsUser, IUpdateChannelV2 } from "../types";
+import { IChannel, IDiscussionsUser, IUpdateChannelV2, Role } from "../types";
+/**
+ * A map of update operations & ACL roles where the key is the update operation
+ * and the value is an array of roles that are permitted to perform the update operation.
+ * See confluence for privs documentation: https://confluencewikidev.esri.com/pages/viewpage.action?pageId=153747776#Roles&Privileges-ApplicationtoChannels
+ * @internal
+ * @hidden
+ */
+export declare const CHANNEL_ACTION_PRIVS: Record<string, Role[]>;
 /**
  * @internal
  * @hidden
@@ -9,6 +17,7 @@ export declare class ChannelPermission {
     private existingChannel;
     private permissionsByCategory;
     constructor(channel: IChannel);
+    deriveUserRole(user: IDiscussionsUser): Role;
     canPostToChannel(user: IDiscussionsUser): boolean;
     canCreateChannel(user: IDiscussionsUser): boolean;
     canModerateChannel(user: IDiscussionsUser): boolean;

package/dist/types/discussions/api/utils/channels/derive-user-role-v2.d.ts

@@ -0,0 +1,9 @@
+import type { IUser } from "@esri/arcgis-rest-portal";
+import { IChannel, IDiscussionsUser, Role } from "../../types";
+/**
+ * Derives the user role for the given channel and user
+ * @param channel an IChannel object
+ * @param user  An IUser or IDiscussionUser object
+ * @returns the appropriate Role for the given user relative to the given channel
+ */
+export declare function deriveUserRoleV2(channel: IChannel, user?: IUser | IDiscussionsUser): Role;

package/dist/types/discussions/api/utils/channels/index.d.ts

@@ -8,3 +8,4 @@ export { canCreateChannelV2 } from "./can-create-channel-v2";
 export { canDeleteChannelV2 } from "./can-delete-channel-v2";
 export { canEditChannelV2 } from "./can-edit-channel-v2";
 export { canReadChannelV2 } from "./can-read-channel-v2";
+export { deriveUserRoleV2 } from "./derive-user-role-v2";

package/dist/types/discussions/api/utils/posts/cannot-create-post-groups-blocked-v2.d.ts

@@ -0,0 +1,3 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+import { IChannel, IDiscussionsUser } from "../../types";
+export declare function cannotCreatePostGroupsBlockedV2(channel: IChannel, user?: IUser | IDiscussionsUser): boolean;

package/dist/types/discussions/api/utils/posts/index.d.ts

@@ -10,3 +10,4 @@ export { canCreateReplyV2 } from "./can-create-reply-v2";
 export { canDeletePostV2 } from "./can-delete-post-v2";
 export { canEditPostStatusV2 } from "./can-edit-post-status-v2";
 export { canEditPostV2 } from "./can-edit-post-v2";
+export { cannotCreatePostGroupsBlockedV2 } from "./cannot-create-post-groups-blocked-v2";

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

@@ -1,4 +1,5 @@
 import type { IGroup, IItem } from "@esri/arcgis-rest-portal";
+import type { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubContent, IHubItemEntity } from "../core";
 import { IChannel, SharingAccess } from "./api/types";
 import { IHubSearchResult, IQuery } from "../search";
@@ -60,13 +61,13 @@ export declare function getChannelOrgIds(channel: IChannel): string[];
 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 terms 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>
+ * @param requestOptions An IRequestOptions object
+ * @returns a promise that resolves an IQuery
  */
-export declare function getChannelUsersQuery(inputs: string[], channel: IChannel, currentUsername?: string): IQuery;
+export declare function getChannelUsersQuery(terms: string[], channel: IChannel, currentUsername?: string, requestOptions?: IRequestOptions): Promise<IQuery>;
 /**
  * Transforms a given channel and optional channel groups array into a IHubSearchResult
  * @param channel

package/dist/types/search/_internal/hubDiscussionsHelpers/processChannelFilters.d.ts

@@ -1,6 +1,20 @@
 import { ISearchChannels } from "../../../discussions/api/types";
 import { IFilter } from "../../types/IHubCatalog";
 /**
+ * @private
+ *
+ * Transforms an array of unknown values into an object containing `ids` and `notIds` arrays.
+ *
+ * @param values An array of unknown values
+ * @returns and object containing an `ids` and `notIds` array
+ */
+export declare const parseIdsAndNotIds: (values: unknown[]) => {
+    ids: string[];
+    notIds: string[];
+};
+/**
+ * @private
+ *
  * Flattens an array of IFilter objects into a map of key/value pairs where the key is the name of the
  * predicate and the value is a unique array of all values for that predicate name spanning all collections
  * and predicates. Uniqueness is only guaranteed for primitives (i.e. strings, boolean, number, etc). E.g.
@@ -21,7 +35,7 @@ import { IFilter } from "../../types/IHubCatalog";
  * @param filters An array of IFilter objects
  * @returns an object containing key/value pairs of parameter values
  */
-export declare function flattenFilters(filters: IFilter[]): Record<string, any[]>;
+export declare function flattenFilters(filters: IFilter[]): Record<string, unknown[]>;
 /**
  * @private
  * Converts an IFilter array into a partial ISearchChannels

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

@@ -2,8 +2,25 @@ import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from
 /**
  * @private
  * Executes a Discussions API channel search and resolves an IHubSearchResponse<IHubSearchResult> for the channel results
+ * Currently supported filters include:
+ *   - term: string;
+ *   - group: string | string[];
+ *   - access: 'public' | 'private' | 'org' | Array<'public' | 'org' | 'private'>
+ *   - id: string | string[] | { not: string } | { not: string[] };
+ *   - orgId: string;
+ *   - hasUserPosts: boolean;
+ *   - discussion: string;
+ *   - owner: string;
+ *   - createdDateRange: IDateRange<string | number>;
+ *   - updatedDateRange: IDateRange<string | number>;
+ *   - role: 'read' | 'write' | 'readWrite' | 'moderate' | 'manage' | 'owner' | Array<'read' | 'write' | 'readWrite' | 'moderate' | 'manage' | 'owner'>
+ * Currently supported sort fields include:
+ *   - created
+ *   - modified
+ *   - owner
+ *   - lastActivity
  * @param query an IQuery object
  * @param options an IHubSearchOptions object
- * @returns a promise that resolves an HubSearchResponse<IHubSearchResult> object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> object
  */
 export declare const hubSearchChannels: (query: IQuery, searchOptions: IHubSearchOptions) => Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -3,6 +3,7 @@ import { IHubSearchOptions } from "../types/IHubSearchOptions";
 import { IHubSearchResponse } from "../types/IHubSearchResponse";
 import { IHubSearchResult } from "../types/IHubSearchResult";
 /**
+ * @private
  * Searches for events against the Events 3 API using the given `query` and `options`.
  * Currently supported filters include:
  *   - access: 'public' | 'private' | 'org' | Array<'public' | 'org' | 'private'>;
@@ -33,6 +34,6 @@ import { IHubSearchResult } from "../types/IHubSearchResult";
  *   - startDate
  * @param query An IQuery object
  * @param options An IHubSearchOptions object
- * @returns a promise that resolves a <IHubSearchResponse<IHubSearchResult> object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult> object
  */
 export declare function hubSearchEvents(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/package.json

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