@esri/hub-common 14.74.2 → 14.75.0

package/dist/types/associations/getRequestingEntitiesQuery.d.ts

@@ -0,0 +1,26 @@
+import { IQuery } from "../search/types";
+import { HubEntity, HubEntityType } from "../core/types";
+import { IArcGISContext } from "..";
+/**
+ * Requesting entities represent "incoming" requests that are
+ * awaiting "approval". They imply a one-way "connection"
+ * between parent/child.
+ *
+ * From the parent's perspective:
+ * parent: does NOT "include" the child in its association query
+ * child: "references" the parent via a typeKeyword of the
+ * form ref|<parentType>|<parentID>
+ *
+ * From the child's perspective:
+ * parent: "includes" the child in its association query
+ * child: does NOT "reference" the parent via a typeKeyword
+ *
+ * The following returns a query to view an entity's incoming
+ * requests for association with another entity type
+ *
+ * @param entity - Hub entity
+ * @param associationType - entity type to query for
+ * @param context - contextual auth and portal information
+ * @returns {IQuery}
+ */
+export declare const getRequestingEntitiesQuery: (entity: HubEntity, associationType: HubEntityType, context: IArcGISContext) => Promise<IQuery>;

package/dist/types/associations/getWellKnownAssociationsCatalog.d.ts

@@ -0,0 +1,34 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubEntity, HubEntityType } from "../core/types";
+import { IHubCatalog } from "../search/types";
+/**
+ * Supported association catalogs that can be requested.
+ * These correspond to a specific IHubCatalog definition
+ * that gets returned.
+ */
+export declare type WellKnownAssociationCatalog = "associated" | "pending" | "requesting" | "availableToRequest";
+/**
+ * There are two primary UI workflows when we consider associations:
+ * 1. Viewing associations
+ * 2. Forming associations
+ *
+ * Because associations involve a 2-way agreement between parent
+ * and child, when viewing associations, there are 3 gallery states
+ * that can be viewed: "associated", "pending", and "requesting"
+ * entities. Additionally, when forming associations, we need a
+ * picker experience filtered to entities that can still be
+ * requested for association.
+ *
+ * These define the "well-known" association catalogs that this
+ * util can return. In turn, these can be passed into the catalog
+ * and/or gallery-picker components to render the appropriate
+ * UI experience.
+ *
+ * @param i18nScope - translation scope to be interpolated into the catalog
+ * @param catalogName - name of the well-known catalog requested
+ * @param entity - primary entity the catalog is being built for
+ * @param associationType - type of entity the primary entity wants to view associations for
+ * @param context - contextual auth and portal information
+ * @returns {IHubCatalog}
+ */
+export declare function getWellKnownAssociationsCatalog(i18nScope: string, catalogName: WellKnownAssociationCatalog, entity: HubEntity, associationType: HubEntityType, context: IArcGISContext): Promise<IHubCatalog>;

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

@@ -1,4 +1,13 @@
 export * from "./addAssociation";
+export * from "./breakAssociation";
 export * from "./listAssociations";
 export * from "./removeAssociation";
 export * from "./types";
+export * from "./getAssociatedEntitiesQuery";
+export * from "./getAssociationStats";
+export * from "./getAvailableToRequestEntitiesQuery";
+export * from "./getPendingEntitiesQuery";
+export * from "./getRequestingEntitiesQuery";
+export * from "./getWellKnownAssociationsCatalog";
+export { requestAssociation } from "./requestAssociation";
+export { requestAssociation as acceptAssociation } from "./requestAssociation";

package/dist/types/associations/internal/getAssociationHierarchy.d.ts

@@ -0,0 +1,15 @@
+import { HubEntityType } from "../../core/types";
+import { IHubAssociationHierarchy } from "../../associations/types";
+/**
+ * associations are hierarchical in nature, e.g.
+ * there is always a parent and a child involved
+ * in the relationship.
+ *
+ * given an entity type, this util returns the
+ * parent and children entity types that it can
+ * associate with
+ *
+ * @param type - entity type
+ * @returns {IHubAssociationHierarchy}
+ */
+export declare const getAssociationHierarchy: (type: HubEntityType) => IHubAssociationHierarchy;

package/dist/types/associations/internal/getIdsFromAssociationGroups.d.ts

@@ -0,0 +1,15 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+import { HubEntityType } from "../../core";
+/**
+ * given an array of groups, this util maps over them,
+ * and for each, determines if it's an association group
+ * by checking if it has a typeKeyword of the form
+ * <associationType>|<id>. If so, it extracts and returns
+ * the id which corresponds to the parent entity that this
+ * association group belongs to
+ *
+ * @param groups - array of groups
+ * @param associationType - entity type to extract ids for
+ * @returns {string[]}
+ */
+export declare const getIdsFromAssociationGroups: (groups: IGroup[], associationType: HubEntityType) => string[];

package/dist/types/associations/internal/getIdsFromKeywords.d.ts

@@ -0,0 +1,13 @@
+import { HubEntity, HubEntityType } from "../../core";
+/**
+ * given a hub entity, this util maps over its typeKeywords,
+ * and for each, determines if it is an association typeKeyword
+ * by checking whether it has the form ref|<associationType>|<id>.
+ * If so, it extracts and returns the id which correspond to the
+ * parent entity that this entity is associated with.
+ *
+ * @param entity - hub entity to extract ids from
+ * @param associationType - entity type to extract ids for
+ * @returns {string[]}
+ */
+export declare const getIdsFromKeywords: (entity: HubEntity, associationType: HubEntityType) => string[];

package/dist/types/associations/internal/getIncludesAndReferencesQuery.d.ts

@@ -0,0 +1,14 @@
+import { HubEntity, HubEntityType } from "../../core/types";
+import { IQuery } from "../../search/types";
+import { IArcGISContext } from "../../ArcGISContext";
+/**
+ * builds a query that will return entities that are
+ * "included" AND "referenced"
+ *
+ * @param entity - Hub entity
+ * @param associationType - entity type to query for
+ * @param isParent - whether the provided Hub entity is the parent in the association relationship
+ * @param context - contextual auth and portal information
+ * @returns {IQuery}
+ */
+export declare const getIncludesAndReferencesQuery: (entity: HubEntity, associationType: HubEntityType, isParent: boolean, context: IArcGISContext) => Promise<IQuery>;

package/dist/types/associations/internal/getIncludesDoesNotReferenceQuery.d.ts

@@ -0,0 +1,14 @@
+import { HubEntity, HubEntityType } from "../../core/types";
+import { IQuery } from "../../search/types";
+import { IArcGISContext } from "../../ArcGISContext";
+/**
+ * builds a query that will return entities that are
+ * "included" but NOT "referenced"
+ *
+ * @param entity - Hub entity
+ * @param associationType - entity type to query for
+ * @param isParent - whether the provided Hub entity is the parent in the association relationship
+ * @param context - contextual auth and portal information
+ * @returns {IQuery}
+ */
+export declare const getIncludesDoesNotReferenceQuery: (entity: HubEntity, associationType: HubEntityType, isParent: boolean, context: IArcGISContext) => Promise<IQuery>;

package/dist/types/associations/internal/getReferencesDoesNotIncludeQuery.d.ts

@@ -0,0 +1,14 @@
+import { HubEntity, HubEntityType } from "../../core/types";
+import { IQuery } from "../../search/types";
+import { IArcGISContext } from "../../ArcGISContext";
+/**
+ * builds a query that will return entities that are
+ * "referenced" but NOT "included"
+ *
+ * @param entity - Hub entity
+ * @param associationType - entity type to query for
+ * @param isParent - whether the provided Hub entity is the parent in the association relationship
+ * @param context - contextual auth and portal information
+ * @returns {IQuery}
+ */
+export declare const getReferencesDoesNotIncludeQuery: (entity: HubEntity, associationType: HubEntityType, isParent: boolean, context: IArcGISContext) => Promise<IQuery>;

package/dist/types/associations/internal/getTypeByIdsQuery.d.ts

@@ -1,10 +1,12 @@
 import { IQuery } from "../../search/types/IHubCatalog";
 /**
- * Get a query that can be used in a Gallery, and will return the associated
- * entities, based on the AssociationType
+ * @private
+ * Construct an IQuery to fetch a specified set of item id(s)
+ * by type(s). Note: if an array of types is provided, they
+ * must be the same underlying target entity type.
  *
- * @param entity
- * @param type
- * @returns
+ * @param itemType - a single item type or an array of item types
+ * @param ids - an array of ids
+ * @returns {IQuery}
  */
-export declare function getTypeByIdsQuery(itemType: string, ids: string[]): IQuery;
+export declare function getTypeByIdsQuery(itemType: string | string[], ids: string[]): IQuery;

package/dist/types/associations/internal/getTypeByNotIdsQuery.d.ts

@@ -0,0 +1,12 @@
+import { IQuery } from "../../search/types/IHubCatalog";
+/**
+ * @private
+ * Construct an IQuery to fetch the inverse of a specified set
+ * of item id(s) by type(s). Note: if an array of types is provided,
+ * they must be the same underlying target entity type.
+ *
+ * @param itemType - a single item type or an array of item types
+ * @param ids - an array of ids
+ * @returns {IQuery}
+ */
+export declare function getTypeByNotIdsQuery(itemType: string | string[], ids: string[]): IQuery;

package/dist/types/associations/internal/getTypeWithKeywordQuery.d.ts

@@ -1,10 +1,13 @@
 import { IQuery } from "../../search/types/IHubCatalog";
 /**
  * @private
- * Return an `IQuery` for a specific item type, with a specific typekeyword
- * This is used internally to build queries for "Connected" entities
- * @param itemType
- * @param keyword
+ * Construct an IQuery to fetch a set of items by type(s)
+ * with a specified typeKeyword. Note: if an array of types
+ * is provided, they must be the same underlying target
+ * entity type.
+ *
+ * @param itemType - The type(s) of item to fetch
+ * @param keyword - The typeKeyword to filter by
  * @returns
  */
-export declare function getTypeWithKeywordQuery(itemType: string, keyword: string): IQuery;
+export declare function getTypeWithKeywordQuery(itemType: string | string[], keyword: string): IQuery;

package/dist/types/associations/internal/getTypeWithoutKeywordQuery.d.ts

@@ -1,10 +1,13 @@
 import { IQuery } from "../../search/types/IHubCatalog";
 /**
  * @private
- * Return an `IQuery` for a specific item type, without a specific typekeyword
- * This is used internally to build queries for "Not Connected" entities
- * @param itemType
- * @param keyword
+ * Construct an IQuery to fetch a set of items by type(s)
+ * withOUT a specified typeKeyword. Note: if an array of
+ * types is provided, they must be the same underlying target
+ * entity type.
+ *
+ * @param itemType - The type(s) of item to fetch
+ * @param keyword - The typeKeyword to filter by
  * @returns
  */
-export declare function getTypeWithoutKeywordQuery(itemType: string, keyword: string): IQuery;
+export declare function getTypeWithoutKeywordQuery(itemType: string | string[], keyword: string): IQuery;

package/dist/types/associations/internal/isAssociationSupported.d.ts

@@ -0,0 +1,11 @@
+import { HubEntityType } from "../../core/types";
+/**
+ * given two entity types, this util returns
+ * whether or not associations are supported
+ * between the two
+ *
+ * @param type1 - first entity type
+ * @param type2 - second entity type
+ * @returns {boolean}
+ */
+export declare const isAssociationSupported: (type1: HubEntityType, type2: HubEntityType) => boolean;

package/dist/types/associations/internal/removeAssociationKeyword.d.ts

@@ -0,0 +1,12 @@
+import { HubEntityType } from "../../core/types";
+/**
+ * when a child decides it wants to "disconnect" itself from
+ * an existing association, the child removes the typeKeyword
+ * (ref|<type>|<id>) that "references" the parent
+ *
+ * @param typeKeywords - the child entity's typeKeywords
+ * @param type - the parent entity's type
+ * @param id - the parent entity's id
+ * @returns {string[]}
+ */
+export declare function removeAssociationKeyword(typeKeywords: string[], type: HubEntityType, id: string): string[];

package/dist/types/associations/internal/setAssociationKeyword.d.ts

@@ -0,0 +1,12 @@
+import { HubEntityType } from "../../core/types";
+/**
+ * when a child sends an "outgoing" request or accepts an
+ * "incoming" request for association, the child "references"
+ * the parent via a typeKeyword (ref|<type>|<id>)
+ *
+ * @param typeKeywords - the child entity's typeKeywords
+ * @param type - the parent entity's type
+ * @param id - the parent entity's id
+ * @returns {string[]}
+ */
+export declare function setAssociationKeyword(typeKeywords: string[], type: HubEntityType, id: string): string[];

package/dist/types/associations/listAssociations.d.ts

@@ -1,6 +1,10 @@
 import { IWithAssociations } from "../core/traits/IWithAssociations";
 import { AssociationType, IAssociationInfo } from "./types";
 /**
+ * ** DEPRECATED: please use getAssociatedEntitiesQuery
+ * to get a query for an entity's associations instead.
+ * This will be removed in the next breaking version **
+ *
  * Return a list of all associations on an entity for a type
  * @param entity
  * @returns

package/dist/types/associations/removeAssociation.d.ts

@@ -1,6 +1,9 @@
 import { IWithAssociations } from "../core/traits/IWithAssociations";
 import { IAssociationInfo } from "./types";
 /**
+ * ** DEPRECATED: please use breakAssociation instead.
+ * This will be removed in the next breaking version **
+ *
  * Remove an association from an entity
  * @param info
  * @param entity

package/dist/types/associations/requestAssociation.d.ts

@@ -0,0 +1,23 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubEntity, HubEntityType } from "../core/types";
+/**
+ * When an entity sends an "outgoing" association request
+ * or accepts an "incoming" association request, half of
+ * the association "connection" is made.
+ *
+ * from the parent's perspective: the parent "includes"
+ * the child in its association group
+ *
+ * From the child's perspective: the child "references"
+ * the parent via a typeKeyword of the form ref|<parentType>|<parentId>
+ *
+ * Note: we export this function under 2 names - requestAssociation
+ * and acceptAssociation. These actions are functionally equivalent,
+ * but we want to make the intent more clear to the consumer.
+ *
+ * @param entity - entity requesting association
+ * @param type - type of the entity the requesting entity wants to associate with
+ * @param id - id of the entity the requesting entity wants to associate with
+ * @param context - contextual portal and auth information
+ */
+export declare const requestAssociation: (entity: HubEntity, associationType: HubEntityType, id: string, context: IArcGISContext) => Promise<void>;

package/dist/types/associations/types.d.ts

@@ -1,4 +1,54 @@
+import { HubEntityType } from "../core";
+import { IQuery } from "../search";
 /**
+ * associations are hierarchical in nature e.g.
+ * there is always a parent and a child in the
+ * relationship. This interface allows us to
+ * define these hierarchies on an entity-by-entity
+ * basis
+ */
+export interface IHubAssociationHierarchy {
+    children: HubEntityType[];
+    parents: HubEntityType[];
+}
+/**
+ * association rules stored on the parent entity
+ * that define what is "included" by the parent
+ *
+ * For now, the query will define an association
+ * group, and "included" simply means it has
+ * been shared with the association group. In
+ * the future, the query may contain additional
+ * conditions
+ */
+export interface IHubAssociationRules {
+    /** schema version for migration purposes */
+    schemaVersion: number;
+    /** query that defines what's "included" by a parent */
+    query: IQuery;
+}
+/**
+ * associations involve a 2-way agreement between
+ * parent and child. This interface allows us to
+ * keep track of an entity's association stats with
+ * another entity
+ */
+export interface IAssociationStats {
+    /** number of full associations */
+    associated: number;
+    /** number of outgoing association requests */
+    pending: number;
+    /** number of incoming association requests */
+    requesting: number;
+    /** number of entity's the child references = associated + pending */
+    referenced?: number;
+    /** number of entities included by the parent = associated + pending */
+    included?: number;
+}
+/**
+ * ** DEPRECATED: This will be removed in the next
+ * breaking version **
+ *
  * Definition of an Association
  * This will be persisted in the item's typekeywords
  * as `type|id`
@@ -14,6 +64,9 @@ export interface IAssociationInfo {
     id: string;
 }
 /**
+ * ** DEPRECATED: This will be removed in the next
+ * breaking version **
+ *
  * Association type
  */
 export declare type AssociationType = "initiative";

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

@@ -148,6 +148,9 @@ export declare abstract class HubItemEntity<T extends IHubItemEntity> implements
      */
     updateIsDiscussable(isDiscussable: boolean): void;
     /**
+     * ** DEPRECATED: This will be removed in the next
+     * breaking version **
+     *
      * Return a list of IAssociationInfo objects representing
      * the associations this entity has, to the specified type
      * @param type
@@ -155,12 +158,18 @@ export declare abstract class HubItemEntity<T extends IHubItemEntity> implements
      */
     listAssociations(type: AssociationType): IAssociationInfo[];
     /**
+     * ** DEPRECATED: please use requestAssociation instead.
+     * This will be removed in the next breaking version **
+     *
      * Add an association to this entity
      * @param info
      * @returns
      */
     addAssociation(info: IAssociationInfo): void;
     /**
+     * ** DEPRECATED: please use breakAssociation instead.
+     * This will be removed in the next breaking version **
+     *
      * Remove an association from this entity
      * @param info
      * @returns

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

@@ -4,17 +4,26 @@ import { AssociationType, IAssociationInfo } from "../../associations/types";
  */
 export interface IWithAssociationBehavior {
     /**
+     * ** DEPRECATED: This will be removed in the next
+     * breaking version **
+     *
      * Get a list of the associations for an AssociationType
      * @param type
      */
     listAssociations(type: AssociationType): IAssociationInfo[];
     /**
+     * ** DEPRECATED: please use requestAssociation directly.
+     * This will be removed in the next breaking version **
+     *
      * Add an association to the entity.
      * Entity needs to be saved after calling this method
      * @param info
      */
     addAssociation(info: IAssociationInfo): void;
     /**
+     * ** DEPRECATED: please use breakAssociation directly.
+     * This will be removed in the next breaking version **
+     *
      * Remove an association to the entity.
      * Entity needs to be saved after calling this method
      * @param info

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

@@ -0,0 +1,10 @@
+import { HubEntityType } from "./types";
+/**
+ * return the item type(s) associated with a provided
+ * Hub entity type. This is effectively the reverse of
+ * getTypeFromEntity
+ *
+ * @param entityType - the hub entity type
+ * @returns {string[]}
+ */
+export declare const getTypesFromEntityType: (entityType: HubEntityType) => string[];

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

@@ -5,6 +5,7 @@ export * from "./schemas";
 export * from "./fetchHubEntity";
 export * from "./getEntityDefaultWorkspacePane";
 export * from "./getTypeFromEntity";
+export * from "./getTypesFromEntityType";
 export * from "./getRelativeWorkspaceUrl";
 export * from "./isValidEntityType";
 export * from "./processActionLinks";

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

@@ -1,4 +1,17 @@
+import { IHubAssociationRules } from "../../associations";
+/** properties for entities with associations */
 export interface IWithAssociations {
+    associations?: {
+        /**
+         * association group id - this is exposed as
+         * its own property for convenience. It is
+         * also included in the association rules
+         * query as a group predicate.
+         */
+        groupId: string;
+        /** association rules */
+        rules: IHubAssociationRules;
+    };
     typeKeywords?: string[];
     [key: string]: any;
 }

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

@@ -62,6 +62,9 @@ export declare function convertItemToInitiative(item: IItem, requestOptions: IRe
  */
 export declare function enrichInitiativeSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
 /**
+ * ** DEPRECATED: Please use the association methods directly.
+ * This will be removed in the next breaking version **
+ *
  * 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.
@@ -72,6 +75,9 @@ export declare function enrichInitiativeSearchResult(item: IItem, include: strin
  */
 export declare function fetchAcceptedProjects(initiative: IHubInitiative, requestOptions: IHubRequestOptions, query?: IQuery): Promise<IEntityInfo[]>;
 /**
+ * ** DEPRECATED: Please use the association methods directly.
+ * This will be removed in the next breaking version **
+ *
  * 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
@@ -82,6 +88,9 @@ export declare function fetchAcceptedProjects(initiative: IHubInitiative, reques
  */
 export declare function fetchPendingProjects(initiative: IHubInitiative, requestOptions: IHubRequestOptions, query?: IQuery): Promise<IEntityInfo[]>;
 /**
+ * ** DEPRECATED: Please use the association methods directly.
+ * This will be removed in the next breaking version **
+ *
  * 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"
@@ -90,6 +99,9 @@ export declare function fetchPendingProjects(initiative: IHubInitiative, request
  */
 export declare function getAcceptedProjectsQuery(initiative: IHubInitiative): IQuery;
 /**
+ * ** DEPRECATED: Please use the association methods directly.
+ * This will be removed in the next breaking version **
+ *
  * 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

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

@@ -0,0 +1,2 @@
+import { IHubAssociationHierarchy } from "../../associations/types";
+export declare const InitiativeAssociationHierarchies: IHubAssociationHierarchy;

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

@@ -8,7 +8,7 @@ export declare const InitiativeDefaultFeatures: IFeatureFlags;
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-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", "hub:initiative:workspace", "hub:initiative:workspace:overview", "hub:initiative:workspace:dashboard", "hub:initiative:workspace:details", "hub:initiative:workspace:settings", "hub:initiative:workspace:collaborators", "hub:initiative:workspace:content", "hub:initiative:workspace:metrics", "hub:initiative:manage"];
+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", "hub:initiative:workspace", "hub:initiative:workspace:overview", "hub:initiative:workspace:dashboard", "hub:initiative:workspace:details", "hub:initiative:workspace:projects", "hub:initiative:workspace:projects:member", "hub:initiative:workspace:projects:manager", "hub:initiative:workspace:settings", "hub:initiative:workspace:collaborators", "hub:initiative:workspace:content", "hub:initiative:workspace:metrics", "hub:initiative:manage"];
 /**
  * Initiative permission policies
  * @private

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

@@ -0,0 +1,2 @@
+import { IHubAssociationHierarchy } from "../../associations/types";
+export declare const ProjectAssociationHierarchies: IHubAssociationHierarchy;

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

@@ -8,7 +8,7 @@ export declare const ProjectDefaultFeatures: IFeatureFlags;
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-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", "hub:project:workspace", "hub:project:workspace:overview", "hub:project:workspace:dashboard", "hub:project:workspace:details", "hub:project:workspace:settings", "hub:project:workspace:collaborators", "hub:project:workspace:content", "hub:project:workspace:metrics", "hub:project:workspace:metrics-coming-soon", "hub:project:manage"];
+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", "hub:project:workspace", "hub:project:workspace:overview", "hub:project:workspace:dashboard", "hub:project:workspace:details", "hub:project:workspace:initiatives", "hub:project:workspace:settings", "hub:project:workspace:collaborators", "hub:project:workspace:content", "hub:project:workspace:metrics", "hub:project:workspace:metrics-coming-soon", "hub:project:manage"];
 /**
  * Project permission policies
  * @private

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

@@ -30,6 +30,9 @@ export declare function convertItemToProject(item: IItem, requestOptions: IReque
  */
 export declare function enrichProjectSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
 /**
+ * ** DEPRECATED: Please use the association methods directly.
+ * This will be removed in the next breaking version **
+ *
  * 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`.

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

@@ -0,0 +1,12 @@
+import { EntityType, IFilter, IHubCatalog, IHubCollection } from "../types";
+/**
+ * Build an IHubCatalog definition JSON object based on a
+ * well-known catalog name, scope filters, and collections
+ *
+ * @param i18nScope - i18n scope for the catalog title
+ * @param catalogName - well known catalog name
+ * @param filters - filters to build the catalog scope
+ * @param collections - collections to include in the catalog
+ * @returns {IHubCatalog}
+ */
+export declare function buildCatalog(i18nScope: string, catalogName: string, filters: IFilter[], collections: IHubCollection[], targetEntity: EntityType): IHubCatalog;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.74.2",
+  "version": "14.75.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/associations/internal/getTargetEntityFromAssociationType.js

@@ -1,18 +0,0 @@
-/**
- * Get the entity item type for an association type
- * @param type
- * @returns
- */
-export function getTargetEntityFromAssociationType(type) {
-    let entityType = "item";
-    switch (type) {
-        case "initiative":
-            entityType = "item";
-            break;
-        // as we add more association types we need to extend this hash
-        default:
-            throw new Error(`getTargetEntityFromAssociationType: Invalid association type ${type}.`);
-    }
-    return entityType;
-}
-//# sourceMappingURL=getTargetEntityFromAssociationType.js.map

package/dist/esm/associations/internal/getTargetEntityFromAssociationType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getTargetEntityFromAssociationType.js","sourceRoot":"","sources":["../../../../src/associations/internal/getTargetEntityFromAssociationType.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAChD,IAAqB;IAErB,IAAI,UAAU,GAAe,MAAM,CAAC;IAEpC,QAAQ,IAAI,EAAE;QACZ,KAAK,YAAY;YACf,UAAU,GAAG,MAAM,CAAC;YACpB,MAAM;QACR,+DAA+D;QAC/D;YACE,MAAM,IAAI,KAAK,CACb,gEAAgE,IAAI,GAAG,CACxE,CAAC;KACL;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}