@esri/hub-common 15.41.3 → 15.42.0

package/dist/types/channels/_internal/transformEntityPermissionPoliciesToFormValues.d.ts

@@ -0,0 +1,44 @@
+import { HubEntityType } from "../../core/types";
+import { IEntityPermissionPolicy } from "../../permissions/types/IEntityPermissionPolicy";
+export interface IHubRoleConfigValue {
+    key: string;
+    entityId?: string;
+    entityType?: HubEntityType;
+    roles: Record<string, {
+        value: string;
+        id?: string;
+    }>;
+}
+/**
+ * @private
+ * Transforms an array of IEntityPermissionPolicy (Hub entity) objects to an array of IHubRoleConfigValue (entity editor) objects
+ * representing the channel's public (anonymous & authenticated) permissions
+ * @param permissionPolicies An array of IEntityPermissionPolicy objects
+ * @returns an array of IHubRoleConfigValue objects
+ */
+export declare const transformEntityPermissionPoliciesToPublicFormValues: (permissionPolicies: IEntityPermissionPolicy[]) => IHubRoleConfigValue[];
+/**
+ * @private
+ * Transforms an array of IEntityPermissionPolicy (Hub entity) objects to an array of IHubRoleConfigValue (entity editor) objects
+ * representing the channel's group (member & admin) permissions
+ * @param permissionPolicies An array of IEntityPermissionPolicy objects
+ * @returns an array of IHubRoleConfigValue objects
+ */
+export declare const transformEntityPermissionPoliciesToGroupFormValues: (permissionPolicies: IEntityPermissionPolicy[]) => IHubRoleConfigValue[];
+/**
+ * @private
+ * Transforms an array of IEntityPermissionPolicy (Hub entity) objects to an array of IHubRoleConfigValue (entity editor) objects
+ * representing the channel's org (member & admin) permissions
+ * @param permissionPolicies An array of IEntityPermissionPolicy objects
+ * @param defaultOrgId The current user's orgId
+ * @returns an array of IHubRoleConfigValue objects
+ */
+export declare const transformEntityPermissionPoliciesToOrgFormValues: (permissionPolicies: IEntityPermissionPolicy[], defaultOrgId?: string) => IHubRoleConfigValue[];
+/**
+ * @private
+ * Transforms an array of IEntityPermissionPolicy (Hub entity) objects to an array of IHubRoleConfigValue (entity editor) objects
+ * representing the channel's individual user permissions
+ * @param permissionPolicies An array of IEntityPermissionPolicy objects
+ * @returns an array of IHubRoleConfigValue objects
+ */
+export declare const transformEntityPermissionPoliciesToUserFormValues: (permissionPolicies: IEntityPermissionPolicy[]) => IHubRoleConfigValue[];

package/dist/types/channels/_internal/transformEntityToChannelData.d.ts

@@ -0,0 +1,9 @@
+import { IHubChannel } from "../../core/types/IHubChannel";
+import { IUpdateChannelV2, ICreateChannelV2 } from "../../discussions/api/types";
+/**
+ * @private
+ * Transforms an IHubChannel entity pojo object to an object that can be passed V2 channel create and update methods
+ * @param entity an IHubChannel object
+ * @returns an object that can be passed to V2 channel create and update methods
+ */
+export declare function transformEntityToChannelData<T extends ICreateChannelV2 | IUpdateChannelV2>(entity: IHubChannel): T;

package/dist/types/channels/_internal/transformEntityToEditor.d.ts

@@ -0,0 +1,9 @@
+import { IHubChannel, IHubChannelEditor } from "../../core/types/IHubChannel";
+import { IArcGISContext } from "../../types/IArcGISContext";
+/**
+ * @private
+ * Transforms an IHubChannel entity pojo to an IHubChannelEditor object
+ * @param entity an IHubChannel object
+ * @returns an IHubChannelEditor object
+ */
+export declare function transformEntityToEditor(entity: IHubChannel, context: IArcGISContext): IHubChannelEditor;

package/dist/types/channels/_internal/transformFormValuesToEntityPermissionPolicies.d.ts

@@ -0,0 +1,9 @@
+import { IEntityPermissionPolicy } from "../../permissions/types";
+import { IHubRoleConfigValue } from "./transformEntityPermissionPoliciesToFormValues";
+/**
+ * @private
+ * Transforms an array of IHubRoleConfigValue objects into an array of IEntityPermissionPolicy objects
+ * @param roleConfigs an array of IHubRoleConfigValue objects
+ * @returns an array of IEntityPermissionPolicy objects
+ */
+export declare function transformFormValuesToEntityPermissionPolicies(roleConfigs: IHubRoleConfigValue[]): IEntityPermissionPolicy[];

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

@@ -0,0 +1,23 @@
+import { IHubChannel } from "../core";
+import { IArcGISContext } from "../types";
+/**
+ * Creates a new Channel from the given IHubChannel object
+ * @param entity An IHubChannel object
+ * @param context ArcGIS context
+ * @returns a promise that resolves an IHubChannel representing the newly created channel
+ */
+export declare function createHubChannel(entity: IHubChannel, context: IArcGISContext): Promise<IHubChannel>;
+/**
+ * Updates an existing Channel from the given IHubChannel object
+ * @param entity An IHubChannel object
+ * @param context ArcGIS context
+ * @returns a promise that resolves an IHubChannel representing the updated channel
+ */
+export declare function updateHubChannel(entity: IHubChannel, context: IArcGISContext): Promise<IHubChannel>;
+/**
+ * Updates an existing Channel from the given IHubChannel object
+ * @param channelId The ID of the channel to delete
+ * @param context ArcGIS context
+ * @returns a promise
+ */
+export declare function deleteHubChannel(channelId: string, context: IArcGISContext): Promise<void>;

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

@@ -0,0 +1,9 @@
+import { IHubChannel } from "../core/types/IHubChannel";
+import { IArcGISContext } from "../types";
+/**
+ * Fetches a Channel for the given channelId
+ * @param channelId The ID of the channel to fetch
+ * @param context ArcGIS context
+ * @returns a promise that resolves an IHubChannel for the given channelId
+ */
+export declare function fetchHubChannel(channelId: string, context: IArcGISContext): Promise<IHubChannel>;

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

@@ -0,0 +1,3 @@
+export * from "./HubChannel";
+export * from "./edit";
+export * from "./fetch";

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

@@ -44,7 +44,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
         control?: import("../../hub-types").AccessControl;
         groups?: import("@esri/arcgis-rest-portal").IGroup[];
     };
-    family?: "map" | "template" | "document" | "content" | "discussion" | "event" | "initiative" | "organization" | "project" | "site" | "app" | "dataset" | "feedback" | "people" | "team" | "channel" | "eventAttendee";
+    family?: "map" | "template" | "document" | "content" | "discussion" | "event" | "initiative" | "organization" | "project" | "site" | "channel" | "app" | "dataset" | "feedback" | "people" | "team" | "eventAttendee";
     categories?: string[];
     isDownloadable: boolean;
     structuredLicense?: import("../..").IStructuredLicense;

package/dist/types/content/get-family.d.ts

@@ -4,7 +4,7 @@ import { HubFamily } from "../hub-types";
  * @param type item type
  * @returns Hub family
  */
-export declare function getFamily(type: string): "map" | "template" | "document" | "content" | "discussion" | "event" | "initiative" | "organization" | "project" | "site" | "app" | "dataset" | "feedback" | "people" | "team" | "channel" | "eventAttendee";
+export declare function getFamily(type: string): "map" | "template" | "document" | "content" | "discussion" | "event" | "initiative" | "organization" | "project" | "site" | "channel" | "app" | "dataset" | "feedback" | "people" | "team" | "eventAttendee";
 /**
  * return the types associated with a provided Hub Family
  * Overrides are provided to match getFamily implementation

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

@@ -8,6 +8,6 @@ export declare class EntityEditor {
     private constructor();
     static fromEntity(entity: HubEntity, context: IArcGISContext): EntityEditor;
     getConfig(i18nScope: string, type: EntityEditorType): Promise<IEditorConfig>;
-    toEditor(editorContext?: IEntityEditorContext, include?: string[]): HubEntityEditor;
+    toEditor(editorContext?: IEntityEditorContext, include?: string[]): Promise<HubEntityEditor>;
     save(editor: HubEntityEditor, editorContext?: IEntityEditorContext): Promise<HubEntity>;
 }

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

@@ -12,7 +12,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -42,7 +42,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat", "hub:card:
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:card:stat", "hub:card:follow", "hub:card:eventGallery"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:create2", "hub:project:edit", "hub:project:metrics", "hub:project:settings", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:create2", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:page:create", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:group:create", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:registrants", "hub:user:settings", "hub:channel:create", "hub:channel:edit", "hub:card:stat", "hub:card:follow", "hub:card:eventGallery"];
 /**
  * An editor's module when dynamically imported depending on the EditorType. This
  * will always have a buildUiSchema function, and sometimes it will have a

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

@@ -8,5 +8,6 @@ import { IHubTemplate } from "./IHubTemplate";
 import { IHubSurvey } from "./IHubSurvey";
 import { IHubEvent } from "./IHubEvent";
 import { IHubUser } from "./IHubUser";
-import { IHubOrganization } from "../..";
-export declare type HubEntity = IHubDiscussion | IHubEvent | IHubGroup | IHubInitiative | IHubOrganization | IHubPage | IHubProject | IHubSite | IHubSurvey | IHubTemplate | IHubUser;
+import { IHubOrganization } from "./IHubOrganization";
+import { IHubChannel } from "./IHubChannel";
+export declare type HubEntity = IHubDiscussion | IHubEvent | IHubGroup | IHubInitiative | IHubOrganization | IHubPage | IHubProject | IHubSite | IHubSurvey | IHubTemplate | IHubUser | IHubChannel;

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

@@ -1,2 +1,2 @@
-export declare const HUB_ENTITY_TYPES: readonly ["content", "discussion", "event", "group", "initiative", "initiativeTemplate", "org", "organization", "page", "project", "site", "survey", "template", "user"];
+export declare const HUB_ENTITY_TYPES: readonly ["content", "discussion", "event", "group", "initiative", "initiativeTemplate", "org", "organization", "page", "project", "site", "survey", "template", "user", "channel"];
 export declare type HubEntityType = (typeof HUB_ENTITY_TYPES)[number];

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

@@ -0,0 +1,91 @@
+import { IChannel } from "../../discussions/api/types";
+import { IEntityPermissionPolicy } from "../../permissions/types/IEntityPermissionPolicy";
+import { IWithViewSettings } from "../traits/IWithViewSettings";
+import { HubEntityType } from "./HubEntityType";
+import { IHubEntityBase } from "./IHubEntityBase";
+import { IHubLocation } from "./IHubLocation";
+import { AccessLevel } from "./types";
+/**
+ * Defines the properties of a Hub Channel object
+ */
+export interface IHubChannel extends IHubEntityBase {
+    /**
+     * An array of blocked words. Posts & replies created/edited containing these words will result in the post status being automatically set to blocked
+     */
+    blockWords: string[];
+    /**
+     * An array of IEntityPermissionPolicy representing the configured permissions for the channel
+     */
+    permissions: IEntityPermissionPolicy[];
+    /**
+     * True when authenticated users can post pseudo-anonymously, masking their identity
+     */
+    allowAsAnonymous: boolean;
+    /**
+     * True when the currently authenticated user can edit the channel
+     */
+    canEdit: boolean;
+    /**
+     * True when the currently authenticated user can delete the channel
+     */
+    canDelete: boolean;
+    /**
+     * The ID of the organization the channel was created within
+     */
+    orgId: string;
+    /**
+     * The owner of the channel
+     */
+    owner: string;
+    /**
+     * A reference to the underlying IChannel object
+     */
+    channel: IChannel;
+    /**
+     * The access level of the channel
+     */
+    access: AccessLevel;
+    /**
+     * Typekeywords applied to the channel
+     */
+    typeKeywords: string[];
+    /**
+     * Thumbnail of the channel
+     */
+    thumbnail?: string;
+    /**
+     * View settings of the channel
+     */
+    view?: IWithViewSettings;
+    /**
+     * Description of the channel
+     */
+    description?: string;
+    /**
+     * Tags applied to the channel
+     */
+    tags: string[];
+    /**
+     * The location of the channel
+     */
+    location?: IHubLocation;
+}
+export interface IHubRoleConfigValue {
+    key: string;
+    entityId?: string;
+    entityType?: HubEntityType;
+    roles: Record<string, {
+        value: string;
+        id?: string;
+    }>;
+}
+export interface IHubChannelEditor {
+    id: string;
+    name: string;
+    blockWords: string;
+    publicConfigs: IHubRoleConfigValue[];
+    orgConfigs: IHubRoleConfigValue[];
+    groupConfigs: IHubRoleConfigValue[];
+    userConfigs: IHubRoleConfigValue[];
+    allowAsAnonymous: boolean;
+}

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

@@ -10,6 +10,7 @@ export * from "./IHubDiscussion";
 export * from "./IHubEditableContent";
 export * from "./IHubEntityBase";
 export * from "./IHubEvent";
+export * from "./IHubChannel";
 export * from "./IHubSurvey";
 export * from "./IHubGroup";
 export * from "./IHubImage";

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from "./i18n";
 export * from "./initiatives";
 export * from "./initiative-templates";
 export * from "./discussions";
+export * from "./channels";
 export * from "./surveys";
 export * from "./events";
 export * from "./items";

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

@@ -14,9 +14,17 @@ export interface IEntityPermissionPolicy {
     /**
      * Id of the collaboration set
      */
-    collaborationId: string;
+    collaborationId?: string | null;
+    /**
+     * Id of the permission record
+     */
+    id?: string | null;
 }
 /**
  * Type of collaboration set. Used when associating a permission with a set of collaborators
  */
-export declare type CollaborationType = "user" | "group" | "group-admin" | "org" | "authenticated" | "anonymous";
+export declare type CollaborationType = "user" | "group" | "group-admin" | "org" | "org-admin" | "authenticated" | "anonymous" | "owner";
+/**
+ * A map of supported collaboration set types
+ */
+export declare const COLLABORATION_TYPES: Record<"user" | "group" | "groupAdmin" | "org" | "orgAdmin" | "authenticated" | "anonymous" | "owner", CollaborationType>;

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

@@ -2,6 +2,7 @@ import { ProjectPermissions } from "../../projects/_internal/ProjectBusinessRule
 import { SitePermissions } from "../../sites/_internal/SiteBusinessRules";
 import { InitiativePermissions } from "../../initiatives/_internal/InitiativeBusinessRules";
 import { DiscussionPermissions } from "../../discussions/_internal/DiscussionBusinessRules";
+import { ChannelPermissions } from "../../channels/_internal/ChannelBusinessRules";
 import { ContentPermissions } from "../../content/_internal/ContentBusinessRules";
 import { GroupPermissions } from "../../groups/_internal/GroupBusinessRules";
 import { PagePermissions } from "../../pages/_internal/PageBusinessRules";
@@ -20,7 +21,7 @@ declare const SystemPermissions: 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 DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number] | (typeof SurveyPermissions)[number] | (typeof EventPermissions)[number] | (typeof UserPermissions)[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 DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number] | (typeof SurveyPermissions)[number] | (typeof EventPermissions)[number] | (typeof UserPermissions)[number] | (typeof ChannelPermissions)[number];
 /**
  * Validate a Permission
  * @param permission

package/package.json

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