@esri/hub-common 9.13.2 → 9.16.0

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

@@ -0,0 +1,25 @@
+/**
+ * Hub Images can either be the name of a resource
+ * or a full url to a publicly accessible image
+ */
+export interface IHubImage {
+    /**
+     * What type of image does this reference?
+     */
+    type: "resource" | "url";
+    /**
+     * The name of the resource, or the url
+     */
+    value: string;
+}
+/**
+ * Extends IHubImage with a resource property
+ * User to send an image file to a store
+ */
+export interface IHubImageOptions extends IHubImage {
+    /**
+     * If defined, treated as a file and uploaded
+     * into a resource associated with an item
+     */
+    resource?: any;
+}

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

@@ -0,0 +1,8 @@
+import { IWithBannerImage } from "../traits/WithBannerImage";
+import { IHubItemEntity } from "./IHubItemEntity";
+/**
+ * DRAFT: Under development and more properties will likely be added
+ * @internal
+ */
+export interface IHubInitiative extends IHubItemEntity, IWithBannerImage {
+}

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

@@ -0,0 +1,42 @@
+import { IHubEntityBase } from "./IHubEntityBase";
+import { IHubGeography } from "../..";
+/**
+ * Properties exposed by Entities that are backed by Items
+ */
+export interface IHubItemEntity extends IHubEntityBase {
+    /**
+     * Thumbnail Uril (read-only)
+     */
+    thumbnailUrl?: string;
+    /**
+     * Username of the owner of the item
+     */
+    owner: string;
+    /**
+     * Description for the item
+     */
+    description?: string;
+    /**
+     * boundary will default to the item extent
+     * but can be overwritten by enrichments from the Hub API (inline)
+     * or fetched from a location such as /resources/boundary.json
+     */
+    boundary?: IHubGeography;
+    /**
+     * Culture code of the content
+     * i.e. `en-us`
+     */
+    culture?: string;
+    /**
+     * User configurable tags
+     */
+    tags: string[];
+    /**
+     * System configurable typekeywords
+     */
+    typeKeywords?: string[];
+    /**
+     * Canonical Url for the Entity
+     */
+    url?: string;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * General interface for a Layout
+ *
+ * Optional header and footer are only used for
+ * a Hub Site
+ */
+export interface IHubLayout {
+    /**
+     * Sections are required for all Layouts
+     */
+    sections: [Record<string, any>];
+    /**
+     * header is optional; Only used in Sites
+     */
+    header?: Record<string, any>;
+    /**
+     * footer is optional; Only used in Sites
+     */
+    footer?: Record<string, any>;
+}

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

@@ -0,0 +1,8 @@
+import { IWithLayout } from "../traits/WithLayout";
+import { IHubItemEntity } from "./IHubItemEntity";
+/**
+ * DRAFT: Under development and more properties will likely be added
+ * @internal
+ */
+export interface IHubPage extends IHubItemEntity, IWithLayout {
+}

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

@@ -0,0 +1,15 @@
+import { IHubTimeline } from ".";
+import { IHubItemEntity, IWithLayout, IWithSlug } from "..";
+/**
+ * Defines the properties of a Hub Project object
+ */
+export interface IHubProject extends IHubItemEntity, IWithSlug, IWithLayout {
+    /**
+     * Timeline for the project
+     */
+    timeline?: IHubTimeline;
+    /**
+     * Project Status
+     */
+    status: "inactive" | "active";
+}

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

@@ -0,0 +1,11 @@
+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>;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * Hub Timeline Definition
+ */
+export interface IHubTimeline {
+    title: string;
+    description: string;
+    stages: IHubStage[];
+}
+/**
+ * Hub Timeline Stage
+ */
+export interface IHubStage {
+    /**
+     * Stage identifier
+     */
+    id: number;
+    /**
+     * Stage Title
+     */
+    title: string;
+    /**
+     * Timeframe for the stage
+     * i.e. "Late Fall 2022"
+     */
+    timeframe: string;
+    /**
+     * Stage Description
+     */
+    description: string;
+    /**
+     * Stage status
+     */
+    status: string;
+    /**
+     * Icon Name
+     */
+    icon: string;
+    isEditing: boolean;
+    leadingElement: boolean;
+    trailingElement: boolean;
+}

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

@@ -0,0 +1,23 @@
+import { IUser, IPortal } from "@esri/arcgis-rest-portal";
+import { IEnrichmentErrorInfo } from "../..";
+export interface IItemEnrichments {
+    /** The portal item's data (if any) */
+    data?: {
+        [propName: string]: any;
+    };
+    /** The content's formal metadata */
+    metadata?: any;
+    /** The ids of any groups that the item belongs to */
+    groupIds?: string[];
+    /** The user that owns the item */
+    ownerUser?: IUser;
+    /**
+     * The owner's organization (portal) details (id, name, extent, etc)
+     */
+    org?: Partial<IPortal>;
+    /**
+     * Any errors encountered when fetching enrichments
+     * see https://github.com/ArcGIS/hub-indexer/blob/master/docs/errors.md#response-formatting-for-errors
+     */
+    errors?: IEnrichmentErrorInfo[];
+}

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

@@ -0,0 +1,14 @@
+export * from "./IContentEnrichments";
+export * from "./IItemEnrichments";
+export * from "./IHubContent";
+export * from "./IHubEntityBase";
+export * from "./IHubItemEntity";
+export * from "./IHubEntityManager";
+export * from "./IHubEvent";
+export * from "./IHubImage";
+export * from "./IHubInitiative";
+export * from "./IHubLayout";
+export * from "./IHubPage";
+export * from "./IHubProject";
+export * from "./IHubSite";
+export * from "./IHubTimeline";

package/dist/types/index.d.ts

@@ -1,25 +1,31 @@
 export * from "./access";
 export * from "./api";
+export * from "./ArcGISContext";
+export * from "./ArcGISContextManager";
 export * from "./auth";
 export * from "./categories";
 export * from "./content";
+export * from "./core";
 export * from "./downloads";
 export * from "./extent";
 export * from "./groups";
+export * from "./i18n";
 export * from "./items";
+export * from "./models";
 export * from "./objects";
+export * from "./projects";
+export * from "./request";
 export * from "./resources";
 export * from "./search";
 export * from "./sites";
+export * from "./surveys";
 export * from "./types";
 export * from "./urls";
 export * from "./util";
 export * from "./utils";
-export * from "./i18n";
-export * from "./request";
-export * from "./surveys";
-export * from "./ArcGISContext";
+export * from "./Hub";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
-export { OperationStack, OperationError };
+import HubError from "./HubError";
+export { OperationStack, OperationError, HubError };
 export { btoa, atob } from "abab";

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

@@ -2,13 +2,10 @@ export * from "./_unprotect-and-remove-item";
 export * from "./apply-properties-to-items";
 export * from "./delete-prop";
 export * from "./fail-safe-update";
-export * from "./get-model";
 export * from "./get-model-from-options";
 export * from "./interpolate";
 export * from "./interpolate-item-id";
-export * from "./normalize-solution-template-item";
 export * from "./replace-item-id";
-export * from "./serialize-model";
 export * from "./share-item-to-groups";
 export * from "./unprotect-model";
 export * from "./unshare-item-from-groups";
@@ -16,3 +13,5 @@ export * from "./does-item-exist-with-title";
 export * from "./get-unique-item-title";
 export * from "./fetch-all-pages";
 export * from "./get-structured-license";
+export * from "./slugs";
+export * from "./normalize-solution-template-item";

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

@@ -0,0 +1,43 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-types";
+/**
+ * Create a slug, namespaced to an org
+ * Typically used to lookup items by a human readable name in urls
+ *
+ * @param title
+ * @param orgKey
+ * @returns
+ */
+export declare function constructSlug(title: string, orgKey: string): string;
+/**
+ * Adds/Updates the slug typekeyword
+ * Returns a new array of keywords
+ * @param typeKeywords
+ * @param slug
+ * @returns
+ */
+export declare function setSlugKeyword(typeKeywords: string[], slug: string): string[];
+/**
+ * Get an item by searching for items with a typeKeyword like `slug|{slug-value}`
+ *
+ * For example, if you pass a slug `"snow-map"` into this function, it will
+ * search for items with `slug|snow-map` in it's typeKeywords array,
+ *
+ * @param slug
+ * @param requestOptions
+ * @returns
+ */
+export declare function getItemBySlug(slug: string, requestOptions: IRequestOptions): Promise<IItem>;
+/**
+ * Given a slug, search for items using that slug, incrementing the slug name until
+ * a unique value is found
+ *
+ * For example, if a slug of `"snow-map"` into this function and some item exists
+ * with that slug, it would return `"snow-map-1"`.
+ *
+ * @param slug
+ * @param requestOptions
+ * @param step
+ * @returns
+ */
+export declare function getUniqueSlug(slug: string, requestOptions: IRequestOptions, step?: number): Promise<string>;

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

@@ -0,0 +1,42 @@
+export * from "./serializeModel";
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "..";
+/**
+ * Gets the full item/data model for an item id
+ * @param {string} id
+ * @param {Object} requestOptions
+ */
+export declare function getModel(id: string, requestOptions: IRequestOptions): Promise<IModel>;
+/**
+ * Get a model by it's slug
+ *
+ * This uses the [Filter](https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm) option of the
+ * to search for an item that has a typekeyword of `slug|{slug-value}`
+ *
+ * This is useful for applications that want to use human-readable urls instead
+ * of using item ids.
+ *
+ * @param slug
+ * @param requestOptions
+ * @returns
+ */
+export declare function getModelBySlug(slug: string, requestOptions: IRequestOptions): Promise<IModel>;
+/**
+ * Create an item to back and IModel.
+ *
+ * @param {IModel}
+ * @param {IRequestOptions} requestOptions
+ * @returns {Promise<IModel>}
+ */
+export declare function createModel(model: IModel, requestOptions: IUserRequestOptions): Promise<IModel>;
+/**
+ * Update an IModel. Generic function that will be used across all
+ * type-specific update functions
+ *
+ * @export
+ * @param {IModel} "model" object (i.e. `{item:{...}, data:{...}}`)
+ * @param {IRequestOptions} requestOptions
+ * @returns {Promise<IModel>}
+ */
+export declare function updateModel(model: IModel, requestOptions: IUserRequestOptions): Promise<IModel>;

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

@@ -0,0 +1,81 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { ArcGISContextManager } from "../ArcGISContextManager";
+import { IArcGISContext } from "..";
+import { IHubProject, IHubEntityManager } from "../core/types";
+/**
+ * Centralized functions used to manage IHubProject instances
+ *
+ * This class is a convenience wrapper over util functions which
+ * are also directly accessible for use in scenarios where
+ * classes are inconvenient.
+ */
+export declare class HubProjectManager implements IHubEntityManager<IHubProject> {
+    /**
+     * 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): HubProjectManager;
+    /**
+     * Getter to abstract how we store the context
+     */
+    private get context();
+    /**
+     * Create and store new project.
+     *
+     * Projects are stored as Items in the Sharing API
+     * @param project
+     * @param requestOptions
+     * @returns
+     */
+    create(project: Partial<IHubProject>, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
+    /**
+     * Update a project
+     * @param project
+     * @param requestOptions
+     * @returns
+     */
+    update(project: IHubProject, requestOptions?: IUserRequestOptions): Promise<IHubProject>;
+    /**
+     * Destroy a project.
+     * This permanently removes the backing Item
+     * @param id
+     * @param requestOptions
+     * @returns
+     */
+    destroy(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
+    /**
+     * Fetch a Project via id or it's slug
+     *
+     * 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?: IRequestOptions): Promise<IHubProject>;
+}

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

@@ -0,0 +1,31 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubProject } from "../core/types";
+export declare const HUB_PROJECT_ITEM_TYPE = "Web Mapping Application";
+/**
+ * Create a new Hub Project item
+ *
+ * Minimal properties are name and org
+ *
+ * @param project
+ * @param requestOptions
+ */
+export declare function createProject(partialProject: Partial<IHubProject>, requestOptions: IUserRequestOptions): Promise<IHubProject>;
+/**
+ * Update a Hub Project
+ * @param project
+ * @param requestOptions
+ */
+export declare function updateProject(project: IHubProject, requestOptions: IUserRequestOptions): Promise<IHubProject>;
+/**
+ * Get a Hub Project by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions
+ */
+export declare function getProject(identifier: string, requestOptions: IRequestOptions): Promise<IHubProject>;
+/**
+ * Remove a Hub Project
+ * @param id
+ * @param requestOptions
+ */
+export declare function destroyProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;

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

@@ -0,0 +1,2 @@
+export * from "./HubProjectManager";
+export * from "./HubProjects";

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

@@ -104,7 +104,7 @@ export declare function getNextFunction<T>(request: ISearchOptions, nextStart: n
  * Construct a the full url to a group thumbnail
  *
  * - If the group has a thumbnail, construct the full url
- * - If the group is not public, append on the token
+ * - If the group is not public, append on the token (if passed in)
  * @param portalUrl
  * @param group
  * @param token

package/dist/types/types.d.ts

@@ -1,7 +1,6 @@
-import { IItem, IUser, IGroup, IGeometry, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-types";
+import { IItem, IUser, IGroup, IGeometry } from "@esri/arcgis-rest-types";
 import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
-import { IStructuredLicense } from "./items/get-structured-license";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IFacet } from "./search";
 /**
@@ -159,6 +158,7 @@ export interface IHubGeography {
 export declare type SearchableType = IItem | IGroup | IUser;
 export declare type SearchFunction = (...args: any[]) => Promise<ISearchResult<SearchableType>>;
 /**
+ * DEPRECATED: Use IHubEntityBase instead.
  * Properties that are common to Hub content, community, members, etc
  *
  * @export
@@ -212,96 +212,6 @@ export interface IEnrichmentErrorInfo {
     statusCode?: number;
     message?: string;
 }
-/**
- * Properties that are common to all Hub content types (dataset, map, document, etc)
- *
- * @export
- * @interface IHubContent
- * @extends {IHubResource,IItem}
- */
-export interface IHubContent extends IHubResource, IItem {
-    /**
-     * The content's ID for use with the Hub API
-     * For most content this will be the item's id
-     * For layers this will be `<itemId>_<layerId>`
-     * This will be undefined for private items and in enterprise
-     * because only public online items are included in the Hub API
-     */
-    hubId?: string;
-    /**
-     * Content visibility and access control, including groups
-     */
-    permissions: {
-        /** Visibility of the content */
-        visibility: Visibility;
-        /** Current user's control over the content */
-        control?: AccessControl;
-        /** The groups that have access to the item (as far as you know) */
-        groups?: IGroup[];
-    };
-    family?: HubFamily;
-    /**
-     * Item categories are the original, non-flattened item
-     * category strings.
-     */
-    itemCategories?: string[];
-    /**
-     * The normalized item type (we run normalizeItemType on
-     * the item in order to compute this prop)
-     */
-    normalizedType?: string;
-    /**
-     * Date the content was published (formal metadata),
-     * defaults to the date the content was created
-     */
-    publishedDate: Date;
-    /** Description of the source of the published date */
-    publishedDateSource?: string;
-    updateFrequency?: string;
-    /** Optional links to show in the Hub application for this content */
-    actionLinks?: IActionLink[];
-    /** Configure which Hub application actions (i.e. create web map) are available for this content */
-    hubActions?: object;
-    metrics?: {
-        /** Visibility of the metrics for this content in the Hub application */
-        visibility: Visibility | "updateGroups";
-    };
-    /** The content's unique URL slug in the Hub app */
-    slug?: string;
-    /** URL of the Portal API data endpoint for the resource */
-    portalDataUrl?: string;
-    /** The ids of any groups that the item belongs to */
-    groupIds?: string[];
-    /**
-     * Any errors encountered when indexing or composing the content
-     * see https://github.com/ArcGIS/hub-indexer/blob/master/docs/errors.md#response-formatting-for-errors
-     */
-    errors?: IEnrichmentErrorInfo[];
-    /**
-     * The item data associated w/ most types of content
-     * the format of the data depends on the item type
-     */
-    data?: {
-        [propName: string]: any;
-    };
-    /** service information (currentVersion, capabilities, maxRecordCount etc) */
-    server?: Partial<IFeatureServiceDefinition>;
-    /** layer information (geometryType, fields, etc) for related layers in the service */
-    layers?: Array<Partial<ILayerDefinition>>;
-    /** layer information (geometryType, fields, etc) */
-    layer?: Partial<ILayerDefinition>;
-    recordCount?: number;
-    /** The owner's organization id */
-    orgId?: string;
-    /**
-     * The owner's organization (portal) details (id, name, extent, etc)
-     */
-    org?: Partial<IPortal>;
-    /** Whether the content is downloadable in the Hub app */
-    isDownloadable: boolean;
-    /** The content's structured license info */
-    structuredLicense?: IStructuredLicense;
-}
 export interface IActionLink {
     /** Link title */
     title: string;

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

@@ -0,0 +1,8 @@
+/**
+ * Cross-walk from a portalUrl to the corresponding Hub API Url
+ *
+ * If the passed url is not recognized, then this will return `undefined`
+ * @param portalUrl
+ * @returns
+ */
+export declare function getHubApiFromPortalUrl(portalUrl: string): string;

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

@@ -0,0 +1,9 @@
+/**
+ * Given an org url, get the portal base url
+ *
+ * i.e. https://myorg.maps.arcgis.com will return https://www.arcgis.com
+ *
+ * @param orgUrl
+ * @returns
+ */
+export declare function getPortalBaseFromOrgUrl(orgUrl: string): string;

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

@@ -13,6 +13,8 @@ export * from "./get-item-home-url";
 export * from "./get-item-api-url";
 export * from "./get-item-data-url";
 export * from "./convert-urls-to-anchor-tags";
+export * from "./getHubApiFromPortalUrl";
+export * from "./getPortalBaseFromOrgUrl";
 /**
  *
  * @param url

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

@@ -0,0 +1,17 @@
+/**
+ *   Dasherize a string
+ *
+ *  ```javascript
+ *  import { dasherize } from '@esri/hub-common';
+ *  dasherize('innerHTML');                // 'inner-html'
+ *  dasherize('action_name');              // 'action-name'
+ *  dasherize('css-class-name');           // 'css-class-name'
+ *  dasherize('my favorite items');        // 'my-favorite-items'
+ *  dasherize('privateDocs/ownerInvoice';  // 'private-docs/owner-invoice'
+ *  ```
+ *
+ *  Extracted and modified from Ember.js source code - MIT license
+ *  @param value
+ *  @returns
+ */
+export declare function dasherize(value: string): string;

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

@@ -16,3 +16,4 @@ export * from "./logger";
 export * from "./is-update-group";
 export * from "./revertable-tasks";
 export * from "./sessionLocalStorage";
+export * from "./dasherize";