@esri/hub-common 14.184.2 → 14.186.0

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

@@ -8,22 +8,28 @@ const processFilters_1 = require("./hubEventsHelpers/processFilters");
 /**
  * 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' | 'access'>;
- *   canEdit: boolean
- *   entityId: string | string[];
- *   entityType: string | string[];
- *   id: string | string[];
- *   userId: string;
- *   term: string;
- *   categories: string | string[];
- *   tags: string | string[];
- *   group: string | string[];
- *   readGroupId: string | string[];
- *   editGroupId: string | string[];
- *   attendanceType: 'virtual' | 'in_person' | Array<'virtual' | 'in_person'>;
- *   owner: string | string[];
- *   status: 'planned' | 'canceled' | 'removed' | Array<'planned' | 'canceled' | 'removed'>;
- *   startDateRange: IDateRange<string | number>
+ *   - access: 'public' | 'private' | 'org' | Array<'public' | 'org' | 'access'>;
+ *   - canEdit: boolean
+ *   - entityId: string | string[];
+ *   - entityType: string | string[];
+ *   - id: string | string[];
+ *   - userId: string;
+ *   - term: string;
+ *   - categories: string | string[];
+ *   - tags: string | string[];
+ *   - group: string | string[];
+ *   - readGroupId: string | string[];
+ *   - editGroupId: string | string[];
+ *   - attendanceType: 'virtual' | 'in_person' | Array<'virtual' | 'in_person'>;
+ *   - owner: string | string[];
+ *   - status: 'planned' | 'canceled' | 'removed' | Array<'planned' | 'canceled' | 'removed'>;
+ *   - startDateRange: IDateRange<string | number>;
+ *   - endDateRange: IDateRange<string | number>;
+ * Currently supported sort fields include:
+ *   - created
+ *   - modified
+ *   - title
+ *   - startDate
  * @param query An IQuery object
  * @param options An IHubSearchOptions object
  * @returns a promise that resolves a <IHubSearchResponse<IHubSearchResult> object
@@ -31,7 +37,7 @@ const processFilters_1 = require("./hubEventsHelpers/processFilters");
 async function hubSearchEvents(query, options) {
     const processedFilters = await processFilters_1.processFilters(query.filters, options.requestOptions);
     const processedOptions = processOptions_1.processOptions(options);
-    const data = Object.assign(Object.assign(Object.assign({}, processedFilters), processedOptions), { include: "creator,registrations" });
+    const data = Object.assign(Object.assign(Object.assign({}, processedFilters), processedOptions), { include: "creator" });
     const { items, nextStart, total } = await events_1.getEvents(Object.assign(Object.assign({}, options.requestOptions), { data }));
     const results = await Promise.all(items.map((event) => eventToSearchResult_1.eventToSearchResult(event, options)));
     const hasNext = nextStart > -1;

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,oDAAoD;AAEpD,gFAA6E;AAC7E,sEAAmE;AACnE,sEAAmE;AAEnE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,eAAe,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,gBAAgB,GAAG,MAAM,+BAAc,CAC3C,KAAK,CAAC,OAAO,EACb,OAAO,CAAC,cAAc,CACvB,CAAC;IACF,MAAM,gBAAgB,GAAG,+BAAc,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,IAAI,iDACL,gBAAgB,GAChB,gBAAgB,KACnB,OAAO,EAAE,uBAAuB,GACjC,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,kBAAS,iCAC9C,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;AApCD,0CAoCC"}
+{"version":3,"file":"hubSearchEvents.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchEvents.ts"],"names":[],"mappings":";;;AAIA,oDAAoD;AAEpD,gFAA6E;AAC7E,sEAAmE;AACnE,sEAAmE;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,eAAe,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,gBAAgB,GAAG,MAAM,+BAAc,CAC3C,KAAK,CAAC,OAAO,EACb,OAAO,CAAC,cAAc,CACvB,CAAC;IACF,MAAM,gBAAgB,GAAG,+BAAc,CAAC,OAAO,CAAC,CAAC;IACjD,MAAM,IAAI,iDACL,gBAAgB,GAChB,gBAAgB,KACnB,OAAO,EAAE,SAAS,GACnB,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,MAAM,kBAAS,iCAC9C,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;AApCD,0CAoCC"}

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

@@ -121,9 +121,16 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug,
      */
     readGroupIds: string[];
     /**
-     * A collection of objects containing the ids & types for entities that the event references
+     * A collection of content ids explicitly referenced by the event
      */
-    references: Array<Record<string, string>>;
+    referencedContentIds: string[];
+    /**
+     * A collection of objects containing the ids & types for entities referenced by the event
+     */
+    referencedContentIdsByType: Array<{
+        entityId: string;
+        entityType: string;
+    }>;
     /**
      * The start date of the event
      */

package/dist/types/events/_internal/buildEventAssociations.d.ts

@@ -0,0 +1,6 @@
+import { IHubRequestOptions } from "../../types";
+import { ICreateEventAssociation } from "../api";
+export declare function buildEventAssociations(referencedContentIdsByType: Array<{
+    entityId: string;
+    entityType: string;
+}>, referencedContentIds: string[], hubRequestOptions: IHubRequestOptions): Promise<ICreateEventAssociation[]>;

package/dist/types/events/_internal/buildReferencedContentSchema.d.ts

@@ -0,0 +1,3 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchemaElement } from "../../core/schemas/types";
+export declare function buildReferencedContentSchema(i18nScope: string, context: IArcGISContext, label?: string): IUiSchemaElement;

package/dist/types/events/edit.d.ts

@@ -14,7 +14,7 @@ export interface IHubCreateEventRegistration {
  *
  * @param partialEvent a partial event
  * @param requestOptions user request options
- * @returns promise that resolves a IHubEvent
+ * @returns promise that resolves an IHubEvent
  */
 export declare function createHubEvent(partialEvent: Partial<IHubEvent>, requestOptions: IHubRequestOptions): Promise<IHubEvent>;
 /**

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

@@ -96,6 +96,9 @@ export interface INotificationSpec {
  * Metadata for the subscription
  */
 export declare type ICreateSubscriptionMetadata = ICreateEventMetadata | ICreateTelemetryReportMetadata;
+export declare enum SubscriptionEntityType {
+    DISCUSSION = "DISCUSSION"
+}
 export declare enum DeliveryMethod {
     EMAIL = "EMAIL"
 }
@@ -105,37 +108,35 @@ export declare enum Cadence {
     WEEKLY = "WEEKLY",
     MONTHLY = "MONTHLY"
 }
+export declare enum SystemNotificationSpecNames {
+    TELEMETRY_REPORT = "TELEMETRY_REPORT",
+    EVENT = "EVENT",
+    DISCUSSION_ON_ENTITY = "DISCUSSION_ON_ENTITY"
+}
+export declare enum SubscriptionActions {
+    DISCUSSION_POST_PENDING = "DISCUSSION_POST_PENDING"
+}
 export interface IUpdateSubscription {
+    /** An array of actions representing user selections that further customize the subscription behavior */
+    actions?: SubscriptionActions[];
     /** Flag to opt user in or out of subscription */
     active?: boolean;
     /** Frequency of the subscription */
     cadence?: Cadence;
     /** Delivery method for subscription, ie email or text */
     deliveryMethod?: DeliveryMethod;
+    /** The AGO id of the entity associated with the subscription */
+    entityId?: string;
+    /** The type of entity associated with the subscription entityId */
+    entityType?: SubscriptionEntityType;
     /** Last delivered datetime string of the subscription in ISO 8601 format */
     lastDelivery?: string;
     /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
     userId?: string;
 }
-export interface ISubscription {
-    active: boolean;
-    cadence: Cadence;
-    createdAt: string;
-    deliveryMethod: DeliveryMethod;
-    id: number;
-    lastDelivery: string;
-    metadata: ISubscriptionMetadata;
-    notificationSpec?: INotificationSpec;
-    notificationSpecId: number;
-    updatedAt: string;
-    user?: IUser;
-    userId: string;
-}
-export declare enum SystemNotificationSpecNames {
-    TELEMETRY_REPORT = "TELEMETRY_REPORT",
-    EVENT = "EVENT"
-}
 export interface ISubscribe {
+    /** An array of actions representing user selections that further customize the subscription behavior */
+    actions?: SubscriptionActions[];
     /** ArcGIS Online id for a user. Will always be extracted from the token unless service token is used. */
     agoId?: string;
     /** Frequency of the subscription */
@@ -146,6 +147,10 @@ export interface ISubscribe {
     deliveryMethod: DeliveryMethod;
     /** Email for the subscriber. Will always be extracted from the token unless service token is used. */
     email?: string;
+    /** The AGO id of the entity associated with the subscription */
+    entityId?: string;
+    /** The type of entity associated with the subscription entityId */
+    entityType?: SubscriptionEntityType;
     /** First name for the subscriber. Will always be extracted from the token unless service token is used. */
     firstName?: string;
     /** Last name for the subscriber. Will always be extracted from the token unless service token is used. */
@@ -159,11 +164,34 @@ export interface ISubscribe {
     /** Username for the subscriber. Will always be extracted from the token unless service token is used. */
     username?: string;
 }
+export interface ISubscription {
+    actions: SubscriptionActions[];
+    active: boolean;
+    cadence: Cadence;
+    createdAt: string;
+    deliveryMethod: DeliveryMethod;
+    entityId: string;
+    entityType: SubscriptionEntityType;
+    id: number;
+    lastDelivery: string;
+    metadata: ISubscriptionMetadata;
+    notificationSpec?: INotificationSpec;
+    notificationSpecId: number;
+    updatedAt: string;
+    user?: IUser;
+    userId: string;
+}
 export interface ICreateSubscription {
+    /** An array of actions representing user selections that further customize the subscription behavior */
+    actions?: SubscriptionActions[];
     /** Frequency of the subscription */
     cadence: Cadence;
     /** Delivery method for subscription, ie email or text */
     deliveryMethod: DeliveryMethod;
+    /** The AGO id of the entity associated with the subscription */
+    entityId?: string;
+    /** The type of entity associated with the subscription entityId */
+    entityType?: SubscriptionEntityType;
     /** Metadata for the subscription */
     metadata: ICreateSubscriptionMetadata;
     /** Notification spec name for the subscription */

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

@@ -5,22 +5,28 @@ import { IHubSearchResult } from "../types/IHubSearchResult";
 /**
  * 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' | 'access'>;
- *   canEdit: boolean
- *   entityId: string | string[];
- *   entityType: string | string[];
- *   id: string | string[];
- *   userId: string;
- *   term: string;
- *   categories: string | string[];
- *   tags: string | string[];
- *   group: string | string[];
- *   readGroupId: string | string[];
- *   editGroupId: string | string[];
- *   attendanceType: 'virtual' | 'in_person' | Array<'virtual' | 'in_person'>;
- *   owner: string | string[];
- *   status: 'planned' | 'canceled' | 'removed' | Array<'planned' | 'canceled' | 'removed'>;
- *   startDateRange: IDateRange<string | number>
+ *   - access: 'public' | 'private' | 'org' | Array<'public' | 'org' | 'access'>;
+ *   - canEdit: boolean
+ *   - entityId: string | string[];
+ *   - entityType: string | string[];
+ *   - id: string | string[];
+ *   - userId: string;
+ *   - term: string;
+ *   - categories: string | string[];
+ *   - tags: string | string[];
+ *   - group: string | string[];
+ *   - readGroupId: string | string[];
+ *   - editGroupId: string | string[];
+ *   - attendanceType: 'virtual' | 'in_person' | Array<'virtual' | 'in_person'>;
+ *   - owner: string | string[];
+ *   - status: 'planned' | 'canceled' | 'removed' | Array<'planned' | 'canceled' | 'removed'>;
+ *   - startDateRange: IDateRange<string | number>;
+ *   - endDateRange: IDateRange<string | number>;
+ * Currently supported sort fields include:
+ *   - created
+ *   - modified
+ *   - title
+ *   - startDate
  * @param query An IQuery object
  * @param options An IHubSearchOptions object
  * @returns a promise that resolves a <IHubSearchResponse<IHubSearchResult> object

package/package.json

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