@esri/hub-common 10.0.2 → 11.0.0-beta.2

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

@@ -23,7 +23,7 @@ export interface IHubEntityManager<T> {
      * @param id
      * @param requestOptions
      */
-    destroy(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+    delete(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)

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

@@ -1,4 +1,4 @@
-import { IWithBannerImage } from "../traits/WithBannerImage";
+import { IWithBannerImage } from "../traits/IWithBannerImage";
 import { IHubItemEntity } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added

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

@@ -1,4 +1,4 @@
-import { IWithLayout } from "../traits/WithLayout";
+import { IWithLayout } from "../traits/IWithLayout";
 import { IHubItemEntity } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added

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

@@ -0,0 +1,23 @@
+/**
+ * Structure of a Hub Permission
+ */
+export interface IHubPermission {
+    /**
+     * Unique identifier of the permission
+     */
+    id?: string;
+    /**
+     * What action is being enabled for the target
+     */
+    permission: HubPermission;
+    /**
+     * What is the target of the permission
+     */
+    target: PermissionTarget;
+    /**
+     * Id of the entity that this permission is granted for
+     */
+    targetId: string;
+}
+export declare type HubPermission = "addEvent" | "createEvent" | "editEvent" | "deleteEvent" | "addInitiative" | "createInitiative" | "editInitiative" | "deleteInitiative" | "addProject" | "createProject" | "editProject" | "deleteProject";
+export declare type PermissionTarget = "org" | "group" | "user";

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

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

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

@@ -1,6 +1,6 @@
 import { IExtent } from "@esri/arcgis-rest-feature-layer";
-import { IWithSlug } from "../traits/WithSlug";
-import { IWithLayout } from "../traits/WithLayout";
+import { IWithSlug } from "../traits/IWithSlug";
+import { IWithLayout } from "../traits/IWithLayout";
 import { IHubItemEntity } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added

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

@@ -16,3 +16,4 @@ export * from "./IHubTimeline";
 export * from "./IItemEnrichments";
 export * from "./IServerEnrichments";
 export * from "./types";
+export * from "./IHubPermission";

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

@@ -1,4 +1,8 @@
+/**
+ * Access levels that can be set on an item
+ */
+export declare type SettableAccessLevel = "public" | "org" | "private";
 /**
  * Access level for Platform Entities
  */
-export declare type AccessLevel = "public" | "shared" | "org" | "private";
+export declare type AccessLevel = SettableAccessLevel | "shared";

package/dist/types/index.d.ts

@@ -23,7 +23,6 @@ export * from "./types";
 export * from "./urls";
 export * from "./util";
 export * from "./utils";
-export * from "./Hub";
 export * from "./pages";
 export * from "./org";
 export * from "./users";

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

@@ -0,0 +1,92 @@
+import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior, SettableAccessLevel } from "../core";
+import { Catalog } from "../search/Catalog";
+import { IArcGISContext } from "../ArcGISContext";
+import { IGroup } from "@esri/arcgis-rest-types";
+/**
+ * Hub Project Class
+ */
+export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
+    private context;
+    private entity;
+    private isDestroyed;
+    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 HubProjectManager over time.
+     * @param context
+     */
+    private constructor();
+    /**
+     * @returns Catalog instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     */
+    get catalog(): Catalog;
+    /**
+     * @returns PermissionManager instance for this project. Note: Do not hold direct references to this object; always access it from the project.
+     */
+    get permissions(): PermissionManager;
+    /**
+     * Create an instance from an IHubProject object
+     * @param json - JSON object to create a HubProject from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json: Partial<IHubProject>, context: IArcGISContext): HubProject;
+    /**
+     * Create a new HubProject, returning a HubProject instance.
+     * Note: This does not persist the Project into the backing store
+     * @param partialProject
+     * @param context
+     * @returns
+     */
+    static create(partialProject: Partial<IHubProject>, context: IArcGISContext, save?: boolean): Promise<HubProject>;
+    /**
+     * Fetch a Project from the backing store and return a HubProject instance.
+     * @param identifier - Identifier of the project to load
+     * @param context
+     * @returns
+     */
+    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
+     */
+    update(changes: Partial<IHubProject>): void;
+    /**
+     * Save the HubProject to the store
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubProject from the store
+     * set a flag to indicate that it is destroyed
+     * @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/projects/HubProjectManager.d.ts

@@ -69,7 +69,7 @@ export declare class HubProjectManager implements IHubEntityManager<IHubProject>
      * @param requestOptions
      * @returns
      */
-    destroy(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
+    delete(id: string, requestOptions?: IUserRequestOptions): Promise<void>;
     /**
      * Fetch a Project via id or it's slug
      *

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

@@ -4,8 +4,8 @@ import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
 import { IHubSearchResponse, IHubSearchResult, IQuery } from "../search";
-export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
 /**
+ * @private
  * Create a new Hub Project item
  *
  * Minimal properties are name and org
@@ -15,23 +15,26 @@ export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
  */
 export declare function createProject(partialProject: Partial<IHubProject>, requestOptions: IUserRequestOptions): Promise<IHubProject>;
 /**
+ * @private
  * Update a Hub Project
  * @param project
  * @param requestOptions
  */
 export declare function updateProject(project: IHubProject, requestOptions: IUserRequestOptions): Promise<IHubProject>;
 /**
+ * @private
  * Get a Hub Project by id or slug
  * @param identifier item id or slug
  * @param requestOptions
  */
 export declare function fetchProject(identifier: string, requestOptions: IRequestOptions): Promise<IHubProject>;
 /**
+ * @private
  * Remove a Hub Project
  * @param id
  * @param requestOptions
  */
-export declare function destroyProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
+export declare function deleteProject(id: string, requestOptions: IUserRequestOptions): Promise<void>;
 /**
  * Search for Projects, and get IHubProject results
  *
@@ -43,6 +46,7 @@ export declare function destroyProject(id: string, requestOptions: IUserRequestO
  */
 export declare function searchProjects(query: string | IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubProject>>;
 /**
+ * @private
  * Convert an Hub Project Item into a Hub Project, fetching any additional
  * information that may be required
  * @param item
@@ -51,6 +55,7 @@ export declare function searchProjects(query: string | IQuery, options: IHubSear
  */
 export declare function convertItemToProject(item: IItem, requestOptions: IRequestOptions): Promise<IHubProject>;
 /**
+ * @private
  * Fetch project specific enrichments
  * @param item
  * @param include

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

@@ -0,0 +1,11 @@
+import { IHubProject } from "../core";
+import { IModel } from "../types";
+export declare const HUB_PROJECT_ITEM_TYPE = "Hub Project";
+/**
+ * Default values of a IHubProject
+ */
+export declare const DEFAULT_PROJECT: Partial<IHubProject>;
+/**
+ * Default values for a new HubProject Model
+ */
+export declare const DEFAULT_PROJECT_MODEL: IModel;

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

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

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

@@ -21,7 +21,7 @@ export declare class Catalog implements IHubCatalog {
     private _catalog;
     private constructor();
     /**
-     * Create a Collection instance from a Catalog json object, a site url or itemId
+     * Create a Catalog instance from a site url or itemId
      * '''js
      * const catalog = await Catalog.create('https://site-org.hub.arcgis.com', context);
      * '''
@@ -32,12 +32,12 @@ export declare class Catalog implements IHubCatalog {
      */
     static init(identifier: string, context?: IArcGISContext): Promise<Catalog>;
     /**
-     * Create a Catalog instance from a Catalog Json object
+     * Create a Catalog instance from a Catalog Definition Json object
      * @param json
      * @param context
      * @returns
      */
-    static fromJson(json: any, context?: IArcGISContext): Catalog;
+    static fromJson(json: IHubCatalog, context?: IArcGISContext): Catalog;
     /**
      * Return the JSON object backing the instance
      * @returns
@@ -140,4 +140,5 @@ export declare class Catalog implements IHubCatalog {
      * @returns
      */
     private getEmptyResult;
+    private getDefaultSearchOptions;
 }

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

@@ -66,7 +66,7 @@ export declare class HubSiteManager implements IHubEntityManager<IHubSite>, IHub
      * @param requestOptions
      * @returns
      */
-    destroy(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
+    delete(id: string, requestOptions?: IHubRequestOptions): Promise<void>;
     /**
      * Fetch a Site via Id, slug or domain
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "10.0.2",
+  "version": "11.0.0-beta.2",
   "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/WithBannerImage.js

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,7 +0,0 @@
-import { Catalog } from "../../search/Catalog";
-export interface IWithCatalog {
-    /**
-     * Catalog
-     */
-    catalog: Catalog;
-}