@esri/hub-common 11.0.0 → 11.3.0

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

@@ -69,23 +69,25 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     viewDefinition?: {
         definitionExpression?: string;
     };
-    thumbnailUrl?: string;
+    source?: string;
+    summary?: string;
     owner: string;
-    description?: string;
+    id: string;
+    access?: import("../core").AccessLevel;
+    url?: string;
     culture?: string;
+    description?: string;
+    extent?: number[][];
     tags: string[];
+    thumbnailUrl?: string;
+    thumbnail?: string;
     typeKeywords?: string[];
-    url?: string;
-    access?: import("../core").AccessLevel;
-    id: string;
     name: string;
-    summary?: string;
     createdDate: Date;
     createdDateSource: string;
     updatedDate: Date;
     updatedDateSource: string;
     type: string;
-    source?: string;
     statistics?: any;
     data?: {
         [propName: string]: any;
@@ -106,7 +108,6 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     title: string;
     snippet?: string;
     documentation?: string;
-    extent?: number[][];
     spatialReference?: ISpatialReference;
     properties?: any;
 };

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

@@ -0,0 +1,83 @@
+import { IGroup } from "@esri/arcgis-rest-portal";
+import { IArcGISContext } from "../ArcGISContext";
+import { IWithSharingBehavior, IWithStoreBehavior } from "./behaviors";
+import { IWithThumbnailBehavior } from "./behaviors/IWithThumbnailBehavior";
+import { IHubItemEntity, SettableAccessLevel } from "./types";
+/**
+ * Base class for all Hub Entities backed by items
+ */
+export declare abstract class HubItemEntity<T extends IHubItemEntity> implements IWithStoreBehavior<T>, IWithSharingBehavior, IWithThumbnailBehavior {
+    protected context: IArcGISContext;
+    protected entity: T;
+    protected isDestroyed: boolean;
+    protected thumbnailCache: {
+        file: any;
+        filename: string;
+    };
+    constructor(entity: T, context: IArcGISContext);
+    /**
+     * Return the entity id
+     */
+    get id(): string;
+    /**
+     * Return the entity owner
+     */
+    get owner(): string;
+    /**
+     * Return the backing entity as an object literal
+     * @returns
+     */
+    toJson(): T;
+    abstract update(changes: Partial<T>): void;
+    abstract save(): Promise<void>;
+    abstract delete(): Promise<void>;
+    /**
+     * Can the current user edit the Entity?
+     * In order to edit an item, the user must be the owner of the item
+     * or be a member of a shared editing group, to which the item is shared.
+     * @returns
+     */
+    canEdit(): Promise<boolean>;
+    /**
+     * Can the current user delete the Entity?
+     * In order to delete an item, the user must be the owner of the item or a full org_admin
+     * in the owner's organization.
+     * @returns
+     */
+    canDelete(): Promise<boolean>;
+    /**
+     * Share the Entity with the specified group id
+     * @param groupId
+     */
+    shareWithGroup(groupId: string): Promise<void>;
+    /**
+     * Unshare the Entity with the specified group id
+     * @param groupId
+     */
+    unshareWithGroup(groupId: string): Promise<void>;
+    /**
+     * Set the access level of the backing item
+     * @param access
+     */
+    setAccess(access: SettableAccessLevel): Promise<void>;
+    /**
+     * Return a list of groups the Entity is shared to.
+     * @returns
+     */
+    sharedWith(): Promise<IGroup[]>;
+    /**
+     * Hook that subclasses should call to invoke shared post-save behavior
+     */
+    afterSave(): Promise<void>;
+    /**
+     * Store thumbnail information to be sent with the next `.save()` call
+     * @param file
+     * @param filename
+     */
+    setThumbnail(file: any, filename: string): void;
+    /**
+     * Return the full url to the thumbnail, optionally with a width parameter
+     * @param width
+     */
+    getThumbnailUrl(width?: number): string;
+}

package/dist/types/core/_internal/getBasePropertyMap.d.ts

@@ -0,0 +1,7 @@
+import { IPropertyMap } from "./PropertyMapper";
+/**
+ * Returns an Array of IPropertyMap objects
+ * that define the standard projection of properties from a IModel an entity interface
+ * @returns
+ */
+export declare function getBasePropertyMap(): IPropertyMap[];

package/dist/types/core/behaviors/IWithStoreBehavior.d.ts

@@ -19,4 +19,14 @@ export interface IWithStoreBehavior<T> {
      * Delete the class instance from it's backing store
      */
     delete(): Promise<void>;
+    /**
+     * Can the current user edit the Entity?
+     * User must be owner, or member of a shared editing group, to which the item is shared
+     */
+    canEdit(useCache: boolean): Promise<boolean>;
+    /**
+     * Can the current user delete the Entity?
+     * User must own the entiry or be an org admin in the owner's org
+     */
+    canDelete(useCache: boolean): Promise<boolean>;
 }

package/dist/types/core/behaviors/IWithThumbnailBehavior.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Composable behavior that adds Thumbnail support to an entity class
+ */
+export interface IWithThumbnailBehavior {
+    /**
+     * Set the thumbnail for an item backed entity. This call does not
+     * actuall upload the thumbnail until `.save()` is called.
+     * @param file
+     * @param filename
+     */
+    setThumbnail(file: any, filename: string): void;
+    /**
+     * Return the full url to the thumbnail for the item backed entity.
+     * Optionally, pass in a width. Default width is 200px, with 1:1.5 aspect ratio.
+     * Other widths are: 400px, 800px and 2400px. A request for any other width will
+     * snap to the next highest supported width. If the original image dimension is
+     * smaller than the size queried, the original image will be returned.
+     * @param width
+     */
+    getThumbnailUrl(width?: number): string;
+}

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

@@ -2,7 +2,7 @@ import { IHubPermission } from "../types";
 /**
  * Adds permissions property to an entity
  */
-export interface IWithPermissionDefinition {
+export interface IWithPermissions {
     /**
      * List of permissions for the entity
      */

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

@@ -2,3 +2,4 @@ export * from "./IWithBannerImage";
 export * from "./IWithLayout";
 export * from "./IWithSlug";
 export * from "./IWithPermissions";
+export * from "./IWithCatalog";

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

@@ -0,0 +1,21 @@
+import { IItemResource } from "./IItemResource";
+/**
+ * More useful interface for entity resources.
+ *
+ * @export
+ * @interface IEntityResource
+ */
+export interface IEntityResource extends IItemResource {
+    /**
+     * Type of resource
+     *
+     * @type {SolutionResourceType}
+     */
+    type: "image" | "thumbnail" | "other";
+    /**
+     * Url where this can be fetched from; Does not include token.
+     *
+     * @type {string}
+     */
+    sourceUrl: string;
+}

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

@@ -15,7 +15,7 @@ export declare enum PublisherSource {
 /**
  * Data model for content
  */
-export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IItem {
+export interface IHubContent extends Omit<IHubItemEntity, "schemaVersion">, IHubContentEnrichments, IItem {
     /**
      * The underlying portal item referenced by this content
      */

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

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

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

@@ -6,17 +6,9 @@ import { AccessLevel } from "./types";
  */
 export interface IHubItemEntity extends IHubEntityBase {
     /**
-     * Thumbnail Uril (read-only)
-     */
-    thumbnailUrl?: string;
-    /**
-     * Username of the owner of the item
-     */
-    owner: string;
-    /**
-     * Description for the item
+     * Access level of the item ("private" | "org" | "public")
      */
-    description?: string;
+    access?: AccessLevel;
     /**
      * boundary will default to the item extent
      * but can be overwritten by enrichments from the Hub API (inline)
@@ -29,19 +21,40 @@ export interface IHubItemEntity extends IHubEntityBase {
      */
     culture?: string;
     /**
-     * User configurable tags
+     * Description for the item
      */
-    tags: string[];
+    description?: string;
     /**
-     * System configurable typekeywords
+     * Extent of the Entity
      */
-    typeKeywords?: string[];
+    extent?: number[][];
+    /**
+     * Username of the owner of the item
+     */
+    owner: string;
     /**
      * Canonical Url for the Entity
      */
     url?: string;
     /**
-     * Access level of the item ("private" | "org" | "public")
+     * Current schema version. Used to determine what if any
+     * schema migrations should be applied when the item is loaded
      */
-    access?: AccessLevel;
+    schemaVersion: number;
+    /**
+     * User configurable tags
+     */
+    tags: string[];
+    /**
+     * Thumbnail Uril (read-only)
+     */
+    thumbnailUrl?: string;
+    /**
+     * Thumbnail (read-only)
+     */
+    thumbnail?: string;
+    /**
+     * System configurable typekeywords
+     */
+    typeKeywords?: string[];
 }

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

@@ -1,10 +1,10 @@
 import { IHubTimeline, IHubItemEntity } from "./index";
-import { IWithLayout, IWithPermissionDefinition, IWithSlug } from "../traits/index";
-import { IWithCatalog } from "../traits/IWithCatalogDefinition";
+import { IWithLayout, IWithPermissions, IWithSlug } from "../traits/index";
+import { IWithCatalog } from "../traits/IWithCatalog";
 /**
  * Defines the properties of a Hub Project object
  */
-export interface IHubProject extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissionDefinition {
+export interface IHubProject extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions {
     /**
      * Timeline for the project
      */

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

@@ -0,0 +1,9 @@
+/**
+ * Item Resource
+ */
+export interface IItemResource {
+    access: string;
+    created: number;
+    resource: string;
+    size: number;
+}

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

@@ -1,12 +1,10 @@
 export * from "./IHubContent";
 export * from "./IHubContentEnrichments";
 export * from "./IHubEntityBase";
-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";

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from "./items";
 export * from "./models";
 export * from "./objects";
 export * from "./projects";
+export * from "./initiatives";
 export * from "./request";
 export * from "./resources";
 export * from "./search";

package/dist/types/initiatives/HubInitiative.d.ts

@@ -0,0 +1,67 @@
+import { IHubInitiative, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior } from "../core";
+import { Catalog } from "../search/Catalog";
+import { IArcGISContext } from "../ArcGISContext";
+import { HubItemEntity } from "../core/HubItemEntity";
+/**
+ * Hub Initiative Class
+ */
+export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
+    private _catalog;
+    private _permissionManager;
+    /**
+     * Private constructor so we don't have `new` all over the place. Allows for
+     * more flexibility in how we create the HubInitiativeManager over time.
+     * @param context
+     */
+    private constructor();
+    /**
+     * Catalog instance for this Initiative. Note: Do not hold direct references to this object; always access it from the Initiative.
+     * @returns Catalog
+     */
+    get catalog(): Catalog;
+    /**
+     * PermissionManager instance for this Initiative. Note: Do not hold direct references to this object; always access it from the Initiative.
+     * @returns PermissionManager
+     */
+    get permissions(): PermissionManager;
+    /**
+     * Create an instance from an IHubInitiative object
+     * @param json - JSON object to create a HubInitiative from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json: Partial<IHubInitiative>, context: IArcGISContext): HubInitiative;
+    /**
+     * Create a new HubInitiative, returning a HubInitiative instance.
+     * Note: This does not persist the Initiative into the backing store
+     * @param partialInitiative
+     * @param context
+     * @returns
+     */
+    static create(partialInitiative: Partial<IHubInitiative>, context: IArcGISContext, save?: boolean): Promise<HubInitiative>;
+    /**
+     * Fetch an Initiative from the backing store and return a HubInitiative instance.
+     * @param identifier - slug or item id
+     * @param context
+     * @returns
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubInitiative>;
+    private static applyDefaults;
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes: Partial<IHubInitiative>): void;
+    /**
+     * Save the HubInitiative to the backing store.
+     * Currently Initiatives are stored as Items in Portal
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubInitiative from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    delete(): Promise<void>;
+}

package/dist/types/initiatives/HubInitiatives.d.ts

@@ -0,0 +1,55 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IHubRequestOptions } from "../index";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubInitiative } from "../core/types";
+import { IHubSearchResult } from "../search";
+/**
+ * @private
+ * Create a new Hub Initiative item
+ *
+ * Minimal properties are name and orgUrlKey
+ *
+ * @param partialInitiative
+ * @param requestOptions
+ */
+export declare function createInitiative(partialInitiative: Partial<IHubInitiative>, requestOptions: IUserRequestOptions): Promise<IHubInitiative>;
+/**
+ * @private
+ * Update a Hub Initiative
+ * @param initiative
+ * @param requestOptions
+ */
+export declare function updateInitiative(initiative: IHubInitiative, requestOptions: IUserRequestOptions): Promise<IHubInitiative>;
+/**
+ * @private
+ * Get a Hub Initiative by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions
+ */
+export declare function fetchInitiative(identifier: string, requestOptions: IRequestOptions): Promise<IHubInitiative>;
+/**
+ * @private
+ * Remove a Hub Initiative
+ * @param id
+ * @param requestOptions
+ */
+export declare function deleteInitiative(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+/**
+ * @private
+ * Convert an Hub Initiative Item into a Hub Initiative, fetching any additional
+ * information that may be required
+ * @param item
+ * @param auth
+ * @returns
+ */
+export declare function convertItemToInitiative(item: IItem, requestOptions: IRequestOptions): Promise<IHubInitiative>;
+/**
+ * @private
+ * Fetch Initiative specific enrichments
+ * @param item
+ * @param include
+ * @param requestOptions
+ * @returns
+ */
+export declare function enrichInitiativeSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;

package/dist/types/initiatives/defaults.d.ts

@@ -0,0 +1,11 @@
+import { IHubInitiative } from "../core/types";
+import { IModel } from "../types";
+export declare const HUB_INITIATIVE_ITEM_TYPE = "Hub Initiative";
+/**
+ * Default values of a IHubInitiative
+ */
+export declare const DEFAULT_INITIATIVE: Partial<IHubInitiative>;
+/**
+ * Default values for a new HubInitiative Model
+ */
+export declare const DEFAULT_INITIATIVE_MODEL: IModel;

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

@@ -0,0 +1,2 @@
+export * from "./HubInitiatives";
+export * from "./HubInitiative";

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

@@ -1,14 +1,11 @@
-import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior, SettableAccessLevel } from "../core";
+import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior } from "../core";
 import { Catalog } from "../search/Catalog";
 import { IArcGISContext } from "../ArcGISContext";
-import { IGroup } from "@esri/arcgis-rest-types";
+import { HubItemEntity } from "../core/HubItemEntity";
 /**
  * Hub Project Class
  */
-export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
-    private context;
-    private entity;
-    private isDestroyed;
+export declare class HubProject extends HubItemEntity<IHubProject> implements IWithStoreBehavior<IHubProject>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
     private _catalog;
     private _permissionManager;
     /**
@@ -18,11 +15,13 @@ export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWit
      */
     private constructor();
     /**
-     * @returns Catalog instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     * Catalog instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     * @returns
      */
     get catalog(): Catalog;
     /**
-     * @returns PermissionManager instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     * PermissionManager instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     * @returns
      */
     get permissions(): PermissionManager;
     /**
@@ -48,11 +47,6 @@ export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWit
      */
     static fetch(identifier: string, context: IArcGISContext): Promise<HubProject>;
     private static applyDefaults;
-    /**
-     * Get the current state of the IHubProject from the instance
-     * @returns IHubProject POJO
-     */
-    toJson(): IHubProject;
     /**
      * Apply a new state to the instance
      * @param changes
@@ -69,24 +63,4 @@ export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWit
      * @returns
      */
     delete(): Promise<void>;
-    /**
-     * Share the Project with the specified group id
-     * @param groupId
-     */
-    shareWithGroup(groupId: string): Promise<void>;
-    /**
-     * Unshare the Project with the specified group id
-     * @param groupId
-     */
-    unshareWithGroup(groupId: string): Promise<void>;
-    /**
-     * Set the access level of the backing item
-     * @param access
-     */
-    setAccess(access: SettableAccessLevel): Promise<void>;
-    /**
-     * Return a list of groups the Project is shared to.
-     * @returns
-     */
-    sharedWith(): Promise<IGroup[]>;
 }

package/dist/types/urls/get-campaign-url.d.ts

@@ -0,0 +1,22 @@
+import { IHubRequestOptions } from "../types";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+interface IBuildHubCampaignUrl {
+    portal: string | IPortal | IHubRequestOptions | IRequestOptions;
+    uri: string;
+    meta: any;
+    redirectUrl: string;
+}
+/**
+ * Builds a Hub "campaign" URL used as a single entry-point into
+ * Hub from external links, i.e. push notifications, emails, sms, etc,
+ * from which we can capture campaign-related telemetry before redirecting
+ * the user off to a provided destination.
+ * @param options.portal A string IPortal IHubRequestOptions or IRequestOptions object
+ * @param options.uri A URI that provides additional context for how to parse the provide meta
+ * @param options.meta An object of metadata for the campaign URL
+ * @param options.redirectURL A redirect URL
+ * @returns string A campaign URL
+ */
+export declare function getCampaignUrl(options: IBuildHubCampaignUrl): string;
+export {};

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

@@ -17,6 +17,7 @@ export * from "./getHubApiFromPortalUrl";
 export * from "./getPortalBaseFromOrgUrl";
 export * from "./getGroupHomeUrl";
 export * from "./getUserHomeUrl";
+export * from "./get-campaign-url";
 /**
  *
  * @param url

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "11.0.0",
+  "version": "11.3.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",

package/dist/esm/core/traits/IWithCatalogDefinition.js

@@ -1 +0,0 @@
-//# sourceMappingURL=IWithCatalogDefinition.js.map

package/dist/esm/core/traits/IWithCatalogDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IWithCatalogDefinition.js","sourceRoot":"","sources":["../../../../src/core/traits/IWithCatalogDefinition.ts"],"names":[],"mappings":""}

package/dist/esm/core/types/IHubEntityManager.js

@@ -1 +0,0 @@
-//# sourceMappingURL=IHubEntityManager.js.map

package/dist/esm/core/types/IHubEntityManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHubEntityManager.js","sourceRoot":"","sources":["../../../../src/core/types/IHubEntityManager.ts"],"names":[],"mappings":""}

package/dist/esm/core/types/IHubItemEntityManager.js

@@ -1 +0,0 @@
-//# sourceMappingURL=IHubItemEntityManager.js.map

package/dist/esm/core/types/IHubItemEntityManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHubItemEntityManager.js","sourceRoot":"","sources":["../../../../src/core/types/IHubItemEntityManager.ts"],"names":[],"mappings":""}

package/dist/node/core/traits/IWithCatalogDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IWithCatalogDefinition.js","sourceRoot":"","sources":["../../../../src/core/traits/IWithCatalogDefinition.ts"],"names":[],"mappings":""}

package/dist/node/core/types/IHubEntityManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHubEntityManager.js","sourceRoot":"","sources":["../../../../src/core/types/IHubEntityManager.ts"],"names":[],"mappings":""}

package/dist/node/core/types/IHubItemEntityManager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IHubItemEntityManager.js","sourceRoot":"","sources":["../../../../src/core/types/IHubItemEntityManager.ts"],"names":[],"mappings":""}