@esri/hub-common 14.5.1 → 14.6.0

package/dist/types/groups/{add-users-workflow/workflow-sections/auto-add-users.d.ts → autoAddUsers.d.ts}

@@ -11,4 +11,4 @@ import { IAuthenticationManager } from "@esri/arcgis-rest-request";
  *
  * @returns {IAddGroupUsersResult|null} Result of the transaction (null if no users are passed in)
  */
-export declare function autoAddUsers(id: string, users: IUser[], authentication: IAuthenticationManager): Promise<IAddGroupUsersResult>;
+export declare function autoAddUsers(id: string, users: IUser[], authentication: IAuthenticationManager): Promise<IAddGroupUsersResult | null>;

package/dist/types/groups/{add-users-workflow/workflow-sections/email-org-users.d.ts → emailOrgUsers.d.ts}

@@ -1,7 +1,7 @@
 import { IUser } from "@esri/arcgis-rest-auth";
 import { ICreateOrgNotificationResult } from "@esri/arcgis-rest-portal";
 import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-import { IEmail } from "../interfaces";
+import { IEmail } from "./types";
 /**
  * Attempts to email members of the requesting user's organization.
  *
@@ -12,4 +12,4 @@ import { IEmail } from "../interfaces";
  *
  * @returns {object|null} A promise that resolves to the result of the transaction (null if no users are passed in)
  */
-export declare function emailOrgUsers(users: IUser[], email: IEmail, authentication: IAuthenticationManager, isOrgAdmin: boolean): Promise<ICreateOrgNotificationResult>;
+export declare function emailOrgUsers(users: IUser[], email: IEmail, authentication: IAuthenticationManager, isOrgAdmin: boolean): Promise<ICreateOrgNotificationResult | null>;

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

@@ -3,3 +3,8 @@ export * from "./add-users-workflow";
 export * from "./types";
 export * from "./HubGroups";
 export * from "./HubGroup";
+export * from "./addOrInviteUsersToGroup";
+export * from "./addOrInviteUsersToGroups";
+export * from "./autoAddUsers";
+export * from "./inviteUsers";
+export * from "./emailOrgUsers";

package/dist/types/groups/{add-users-workflow/workflow-sections/invite-users.d.ts → inviteUsers.d.ts}

@@ -14,4 +14,4 @@ import { IAuthenticationManager } from "@esri/arcgis-rest-request";
  * @returns {object|null} Result of the transaction (null if no users are passed in)
  */
 export declare function inviteUsers(id: string, users: IUser[], authentication: IAuthenticationManager, expiration?: number, // default to 2 week expiration TODO: is this actually 2 weeks?
-role?: "group_member" | "group_admin"): Promise<IInviteGroupUsersResult>;
+role?: "group_member" | "group_admin"): Promise<IInviteGroupUsersResult | null>;

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

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

package/dist/types/groups/types/types.d.ts

@@ -0,0 +1,72 @@
+import { ArcGISRequestError, IAuthenticationManager } from "@esri/arcgis-rest-request";
+import { IUser } from "@esri/arcgis-rest-types";
+export interface IEmail {
+    subject?: string;
+    body?: string;
+    copyMe?: boolean;
+}
+/**
+ * User object returned from add users modal in ember application
+ * It extends the IUser interface with an additional property
+ * that denotes what org relationship the user might have (world|org|community|partnered|collaborationCoordinator)
+ */
+export interface IUserWithOrgType extends IUser {
+    orgType: "world" | "org" | "community" | "partnered" | "collaborationCoordinator";
+}
+/**
+ * User org relationship interface
+ * Object contains users parsed by their org relationship (world|org|community|partnered|collaborationCoordinator)
+ */
+export interface IUserOrgRelationship {
+    world: IUserWithOrgType[];
+    org: IUserWithOrgType[];
+    community: IUserWithOrgType[];
+    partnered: IUserWithOrgType[];
+    collaborationCoordinator: IUserWithOrgType[];
+}
+/**
+ * Interface governing the add or invite response out of process auto add / invite / emailing users
+ */
+export interface IAddOrInviteResponse {
+    users: string[];
+    errors: ArcGISRequestError[];
+    notAdded: string[];
+    notInvited: string[];
+    notEmailed: string[];
+}
+/**
+ * Email input object for add/invite flow
+ * contains both the IEmail object and auth for the email.
+ */
+export interface IAddOrInviteEmail {
+    message: IEmail;
+    auth: IAuthenticationManager;
+    groupId?: string;
+}
+/**
+ * Add or invite flow context - object that contains all the needed
+ * inputs for org/world/community users
+ */
+export interface IAddOrInviteContext extends IUserOrgRelationship {
+    groupId: string;
+    primaryRO: IAuthenticationManager;
+    allUsers: IUserWithOrgType[];
+    canAutoAddUser: boolean;
+    addUserAsGroupAdmin: boolean;
+    email: IAddOrInviteEmail;
+}
+/**
+ * Interface for result object out of addOrInviteUsersToGroup.
+ */
+export interface IAddOrInviteToGroupResult {
+    errors: ArcGISRequestError[];
+    notAdded: string[];
+    notInvited: string[];
+    notEmailed: string[];
+    community: IAddOrInviteResponse;
+    org: IAddOrInviteResponse;
+    world: IAddOrInviteResponse;
+    partnered: IAddOrInviteResponse;
+    collaborationCoordinator: IAddOrInviteResponse;
+    groupId: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.5.1",
+  "version": "14.6.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/groups/add-users-workflow/workflow-sections/auto-add-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auto-add-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/auto-add-users.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,aAAa,EACd,MAAM,0BAA0B,CAAC;AAGlC;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAC1B,EAAU,EACV,KAAc,EACd,cAAsC;IAEtC,IAAI,QAAQ,GAAkC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAA0B;YAClC,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;YACjC,cAAc;SACf,CAAC;QACF,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;KAChC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/esm/groups/add-users-workflow/workflow-sections/email-org-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-org-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/email-org-users.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,qBAAqB,EACtB,MAAM,0BAA0B,CAAC;AAIlC;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAc,EACd,KAAa,EACb,cAAsC,EACtC,UAAmB;IAEnB,IAAI,QAAQ,GAA0C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAAkC;YAC1C,cAAc;YACd,OAAO,EAAE,KAAK,CAAC,IAAI;YACnB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,uBAAuB,EAAE,OAAO;YAChC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;SAClC,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;SACpB;QACD,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;KACxC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/esm/groups/add-users-workflow/workflow-sections/index.js

@@ -1,4 +0,0 @@
-export * from "./auto-add-users";
-export * from "./email-org-users";
-export * from "./invite-users";
-//# sourceMappingURL=index.js.map

package/dist/esm/groups/add-users-workflow/workflow-sections/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC"}

package/dist/esm/groups/add-users-workflow/workflow-sections/invite-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"invite-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/invite-users.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAGlC;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CACzB,EAAU,EACV,KAAc,EACd,cAAsC,EACtC,UAAU,GAAG,KAAK,EAAE,+DAA+D;AACnF,OAAuC,cAAc,CAAC,4DAA4D;;IAElH,IAAI,QAAQ,GAAqC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAA6B;YACrC,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;YACnC,cAAc;YACd,IAAI;YACJ,UAAU;SACX,CAAC;QAEF,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;KACnC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/node/groups/add-users-workflow/workflow-sections/auto-add-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"auto-add-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/auto-add-users.ts"],"names":[],"mappings":";;;AACA,iEAIkC;AAGlC;;;;;;;;;GASG;AACH,SAAgB,YAAY,CAC1B,EAAU,EACV,KAAc,EACd,cAAsC;IAEtC,IAAI,QAAQ,GAAkC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAA0B;YAClC,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;YACjC,cAAc;SACf,CAAC;QACF,QAAQ,GAAG,kCAAa,CAAC,IAAI,CAAC,CAAC;KAChC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAhBD,oCAgBC"}

package/dist/node/groups/add-users-workflow/workflow-sections/email-org-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"email-org-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/email-org-users.ts"],"names":[],"mappings":";;;AACA,iEAIkC;AAIlC;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAC3B,KAAc,EACd,KAAa,EACb,cAAsC,EACtC,UAAmB;IAEnB,IAAI,QAAQ,GAA0C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAAkC;YAC1C,cAAc;YACd,OAAO,EAAE,KAAK,CAAC,IAAI;YACnB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,uBAAuB,EAAE,OAAO;YAChC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;SAClC,CAAC;QACF,IAAI,CAAC,UAAU,EAAE;YACf,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;SACpB;QACD,QAAQ,GAAG,0CAAqB,CAAC,IAAI,CAAC,CAAC;KACxC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAtBD,sCAsBC"}

package/dist/node/groups/add-users-workflow/workflow-sections/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./auto-add-users"), exports);
-tslib_1.__exportStar(require("./email-org-users"), exports);
-tslib_1.__exportStar(require("./invite-users"), exports);
-//# sourceMappingURL=index.js.map

package/dist/node/groups/add-users-workflow/workflow-sections/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,yDAA+B"}

package/dist/node/groups/add-users-workflow/workflow-sections/invite-users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"invite-users.js","sourceRoot":"","sources":["../../../../../src/groups/add-users-workflow/workflow-sections/invite-users.ts"],"names":[],"mappings":";;;AACA,iEAIkC;AAGlC;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,EAAU,EACV,KAAc,EACd,cAAsC,EACtC,UAAU,GAAG,KAAK,EAAE,+DAA+D;AACnF,OAAuC,cAAc,CAAC,4DAA4D;;IAElH,IAAI,QAAQ,GAAqC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,KAAK,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,GAA6B;YACrC,EAAE;YACF,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;YACnC,cAAc;YACd,IAAI;YACJ,UAAU;SACX,CAAC;QAEF,QAAQ,GAAG,qCAAgB,CAAC,IAAI,CAAC,CAAC;KACnC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AArBD,kCAqBC"}

package/dist/types/groups/add-users-workflow/workflow-sections/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./auto-add-users";
-export * from "./email-org-users";
-export * from "./invite-users";