@esri/hub-common 13.37.3 → 13.38.0

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

@@ -1,4 +1,4 @@
-import { IEntityPermissionPolicy } from "../../permissions";
+import { IEntityFeatures, IEntityPermissionPolicy } from "../../permissions";
 import { EntityCapabilities } from "../../capabilities";
 /**
  * Adds permissions property to an entity
@@ -8,5 +8,13 @@ export interface IWithPermissions {
      * Array of permission policies that apply to the entity
      */
     permissions?: IEntityPermissionPolicy[];
+    /**
+     * We need a means to enable / disable the "feature/capability" represented by a permission
+     * for an entity. e.g. we want to disable events for a site, so we have `hub:site:events`: false
+     */
+    features?: IEntityFeatures;
+    /**
+     * DEPRECATEDL use `features` instead
+     */
     capabilities?: EntityCapabilities;
 }

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

@@ -92,4 +92,8 @@ export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithD
      * The orgId of the Entity, if available
      */
     orgId?: string;
+    /**
+     * Is the item protected?
+     */
+    protected?: boolean;
 }

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

@@ -3,6 +3,7 @@
  */
 export declare type SystemStatus = "online" | "offline" | "maintenance" | "not-available";
 /**
+ * DEPRECATED: use HubServiceStatus instead
  * Hash of subsystems and their status
  */
 export declare type HubSystemStatus = {
@@ -10,13 +11,29 @@ export declare type HubSystemStatus = {
 };
 declare const validSubsystems: readonly ["content", "discussions", "events", "initiatives", "items", "metrics", "notifications", "pages", "projects", "search", "sites", "groups", "platform"];
 /**
+ * * DEPRECATED: use HubService instead
  * Defines values for HubSubsystem
  */
 export declare type HubSubsystem = (typeof validSubsystems)[number];
 /**
+ * * DEPRECATED: use isHubService instead
  * Validate a Subsystem
  * @param subsystem
  * @returns
  */
 export declare function isSubsystem(maybeSubsystem: string): boolean;
+/**
+ * Hash of subsystems and their status
+ */
+export declare type HubServiceStatus = {
+    [key in HubService]: SystemStatus;
+};
+declare const validServices: readonly ["portal", "discussions", "events", "metrics", "notifications", "hub-search", "domains"];
+export declare type HubService = (typeof validServices)[number];
+/**
+ * Validate a Service
+ * @param service
+ * @returns
+ */
+export declare function isHubService(maybeService: string): boolean;
 export {};

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

@@ -8,6 +8,7 @@ export * from "./IHubDiscussion";
 export * from "./IHubEditableContent";
 export * from "./IHubEntityBase";
 export * from "./IHubEvent";
+export * from "./IHubGroup";
 export * from "./IHubImage";
 export * from "./IHubInitiative";
 export * from "./IHubItemEntity";

package/dist/types/discussions/_internal/DiscussionBusinessRules.d.ts

@@ -5,12 +5,14 @@ import { IPermissionPolicy } from "../../permissions";
  * 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
+ * TODO: Remove capabilities
  */
 export declare const DiscussionDefaultCapabilities: EntityCapabilities;
 /**
  * List of all the Discussion Capability Permissions
  * These are considered Hub Business Rules and are not intended
  * to be modified by consumers
+ * TODO: Remove capabilities
  * @private
  */
 export declare const DiscussionCapabilityPermissions: ICapabilityPermission[];
@@ -19,7 +21,7 @@ export declare const DiscussionCapabilityPermissions: ICapabilityPermission[];
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const DiscussionPermissions: readonly ["hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view"];
+export declare const DiscussionPermissions: readonly ["hub:discussion", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view"];
 /**
  * Discussion permission policies
  * @private

package/dist/types/groups/_internal/GroupBusinessRules.d.ts

@@ -3,6 +3,7 @@ import { IPermissionPolicy } from "../../permissions";
 /**
  * Default capabilities for a Group.
  * If not listed here, the capability will not be available
+ * TODO: Remove capabilities
  * @private
  */
 export declare const GroupDefaultCapabilities: EntityCapabilities;
@@ -10,6 +11,7 @@ export declare const GroupDefaultCapabilities: EntityCapabilities;
  * List of all the Group Capability Permissions
  * These are considered Hub Business Rules and are not intended
  * to be modified by consumers
+ * TODO: Remove capabilities
  * @private
  */
 export declare const GroupCapabilityPermissions: ICapabilityPermission[];
@@ -18,7 +20,7 @@ export declare const GroupCapabilityPermissions: ICapabilityPermission[];
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const GroupPermissions: readonly ["hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner"];
+export declare const GroupPermissions: readonly ["hub:group", "hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner"];
 /**
  * Group permission policies
  * @private

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

@@ -1,5 +1,5 @@
 import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
-import { IPermissionPolicy } from "../../permissions";
+import { IEntityFeatures, IPermissionPolicy } from "../../permissions";
 /**
  * Default capabilities for a Initiative. 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
@@ -14,12 +14,16 @@ export declare const InitiativeDefaultCapabilities: EntityCapabilities;
  * @private
  */
 export declare const InitiativeCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Default features for a Initiative. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const InitiativeDefaultFeatures: IEntityFeatures;
 /**
  * Initiative Permission Policies
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const InitiativePermissions: readonly ["hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view"];
+export declare const InitiativePermissions: readonly ["hub:initiative", "hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view", "hub:initiative:events", "hub:initiative:content", "hub:initiative:discussions"];
 /**
  * Initiative permission policies
  * @private

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

@@ -1,25 +1,31 @@
 import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
-import { IPermissionPolicy } from "../../permissions";
+import { IEntityFeatures, 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
+ * TODO: Remove capabilities
  */
 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
+ * TODO: Remove capabilities
  * @private
  */
 export declare const PageCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Default features for a Project. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const PageDefaultFeatures: IEntityFeatures;
 /**
  * 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"];
+export declare const PagePermissions: readonly ["hub:page", "hub:page:create", "hub:page:delete", "hub:page:edit", "hub:page:view"];
 /**
  * Page permission policies
  * @private

package/dist/types/permissions/_internal/checkAlphaGating.d.ts

@@ -7,4 +7,4 @@ import { IPermissionPolicy, IPolicyCheck } from "../types";
  * @param entity
  * @returns
  */
-export declare function checkAlphaGating(policy: IPermissionPolicy, context: IArcGISContext, entity?: Record<string, any>): IPolicyCheck[];
+export declare function checkAlphaGating(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkAvailability.d.ts

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+/**
+ * @internal
+ * Verify that the policy.availability requirement is met.
+ * If a value is specified in the policy, the current context must be one of those values.
+ * @param policy
+ * @param context
+ * @param entity
+ * @returns
+ */
+export declare function checkAvailability(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkEntityFeature.d.ts

@@ -0,0 +1,4 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+export declare function checkEntityFeature(policy: IPermissionPolicy, _entitycontext: IArcGISContext, entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkEnvironment.d.ts

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+/**
+ * @internal
+ * Verify that the policy.environment requirement is met.
+ *
+ * @param policy
+ * @param context
+ * @param entity
+ * @returns
+ */
+export declare function checkEnvironment(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkParents.d.ts

@@ -0,0 +1,12 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+/**
+ * @internal
+ * Check the parent policies for the given policy
+ * @param policy
+ * @param context
+ * @param entity
+ * @returns
+ */
+export declare function checkParents(policy: IPermissionPolicy, context: IArcGISContext, entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/checkServiceStatus.d.ts

@@ -0,0 +1,4 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IPermissionPolicy } from "../types/IPermissionPolicy";
+import { IPolicyCheck } from "../types/IPolicyCheck";
+export declare function checkServiceStatus(policy: IPermissionPolicy, context: IArcGISContext, _entity?: Record<string, any>): IPolicyCheck[];

package/dist/types/permissions/_internal/processEntityFeatures.d.ts

@@ -0,0 +1,9 @@
+import { IEntityFeatures } from "../types/IPermissionPolicy";
+/**
+ * Take an entity's features and merge them with the default features ensuring
+ * that only the featires defined in the business rules are allowed through.
+ * @param entityFeatures
+ * @param defaultFeatures
+ * @returns
+ */
+export declare function processEntityFeatures(entityFeatures: IEntityFeatures, defaultFeatures: IEntityFeatures): IEntityFeatures;

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

@@ -1,5 +1,5 @@
 import { HubLicense } from "./HubLicense";
-import { HubSubsystem } from "../../core/types/ISystemStatus";
+import { HubService, HubSubsystem } from "../../core/types/ISystemStatus";
 import { Permission } from "./Permission";
 import { PlatformPrivilege } from "./PlatformPrivilege";
 /**
@@ -14,9 +14,17 @@ export interface IPermissionPolicy {
      */
     permission: Permission;
     /**
-     * What subsystems are required to be online for this permission to be granted
+     * Parent permissions this permission is dependent on
      */
-    subsystems: HubSubsystem[];
+    dependencies?: Permission[];
+    /**
+     * DEPRECATED: What subsystems are required to be online for this permission to be granted
+     */
+    subsystems?: HubSubsystem[];
+    /**
+     * What services are required to be online for this permission to be granted
+     */
+    services?: HubService[];
     /**
      * Must the user authenticated?
      */
@@ -27,11 +35,25 @@ export interface IPermissionPolicy {
      * e.g. If a user is in a Partner "hub-basic" org, they can not create "premium" entities (e.g. Projects)
      */
     licenses?: HubLicense[];
+    /**
+     * Is this permission gated to a specific availability?
+     * This is used to limit access to features that are not yet available in production
+     */
+    availability?: HubAvailability[];
+    /**
+     * Is this permission gated to a specific environment? (e.g. devext, qaext)
+     * This is used to limit access to features that are not yet available in production
+     */
+    environments?: HubEnvironment[];
     /**
      * Any platform level privileges required for this permission to be granted
      * e.g. "portal:user:createItem"
      */
     privileges?: PlatformPrivilege[];
+    /**
+     * Can an entity provide additional conditions to further limit access?
+     */
+    entityConfigurable?: boolean;
     /**
      * Is the user an owner of the entity being accessed?
      */
@@ -41,17 +63,46 @@ export interface IPermissionPolicy {
      */
     entityOwner?: boolean;
     /**
-     * Is this gated to alpha orgs?
+     * DEPRECATED: Use `gatedAvailability: "alpha"` instead
      */
     alpha?: boolean;
     /**
      * More complex policies can be defined with a set of assertions
      */
     assertions?: IPolicyAssertion[];
+    /**
+     * Value set by the feature flagging system to override the default permission behavior. This can be used to
+     * demo features to specific users or groups, during a specific user session.
+     * If `true`, the permission will be granted as long as the license and privilege requirements are met.
+     * If `false`, the permission will be denied for all users - typically as a means to check for graceful degradation
+     * if a system is offline.
+     */
+    flagValue?: boolean;
 }
+/**
+ * Hash of features for an entity which can be used to determine if a feature is enabled for the entity
+ * This can be applied to any permissin, enabling a lot of flexibility in how features are described and enabled
+ * If the value is set to false, then the permission will alway be set to false for all users.
+ */
+export interface IEntityFeatures extends Record<Permission, boolean> {
+}
+/**
+ * Hub Availability levels
+ */
+export declare type HubAvailability = "alpha" | "beta" | "general";
+/**
+ * Hub Run-time environments
+ */
+export declare type HubEnvironment = "devext" | "qaext" | "production" | "enterprise" | "enterprise-k8s";
+/**
+ * Assertion used to define more complex permission policies
+ */
 export interface IPolicyAssertion {
     property: string;
     type: AssertionType;
     value: any;
 }
+/**
+ * Assertion types which define the comparison operation to be performed
+ */
 export declare type AssertionType = "eq" | "neq" | "gt" | "lt" | "contains" | "contains-all" | "without" | "included-in" | "is-group-admin" | "is-group-member" | "is-group-owner" | "starts-with" | "ends-with" | "not-starts-with" | "not-ends-with";

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

@@ -1,4 +1,4 @@
 /**`
  * Human readable response from a policy check
  */
-export declare type PolicyResponse = "granted" | "org-member" | "not-org-member" | "group-member" | "not-group-member" | "not-group-admin" | "is-user" | "not-owner" | "not-licensed" | "not-licensed-available" | "not-available" | "not-granted" | "no-edit-access" | "edit-access" | "invalid-permission" | "invalid-capability" | "privilege-required" | "system-offline" | "system-maintenance" | "entity-required" | "not-authenticated" | "not-alpha-org" | "property-missing" | "property-not-array" | "array-contains-invalid-value" | "array-missing-required-value" | "property-mismatch" | "user-not-group-member" | "user-not-group-manager" | "user-not-group-owner" | "assertion-property-not-found" | "assertion-failed" | "assertion-requires-numeric-values" | "property-match";
+export declare type PolicyResponse = "granted" | "org-member" | "not-org-member" | "group-member" | "not-group-member" | "not-group-admin" | "is-user" | "not-owner" | "not-licensed" | "not-licensed-available" | "not-available" | "not-granted" | "no-edit-access" | "edit-access" | "invalid-permission" | "invalid-capability" | "privilege-required" | "system-offline" | "system-maintenance" | "service-offline" | "service-maintenance" | "service-not-available" | "entity-required" | "not-authenticated" | "not-alpha-org" | "not-beta-org" | "property-missing" | "property-not-array" | "array-contains-invalid-value" | "array-missing-required-value" | "property-mismatch" | "user-not-group-member" | "user-not-group-manager" | "user-not-group-owner" | "assertion-property-not-found" | "assertion-failed" | "assertion-requires-numeric-values" | "property-match" | "feature-disabled" | "feature-enabled" | "not-in-environment";

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

@@ -1,25 +1,31 @@
 import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
-import { IPermissionPolicy } from "../../permissions";
+import { IEntityFeatures, IPermissionPolicy } from "../../permissions";
 /**
  * Default capabilities for a Project. 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
+ * TODO: Remove capabilities
  */
 export declare const ProjectDefaultCapabilities: EntityCapabilities;
 /**
  * List of all the Project Capability Permissions
  * These are considered Hub Business Rules and are not intended
  * to be modified by consumers
+ * TODO: Remove capabilities
  * @private
  */
 export declare const ProjectCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Default features for a Project. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const ProjectDefaultFeatures: IEntityFeatures;
 /**
  * Project Permission Policies
  * 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", "hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:project:owner", "hub:project:events", "hub:project:content", "hub:project:discussions"];
 /**
  * Project permission policies
  * @private

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

@@ -1,6 +1,7 @@
 import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
-import { IPermissionPolicy } from "../../permissions/types";
+import { IEntityFeatures, IPermissionPolicy } from "../../permissions/types";
 /**
+ * DEPRECATED
  * Default capabilities for a Site. 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
@@ -8,16 +9,22 @@ import { IPermissionPolicy } from "../../permissions/types";
  */
 export declare const SiteDefaultCapabilities: EntityCapabilities;
 /**
+ * DEPRECATED
  * List of all the Site Capability Permissions
  * These are considered Hub Business Rules and are not intended
  * to be modified by consumers
+ * @private
  */
 export declare const SiteCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Default features for a Site. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const SiteDefaultFeatures: IEntityFeatures;
 /**
  * Site Permissions
  * This feeds into the Permissions type
  */
-export declare const SitePermissions: readonly ["hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view"];
+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"];
 /**
  * Site permission policies
  * @private

package/dist/types/utils/getEnvironmentFromPortalUrl.d.ts

@@ -0,0 +1,2 @@
+import { HubEnvironment } from "../permissions";
+export declare function getEnvironmentFromPortalUrl(portalUrl: string): HubEnvironment;

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

@@ -21,3 +21,4 @@ export * from "./sessionLocalStorage";
 export * from "./dasherize";
 export * from "./titleize";
 export * from "./memoize";
+export * from "./getEnvironmentFromPortalUrl";

package/package.json

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