@esri/hub-common 16.0.2 → 16.2.0

package/dist/node/utils/batch.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/utils/batch.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,SAAgB,KAAK,CACnB,MAAc,EACd,EAAmB,EACnB,YAAoB,CAAC;IAErB,MAAM,SAAS,GAAG,CAAC,QAAkB,EAAE,KAAU,EAAY,EAAE;QAC7D,IAAI,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;YAC1C,MAAM,GAAG,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvB;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,CACzB,OAAqB,EACrB,aAAqB,EACP,EAAE;QAChB,MAAM,YAAY,GAAG,CAAC,WAAkB,EAAE,EAAE;YAC1C,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAChD,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAC5B,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,sCAAsC;IACtC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE7C,0CAA0C;IAC1C,0CAA0C;IAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAlCD,sBAkCC"}
+{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/utils/batch.ts"],"names":[],"mappings":";;;AACA,qCAA8C;AAE9C;;;;;;;GAOG;AACH,SAAgB,KAAK,CACnB,MAAc,EACd,EAAmB,EACnB,YAAoB,CAAC;IAErB,MAAM,kBAAkB,GAAG,CACzB,OAAqB,EACrB,aAAqB,EACP,EAAE;QAChB,MAAM,YAAY,GAAG,CAAC,WAAkB,EAAE,EAAE;YAC1C,MAAM,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAChD,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAC5B,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC,CAAC;IAEF,sCAAsC;IACtC,MAAM,OAAO,GAAG,2BAAkB,CAAS,MAAM,EAAE,SAAS,CAAC,CAAC;IAE9D,0CAA0C;IAC1C,0CAA0C;IAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;AACjE,CAAC;AAxBD,sBAwBC"}

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

@@ -0,0 +1,11 @@
+import type { IArcGISContext } from "../../../../types/IArcGISContext";
+import { IUiSchema } from "../../types";
+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 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>;

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

@@ -12,7 +12,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:discussion:settings:discussions", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -42,7 +42,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat", "hub:card:
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit", "hub:card:stat", "hub:card:follow", "hub:card:eventGallery"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:discussion:settings:discussions", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit", "hub:card:stat", "hub:card:follow", "hub:card:eventGallery"];
 /**
  * An editor's module when dynamically imported depending on the EditorType. This
  * will always have a buildUiSchema function, and sometimes it will have a

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: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:discussion", "hub:discussion:workspace:metrics", "hub:discussion:workspace:settings:discussions", "hub:discussion:manage", "temp:hub:discussion:create"];
 /**
  * Discussion permission policies
  * @private

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

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core";
 export declare type DiscussionEditorType = (typeof DiscussionEditorTypes)[number];
-export declare const DiscussionEditorTypes: readonly ["hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings"];
+export declare const DiscussionEditorTypes: readonly ["hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:discussion:settings:discussions"];
 /**
  * defines the JSON schema for a Discussion's editable fields
  */

package/dist/types/events/api/orval/api/orval-events.d.ts

@@ -1,9 +1,3 @@
-/**
- * Generated by orval v6.24.0 🍺
- * Do not edit manually.
- * Hub Events Service
- * OpenAPI spec version: 0.0.1
- */
 /**
  * Generated by orval v6.24.0 🍺
  * Do not edit manually.
@@ -287,6 +281,10 @@ export declare enum GetEventsInclude {
     onlineMeeting = "onlineMeeting",
     registrations = "registrations"
 }
+export declare enum EventsSearchFormat {
+    csv = "csv",
+    json = "json"
+}
 export interface IPagedEventResponse {
     items: IEvent[];
     nextStart: number;
@@ -325,6 +323,8 @@ export interface ISearchEvents {
     entityTypes?: EventAssociationEntityType[];
     /** Array of event ids */
     eventIds?: string[];
+    /** response data format. Example: csv,json */
+    f?: EventsSearchFormat;
     /** esri geometry object */
     geometry?: ISearchEventsGeometry;
     /** Array of relation fields to include in response. Example: associations,creator,location,onlineMeeting,registrations */
@@ -651,16 +651,49 @@ export declare enum EventAccess {
     PUBLIC = "PUBLIC"
 }
 declare type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1];
+/**
+ * Create a new event.
+ */
 export declare const createEvent: (iCreateEvent: ICreateEvent, options?: SecondParameter<typeof customClient>) => Promise<IEvent>;
+/**
+ * Get a list of events matching request criteria.
+ */
 export declare const getEvents: (params?: GetEventsParams, options?: SecondParameter<typeof customClient>) => Promise<IPagedEventResponse>;
+/**
+ * Search for events matching request criteria.
+ */
 export declare const searchEvents: (iSearchEvents: ISearchEvents, options?: SecondParameter<typeof customClient>) => Promise<IPagedEventResponse>;
+/**
+ * Get a single event.
+ */
 export declare const getEvent: (id: string, options?: SecondParameter<typeof customClient>) => Promise<IEvent>;
+/**
+ * Update an existing event.
+ */
 export declare const updateEvent: (id: string, iUpdateEvent: IUpdateEvent, options?: SecondParameter<typeof customClient>) => Promise<IEvent>;
+/**
+ * Delete an existing event.
+ */
 export declare const deleteEvent: (id: string, options?: SecondParameter<typeof customClient>) => Promise<IEvent>;
+/**
+ * Create a new registration.
+ */
 export declare const createRegistration: (iCreateRegistration: ICreateRegistration, options?: SecondParameter<typeof customClient>) => Promise<IRegistration>;
+/**
+ * Get a list of registrations matching request criteria.
+ */
 export declare const getRegistrations: (params?: GetRegistrationsParams, options?: SecondParameter<typeof customClient>) => Promise<IPagedRegistrationResponse>;
+/**
+ * Get a registration by id.
+ */
 export declare const getRegistration: (id: string, options?: SecondParameter<typeof customClient>) => Promise<IRegistration>;
+/**
+ * Update a registration by id.
+ */
 export declare const updateRegistration: (id: string, iUpdateRegistration: IUpdateRegistration, options?: SecondParameter<typeof customClient>) => Promise<IRegistration>;
+/**
+ * Delete a registration by id.
+ */
 export declare const deleteRegistration: (id: string, options?: SecondParameter<typeof customClient>) => Promise<IRegistration>;
 export declare type CreateEventResult = NonNullable<Awaited<ReturnType<typeof createEvent>>>;
 export declare type GetEventsResult = NonNullable<Awaited<ReturnType<typeof getEvents>>>;

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

@@ -0,0 +1,11 @@
+import { IHubSearchOptions, IHubSearchResult } from "../../types";
+import { IChannel } from "../../../discussions/api/types";
+/**
+ * @private
+ * Convert an array of Discussions API channel search results into an
+ * array of IHubSearchResult objects
+ * @param channels An array of IChannel objects
+ * @param options an IHubSearchOptions object
+ * @returns a promise that resolves an array of IHubSearchResult objects
+ */
+export declare function channelResultsToSearchResults(channels: IChannel[], options: IHubSearchOptions): Promise<IHubSearchResult[]>;

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

@@ -0,0 +1,10 @@
+import { ISearchChannels } from "../../../discussions/api/types";
+import { IFilter } from "../../types/IHubCatalog";
+/**
+ * @private
+ * Converts an IFilter array into a partial ISearchChannels
+ * object of filter parameters
+ * @param filters An array of IFilter objects
+ * @returns a partial ISearchChannels object
+ */
+export declare function processChannelFilters(filters: IFilter[]): Partial<ISearchChannels>;

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

@@ -0,0 +1,10 @@
+import { ISearchChannels } from "../../../discussions/api/types";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * @private
+ * Converts an IHubSearchOptions object into a partial ISearchChannels
+ * object of paging & sort parameters
+ * @param options An IHubSearchOptions object
+ * @returns a partial ISearchChannels object
+ */
+export declare function processChannelOptions(options: IHubSearchOptions): Partial<ISearchChannels>;

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

@@ -1,30 +1,9 @@
 import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
-import { IChannel, IPagedResponse, ISearchChannelsParams } from "../../discussions";
 /**
  * @private
- * Convert hubSearch IHubSearchOptions and IQuery interfaces to a
- * ISearchChannelsParams structure that is needed for the Discussions API
- * searchChannels(searchOptions: ISearchCHannelsParams) function
- * @param {IHubSearchOptions} options
- * @param {IQuery} query
- * @returns ISearchChannelParams
+ * Executes a Discussions API channel search and resolves an IHubSearchResponse<IHubSearchResult> for the channel results
+ * @param query an IQuery object
+ * @param options an IHubSearchOptions object
+ * @returns a promise that resolves an HubSearchResponse<IHubSearchResult> object
  */
-export declare const processSearchParams: (options: IHubSearchOptions, query: IQuery) => ISearchChannelsParams;
-/**
- * @private
- * Convert the Discussions API searchChannels response into an
- * IHubSearchResponse necessary for supporting hubSearch results
- * @param {IPagedResponse{IChannel}} channelsResponse
- * @param {IQuery} query
- * @param {IHubSearchOptions} options
- * @returns IHubSearchResponse<IHubSearchResult>
- */
-export declare const toHubSearchResults: (channelsResponse: IPagedResponse<IChannel>, query: IQuery, options: IHubSearchOptions) => Promise<IHubSearchResponse<IHubSearchResult>>;
-/**
- * @private
- * Execute channel search against the Discussions API
- * @param query
- * @param options
- * @returns
- */
-export declare const hubSearchChannels: (query: IQuery, options: IHubSearchOptions) => Promise<IHubSearchResponse<IHubSearchResult>>;
+export declare const hubSearchChannels: (query: IQuery, searchOptions: IHubSearchOptions) => Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/users/_internal/UserBusinessRules.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 UserPermissions: readonly ["hub:user", "hub:user:view", "hub:user:edit", "hub:user:owner", "hub:user:workspace", "hub:user:workspace:overview", "hub:user:workspace:settings", "hub:user:workspace:content", "hub:user:workspace:groups", "hub:user:workspace:events", "hub:user:workspace:discussions", "hub:user:workspace:shared-with-me", "hub:user:manage"];
+export declare const UserPermissions: readonly ["hub:user", "hub:user:view", "hub:user:edit", "hub:user:owner", "hub:user:workspace", "hub:user:workspace:overview", "hub:user:workspace:settings", "hub:user:workspace:content", "hub:user:workspace:groups", "hub:user:workspace:events", "hub:user:workspace:shared-with-me", "hub:user:manage"];
 /**
  * User permission policies
  * @private

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

@@ -7,3 +7,11 @@
  * @private
  */
 export declare const maybeConcat: (arrays: any[][]) => any[];
+/**
+ * Splits a single array into many arrays of a given max length.
+ * E.g. splitArrayByLength(['a', 'b', 'c'], 2); // => [['a', 'b'], ['c']]
+ * @param originalValues The original array of values
+ * @param length The max length of the resulting arrays
+ * @returns an array of arrays
+ */
+export declare function splitArrayByLength<T>(originalValues: T[], length: number): T[][];

package/package.json

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