@esri/hub-common 13.21.1 → 13.22.0

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

@@ -0,0 +1,25 @@
+import { RemoteServerError as _RemoteServerError } from "../../../request";
+import { IDiscussionsRequestOptions } from "../types";
+export declare class RemoteServerError extends _RemoteServerError {
+    error: string;
+    constructor(message: string, url: string, status: number, error: string);
+}
+/**
+ * returns Promise that resolves token to use in Discussions API requests
+ *
+ * @export
+ * @param {IDiscussionsRequestOptions} options
+ * @return {*}  {Promise<string>}
+ */
+export declare function authenticateRequest(options: IDiscussionsRequestOptions): Promise<string>;
+/**
+ * parses IDiscussionsRequestOptions and makes request against Discussions API
+ *
+ * @export
+ * @template T
+ * @param {string} route
+ * @param {IDiscussionsRequestOptions} options
+ * @param {string} [token]
+ * @return {*}  {Promise<T>}
+ */
+export declare function apiRequest<T>(route: string, options: IDiscussionsRequestOptions, token?: string): Promise<T>;

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

@@ -3,3 +3,4 @@ export * from "./edit";
 export * from "./fetch";
 export * from "./constants";
 export * from "./utils";
+export * from "./api";

package/dist/types/search/_internal/commonHelpers/getDiscussionsApiDefinition.d.ts

@@ -0,0 +1,2 @@
+import { IApiDefinition } from "../../types/types";
+export declare function getDiscussionsApiDefinition(): IApiDefinition;

package/dist/types/search/_internal/commonHelpers/shouldUseDiscussionsApi.d.ts

@@ -0,0 +1,11 @@
+import { EntityType } from "../../types/IHubCatalog";
+import { IHubSearchOptions } from "../../types/IHubSearchOptions";
+/**
+ * @private
+ * Determines if the Discussions API can be targeted with the given
+ * search parameters
+ * @param targetEntity
+ * @param options
+ * @returns boolean
+ */
+export declare function shouldUseDiscussionsApi(targetEntity: EntityType, options: IHubSearchOptions): boolean;

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

@@ -0,0 +1,30 @@
+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
+ */
+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 toHubSearchResult: (channelsResponse: IPagedResponse<IChannel>, query: IQuery, options: IHubSearchOptions) => 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>>;

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

@@ -2,3 +2,4 @@ export * from "./portalSearchItems";
 export * from "./hubSearchItems";
 export * from "./portalSearchGroups";
 export * from "./portalSearchUsers";
+export * from "./hubSearchChannels";

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

@@ -50,6 +50,7 @@ export interface IHubCollection {
      */
     targetEntity: EntityType;
 }
+export declare type EntityType = "item" | "group" | "user" | "groupMember" | "event" | "channel";
 /**
  * @private
  *
@@ -60,7 +61,6 @@ export interface IHubCollection {
 export interface IHubCollectionPersistance extends IHubCollection {
     hidden?: boolean;
 }
-export declare type EntityType = "item" | "group" | "user" | "groupMember" | "event";
 /**
  * IQuery is the fundamental unit used to execute a search. By composing
  * `Filter`'s and `IPredicate`s, we can express very complex queries

package/dist/types/types.d.ts

@@ -130,7 +130,7 @@ export interface IRevertableTaskFailed {
     error: Error;
 }
 export declare type IRevertableTaskResult = IRevertableTaskSuccess | IRevertableTaskFailed;
-export declare type HubFamily = "app" | "content" | "dataset" | "document" | "event" | "feedback" | "initiative" | "map" | "people" | "site" | "team" | "template" | "project";
+export declare type HubFamily = "app" | "content" | "dataset" | "document" | "event" | "feedback" | "initiative" | "map" | "people" | "site" | "team" | "template" | "project" | "channel";
 /**
  * Visibility levels of a Hub resource
  */

package/package.json

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