@esri/hub-common 9.10.1 → 9.13.0

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

@@ -0,0 +1,251 @@
+import { ResourceObject } from "jsonapi-typescript";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { HubType, HubFamily } from "../types";
+import { IHubContent, IModel } from "../types";
+/**
+ * JSONAPI dataset resource returned by the Hub API
+ */
+export declare type DatasetResource = ResourceObject<"dataset", {
+    [k: string]: any;
+}>;
+/**
+ * ```js
+ * import { getCategory } from "@esri/hub-common";
+ * //
+ * getCategory('Feature Layer')
+ * > 'dataset'
+ * ```
+ * **DEPRECATED: Use getCollection() instead**
+ * returns the Hub category for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the category of a given item type.
+ */
+export declare function getCategory(itemType?: string): string;
+/**
+ * ```js
+ * import { getTypes } from "@esri/hub-common";
+ * //
+ * getTypes('site')
+ * > [ 'hub site application' ]
+ * ```
+ * To do.
+ * @param category The ArcGIS Hub category.
+ * @returns all the item types for the given category.
+ *
+ */
+export declare function getTypes(category?: string): string[];
+/**
+ * ```js
+ * import { normalizeItemType } from "@esri/hub-common";
+ * //
+ * normalizeItemType(item)
+ * > [ 'Hub Site Application' ]
+ * ```
+ * @param item Item object.
+ * @returns type of the input item.
+ *
+ */
+export declare function normalizeItemType(item?: any): string;
+/**
+ * ```js
+ * import { getTypeCategories } from "@esri/hub-common";
+ * //
+ * getTypeCategories(item)
+ * > [ 'Hub Site Application' ]
+ * ```
+ * @param item Item object.
+ * @returns typeCategory of the input item.
+ *
+ */
+export declare function getTypeCategories(item?: any): string[];
+/**
+ * ```js
+ * import { getCollection } from "@esri/hub-common";
+ * //
+ * getCollection('Feature Layer')
+ * > 'dataset'
+ * ```
+ * Get the Hub collection for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the Hub collection of a given item type.
+ */
+export declare function getCollection(itemType?: string): string;
+/**
+ * Case-insensitive check if the type is "Feature Service"
+ * @param {string} type - item's type
+ * @returns {boolean}
+ */
+export declare const isFeatureService: (type: string) => boolean;
+/**
+ * parse layer id from a service URL
+ * @param {string} url
+ * @returns {string} layer id
+ */
+export declare const getLayerIdFromUrl: (url: string) => string;
+/**
+ * return the layerId if we can tell that item is a single layer service
+ * @param {*} item from AGO
+ * @returns {string} layer id
+ */
+export declare const getItemLayerId: (item: IItem) => string;
+/**
+ * given an item, get the id to use w/ the Hub API
+ * @param item
+ * @returns Hub API id (hubId)
+ */
+export declare const getItemHubId: (item: IItem) => string;
+/**
+ * ```js
+ * import { getContentIdentifier } from "@esri/hub-common";
+ * //
+ * getContentIdentifier(content, site)
+ * > 'f12hhjk32' // id
+ * // OR
+ * > 'content-slug' // human-readable slug
+ * ```
+ * Returns the preferred identifier for a piece of content (determined by content type):
+ * - Content from the 'template' and 'feedback' families return the standard id field
+ * - Pages that are linked to the site parameter will return the slug defined by the site. Otherwise, the page id will be returned
+ * - All other content will return the highest available item in the following hierarchy:
+ *   1. slug - includes org prefix if the site parameter is a portal or has an orgKey different from the slug prefix
+ *   2. hubId
+ *   3. id
+ * @param content The IHubContent item
+ * @param site The site to compare content against
+ * @returns the preferred id for the given content.
+ */
+export declare function getContentIdentifier(content: IHubContent, site?: IModel): string;
+/**
+ * Parse item ID and layer ID (if any) from dataset record ID
+ *
+ * @param datasetId Hub API dataset record id ({itemId}_{layerId} or {itemId})
+ * @returns A hash with the `itemId` and `layerId` (if any)
+ */
+export declare function parseDatasetId(datasetId: string): {
+    itemId: string;
+    layerId?: string;
+};
+/**
+ * Determine if an identifier is a Hub API slug
+ *
+ * @param identifier Hub API slug ({orgKey}::{title-as-slug} or {title-as-slug})
+ * or record id ((itemId}_{layerId} or {itemId})
+ * @returns true if the identifier is valid _and_ is **not** a record id
+ */
+export declare function isSlug(identifier: string): boolean;
+/**
+ * Add a context (prefix) to slug if it doesn't already have one
+ *
+ * @param slug Hub API slug (with or without context)
+ * @param context usually a portal's orgKey
+ * @returns slug with context ({context}::{slug})
+ */
+export declare function addContextToSlug(slug: string, context: string): string;
+/**
+ * Remove context (prefix) from a slug
+ *
+ * @param slug Hub API slug with context
+ * @param context usually a portal's orgKey
+ * @returns slug without context
+ */
+export declare function removeContextFromSlug(slug: string, context: string): string;
+/**
+ * Splits item category strings at slashes and discards the "Categories" keyword
+ *
+ * ```
+ * ["/Categories/Boundaries", "/Categories/Planning and cadastre/Property records", "/Categories/Structure"]
+ * ```
+ * Should end up being
+ * ```
+ * ["Boundaries", "Planning and cadastre", "Property records", "Structure"]
+ * ```
+ *
+ * @param categories - an array of strings
+ * @private
+ */
+export declare function parseItemCategories(categories: string[]): string[];
+/**
+ * return the Hub family given an item's type
+ * @param type item type
+ * @returns Hub family
+ */
+export declare function getFamily(type: string): HubFamily;
+/**
+ * DEPRECATED: Use getFamily() instead.
+ *
+ * get the HubType for a given item or item type
+ *
+ * @param itemOrType an item or item.type
+ */
+export declare function getItemHubType(itemOrType: IItem | string): HubType;
+/**
+ * Convert a Portal item to Hub content
+ *
+ * @param item Portal Item
+ * @returns Hub content
+ * @export
+ */
+export declare function itemToContent(item: IItem): IHubContent;
+/**
+ * Convert a Hub API dataset resource to Hub Content
+ *
+ * @param {DatasetResource} Dataset resource
+ * @returns {IHubContent} Hub content object
+ * @export
+ */
+export declare function datasetToContent(dataset: DatasetResource): IHubContent;
+/**
+ * Convert a Hub API dataset resource to a portal item
+ *
+ * @param {DatasetResource} Dataset resource
+ * @returns {IItem} portal item
+ * @export
+ */
+export declare function datasetToItem(dataset: DatasetResource): IItem;
+/**
+ * returns a new content that has the specified type and
+ * and updated related properties like normalizedType, family, etc
+ * @param content orignal content
+ * @param type new type
+ * @returns new content
+ */
+export declare const setContentType: (content: IHubContent, type: string) => IHubContent;
+/**
+ * Compute the content type icon based on the normalizedType
+ * @param normalizedType
+ * @returns content type icon
+ */
+export declare const getContentTypeIcon: (normalizedType: string) => any;
+/**
+ * Compute the content type label
+ * @param normalizedType
+ * @param isProxied
+ * @returns content type label
+ */
+export declare const getContentTypeLabel: (normalizedType: string, isProxied: boolean) => string;
+/**
+ * returns a new content that has the specified hubId and updated identifier
+ * @param content orignal content
+ * @param hubId new hubId
+ * @returns new content
+ */
+export declare const setContentHubId: (content: IHubContent, hubId: string) => IHubContent;
+/**
+ * Calculates the relative and absolute urls for a given content on a specific site
+ *
+ * @param content
+ * @param siteModel
+ * @returns relative and absolute urls
+ */
+export declare const getContentSiteUrls: (content: IHubContent, siteModel: IModel) => {
+    relative: string;
+    absolute: string;
+};
+/**
+ * append the absolute URL to the content on the site
+ * also updates the relative URL in case the
+ * @param content
+ * @param siteModel
+ * @returns
+ */
+export declare const setContentSiteUrls: (content: IHubContent, siteModel: IModel) => IHubContent;

package/dist/types/downloads/build-existing-exports-portal-query.d.ts

@@ -0,0 +1,86 @@
+import { ISpatialReference } from "@esri/arcgis-rest-types";
+export declare const WGS84_WKID = "4326";
+export declare const PORTAL_EXPORT_TYPES: {
+    csv: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    kml: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    shapefile: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    fileGeodatabase: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    geojson: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    excel: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+    featureCollection: {
+        name: string;
+        itemTypes: string[];
+        supportsProjection: boolean;
+    };
+};
+interface IExistingExportsPortalQueryOptions {
+    layerId?: number | string;
+    onlyTypes?: string[];
+    spatialRefId?: string;
+}
+/**
+ * Puts a spatial reference into a serialized format that can be used
+ * for item typeKeywords.
+ *
+ * **Note**: discards "latestWkid"
+ *
+ * In the past we used `JSON.stringify`, but that causes problems because
+ * it can include commas which are interpreted by the portal [update item call](https://developers.arcgis.com/rest/users-groups-and-items/update-item.htm)
+ * as being separate typekeywords. With `JSON.stringify`, equality was also
+ * dependent on the order of the properties in the spatial reference.
+ *
+ * Check https://developers.arcgis.com/web-map-specification/objects/spatialReference/
+ * for more details on what this object looks like.
+ */
+export declare function serializeSpatialReference(spatialReference: ISpatialReference | string): string;
+/**
+ * Builds the Portal API query string to search for exports from a given dataset
+ *
+ * @param itemId - The dataset ID
+ * @param options - A set of options including item types, layerId, and spatialRefId
+ * @returns
+ */
+export declare function buildExistingExportsPortalQuery(itemId: string, options?: IExistingExportsPortalQueryOptions): string;
+/**
+ * Generates typekeyword for identifying which spatialRefId an export is
+ * @param spatialRefId - either a WKID, WKT, or stringified ISpatialReference
+ * @private
+ */
+export declare function getSpatialRefTypeKeyword(spatialRefId: string): string;
+/**
+ * Returns the keyword identifying exports by the item they originate from
+ * @param itemId - ID for the item from which the export originated
+ * @private
+ */
+export declare function getExportItemTypeKeyword(itemId: string): string;
+/**
+ * Returns the keyword identifying exports by the layer they originate from
+ * @param layerId - ID for the layer from which the export originated
+ * @private
+ */
+export declare function getExportLayerTypeKeyword(layerId?: number | string): string;
+export {};

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

@@ -0,0 +1 @@
+export * from "./build-existing-exports-portal-query";

package/dist/types/extent.d.ts

@@ -0,0 +1,33 @@
+import { IExtent, IPolygon } from "@esri/arcgis-rest-types";
+import { IHubRequestOptions, BBox } from "./types";
+export declare function createExtent(xmin: number, ymin: number, xmax: number, ymax: number, wkid?: number): IExtent;
+/**
+ * Turns an extent into a bbox
+ * @param envelope extent
+ */
+export declare function extentToBBox(envelope: IExtent): BBox;
+export declare const GLOBAL_EXTENT: IExtent;
+/**
+ * Gets the geographic extent for an org
+ * @param hubRequestOptions
+ */
+export declare function getGeographicOrgExtent(hubRequestOptions: IHubRequestOptions): Promise<IExtent>;
+/**
+ * Get the default org extent as a bbox for use on item.extent
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function getOrgExtentAsBBox(hubRequestOptions: IHubRequestOptions): Promise<BBox>;
+/**
+ * checks if the extent is a valid BBox (2 element array of coordinate pair arrays)
+ * @param extent
+ * @returns
+ */
+export declare const isBBox: (extent: unknown) => boolean;
+export declare function isExtentCoordinateArray(extent: object): boolean;
+/**
+ * Check if the given extent is in a known format
+ * @param  {Object} extent extent in any format
+ * @return {Boolean}       indicator
+ */
+export declare function isValidExtent(extent: object): boolean;
+export declare const bBoxToPolygon: (bBox: BBox) => IPolygon;

package/dist/types/groups/_unprotect-and-remove-group.d.ts

@@ -0,0 +1,10 @@
+import { IUserGroupOptions } from "@esri/arcgis-rest-portal";
+/**
+ * Unprotect and Remove a Group.
+ * Assumed caller has checked that the current user should be able
+ * to unprotect and remove the group. Underlying calls are failsafe
+ * so a failure to unprotect or remove the group will not reject
+ * @param {IUserGroupOptions} userGroupOptions id and authentication
+ * @private
+ */
+export declare function _unprotectAndRemoveGroup(userGroupOptions: IUserGroupOptions): Promise<any>;

package/dist/types/groups/add-users-workflow/add-users-to-group.d.ts

@@ -0,0 +1,33 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../../types";
+import { IConsolidatedResult, IEmail } from "./interfaces";
+/**
+ * Adds, invites or emails users about joining a group
+ * based on the permissions of the requesting user. The
+ * function returns a hash of results indicating which
+ * operations were attempted and whether they were successful.
+ *
+ * In general, this algorithm will auto-add all the users
+ * that it can, invite the others, and send emails to eligible
+ * invited users (See below for more details)
+ *
+ * Here are a couple caveats to be aware of:
+ * 1) If the requestingUser can auto-add to the group (A.K.A. has
+ * portal:admin:assignToGroups) no email will be sent, period.
+ * 2) Emails can only be sent to members of the same org as the
+ * requesting user if they have been invited (not auto-added)
+ * to the group. If emails must to be sent to invited members
+ * of a second org (e.g a community org), an authenticated user
+ * of the second org must be passed in (see secondaryRO)
+ * 3) If no email is passed in, no email will be sent
+ * 4) If auto-adding fails, the unadded users will be invited
+ *
+ * @param {string} groupId
+ * @param {IUser[]} allUsers
+ * @param {IHubRequestOptions} primaryRO Info and authentication for the requesting user
+ * @param {IEmail} [email] Email to be sent (if qualifying users are passed in)
+ * @param {IHubRequestOptions} [secondaryRO] Info and authentication for emailing members of a secondary organization (typically a community org)
+ *
+ * @returns {IConsolidatedResult} The operations attempted, whether they were successful and any errors
+ */
+export declare function addUsersToGroup(groupId: string, allUsers: IUser[], primaryRO: IHubRequestOptions, email?: IEmail, secondaryRO?: IHubRequestOptions): Promise<IConsolidatedResult>;

package/dist/types/groups/add-users-workflow/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./output-processors";
+export * from "./utils";
+export * from "./workflow-sections";
+export * from "./add-users-to-group";
+export * from "./interfaces";

package/dist/types/groups/add-users-workflow/interfaces.d.ts

@@ -0,0 +1,33 @@
+import { ICreateOrgNotificationResult, IInviteGroupUsersResult, IUser } from "@esri/arcgis-rest-portal";
+import { ArcGISRequestError } from "@esri/arcgis-rest-request";
+import { IHubRequestOptions } from "../../types";
+export interface IEmail {
+    subject?: string;
+    body?: string;
+    copyMe?: boolean;
+}
+export interface IConsolidatedResult {
+    success: boolean;
+    autoAdd?: ISimpleResult;
+    invite?: IInviteGroupUsersResult;
+    email?: ICreateOrgNotificationResult;
+}
+export interface ISimpleResult {
+    success: boolean;
+    errors?: ArcGISRequestError[];
+}
+export interface IAddMemberContext {
+    groupId: string;
+    allUsers: IUser[];
+    primaryRO: IHubRequestOptions;
+    requestingUser: IUser;
+    usersToAutoAdd: IUser[];
+    usersToInvite: IUser[];
+    usersToEmail: IUser[];
+    email?: IEmail;
+    secondaryRO?: IHubRequestOptions;
+    autoAddResult?: ISimpleResult;
+    inviteResult?: IInviteGroupUsersResult;
+    primaryEmailResult?: ICreateOrgNotificationResult;
+    secondaryEmailResult?: ICreateOrgNotificationResult;
+}

package/dist/types/groups/add-users-workflow/output-processors/_consolidate-results.d.ts

@@ -0,0 +1,5 @@
+import { IAddMemberContext, IConsolidatedResult } from "../interfaces";
+/**
+ * @private
+ */
+export declare function _consolidateResults(context: IAddMemberContext): IConsolidatedResult;

package/dist/types/groups/add-users-workflow/output-processors/_format-auto-add-response.d.ts

@@ -0,0 +1,12 @@
+import { IAddGroupUsersResult } from "@esri/arcgis-rest-portal";
+import { IAddMemberContext } from "../interfaces";
+/**
+ * @private
+ *
+ * Coerce autoAdd response into a more similar interface as
+ * the other rest calls.
+ *
+ * If any users are not auto added, an error is added to the response
+ * and unadded users are placed into the invitation list
+ */
+export declare function _formatAutoAddResponse(rawResponse: IAddGroupUsersResult, context: IAddMemberContext): IAddMemberContext;

package/dist/types/groups/add-users-workflow/output-processors/_process-auto-add.d.ts

@@ -0,0 +1,5 @@
+import { IAddMemberContext } from "../interfaces";
+/**
+ * @private
+ */
+export declare function _processAutoAdd(context: IAddMemberContext): Promise<IAddMemberContext>;

package/dist/types/groups/add-users-workflow/output-processors/_process-invite.d.ts

@@ -0,0 +1,5 @@
+import { IAddMemberContext } from "../interfaces";
+/**
+ * @private
+ */
+export declare function _processInvite(context: IAddMemberContext): Promise<IAddMemberContext>;

package/dist/types/groups/add-users-workflow/output-processors/_process-primary-email.d.ts

@@ -0,0 +1,8 @@
+import { IAddMemberContext } from "../interfaces";
+/**
+ * @private
+ *
+ * Send email notification if an email object is present and
+ * the previous invitation call was successful
+ */
+export declare function _processPrimaryEmail(context: IAddMemberContext): Promise<IAddMemberContext>;

package/dist/types/groups/add-users-workflow/output-processors/_process-secondary-email.d.ts

@@ -0,0 +1,12 @@
+import { IAddMemberContext } from "../interfaces";
+/**
+ * @private
+ *
+ * If a secondary authentication is passed in AND
+ * an email object is passed in AND
+ * the previous invitation call was successful:
+ *
+ * Send an email notification to the invited
+ * users that are part of the secondary authentication's org
+ */
+export declare function _processSecondaryEmail(context: IAddMemberContext): Promise<IAddMemberContext>;

package/dist/types/groups/add-users-workflow/output-processors/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./_consolidate-results";
+export * from "./_format-auto-add-response";
+export * from "./_process-secondary-email";
+export * from "./_process-auto-add";
+export * from "./_process-invite";
+export * from "./_process-primary-email";

package/dist/types/groups/add-users-workflow/utils/_can-email-user.d.ts

@@ -0,0 +1,7 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+/**
+ * @private
+ *
+ * returns whether or not the users are in the same org
+ */
+export declare function _canEmailUser(recipient: IUser, sender: IUser): boolean;

package/dist/types/groups/add-users-workflow/utils/_get-auto-add-users.d.ts

@@ -0,0 +1,8 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+/**
+ * @private
+ *
+ * A user can be auto-added if they are part of the requesting user's e-org
+ * or c-org and the requesting user has the assignToGroups privilege
+ */
+export declare function _getAutoAddUsers(users: IUser[], requestingUser: IUser): IUser[];

package/dist/types/groups/add-users-workflow/utils/_get-email-users.d.ts

@@ -0,0 +1,8 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+/**
+ * @private
+ *
+ * A user can be emailed if they are invited (not auto-added)
+ * and the _canEmailUser condition is met
+ */
+export declare function _getEmailUsers(users: IUser[], requestingUser: IUser, includeSelf?: boolean): IUser[];

package/dist/types/groups/add-users-workflow/utils/_get-invite-users.d.ts

@@ -0,0 +1,7 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+/**
+ * @private
+ *
+ * A user will be invited if they cannot be auto-added
+ */
+export declare function _getInviteUsers(users: IUser[], requestingUser: IUser): IUser[];

package/dist/types/groups/add-users-workflow/utils/_is-org-admin.d.ts

@@ -0,0 +1,5 @@
+import { IUser } from "@esri/arcgis-rest-portal";
+/**
+ * @private
+ */
+export declare function _isOrgAdmin(user: IUser): boolean;

package/dist/types/groups/add-users-workflow/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./_can-email-user";
+export * from "./_get-auto-add-users";
+export * from "./_get-email-users";
+export * from "./_get-invite-users";
+export * from "./_is-org-admin";

package/dist/types/groups/add-users-workflow/workflow-sections/auto-add-users.d.ts

@@ -0,0 +1,14 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+import { IAddGroupUsersResult } from "@esri/arcgis-rest-portal";
+import { IAuthenticationManager } from "@esri/arcgis-rest-request";
+/**
+ *
+ * Attempts to auto-add users to a group
+ *
+ * @param {string} id ID of the group the users will be added to
+ * @param {IUser[]} users
+ * @param {IAuthenticationManager} authentication
+ *
+ * @returns {IAddGroupUsersResult|null} Result of the transaction (null if no users are passed in)
+ */
+export declare function autoAddUsers(id: string, users: IUser[], authentication: IAuthenticationManager): Promise<IAddGroupUsersResult>;

package/dist/types/groups/add-users-workflow/workflow-sections/email-org-users.d.ts

@@ -0,0 +1,15 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+import { ICreateOrgNotificationResult } from "@esri/arcgis-rest-portal";
+import { IAuthenticationManager } from "@esri/arcgis-rest-request";
+import { IEmail } from "../interfaces";
+/**
+ * Attempts to email members of the requesting user's organization.
+ *
+ * @param {IUser[]} users Users to email (must be in the same org as the requesting user)
+ * @param {IEmail} email
+ * @param {IAuthenticationManager} authentication
+ * @param {boolean} isOrgAdmin // Whether the requesting user in an org admin
+ *
+ * @returns {object|null} A promise that resolves to the result of the transaction (null if no users are passed in)
+ */
+export declare function emailOrgUsers(users: IUser[], email: IEmail, authentication: IAuthenticationManager, isOrgAdmin: boolean): Promise<ICreateOrgNotificationResult>;

package/dist/types/groups/add-users-workflow/workflow-sections/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./auto-add-users";
+export * from "./email-org-users";
+export * from "./invite-users";

package/dist/types/groups/add-users-workflow/workflow-sections/invite-users.d.ts

@@ -0,0 +1,17 @@
+import { IUser } from "@esri/arcgis-rest-auth";
+import { IInviteGroupUsersResult } from "@esri/arcgis-rest-portal";
+import { IAuthenticationManager } from "@esri/arcgis-rest-request";
+/**
+ *
+ * Attempts to invite users to a group
+ *
+ * @param {string} id ID of the group the users will be invited to
+ * @param {object[]} users
+ * @param {object} authentication
+ * @param {number} expiration How long the invite will be active (in minutes)
+ * @param {string} role What role should they be added as. Defaults to group member
+ *
+ * @returns {object|null} Result of the transaction (null if no users are passed in)
+ */
+export declare function inviteUsers(id: string, users: IUser[], authentication: IAuthenticationManager, expiration?: number, // default to 2 week expiration TODO: is this actually 2 weeks?
+role?: "group_member" | "group_admin"): Promise<IInviteGroupUsersResult>;

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

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

package/dist/types/i18n/convert-to-well-known-locale.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert a requested locale into a locale we support.
+ * i.e. en-ca => en
+ * If the requested locale is not available, en will be returned
+ * @param {string} requestedLocale Locale we want
+ */
+export declare function convertToWellKnownLocale(requestedLocale?: string): string;

package/dist/types/i18n/fetch-hub-translation.d.ts

@@ -0,0 +1,8 @@
+import { IPortal } from "@esri/arcgis-rest-portal";
+/**
+ * Fetch the Hub translation file for a given locale
+ * These are all public urls and should never require auth/tokens etc
+ * @param {String} locale Locale code - i.e. `es`
+ * @param {Object} portal Portal Self
+ */
+export declare function fetchHubTranslation(locale: string, portal: IPortal, mode?: RequestMode): Promise<any>;

package/dist/types/i18n/get-culture.d.ts

@@ -0,0 +1,7 @@
+import { IHubRequestOptions } from "../types";
+/**
+ * Return the culture from the Hub Request Options
+ * In priority order: user.culture, portal.culture, en-us
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function getCulture(hubRequestOptions: IHubRequestOptions): any;