@esri/hub-common 13.17.2 → 13.17.4

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

@@ -0,0 +1,15 @@
+import { IEditorConfig } from "../../behaviors/IWithEditorBehavior";
+import { EditorType } from "../types";
+import { ConfigurableEntity } from "./ConfigurableEntity";
+import { IArcGISContext } from "../../../ArcGISContext";
+/**
+ * get the editor schema and uiSchema defined for an entity.
+ * The schema and uiSchema that are returned can be used to
+ * render a form UI (using the configuration editor)
+ *
+ * @param i18nScope translation scope to be interpolated into the uiSchema
+ * @param type editor type - corresonds to the returned uiSchema
+ * @param options optional hash of dynamic uiSchema element options
+ * @returns
+ */
+export declare function getEntityEditorSchemas(i18nScope: string, type: EditorType, entity: ConfigurableEntity, context: IArcGISContext): Promise<IEditorConfig>;

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

@@ -0,0 +1,8 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+import { IHubCatalog } from "../../../search/types/IHubCatalog";
+/**
+ * Return a catalog structured for picking featured content.
+ * @param user
+ * @returns
+ */
+export declare function getFeaturedContentCatalogs(user: IUser): IHubCatalog[];

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

@@ -0,0 +1,3 @@
+import { IArcGISContext } from "../../../ArcGISContext";
+import { ConfigurableEntity } from "./ConfigurableEntity";
+export declare function getFeaturedImageUrl(entity: ConfigurableEntity, context: IArcGISContext): string;

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

@@ -0,0 +1,7 @@
+import { IHubRequestOptions } from "../../../types";
+import { ConfigurableEntity } from "./ConfigurableEntity";
+/**
+ * Get the extent from the entity's location, if it has one.
+ * Otherwise, fall back to using the org extent.
+ */
+export declare function getLocationExtent(entity: ConfigurableEntity, hubRequestOptions: IHubRequestOptions): Promise<import("@esri/arcgis-rest-types").IExtent>;

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

@@ -0,0 +1,16 @@
+import { IHubRequestOptions } from "../../../types";
+import { ConfigurableEntity } from "./ConfigurableEntity";
+import { IHubLocationOption } from "../../types/IHubLocation";
+/**
+ * Construct the dynamic location picker options with the entity's
+ * configured location using the following logic:
+ *
+ * 1. If there is no entity (e.g. we're creating an entity),
+ * select the "custom" option by default
+ * 2. Else if there is no location set on the entity, select the
+ * "none" option
+ * 3. Else if the entity has a location and it's the same as the
+ * current option, select it and update the option with the entity's
+ * location
+ */
+export declare function getLocationOptions(entity: ConfigurableEntity, portalName: string, hubRequestOptions: IHubRequestOptions): Promise<IHubLocationOption[]>;

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

@@ -0,0 +1,7 @@
+import { IGroup } from "@esri/arcgis-rest-portal";
+import { IUiSchemaComboboxItem } from "../types";
+/**
+ * Filter an array of groups into the set the user has the rights to share content
+ * into, and then convert them to UiSchemaComboboxItem array for use in the Entity Editor component
+ */
+export declare function getSharableGroupsComboBoxItems(groups: IGroup[]): IUiSchemaComboboxItem[];

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

@@ -0,0 +1,12 @@
+import { IHubRequestOptions } from "../../../types";
+import { IUiSchemaComboboxItem } from "../types";
+import { ConfigurableEntity } from "./ConfigurableEntity";
+/**
+ * Fetch the entity's org tags (limited to the top 200),
+ * merge with any configured on the entity itself, and convert
+ * into a format that can be consumed by the combobox field
+ *
+ * TODO: the search portion of this util should probably
+ * be hoisted to hub.js
+ */
+export declare function getTagItems(entity: ConfigurableEntity, orgId: string, hubRequestOptions: IHubRequestOptions): Promise<IUiSchemaComboboxItem[]>;

package/dist/types/core/traits/IWithAssociations.d.ts

@@ -0,0 +1,4 @@
+export interface IWithAssociations {
+    typeKeywords?: string[];
+    [key: string]: any;
+}

package/dist/types/core/traits/IWithFollowers.d.ts

@@ -0,0 +1,7 @@
+/**
+ * properties for entities with followers
+ */
+export interface IWithFollowers {
+    /** followers group id */
+    followersGroupId?: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * Unified type for all Hub entity editors
+ */
+export declare type HubEntityEditor = Record<string, any>;
+/**
+ * Additional context that can be passed to `toEditor()` functions
+ */
+export interface IEntityEditorContext {
+    collaborationGroupId?: string;
+    contentGroupId?: string;
+}

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

@@ -0,0 +1,109 @@
+import { IWithPermissions } from "../traits";
+import { IHubEntityBase } from "./IHubEntityBase";
+import { GroupSortField, MemberType, MembershipAccess, PlatformSortOrder, AccessLevel } from "./types";
+/**
+ * Defines the properties of a Hub Group object
+ * @internal
+ */
+export interface IHubGroup extends IHubEntityBase, IWithPermissions {
+    /**
+     * Access level of the group
+     * ("private" | "org" | "public")
+     * we are using AccessLevel instead of SettableAccessLevel
+     * intentionally due to the Portal API being inconsistent
+     * between .access on items vs groups
+     */
+    access: AccessLevel;
+    /**
+     * Whether members can auto join the group
+     */
+    autoJoin?: boolean;
+    /**
+     * Whether the user can edit the group, only owners and admins can
+     */
+    canEdit: boolean;
+    /**
+     * Whether the user can delete the group, only owners and admins can
+     */
+    canDelete: boolean;
+    /**
+     * Description for the group
+     */
+    description?: string;
+    /**
+     * Whether the group is editable
+     */
+    isSharedUpdate: boolean;
+    /**
+     * Whether the group accepts members through invitations only
+     */
+    isInvitationOnly: boolean;
+    /**
+     * Whether discussions are enabled or disabled
+     */
+    isDiscussable: boolean;
+    /**
+     * Whether the group is for read only or not
+     */
+    isReadOnly: boolean;
+    /**
+     * Whether the group is for view only or not
+     */
+    isViewOnly: boolean;
+    /**
+     * Who can join the groups
+     * (organization, collaborators, anyone)
+     */
+    membershipAccess?: MembershipAccess;
+    /**
+     * Username of the owner of the group
+     */
+    owner?: string;
+    /**
+     * Whether the group is protected or not
+     * the group cannot be deleted if protected
+     */
+    protected: boolean;
+    /**
+     * Sort field for the Group
+     */
+    sortField?: GroupSortField;
+    /**
+     * Sort order for the Group
+     */
+    sortOrder?: PlatformSortOrder;
+    /**
+     * User configurable tags
+     */
+    tags?: string[];
+    /**
+     * Group thumbnail url (read-only)
+     */
+    thumbnail?: string;
+    /**
+     * Group thumbnail url (read-only)
+     */
+    thumbnailUrl?: string;
+    /**
+     * Member types of the group
+     * ("owner" | "admin" | "member" | "none")
+     */
+    memberType?: MemberType;
+    /**
+     * Whether there is a field we are trying to clear,
+     * if true, we need to send clearEmptyFields: true
+     * to the updateGroup call
+     */
+    _clearEmptyFields?: boolean;
+}
+/**
+ * This type redefines the IHubGroup interface in such a way
+ * that it can be consumed by the entity editor.
+ */
+export declare type IHubGroupEditor = IHubGroup & {
+    /**
+     * Thumbnail image. This is only used on the Editor and is
+     * persisted in the fromEditor method on the Class
+     */
+    _thumbnail?: any;
+};

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

@@ -0,0 +1,10 @@
+import { IChannel, IPagedResponse, ISearchChannelsParams } from "../types";
+/**
+ * Search for Channels in the Discussions API.  Channels define the capabilities,
+ * permissions, and configuration for Discussion posts.
+ *
+ * @export
+ * @param {ISearchChannelsParams} options
+ * @return {*}  {Promise<IPagedResponse<IChannel>>}
+ */
+export declare function searchChannels(options: ISearchChannelsParams): Promise<IPagedResponse<IChannel>>;

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

@@ -0,0 +1 @@
+export * from "./channels";

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

@@ -0,0 +1,2 @@
+export * from "./channels";
+export * from "./types";

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

@@ -0,0 +1,11 @@
+import { IDiscussionsRequestOptions } from "./types";
+/**
+ * method that authenticates and makes requests to Discussions API
+ *
+ * @export
+ * @template T
+ * @param {string} url
+ * @param {IDiscussionsRequestOptions} options
+ * @return {*}  {Promise<T>}
+ */
+export declare function request<T>(url: string, options: IDiscussionsRequestOptions): Promise<T>;