@esri/hub-common 14.14.0 → 14.16.0

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

@@ -0,0 +1,4 @@
+export interface IWithAssociations {
+    typeKeywords?: string[];
+    [key: string]: any;
+}

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/traits/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./IWithAssociations";
 export * from "./IWithBannerImage";
 export * from "./IWithLayout";
 export * from "./IWithSlug";

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

@@ -3,10 +3,12 @@ import { IHubGeography } from "../../types";
 import { AccessLevel } from "./types";
 import { IWithPermissions, IWithViewSettings, IWithDiscussions } from "../traits";
 import { IHubLocation } from "./IHubLocation";
+import { IWithFollowers } from "../traits/IWithFollowers";
+import { IWithAssociations } from "../traits/IWithAssociations";
 /**
  * Properties exposed by Entities that are backed by Items
  */
-export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions {
+export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions, IWithFollowers, IWithAssociations {
     /**
      * Access level of the item ("private" | "org" | "public")
      */
@@ -101,3 +103,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/extent.d.ts

@@ -24,7 +24,7 @@ export declare const GLOBAL_EXTENT: IExtent;
  * Gets the geographic extent for an org
  * @param hubRequestOptions
  */
-export declare function getGeographicOrgExtent(hubRequestOptions: IHubRequestOptions): Promise<IExtent>;
+export declare function orgExtent(hubRequestOptions: IHubRequestOptions): Promise<IExtent>;
 /**
  * Get the default org extent as a bbox for use on item.extent
  * @param {IHubRequestOptions} hubRequestOptions

package/dist/types/groups/HubGroups.d.ts

@@ -1,9 +1,9 @@
 import { IGroup } from "@esri/arcgis-rest-types";
-import { IHubSearchResult } from "../search";
 import { IHubRequestOptions } from "../types";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubGroup } from "../core/types/IHubGroup";
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
 /**
  * Enrich a generic search result
  * @param group

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./associations";
 export * from "./access";
 export * from "./api";
 export * from "./ArcGISContext";

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

@@ -1,5 +1,5 @@
 import { IEntityEditorContext } from "../core/types/HubEntityEditor";
-import { Catalog } from "../search";
+import { Catalog } from "../search/Catalog";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { InitiativeEditorType } from "./_internal/InitiativeSchema";

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

@@ -1,8 +1,9 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IHubRequestOptions } from "../index";
+import { IQuery } from "../search/types/IHubCatalog";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IHubInitiative } from "../core/types";
+import { IEntityInfo, IHubInitiative } from "../core/types";
 import { IHubSearchResult } from "../search";
 /**
  * @private
@@ -53,3 +54,41 @@ export declare function convertItemToInitiative(item: IItem, requestOptions: IRe
  * @returns
  */
 export declare function enrichInitiativeSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
+/**
+ * Fetch the Projects that are "Accepted" with an Initiative.
+ * This is a subset of the "Associated" projects, limited
+ * to those included in the Initiative's Catalog.
+ * @param initiative
+ * @param requestOptions
+ * @param query: Optional `IQuery` to further filter the results
+ * @returns
+ */
+export declare function fetchAcceptedProjects(initiative: IHubInitiative, requestOptions: IHubRequestOptions, query?: IQuery): Promise<IEntityInfo[]>;
+/**
+ * Fetch the Projects that are "Associated" to the Initiative but are not
+ * "Accepted", meaning they have the keyword but are not included in the Initiative's Catalog.
+ * This is how we can get the list of Projects awaiting Acceptance
+ * @param initiative
+ * @param requestOptions
+ * @param query
+ * @returns
+ */
+export declare function fetchPendingProjects(initiative: IHubInitiative, requestOptions: IHubRequestOptions, query?: IQuery): Promise<IEntityInfo[]>;
+/**
+ * Associated projects are those with the Initiative id in the typekeywords
+ * and is included in the Initiative's catalog.
+ * This is passed into the Gallery showing "Approved Projects"
+ * @param initiative
+ * @returns
+ */
+export declare function getAcceptedProjectsQuery(initiative: IHubInitiative): IQuery;
+/**
+ * Related Projects are those that have the Initiative id in the
+ * typekeywords but NOT in the catalog. We use this query to show
+ * Projects which want to be associated but are not yet included in
+ * the catalog
+ * This is passed into the Gallery showing "Pending Projects"
+ * @param initiative
+ * @returns
+ */
+export declare function getPendingProjectsQuery(initiative: IHubInitiative): IQuery;

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

@@ -1,8 +1,20 @@
-declare const validPermissions: readonly string[];
+import { ProjectPermissions } from "../../projects/_internal/ProjectBusinessRules";
+import { SitePermissions } from "../../sites/_internal/SiteBusinessRules";
+import { InitiativePermissions } from "../../initiatives/_internal/InitiativeBusinessRules";
+import { ContentPermissions } from "../../content/_internal/ContentBusinessRules";
+import { GroupPermissions } from "../../groups/_internal/GroupBusinessRules";
+import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
+import { PlatformPermissions } from "../PlatformPermissionPolicies";
+/**
+ * Defines the values for Permissions
+ * It's critical that the arrays defined in the modules use `as const`
+ * otherwise Permission devolves into just a string type
+ */
+declare const TempPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = (typeof validPermissions)[number];
+export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number];
 /**
  * Validate a Permission
  * @param permission

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

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

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

@@ -2,6 +2,7 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubProject } from "../core/types";
 import { IHubSearchResult } from "../search";
+import { IQuery } from "../search/types/IHubCatalog";
 import { IHubRequestOptions } from "../types";
 /**
  * @private
@@ -28,3 +29,16 @@ export declare function convertItemToProject(item: IItem, requestOptions: IReque
  * @returns
  */
 export declare function enrichProjectSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
+/**
+ * Get a query that will fetch all the initiatives which the project has
+ * chosen to connect to. If project has not defined any associations
+ * to any Initiatives, will return `null`.
+ * Currently, we have not implemented a means to get the list of initiatives that have
+ * "Accepted" the Project via inclusion in it's catalog.
+ *
+ * If needed, this could be done by getting all the groups the project is shared into
+ * then cross-walking that into the catalogs of all the Associated Initiatives
+ * @param project
+ * @returns
+ */
+export declare function getAssociatedInitiativesQuery(project: IHubProject): IQuery;

package/dist/types/search/_internal/getEntityTypeFromType.d.ts

@@ -0,0 +1,9 @@
+import { EntityType } from "../types";
+/**
+ * @private
+ * Given a type (e.g. Hub Site Application) return the appropriate entity type
+ * that can be used as a `targetEntity` in an `IQuery`
+ * @param type
+ * @returns
+ */
+export declare function getEntityTypeFromType(type: string): EntityType;

package/dist/types/search/_internal/negateGroupPredicates.d.ts

@@ -0,0 +1,9 @@
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * @private
+ * Helper function that locates group predicates and "negates" them
+ * so we get a query that is `not in groups ...` vs `in groups ...`
+ * @param query
+ * @returns
+ */
+export declare function negateGroupPredicates(query: IQuery): IQuery;

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

@@ -85,6 +85,7 @@ export declare function getUserThumbnailUrl(portalUrl: string, user: IUser, toke
  */
 export declare function migrateToCollectionKey(collectionOrSearchCategory: LegacySearchCategory | WellKnownCollection): WellKnownCollection;
 /**
+ * DEPRECATED: Please use `getGroupPredicate`
  * Searches through a catalog scope and retrieves the predicate responsible
  * for determining group sharing requirements.
  *
@@ -92,6 +93,13 @@ export declare function migrateToCollectionKey(collectionOrSearchCategory: Legac
  * @returns The first predicate with a `group` field (if present)
  */
 export declare function getScopeGroupPredicate(scope: IQuery): IPredicate;
+/**
+ * Searches through an `IQuery` and retrieves the predicate with a `group` definition.
+ * If there is no group predicate, returns `null`
+ * @param query IQuery to search
+ * @returns
+ */
+export declare function getGroupPredicate(query: IQuery): IPredicate;
 /**
  * Determines the canonical siteRelative link for a search result.
  *

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/dist/types/users/HubUsers.d.ts

@@ -1,6 +1,6 @@
 import { IUser } from "@esri/arcgis-rest-types";
-import { IHubSearchResult } from "../search";
 import { IHubRequestOptions } from "../types";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
 /**
  * Enrich a User object
  * @param user

package/package.json

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