@esri/hub-common 15.31.2 → 15.31.4

package/dist/node/sites/searchCategoriesToCollections.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchCategoriesToCollections = void 0;
+const types_1 = require("./_internal/types");
+const defaultSiteCollectionKeys_1 = require("./defaultSiteCollectionKeys");
+/**
+ * Convert searchCategories to collections. If no searchCategories are provided,
+ * the default collections will be returned.
+ *
+ * @param searchCategories searchCategories from site model (data.values.searchCategories)
+ * @returns IHubCollections that respect the searchCategories configuration
+ */
+function searchCategoriesToCollections(searchCategories) {
+    const baseCollectionMap = defaultSiteCollectionKeys_1.defaultSiteCollectionKeys.reduce((map, key) => {
+        // We use well-known predicates for the default collections,
+        // but "Apps & Maps" is a special case since it includes both the app and map families
+        const predicates = key === "appAndMap"
+            ? [{ type: { any: ["$app", "$map"] } }]
+            : [{ type: { any: [`$${key}`] } }];
+        map[key] = {
+            // We chose to leave the label as "null" for a couple of reasons. First off,
+            // the default collection names are supposed to be translated and we don't
+            // have access to i18n services here. Second, because we temporarily have to
+            // serialize changes from catalog.collections back to site.data.values.searchCategories
+            // for backwards compatibility, we need a way to indicate whether a collection's
+            // name has been explicitly set or if it is relying on the default translation.
+            // As such, we only set the label on the collection object IFF an explicit
+            // override text has been configured.
+            label: null,
+            key,
+            include: [],
+            targetEntity: "item",
+            scope: {
+                targetEntity: "item",
+                filters: [{ predicates }],
+            },
+            displayConfig: {
+                hidden: false,
+            },
+        };
+        return map;
+    }, {});
+    const searchCategoryToCollection = {
+        [types_1.SearchCategories.DATA]: "dataset",
+        // Unfortunately, the "site" search category has different keys depending on if the catalog
+        // was created for a hub basic or hub premium site. As such, we just account for both.
+        [types_1.SearchCategories.INITIATIVES]: "site",
+        [types_1.SearchCategories.SITES]: "site",
+        [types_1.SearchCategories.DOCUMENTS]: "document",
+        [types_1.SearchCategories.APPS_AND_MAPS]: "appAndMap",
+    };
+    // Not every site has `data.values.searchCategories` saved, so we have to keep a bare-bones
+    // copy of what the default objects are in opendata-ui.
+    // NOTE: The `event` search category has been explicitly omitted. While the classic search view
+    // allows for the searching of `events`, the new search view does not.
+    const DEFAULT_SEARCH_CATEGORIES = [
+        { key: types_1.SearchCategories.SITES, hidden: true },
+        { key: types_1.SearchCategories.DATA },
+        { key: types_1.SearchCategories.DOCUMENTS },
+        { key: types_1.SearchCategories.APPS_AND_MAPS },
+    ];
+    const legacySearchCategories = searchCategories || DEFAULT_SEARCH_CATEGORIES;
+    const configuredCollections = legacySearchCategories
+        // The new search view doesn't currently allow for searching events
+        .filter((searchCategory) => searchCategory.key !== types_1.SearchCategories.EVENTS)
+        // Some sites have a borked `data.values.searchCategories` that explicitly includes the `all`
+        // collection. We have this check to catch that and any other weird scenarios.
+        .filter((searchCategory) => !!searchCategoryToCollection[searchCategory.key])
+        .map((searchCategory) => {
+        const collectionKey = searchCategoryToCollection[searchCategory.key];
+        const collection = baseCollectionMap[collectionKey];
+        collection.label = searchCategory.overrideText || null;
+        collection.displayConfig.hidden = !!searchCategory.hidden;
+        return collection;
+    });
+    return configuredCollections;
+}
+exports.searchCategoriesToCollections = searchCategoriesToCollections;
+//# sourceMappingURL=searchCategoriesToCollections.js.map

package/dist/node/sites/searchCategoriesToCollections.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchCategoriesToCollections.js","sourceRoot":"","sources":["../../../src/sites/searchCategoriesToCollections.ts"],"names":[],"mappings":";;;AAEA,6CAAqD;AACrD,2EAAwE;AAExE;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAC3C,gBAAqC;IAErC,MAAM,iBAAiB,GAAG,qDAAyB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACtE,4DAA4D;QAC5D,sFAAsF;QACtF,MAAM,UAAU,GACd,GAAG,KAAK,WAAW;YACjB,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;YACvC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAEvC,GAAG,CAAC,GAAG,CAAC,GAAG;YACT,4EAA4E;YAC5E,0EAA0E;YAC1E,4EAA4E;YAC5E,uFAAuF;YACvF,gFAAgF;YAChF,+EAA+E;YAC/E,0EAA0E;YAC1E,qCAAqC;YACrC,KAAK,EAAE,IAAI;YACX,GAAG;YACH,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,MAAM;YACpB,KAAK,EAAE;gBACL,YAAY,EAAE,MAAM;gBACpB,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;aAC1B;YACD,aAAa,EAAE;gBACb,MAAM,EAAE,KAAK;aACd;SACF,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAoC,CAAC,CAAC;IACzC,MAAM,0BAA0B,GAE5B;QACF,CAAC,wBAAgB,CAAC,IAAI,CAAC,EAAE,SAAS;QAClC,2FAA2F;QAC3F,sFAAsF;QACtF,CAAC,wBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM;QACtC,CAAC,wBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM;QAChC,CAAC,wBAAgB,CAAC,SAAS,CAAC,EAAE,UAAU;QACxC,CAAC,wBAAgB,CAAC,aAAa,CAAC,EAAE,WAAW;KAC9C,CAAC;IACF,2FAA2F;IAC3F,uDAAuD;IACvD,+FAA+F;IAC/F,sEAAsE;IACtE,MAAM,yBAAyB,GAAU;QACvC,EAAE,GAAG,EAAE,wBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE;QAC7C,EAAE,GAAG,EAAE,wBAAgB,CAAC,IAAI,EAAE;QAC9B,EAAE,GAAG,EAAE,wBAAgB,CAAC,SAAS,EAAE;QACnC,EAAE,GAAG,EAAE,wBAAgB,CAAC,aAAa,EAAE;KACxC,CAAC;IACF,MAAM,sBAAsB,GAC1B,gBAAgB,IAAI,yBAAyB,CAAC;IAEhD,MAAM,qBAAqB,GAAG,sBAAsB;QAClD,mEAAmE;SAClE,MAAM,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,KAAK,wBAAgB,CAAC,MAAM,CAAC;QAC3E,6FAA6F;QAC7F,8EAA8E;SAC7E,MAAM,CACL,CAAC,cAAc,EAAE,EAAE,CACjB,CAAC,CAAC,0BAA0B,CAAC,cAAc,CAAC,GAAuB,CAAC,CACvE;SACA,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE;QACtB,MAAM,aAAa,GACjB,0BAA0B,CAAC,cAAc,CAAC,GAAuB,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACpD,UAAU,CAAC,KAAK,GAAG,cAAc,CAAC,YAAY,IAAI,IAAI,CAAC;QACvD,UAAU,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC,CAAC;IAEL,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AA7ED,sEA6EC"}

package/dist/node/types/IArcGISContext.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IArcGISContext.js.map

package/dist/node/types/IArcGISContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IArcGISContext.js","sourceRoot":"","sources":["../../../src/types/IArcGISContext.ts"],"names":[],"mappings":""}

package/dist/node/types/IArcGISContextManagerOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IArcGISContextManagerOptions.js.map

package/dist/node/types/IArcGISContextManagerOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IArcGISContextManagerOptions.js","sourceRoot":"","sources":["../../../src/types/IArcGISContextManagerOptions.ts"],"names":[],"mappings":""}

package/dist/node/types/IArcGISContextOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IArcGISContextOptions.js.map

package/dist/node/types/IArcGISContextOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IArcGISContextOptions.js","sourceRoot":"","sources":["../../../src/types/IArcGISContextOptions.ts"],"names":[],"mappings":""}

package/dist/node/types/IUserResourceConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IUserResourceConfig.js.map

package/dist/node/types/IUserResourceConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUserResourceConfig.js","sourceRoot":"","sources":["../../../src/types/IUserResourceConfig.ts"],"names":[],"mappings":""}

package/dist/node/types/IUserResourceToken.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IUserResourceToken.js.map

package/dist/node/types/IUserResourceToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUserResourceToken.js","sourceRoot":"","sources":["../../../src/types/IUserResourceToken.ts"],"names":[],"mappings":""}

package/dist/node/urls/getPortalBaseFromOrgUrl.js

@@ -10,7 +10,9 @@ exports.getPortalBaseFromOrgUrl = void 0;
  * @returns
  */
 function getPortalBaseFromOrgUrl(orgUrl) {
-    let result = orgUrl;
+    // strip off the /sharing/rest part of the url
+    // this will also handle enterprise urls
+    let result = orgUrl.split("/sharing/rest")[0];
     if (orgUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
         result = "https://qaext.arcgis.com";
     }

package/dist/node/urls/getPortalBaseFromOrgUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"getPortalBaseFromOrgUrl.js","sourceRoot":"","sources":["../../../src/urls/getPortalBaseFromOrgUrl.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CAAC,MAAc;IACpD,IAAI,MAAM,GAAG,MAAM,CAAC;IAEpB,IAAI,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QAChD,MAAM,GAAG,0BAA0B,CAAC;KACrC;SAAM,IAAI,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC5D,MAAM,GAAG,2BAA2B,CAAC;KACtC;SAAM;QACL,0BAA0B;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;YAC5C,MAAM,GAAG,wBAAwB,CAAC;SACnC;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,0DAeC"}
+{"version":3,"file":"getPortalBaseFromOrgUrl.js","sourceRoot":"","sources":["../../../src/urls/getPortalBaseFromOrgUrl.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CAAC,MAAc;IACpD,8CAA8C;IAC9C,wCAAwC;IACxC,IAAI,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9C,IAAI,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QAChD,MAAM,GAAG,0BAA0B,CAAC;KACrC;SAAM,IAAI,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC5D,MAAM,GAAG,2BAA2B,CAAC;KACtC;SAAM;QACL,0BAA0B;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;YAC5C,MAAM,GAAG,wBAAwB,CAAC;SACnC;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjBD,0DAiBC"}

package/dist/node/utils/IHubConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IHubConfig.js.map

package/dist/node/utils/IHubConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHubConfig.js","sourceRoot":"","sources":["../../../src/utils/IHubConfig.ts"],"names":[],"mappings":""}

package/dist/node/utils/IUserHubSettings.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IUserHubSettings.js.map

package/dist/node/utils/IUserHubSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUserHubSettings.js","sourceRoot":"","sources":["../../../src/utils/IUserHubSettings.ts"],"names":[],"mappings":""}

package/dist/node/utils/IUserSiteSettings.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Site Level Settings
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IUserSiteSettings.js.map

package/dist/node/utils/IUserSiteSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IUserSiteSettings.js","sourceRoot":"","sources":["../../../src/utils/IUserSiteSettings.ts"],"names":[],"mappings":";AAAA;;GAEG"}

package/dist/node/utils/LogLevel.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LogLevel.js.map

package/dist/node/utils/LogLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogLevel.js","sourceRoot":"","sources":["../../../src/utils/LogLevel.ts"],"names":[],"mappings":""}

package/dist/node/utils/internal/config.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logLevel = void 0;
+// the default settings
+const DEFAULT_CONFIG = {
+    logLevel: "error",
+};
+// the global variable name that consumers use to override the defaults
+const GLOBAL_VARIABLE_NAME = "arcgisHubConfig";
+// merge consumer supplied config (if any) with the defaults
+const config = Object.assign(Object.assign({}, DEFAULT_CONFIG), globalThis[GLOBAL_VARIABLE_NAME]);
+// export the settings as immutable consts
+exports.logLevel = config.logLevel;
+//# sourceMappingURL=config.js.map

package/dist/node/utils/internal/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/utils/internal/config.ts"],"names":[],"mappings":";;;AAEA,uBAAuB;AACvB,MAAM,cAAc,GAAe;IACjC,QAAQ,EAAE,OAAO;CAClB,CAAC;AAEF,uEAAuE;AACvE,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;AAE/C,4DAA4D;AAC5D,MAAM,MAAM,GAAG,gCACV,cAAc,GACb,UAAkB,CAAC,oBAAoB,CAAC,CAC/B,CAAC;AAEhB,0CAA0C;AAC7B,QAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC"}

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

@@ -0,0 +1,105 @@
+import { IArcGISContext } from "../types";
+import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { IWithStoreBehavior } from "../core/behaviors/IWithStoreBehavior";
+import { IEditorConfig } from "../core/schemas/types";
+import { IEntityEditorContext } from "../core/types/HubEntityEditor";
+import { IHubChannel, IHubChannelEditor } from "../core/types/IHubChannel";
+import { ChannelEditorType } from "./_internal/ChannelSchema";
+import { IConvertToCardModelOpts, IHubCardViewModel } from "../core/types/IHubCardViewModel";
+export declare class HubChannel implements IWithStoreBehavior<IHubChannel>, IWithEditorBehavior {
+    protected context: IArcGISContext;
+    protected entity: IHubChannel;
+    protected isDestroyed: boolean;
+    constructor(entity: IHubChannel, context: IArcGISContext);
+    /**
+     * Create an instance from an IHubChannel object
+     * @param json - JSON object to create a HubChannel from
+     * @param context - ArcGIS context
+     * @returns a HubChannel instance
+     */
+    static fromJson(json: Partial<IHubChannel>, context: IArcGISContext): HubChannel;
+    /**
+     * Create a new HubChannel, returning a HubChannel instance.
+     * Note: This does not persist the Channel into the backing store
+     * @param partialChannel A partial IHubChannel object
+     * @param context ArcGIS Context
+     * @returns a HubChannel instance
+     */
+    static create(partialChannel: Partial<IHubChannel>, context: IArcGISContext, save?: boolean): Promise<HubChannel>;
+    /**
+     * Fetch a Channel from the backing store and return a HubChannel instance.
+     * @param identifier - Identifier of the channel to load
+     * @param context - An IArcGISContext object
+     * @returns a HubChannel instance
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubChannel>;
+    /**
+     * Given a partial channel, apply defaults to it to ensure that a baseline of properties are set
+     * @param partialChannel A partial IHubChannel object
+     * @param context - ArcGIS Context
+     * @returns an IHubChannel object
+     */
+    private static applyDefaults;
+    /**
+     * Can the current user edit the channel?
+     * @returns boolean
+     */
+    get canEdit(): boolean;
+    /**
+     * Can the current user delete the channel?
+     * @returns boolean
+     */
+    get canDelete(): boolean;
+    /**
+     * The orgId of the channel
+     * @returns the orgId of the channel
+     */
+    get orgId(): string;
+    /**
+     * Return the backing entity as an object literal
+     * @returns an IHubChannel
+     */
+    toJson(): IHubChannel;
+    /**
+     * Apply a new state to the instance
+     * @param changes A partial IHubChannel object
+     */
+    update(changes: Partial<IHubChannel>): void;
+    /**
+     * Save the HubChannel to the backing store.
+     * @returns a promise
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubChannel from the store
+     * set a flag to indicate that it is destroyed
+     * @returns a promise
+     */
+    delete(): Promise<void>;
+    /**
+     * TODO
+     * @param opts
+     * @returns
+     */
+    convertToCardModel(opts?: IConvertToCardModelOpts): IHubCardViewModel;
+    /**
+     * Get a specifc editor config for the HubChannel entity.
+     * @param i18nScope A string representing the i18n scope for translated strings
+     * @param type One of the supported ChannelEditorType strings
+     * @returns a promise that resolves a IEditorConfig object
+     */
+    getEditorConfig(i18nScope: string, type: ChannelEditorType): Promise<IEditorConfig>;
+    /**
+     * Return the channel as an editor object
+     * @param editorContext An IEntityEditorContext object
+     * @param include An optional array of includes
+     * @returns a promise that resolves an IHubChannelEditor object
+     */
+    toEditor(editorContext: IEntityEditorContext, include?: string[]): Promise<IHubChannelEditor>;
+    /**
+     * Load the channel from the editor object
+     * @param editor An IHubChannelEditor object
+     * @returns a promise that resolves an IHubChannel
+     */
+    fromEditor(editor: IHubChannelEditor): Promise<IHubChannel>;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * @private
+ * An array of all supported channel permissions
+ */
+export declare const ChannelPermissions: readonly ["hub:channel", "hub:channel:create", "hub:channel:delete", "hub:channel:edit", "hub:channel:view", "hub:channel:owner", "hub:channel:manage", "hub:channel:read", "hub:channel:write", "hub:channel:readWrite", "hub:channel:moderate"];
+/**
+ * @private
+ * A union type representing all the supported channel permissions
+ */
+export declare type ChannelPermission = (typeof ChannelPermissions)[number];
+/**
+ * A pseudo-permission used as a placeholder for the "None" permission option
+ */
+export declare const ChannelNonePermission = "hub:channel:none";
+/**
+ * @private
+ * A map of all supported channel permissions
+ */
+export declare const CHANNEL_PERMISSIONS: Record<"channelRoot" | "channelCreate" | "channelDelete" | "channelEdit" | "channelView" | "channelOwner" | "channelManage" | "channelRead" | "channelWrite" | "channelReadWrite" | "channelModerate", ChannelPermission>;

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

@@ -0,0 +1,16 @@
+import { IConfigurationSchema } from "../../core/schemas/types";
+/**
+ * @private
+ * The supported channel editor types
+ */
+export declare const ChannelEditorTypes: readonly ["hub:channel:create", "hub:channel:edit"];
+/**
+ * @private
+ * The union of all supported channel editor types
+ */
+export declare type ChannelEditorType = (typeof ChannelEditorTypes)[number];
+/**
+ * @private
+ * The channel editor schema
+ */
+export declare const ChannelSchema: IConfigurationSchema;

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

@@ -0,0 +1,10 @@
+import { IUiSchema } from "../../core/schemas/types";
+import { IArcGISContext } from "../../types";
+import { IHubChannel } from "../../core/types";
+/**
+ * @private
+ * constructs the complete create uiSchema for Hub Channels.
+ * This defines how the schema properties should be
+ * rendered in the channel editing experience
+ */
+export declare const buildUiSchema: (i18nScope: string, _options: Partial<IHubChannel>, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,10 @@
+import { IUiSchema } from "../../core/schemas/types";
+import { IArcGISContext } from "../../types";
+import { IHubChannel } from "../../core/types";
+/**
+ * @private
+ * constructs the complete edit uiSchema for Hub Channels.
+ * This defines how the schema properties should be
+ * rendered in the channel editing experience
+ */
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubChannel>, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,8 @@
+import { IHubChannel } from "../../core/types/IHubChannel";
+/**
+ * @private
+ * Builds a partial IHubChannel object with default values
+ * @param orgId the currently authenticated user's orgId
+ * @returns a partial IHubChannel object
+ */
+export declare function buildDefaultChannel(orgId: string): Partial<IHubChannel>;

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

@@ -0,0 +1,11 @@
+import { IEntityPermissionPolicy } from "../../permissions/types/IEntityPermissionPolicy";
+import { IChannelAclPermissionDefinition } from "../../discussions/api/types";
+/**
+ * @private
+ * Transforms an IChannelAclPermission-like object to an IEntityPermissionPolicy object
+ * @param channelAclPermission An IChannelAclPermission-like object
+ * @returns an IEntityPermissionPolicy object
+ */
+export declare const transformAclPermissionToEntityPermissionPolicy: (channelAclPermission: IChannelAclPermissionDefinition & {
+    id?: string;
+}) => IEntityPermissionPolicy;

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

@@ -0,0 +1,11 @@
+import { IHubChannel } from "../../core/types/IHubChannel";
+import { IChannel } from "../../discussions/api/types";
+import type { IUser } from "@esri/arcgis-rest-portal";
+/**
+ * @private
+ * Transforms a given IChannel object to an IHubChannel object
+ * @param channel An IChannel object
+ * @param user The currently authenticated user
+ * @returns an IHubChannel object
+ */
+export declare function transformChannelToEntity(channel: IChannel, user: IUser): IHubChannel;

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

@@ -0,0 +1,8 @@
+import { IHubChannel, IHubChannelEditor } from "../../core/types/IHubChannel";
+/**
+ * @private
+ * Transforms an IHubChannelEditor object to a partial IHubChannel object
+ * @param editor an IHubChannelEditor object
+ * @returns a partial IHubChannel object
+ */
+export declare function transformEditorToEntity(editor: IHubChannelEditor): Partial<IHubChannel>;

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/core/schemas/internal/discussions/EntityUiSchemaDiscussionsSettings.d.ts

@@ -0,0 +1,11 @@
+import type { IArcGISContext } from "../../../../types/IArcGISContext";
+import { IUiSchema } from "../../types";
+import { EntityEditorOptions } from "../EditorOptions";
+/**
+ * Builds the UI Schema for the "settings => discussions" workspace pane
+ * @param i18nScope the i18n scope for translations
+ * @param options an EntityEditorOptions object
+ * @param context an IArcGISContext object
+ * @returns a promise that resolves a UI Schema object
+ */
+export declare const buildUiSchema: (i18nScope: string, options: EntityEditorOptions, context: IArcGISContext) => Promise<IUiSchema>;

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;
+}