@esri/hub-common 9.37.0 → 9.38.0

package/dist/node/urls/index.js

@@ -20,6 +20,7 @@ tslib_1.__exportStar(require("./get-item-data-url"), exports);
 tslib_1.__exportStar(require("./convert-urls-to-anchor-tags"), exports);
 tslib_1.__exportStar(require("./getHubApiFromPortalUrl"), exports);
 tslib_1.__exportStar(require("./getPortalBaseFromOrgUrl"), exports);
+tslib_1.__exportStar(require("./getGroupHomeUrl"), exports);
 const MAP_OR_FEATURE_SERVER_URL_REGEX = /\/(map|feature)server/i;
 /**
  *

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":";;;;AAAA,kCAAqC;AACrC,sDAA4B;AAC5B,qEAA2C;AAC3C,+DAAqC;AACrC,2DAAiC;AACjC,2DAAiC;AACjC,6DAAmC;AACnC,2DAAiC;AACjC,qEAA2C;AAC3C,0DAAgC;AAChC,wEAA8C;AAC9C,oEAA0C;AAC1C,8DAAoC;AACpC,6DAAmC;AACnC,8DAAoC;AACpC,wEAA8C;AAC9C,mEAAyC;AACzC,oEAA0C;AAE1C,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,iBAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/urls/index.ts"],"names":[],"mappings":";;;;AAAA,kCAAqC;AACrC,sDAA4B;AAC5B,qEAA2C;AAC3C,+DAAqC;AACrC,2DAAiC;AACjC,2DAAiC;AACjC,6DAAmC;AACnC,2DAAiC;AACjC,qEAA2C;AAC3C,0DAAgC;AAChC,wEAA8C;AAC9C,oEAA0C;AAC1C,8DAAoC;AACpC,6DAAmC;AACnC,8DAAoC;AACpC,wEAA8C;AAC9C,mEAAyC;AACzC,oEAA0C;AAC1C,4DAAkC;AAElC,MAAM,+BAA+B,GAAG,wBAAwB,CAAC;AAEjE;;;;GAIG;AACU,QAAA,uBAAuB,GAAG,CAAC,GAAW,EAAE,EAAE;IACrD,OAAO,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;;GAKG;AACU,QAAA,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE;IACnD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,YAAY,IAAI,GAAG,iBAAU,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/D,CAAC,CAAC"}

package/dist/types/content/HubContent.d.ts

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

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

@@ -7,6 +7,7 @@ export * from "./get-family";
 export * from "./slugs";
 export * from "./fetch";
 export * from "./types";
+export * from "./HubContent";
 /**
  * ```js
  * import { getCategory } from "@esri/hub-common";

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

@@ -0,0 +1,11 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+import { IHubSearchResult } from "../search";
+import { IHubRequestOptions } 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>;

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

@@ -0,0 +1,30 @@
+import { IGroup } from "@esri/arcgis-rest-portal";
+import { IGroupMembershipSummary } from "../..";
+import { IEnrichmentErrorInfo, IHubRequestOptions } from "../../types";
+/**
+ * Possible additional properties available through enrichments
+ */
+export interface IGroupEnrichments {
+    contentCount?: number;
+    membershipSummary?: IGroupMembershipSummary;
+    /**
+     * Any errors encountered when fetching enrichments
+     * see https://github.com/ArcGIS/hub-indexer/blob/master/docs/errors.md#response-formatting-for-errors
+     */
+    errors?: IEnrichmentErrorInfo[];
+}
+export declare type GroupEnrichment = keyof IGroupEnrichments;
+/**
+ * Merging of the Enrichment and the Group
+ */
+export interface IGroupAndEnrichments extends IGroupEnrichments {
+    group: IGroup;
+}
+/**
+ * Fetch enrichments for Groups
+ * @param group
+ * @param enrichments
+ * @param requestOptions
+ * @returns
+ */
+export declare function fetchGroupEnrichments(group: IGroup, enrichments: GroupEnrichment[], requestOptions?: IHubRequestOptions): Promise<IGroupAndEnrichments>;

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

@@ -1,2 +1,4 @@
 export * from "./_unprotect-and-remove-group";
 export * from "./add-users-workflow";
+export * from "./types";
+export * from "./HubGroups";

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

@@ -0,0 +1,15 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+/**
+ * Structure of the `membershipSummary` Group enrichment
+ */
+export interface IGroupMembershipSummary {
+    /**
+     * Total number of members
+     */
+    total: number;
+    /**
+     * Up to three group members. Used
+     * to display subset of avatars in cards.
+     */
+    users: IUser[];
+}

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

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

package/dist/types/index.d.ts

@@ -24,6 +24,7 @@ export * from "./urls";
 export * from "./util";
 export * from "./utils";
 export * from "./Hub";
+export * from "./pages";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/pages/HubPages.d.ts

@@ -0,0 +1,11 @@
+import { IItem } from "@esri/arcgis-rest-types";
+import { IHubSearchResult } from "../search";
+import { IHubRequestOptions } from "../types";
+/**
+ * Fetch Page specific Enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichPageSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

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

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

package/dist/types/projects/HubProjects.d.ts

@@ -1,8 +1,9 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-import { Filter, IHubSearchOptions, ISearchResponse } from "..";
+import { Filter, IHubSearchOptions, ISearchResponse, IHubRequestOptions } from "..";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
+import { IHubSearchResult } from "../search";
 export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
 /**
  * Create a new Hub Project item
@@ -49,3 +50,11 @@ export declare function searchProjects(filter: Filter<"content">, options: IHubS
  * @returns
  */
 export declare function convertItemToProject(item: IItem, requestOptions: IRequestOptions): Promise<IHubProject>;
+/**
+ * Fetch project specific enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichProjectSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/search/_internal/hubSearchItems.d.ts

@@ -0,0 +1,18 @@
+import { IHubContent } from "../..";
+import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IFacet } from "../types";
+/**
+ * Execute item search against the Hub API
+ * @param filter
+ * @param options
+ * @returns
+ */
+export declare function hubSearchItems(filters: Array<IFilterGroup<"item">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
+/**
+ * Re-structure a jsonApi data entry into a flat object cast into
+ * IHubContent
+ * @param data
+ * @returns
+ */
+export declare function jsonApiToHubContent(data: Record<string, any>): IHubContent;
+export declare function hubContentToSearchResult(content: IHubContent): Promise<IHubSearchResult>;
+export declare function convertHubResponseToFacets(response: any, operation?: "OR" | "AND"): IFacet[];

package/dist/types/search/_internal/index.d.ts

@@ -1,2 +1,5 @@
 export * from "./searchContentEntities";
 export * from "./state";
+export * from "./portalSearchItems";
+export * from "./hubSearchItems";
+export * from "./portalSearchGroups";

package/dist/types/search/_internal/parseInclude.d.ts

@@ -0,0 +1,32 @@
+import { ItemOrServerEnrichment } from "../../items/_enrichments";
+/**
+ * @private
+ */
+export interface IIncludeSpec {
+    /**
+     * The backing enrichment to fetch - group, data, metadata etc
+     */
+    enrichment: ItemOrServerEnrichment;
+    /**
+     * The Path in the backing entity to pluck out
+     * If not specified, the entire entity will be returned
+     */
+    path: string;
+    /**
+     * Property name to use when attaching the information
+     * to the search result object
+     */
+    prop?: string;
+}
+/**
+ * Parse an IncludeSpec from the include string
+ * Include String structure:
+ * - `enrichment{.deep.path} AS propertyName`
+ *
+ * Examples
+ * - `server.layers.0.name as layerName` -> use the `server` enrichment, extract the name of the first layer and attach that as `layerName`
+ * - `server.layers` ->  use the `server` enrichment, attach the `layers` array as `layers`
+ * @param include
+ * @returns
+ */
+export declare function parseInclude(include: string): IIncludeSpec;

package/dist/types/search/_internal/portalSearchGroups.d.ts

@@ -0,0 +1,9 @@
+import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "../types";
+/**
+ * @private
+ * Portal Search Implementation for Items
+ * @param filterGroups
+ * @param options
+ * @returns
+ */
+export declare function portalSearchGroups(filterGroups: Array<IFilterGroup<"group">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/_internal/portalSearchItems.d.ts

@@ -0,0 +1,9 @@
+import { IFilterGroup, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "../types";
+/**
+ * @private
+ * Portal Search Implementation for Items
+ * @param filterGroups
+ * @param options
+ * @returns
+ */
+export declare function portalSearchItems(filterGroups: Array<IFilterGroup<"item">>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

package/dist/types/search/content-utils.d.ts

@@ -4,11 +4,19 @@ import { IFacet } from "./types/IFacet";
 /**
  * @private
  * Convert portal search response to facets
- * Note: Only applicable to a "content" search
+ * Note: Only applicable to an item search
  * @param response
  * @returns
  */
 export declare function convertPortalResponseToFacets(response: ISearchResult<IItem>, operation?: "OR" | "AND"): IFacet[];
+/**
+ * @private
+ * Convert portal search response to facets
+ * Note: Only applicable to an item search
+ * @param response
+ * @returns
+ */
+export declare function convertPortalItemResponseToFacets(response: ISearchResult<IItem>, operation?: "OR" | "AND", optionProp?: "filter" | "filters"): IFacet[];
 /**
  * Merge `Filter<"content">` objects
  *

package/dist/types/search/hubSearch.d.ts

@@ -0,0 +1,11 @@
+import { IFilterGroup, FilterType, IHubSearchOptions, IHubSearchResponse, IHubSearchResult } from "./types";
+/**
+ * Main Search function for ArcGIS Hub
+ *
+ * Default's to search ArcGIS Portal but can delegate
+ * to Hub API when it's available.
+ * @param filterGroups
+ * @param options
+ * @returns
+ */
+export declare function hubSearch(filterGroups: Array<IFilterGroup<FilterType>>, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -10,3 +10,4 @@ export * from "./types";
 export * from "./collectionState";
 export * from "./convertCatalog";
 export * from "./filter-utils";
+export * from "./hubSearch";

package/dist/types/search/types/ICollection.d.ts

@@ -7,6 +7,14 @@ import { Filter, FilterType, ISortOption } from "./types";
 export interface ICollection {
     label: string;
     key: string;
+    /**
+     * Filter Type used in this collection
+     */
+    filterType?: FilterType;
+    /**
+     * Specify the includes to be requested when working with this collection
+     */
+    include?: string[];
     defaultQuery?: string;
     sortOption: ISortOption;
     filter: Filter<FilterType>;

package/dist/types/search/types/IHubSearchOptions.d.ts

@@ -1,26 +1,67 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IModel } from "../..";
+import { IHubRequestOptions, IModel } from "../..";
 import { NamedApis, IApiDefinition } from "./types";
-/**
- * Requestable Enrichments
- */
 export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
 /**
  * Search Options
  */
 export interface IHubSearchOptions {
+    /**
+     * Fields to return aggregations on
+     */
     aggFields?: string[];
+    /**
+     * Maximum number of aggregations to return
+     * Portal API only supports a single value
+     */
     aggLimit?: number;
+    /**
+     * Deprecate in favor of context
+     */
     api?: NamedApis | IApiDefinition;
+    /**
+     * TODO: Deprecate in requestOptions
+     */
     authentication?: UserSession;
+    /**
+     * While hubSearch requires requestOptions, it is not marked
+     * required because that is a breaking change to this
+     * interface, which is still required while we implement
+     * hubSearch
+     */
+    requestOptions?: IHubRequestOptions;
     bbox?: string;
+    /**
+     * Objects or fields to include
+     * e.g. `server.layers AS serverLayers`
+     */
+    include?: string[];
+    /**
+     * Enrichments
+     * Deprecated in favor of `include`
+     */
     enrichments?: Enrichments[];
-    fields?: string;
+    /**
+     * Maximum number of results to return, per-page
+     */
     num?: number;
+    /**
+     * What page of results to return
+     */
     page?: string;
+    /**
+     * What field should the results be sorted on
+     */
     sortField?: string;
+    /**
+     * Sort direction
+     */
     sortOrder?: "desc" | "asc";
+    /**
+     * TODO: Determine if this is used or can be removed
+     */
     start?: number;
     aggregations?: string[];
     site?: IModel;
+    fields?: string;
 }

package/dist/types/search/types/IHubSearchResult.d.ts

@@ -1,5 +1,18 @@
 import { HubFamily, IHubGeography } from "../..";
 import { AccessLevel, IHubEntityBase } from "../../core";
+/**
+ * Simple interface for Links
+ */
+export interface ILink {
+    /**
+     * Link url
+     */
+    href: string;
+    /**
+     * Additional optional properties
+     */
+    [key: string]: string;
+}
 /**
  * Standardized light-weight search result structure, applicable to all
  * types of search results - users, groups, content, events etc
@@ -18,20 +31,24 @@ export interface IHubSearchResult extends IHubEntityBase {
      */
     owner?: string;
     /**
+     * DEPRECATED use links.thumbnail
      * Fully qualified thumbnail url for items, groups, users
      * Will not have the token appended. Consuming app needs to
      * check the value of `access` and apply the token as needed
      */
-    thumbnailUrl: string;
+    thumbnailUrl?: string;
     /**
+     * DEPRECATED - use links
      * Hash of pre-computed urls
      */
-    urls: {
+    urls?: {
         /**
+         * DEPRECATED - use links
          * Canononical ArcGIS Online Url for this entity (if applicable)
          */
         portalHome?: string;
         /**
+         * DEPRECATED - use links
          * Relative url, which can be appended to a Site's root Url
          * e.g. /datasets/3ef8c7a, or /events/june-meeting
          * This is much easier than passing a Site into the search
@@ -39,11 +56,35 @@ export interface IHubSearchResult extends IHubEntityBase {
          */
         relative: string;
         /**
+         * DEPRECATED - use links
          * Allow for arbitrary other urls, including `.customUrl` which
          * can ben generated client-side in the gallery via a callback
          */
         [key: string]: string;
     };
+    /**
+     * Links to related things
+     */
+    links?: {
+        /**
+         * Url to Thumbnail. Will not include a token
+         */
+        thumbnail?: string;
+        /**
+         * Url to the entities canonical "self"
+         * For Items/Groups/Users, this will be the Home App url
+         * For other entities, it will be the canonical url
+         */
+        self: string;
+        /**
+         * Relative url of the entity, within a site
+         */
+        siteRelative: string;
+        /**
+         * Additional urls
+         */
+        [key: string]: string | ILink;
+    };
     /**
      * Geometry connected to this entity
      * For items, it will default to the extent,
@@ -52,9 +93,12 @@ export interface IHubSearchResult extends IHubEntityBase {
      */
     geometry?: IHubGeography;
     /**
+     * DEPRECATED - includes/enrichments are directly attached
      * Optional metadata hash
      * Any specified enrichments will be attached in here, as well
      * as tags, typekeywords and culture
      */
     metadata?: Record<string, any>;
+    /** Allow any additional properties to be added */
+    [key: string]: any;
 }

package/dist/types/search/types/types.d.ts

@@ -6,8 +6,7 @@ import { IFacet } from "./IFacet";
  *
  * `Filter<T extends FilterType>` [FilterType](../FilterType) is constrained to
  *
- * - `Filter<"any">` [IAnyFilterDefinition](../IAnyFilterDefinition)
- * - `Filter<"content">` [IContentFilterDefinition](../IContentFilterDefinition)
+ * - `Filter<"item">` [IContentFilterDefinition](../IContentFilterDefinition)
  * - `Filter<"user">` [IUserFilterDefinition](../IUserFilterDefinition)
  * - `Filter<"group">` [IGroupFilterDefinition](../IGroupFilterDefinition)
  *
@@ -15,8 +14,8 @@ import { IFacet } from "./IFacet";
  * and it must be `keyof` [FilterTypeMap](../FilterTypeMap)
  *
  * ```ts
- * const f:Filter<"content"> = {
- *   filterType: "content" // must match the FilterType
+ * const f:Filter<"item"> = {
+ *   filterType: "item" // must match the FilterType
  *   term: "water"
  * }
  * ```
@@ -24,15 +23,12 @@ import { IFacet } from "./IFacet";
 export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
     filterType: T;
 };
-export interface IFilterGroup<T extends FilterType> {
-    operation?: "AND" | "OR";
-    filters: Array<Filter<T>>;
-}
 /**
  * Groups of filters with an operation specifying how the
  * filters should be connected when serialized
  */
 export interface IFilterGroup<T extends FilterType> {
+    filterType: T;
     operation?: "AND" | "OR";
     filters: Array<Filter<T>>;
 }
@@ -42,23 +38,21 @@ export interface IFilterGroup<T extends FilterType> {
  */
 export interface IFilterTypeMap {
     item: IItemFilter;
+    user: IUserFilterDefinition;
+    group: IGroupFilterDefinition;
+    event: IEventFilterDefinition;
     /**
      * DEPRECATED use item
+     * // TODO: Remove with _searchContent
      */
     content: IContentFilterDefinition;
-    user: IUserFilterDefinition;
-    group: IGroupFilterDefinition;
-    event: IEventFilterDefinition;
 }
 export declare type FilterType = keyof IFilterTypeMap;
-/**
- * Common set of fields that are reasonable to apply at the
- * top level of a Catalog
- */
 export interface IItemFilter {
     access?: AccessLevel | AccessLevel[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
+    categories?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
     snippet?: string | string[] | IMatchOptions;
@@ -74,11 +68,13 @@ export interface IItemFilter {
 }
 /**
  * Fields related to Content based searches
+ * // TODO: Remove with _searchContent
  */
 export interface IContentFilterDefinition {
     access?: string | string[] | IMatchOptions;
     owner?: string | string[] | IMatchOptions;
     tags?: string | string[] | IMatchOptions;
+    categories?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
     description?: string | string[] | IMatchOptions;
     snippet?: string | string[] | IMatchOptions;
@@ -153,6 +149,7 @@ export interface IGroupFilterDefinition {
     term?: string;
     title?: string | string[] | IMatchOptions;
     typekeywords?: string | string[] | IMatchOptions;
+    isopendata?: boolean;
 }
 export interface IEventFilterDefinition {
     created?: IDateRange<number> | IRelativeDate;
@@ -216,6 +213,7 @@ export interface IMatchOptions {
 }
 /**
  * searchContent return
+ * // TODO: Remove with _searchContent
  */
 export interface IContentSearchResult {
     total: number;

package/dist/types/sites/HubSites.d.ts

@@ -1,5 +1,5 @@
 import { IItem } from "@esri/arcgis-rest-portal";
-import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSite, ISearchResponse } from "..";
+import { Filter, IHubRequestOptions, IHubSearchOptions, IHubSearchResult, IHubSite, ISearchResponse } from "..";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 export declare const HUB_SITE_ITEM_TYPE = "Hub Site Application";
 export declare const ENTERPRISE_SITE_ITEM_TYPE = "Site Application";
@@ -54,3 +54,11 @@ export declare function convertItemToSite(item: IItem, requestOptions: IRequestO
  * @returns
  */
 export declare function searchSites(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+/**
+ * Fetch Site specific enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichSiteSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/urls/getGroupHomeUrl.d.ts

@@ -0,0 +1,10 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../types";
+/**
+ * Return the URL of the group's page in the Portal Home application
+ * @param groupId The group's ID
+ * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
+ * @returns URL to the groups's url, defaults to `https://www.arcgis.com/home/group.html?id={group.id}`
+ */
+export declare function getGroupHomeUrl(groupId: string, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions): string;

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

@@ -15,6 +15,7 @@ export * from "./get-item-data-url";
 export * from "./convert-urls-to-anchor-tags";
 export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
+export * from "./getGroupHomeUrl";
 /**
  *
  * @param url