@esri/hub-common 14.24.0 → 14.25.1

package/dist/types/initiative-templates/defaults.d.ts

@@ -0,0 +1,8 @@
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { IModel } from "../types";
+export declare const HUB_INITIATIVE_TEMPLATE_ITEM_TYPE = "Hub Initiative Template";
+/**
+ * Default values of a IHubInitiativeTemplate
+ */
+export declare const DEFAULT_INITIATIVE_TEMPLATE: Partial<IHubInitiativeTemplate>;
+export declare const DEFAULT_INITIATIVE_TEMPLATE_MODEL: IModel;

package/dist/types/initiative-templates/edit.d.ts

@@ -0,0 +1,32 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubInitiativeTemplate, IHubInitiativeTemplateEditor } from "../core/types/IHubInitiativeTemplate";
+/**
+ * @private
+ * Create a new Hub Initiative Template item
+ * @param partialInitiativeTemplate
+ * @param requestOptions
+ * @returns
+ */
+export declare function createInitiativeTemplate(partialInitiativeTemplate: Partial<IHubInitiativeTemplate>, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * Convert an IHubInitiativeTemplateEditor back to an IHubInitiativeTemplate
+ * @param editor
+ * @param portal
+ * @returns
+ */
+export declare function editorToInitiativeTemplate(editor: IHubInitiativeTemplateEditor, portal: IPortal): IHubInitiativeTemplate;
+/**
+ * @private
+ * Update a Hub Initiative Template
+ * @param initiativeTemplate
+ * @param requestOptions
+ */
+export declare function updateInitiativeTemplate(initiativeTemplate: IHubInitiativeTemplate, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Remove a Hub Initiative Template
+ * @param id
+ * @param requestOptions
+ */
+export declare function deleteInitiativeTemplate(id: string, requestOptions: IUserRequestOptions): Promise<void>;

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

@@ -0,0 +1,16 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubInitiativeTemplate } from "../core/types";
+import { IHubSearchResult } from "../search";
+import { IHubRequestOptions } from "../types";
+export declare function fetchInitiativeTemplate(identifier: string, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Convert a Hub Initiative Template Item into a Hub Initiative Template, feching any additional
+ * information that may be required
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function convertItemToInitiativeTemplate(item: IItem, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+export declare function enrichInitiativeTemplateSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

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

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

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

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

package/dist/types/permissions/types/Permission.d.ts

@@ -6,6 +6,7 @@ import { ContentPermissions } from "../../content/_internal/ContentBusinessRules
 import { GroupPermissions } from "../../groups/_internal/GroupBusinessRules";
 import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
 import { PlatformPermissions } from "../PlatformPermissionPolicies";
+import { InitiativeTemplatePermissions } from "../../initiative-templates/_internal/InitiativeTemplateBusinessRules";
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -15,7 +16,7 @@ declare const TempPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number];
+export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number];
 /**
  * Validate a Permission
  * @param permission

package/package.json

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