@esri/hub-common 14.23.0 → 14.25.0

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

@@ -76,6 +76,10 @@ export interface IHubGroup extends IHubEntityBase, IWithPermissions {
      * User configurable tags
      */
     tags?: string[];
+    /**
+     * System configurable typekeywords
+     */
+    typeKeywords?: string[];
     /**
      * Group thumbnail url (read-only)
      */

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

@@ -0,0 +1,14 @@
+import { IHubItemEntity } from "./IHubItemEntity";
+import { IWithLayout, IWithSlug, IWithCatalog } from "../traits";
+import { IHubItemEntityEditor } from "./IHubItemEntity";
+/** Defines the properties of a Hub Initiative Template object */
+export interface IHubInitiativeTemplate extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout {
+    previewUrl: string;
+    recommendedTemplates: string[];
+    siteSolutionId: string;
+}
+/**
+ * This type redefines the IHubInitiativeTemplate interface in such a way
+ * that it can be consumed by the entity editor.
+ */
+export declare type IHubInitiativeTemplateEditor = IHubItemEntityEditor<IHubInitiativeTemplate> & {};

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

@@ -69,4 +69,6 @@ export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWith
     /** Legacy teams - list of ids */
     legacyTeams: string[];
 }
-export declare type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {};
+export declare type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {
+    _discussions?: boolean;
+};

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

@@ -11,6 +11,7 @@ export * from "./IHubEvent";
 export * from "./IHubGroup";
 export * from "./IHubImage";
 export * from "./IHubInitiative";
+export * from "./IHubInitiativeTemplate";
 export * from "./IHubItemEntity";
 export * from "./IHubLayout";
 export * from "./IHubLocation";

package/dist/types/discussions/_internal/DiscussionSchema.d.ts

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core";
 export declare type DiscussionEditorType = (typeof DiscussionEditorTypes)[number];
-export declare const DiscussionEditorTypes: readonly ["hub:discussion:edit", "hub:discussion:create"];
+export declare const DiscussionEditorTypes: readonly ["hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings"];
 /**
  * defines the JSON schema for a Discussion's editable fields
  */

package/dist/types/discussions/_internal/DiscussionUiSchemaSettings.d.ts

@@ -0,0 +1,10 @@
+import { IHubDiscussion } from "../../core/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @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, entity: IHubDiscussion, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -4,7 +4,7 @@ import { IPermissionPolicy } from "../../permissions";
  * These define the requirements any user must meet to perform related actions
  * @private
  */
-export declare const GroupPermissions: readonly ["hub:group", "hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner", "hub:group:workspace:overview", "hub:group:workspace:dashboard", "hub:group:workspace:details", "hub:group:workspace:settings", "hub:group:workspace:collaborators", "hub:group:workspace:content", "hub:group:workspace:members", "hub:group:shareContent", "hub:group:manage"];
+export declare const GroupPermissions: readonly ["hub:group", "hub:group:create", "hub:group:delete", "hub:group:edit", "hub:group:view", "hub:group:owner", "hub:group:workspace:overview", "hub:group:workspace:dashboard", "hub:group:workspace:details", "hub:group:workspace:discussion", "hub:group:workspace:settings", "hub:group:workspace:collaborators", "hub:group:workspace:content", "hub:group:workspace:members", "hub:group:shareContent", "hub:group:manage"];
 /**
  * Group permission policies
  * @private

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

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

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

@@ -0,0 +1,10 @@
+import { IHubGroup } from "../../core/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @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, entity: IHubGroup, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ export * from "./extent";
 export * from "./groups";
 export * from "./i18n";
 export * from "./initiatives";
+export * from "./initiative-templates";
 export * from "./discussions";
 export * from "./items";
 export * from "./models";

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

@@ -0,0 +1,82 @@
+import { HubItemEntity } from "../core/HubItemEntity";
+import { IHubInitiativeTemplate, IWithCatalogBehavior, IWithCardBehavior, IConvertToCardModelOpts, IHubCardViewModel, IEntityEditorContext, IHubInitiativeTemplateEditor, HubEntity } from "../core";
+import { IEditorConfig, IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { EditorType } from "../core/schemas/types";
+import { IArcGISContext } from "..";
+import { Catalog } from "../search";
+/**
+ * Hub Initiative Template Class
+ */
+export declare class HubInitiativeTemplate extends HubItemEntity<IHubInitiativeTemplate> implements IWithCatalogBehavior, IWithEditorBehavior, IWithCardBehavior {
+    private _catalog;
+    private constructor();
+    get catalog(): Catalog;
+    /**
+     * Create an instance from an IHubInitiativeTemplate object
+     * @param json - JSON object to create a HubInitiativeTemplate from
+     * @param context - ArcGIS context
+     * @returns - instance of HubInitiativeTemplate
+     */
+    static fromJson(json: Partial<IHubInitiativeTemplate>, context: IArcGISContext): HubInitiativeTemplate;
+    /**
+     * Create a new HubInitiativeTemplate, returning a HubInitiativeTemplate instance.
+     * Note: This does not persist the HubInitiativeTemplate into the backing store
+     * @param partialInitiativeTemplate
+     * @param context
+     * @param save
+     * @returns
+     */
+    static create(partialInitiativeTemplate: Partial<IHubInitiativeTemplate>, context: IArcGISContext, save?: boolean): Promise<HubInitiativeTemplate>;
+    /**
+     * Fetch a HubInitiativeTemplate from the backing store and return a HubInitiativeTemplate instance.
+     * @param identifier - Identifier of the initiative template to load
+     * @param context
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubInitiativeTemplate>;
+    /**
+     * Given a partial initiative template, apply defaults to it to ensure that a baseline of properties are set
+     * @param partialInitiativeTemplate
+     * @param context
+     * @returns
+     */
+    private static applyDefaults;
+    /**
+     * Convert the project entity into a card view model that can
+     * be consumed by the suite of hub gallery components
+     * @param opts - view model options
+     * @returns
+     */
+    convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
+    /**
+     * Get the editor config for the HubInitiativeTemplate entity.
+     * @param i18nScope translation scope to be interpolated into the uiSchema
+     * @param type editor type -- corresponds to the returned uiSchema
+     */
+    getEditorConfig(i18nScope: string, type: EditorType): Promise<IEditorConfig>;
+    /**
+     * Return the initiative template as an editor object
+     * @param editorContext
+     */
+    toEditor(editorContext?: IEntityEditorContext, include?: string[]): Promise<IHubInitiativeTemplateEditor>;
+    /**
+     * Load the initiative template from the editor object
+     * @param editor
+     */
+    fromEditor(editor: IHubInitiativeTemplateEditor): Promise<HubEntity>;
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes: Partial<IHubInitiativeTemplate>): void;
+    /**
+     * Save the HubInitiativeTemplate to the backing store.
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubInitiativeTemplate from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    delete(): Promise<void>;
+}

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

@@ -0,0 +1,16 @@
+import { IFeatureFlags, IPermissionPolicy } from "../../permissions";
+/**
+ * Default features for an Initiative Template. These are the features that can be enabled / disabled by the entity owner
+ */
+export declare const InitiativeTemplateDefaultFeatures: IFeatureFlags;
+/**
+ * Initiative Template Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const InitiativeTemplatePermissions: readonly ["hub:initiativeTemplate", "hub:initiativeTemplate:create", "hub:initiativeTemplate:delete", "hub:initiativeTemplate:edit", "hub:initiativeTemplate:view", "hub:initiativeTemplate:workspace:overview", "hub:initiativeTemplate:workspace:details", "hub:initiativeTemplate:workspace:collaborators", "hub:initiativeTemplate:workspace:settings", "hub:initiativeTemplate:manage"];
+/**
+ * Initiative Template policies
+ * @private
+ */
+export declare const InitiativeTemplatePermissionPolicies: IPermissionPolicy[];

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

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

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

@@ -0,0 +1,15 @@
+import { IArcGISContext } from "../..";
+import { IHubInitiativeTemplate } from "../../core";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @private
+ * constructs the complete edit uiSchema for Hub Initiative Templates.
+ * This defines how the schema properties should be rendered
+ * in the initiative template editing experience.
+ *
+ * @param i18nScope
+ * @param entity
+ * @param context
+ * @returns
+ */
+export declare const buildUiSchema: (i18nScope: string, entity: IHubInitiativeTemplate, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-types";
+import { IHubEntityLinks } from "../../core";
+/**
+ * Compute the links that get appended to a Hub Initiative Template
+ * search result and entity
+ *
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function computeLinks(item: IItem, requestOptions: IRequestOptions): IHubEntityLinks;

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

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubInitiativeTemplate } from "../../core";
+import { IModel } from "../../types";
+/**
+ * Given a model and an initiative template, set various computed properties that can't be directly mapped
+ * @private
+ * @param model
+ * @param initiativeTemplate
+ * @param requestOptions
+ * @returns
+ */
+export declare function computeProps(model: IModel, initiativeTemplate: Partial<IHubInitiativeTemplate>, requestOptions: IRequestOptions): IHubInitiativeTemplate;

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

@@ -0,0 +1,7 @@
+import { IPropertyMap } from "../../core/_internal/PropertyMapper";
+/**
+ * @private
+ * Returns an Array of IPropertyMap objects
+ * that define the projection of properties from an IModel to an IHubInitiativeTemplate
+ */
+export declare function getPropertyMap(): IPropertyMap[];

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

@@ -0,0 +1,8 @@
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { IModel } from "../types";
+export declare const HUB_INITIATIVE_TEMPLATE_ITEM_TYPE = "Hub Initiative Template";
+/**
+ * Default values of a IHubInitiativeTemplate
+ */
+export declare const DEFAULT_INITIATIVE_TEMPLATE: Partial<IHubInitiativeTemplate>;
+export declare const DEFAULT_INITIATIVE_TEMPLATE_MODEL: IModel;

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

@@ -0,0 +1,32 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubInitiativeTemplate, IHubInitiativeTemplateEditor } from "../core/types/IHubInitiativeTemplate";
+/**
+ * @private
+ * Create a new Hub Initiative Template item
+ * @param partialInitiativeTemplate
+ * @param requestOptions
+ * @returns
+ */
+export declare function createInitiativeTemplate(partialInitiativeTemplate: Partial<IHubInitiativeTemplate>, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * Convert an IHubInitiativeTemplateEditor back to an IHubInitiativeTemplate
+ * @param editor
+ * @param portal
+ * @returns
+ */
+export declare function editorToInitiativeTemplate(editor: IHubInitiativeTemplateEditor, portal: IPortal): IHubInitiativeTemplate;
+/**
+ * @private
+ * Update a Hub Initiative Template
+ * @param initiativeTemplate
+ * @param requestOptions
+ */
+export declare function updateInitiativeTemplate(initiativeTemplate: IHubInitiativeTemplate, requestOptions: IUserRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Remove a Hub Initiative Template
+ * @param id
+ * @param requestOptions
+ */
+export declare function deleteInitiativeTemplate(id: string, requestOptions: IUserRequestOptions): Promise<void>;

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

@@ -0,0 +1,16 @@
+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 "../types";
+export declare function fetchInitiativeTemplate(identifier: string, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+/**
+ * @private
+ * Convert a Hub Initiative Template Item into a Hub Initiative Template, feching any additional
+ * information that may be required
+ * @param item
+ * @param requestOptions
+ * @returns
+ */
+export declare function convertItemToInitiativeTemplate(item: IItem, requestOptions: IRequestOptions): Promise<IHubInitiativeTemplate>;
+export declare function enrichInitiativeTemplateSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

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

@@ -0,0 +1,4 @@
+export * from "./HubInitiativeTemplate";
+export * from "./edit";
+export * from "./fetch";
+export * from "./view";

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

@@ -0,0 +1,20 @@
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
+import { ResultToCardModelFn, EntityToCardModelFn } from "../core/types/IHubCardViewModel";
+/**
+ * Convert an initiative template entity into a card view model that can
+ * be consumed by the suite of hub gallery components
+ *
+ * @param initiativeTemplate initiative template entity
+ * @param context auth & portal information
+ * @param opts view model options
+ * @returns
+ */
+export declare const initiativeTemplateToCardModel: EntityToCardModelFn<IHubInitiativeTemplate>;
+/**
+ * Convert an initiative template hub search result into a card view model that
+ * can be consumed by the suite of hub gallery components
+ *
+ * @param searchResult hub initiative template search result
+ * @param opts view model options
+ */
+export declare const initiativeTemplateResultToCardModel: ResultToCardModelFn;

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

@@ -6,6 +6,7 @@ import { ContentPermissions } from "../../content/_internal/ContentBusinessRules
 import { GroupPermissions } from "../../groups/_internal/GroupBusinessRules";
 import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
 import { PlatformPermissions } from "../PlatformPermissionPolicies";
+import { InitiativeTemplatePermissions } from "../../initiative-templates/_internal/InitiativeTemplateBusinessRules";
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -15,7 +16,7 @@ declare const TempPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-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] | (typeof DiscussionPermissions)[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] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number];
 /**
  * Validate a Permission
  * @param permission

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: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"];
+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:feature: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:workspace:discussion", "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", "hub:site:followers"];
+export declare const SiteEditorTypes: readonly ["hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions"];
 /**
  * defines the JSON schema for a Hub Site's editable fields
  */

package/dist/types/sites/_internal/SiteUiSchemaDiscussions.d.ts

@@ -0,0 +1,10 @@
+import { IHubSite } from "../../core/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @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, entity: IHubSite, context: IArcGISContext) => Promise<IUiSchema>;

package/dist/types/sites/_internal/capabilities/types.d.ts

@@ -2,7 +2,7 @@ import { SitePermissions } from "../SiteBusinessRules";
 /**
  * legacy site capabilities
  */
-export declare type LegacyCapability = "hideFollow";
+export declare type LegacyCapability = "hideFollow" | "disableDiscussions";
 /**
  * representation of legacy site capabilities as
  * feature flags

package/package.json

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