@esri/hub-common 9.24.2 → 9.25.2

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

@@ -1,11 +1,75 @@
+import { IExtent } from "@esri/arcgis-rest-feature-layer";
+import { IWithSlug } from "../traits/WithSlug";
 import { IWithLayout } from "../traits/WithLayout";
 import { IHubItemEntity } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added
  * @internal
  */
-export interface IHubSite extends IHubItemEntity, IWithLayout {
-    header: Record<string, any>;
-    footer: Record<string, any>;
-    pages: Record<string, any>;
+export interface IHubSite extends IHubItemEntity, IWithSlug, IWithLayout {
+    /**
+     * Array of minimal page objects
+     */
+    pages: Array<{
+        title: string;
+        id: string;
+        slug: string;
+    }>;
+    /**
+     * Site Theme as json
+     */
+    theme: Record<string, any>;
+    /**
+     * Array of capabilities enabled for the site
+     */
+    capabilities: string[];
+    /**
+     * Currently not an actual ICatalog
+     */
+    catalog: {
+        groups: string[];
+        [key: string]: any;
+    };
+    /**
+     * Subdomain of the site
+     * Will be prepended to `<org-key>.hub.arcgis.com`
+     */
+    subdomain: string;
+    /**
+     * Full hostname
+     * Looks like`<subdomain>-<org-key>.hub.arcgis.com`
+     */
+    defaultHostname: string;
+    /**
+     * Custom Domain Name
+     */
+    customHostname: string;
+    /**
+     * oAuth Client Id for the Site
+     */
+    clientId: string;
+    /**
+     * Feed configurations
+     */
+    feeds: Record<string, any>;
+    /**
+     * Default extent used when loading maps on the site
+     */
+    defaultExtent: IExtent;
+    /**
+     * Default map configuration for the site
+     */
+    map: Record<string, any>;
+    /**
+     * Content Views settings
+     */
+    contentViews: Record<string, any>;
+    /**
+     * Site Telemetry Settings
+     */
+    telemetry: Record<string, any>;
+    /**
+     * Header CSS
+     */
+    headerSass: string;
 }

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

@@ -0,0 +1,28 @@
+export interface IHubSiteTheme {
+    header: {
+        background: string;
+        text: string;
+    };
+    body: {
+        background: string;
+        text: string;
+        link: string;
+    };
+    button: {
+        background: string;
+        text: string;
+    };
+    logo: {
+        small: string;
+    };
+    fonts: {
+        base: {
+            url: string;
+            family: string;
+        };
+        heading: {
+            url: string;
+            family: string;
+        };
+    };
+}

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

@@ -1,15 +1,17 @@
-export * from "./IItemEnrichments";
-export * from "./IHubContentEnrichments";
 export * from "./IHubContent";
+export * from "./IHubContentEnrichments";
 export * from "./IHubEntityBase";
-export * from "./IHubItemEntity";
 export * from "./IHubEntityManager";
 export * from "./IHubEvent";
 export * from "./IHubImage";
 export * from "./IHubInitiative";
+export * from "./IHubItemEntity";
+export * from "./IHubItemEntityManager";
 export * from "./IHubLayout";
 export * from "./IHubPage";
 export * from "./IHubProject";
 export * from "./IHubSite";
+export * from "./IHubSiteTheme";
 export * from "./IHubTimeline";
+export * from "./IItemEnrichments";
 export * from "./IServerEnrichments";

package/dist/types/items/_enrichments.d.ts

@@ -1,6 +1,6 @@
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IItemEnrichments, IServerEnrichments } from "../core";
-import { IHubRequestOptions } from "../types";
+import { IEnrichmentErrorInfo, IHubRequestOptions } from "../types";
 /**
  * An object containing the item and fetched enrichments
  */
@@ -13,6 +13,15 @@ export interface IItemAndEnrichments extends IItemEnrichments, IServerEnrichment
  * or from the server that the item points to
  */
 export declare type ItemOrServerEnrichment = keyof IItemEnrichments | keyof IServerEnrichments;
+/**
+ * convert an error to an enrichment error info format
+ * and optionally append it to an existing array of those
+ * @param error
+ * @param errors an array of existing enrichment error info
+ * @returns a new array of enrichment error info
+ * @private
+ */
+export declare const getEnrichmentErrors: (error: Error | string, errors?: IEnrichmentErrorInfo[]) => IEnrichmentErrorInfo[];
 /**
  * Fetch enrichments for an item
  * @param item

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

@@ -16,3 +16,4 @@ export * from "./get-structured-license";
 export * from "./slugs";
 export * from "./normalize-solution-template-item";
 export * from "./setItemThumbnail";
+export * from "./registerBrowserApp";

package/dist/types/items/registerBrowserApp.d.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Register an Item as an application, enabling oAuth flows at custom
+ * domains. Only item types with "Application" in the name are valid
+ * with this API call.
+ * @param {string} itemId Item Id of item to create an application for
+ * @param {Array} redirectUris Array of valid redirect uris for the app
+ * @param {string} appType Defaults to "browser"
+ * @param {IRequestOptions} requestOptions
+ */
+export declare function registerBrowserApp(itemId: string, redirectUris: string[], requestOptions: IRequestOptions): Promise<any>;

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

@@ -4,6 +4,7 @@ import { ArcGISContextManager } from "../ArcGISContextManager";
 import { Filter, IArcGISContext, IHubSearchOptions, ISearchResponse } from "..";
 import { IHubEntityManager, IHubProject } from "../core/types";
 import { IHubItemEntityManager } from "../core/types/IHubItemEntityManager";
+import { IItem } from "@esri/arcgis-rest-types";
 /**
  * Centralized functions used to manage IHubProject instances
  *
@@ -96,4 +97,11 @@ export declare class HubProjectManager implements IHubEntityManager<IHubProject>
      * @returns
      */
     updateThumbnail(project: IHubProject, file: any, filename: string, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
+    /**
+     * Convert a Hub Project Item to a IHubProject
+     * @param item
+     * @param requestOptions
+     * @returns
+     */
+    fromItem(item: IItem, requestOptions?: IRequestOptions): Promise<IHubProject>;
 }

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

@@ -1,5 +1,6 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { Filter, IHubSearchOptions, ISearchResponse } from "..";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
 export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
@@ -30,4 +31,21 @@ export declare function fetchProject(identifier: string, requestOptions: IReques
  * @param requestOptions
  */
 export declare function destroyProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+/**
+ * Search for Projects, and get IHubProject results
+ *
+ * Different from `searchContent` in that this returns the specific entity type
+ *
+ * @param filter
+ * @param options
+ * @returns
+ */
 export declare function searchProjects(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubProject>>;
+/**
+ * Convert an Hub Project Item into a Hub Project, fetching any additional
+ * information that may be required
+ * @param item
+ * @param auth
+ * @returns
+ */
+export declare function convertItemToProject(item: IItem, requestOptions: IRequestOptions): Promise<IHubProject>;

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

@@ -0,0 +1,32 @@
+import { ISearchOptions } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-types";
+import { ISearchResponse } from "../../types";
+import { Filter, IHubSearchOptions } from "../../search/types";
+/**
+ * Definition of `convertItemTo<T>` functions
+ */
+export declare type ItemToEntityFunction<T> = (i: IItem, ro?: IRequestOptions) => Promise<T>;
+/**
+ * Generic search that returns Hub Entity types converted from items
+ * by the passed in `ItemToEntityFunction`
+ *
+ * This abstraction is used to ensure that searching from any of the
+ * entity managers / modules is consistent, and returns the entity
+ * types, instead of `IItem` or `IHubContent`
+ *
+ * @param filter
+ * @param convertFn
+ * @param options
+ * @returns
+ */
+export declare function searchContentEntities<T>(filter: Filter<"content">, convertFn: ItemToEntityFunction<T>, options: IHubSearchOptions): Promise<ISearchResponse<T>>;
+/**
+ * Return a function that holds a closure containing
+ * a hub entity specific conversion function. This
+ * allows the `.next()` function to use the function on
+ * subsequent calls
+ * @param convertFn
+ * @returns
+ */
+export declare function createContentEntitySearchFn<T>(convertFn: ItemToEntityFunction<T>): (v: ISearchOptions) => Promise<ISearchResponse<T>>;

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

@@ -1,6 +1,6 @@
 import { IUser } from "@esri/arcgis-rest-auth";
 import { IGroup, ISearchOptions } from "@esri/arcgis-rest-portal";
-import { ISearchResponse } from "..";
+import { ISearchResponse } from "../types";
 import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types";
 /**
  * Well known APIs

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

@@ -0,0 +1,104 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubEntityManager, IHubItemEntityManager, IHubSite } from "../core/types";
+import { ArcGISContextManager } from "../ArcGISContextManager";
+import { Filter, IHubSearchOptions } from "../search";
+import { IHubRequestOptions, ISearchResponse } from "../types";
+import { IItem } from "@esri/arcgis-rest-types";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHubItemEntityManager<IHubSite> {
+    /**
+     * Hold a context manager, which should be a single instance for
+     * an application. When authentication changes, the .context
+     * property on the context manager will be replaced. As long as
+     * all the fns in this class leverage properties on .context
+     * everything be kept in sync.
+     */
+    private _contextManager;
+    /**
+     * Hold context directly. Allows the class to be used in places
+     * where an `ArcGISContextManager` is not directly available, but
+     * an `IArcGISContext` is
+     */
+    private _context;
+    /**
+     * Private so we can employ a factory function should we need
+     * async work during creation
+     * @param contextOrManager
+     */
+    private constructor();
+    /**
+     * Factory function to construct a new HubProjectManager instance.
+     *
+     * Note: Used so that we could do async actions in the ctor.
+     * @param contextOrManager
+     * @returns
+     */
+    static init(contextOrManager: ArcGISContextManager | IArcGISContext): HubSiteManager;
+    /**
+     * Getter to abstract how we store the context
+     */
+    private get context();
+    /**
+     * Create and store a new Site
+     *
+     * This also registers the item for oAuth and
+     * registers domain names with the hub Domain system
+     *
+     * Sites are stored as Items in the Sharing API
+     * @param site
+     * @param requestOptions
+     * @returns
+     */
+    create(site: Partial<IHubSite>, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
+    /**
+     * Update a Site
+     * @param site
+     * @param requestOptions
+     * @returns
+     */
+    update(site: IHubSite, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
+    /**
+     * Destroy a Site
+     * This permanently removes the backing Item,
+     * and clears the domain entries for it.
+     * @param id
+     * @param requestOptions
+     * @returns
+     */
+    destroy(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
+    /**
+     * Fetch a Site via Id, slug or domain
+     *
+     * This function does not require a user to be
+     * authenticated, but it does require an `IRequestOptions`
+     * which contains the portal instance to communicate with
+     * @param identifier
+     * @param requestOptions
+     * @returns
+     */
+    fetch(identifier: string, requestOptions?: IHubRequestOptions): Promise<IHubSite>;
+    /**
+     * Search for Sites
+     *
+     * @param filter
+     * @param opts
+     */
+    search(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;
+    /**
+     * Set the thumbnail for the Site
+     * @param id
+     * @param file
+     * @param filename
+     * @param requestOptions
+     * @returns
+     */
+    updateThumbnail(site: IHubSite, file: any, filename: string, requestOptions?: IUserRequestOptions): Promise<IHubSite>;
+    /**
+     * Convert a Hub Project Item to a IHubProject
+     * @param item
+     * @param requestOptions
+     * @returns
+     */
+    fromItem(item: IItem, requestOptions?: IRequestOptions): Promise<IHubSite>;
+}

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

@@ -0,0 +1,56 @@
+import { IItem } from "@esri/arcgis-rest-portal";
+import { Filter, IHubRequestOptions, IHubSearchOptions, 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";
+/**
+ * Create a new Hub Site
+ *
+ * Minimum properties are `name` and `org`
+ * @param partialSite
+ * @param requestOptions
+ */
+export declare function createSite(partialSite: Partial<IHubSite>, requestOptions: IHubRequestOptions): Promise<IHubSite>;
+/**
+ * Update a Hub Site
+ *
+ * This checks for and applies domain changes
+ * @param site
+ * @param requestOptions
+ * @returns
+ */
+export declare function updateSite(site: IHubSite, requestOptions: IHubRequestOptions): Promise<IHubSite>;
+/**
+ * Remove a Hub Site
+ *
+ * This simply removes the Site item, and it's associated domain records.
+ * This does not remove any Teams/Groups or content associated with the
+ * Site
+ * @param id
+ * @param requestOptions
+ * @returns
+ */
+export declare function destroySite(id: string, requestOptions: IHubRequestOptions): Promise<void>;
+/**
+ * Returns site model given various kinds of identifier
+ *
+ * @param identifier - a site item ID, site hostname, enterprise site slug, or full site URL
+ * @param requestOptions
+ * @private // remove when we remove existing fetchSite function
+ */
+export declare function _fetchSite(identifier: string, requestOptions: IHubRequestOptions): Promise<IHubSite>;
+/**
+ * Convert a Hub Site Application item into a Hub Site, fetching any
+ * additional information that may be required
+ * @param item
+ * @param auth
+ * @returns
+ */
+export declare function convertItemToSite(item: IItem, requestOptions: IRequestOptions): Promise<IHubSite>;
+/**
+ * Search for Sites and get IHubSite results
+ * @param filter
+ * @param options
+ * @returns
+ */
+export declare function searchSites(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubSite>>;

package/dist/types/sites/{_apply-site-schema.d.ts → _internal/_apply-site-schema.d.ts}

@@ -1,4 +1,4 @@
-import { IModel } from "../types";
+import { IModel } from "../../types";
 /**
  * Apply the first schema version to the item
  * @param {Object} model Site Model

package/dist/types/sites/{_enforce-lowercase-domains.d.ts → _internal/_enforce-lowercase-domains.d.ts}

@@ -1,4 +1,4 @@
-import { IModel } from "..";
+import { IModel } from "../..";
 /**
  * Enforce lowercase domains
  * @param {Object} model Site Model

package/dist/types/sites/{_ensure-catalog.d.ts → _internal/_ensure-catalog.d.ts}

@@ -1,4 +1,4 @@
-import { IModel } from "..";
+import { IModel } from "../..";
 /**
  * Move the data.values.groups array into the
  * data.catalog object

package/dist/types/sites/{_ensure-telemetry.d.ts → _internal/_ensure-telemetry.d.ts}

@@ -1,4 +1,4 @@
-import { IModel, IDraft } from "..";
+import { IModel, IDraft } from "../..";
 /**
  * Add telemetry config object
  * @private

package/dist/types/sites/{_migrate-feed-config.d.ts → _internal/_migrate-feed-config.d.ts}

@@ -1,4 +1,4 @@
-import { IModel } from "..";
+import { IModel } from "../..";
 /**
  * Migrates the site so it can store configurations for multiple feed formats
  * (dcat-us-1.1, dcat-ap-2.0.1, etc.). If the site has an existing custom

package/dist/types/sites/{_purge-non-guids-from-catalog.d.ts → _internal/_purge-non-guids-from-catalog.d.ts}

@@ -1,4 +1,4 @@
-import { IModel } from "..";
+import { IModel } from "../..";
 /**
  * Remove any non-guid entries from the data catalog groups array
  * @param {object} model Site Model

package/dist/types/sites/_internal/handleDomainChanges.d.ts

@@ -0,0 +1,9 @@
+import { IHubRequestOptions, IModel } from "../..";
+/**
+ * Given two site models, determine the domain changes and apply them
+ * @param currentModel
+ * @param updatedModel
+ * @param requestOptions
+ * @private
+ */
+export declare function handleDomainChanges(updatedModel: IModel, currentModel: IModel, requestOptions: IHubRequestOptions): Promise<any[]>;

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

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

package/dist/types/sites/domains/addSiteDomains.d.ts

@@ -0,0 +1,11 @@
+import { IHubRequestOptions, IModel } from "../..";
+/**
+ * Given a Site Model, register the domains with the Domain Service.
+ *
+ * This should only be used when creating a site. To update domains related
+ * to a site, use the `addDomain` and `removeDomain` functions directly
+ *
+ * @param {Object} model site model
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function addSiteDomains(model: IModel, hubRequestOptions: IHubRequestOptions): Promise<any[]>;

package/dist/types/sites/domains/index.d.ts

@@ -17,3 +17,5 @@ export * from "./remove-domains-by-site-id";
 export * from "./update-domain";
 export * from "./_ensure-safe-domain-length";
 export * from "./ensure-unique-domain-name";
+export * from "./addSiteDomains";
+export * from "./removeDomainByHostname";

package/dist/types/sites/domains/removeDomainByHostname.d.ts

@@ -0,0 +1,10 @@
+import { IHubRequestOptions } from "../../types";
+/**
+ * Remove an entry from the domain service, based on a hostname
+ *
+ * Callers must ensure the user is a member of the org that
+ * owns the domain entry else the call will fail.
+ * @param hostname
+ * @param hubRequestOptions
+ */
+export declare function removeDomainByHostname(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<void>;

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

@@ -0,0 +1,12 @@
+import { IHubRequestOptions, IModel } from "..";
+/**
+ * Returns site model given various kinds of identifier
+ *
+ * @param identifier - a site item ID, site hostname, enterprise site slug, or full site URL
+ * @param hubRequestOptions
+ */
+export declare function fetchSiteModel(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<IModel>;
+/**
+ * @private // keep out of docs
+ */
+export declare function fetchSite(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<IModel>;

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

@@ -1,14 +1,11 @@
-import { IHubRequestOptions } from "../types";
-/**
- * Returns site model given various kinds of identifier
- *
- * @param identifier - a site item ID, site hostname, enterprise site slug, or full site URL
- * @param hubRequestOptions
- */
-export declare function fetchSite(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<import("../types").IModel>;
+export * from "./_internal/_ensure-telemetry";
 export * from "./domains";
 export * from "./drafts";
-export * from "./_ensure-telemetry";
+export * from "./fetchSiteModel";
 export * from "./get-site-by-id";
+export * from "./HubSiteManager";
+export * from "./HubSites";
+export * from "./registerSiteAsApplication";
 export * from "./site-schema-version";
+export * from "./themes";
 export * from "./upgrade-site-schema";

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

@@ -0,0 +1,8 @@
+import { IHubRequestOptions, IModel } from "..";
+/**
+ * Register the Site item as an application so we can oauth against it
+ * @param {string} siteId Item Id of the site
+ * @param {Array} uris Arrayf valid uris for the site
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function registerSiteAsApplication(model: IModel, hubRequestOptions: IHubRequestOptions): Promise<any>;

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

@@ -0,0 +1,11 @@
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubSiteTheme } from "..";
+/**
+ * Default Site Theme
+ */
+export declare const DEFAULT_THEME: IHubSiteTheme;
+/**
+ * Return the default theme, extended with values from the Org's shared theme
+ * @param {Object} portalSelf Org's Portal object
+ */
+export declare function getOrgDefaultTheme(portalSelf: IPortal): IHubSiteTheme;

package/dist/types/utils/_array.d.ts

@@ -0,0 +1,9 @@
+/**
+ * concat an array of arrays
+ * excluding any elements of the top level array
+ * that are not actually arrays
+ * @param arrays An array of arrays
+ * @returns concatenated array
+ * @private
+ */
+export declare const maybeConcat: (arrays: any[][]) => any[];