@esri/hub-common 14.15.0 → 14.17.0

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

@@ -76,43 +76,6 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     viewDefinition?: {
         definitionExpression?: string;
     };
-    source?: string;
-    summary?: string;
-    view?: import("../../core").IWithViewSettings;
-    owner: string;
-    url?: string;
-    id: string;
-    canEdit: boolean;
-    access?: import("../../core").AccessLevel;
-    culture?: string;
-    description?: string;
-    extent?: number[][];
-    itemControl: string;
-    tags: string[];
-    thumbnailUrl?: string;
-    thumbnail?: string;
-    typeKeywords?: string[];
-    canDelete: boolean;
-    location?: import("../../core").IHubLocation;
-    orgId?: string;
-    protected?: boolean;
-    name: string;
-    createdDate: Date;
-    createdDateSource: string;
-    updatedDate: Date;
-    updatedDateSource: string;
-    type: string;
-    links?: {
-        [key: string]: string | import("../../core").ILink;
-        thumbnail?: string;
-        self: string;
-        siteRelative?: string;
-        workspaceRelative?: string;
-        layoutRelative?: string;
-    };
-    features?: import("../..").IFeatureFlags;
-    isDiscussable?: boolean;
-    followersGroupId?: string;
     statistics?: any;
     data?: {
         [propName: string]: any;
@@ -126,15 +89,25 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     layers?: Partial<ILayerDefinition>[];
     recordCount?: number;
     servicesDirectoryDisabled?: boolean;
+    id: string;
+    owner: string;
+    tags: string[];
     created: number;
     modified: number;
     numViews: number;
     size: number;
+    protected?: boolean;
     title: string;
+    type: string;
+    typeKeywords?: string[];
+    description?: string;
     snippet?: string;
     documentation?: string;
+    extent?: number[][];
     spatialReference?: ISpatialReference;
+    culture?: string;
     properties?: any;
+    url?: string;
 };
 /**
  * get a content's boundary based on the item's boundary property

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

@@ -1,15 +1,16 @@
 import { IGroup } from "@esri/arcgis-rest-portal";
 import { IArcGISContext } from "../ArcGISContext";
 import { IPermissionAccessResponse, IEntityPermissionPolicy, Permission } from "../permissions";
-import { IWithSharingBehavior, IWithStoreBehavior, IWithFeaturedImageBehavior, IWithPermissionBehavior } from "./behaviors";
+import { IWithSharingBehavior, IWithStoreBehavior, IWithFeaturedImageBehavior, IWithPermissionBehavior, IWithAssociationBehavior } from "./behaviors";
 import { IWithThumbnailBehavior } from "./behaviors/IWithThumbnailBehavior";
 import { IHubItemEntity, SettableAccessLevel } from "./types";
 import { IWithDiscussionsBehavior } from "./behaviors/IWithDiscussionsBehavior";
 import { IWithFollowersBehavior } from "./behaviors/IWithFollowersBehavior";
+import { AssociationType, IAssociationInfo } from "../associations/types";
 /**
  * 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, IWithFollowersBehavior {
+export declare abstract class HubItemEntity<T extends IHubItemEntity> implements IWithStoreBehavior<T>, IWithSharingBehavior, IWithThumbnailBehavior, IWithFeaturedImageBehavior, IWithPermissionBehavior, IWithDiscussionsBehavior, IWithFollowersBehavior, IWithAssociationBehavior {
     protected context: IArcGISContext;
     protected entity: T;
     protected isDestroyed: boolean;
@@ -141,4 +142,23 @@ export declare abstract class HubItemEntity<T extends IHubItemEntity> implements
      * @param isDiscussable whether to enable or disable discussions
      */
     updateIsDiscussable(isDiscussable: boolean): void;
+    /**
+     * Return a list of IAssociationInfo objects representing
+     * the associations this entity has, to the specified type
+     * @param type
+     * @returns
+     */
+    listAssociations(type: AssociationType): IAssociationInfo[];
+    /**
+     * Add an association to this entity
+     * @param info
+     * @returns
+     */
+    addAssociation(info: IAssociationInfo): void;
+    /**
+     * Remove an association from this entity
+     * @param info
+     * @returns
+     */
+    removeAssociation(info: IAssociationInfo): void;
 }

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

@@ -0,0 +1,23 @@
+import { AssociationType, IAssociationInfo } from "../../associations/types";
+/**
+ * Composable behavior that adds permissions to an entity
+ */
+export interface IWithAssociationBehavior {
+    /**
+     * Get a list of the associations for an AssociationType
+     * @param type
+     */
+    listAssociations(type: AssociationType): IAssociationInfo[];
+    /**
+     * Add an association to the entity.
+     * Entity needs to be saved after calling this method
+     * @param info
+     */
+    addAssociation(info: IAssociationInfo): void;
+    /**
+     * Remove an association to the entity.
+     * Entity needs to be saved after calling this method
+     * @param info
+     */
+    removeAssociation(info: IAssociationInfo): void;
+}

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

@@ -6,3 +6,4 @@ export * from "./IWithEditorBehavior";
 export * from "./IWithFeaturedImageBehavior";
 export * from "./IWithVersioningBehavior";
 export * from "./IWithCardBehavior";
+export * from "./IWIthAssociationBehavior";

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

@@ -14,4 +14,3 @@ import { IHubLocationOption } from "../../types/IHubLocation";
  * location
  */
 export declare function getLocationOptions(entity: ConfigurableEntity, portalName: string, hubRequestOptions: IHubRequestOptions): Promise<IHubLocationOption[]>;
-export declare function getDefaultLocationOptions(entity: ConfigurableEntity, portalName: string, hubRequestOptions: IHubRequestOptions): Promise<IHubLocationOption[]>;

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/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

@@ -4,10 +4,11 @@ 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, IWithFollowers {
+export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions, IWithFollowers, IWithAssociations {
     /**
      * Access level of the item ("private" | "org" | "public")
      */

package/dist/types/discussions/api/types.d.ts

@@ -735,6 +735,7 @@ export interface ICreateChannelPermissions {
 export interface IUpdateChannelPermissions {
     access?: SharingAccess;
     allowAnonymous?: boolean;
+    groups?: string[];
 }
 /**
  * permissions and settings options for creating a channel

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/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.15.0",
+  "version": "14.17.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",