feat: registerForEvent

Esri · Mar 28, 2019 · f4bd391 · f4bd391
1 parent 8c902e4
commit f4bd391
Show file tree

Hide file tree

Showing 11 changed files with 98 additions and 35 deletions.
diff --git a/demos/oauth2-browser/package.json b/demos/oauth2-browser/package.json
@@ -8,7 +8,7 @@
   "dependencies": {
     "@esri/arcgis-rest-auth": "^1.16.0",
     "@esri/arcgis-rest-request": "^1.16.0",
-    "@esri/hub-auth": "^1.8.1"
+    "@esri/hub-auth": "^1.9.0"
   },
   "devDependencies": {
     "http-server": "0.11.1"

diff --git a/packages/domains/package.json b/packages/domains/package.json
@@ -16,7 +16,7 @@
     "@esri/hub-common": "^1.8.0"
   },
   "devDependencies": {
-    "@esri/hub-common": "^1.8.1"
+    "@esri/hub-common": "^1.9.0"
   },
   "files": [
     "dist/**"

diff --git a/packages/events/package-lock.json b/packages/events/package-lock.json
diff --git a/packages/events/package.json b/packages/events/package.json
@@ -9,11 +9,12 @@
   "types": "dist/esm/index.d.ts",
   "license": "Apache-2.0",
   "dependencies": {
-    "@esri/arcgis-rest-auth": "^1.17.0",
-    "@esri/arcgis-rest-common-types": "^1.17.0",
-    "@esri/arcgis-rest-feature-service": "^1.17.0",
-    "@esri/arcgis-rest-items": "^1.17.0",
-    "@esri/arcgis-rest-request": "^1.17.0",
+    "@esri/arcgis-rest-auth": "^1.18.0",
+    "@esri/arcgis-rest-common-types": "^1.18.0",
+    "@esri/arcgis-rest-feature-service": "^1.18.0",
+    "@esri/arcgis-rest-items": "^1.18.0",
+    "@esri/arcgis-rest-groups": "^1.18.0",
+    "@esri/arcgis-rest-request": "^1.18.0",
     "tslib": "^1.9.3"
   },
   "files": [

diff --git a/packages/events/src/index.ts b/packages/events/src/index.ts
@@ -3,3 +3,4 @@
 
 export * from "./util";
 export * from "./search";
+export * from "./register";
diff --git a/packages/events/src/register.ts b/packages/events/src/register.ts
@@ -0,0 +1,57 @@
+/* Copyright (c) 2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { joinGroup, leaveGroup } from "@esri/arcgis-rest-groups";
+
+export interface IEventRegisterRequestOptions extends IUserRequestOptions {
+  /**
+   * Identifier for the group associated with the ArcGIS Hub event.
+   */
+  groupId: string;
+}
+/**
+ * ```js
+ * import { registerForEvent } from "@esri/hub-events";
+ * //
+ * registerForEvent({
+ *   groupId,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Register for an ArcGIS Hub event.
+ * @param requestOptions - request options that include authentication
+ * @returns A Promise that will resolve with the response from the service.
+ */
+export function registerForEvent(
+  requestOptions: IEventRegisterRequestOptions
+): Promise<{ success: boolean; groupId: string }> {
+  return joinGroup({
+    id: requestOptions.groupId,
+    authentication: requestOptions.authentication
+  });
+}
+
+/**
+ * ```js
+ * import { unregisterForEvent } from "@esri/hub-events";
+ * //
+ * unregisterForEvent({
+ *   groupId,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Unregister for an ArcGIS Hub event.
+ * @param requestOptions - request options that include authentication
+ * @returns A Promise that will resolve with the response from the service.
+ */
+export function unregisterForEvent(
+  requestOptions: IEventRegisterRequestOptions
+): Promise<{ success: boolean; groupId: string }> {
+  return leaveGroup({
+    id: requestOptions.groupId,
+    authentication: requestOptions.authentication
+  });
+}
diff --git a/packages/events/src/util.ts b/packages/events/src/util.ts
@@ -12,7 +12,7 @@ import { UserSession } from "@esri/arcgis-rest-auth";
  * import { getEventServiceUrl } from "@esri/hub-events";
  * // org ids can be retrieved via a call to portals/self
  * request("http://custom.maps.arcgis.com/sharing/rest/portals/self")
- *   then(response => {
+ *   .then(response => {
  *     getEventServiceUrl(response.id)
  *       .then(url)
  *   })

diff --git a/packages/initiatives/package.json b/packages/initiatives/package.json
@@ -23,9 +23,9 @@
     "@esri/hub-sites": "^1.8.0"
   },
   "devDependencies": {
-    "@esri/hub-common": "^1.8.1",
-    "@esri/hub-domains": "^1.8.1",
-    "@esri/hub-sites": "^1.8.1",
+    "@esri/hub-common": "^1.9.0",
+    "@esri/hub-domains": "^1.9.0",
+    "@esri/hub-sites": "^1.9.0",
     "blob": "0.0.4"
   },
   "files": [

diff --git a/packages/initiatives/src/follow.ts b/packages/initiatives/src/follow.ts
@@ -1,8 +1,4 @@
-import {
-  request,
-  getPortalUrl,
-  IRequestOptions
-} from "@esri/arcgis-rest-request";
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
 import { UserSession, getUserUrl } from "@esri/arcgis-rest-auth";
 import { IUser } from "@esri/arcgis-rest-common-types";
 

diff --git a/packages/sites/package.json b/packages/sites/package.json
@@ -20,8 +20,8 @@
     "@esri/hub-domains": "^1.8.0"
   },
   "devDependencies": {
-    "@esri/hub-common": "^1.8.1",
-    "@esri/hub-domains": "^1.8.1"
+    "@esri/hub-common": "^1.9.0",
+    "@esri/hub-domains": "^1.9.0"
   },
   "files": [
     "dist/**"

diff --git a/packages/solutions/package.json b/packages/solutions/package.json
@@ -17,8 +17,8 @@
     "@esri/hub-domains": "^1.8.0"
   },
   "devDependencies": {
-    "@esri/hub-common": "^1.8.1",
-    "@esri/hub-domains": "^1.8.1"
+    "@esri/hub-common": "^1.9.0",
+    "@esri/hub-domains": "^1.9.0"
   },
   "files": [
     "dist/**"