@esri/hub-common 14.21.1 → 14.22.0

package/dist/node/groups/addOrInviteUsersToGroup.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addOrInviteUsersToGroup = void 0;
-const AddOrInviteUsersToGroupUtils_1 = require("./_internal/AddOrInviteUsersToGroupUtils");
-/**
- * Add or invite N users to a single group
- * Org|community|world logic flows are run even if there are no users applicable for that particular path.
- * Results from each path are consolidated and surfaced in the return object as failures and errors are of
- * more importance than successes.
- *
- * @export
- * @param {string} groupId Group we are adding users to
- * @param {IUserWithOrgType[]} users array of users to add
- * @param {IAuthenticationManager} primaryRO primary requestOptions
- * @param {boolean} canAutoAddUser Can we automatically add a user to the group?
- * @param {boolean} addUserAsGroupAdmin Should the user be added as a group administrator
- * @param {IAddOrInviteEmail} email Email object
- * @return {IAddOrInviteToGroupResult} Result object
- */
-async function addOrInviteUsersToGroup(groupId, users, primaryRO, canAutoAddUser, addUserAsGroupAdmin, email) {
-    // Group users by their org relationship
-    const parsedUsers = AddOrInviteUsersToGroupUtils_1.groupUsersByOrgRelationship(users);
-    // build up params for the context
-    const inputParams = {
-        groupId,
-        primaryRO,
-        allUsers: users,
-        canAutoAddUser,
-        addUserAsGroupAdmin,
-        email,
-    };
-    // create context from params and parsed users
-    const context = Object.assign(inputParams, parsedUsers);
-    // result obj by org relationship
-    const result = {
-        community: await AddOrInviteUsersToGroupUtils_1.addOrInviteCommunityUsers(context),
-        org: await AddOrInviteUsersToGroupUtils_1.addOrInviteOrgUsers(context),
-        world: await AddOrInviteUsersToGroupUtils_1.addOrInviteWorldUsers(context),
-        partnered: await AddOrInviteUsersToGroupUtils_1.addOrInvitePartneredUsers(context),
-        collaborationCoordinator: await AddOrInviteUsersToGroupUtils_1.addOrInviteCollaborationCoordinators(context),
-        notAdded: [],
-        notInvited: [],
-        notEmailed: [],
-        errors: [],
-        groupId,
-    };
-    // Bring not added / invited / emailed / errors up to the top level
-    result.notAdded = [
-        ...result.community.notAdded,
-        ...result.org.notAdded,
-        ...result.world.notAdded,
-    ];
-    result.notInvited = [
-        ...result.community.notInvited,
-        ...result.org.notInvited,
-        ...result.world.notInvited,
-    ];
-    result.notEmailed = [
-        ...result.community.notEmailed,
-        ...result.org.notEmailed,
-        ...result.world.notEmailed,
-    ];
-    result.errors = [
-        ...result.community.errors,
-        ...result.org.errors,
-        ...result.world.errors,
-    ];
-    return result;
-}
-exports.addOrInviteUsersToGroup = addOrInviteUsersToGroup;
-//# sourceMappingURL=addOrInviteUsersToGroup.js.map

package/dist/node/groups/addOrInviteUsersToGroup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"addOrInviteUsersToGroup.js","sourceRoot":"","sources":["../../../src/groups/addOrInviteUsersToGroup.ts"],"names":[],"mappings":";;;AAQA,2FAOkD;AAElD;;;;;;;;;;;;;;GAcG;AACI,KAAK,UAAU,uBAAuB,CAC3C,OAAe,EACf,KAAyB,EACzB,SAAiC,EACjC,cAAuB,EACvB,mBAA4B,EAC5B,KAAwB;IAExB,wCAAwC;IACxC,MAAM,WAAW,GAAyB,0DAA2B,CAAC,KAAK,CAAC,CAAC;IAC7E,kCAAkC;IAClC,MAAM,WAAW,GAAG;QAClB,OAAO;QACP,SAAS;QACT,QAAQ,EAAE,KAAK;QACf,cAAc;QACd,mBAAmB;QACnB,KAAK;KACN,CAAC;IACF,8CAA8C;IAC9C,MAAM,OAAO,GAAwB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAC7E,iCAAiC;IACjC,MAAM,MAAM,GAA8B;QACxC,SAAS,EAAE,MAAM,wDAAyB,CAAC,OAAO,CAAC;QACnD,GAAG,EAAE,MAAM,kDAAmB,CAAC,OAAO,CAAC;QACvC,KAAK,EAAE,MAAM,oDAAqB,CAAC,OAAO,CAAC;QAC3C,SAAS,EAAE,MAAM,wDAAyB,CAAC,OAAO,CAAC;QACnD,wBAAwB,EAAE,MAAM,mEAAoC,CAClE,OAAO,CACR;QACD,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,EAAE;QACd,MAAM,EAAE,EAAE;QACV,OAAO;KACR,CAAC;IACF,mEAAmE;IACnE,MAAM,CAAC,QAAQ,GAAG;QAChB,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;QAC5B,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ;QACtB,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ;KACzB,CAAC;IACF,MAAM,CAAC,UAAU,GAAG;QAClB,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU;QAC9B,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU;QACxB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU;KAC3B,CAAC;IACF,MAAM,CAAC,UAAU,GAAG;QAClB,GAAG,MAAM,CAAC,SAAS,CAAC,UAAU;QAC9B,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU;QACxB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU;KAC3B,CAAC;IACF,MAAM,CAAC,MAAM,GAAG;QACd,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM;QAC1B,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM;QACpB,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM;KACvB,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AA1DD,0DA0DC"}

package/dist/node/groups/addOrInviteUsersToGroups.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addOrInviteUsersToGroups = void 0;
-const addOrInviteUsersToGroup_1 = require("./addOrInviteUsersToGroup");
-/**
- * addOrInviteUsersToGroups adds/invites N users to N groups
- * Initial entry point function for add/invite members flow
- * when dealing with multiple groups.
- * Responses from each group are then consolidated into the final returned object.
- *
- * @export
- * @param {string[]} groupIds array of groups we are adding users to
- * @param {IUserWithOrgType[]} users array of users to add to those groups
- * @param {IAuthenticationManager} primaryRO primary requestOptions
- * @param {boolean} [canAutoAddUser=false] Can we automatically add a user to the group?
- * @param {boolean} [addUserAsGroupAdmin=false] Can the user be added to a group as an administrator of that group?
- * @param {IAddOrInviteEmail} [email] Email object contains auth for the email && the email object itself
- * @return {*}  {Promise<{
- *   notAdded: string[];
- *   notInvited: string[];
- *   notEmailed: string[];
- *   errors: ArcGISRequestError[];
- *   responses: IAddOrInviteToGroupResult[];
- * }>} Results object
- */
-async function addOrInviteUsersToGroups(groupIds, users, primaryRO, canAutoAddUser = false, addUserAsGroupAdmin = false, email) {
-    let notAdded = [];
-    let notInvited = [];
-    let notEmailed = [];
-    let errors = [];
-    const responses = [];
-    // need to for..of loop this as a reduce will overwrite promises during execution
-    // this way we get an object of each group id nicely.
-    for (const groupId of groupIds) {
-        // For each group we'll add the users to them.
-        const result = await addOrInviteUsersToGroup_1.addOrInviteUsersToGroup(groupId, users, primaryRO, canAutoAddUser, addUserAsGroupAdmin, email);
-        // attach each groups results
-        responses.push(result);
-        // surface results to the top of the stack...
-        notAdded = notAdded.concat(result.notAdded);
-        errors = errors.concat(result.errors);
-        notInvited = notInvited.concat(result.notInvited);
-        notEmailed = notEmailed.concat(result.notEmailed);
-    }
-    // Return built up result object.
-    return {
-        notAdded,
-        notInvited,
-        notEmailed,
-        errors,
-        responses,
-    };
-}
-exports.addOrInviteUsersToGroups = addOrInviteUsersToGroups;
-//# sourceMappingURL=addOrInviteUsersToGroups.js.map

package/dist/node/groups/addOrInviteUsersToGroups.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"addOrInviteUsersToGroups.js","sourceRoot":"","sources":["../../../src/groups/addOrInviteUsersToGroups.ts"],"names":[],"mappings":";;;AASA,uEAAoE;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACI,KAAK,UAAU,wBAAwB,CAC5C,QAAkB,EAClB,KAAyB,EACzB,SAAiC,EACjC,iBAA0B,KAAK,EAC/B,sBAA+B,KAAK,EACpC,KAAyB;IAQzB,IAAI,QAAQ,GAAa,EAAE,CAAC;IAC5B,IAAI,UAAU,GAAa,EAAE,CAAC;IAC9B,IAAI,UAAU,GAAa,EAAE,CAAC;IAC9B,IAAI,MAAM,GAAyB,EAAE,CAAC;IACtC,MAAM,SAAS,GAAgC,EAAE,CAAC;IAClD,iFAAiF;IACjF,qDAAqD;IACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC9B,8CAA8C;QAC9C,MAAM,MAAM,GAAG,MAAM,iDAAuB,CAC1C,OAAO,EACP,KAAK,EACL,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,KAAK,CACN,CAAC;QACF,6BAA6B;QAC7B,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,6CAA6C;QAC7C,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAClD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;KACnD;IACD,iCAAiC;IACjC,OAAO;QACL,QAAQ;QACR,UAAU;QACV,UAAU;QACV,MAAM;QACN,SAAS;KACV,CAAC;AACJ,CAAC;AA/CD,4DA+CC"}

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

@@ -1,82 +0,0 @@
-import { IAddOrInviteContext, IAddOrInviteResponse, IUserOrgRelationship, IUserWithOrgType } from "../types";
-/**
- * @private
- * Handles add/invite logic for collaboration coordinators inside partnered orgs.
- * This is intentionally split out from the invitation of partnered org normal members,
- * because the two types of partnered org usres (regular and collaboration coordinator)
- * always come from the same 'bucket', however have distinctly different add paths Invite vs auto add.
- * It returns either an empty instance of the addOrInviteResponse
- * object, or their response from auto adding users.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @return {IAddOrInviteResponse} response object
- */
-export declare function addOrInviteCollaborationCoordinators(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Handles add/invite logic for community users
- * It returns either an empty instance of the addOrInviteResponse
- * object, or either ther esponse from processing auto adding
- * users or inviting users. If an email has been passed in it also notifies
- * processAutoAddUsers that emails should be sent.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @return {IAddOrInviteResponse} response object
- */
-export declare function addOrInviteCommunityUsers(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Handles add/invite logic for Org users
- * It returns either an empty instance of the addOrInviteResponse
- * object, or either ther esponse from processing auto adding a users or inviting a user
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @return {IAddOrInviteResponse} response object
- */
-export declare function addOrInviteOrgUsers(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Handles add/invite logic for partnered org users.
- * It returns either an empty instance of the addOrInviteResponse
- * object, or their response from inviting users.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @return {IAddOrInviteResponse} response object
- */
-export declare function addOrInvitePartneredUsers(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Handles add/invite logic for world users
- * It either returns an empty instance of the add/invite response
- * object, or a populated version from processInviteUsers
- *
- * @export
- * @param {IAddOrInviteContext} context Context object
- * @return {IAddOrInviteResponse} Response object
- */
-export declare function addOrInviteWorldUsers(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Returns an empty instance of the addorinviteresponse object.
- * We are using this because if you leave out any of the props
- * from the final object and you are concatting together arrays you can concat
- * an undeifined inside an array which will throw off array lengths.
- *
- * @export
- * @return {IAddOrInviteResponse}
- */
-export declare function handleNoUsers(context?: IAddOrInviteContext, userType?: "world" | "org" | "community" | "partnered", shouldEmail?: boolean): Promise<IAddOrInviteResponse>;
-/**
- * @private
- * Takes users array and sorts them into an object by the type of user they are
- * based on the orgType prop (world|org|community)
- *
- * @export
- * @param {IUserWithOrgType[]} users array of users
- * @return {IUserOrgRelationship} Object of users sorted by type (world, org, community)
- */
-export declare function groupUsersByOrgRelationship(users: IUserWithOrgType[]): IUserOrgRelationship;

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

@@ -1,15 +0,0 @@
-import { IAddOrInviteContext, IAddOrInviteResponse } from "../types";
-/**
- * @private
- * Governs logic for automatically adding N users to a group.
- * Users are added as either a regular user OR as an administrator of the group
- * depending on the addUserAsGroupAdmin prop on the IAddOrInviteContext.
- * If there is an email object on the IAddOrInviteContext, then email notifications are sent.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @param {string} userType what type of user is it: org | world | community
- * @param {boolean} [shouldEmail=false] should the user be emailed?
- * @return {IAddOrInviteResponse} response object
- */
-export declare function processAutoAddUsers(context: IAddOrInviteContext, userType: "world" | "org" | "community" | "partnered" | "collaborationCoordinator", shouldEmail?: boolean): Promise<IAddOrInviteResponse>;

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

@@ -1,14 +0,0 @@
-import { IAddOrInviteContext, IAddOrInviteResponse } from "../types";
-/**
- * @private
- * Governs the logic for emailing N users. It acts under the assumption
- * that all the 'community' users are the ones being emailed (this is due to platform rules we conform to)
- * Function is called upstream depending on if an email object is attached to the context.
- * Email object contains its own auth as it'll require the community admin to send the email itself.
- * An individual email call goes out for each user due to how the response of multiple users in a single call works.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @return {IAddOrInviteResponse} response object
- */
-export declare function processEmailUsers(context: IAddOrInviteContext): Promise<IAddOrInviteResponse>;

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

@@ -1,13 +0,0 @@
-import { IAddOrInviteContext, IAddOrInviteResponse } from "../types";
-/**
- * @private
- * Governs the logic for inviting N users to a single group.
- * An individual invite call goes out for each user and the results are consolidated.
- * See comment in function about the for...of loop which explains reasoning.
- *
- * @export
- * @param {IAddOrInviteContext} context context object
- * @param {string} userType what type of user is it: org | world | community
- * @return {IAddOrInviteResponse} response object
- */
-export declare function processInviteUsers(context: IAddOrInviteContext, userType: "world" | "org" | "community" | "partnered"): Promise<IAddOrInviteResponse>;

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

@@ -1,18 +0,0 @@
-import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-import { IAddOrInviteEmail, IAddOrInviteToGroupResult, IUserWithOrgType } from "./types";
-/**
- * Add or invite N users to a single group
- * Org|community|world logic flows are run even if there are no users applicable for that particular path.
- * Results from each path are consolidated and surfaced in the return object as failures and errors are of
- * more importance than successes.
- *
- * @export
- * @param {string} groupId Group we are adding users to
- * @param {IUserWithOrgType[]} users array of users to add
- * @param {IAuthenticationManager} primaryRO primary requestOptions
- * @param {boolean} canAutoAddUser Can we automatically add a user to the group?
- * @param {boolean} addUserAsGroupAdmin Should the user be added as a group administrator
- * @param {IAddOrInviteEmail} email Email object
- * @return {IAddOrInviteToGroupResult} Result object
- */
-export declare function addOrInviteUsersToGroup(groupId: string, users: IUserWithOrgType[], primaryRO: IAuthenticationManager, canAutoAddUser: boolean, addUserAsGroupAdmin: boolean, email: IAddOrInviteEmail): Promise<IAddOrInviteToGroupResult>;

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

@@ -1,30 +0,0 @@
-import { ArcGISRequestError, IAuthenticationManager } from "@esri/arcgis-rest-request";
-import { IAddOrInviteEmail, IAddOrInviteToGroupResult, IUserWithOrgType } from "./types";
-/**
- * addOrInviteUsersToGroups adds/invites N users to N groups
- * Initial entry point function for add/invite members flow
- * when dealing with multiple groups.
- * Responses from each group are then consolidated into the final returned object.
- *
- * @export
- * @param {string[]} groupIds array of groups we are adding users to
- * @param {IUserWithOrgType[]} users array of users to add to those groups
- * @param {IAuthenticationManager} primaryRO primary requestOptions
- * @param {boolean} [canAutoAddUser=false] Can we automatically add a user to the group?
- * @param {boolean} [addUserAsGroupAdmin=false] Can the user be added to a group as an administrator of that group?
- * @param {IAddOrInviteEmail} [email] Email object contains auth for the email && the email object itself
- * @return {*}  {Promise<{
- *   notAdded: string[];
- *   notInvited: string[];
- *   notEmailed: string[];
- *   errors: ArcGISRequestError[];
- *   responses: IAddOrInviteToGroupResult[];
- * }>} Results object
- */
-export declare function addOrInviteUsersToGroups(groupIds: string[], users: IUserWithOrgType[], primaryRO: IAuthenticationManager, canAutoAddUser?: boolean, addUserAsGroupAdmin?: boolean, email?: IAddOrInviteEmail): Promise<{
-    notAdded: string[];
-    notInvited: string[];
-    notEmailed: string[];
-    errors: ArcGISRequestError[];
-    responses: IAddOrInviteToGroupResult[];
-}>;