@esri/hub-common 14.26.1 → 14.27.0

package/dist/types/templates/fetch.d.ts

@@ -0,0 +1,28 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubTemplate } from "../core/types/IHubTemplate";
+import { IHubRequestOptions } from "../types";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubSearchResult } from "../search/types";
+/**
+ * @private
+ * Fetch a Hub Template backing item by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions
+ */
+export declare function fetchTemplate(identifier: string, requestOptions: IRequestOptions): Promise<IHubTemplate>;
+/**
+ * @private
+ * Convert a Solution Item into a Hub Template, fetching
+ * any additional information that may be required
+ * @param item
+ * @param auth
+ */
+export declare function convertItemToTemplate(item: IItem, requestOptions: IRequestOptions): Promise<IHubTemplate>;
+/**
+ * @private
+ * Fetch template specific enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ */
+export declare function enrichTemplateSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

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

@@ -0,0 +1,4 @@
+export * from "./HubTemplate";
+export * from "./view";
+export * from "./fetch";
+export * from "./edit";

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

@@ -0,0 +1,13 @@
+import { IItem } from "@esri/arcgis-rest-types";
+/**
+ * We do our best to glean what the solution template
+ * is supposed to become when deployed. This util
+ * extracts the expected item type from the
+ * hubSolutionType typeKeyword on the solution item
+ *
+ * We use this in various UIs to show the expected
+ * type rather than "Solution"
+ *
+ * @param template
+ */
+export declare const getDeployedTemplateType: (template: IItem) => string;

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

@@ -0,0 +1,19 @@
+import { IHubTemplate } from "../core/types/IHubTemplate";
+import { ResultToCardModelFn, EntityToCardModelFn } from "../core/types/IHubCardViewModel";
+/**
+ * Convert a template entity into a card view model that can
+ * be consumed by the suite of hub gallery components
+ *
+ * @param template template entity
+ * @param context auth & portal information
+ * @param opts view model options
+ */
+export declare const templateToCardModel: EntityToCardModelFn<IHubTemplate>;
+/**
+ * Convert a template hub search result into a card view model
+ * that can be consumed by the suite of hub gallery components
+ *
+ * @param searchResult hub template search result
+ * @param opts view model options
+ */
+export declare const templateResultToCardModel: ResultToCardModelFn;

package/dist/types/urls/getCardModelUrl.d.ts

@@ -3,7 +3,8 @@ 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
+ * given a target and hub search result, this util
+ * returns a gallery card's title url
  *
  * @param result hub search result
  * @param target context the card should redirect to
@@ -11,7 +12,8 @@ import { IHubSearchResult } from "../search/types/IHubSearchResult";
  */
 export declare function getCardModelUrlFromResult(result: IHubSearchResult, target: CardModelTarget, baseUrl?: string): string;
 /**
- * returns a gallery card's title url from an entity
+ * given a target and hub entity, this util
+ * returns a gallery card's title url
  *
  * @param entity hub entity
  * @param context auth & portal information

package/package.json

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