@esri/hub-common 13.18.0 → 13.20.0

package/dist/types/capabilities/checkCapability.d.ts

@@ -1,5 +1,5 @@
 import { Capability, ICapabilityAccessResponse } from "./types";
-import { IArcGISContext, HubEntity } from "../index";
+import { IArcGISContext, HubEntity, IHubItemEntity } from "../index";
 /**
  * Check if a capability is enabled for a given entity and if the current user has necessary permissions to access it
  * @param capability
@@ -7,4 +7,4 @@ import { IArcGISContext, HubEntity } from "../index";
  * @param entity
  * @returns
  */
-export declare function checkCapability(capability: Capability, context: IArcGISContext, entity: HubEntity): ICapabilityAccessResponse;
+export declare function checkCapability(capability: Capability, context: IArcGISContext, entity: IHubItemEntity | HubEntity): ICapabilityAccessResponse;

package/dist/types/capabilities/types.d.ts

@@ -3,7 +3,7 @@ import { IAccessResponse } from "../core/types/IAccessResponse";
 /**
  * Hub System Capabilities
  */
-declare const validCapabilities: readonly ["collaboration", "details", "discussions", "events", "followers", "overview", "settings", "teams", "metrics"];
+declare const validCapabilities: readonly ["collaboration", "details", "discussions", "events", "followers", "overview", "settings", "teams", "metrics", "content"];
 /**
  * Defines the possible values for Capability
  */

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

@@ -1,7 +1,7 @@
-import { HubEntity, HubEntityType } from "./types";
+import { HubEntity, IHubItemEntity, HubEntityType } from "./types";
 /**
  * Given a HubEntity, return it's HubEntityType
  * @param entity
  * @returns
  */
-export declare function getTypeFromEntity(entity: HubEntity): HubEntityType;
+export declare function getTypeFromEntity(entity: IHubItemEntity | HubEntity): HubEntityType;

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

@@ -5,7 +5,7 @@ import { UiSchemaElementOptions } from "./types";
  * 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:initiative:edit", "hub:site:edit", "hub:discussion:edit", "hub:discussion:create"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:initiative:edit", "hub:site:edit", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit"];
 /**
  * get the editor schema and uiSchema defined for an entity.
  * The schema and uiSchema that are returned can be used to

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

@@ -1,8 +1,8 @@
-import { IWithLayout } from "../traits/IWithLayout";
 import { IHubItemEntity } from "./IHubItemEntity";
+import { IWithLayout, IWithPermissions, IWithSlug } from "../traits";
 /**
  * DRAFT: Under development and more properties will likely be added
  * @internal
  */
-export interface IHubPage extends IHubItemEntity, IWithLayout {
+export interface IHubPage extends IHubItemEntity, IWithLayout, IWithPermissions, IWithSlug {
 }

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

@@ -0,0 +1,59 @@
+import { IHubPage, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions } from "../core";
+import { IArcGISContext } from "../ArcGISContext";
+import { HubItemEntity } from "../core/HubItemEntity";
+import { IEditorConfig } 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 {
+    /**
+     * Private constructor so we don't have `new` all over the place. Allows for
+     * more flexibility in how we create the HubPageManager over time.
+     * @param context
+     */
+    private constructor();
+    /**
+     * Create an instance from an IHubPage object
+     * @param json - JSON object to create a HubPage from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json: Partial<IHubPage>, context: IArcGISContext): HubPage;
+    /**
+     *
+     * Create a new HubPage, returning a HubPage instance.
+     * By default, this does not save the page to the backing store.
+     * @param partialPage
+     * @param context
+     * @returns
+     */
+    static create(partialPage: Partial<IHubPage>, context: IArcGISContext, save?: boolean): Promise<HubPage>;
+    /**
+     * Fetch a Page from the backing store and return a HubPage instance.
+     * @param identifier - Identifier of the page to load
+     * @param context
+     * @returns
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubPage>;
+    static getEditorConfig(i18nScope: string, type: PageEditorType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;
+    private static applyDefaults;
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes: Partial<IHubPage>): void;
+    /**
+     * Save the HubPage to the backing store.
+     * Currently Pages are stored as Items in Portal
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubPage from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    delete(): Promise<void>;
+}

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

@@ -1,6 +1,49 @@
-import { IItem } from "@esri/arcgis-rest-types";
 import { IHubSearchResult } from "../search";
 import { IHubRequestOptions } from "../types";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubPage } from "../core";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+/**
+ * @private
+ * Create a new Hub Page item
+ *
+ * Minimal properties are name and org
+ *
+ * @param partialPage
+ * @param requestOptions
+ */
+export declare function createPage(partialPage: Partial<IHubPage>, requestOptions: IUserRequestOptions): Promise<IHubPage>;
+/**
+ * @private
+ * Update a Hub Page
+ * @param page
+ * @param requestOptions
+ */
+export declare function updatePage(page: IHubPage, requestOptions: IUserRequestOptions): Promise<IHubPage>;
+/**
+ * @private
+ * Get a Hub Page by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions
+ */
+export declare function fetchPage(identifier: string, requestOptions: IRequestOptions): Promise<IHubPage>;
+/**
+ * @private
+ * Convert an Hub Page Item into a Hub Page, fetching any additional
+ * information that may be required
+ * @param item
+ * @param auth
+ * @returns
+ */
+export declare function convertItemToPage(item: IItem, requestOptions: IRequestOptions): Promise<IHubPage>;
+/**
+ * @private
+ * Remove a Hub Page
+ * @param id
+ * @param requestOptions
+ */
+export declare function deletePage(id: string, requestOptions: IUserRequestOptions): Promise<void>;
 /**
  * Fetch Page specific Enrichments
  * @param item

package/dist/types/pages/_internal/PageBusinessRules.d.ts

@@ -1,3 +1,30 @@
+import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
+import { IPermissionPolicy } from "../../permissions";
+/**
+ * Default capabilities for a Page. If not listed here, the capability will not be available
+ * This hash is combined with the capabilities hash stored in the item data. Regardless of what
+ * properties are defined in the item data, only the capabilities defined here will be available
+ * @private
+ */
+export declare const PageDefaultCapabilities: EntityCapabilities;
+/**
+ * List of all the Page Capability Permissions
+ * These are considered Hub Business Rules and are not intended
+ * to be modified by consumers
+ * @private
+ */
+export declare const PageCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Page Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const PagePermissions: readonly ["hub:page:create", "hub:page:delete", "hub:page:edit", "hub:page:view"];
+/**
+ * Page permission policies
+ * @private
+ */
+export declare const PagePermissionPolicies: IPermissionPolicy[];
 /**
  * Page versioning include list
  */

package/dist/types/pages/_internal/PageSchema.d.ts

@@ -0,0 +1,7 @@
+import { IConfigurationSchema } from "../../core";
+export declare const PageEditorTypes: readonly ["hub:page:edit"];
+export declare type PageEditorType = (typeof PageEditorTypes)[number];
+/**
+ * defines the JSON schema for a Hub Site's editable fields
+ */
+export declare const PageSchema: IConfigurationSchema;

package/dist/types/pages/_internal/PageUiSchemaEdit.d.ts

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

package/dist/types/pages/_internal/computeProps.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubPage } from "../../core";
+import { IModel } from "../../types";
+/**
+ * Given a model and a page, set various computed properties that can't be directly mapped
+ * @private
+ * @param model
+ * @param page
+ * @param requestOptions
+ * @returns
+ */
+export declare function computeProps(model: IModel, page: Partial<IHubPage>, requestOptions: IRequestOptions): IHubPage;

package/dist/types/pages/_internal/getPropertyMap.d.ts

@@ -0,0 +1,8 @@
+import { IPropertyMap } from "../../core/_internal/PropertyMapper";
+/**
+ * Returns an Array of IPropertyMap objects
+ * that define the projection of properties from a IModel to an IHubPage
+ * @returns
+ * @private
+ */
+export declare function getPropertyMap(): IPropertyMap[];

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

@@ -0,0 +1,13 @@
+import { IHubPage } from "../core";
+import { IModel } from "../types";
+export declare const HUB_PAGE_ITEM_TYPE = "Hub Page";
+export declare const ENTERPRISE_PAGE_ITEM_TYPE = "Site Page";
+export declare const PAGE_TYPE_KEYWORD = "hubPage";
+/**
+ * Default values of a IHubPage
+ */
+export declare const DEFAULT_PAGE: Partial<IHubPage>;
+/**
+ * Default values for a new HubPage Model
+ */
+export declare const DEFAULT_PAGE_MODEL: IModel;

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

@@ -1 +1,2 @@
 export * from "./HubPages";
+export * from "./HubPage";

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: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"];
+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:page:create", "hub:page:delete", "hub:page:edit", "hub:page:view"];
 /**
  * Defines the possible values for Permissions
  */

package/dist/types/search/types/IHubCatalog.d.ts

@@ -50,6 +50,16 @@ export interface IHubCollection {
      */
     targetEntity: EntityType;
 }
+/**
+ * @private
+ *
+ * This interface wraps IHubCollection and provides additional fields
+ * for collection configuration. It is the actual interface used when
+ * when storing an entity's catalog collections.
+ */
+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

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

@@ -56,7 +56,7 @@ export declare function convertModelToSite(model: IModel, requestOptions: IReque
  * @param requestOptions
  * @returns
  */
-export declare function convertSiteToModel(site: IHubSite, requestOptions: IRequestOptions): IModel;
+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/sites/_internal/applyCatalogStructureMigration.d.ts

@@ -0,0 +1,11 @@
+import { IModel } from "../../types";
+/**
+ * Add the default catalog structure to the Site model
+ * Note: This in-memory migration is only applies via `fetchSite(..):IHubSite` and not
+ * the older `getSiteById(...):IModel`. Changes made in this migration will not be
+ * persisted to AGO until all other parts of the application stop relying on the legacy
+ * catalog implementation
+ * @param model
+ * @returns
+ */
+export declare function applyCatalogStructureMigration(model: IModel): IModel;

package/dist/types/sites/_internal/applyDefaultCollectionMigration.d.ts

@@ -0,0 +1,21 @@
+import { IModel } from "../../types";
+/**
+ * In-Memory migration that adds default collections to site models that have the
+ * new catalog structure. These default collections will have the same names and
+ * display order found in `site.data.values.searchCategories`
+ *
+ * This migration simplifies display logic, as consuming components no longer
+ * have to merge `catalog.collections` with the default collection definitions.
+ *
+ * This migration also lays the foundation for customization, since editors will
+ * be able to modify these persisted default objects. For example, editors can
+ * change the default labels, display order, or mark a default as "hidden" so the
+ * public can't see it.
+ *
+ * NOTE: The changes made in this migration will not be persisted to AGO at this time
+ *
+ * @param model site model to migrate
+ * @returns a migrated model with default `IHubCollectionPersistance` objects added
+ * to the catalog
+ */
+export declare function applyDefaultCollectionMigration(model: IModel): IModel;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "13.18.0",
+  "version": "13.20.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/sites/_internal/catalogMigration.js

@@ -1,50 +0,0 @@
-import { getProp } from "../../objects/get-prop";
-/**
- * Add the default catalog and collections to the Site model
- * Note: This migration is only applies via `fetchSite(..):IHubSite` and not
- * the older `getSiteById(...):IModel`
- * @param model
- * @returns
- */
-export function catalogMigration(model) {
-    if (getProp(model, "item.properties.schemaVersion") >= 1.7) {
-        return model;
-    }
-    else {
-        let siteCatalog = model.data.catalog || {};
-        if (!siteCatalog.hasOwnProperty("schemaVersion")) {
-            const groups = siteCatalog.groups || [];
-            siteCatalog = {
-                schemaVersion: 1,
-                title: "Default Site Catalog",
-                scopes: {
-                    item: {
-                        targetEntity: "item",
-                        filters: [],
-                    },
-                },
-                collections: [],
-            };
-            // groups are used to set the item scope for the whole catalog
-            siteCatalog.scopes.item.filters.push({
-                predicates: [
-                    {
-                        group: [...groups],
-                    },
-                ],
-            });
-            // in order to not break existing code, we need store the
-            // new catalog on `data.catalogv2` and leave old catalog on `data.catalog`
-            // The property mapper will expose this as `catalog` on the IHubSite
-            // and re-map it back to `data.catalogv2` when saving
-            // This is only done if the data.catalog does not have `schemaVersion`
-            // property. At some point we will deprecate the old catalog
-            // remove the mappings, and save the catalog directly to `data.catalog`
-            model.data.catalogv2 = siteCatalog;
-        }
-        // set the schema version
-        model.item.properties.schemaVersion = 1.7;
-        return model;
-    }
-}
-//# sourceMappingURL=catalogMigration.js.map

package/dist/esm/sites/_internal/catalogMigration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"catalogMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/catalogMigration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAIjD;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,IAAI,OAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,GAAG,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;SAAM;QACL,IAAI,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YAChD,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,IAAI,EAAE,CAAC;YACxC,WAAW,GAAG;gBACZ,aAAa,EAAE,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,MAAM,EAAE;oBACN,IAAI,EAAE;wBACJ,YAAY,EAAE,MAAM;wBACpB,OAAO,EAAE,EAAE;qBACZ;iBACF;gBACD,WAAW,EAAE,EAAE;aACD,CAAC;YAEjB,8DAA8D;YAC9D,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBACnC,UAAU,EAAE;oBACV;wBACE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;qBACnB;iBACF;aACF,CAAC,CAAC;YACH,yDAAyD;YACzD,0EAA0E;YAC1E,oEAAoE;YACpE,qDAAqD;YACrD,sEAAsE;YACtE,4DAA4D;YAC5D,uEAAuE;YACvE,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC;SACpC;QACD,yBAAyB;QACzB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;QAE1C,OAAO,KAAK,CAAC;KACd;AACH,CAAC"}

package/dist/node/sites/_internal/catalogMigration.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.catalogMigration = void 0;
-const get_prop_1 = require("../../objects/get-prop");
-/**
- * Add the default catalog and collections to the Site model
- * Note: This migration is only applies via `fetchSite(..):IHubSite` and not
- * the older `getSiteById(...):IModel`
- * @param model
- * @returns
- */
-function catalogMigration(model) {
-    if (get_prop_1.getProp(model, "item.properties.schemaVersion") >= 1.7) {
-        return model;
-    }
-    else {
-        let siteCatalog = model.data.catalog || {};
-        if (!siteCatalog.hasOwnProperty("schemaVersion")) {
-            const groups = siteCatalog.groups || [];
-            siteCatalog = {
-                schemaVersion: 1,
-                title: "Default Site Catalog",
-                scopes: {
-                    item: {
-                        targetEntity: "item",
-                        filters: [],
-                    },
-                },
-                collections: [],
-            };
-            // groups are used to set the item scope for the whole catalog
-            siteCatalog.scopes.item.filters.push({
-                predicates: [
-                    {
-                        group: [...groups],
-                    },
-                ],
-            });
-            // in order to not break existing code, we need store the
-            // new catalog on `data.catalogv2` and leave old catalog on `data.catalog`
-            // The property mapper will expose this as `catalog` on the IHubSite
-            // and re-map it back to `data.catalogv2` when saving
-            // This is only done if the data.catalog does not have `schemaVersion`
-            // property. At some point we will deprecate the old catalog
-            // remove the mappings, and save the catalog directly to `data.catalog`
-            model.data.catalogv2 = siteCatalog;
-        }
-        // set the schema version
-        model.item.properties.schemaVersion = 1.7;
-        return model;
-    }
-}
-exports.catalogMigration = catalogMigration;
-//# sourceMappingURL=catalogMigration.js.map

package/dist/node/sites/_internal/catalogMigration.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"catalogMigration.js","sourceRoot":"","sources":["../../../../src/sites/_internal/catalogMigration.ts"],"names":[],"mappings":";;;AAAA,qDAAiD;AAIjD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,KAAa;IAC5C,IAAI,kBAAO,CAAC,KAAK,EAAE,+BAA+B,CAAC,IAAI,GAAG,EAAE;QAC1D,OAAO,KAAK,CAAC;KACd;SAAM;QACL,IAAI,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YAChD,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,IAAI,EAAE,CAAC;YACxC,WAAW,GAAG;gBACZ,aAAa,EAAE,CAAC;gBAChB,KAAK,EAAE,sBAAsB;gBAC7B,MAAM,EAAE;oBACN,IAAI,EAAE;wBACJ,YAAY,EAAE,MAAM;wBACpB,OAAO,EAAE,EAAE;qBACZ;iBACF;gBACD,WAAW,EAAE,EAAE;aACD,CAAC;YAEjB,8DAA8D;YAC9D,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;gBACnC,UAAU,EAAE;oBACV;wBACE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;qBACnB;iBACF;aACF,CAAC,CAAC;YACH,yDAAyD;YACzD,0EAA0E;YAC1E,oEAAoE;YACpE,qDAAqD;YACrD,sEAAsE;YACtE,4DAA4D;YAC5D,uEAAuE;YACvE,KAAK,CAAC,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC;SACpC;QACD,yBAAyB;QACzB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC;QAE1C,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAzCD,4CAyCC"}

package/dist/types/sites/_internal/catalogMigration.d.ts

@@ -1,9 +0,0 @@
-import { IModel } from "../../types";
-/**
- * Add the default catalog and collections to the Site model
- * Note: This migration is only applies via `fetchSite(..):IHubSite` and not
- * the older `getSiteById(...):IModel`
- * @param model
- * @returns
- */
-export declare function catalogMigration(model: IModel): IModel;