@esri/hub-common 20.8.1 → 20.10.0

package/dist/types/events/_internal/computeLinks.d.ts

@@ -1,5 +1,5 @@
-import { IHubEntityLinks } from "../../core/types";
 import { IEvent } from "../api/orval/api/orval-events";
+import { IHubEntityLinks } from "../../core/types/IHubEntityBase";
 /**
  * Compute the links that get appended to a Hub Event
  * search result and entity

package/dist/types/events/_internal/eventEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type EventEditorType = (typeof EventEditorTypes)[number];
+export declare const EventEditorTypes: readonly ["hub:event:create", "hub:event:edit", "hub:event:registrants"];

package/dist/types/events/edit.d.ts

@@ -1,6 +1,6 @@
 import { IHubEvent } from "../core/types/IHubEvent";
 import { IHubRequestOptions } from "../hub-types";
-import { EventAttendanceType, IRegistration, RegistrationRole } from "./api";
+import { RegistrationRole, EventAttendanceType, IRegistration } from "./api/types";
 export interface IHubCreateEventRegistration {
     eventId: string;
     role: RegistrationRole;

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

@@ -1,12 +1,14 @@
 import { IHubGroup, IHubGroupEditor } from "../core/types/IHubGroup";
-import { IEntityPermissionPolicy, IPermissionAccessResponse, Permission } from "../permissions";
 import { IWithStoreBehavior } from "../core/behaviors/IWithStoreBehavior";
 import { IWithPermissionBehavior } from "../core/behaviors/IWithPermissionBehavior";
 import type { IArcGISContext } from "../types/IArcGISContext";
 import { IEditorConfig } from "../core/schemas/types";
 import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
-import { GroupEditorType } from "./_internal/GroupSchema";
-import { IEntityEditorContext } from "../core";
+import { GroupEditorType } from "./_internal/groupEditorTypes";
+import { IEntityEditorContext } from "../core/types/HubEntityEditor";
+import { IEntityPermissionPolicy } from "../permissions/types/IEntityPermissionPolicy";
+import { IPermissionAccessResponse } from "../permissions/types/IPermissionAccessResponse";
+import { Permission } from "../permissions/types/Permission";
 /**
  * Hub Group Class
  */

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

@@ -1,17 +1,7 @@
-import type { IGroup } from "@esri/arcgis-rest-portal";
-import { IHubRequestOptions } from "../hub-types";
 import { IHubGroup } from "../core/types/IHubGroup";
 import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
-import { IHubSearchResult } from "../search/types/IHubSearchResult";
-import { IArcGISContext } from "../types";
-/**
- * Enrich a generic search result
- * @param group
- * @param includes
- * @param requestOptions
- * @returns
- */
-export declare function enrichGroupSearchResult(group: IGroup, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
+import { IArcGISContext } from "../types/IArcGISContext";
+import { IHubRequestOptions } from "../hub-types";
 /**
  * Create a new Hub Group
  * we are creating an IGroup with the createGroup call

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

@@ -1,4 +1,4 @@
-import { IPermissionPolicy } from "../../permissions";
+import { IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
 /**
  * Group permission policies
  * @private

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

@@ -1,6 +1,4 @@
-import { IConfigurationSchema } from "../../core";
-export declare type GroupEditorType = (typeof GroupEditorTypes)[number];
-export declare const GroupEditorTypes: readonly ["hub:group:edit", "hub:group:settings", "hub:group:settings:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create"];
+import { IConfigurationSchema } from "../../core/schemas/types";
 /**
  * Defines the JSON schema for a Hub Group's editable fields
  */

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

@@ -1,7 +1,7 @@
 import { IConfigurationValues, IUiSchema } from "../../core/schemas/types";
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
-import { IHubGroup } from "../../core";
+import { IHubGroup } from "../../core/types/IHubGroup";
 /**
  * @private
  * constructs the complete uiSchema for creating a view

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

@@ -7,7 +7,7 @@ import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
  * group. This defines how the schema properties should be
  * rendered in the edit group creation experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
 /**
  * @private
  * constructs the default values for creating an edit group.
@@ -18,4 +18,4 @@ export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOpt
  * @param context
  * @returns
  */
-export declare const buildDefaults: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;
+export declare const buildDefaults: (_i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;

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

@@ -7,7 +7,7 @@ import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
  * group. This defines how the schema properties should be
  * rendered in the follower group creation experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, _context: IArcGISContext) => Promise<IUiSchema>;
 /**
  * @private
  * constructs the default values for creating a followers group.
@@ -18,4 +18,4 @@ export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOpt
  * @param context
  * @returns
  */
-export declare const buildDefaults: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;
+export declare const buildDefaults: (_i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;

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

@@ -7,7 +7,7 @@ import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
  * group. This defines how the schema properties should be
  * rendered in the view group creation experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;
 /**
  * @private
  * constructs the default values for creating a view group.
@@ -18,4 +18,4 @@ export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOpt
  * @param context
  * @returns
  */
-export declare const buildDefaults: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;
+export declare const buildDefaults: (_i18nScope: string, _options: EntityEditorOptions, context: IArcGISContext) => Promise<IConfigurationValues>;

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

@@ -0,0 +1,10 @@
+import type { IArcGISContext } from "../../types/IArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
+/**
+ * @private
+ * settings uiSchema for Hub Discussions - this
+ * defines how the schema properties should be
+ * rendered in the Discussions settings experience
+ */
+export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -1,4 +1,5 @@
-import { IHubGroup, IUiSchema } from "../../core";
+import { IUiSchema } from "../../core/schemas/types";
+import { IHubGroup } from "../../core/types/IHubGroup";
 import type { IArcGISContext } from "../../types/IArcGISContext";
 /**
  * @private
@@ -6,4 +7,4 @@ import type { IArcGISContext } from "../../types/IArcGISContext";
  * This defines how the schema properties should be
  * rendered in the group settings experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubGroup>, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubGroup>, _context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -1,6 +1,6 @@
 import type { IGroup } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IHubEntityLinks } from "../../core/types";
+import { IHubEntityLinks } from "../../core/types/IHubEntityBase";
 /**
  * Compute the links that get appended to a Hub Group
  * search result and entity

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

@@ -1,7 +1,7 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubGroup } from "../../core/types/IHubGroup";
 import type { IGroup } from "@esri/arcgis-rest-portal";
-import { IEntitySetting } from "../../discussions";
+import { IEntitySetting } from "../../discussions/api/types";
 /**
  * Given a model and a group, set various computed properties that can't be directly mapped
  * @private

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

@@ -1,6 +1,6 @@
 import { IGroup, GroupMembership } from "@esri/arcgis-rest-portal";
 import { IEnrichmentErrorInfo, IHubRequestOptions } from "../../hub-types";
-import { IGroupMembershipSummary } from "../types";
+import { IGroupMembershipSummary } from "../types/IGroupMembershipSummary";
 /**
  * Possible additional properties available through enrichments
  */

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

@@ -0,0 +1,2 @@
+export declare type GroupEditorType = (typeof GroupEditorTypes)[number];
+export declare const GroupEditorTypes: readonly ["hub:group:edit", "hub:group:settings", "hub:group:settings:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create"];

package/dist/types/groups/add-users-workflow/add-users-to-group.d.ts

@@ -1,7 +1,7 @@
 import { IUser } from "@esri/arcgis-rest-portal";
 import { IHubRequestOptions } from "../../hub-types";
 import { IConsolidatedResult } from "./interfaces";
-import { IEmail } from "../types";
+import { IEmail } from "../types/types";
 /**
  * Adds, invites or emails users about joining a group
  * based on the permissions of the requesting user. The

package/dist/types/groups/add-users-workflow/interfaces.d.ts

@@ -1,7 +1,7 @@
 import { ICreateOrgNotificationResult, IInviteGroupUsersResult, IUser } from "@esri/arcgis-rest-portal";
 import { ArcGISRequestError } from "@esri/arcgis-rest-request";
 import { IHubRequestOptions } from "../../hub-types";
-import { IEmail } from "../types";
+import { IEmail } from "../types/types";
 export interface IConsolidatedResult {
     success: boolean;
     autoAdd?: ISimpleResult;

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

@@ -1,5 +1,5 @@
-import { IAddGroupMembersResult } from "./types";
 import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
+import { IAddGroupMembersResult } from "./types/types";
 /**
  * Add or invite N users to a single group.
  * If autoAdd is true (if the user doing the adding has the 'portal:admin:assignToGroups' priv)

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

@@ -1,7 +1,7 @@
 import type { IUser } from "@esri/arcgis-rest-portal";
 import { ICreateOrgNotificationResult } from "@esri/arcgis-rest-portal";
 import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-import { IEmail } from "./types";
+import { IEmail } from "./types/types";
 /**
  * Attempts to email members of the requesting user's organization.
  *

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

@@ -0,0 +1,11 @@
+import type { IGroup } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../hub-types";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
+/**
+ * Enrich a generic search result
+ * @param group
+ * @param includes
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichGroupSearchResult(group: IGroup, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

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

@@ -9,3 +9,4 @@ export * from "./isOpenDataGroup";
 export * from "./autoAddUsers";
 export * from "./inviteUsers";
 export * from "./emailOrgUsers";
+export * from "./enrichGroupSearchResult";

package/dist/types/index.d.ts

@@ -39,22 +39,6 @@ export * from "./util";
 export * from "./utils";
 export * from "./versioning";
 export * from "./metrics";
-export * from "./core/updateHubEntity";
-export * from "./urls/getCardModelUrl";
-export * from "./core/EntityEditor";
-export * from "./search/explainQueryResult";
-export * from "./search/getCatalogGroups";
-export * from "./search/getPredicateValues";
-export * from "./search/getUserGroupsByMembership";
-export * from "./search/getUserGroupsFromQuery";
-export * from "./search/negateGroupPredicates";
-export * from "./search/searchCatalogs";
-export * from "./search/searchEntityCatalogs";
-export * from "./core/hubHistory";
-export * from "./core/deepCatalogContains";
-export * from "./core/parseContainmentPath";
-export * from "./core/catalogContains";
-export * from "./core/schemas/internal/fetchCategoriesUiSchemaElement";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/initiative-templates/HubInitiativeTemplate.d.ts

@@ -1,10 +1,15 @@
 import { HubItemEntity } from "../core/HubItemEntity";
-import { IHubInitiativeTemplate, IWithCatalogBehavior, IWithCardBehavior, IConvertToCardModelOpts, IHubCardViewModel, IEntityEditorContext, IHubInitiativeTemplateEditor, HubEntity } from "../core";
 import { IEditorConfig } from "../core/schemas/types";
 import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
 import type { IArcGISContext } from "../types/IArcGISContext";
 import { Catalog } from "../search/Catalog";
-import { InitiativeTemplateEditorType } from "./_internal/InitiativeTemplateSchema";
+import { InitiativeTemplateEditorType } from "./_internal/initiativeTemplateEditorTypes";
+import { IWithCardBehavior } from "../core/behaviors/IWithCardBehavior";
+import { IWithCatalogBehavior } from "../core/behaviors/IWithCatalogBehavior";
+import { HubEntity } from "../core/types/HubEntity";
+import { IEntityEditorContext } from "../core/types/HubEntityEditor";
+import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+import { IHubInitiativeTemplate, IHubInitiativeTemplateEditor } from "../core/types/IHubInitiativeTemplate";
 /**
  * Hub Initiative Template Class
  */

package/dist/types/initiative-templates/_internal/InitiativeTemplateBusinessRules.d.ts

@@ -1,4 +1,4 @@
-import { IFeatureFlags, IPermissionPolicy } from "../../permissions";
+import { IFeatureFlags, IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
 /**
  * Default features for an Initiative Template. These are the features that can be enabled / disabled by the entity owner
  */

package/dist/types/initiative-templates/_internal/InitiativeTemplateSchema.d.ts

@@ -1,4 +1,2 @@
-import { IConfigurationSchema } from "../../core";
-export declare type InitiativeTemplateEditorType = (typeof InitiativeTemplateEditorTypes)[number];
-export declare const InitiativeTemplateEditorTypes: readonly ["hub:initiativeTemplate:edit"];
+import { IConfigurationSchema } from "../../core/schemas/types";
 export declare const InitiativeTemplateSchema: IConfigurationSchema;

package/dist/types/initiative-templates/_internal/InitiativeTemplateUiSchemaEdit.d.ts

@@ -1,6 +1,6 @@
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
-import { IHubInitiativeTemplate } from "../../core";
+import { IHubInitiativeTemplate } from "../../core/types/IHubInitiativeTemplate";
 /**
  * @private
  * constructs the complete edit uiSchema for Hub Initiative Templates.

package/dist/types/initiative-templates/_internal/computeLinks.d.ts

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import type { IItem } from "@esri/arcgis-rest-portal";
-import { IHubEntityLinks } from "../../core";
+import { IHubEntityLinks } from "../../core/types/IHubEntityBase";
 /**
  * Compute the links that get appended to a Hub Initiative Template
  * search result and entity

package/dist/types/initiative-templates/_internal/computeProps.d.ts

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IHubInitiativeTemplate } from "../../core";
 import { IModel } from "../../hub-types";
+import { IHubInitiativeTemplate } from "../../core/types/IHubInitiativeTemplate";
 /**
  * Given a model and an initiative template, set various computed properties that can't be directly mapped
  * @private

package/dist/types/initiative-templates/_internal/getRecommendedTemplatesCatalog.d.ts

@@ -1,2 +1,2 @@
 import type { IUser } from "@esri/arcgis-rest-portal";
-export declare const getRecommendedTemplatesCatalog: (user: IUser, i18nScope: string) => import("../../search").IHubCatalog[];
+export declare const getRecommendedTemplatesCatalog: (user: IUser, i18nScope: string) => import("../../search/types/IHubCatalog").IHubCatalog[];

package/dist/types/initiative-templates/_internal/initiativeTemplateEditorTypes.d.ts

@@ -0,0 +1,2 @@
+export declare type InitiativeTemplateEditorType = (typeof InitiativeTemplateEditorTypes)[number];
+export declare const InitiativeTemplateEditorTypes: readonly ["hub:initiativeTemplate:edit"];

package/dist/types/initiative-templates/fetch.d.ts

@@ -1,8 +1,8 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-portal";
-import { IHubInitiativeTemplate } from "../core/types";
-import { IHubSearchResult } from "../search";
 import { IHubRequestOptions } from "../hub-types";
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
 export declare function fetchInitiativeTemplate(identifier: string, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
 /**
  * @private

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

@@ -2,11 +2,17 @@ import { IEntityEditorContext } from "../core/types/HubEntityEditor";
 import { Catalog } from "../search/Catalog";
 import type { IArcGISContext } from "../types/IArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
-import { InitiativeEditorType } from "./_internal/InitiativeSchema";
+import { InitiativeEditorType } from "./_internal/initiativeEditorTypes";
 import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
 import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
-import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, IResolvedMetric, IWithCardBehavior, IWithEditorBehavior, IHubInitiativeEditor } from "../core";
 import { IEditorConfig } from "../core/schemas/types";
+import { IWithCardBehavior } from "../core/behaviors/IWithCardBehavior";
+import { IWithCatalogBehavior } from "../core/behaviors/IWithCatalogBehavior";
+import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { IWithSharingBehavior } from "../core/behaviors/IWithSharingBehavior";
+import { IWithStoreBehavior } from "../core/behaviors/IWithStoreBehavior";
+import { IHubInitiative, IHubInitiativeEditor } from "../core/types/IHubInitiative";
+import { IResolvedMetric } from "../core/types/Metrics";
 /**
  * Hub Initiative Class
  */

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

@@ -2,9 +2,9 @@ import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
 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 { IHubSearchResult } from "../search";
 import { IHubRequestOptions } from "../hub-types";
+import { IHubInitiative } from "../core/types/IHubInitiative";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
 /**
  * @private
  * Create a new Hub Initiative item

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

@@ -1,4 +1,4 @@
-import { IFeatureFlags, IPermissionPolicy } from "../../permissions";
+import { IFeatureFlags, IPermissionPolicy } from "../../permissions/types/IPermissionPolicy";
 /**
  * Default features for a Initiative. These are the features that can be enabled / disabled by the entity owner
  */

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

@@ -1,6 +1,4 @@
-import { IConfigurationSchema } from "../../core";
-export declare type InitiativeEditorType = (typeof InitiativeEditorTypes)[number];
-export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings"];
+import { IConfigurationSchema } from "../../core/schemas/types";
 /**
  * defines the JSON schema for a Hub Initiative's editable fields
  */

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

@@ -1,10 +1,10 @@
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
-import { IHubInitiative } from "../../core/types";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * @private
  * constructs the minimal association group settings uiSchema for Hub Initiatives.
  * This defines how the schema properties should be rendered
  * in the initiative creation experience
  */
-export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubInitiative>, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: Partial<IHubInitiative>, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -1,6 +1,6 @@
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
-import { IHubInitiative } from "../../core/types";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * @private
  * constructs the minimal create uiSchema for Hub Initiatives.

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

@@ -1,6 +1,6 @@
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
-import { IHubInitiative } from "../../core/types";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * @private
  * constructs the minimal create uiSchema for Hub Initiatives.

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

@@ -1,6 +1,6 @@
 import { IUiSchema } from "../../core/schemas/types";
 import type { IArcGISContext } from "../../types/IArcGISContext";
-import { IHubInitiative } from "../../core";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * @private
  * constructs the complete edit uiSchema for Hub Initiative.

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

@@ -1,10 +1,10 @@
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { IUiSchema } from "../../core/schemas/types";
-import { IHubInitiative } from "../../core/types";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * @private
  * constructs the settings uiSchema for Hub Initiatives.
  * This defines how the schema should be rendered
  * in the initiative settings pane
  */
-export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubInitiative>, context: IArcGISContext) => Promise<IUiSchema>;
+export declare const buildUiSchema: (i18nScope: string, _options: Partial<IHubInitiative>, _context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import type { IItem } from "@esri/arcgis-rest-portal";
-import { IHubEntityLinks } from "../../core";
+import { IHubEntityLinks } from "../../core/types/IHubEntityBase";
 /**
  * Compute the links that get appended to a Hub Initiative
  * search result and entity

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

@@ -1,6 +1,6 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IModel } from "../../hub-types";
-import { IHubInitiative } from "../../core";
+import { IHubInitiative } from "../../core/types/IHubInitiative";
 /**
  * Given a model and an Initiative, set various computed properties that can't be directly mapped
  * @private

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

@@ -0,0 +1,2 @@
+export declare type InitiativeEditorType = (typeof InitiativeEditorTypes)[number];
+export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings"];

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

@@ -1,4 +1,4 @@
-import { IHubInitiative } from "../core/types";
+import { IHubInitiative } from "../core/types/IHubInitiative";
 import { IModel } from "../hub-types";
 export declare const HUB_INITIATIVE_ITEM_TYPE = "Hub Initiative";
 export declare const HUB_INITIATIVE_CURRENT_SCHEMA_VERSION = 2.2;

package/dist/types/items/_enrichments.d.ts

@@ -1,7 +1,8 @@
 import type { IItem } from "@esri/arcgis-rest-portal";
-import { IItemEnrichments, IServerEnrichments } from "../core";
 import { IEnrichmentErrorInfo, IHubRequestOptions } from "../hub-types";
 import { IHubSchedule } from "../core/types/IHubSchedule";
+import { IItemEnrichments } from "../core/types/IItemEnrichments";
+import { IServerEnrichments } from "../core/types/IServerEnrichments";
 /**
  * An object containing the item and fetched enrichments
  */

package/dist/types/items/_internal/ensureUniqueEntitySlug.d.ts

@@ -1,3 +1,3 @@
-import { IHubItemEntity } from "../../core";
+import { IHubItemEntity } from "../../core/types/IHubItemEntity";
 import { IHubRequestOptions } from "../../hub-types";
 export declare const ensureUniqueEntitySlug: (entity: IHubItemEntity, requestOptions: IHubRequestOptions) => Promise<IHubItemEntity>;

package/dist/types/items/follow.d.ts

@@ -1,7 +1,7 @@
 import { IUser } from "@esri/arcgis-rest-portal";
-import { HubEntityType } from "../core";
 import { IWithFollowers } from "../core/traits/IWithFollowers";
 import type { IArcGISContext } from "../types/IArcGISContext";
+import { HubEntityType } from "../core/types/HubEntityType";
 /**
  * Get the entity's followers group id
  * @param entityId entity id

package/dist/types/metrics/aggregateMetrics.d.ts

@@ -1,5 +1,5 @@
-import { IMetricFeature } from "../core";
 import { DynamicAggregation } from "../core/types/DynamicValues";
+import { IMetricFeature } from "../core/types/Metrics";
 /**
  * Given an array of metrics, aggregate them using the specified aggregation
  * Consumer must be aware of the type of the metrics and pass an appropriate aggregation

package/dist/types/models/createModel.d.ts

@@ -0,0 +1,10 @@
+import type { IUserRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Create an item to back and IModel.
+ *
+ * @param {IModel}
+ * @param {IRequestOptions} requestOptions
+ * @returns {Promise<IModel>}
+ */
+export declare function createModel(model: IModel, requestOptions: IUserRequestOptions): Promise<IModel>;

package/dist/types/models/fetchModelFromItem.d.ts

@@ -0,0 +1,10 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Given an Item, fetch the data json and return an IModel
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function fetchModelFromItem(item: IItem, requestOptions: IRequestOptions): Promise<IModel>;

package/dist/types/models/fetchModelResource.d.ts

@@ -0,0 +1,17 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Given an item, and a list of resource name/prop pairs,
+ * fetch the resources and return as an object for the IModel
+ *
+ * @export
+ * @param {IItem} item
+ * @param {{
+ *     [key: string]: string
+ *   }} resourceNamePairs
+ * @param {IRequestOptions} requestOptions
+ * @return {*}  {Promise<Record<string, any>>}
+ */
+export declare function fetchModelResources(item: IItem, resourceNamePairs: {
+    [key: string]: string;
+}, requestOptions: IRequestOptions): Promise<Record<string, any>>;

package/dist/types/models/getModel.d.ts

@@ -0,0 +1,8 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Gets the full item/data model for an item id
+ * @param {string} id
+ * @param {Object} requestOptions
+ */
+export declare function getModel(id: string, requestOptions: IRequestOptions): Promise<IModel>;

package/dist/types/models/getModelBySlug.d.ts

@@ -0,0 +1,16 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../hub-types";
+/**
+ * Get a model by it's slug
+ *
+ * This uses the [Filter](https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm) option of the
+ * to search for an item that has a typekeyword of `slug|{slug-value}`
+ *
+ * This is useful for applications that want to use human-readable urls instead
+ * of using item ids.
+ *
+ * @param slug
+ * @param requestOptions
+ * @returns
+ */
+export declare function getModelBySlug(slug: string, requestOptions: IRequestOptions): Promise<IModel>;