@esri/hub-common 14.14.0 → 14.15.0

package/dist/types/content/_internal/internalContentUtils.d.ts

@@ -112,6 +112,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     };
     features?: import("../..").IFeatureFlags;
     isDiscussable?: boolean;
+    followersGroupId?: string;
     statistics?: any;
     data?: {
         [propName: string]: any;

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

@@ -5,10 +5,11 @@ import { IWithSharingBehavior, IWithStoreBehavior, IWithFeaturedImageBehavior, I
 import { IWithThumbnailBehavior } from "./behaviors/IWithThumbnailBehavior";
 import { IHubItemEntity, SettableAccessLevel } from "./types";
 import { IWithDiscussionsBehavior } from "./behaviors/IWithDiscussionsBehavior";
+import { IWithFollowersBehavior } from "./behaviors/IWithFollowersBehavior";
 /**
  * Base class for all Hub Entities backed by items
  */
-export declare abstract class HubItemEntity<T extends IHubItemEntity> implements IWithStoreBehavior<T>, IWithSharingBehavior, IWithThumbnailBehavior, IWithFeaturedImageBehavior, IWithPermissionBehavior, IWithDiscussionsBehavior {
+export declare abstract class HubItemEntity<T extends IHubItemEntity> implements IWithStoreBehavior<T>, IWithSharingBehavior, IWithThumbnailBehavior, IWithFeaturedImageBehavior, IWithPermissionBehavior, IWithDiscussionsBehavior, IWithFollowersBehavior {
     protected context: IArcGISContext;
     protected entity: T;
     protected isDestroyed: boolean;
@@ -92,6 +93,15 @@ export declare abstract class HubItemEntity<T extends IHubItemEntity> implements
      * @param access
      */
     setAccess(access: SettableAccessLevel): Promise<void>;
+    /**
+     * Returns the followers group
+     */
+    getFollowersGroup(): Promise<IGroup>;
+    /**
+     * Sets the access level of the followers group
+     * @param access
+     */
+    setFollowersGroupAccess(access: SettableAccessLevel): Promise<void>;
     /**
      * Return a list of groups the Entity is shared to.
      * @returns

package/dist/types/core/behaviors/IWithFollowersBehavior.d.ts

@@ -0,0 +1,15 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+import { SettableAccessLevel } from "../types";
+/**
+ * Followers behavior for Item-Backed Entities
+ */
+export interface IWithFollowersBehavior {
+    /**
+     * Get the followers group
+     */
+    getFollowersGroup(): Promise<IGroup>;
+    /**
+     * Set the access level of the followers group
+     */
+    setFollowersGroupAccess(access: SettableAccessLevel): Promise<void>;
+}

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

@@ -5,7 +5,7 @@ import Ajv from "ajv";
  * 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:content:settings", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit", "hub:group:edit", "hub:group:settings"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:content:settings", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:discussion:edit", "hub:discussion:create", "hub:page:edit", "hub:group:edit", "hub:group:settings"];
 export declare enum UiSchemaRuleEffects {
     SHOW = "SHOW",
     HIDE = "HIDE",

package/dist/types/core/traits/IWithFollowers.d.ts

@@ -3,5 +3,5 @@
  */
 export interface IWithFollowers {
     /** followers group id */
-    followersGroupId: string;
+    followersGroupId?: string;
 }

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

@@ -3,10 +3,11 @@ import { IHubGeography } from "../../types";
 import { AccessLevel } from "./types";
 import { IWithPermissions, IWithViewSettings, IWithDiscussions } from "../traits";
 import { IHubLocation } from "./IHubLocation";
+import { IWithFollowers } from "../traits/IWithFollowers";
 /**
  * Properties exposed by Entities that are backed by Items
  */
-export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions {
+export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions, IWithFollowers {
     /**
      * Access level of the item ("private" | "org" | "public")
      */
@@ -101,3 +102,19 @@ export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithD
      */
     protected?: boolean;
 }
+export declare type IHubItemEntityEditor<T> = Omit<T, "extent"> & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+    /**
+     * Follower group settings. These settings are only used in the
+     * Editor and is persisted appropriately in the fromEditor
+     * method on the Class
+     */
+    _followers?: {
+        groupAccess?: AccessLevel;
+        showFollowAction?: boolean;
+    };
+};

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

@@ -1,13 +1,12 @@
 import { IExtent } from "@esri/arcgis-rest-feature-layer";
 import { IWithVersioningBehavior } from "../behaviors";
 import { IWithCatalog, IWithLayout, IWithPermissions, IWithSlug } from "../traits/index";
-import { IHubItemEntity } from "./IHubItemEntity";
-import { IWithFollowers } from "../traits/IWithFollowers";
+import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added
  * @internal
  */
-export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions, IWithVersioningBehavior, IWithFollowers {
+export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions, IWithVersioningBehavior {
     /**
      * Array of minimal page objects
      */
@@ -70,10 +69,4 @@ export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWith
     /** Legacy teams - list of ids */
     legacyTeams: 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;
-};
+export declare type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {};

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

@@ -7,7 +7,7 @@ export declare const SiteDefaultFeatures: IFeatureFlags;
  * Site Permissions
  * This feeds into the Permissions type
  */
-export declare const SitePermissions: readonly ["hub:site", "hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:site:owner", "hub:site:events", "hub:site:content", "hub:site:discussions", "hub:site:workspace:overview", "hub:site:workspace:dashboard", "hub:site:workspace:details", "hub:site:workspace:settings", "hub:site:workspace:collaborators", "hub:site:workspace:content", "hub:site:workspace:metrics", "hub:site:workspace:followers", "hub:site:workspace:followers:member", "hub:site:workspace:followers:manager", "hub:site:manage"];
+export declare const SitePermissions: readonly ["hub:site", "hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:site:owner", "hub:site:events", "hub:site:content", "hub:site:discussions", "hub:site:feature:follow", "hub:site:workspace:overview", "hub:site:workspace:dashboard", "hub:site:workspace:details", "hub:site:workspace:settings", "hub:site:workspace:collaborators", "hub:site:workspace:content", "hub:site:workspace:metrics", "hub:site:workspace:followers", "hub:site:workspace:followers:member", "hub:site:workspace:followers:manager", "hub:site:manage"];
 /**
  * Site permission policies
  * @private

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

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

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

@@ -3,8 +3,8 @@ import { IUiSchema } from "../../core/schemas/types";
 import { IHubSite } from "../../core/types";
 /**
  * @private
- * construct edit uiSchema for Hub Projects - this defines
- * how the schema properties should be rendered in the
- * project editing experience
+ * constructs the edit uiSchema for Hub Sites.
+ * This defines how the schema properties should
+ * be rendered in the site editing experience
  */
 export declare const buildUiSchema: (i18nScope: string, entity: IHubSite, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+import { IHubSite } from "../../core/types";
+/**
+ * @private
+ * constructs the followers uiSchema for Hub Sites.
+ * This defines how the schema properties should
+ * be rendered in the site followers > settings
+ * experience
+ */
+export declare const buildUiSchema: (i18nScope: string, entity: IHubSite, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/sites/_internal/capabilities/capabilityToFeatureMap.d.ts

@@ -0,0 +1,14 @@
+import { ICapabilityToFeatureMap } from "./types";
+/**
+ * Returns an array of ICapabilityToFeatureMap objects
+ * that define the projection of legacy capabilities
+ * to permission features.
+ *
+ * We use this map to manage foward and backard conversions
+ * and migration of legacy capablities to features when a
+ * site is fetched or updated
+ *
+ * NOTE: if you are porting a legacy capability over to
+ * workspaces, add it to this map
+ */
+export declare const capabilityToFeatureMap: ICapabilityToFeatureMap[];

package/dist/types/sites/_internal/capabilities/convertFeaturesToLegacyCapabilities.d.ts

@@ -0,0 +1,19 @@
+import { IModel } from "../../../types";
+/**
+ * Site capabilities are currently saved as an array on the
+ * site.data.values.capabilities. We want to migragte these
+ * legacy capabilities over to features in the new permissions
+ * system; however, we must continue persisting updates to
+ * these features in the legacy capabilities array until the
+ * existing site capabilities in our application are plumbed
+ * to work off of permissions
+ *
+ * This function is called within updateSite to ensure
+ * the legacy capabilities array is kept up-to-date
+ *
+ * TODO: Remove once site capabilities use permissions
+ *
+ * @param modelToUpdate
+ * @param currentModel
+ */
+export declare const convertFeaturesToLegacyCapabilities: (modelToUpdate: IModel, currentModel: IModel) => IModel;

package/dist/types/sites/_internal/capabilities/migrateLegacyCapabilitiesToFeatures.d.ts

@@ -0,0 +1,12 @@
+import { IModel } from "../../../types";
+/**
+ * Site capabilities are currently saved as an array on the
+ * site.data.values.capabilities. We want to migragte these
+ * legacy capabilities over to features in the new permissions
+ * system and expose them on the entity
+ *
+ * This function is called within fetchSite to ensure all
+ * sites have features that are kept up-to-date with the
+ * legacy capabilities array
+ */
+export declare const migrateLegacyCapabilitiesToFeatures: (model: IModel) => IModel;

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

@@ -0,0 +1,29 @@
+import { SitePermissions } from "../SiteBusinessRules";
+/**
+ * legacy site capabilities
+ */
+export declare type LegacyCapability = "hideFollow";
+/**
+ * representation of legacy site capabilities as
+ * feature flags
+ */
+export interface ILegacyCapabilityFeatureFlags extends Partial<Record<LegacyCapability, boolean>> {
+}
+/**
+ * capability to feature map entry that provides a
+ * "cross-walk" between a legacy site capability
+ * and site feature (using the new permissions
+ * system)
+ *
+ * This enables us to convert/migrate capabilities
+ * to features when sites are fetched and updated
+ */
+export interface ICapabilityToFeatureMap {
+    capability: LegacyCapability;
+    feature: (typeof SitePermissions)[number];
+    /**
+     * whether to apply a ! when converting between the
+     * capability and feature
+     */
+    negate?: boolean;
+}

package/package.json

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