@esri/hub-common 13.21.0 → 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/index.d.ts

@@ -33,6 +33,7 @@ export * from "./utils";
 export * from "./versioning";
 export * from "./metrics";
 export * from "./core/updateHubEntity";
+export * from "./urls/getCardModelUrl";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/initiatives/HubInitiative.d.ts

@@ -1,14 +1,14 @@
-import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IResolvedMetric } from "../core";
+import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IResolvedMetric, IWithCardBehavior } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { InitiativeEditorType } from "./_internal/InitiativeSchema";
 import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
-import { ICardActionLink, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
 /**
  * Hub Initiative Class
  */
-export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior {
+export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior, IWithCardBehavior {
     private _catalog;
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
@@ -80,16 +80,9 @@ export declare class HubInitiative extends HubItemEntity<IHubInitiative> impleme
     resolveMetric(metricId: string): Promise<IResolvedMetric>;
     /**
      * Convert the initiative entity into a card view model that
-     * can be consumed by the suit of hub gallery components
+     * can be consumed by the suite of hub gallery components
      *
-     * @param target card link contextual target
-     * @param actionLinks card action links
-     * @param locale internationalization locale
+     * @param opts view model options
      */
-    convertToCardViewModel(target: "ago" | "view" | "workspace", actionLinks: ICardActionLink[], 
-    /**
-     * TODO: move transform logic to FE so we don't need to pass
-     * locale down (follow https://devtopia.esri.com/dc/hub/issues/7255)
-     */
-    locale: string): IHubCardViewModel;
+    convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
 }

package/dist/types/initiatives/view.d.ts

@@ -1,24 +1,19 @@
-import { IArcGISContext, IHubSearchResult } from "..";
 import { IHubInitiative } from "../core";
-import { ICardActionLink, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { EntityToCardModelFn, ResultToCardModelFn } from "../core/types/IHubCardViewModel";
 /**
  * Convert an initiative entity in a card view model
  * that can be consumed by the suite of hub gallery components
  *
  * @param initiative initiative entity
  * @param context auth & portal information
- * @param target card link contextual target
- * @param actionLinks card action links
- * @param locale internationalization locale
+ * @param opts view model options
  */
-export declare const convertInitiativeEntityToCardViewModel: (initiative: IHubInitiative, context: IArcGISContext, target?: "ago" | "view" | "workspace", actionLinks?: ICardActionLink[], locale?: string) => IHubCardViewModel;
+export declare const initiativeToCardModel: EntityToCardModelFn<IHubInitiative>;
 /**
  * Conver an initiative search result into a card view model
  * that can be consumed by the suite of hub gallery components
  *
  * @param searchResult hub initiative search result
- * @param target card link contextual target
- * @param actionLinks card action links
- * @param locale internationalization locale
+ * @param opts view model options
  */
-export declare const convertInitiativeSearchResultToCardViewModel: (searchResult: IHubSearchResult, target?: "ago" | "view" | "workspace", actionLinks?: ICardActionLink[], locale?: string) => IHubCardViewModel;
+export declare const initiativeResultToCardModel: ResultToCardModelFn;

package/dist/types/projects/HubProject.d.ts

@@ -5,7 +5,7 @@ import { HubItemEntity } from "../core/HubItemEntity";
 import { IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
 import { ProjectEditorType } from "./_internal/ProjectSchema";
 import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
-import { ICardActionLink, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
 /**
  * Hub Project Class
  */
@@ -60,16 +60,9 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * Convert the project entity into a card view model that can
      * be consumed by the suite of hub gallery components
      *
-     * @param target card link contextual target
-     * @param actionLinks card action links
-     * @param locale internationalization locale
+     * @param opts view model options
      */
-    convertToCardViewModel(target: "ago" | "view" | "workspace", actionLinks: ICardActionLink[], 
-    /**
-     * TODO: move transform logic to FE so we don't need to pass
-     * locale down (follow https://devtopia.esri.com/dc/hub/issues/7255)
-     */
-    locale: string): IHubCardViewModel;
+    convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
     /**
      * Apply a new state to the instance
      * @param changes

package/dist/types/projects/view.d.ts

@@ -1,24 +1,19 @@
-import { IArcGISContext, IHubSearchResult } from "..";
 import { IHubProject } from "../core";
-import { ICardActionLink, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { ResultToCardModelFn, EntityToCardModelFn } from "../core/types/IHubCardViewModel";
 /**
  * Convert a project entity into a card view model that can
  * be consumed by the suite of hub gallery components
  *
  * @param project project entity
  * @param context auth & portal information
- * @param target card link contextual target
- * @param actionLinks card action links
- * @param locale internationalization locale
+ * @param opts view model options
  */
-export declare const convertProjectEntityToCardViewModel: (project: IHubProject, context: IArcGISContext, target?: "ago" | "view" | "workspace", actionLinks?: ICardActionLink[], locale?: string) => IHubCardViewModel;
+export declare const projectToCardModel: EntityToCardModelFn<IHubProject>;
 /**
  * Convert a project hub search result into a card view model that
  * can be consumed by the suite of hub gallery components
  *
  * @param searchResult hub project search result
- * @param target card link contextual target
- * @param actionLinks card action links
- * @param locale internationalization locale
+ * @param opts view model options
  */
-export declare const convertProjectSearchResultToCardViewModel: (searchResult: IHubSearchResult, target?: "ago" | "view" | "workspace", actionLinks?: ICardActionLink[], locale?: string) => IHubCardViewModel;
+export declare const projectResultToCardModel: ResultToCardModelFn;

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/dist/types/urls/getCardModelUrl.d.ts

@@ -0,0 +1,21 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubEntity } from "../core/types/HubEntity";
+import { CardModelTarget } from "../core/types/IHubCardViewModel";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
+/**
+ * returns a gallery card's title url from a hub search result
+ *
+ * @param result hub search result
+ * @param target context the card should redirect to
+ * @param baseUrl base url to work in conjunction with the target
+ */
+export declare function getCardModelUrlFromResult(result: IHubSearchResult, target: CardModelTarget, baseUrl?: string): string;
+/**
+ * returns a gallery card's title url from an entity
+ *
+ * @param entity hub entity
+ * @param context auth & portal information
+ * @param target context the card should redirect to
+ * @param baseUrl base url to work in conjunction with the target
+ */
+export declare function getCardModelUrlFromEntity(entity: HubEntity, context: IArcGISContext, target: CardModelTarget, baseUrl?: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "13.21.0",
+  "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",