@esri/hub-common 14.74.1 → 14.75.0

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.1",
+  "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"}

package/dist/esm/associations/internal/getTypeFromAssociationType.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"getTypeFromAssociationType.js","sourceRoot":"","sources":["../../../../src/associations/internal/getTypeFromAssociationType.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAAqB;IAC9D,IAAI,QAAQ,GAAG,gBAAgB,CAAC;IAChC,QAAQ,IAAI,EAAE;QACZ,KAAK,YAAY;YACf,QAAQ,GAAG,gBAAgB,CAAC;YAC5B,MAAM;QACR,+DAA+D;QAC/D;YACE,MAAM,IAAI,KAAK,CACb,wDAAwD,IAAI,GAAG,CAChE,CAAC;KACL;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/node/associations/internal/getTargetEntityFromAssociationType.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTargetEntityFromAssociationType = void 0;
-/**
- * Get the entity item type for an association type
- * @param type
- * @returns
- */
-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;
-}
-exports.getTargetEntityFromAssociationType = getTargetEntityFromAssociationType;
-//# sourceMappingURL=getTargetEntityFromAssociationType.js.map

package/dist/node/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,SAAgB,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;AAhBD,gFAgBC"}

package/dist/node/associations/internal/getTypeFromAssociationType.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypeFromAssociationType = void 0;
-/**
- * Get the item type for an association type
- * @param type
- * @returns
- */
-function getTypeFromAssociationType(type) {
-    let itemType = "Hub Initiative";
-    switch (type) {
-        case "initiative":
-            itemType = "Hub Initiative";
-            break;
-        // as we add more association types we need to extend this hash
-        default:
-            throw new Error(`getTypeFromAssociationType: Invalid association type ${type}.`);
-    }
-    return itemType;
-}
-exports.getTypeFromAssociationType = getTypeFromAssociationType;
-//# sourceMappingURL=getTypeFromAssociationType.js.map

package/dist/node/associations/internal/getTypeFromAssociationType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getTypeFromAssociationType.js","sourceRoot":"","sources":["../../../../src/associations/internal/getTypeFromAssociationType.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,SAAgB,0BAA0B,CAAC,IAAqB;IAC9D,IAAI,QAAQ,GAAG,gBAAgB,CAAC;IAChC,QAAQ,IAAI,EAAE;QACZ,KAAK,YAAY;YACf,QAAQ,GAAG,gBAAgB,CAAC;YAC5B,MAAM;QACR,+DAA+D;QAC/D;YACE,MAAM,IAAI,KAAK,CACb,wDAAwD,IAAI,GAAG,CAChE,CAAC;KACL;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAbD,gEAaC"}

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

@@ -1,8 +0,0 @@
-import { EntityType } from "../../search/types/IHubCatalog";
-import { AssociationType } from "../types";
-/**
- * Get the entity item type for an association type
- * @param type
- * @returns
- */
-export declare function getTargetEntityFromAssociationType(type: AssociationType): EntityType;

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

@@ -1,7 +0,0 @@
-import { AssociationType } from "../types";
-/**
- * Get the item type for an association type
- * @param type
- * @returns
- */
-export declare function getTypeFromAssociationType(type: AssociationType): string;