@esri/hub-common 20.13.0 → 20.15.0

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

@@ -0,0 +1,8 @@
+import { ISearchPosts } from "../../../discussions";
+import { IHubSearchOptions } from "../../types";
+/**
+ * Builds a Partial<ISearchPosts> for the given IHubSearchOptions
+ * @param options An IHubSearchOptions object
+ * @returns a Partial<ISearchPosts> for the given IHubSearchOptions
+ */
+export declare function processPostOptions(options: IHubSearchOptions): Partial<ISearchPosts>;

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

@@ -0,0 +1,7 @@
+import { PostRelation } from "../../../discussions/api/types";
+/**
+ * Convert an array of `include` into an array of PostRelation enum values.
+ * @param relations array of include (e.g. ["channel", "replies"]).
+ * @returns PostRelation[] with order of first appearance preserved and duplicates removed.
+ */
+export declare function processRelations(relations?: string[]): PostRelation[];

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

@@ -0,0 +1,56 @@
+import { IHubSearchResult } from "../types/IHubSearchResult";
+import { IHubSearchOptions } from "../types/IHubSearchOptions";
+import { IHubSearchResponse } from "../types/IHubSearchResponse";
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * @private
+ * Executes a Discussions API (v2) post search and resolves an IHubSearchResponse<IHubSearchResult>.
+ * Currently supported filters include (filter predicate key => accepted values):
+ *   - access: 'public' | 'private' | 'org' | Array<'public' | 'private' | 'org'>
+ *   - body: string
+ *   - channel: string | string[] (mapped internally to `channels`)
+ *   - owner: string | string[] (first value mapped to `creator`)
+ *   - discussion: string | string[]
+ *   - editor: string | string[]
+ *   - status: 'pending' | 'approved' | 'rejected' | 'deleted' | 'hidden' | 'blocked' | Array<...>
+ *   - title: string | string[]
+ *   - parentId: string | string[] (mapped internally to `parents`)
+ *   - groups: string | string[]
+ *   - postType: 'text' | 'announcement' | 'poll' | 'question'
+ *   - created: IDateRange<string | number> (mapped to createdAfter / createdBefore)
+ *   - modified: IDateRange<string | number> (mapped to updatedAfter / updatedBefore)
+ *
+ * Notes / constraints:
+ *   - For single-value filters where an array is provided (e.g., owner, editor, discussion, title, body), only the first value is used.
+ *   - Date range predicates use the shape: { from: string|number; to: string|number }.
+ *   - Unsupported filters are ignored silently.
+ *
+ * INCLUDE SUPPORT (options.include tokens mapped to post relations - bare tokens only)
+ *   channel     -> PostRelation.CHANNEL
+ *   parent      -> PostRelation.PARENT
+ *   replies     -> PostRelation.REPLIES (returns replies collection or paging info)
+ *   replyCount  -> PostRelation.REPLY_COUNT (numeric aggregate)
+ *   reactions   -> PostRelation.REACTIONS
+ *   channelAcl  -> PostRelation.CHANNEL_ACL
+ *   Unknown tokens are ignored; no namespaced forms (e.g. `post:channel`) are supported.
+ *
+ * Currently supported sort fields include (pass via `options.sortField`):
+ *   - body
+ *   - channelId
+ *   - created  (maps to createdAt)
+ *   - modified (maps to updatedAt)
+ *   - owner    (maps to creator)
+ *   - discussion
+ *   - editor
+ *   - id
+ *   - parentId
+ *   - status
+ *   - title
+ * Sort order: 'ASC' | 'DESC' (via `options.sortOrder`).
+ * Pagination options: `options.num` (page size), `options.start` (1-based offset handled by API).
+ *
+ * @param query An IQuery object (must include `filters` and `targetEntity: 'post'` upstream)
+ * @param options An IHubSearchOptions object
+ * @returns a promise that resolves an IHubSearchResponse<IHubSearchResult>
+ */
+export declare function hubSearchPosts(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -74,7 +74,7 @@ export interface IHubCollection {
      */
     displayConfig?: IGalleryDisplayConfig;
 }
-export declare const targetEntities: readonly ["item", "group", "user", "portalUser", "communityUser", "groupMember", "event", "channel", "discussionPost", "eventAttendee", "organization"];
+export declare const targetEntities: readonly ["item", "group", "user", "portalUser", "communityUser", "groupMember", "event", "channel", "discussionPost", "eventAttendee", "organization", "post"];
 export declare type EntityType = (typeof targetEntities)[number];
 /**
  * IQuery is the fundamental unit used to execute a search. By composing

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

@@ -1,7 +1,7 @@
 import { IGroup, IItem, IUser } from "@esri/arcgis-rest-portal";
 import { HubFamily, IHubGeography } from "../../hub-types";
 import { IOgcItem } from "../_internal/hubSearchItemsHelpers/interfaces";
-import { IChannel } from "../../discussions/api/types";
+import { IChannel, IPost } from "../../discussions/api/types";
 import { IEvent, IRegistration } from "../../events/api/orval/api/orval-events";
 import { IHubLocation } from "../../core/types/IHubLocation";
 import { AccessLevel } from "../../core/types/types";
@@ -61,7 +61,7 @@ export interface IHubSearchResult extends IHubEntityBase {
      * Note: We will need to cast to the approproate type
      * in order to access the properties
      */
-    rawResult?: IItem | IGroup | IUser | IOgcItem | IChannel | IEvent | IRegistration;
+    rawResult?: IItem | IGroup | IUser | IOgcItem | IChannel | IEvent | IRegistration | IPost;
     /** Allow any additional properties to be added */
     [key: string]: any;
 }

package/package.json

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