@esri/hub-common 13.27.1 → 13.28.0

package/dist/types/core/schemas/types.d.ts

@@ -1,5 +1,11 @@
 import { JSONSchema } from "json-schema-typed";
 import Ajv from "ajv";
+/**
+ * Defines the possible editor type values - these correspond
+ * to the supported/defined uiSchema configurations
+ */
+export declare type EditorType = (typeof validEditorTypes)[number];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit"];
 export declare enum UiSchemaRuleEffects {
     SHOW = "SHOW",
     HIDE = "HIDE",
@@ -7,6 +13,7 @@ export declare enum UiSchemaRuleEffects {
     NONE = ""
 }
 export declare enum UiSchemaElementTypes {
+    accordionItem = "AccordionItem",
     section = "Section",
     step = "Step",
     control = "Control",
@@ -15,13 +22,20 @@ export declare enum UiSchemaElementTypes {
 }
 export declare enum UiSchemaSectionTypes {
     accordion = "accordion",
-    stepper = "stepper"
+    block = "block",
+    stepper = "stepper",
+    subblock = "subblock"
+}
+export declare enum UiSchemaMessageTypes {
+    error = "ERROR",
+    success = "SUCCESS",
+    custom = "CUSTOM"
 }
 export interface IConfigurationSchema extends JSONSchema {
     type?: "object";
 }
 export interface IConfigurationValues {
-    [key: string]: unknown;
+    [key: string]: any;
 }
 export interface IChangeEventDetail {
     valid: boolean;
@@ -53,7 +67,7 @@ export interface IUiSchemaElement {
     tooltip?: string;
 }
 export interface IUiSchema extends IUiSchemaElement {
-    elements?: IUiSchema[] | IUiSchemaElement[];
+    elements?: IUiSchemaElement[];
 }
 /**
  * Run-time configuration for UiSchema Elements
@@ -65,3 +79,29 @@ export interface IUiSchemaComboboxItem {
     icon?: string;
     selected?: boolean;
 }
+export interface IUiSchemaRule {
+    effect: UiSchemaRuleEffects;
+    condition: IUiSchemaCondition;
+}
+export interface IUiSchemaCondition {
+    scope?: string;
+    schema: IConfigurationSchema;
+}
+export interface IUiSchemaMessage {
+    type: UiSchemaMessageTypes;
+    keyword?: string;
+    label?: string;
+    labelKey?: string;
+    icon?: boolean | string;
+    hidden?: boolean;
+    condition?: IUiSchemaCondition;
+    allowShowBeforeInteract?: boolean;
+}
+export interface IUiSchemaRule {
+    effect: UiSchemaRuleEffects;
+    condition: IUiSchemaCondition;
+}
+export interface IUiSchemaCondition {
+    scope?: string;
+    schema: IConfigurationSchema;
+}

package/dist/types/core/types/IHubDiscussion.d.ts

@@ -6,3 +6,10 @@ import { IHubItemEntity } from "./IHubItemEntity";
  */
 export interface IHubDiscussion extends IHubItemEntity, IWithSlug, IWithPermissions {
 }
+export declare type IHubDiscussionEditor = Omit<IHubDiscussion, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/core/types/IHubEditableContent.d.ts

@@ -5,3 +5,10 @@ import { IHubItemEntity } from "./IHubItemEntity";
  */
 export interface IHubEditableContent extends IHubItemEntity, IWithSlug, IWithPermissions {
 }
+export declare type IHubContentEditor = Omit<IHubEditableContent, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/core/types/IHubInitiative.d.ts

@@ -7,3 +7,10 @@ import { IHubItemEntity } from "./IHubItemEntity";
  */
 export interface IHubInitiative extends IHubItemEntity, IWithSlug, IWithCatalog, IWithMetrics, IWithPermissions {
 }
+export declare type IHubInitiativeEditor = Omit<IHubInitiative, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/core/types/IHubPage.d.ts

@@ -6,3 +6,10 @@ import { IWithLayout, IWithPermissions, IWithSlug } from "../traits";
  */
 export interface IHubPage extends IHubItemEntity, IWithLayout, IWithPermissions, IWithSlug {
 }
+export declare type IHubPageEditor = Omit<IHubPage, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/core/types/IHubProject.d.ts

@@ -18,6 +18,11 @@ export declare enum PROJECT_STATUSES {
  * that it can be consumed by the entity editor.
  */
 export declare type IHubProjectEditor = Omit<IHubProject, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
     view: {
         featuredImage?: any;
     };

package/dist/types/core/types/IHubSite.d.ts

@@ -67,3 +67,10 @@ export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWith
      */
     legacyCapabilities: string[];
 }
+export declare type IHubSiteEditor = Omit<IHubSite, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

package/dist/types/core/types/ISystemStatus.d.ts

@@ -8,7 +8,7 @@ export declare type SystemStatus = "online" | "offline" | "maintenance" | "not-a
 export declare type HubSystemStatus = {
     [key in HubSubsystem]: SystemStatus;
 };
-declare const validSubsystems: readonly ["content", "discussions", "events", "initiatives", "items", "metrics", "notifications", "pages", "projects", "search", "sites", "groups"];
+declare const validSubsystems: readonly ["content", "discussions", "events", "initiatives", "items", "metrics", "notifications", "pages", "projects", "search", "sites", "groups", "platform"];
 /**
  * Defines values for HubSubsystem
  */

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

@@ -1,11 +1,13 @@
 import { IWithSharingBehavior, IWithStoreBehavior } from "../core/behaviors";
 import { IArcGISContext } from "../ArcGISContext";
-import { IHubDiscussion } from "../core/types";
+import { IEntityEditorContext, IHubDiscussion, IHubDiscussionEditor } from "../core/types";
 import { HubItemEntity } from "../core/HubItemEntity";
+import { EditorType } from "../core/schemas/types";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 /**
  * Hub Discussion Class
  */
-export declare class HubDiscussion extends HubItemEntity<IHubDiscussion> implements IWithStoreBehavior<IHubDiscussion>, IWithSharingBehavior {
+export declare class HubDiscussion extends HubItemEntity<IHubDiscussion> implements IWithStoreBehavior<IHubDiscussion>, IWithSharingBehavior, IWithEditorBehavior {
     /**
      * Create an instance from an IHubDiscussion object
      * @param json JSON object to create a HubDiscussion from
@@ -41,4 +43,17 @@ export declare class HubDiscussion extends HubItemEntity<IHubDiscussion> impleme
      * @returns a promise
      */
     delete(): Promise<void>;
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the project as an editor object
+     * @param editorContext
+     * @returns
+     */
+    toEditor(editorContext?: IEntityEditorContext): IHubDiscussionEditor;
+    /**
+     * Load the project from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubDiscussionEditor): Promise<IHubDiscussion>;
 }

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

@@ -1,14 +1,16 @@
-import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IResolvedMetric, IWithCardBehavior } from "../core";
+import { EditorType } from "../core/schemas/types";
+import { IEntityEditorContext } from "../core/types/HubEntityEditor";
 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 { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IResolvedMetric, IWithCardBehavior, IWithEditorBehavior, IHubInitiativeEditor } from "../core";
 /**
  * Hub Initiative Class
  */
-export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior, IWithCardBehavior {
+export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior, IWithCardBehavior, IWithEditorBehavior {
     private _catalog;
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
@@ -85,4 +87,17 @@ export declare class HubInitiative extends HubItemEntity<IHubInitiative> impleme
      * @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): IHubInitiativeEditor;
+    /**
+     * Load the project from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubInitiativeEditor): Promise<IHubInitiative>;
 }

package/dist/types/initiatives/_internal/InitiativeSchema.d.ts

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core";
 export declare type InitiativeEditorType = (typeof InitiativeEditorTypes)[number];
-export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit"];
+export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create"];
 /**
  * defines the JSON schema for a Hub Initiative's editable fields
  */

package/dist/types/initiatives/_internal/InitiativeUiSchemaCreate.d.ts

@@ -0,0 +1,7 @@
+import { IUiSchema } from "../../core";
+/**
+ * minimal create uiSchema for Hub Projects - this defines
+ * how the schema properties should be rendered in the
+ * project creation experience
+ */
+export declare const uiSchema: IUiSchema;

package/dist/types/items/deleteItemThumbnail.d.ts

@@ -0,0 +1,9 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * Delete an item's thumbnail
+ * @param id
+ * @param owner
+ * @param requestOptions
+ * @returns
+ */
+export declare function deleteItemThumbnail(id: string, owner: string, requestOptions: IUserRequestOptions): Promise<any>;

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

@@ -23,3 +23,4 @@ export * from "./create-item-from-url-or-file";
 export * from "./uploadImageResource";
 export * from "./is-services-directory-disabled";
 export * from "./getItemIdentifier";
+export * from "./deleteItemThumbnail";

package/dist/types/pages/HubPage.d.ts

@@ -1,13 +1,14 @@
-import { IHubPage, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions } from "../core";
+import { EditorType } from "../core/schemas/types";
+import { IHubPage, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IHubPageEditor, IEntityEditorContext } from "../core";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
-import { IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 import { PageEditorType } from "./_internal/PageSchema";
 /**
  * Hub Page Class
  * NOTE: This is a minimal implementation.
  */
-export declare class HubPage extends HubItemEntity<IHubPage> implements IWithStoreBehavior<IHubPage>, IWithSharingBehavior {
+export declare class HubPage extends HubItemEntity<IHubPage> implements IWithStoreBehavior<IHubPage>, IWithSharingBehavior, IWithEditorBehavior {
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
      * more flexibility in how we create the HubPageManager over time.
@@ -56,4 +57,17 @@ export declare class HubPage extends HubItemEntity<IHubPage> implements IWithSto
      * @returns
      */
     delete(): Promise<void>;
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the project as an editor object
+     * @param editorContext
+     * @returns
+     */
+    toEditor(editorContext?: IEntityEditorContext): IHubPageEditor;
+    /**
+     * Load the project from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubPageEditor): Promise<IHubPage>;
 }

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

@@ -0,0 +1,9 @@
+import { IPermissionPolicy } from "./types/IPermissionPolicy";
+/**
+ * All the permission policies for the Hub
+ */
+export declare const PlatformPermissions: string[];
+/**
+ * Platform Permission policies which delegate to Platform Privileges
+ */
+export declare const PlatformPermissionPolicies: IPermissionPolicy[];

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

@@ -3,7 +3,7 @@
  * It's critical that the arrays defined in the modules use `as const`
  * otherwise Permission devolves into just a string type
  */
-declare const validPermissions: readonly ["hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner", "hub:project:share", "hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view", "hub:content:create", "hub:content:edit", "hub:content:view", "hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner", "hub:page:create", "hub:page:delete", "hub:page:edit", "hub:page:view"];
+declare const validPermissions: readonly ["hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner", "hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view", "hub:content:create", "hub:content:edit", "hub:content:view", "hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner", "hub:page:create", "hub:page:delete", "hub:page:edit", "hub:page:view", ...string[]];
 /**
  * Defines the possible values for Permissions
  */

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

@@ -2,4 +2,4 @@
  * Type that defines Platform Privileges
  * TODO: Ensure this is a complete list
  */
-export declare type PlatformPrivilege = "opendata:user:designateGroup" | "opendata:user:openDataAdmin" | "portal:admin:assignToGroups" | "portal:admin:categorizeItems" | "portal:admin:changeUserRoles" | "portal:admin:createGPWebhook" | "portal:admin:createUpdateCapableGroup" | "portal:admin:deleteGroups" | "portal:admin:deleteItems" | "portal:admin:deleteUsers" | "portal:admin:disableUsers" | "portal:admin:inviteUsers" | "portal:admin:manageCollaborations" | "portal:admin:manageCredits" | "portal:admin:manageEnterpriseGroups" | "portal:admin:manageLicenses" | "portal:admin:manageRoles" | "portal:admin:manageSecurity" | "portal:admin:manageServers" | "portal:admin:manageUtilityServices" | "portal:admin:manageWebhooks" | "portal:admin:manageWebsite" | "portal:admin:reassignGroups" | "portal:admin:reassignItems" | "portal:admin:reassignUsers" | "portal:admin:shareToGroup" | "portal:admin:shareToOrg" | "portal:admin:shareToPublic" | "portal:admin:updateGroups" | "portal:admin:updateItemCategorySchema" | "portal:admin:updateItems" | "portal:admin:updateMemberCategorySchema" | "portal:admin:updateUsers" | "portal:admin:viewGroups" | "portal:admin:viewItems" | "portal:admin:viewUsers" | "portal:publisher:bulkPublishFromDataStores" | "portal:publisher:createFeatureWebhook" | "portal:publisher:publishBigDataAnalytics" | "portal:publisher:publishDynamicImagery" | "portal:publisher:publishFeatures" | "portal:publisher:publishFeeds" | "portal:publisher:publishKnowledgeGraph" | "portal:publisher:publishRealTimeAnalytics" | "portal:publisher:publishScenes" | "portal:publisher:publishServerGPServices" | "portal:publisher:publishServerServices" | "portal:publisher:publishTiledImagery" | "portal:publisher:publishTiles" | "portal:publisher:registerDataStores" | "portal:user:addExternalMembersToGroup" | "portal:user:categorizeItems" | "portal:user:createGroup" | "portal:user:createItem" | "portal:user:invitePartneredCollaborationMembers" | "portal:user:joinGroup" | "portal:user:joinNonOrgGroup" | "portal:user:reassignItems" | "portal:user:receiveItems" | "portal:user:runWebTool" | "portal:user:shareGroupToOrg" | "portal:user:shareGroupToPublic" | "portal:user:shareToGroup" | "portal:user:shareToOrg" | "portal:user:shareToPublic" | "portal:user:viewHostedFeatureServices" | "portal:user:viewHostedTileServices" | "portal:user:viewOrgGroups" | "portal:user:viewOrgItems" | "portal:user:viewOrgUsers" | "portal:user:viewTracks";
+export declare type PlatformPrivilege = "features:user:edit" | "features:user:fullEdit" | "features:user:manageVersions" | "marketplace:admin:manage" | "marketplace:admin:purchase" | "marketplace:admin:startTrial" | "opendata:user:designateGroup" | "opendata:user:openDataAdmin" | "portal:admin:assignToGroups" | "portal:admin:categorizeItems" | "portal:admin:changeUserRoles" | "portal:admin:createGPWebhook" | "portal:admin:createUpdateCapableGroup" | "portal:admin:deleteGroups" | "portal:admin:deleteItems" | "portal:admin:deleteUsers" | "portal:admin:disableUsers" | "portal:admin:inviteUsers" | "portal:admin:manageCollaborations" | "portal:admin:manageCredits" | "portal:admin:manageEnterpriseGroups" | "portal:admin:manageLicenses" | "portal:admin:manageRoles" | "portal:admin:manageSecurity" | "portal:admin:manageServers" | "portal:admin:manageUtilityServices" | "portal:admin:manageWebhooks" | "portal:admin:manageWebsite" | "portal:admin:reassignGroups" | "portal:admin:reassignItems" | "portal:admin:reassignUsers" | "portal:admin:shareToGroup" | "portal:admin:shareToOrg" | "portal:admin:shareToPublic" | "portal:admin:updateGroups" | "portal:admin:updateItemCategorySchema" | "portal:admin:updateItems" | "portal:admin:updateMemberCategorySchema" | "portal:admin:updateUsers" | "portal:admin:viewGroups" | "portal:admin:viewItems" | "portal:admin:viewUsers" | "portal:publisher:bulkPublishFromDataStores" | "portal:publisher:createDataPipelines" | "portal:publisher:createFeatureWebhook" | "portal:publisher:publishBigDataAnalytics" | "portal:publisher:publishDynamicImagery" | "portal:publisher:publishFeatures" | "portal:publisher:publishFeeds" | "portal:publisher:publishKnowledgeGraph" | "portal:publisher:publishRealTimeAnalytics" | "portal:publisher:publishScenes" | "portal:publisher:publishServerGPServices" | "portal:publisher:publishServerServices" | "portal:publisher:publishTiledImagery" | "portal:publisher:publishTiles" | "portal:publisher:registerDataStores" | "portal:user:addExternalMembersToGroup" | "portal:user:categorizeItems" | "portal:user:createGroup" | "portal:user:createItem" | "portal:user:invitePartneredCollaborationMembers" | "portal:user:joinGroup" | "portal:user:joinNonOrgGroup" | "portal:user:reassignItems" | "portal:user:receiveItems" | "portal:user:runWebTool" | "portal:user:shareGroupToOrg" | "portal:user:shareGroupToPublic" | "portal:user:shareToGroup" | "portal:user:shareToOrg" | "portal:user:shareToPublic" | "portal:user:viewHostedFeatureServices" | "portal:user:viewHostedTileServices" | "portal:user:viewOrgGroups" | "portal:user:viewOrgItems" | "portal:user:viewOrgUsers" | "portal:user:viewTracks" | "premium:publisher:createAdvancedNotebooks" | "premium:publisher:createNotebooks" | "premium:publisher:geoanalytics" | "premium:publisher:rasteranalysis" | "premium:publisher:scheduleNotebooks" | "premium:user:demographics" | "premium:user:elevation" | "premium:user:featurereport" | "premium:user:geocode:stored" | "premium:user:geocode:temporary" | "premium:user:geocode" | "premium:user:geoenrichment" | "premium:user:networkanalysis:closestfacility" | "premium:user:networkanalysis:locationallocation" | "premium:user:networkanalysis:optimizedrouting" | "premium:user:networkanalysis:origindestinationcostmatrix" | "premium:user:networkanalysis:routing" | "premium:user:networkanalysis:servicearea" | "premium:user:networkanalysis:vehiclerouting" | "premium:user:networkanalysis" | "premium:user:places" | "premium:user:spatialanalysis";

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

@@ -1,5 +1,5 @@
 import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, IResolvedMetric, IWithCardBehavior, IHubProjectEditor, IEntityEditorContext } from "../core";
-import { EditorType } from "../core/schemas/getEntityEditorSchemas";
+import { EditorType } from "../core/schemas/types";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";

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", "hub:project:share"];
+export declare const ProjectPermissions: readonly ["hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner"];
 /**
  * Project permission policies
  * @private

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

@@ -2,13 +2,17 @@ import { IHubSite, IWithPermissionBehavior, IWithCatalogBehavior, IWithStoreBeha
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
+import { EditorType } from "../core/schemas/types";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { IEntityEditorContext } from "../core/types/HubEntityEditor";
 import { IContainsResponse, IDeepCatalogInfo } from "../search";
 import { ICreateVersionOptions, IVersion, IVersionMetadata } from "../versioning";
+import { IHubSiteEditor } from "../index";
 /**
  * Hub Site Class
  * NOTE: This is a minimal implementation. Create operations are not supported at this time
  */
-export declare class HubSite extends HubItemEntity<IHubSite> implements IWithStoreBehavior<IHubSite>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior, IWithVersioningBehavior {
+export declare class HubSite extends HubItemEntity<IHubSite> implements IWithStoreBehavior<IHubSite>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior, IWithVersioningBehavior, IWithEditorBehavior {
     private _catalog;
     private _catalogCache;
     /**
@@ -131,4 +135,17 @@ export declare class HubSite extends HubItemEntity<IHubSite> implements IWithSto
     deleteVersion(versionId: string): Promise<{
         success: boolean;
     }>;
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the project as an editor object
+     * @param editorContext
+     * @returns
+     */
+    toEditor(editorContext?: IEntityEditorContext): IHubSiteEditor;
+    /**
+     * Load the project from the editor object
+     * @param editor
+     * @returns
+     */
+    fromEditor(editor: IHubSiteEditor): Promise<IHubSite>;
 }

package/package.json

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

package/dist/esm/projects/_internal/getProjectEditorConfigOptions.js

@@ -1,63 +0,0 @@
-import { getCategoryItems } from "../../core/schemas/internal/getCategoryItems";
-import { getFeaturedContentCatalogs } from "../../core/schemas/internal/getFeaturedContentCatalogs";
-import { getFeaturedImageUrl } from "../../core/schemas/internal/getFeaturedImageUrl";
-import { getLocationExtent } from "../../core/schemas/internal/getLocationExtent";
-import { getLocationOptions } from "../../core/schemas/internal/getLocationOptions";
-import { getTagItems } from "../../core/schemas/internal/getTagItems";
-import { getSharableGroupsComboBoxItems } from "../../core/schemas/internal/getSharableGroupsComboBoxItems";
-import { checkPermission } from "../../permissions/checkPermission";
-/**
- * Construct the Project Editor configuration options
- * @param entity
- * @param context
- * @returns
- */
-export async function getProjectEditorConfigOptions(entity, context) {
-    var _a;
-    const canShare = checkPermission("hub:project:share", context);
-    return [
-        {
-            scope: "/properties/access",
-            options: {
-                orgName: context.portal.name,
-            },
-        },
-        {
-            scope: "/properties/location",
-            options: {
-                extent: await getLocationExtent(entity, context.hubRequestOptions),
-                options: await getLocationOptions(entity, context.portal.name, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/tags",
-            options: {
-                items: await getTagItems(entity, context.portal.id, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/categories",
-            options: {
-                items: await getCategoryItems(context.portal.id, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/view/properties/featuredImage",
-            options: {
-                imgSrc: ((_a = entity.view) === null || _a === void 0 ? void 0 : _a.featuredImageUrl) && getFeaturedImageUrl(entity, context),
-            },
-        },
-        {
-            scope: "/properties/view/properties/featuredContentIds",
-            options: getFeaturedContentCatalogs(context.currentUser),
-        },
-        {
-            scope: "/properties/_groups",
-            options: {
-                items: getSharableGroupsComboBoxItems(context.currentUser.groups),
-                disabled: !canShare,
-            },
-        },
-    ];
-}
-//# sourceMappingURL=getProjectEditorConfigOptions.js.map

package/dist/esm/projects/_internal/getProjectEditorConfigOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getProjectEditorConfigOptions.js","sourceRoot":"","sources":["../../../../src/projects/_internal/getProjectEditorConfigOptions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,wDAAwD,CAAC;AACpG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,4DAA4D,CAAC;AAG5G,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,MAAmB,EACnB,OAAuB;;IAEvB,MAAM,QAAQ,GAAG,eAAe,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAE/D,OAAO;QACL;YACE,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE;gBACP,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;aAC7B;SACF;QACD;YACE,KAAK,EAAE,sBAAsB;YAC7B,OAAO,EAAE;gBACP,MAAM,EAAE,MAAM,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC;gBAClE,OAAO,EAAE,MAAM,kBAAkB,CAC/B,MAAM,EACN,OAAO,CAAC,MAAM,CAAC,IAAI,EACnB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,kBAAkB;YACzB,OAAO,EAAE;gBACP,KAAK,EAAE,MAAM,WAAW,CACtB,MAAM,EACN,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,wBAAwB;YAC/B,OAAO,EAAE;gBACP,KAAK,EAAE,MAAM,gBAAgB,CAC3B,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,2CAA2C;YAClD,OAAO,EAAE;gBACP,MAAM,EACJ,OAAA,MAAM,CAAC,IAAI,0CAAE,gBAAgB,KAAI,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;aACxE;SACF;QACD;YACE,KAAK,EAAE,gDAAgD;YACvD,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,WAAW,CAAC;SACzD;QACD;YACE,KAAK,EAAE,qBAAqB;YAC5B,OAAO,EAAE;gBACP,KAAK,EAAE,8BAA8B,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;gBACjE,QAAQ,EAAE,CAAC,QAAQ;aACpB;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/node/projects/_internal/getProjectEditorConfigOptions.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectEditorConfigOptions = void 0;
-const getCategoryItems_1 = require("../../core/schemas/internal/getCategoryItems");
-const getFeaturedContentCatalogs_1 = require("../../core/schemas/internal/getFeaturedContentCatalogs");
-const getFeaturedImageUrl_1 = require("../../core/schemas/internal/getFeaturedImageUrl");
-const getLocationExtent_1 = require("../../core/schemas/internal/getLocationExtent");
-const getLocationOptions_1 = require("../../core/schemas/internal/getLocationOptions");
-const getTagItems_1 = require("../../core/schemas/internal/getTagItems");
-const getSharableGroupsComboBoxItems_1 = require("../../core/schemas/internal/getSharableGroupsComboBoxItems");
-const checkPermission_1 = require("../../permissions/checkPermission");
-/**
- * Construct the Project Editor configuration options
- * @param entity
- * @param context
- * @returns
- */
-async function getProjectEditorConfigOptions(entity, context) {
-    var _a;
-    const canShare = checkPermission_1.checkPermission("hub:project:share", context);
-    return [
-        {
-            scope: "/properties/access",
-            options: {
-                orgName: context.portal.name,
-            },
-        },
-        {
-            scope: "/properties/location",
-            options: {
-                extent: await getLocationExtent_1.getLocationExtent(entity, context.hubRequestOptions),
-                options: await getLocationOptions_1.getLocationOptions(entity, context.portal.name, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/tags",
-            options: {
-                items: await getTagItems_1.getTagItems(entity, context.portal.id, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/categories",
-            options: {
-                items: await getCategoryItems_1.getCategoryItems(context.portal.id, context.hubRequestOptions),
-            },
-        },
-        {
-            scope: "/properties/view/properties/featuredImage",
-            options: {
-                imgSrc: ((_a = entity.view) === null || _a === void 0 ? void 0 : _a.featuredImageUrl) && getFeaturedImageUrl_1.getFeaturedImageUrl(entity, context),
-            },
-        },
-        {
-            scope: "/properties/view/properties/featuredContentIds",
-            options: getFeaturedContentCatalogs_1.getFeaturedContentCatalogs(context.currentUser),
-        },
-        {
-            scope: "/properties/_groups",
-            options: {
-                items: getSharableGroupsComboBoxItems_1.getSharableGroupsComboBoxItems(context.currentUser.groups),
-                disabled: !canShare,
-            },
-        },
-    ];
-}
-exports.getProjectEditorConfigOptions = getProjectEditorConfigOptions;
-//# sourceMappingURL=getProjectEditorConfigOptions.js.map

package/dist/node/projects/_internal/getProjectEditorConfigOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getProjectEditorConfigOptions.js","sourceRoot":"","sources":["../../../../src/projects/_internal/getProjectEditorConfigOptions.ts"],"names":[],"mappings":";;;AAEA,mFAAgF;AAChF,uGAAoG;AACpG,yFAAsF;AACtF,qFAAkF;AAClF,uFAAoF;AACpF,yEAAsE;AACtE,+GAA4G;AAG5G,uEAAoE;AAEpE;;;;;GAKG;AACI,KAAK,UAAU,6BAA6B,CACjD,MAAmB,EACnB,OAAuB;;IAEvB,MAAM,QAAQ,GAAG,iCAAe,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAE/D,OAAO;QACL;YACE,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE;gBACP,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;aAC7B;SACF;QACD;YACE,KAAK,EAAE,sBAAsB;YAC7B,OAAO,EAAE;gBACP,MAAM,EAAE,MAAM,qCAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC;gBAClE,OAAO,EAAE,MAAM,uCAAkB,CAC/B,MAAM,EACN,OAAO,CAAC,MAAM,CAAC,IAAI,EACnB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,kBAAkB;YACzB,OAAO,EAAE;gBACP,KAAK,EAAE,MAAM,yBAAW,CACtB,MAAM,EACN,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,wBAAwB;YAC/B,OAAO,EAAE;gBACP,KAAK,EAAE,MAAM,mCAAgB,CAC3B,OAAO,CAAC,MAAM,CAAC,EAAE,EACjB,OAAO,CAAC,iBAAiB,CAC1B;aACF;SACF;QACD;YACE,KAAK,EAAE,2CAA2C;YAClD,OAAO,EAAE;gBACP,MAAM,EACJ,OAAA,MAAM,CAAC,IAAI,0CAAE,gBAAgB,KAAI,yCAAmB,CAAC,MAAM,EAAE,OAAO,CAAC;aACxE;SACF;QACD;YACE,KAAK,EAAE,gDAAgD;YACvD,OAAO,EAAE,uDAA0B,CAAC,OAAO,CAAC,WAAW,CAAC;SACzD;QACD;YACE,KAAK,EAAE,qBAAqB;YAC5B,OAAO,EAAE;gBACP,KAAK,EAAE,+DAA8B,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;gBACjE,QAAQ,EAAE,CAAC,QAAQ;aACpB;SACF;KACF,CAAC;AACJ,CAAC;AA9DD,sEA8DC"}

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

@@ -1,10 +0,0 @@
-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[]>;