@esri/hub-common 11.0.0-beta.1 → 11.0.0-beta.4

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

@@ -0,0 +1,27 @@
+import { IGroup } from "@esri/arcgis-rest-portal";
+import { AccessLevel } from "../types";
+/**
+ * Sharing behavior for Item-Backed Entities
+ */
+export interface IWithSharingBehavior {
+    /**
+     * Share the item with the specified group
+     * @param groupId
+     */
+    shareWithGroup(groupId: string): Promise<void>;
+    /**
+     * Unshare the item with the specified group
+     * @param groupId
+     */
+    unshareWithGroup(groupId: string): Promise<void>;
+    /**
+     * Set the access level for the item
+     * @param access
+     */
+    setAccess(access: AccessLevel): Promise<void>;
+    /**
+     * Get the list of groups that the item is shared to.
+     * Limited to Groups that the user has access to
+     */
+    sharedWith(): Promise<IGroup[]>;
+}

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

@@ -1,3 +1,4 @@
 export * from "./IWithPermissionBehavior";
 export * from "./IWithCatalogBehavior";
 export * from "./IWithStoreBehavior";
+export * from "./IWithSharingBehavior";

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

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

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

@@ -6,5 +6,5 @@ export interface IWithPermissionDefinition {
     /**
      * List of permissions for the entity
      */
-    permissionDefinition: IHubPermission[];
+    permissions: IHubPermission[];
 }

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 { IWithCatalogDefinition } from "../traits/IWithCatalogDefinition";
+import { IWithCatalog } from "../traits/IWithCatalogDefinition";
 /**
  * Defines the properties of a Hub Project object
  */
-export interface IHubProject extends IHubItemEntity, IWithSlug, IWithCatalogDefinition, IWithLayout, IWithPermissionDefinition {
+export interface IHubProject extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissionDefinition {
     /**
      * Timeline for the project
      */

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/projects/HubProject.d.ts

@@ -1,10 +1,11 @@
-import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior } from "../core";
+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 {
+export declare class HubProject implements IWithStoreBehavior<IHubProject>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
     private context;
     private entity;
     private isDestroyed;
@@ -68,4 +69,24 @@ 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/projects/HubProjectManager.d.ts

@@ -7,6 +7,7 @@ import { IHubItemEntityManager } from "../core/types/IHubItemEntityManager";
 import { IGroup, IItem } from "@esri/arcgis-rest-types";
 import { ISharingResponse } from "@esri/arcgis-rest-portal";
 /**
+ * @private
  * Centralized functions used to manage IHubProject instances
  *
  * This class is a convenience wrapper over util functions which

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

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

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

@@ -3,7 +3,6 @@ export * from "./domains";
 export * from "./drafts";
 export * from "./fetchSiteModel";
 export * from "./get-site-by-id";
-export * from "./HubSiteManager";
 export * from "./HubSites";
 export * from "./registerSiteAsApplication";
 export * from "./site-schema-version";

package/package.json

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