@esri/hub-common 13.22.1 → 13.24.0

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

@@ -1,15 +1,15 @@
-import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IResolvedMetric, IWithCardBehavior } from "../core";
+import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, IResolvedMetric, IWithCardBehavior, IHubProjectEditor, IEntityEditorContext } from "../core";
+import { EditorType } from "../core/schemas/getEntityEditorSchemas";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
-import { IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
-import { ProjectEditorType } from "./_internal/ProjectSchema";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
 import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
 /**
  * Hub Project Class
  */
-export declare class HubProject extends HubItemEntity<IHubProject> implements IWithStoreBehavior<IHubProject>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior, IWithCardBehavior {
+export declare class HubProject extends HubItemEntity<IHubProject> implements IWithStoreBehavior<IHubProject>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior, IWithCardBehavior, IWithEditorBehavior {
     private _catalog;
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
@@ -45,16 +45,11 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      */
     static fetch(identifier: string, context: IArcGISContext): Promise<HubProject>;
     /**
-     * Static method to get the editor config for the HubProject entity.
-     * @param i18nScope translation scope to be interpolated into the uiSchema
-     * @param type editor type - corresonds to the returned uiSchema
-     * @param options optional hash of dynamic uiSchema element options
-     *
-     * Note: typescript does not have a means to specify static methods in interfaces
-     * so while this is the implementation of IWithEditorBehavior, it is not enforced
-     * by the compiler.
+     * Given a partial project, apply defaults to it to ensure that a baseline of properties are set
+     * @param partialProject
+     * @param context
+     * @returns
      */
-    static getEditorConfig(i18nScope: string, type: ProjectEditorType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;
     private static applyDefaults;
     /**
      * Convert the project entity into a card view model that can
@@ -63,6 +58,19 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * @param opts view model options
      */
     convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the project as an editor object
+     * @param editorContext
+     * @returns
+     */
+    toEditor(editorContext?: IEntityEditorContext): IHubProjectEditor;
+    /**
+     * Load the project from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubProjectEditor): Promise<IHubProject>;
     /**
      * Apply a new state to the instance
      * @param changes

package/dist/types/projects/_internal/ProjectBusinessRules.d.ts

@@ -19,7 +19,7 @@ export declare const ProjectCapabilityPermissions: ICapabilityPermission[];
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const ProjectPermissions: readonly ["hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner"];
+export declare const ProjectPermissions: readonly ["hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner", "hub:project:share"];
 /**
  * Project permission policies
  * @private

package/dist/types/projects/_internal/ProjectSchema.d.ts

@@ -1,7 +1,7 @@
-import { IConfigurationSchema } from "../../core";
+import { IConfigurationSchema } from "../../core/schemas/types";
 export declare type ProjectEditorType = (typeof ProjectEditorTypes)[number];
 export declare const ProjectEditorTypes: readonly ["hub:project:create", "hub:project:edit"];
 /**
- * defines the JSON schema for a Hub Project's editable fields
+ * Defines the JSON schema for a Hub Project's editable fields
  */
 export declare const ProjectSchema: IConfigurationSchema;

package/dist/types/projects/_internal/getProjectEditorConfigOptions.d.ts

@@ -0,0 +1,10 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { UiSchemaElementOptions } from "../../core/schemas/types";
+import { IHubProject } from "../../core/types/IHubProject";
+/**
+ * Construct the Project Editor configuration options
+ * @param entity
+ * @param context
+ * @returns
+ */
+export declare function getProjectEditorConfigOptions(entity: IHubProject, context: IArcGISContext): Promise<UiSchemaElementOptions[]>;

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

@@ -1,7 +1,9 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-import { IHubProject } from "../core/types";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubProject, IHubProjectEditor } from "../core/types";
+import { ProjectEditorType } from "./_internal/ProjectSchema";
 import { UiSchemaElementOptions } from "../core/schemas";
-import { EditorConfigType, IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
+import { IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
 /**
  * @private
  * Create a new Hub Project item
@@ -12,6 +14,13 @@ import { EditorConfigType, IEditorConfig } from "../core/behaviors/IWithEditorBe
  * @param requestOptions
  */
 export declare function createProject(partialProject: Partial<IHubProject>, requestOptions: IUserRequestOptions): Promise<IHubProject>;
+/**
+ * Convert a IHubProjectEditor back to an IHubProject
+ * @param editor
+ * @param portal
+ * @returns
+ */
+export declare function editorToProject(editor: IHubProjectEditor, portal: IPortal): IHubProject;
 /**
  * @private
  * Update a Hub Project
@@ -27,13 +36,9 @@ export declare function updateProject(project: IHubProject, requestOptions: IUse
  */
 export declare function deleteProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
 /**
- * DEPRECATED: the following will be removed at next breaking version
- * use the getEntityEditorSchemas function instead (which this function
- * has already been refactored to consume)
- *
  * Get the editor config for for the HubProject entity.
  * @param i18nScope translation scope to be interpolated into the uiSchema
  * @param type editor type - corresonds to the returned uiSchema
  * @param options optional hash of dynamic uiSchema element options
  */
-export declare function getHubProjectEditorConfig(i18nScope: string, type: EditorConfigType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;
+export declare function getHubProjectEditorConfig(i18nScope: string, type: ProjectEditorType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;

package/dist/types/sites/HubSites.d.ts

@@ -49,14 +49,6 @@ export declare function fetchSite(identifier: string, requestOptions: IHubReques
  * @returns
  */
 export declare function convertModelToSite(model: IModel, requestOptions: IRequestOptions): IHubSite;
-/**
- * @internal
- * Convert an IHubSite into an IModel
- * @param site
- * @param requestOptions
- * @returns
- */
-export declare function convertSiteToModel(site: IHubSite, _requestOptions: IRequestOptions): IModel;
 /**
  * Convert a Hub Site Application item into a Hub Site, fetching any
  * additional information that may be required

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

@@ -0,0 +1,5 @@
+/**
+ * artifically update a query param associated with a url to force
+ * the browser to load it from file rather than from cache
+ */
+export declare const cacheBustUrl: (url: string, param?: string) => string;

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

@@ -19,6 +19,7 @@ export * from "./getGroupHomeUrl";
 export * from "./getUserHomeUrl";
 export * from "./get-campaign-url";
 export * from "./is-safe-redirect-url";
+export * from "./cacheBustUrl";
 /**
  *
  * @param url

package/package.json

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