@esri/hub-common 9.14.1 → 9.15.0

package/dist/types/core/helpers/PropertyMapper.d.ts

@@ -0,0 +1,69 @@
+import { IModel } from "../..";
+/**
+ * Manage forward and backward property mappings to
+ * streamline conversion between the Hub entities, and
+ * the backing IModel
+ */
+export declare class PropertyMapper<T> {
+    mappings: IPropertyMap[];
+    /**
+     * Pass in the mappings between the Entity and
+     * it's backing structure (model or otherwise)
+     * @param mappings
+     */
+    constructor(mappings: IPropertyMap[]);
+    /**
+     * Map properties from a model on to the entity object.
+     *
+     * Used when constructing an entity can from a fetched model,
+     * in which case the entity should be an empty object (`{}`).
+     *
+     * Can also be used to apply changes to an entity from a model,
+     * in which case an existing entity can be passed in.
+     * @param model
+     * @param object
+     * @returns
+     */
+    modelToObject(model: IModel, object: T): T;
+    /**
+     * Map properties from an entity object onto a model.
+     *
+     * Typically the model will already exist, and this
+     * method is used to transfer changes to the model
+     * prior to storage.
+     * @param object
+     * @param model
+     * @returns
+     */
+    objectToModel(object: T, model: IModel): IModel;
+}
+/**
+ * Property Map Entry that provides a cross-walk
+ * between a property path (`name`) on the "object"
+ * to a property path on a model (`item.title`).
+ *
+ * This enables autmatic mapping of properties between
+ * the two types of objects.
+ */
+export interface IPropertyMap {
+    objectKey: string;
+    modelKey: string;
+}
+/**
+ * Generic function to apply properties from an Object
+ * (i.e. IHubProject) onto a Model that can be persisted to an Item
+ * @param object
+ * @param model
+ * @param mappings
+ * @returns
+ */
+export declare function mapObjectToModel<T>(object: T, model: IModel, mappings: IPropertyMap[]): IModel;
+/**
+ * Generic function to apply properties from a Model
+ * onto an Object (i.e. IHubProject etc)
+ * @param model
+ * @param object
+ * @param mappings
+ * @returns
+ */
+export declare function mapModelToObject<T>(model: IModel, object: T, mappings: IPropertyMap[]): T;

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

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

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

@@ -0,0 +1,30 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IHubImage, IHubImageOptions } from "../types/IHubImage";
+/**
+ * WithBannerImage Trait
+ * Adds a .bannerImage property
+ */
+export interface IWithBannerImage {
+    /**
+     * Banner Image as IHubImage
+     */
+    bannerImage?: IHubImage;
+}
+/**
+ * Defines functions for working with Banner Images
+ */
+export interface IWithBannerImageStore {
+    /**
+     * Store a banner image
+     * @param id
+     * @param opts
+     * @param ro
+     */
+    setBannerImage(id: string, opts: IHubImageOptions, ro: IUserRequestOptions): Promise<IHubImage>;
+    /**
+     * Clear a banner image
+     * @param id
+     * @param ro
+     */
+    clearBannerImage(id: string, ro: IUserRequestOptions): Promise<void>;
+}

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

@@ -0,0 +1,54 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubLayout } from "../types/IHubLayout";
+/**
+ * Properties associated with a Layout
+ */
+export interface IWithLayout {
+    /**
+     * Layout property
+     */
+    layout?: IHubLayout;
+}
+/**
+ * Defined layout related functions that a module
+ * working with IWithLayout objects must implement
+ */
+export interface IWithLayoutStore {
+    /**
+     * Given a version name, copy that into the item's /data
+     * making it the "active version"
+     * @param id
+     * @param ro
+     */
+    setActiveVersion(id: string, ro: IUserRequestOptions): Promise<void>;
+    /**
+     * Return a list of all the versions by name
+     * @param id
+     * @param ro
+     */
+    listVersions(id: string, ro: IRequestOptions): Promise<string[]>;
+    /**
+     * Destroy the resource backing a version
+     * @param id
+     * @param name
+     * @param ro
+     */
+    destroyVersion(id: string, name: string, ro: IUserRequestOptions): Promise<void>;
+    /**
+     * Store a version as a resource, with the given name
+     * @param id
+     * @param name
+     * @param layout
+     * @param ro
+     */
+    saveVersion(id: string, name: string, layout: IHubLayout, ro: IUserRequestOptions): Promise<void>;
+    /**
+     * Fetch the layout from a specific version.
+     * Used when editing a specific version.
+     * @param id
+     * @param name
+     * @param ro
+     */
+    loadVersion(id: string, name: string, ro: IRequestOptions): Promise<IHubLayout>;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * Adds slug and related properties
+ */
+export interface IWithSlug {
+    /**
+     * Slug that can be used to lookup an entity
+     * by something other than it's id
+     */
+    slug?: string;
+    /**
+     * Organization urlKey used to construct the
+     * slug
+     */
+    orgUrlKey: string;
+}

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

@@ -0,0 +1,3 @@
+export * from "./WithBannerImage";
+export * from "./WithLayout";
+export * from "./WithSlug";

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

@@ -0,0 +1,10 @@
+import { IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
+import { IItemEnrichments } from "./IItemEnrichments";
+export interface IContentEnrichments extends IItemEnrichments {
+    /** Information about the service referenced by this content (currentVersion, capabilities, maxRecordCount etc) */
+    server?: Partial<IFeatureServiceDefinition>;
+    /** Detailed information about the service's layers (geometryType, fields, etc) for related layers in the service */
+    layers?: Array<Partial<ILayerDefinition>>;
+    /** The count of records for the layer referenced by this content */
+    recordCount?: number;
+}

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

@@ -0,0 +1,77 @@
+import { IItem, IGroup } from "@esri/arcgis-rest-portal";
+import { ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
+import { Visibility, AccessControl, HubFamily, IActionLink, IStructuredLicense } from "../..";
+import { IHubItemEntity } from ".";
+import { IContentEnrichments } from "./IContentEnrichments";
+/**
+ * Data model for content
+ */
+export interface IHubContent extends IHubItemEntity, IContentEnrichments, IItem {
+    /**
+     * The underlying portal item referenced by this content
+     */
+    item: IItem;
+    /**
+     * Slug that can be used to lookup an entity
+     * by something other than it's id
+     */
+    slug?: string;
+    /**
+     * 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;
+    /**
+     * The preferred identifier to use for Hub URLs.
+     * This will be either the slug, hubId, or item id.
+     */
+    identifier: 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[];
+    };
+    /**
+     * The the family of related types that this content belongs to.
+     */
+    family?: HubFamily;
+    /** Parsed item categories (see parseItemCategories) */
+    categories?: string[];
+    /** Whether the content is downloadable in the Hub app */
+    isDownloadable: boolean;
+    /** The content's structured license info */
+    structuredLicense?: IStructuredLicense;
+    /**
+     * 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;
+    /** Frequency at which the content is updated */
+    updateFrequency?: string;
+    /** URL of the resource's page in the Portal Home application */
+    portalHomeUrl?: string;
+    /** URL of the Portal API endpoint for the resource */
+    portalApiUrl?: string;
+    /** URL of the Portal API data endpoint for the resource */
+    portalDataUrl?: 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;
+    /** Information about the layer referenced by this content (geometryType, fields, etc) */
+    layer?: Partial<ILayerDefinition>;
+    itemCategories?: string[];
+    normalizedType?: string;
+    orgId?: string;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * Base properties for Hub Entities
+ * This is a subset of `IItem`, that can apply to
+ * models that are not backed by items.
+ */
+export interface IHubEntityBase {
+    /**
+     * Id of the entity as a string
+     */
+    id: string;
+    /**
+     * Name of the Entity
+     * For Entities backed by items, this is typically the title
+     */
+    name: string;
+    /**
+     * Simple summary of the Entity.
+     * For items, this is typically the `snippet` property.
+     */
+    summary?: string;
+    /**
+     * Date the entity was created
+     */
+    createdDate: Date;
+    /**
+     * Source of the creation date
+     */
+    createdDateSource: string;
+    /**
+     * Date the entity was last updated
+     */
+    updatedDate: Date;
+    /**
+     * Source of the updated date
+     */
+    updatedDateSource: string;
+    /**
+     * Type of entity
+     */
+    type: string;
+}

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

@@ -0,0 +1,33 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Baseline CRUD+Search functions required for all Store classes
+ */
+export interface IHubEntityManager<T> {
+    /**
+     * Create and Store a new Entity
+     * @param obj
+     * @param requestOptions
+     */
+    create(obj: T, requestOptions: IUserRequestOptions): Promise<T>;
+    /**
+     * Update an existing Entity
+     * @param obj
+     * @param requestOptions
+     */
+    update(obj: T, requestOptions: IUserRequestOptions): Promise<T>;
+    /**
+     * Destroy an Entity
+     * @param id
+     * @param requestOptions
+     */
+    destroy(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+    /**
+     * Get an entity by an identifier. Implementations can handle this
+     * differently as needed. i.e. a HubProject can be fetched by item id (guid)
+     * or by a slug.
+     * @param identifier
+     * @param requestOptions
+     */
+    fetch(identifier: string, requestOptions: IRequestOptions): Promise<T>;
+}

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

@@ -0,0 +1,10 @@
+import { IHubEntityBase } from "./IHubEntityBase";
+/**
+ * DRAFT: Under development and more properties will likely be added
+ * @internal
+ */
+export interface IHubEvent extends IHubEntityBase {
+    location: string;
+    startDate: Date;
+    readonly owner: string;
+}

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,26 +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 "./ArcGISContextManager";
-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>;