@esri/hub-common 13.17.3 → 13.17.4

package/dist/esm/features/_internal/checkFeatureAccess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkFeatureAccess.js","sourceRoot":"","sources":["../../../../src/features/_internal/checkFeatureAccess.ts"],"names":[],"mappings":";AAAA,wDAAwD;AACxD,iFAAiF;AACjF,8EAA8E;AAC9E,sEAAsE;AACtE,wDAAwD;AAExD,uCAAuC;AACvC,sBAAsB;AACtB,KAAK;AAEL,4DAA4D;AAC5D,8DAA8D;AAC9D,gEAAgE;AAEhE,4CAA4C;AAC5C,uBAAuB;AACvB,KAAK;AAEL,4CAA4C;AAC5C,uBAAuB;AACvB,KAAK;AAEL,iFAAiF;AACjF,2BAA2B;AAC3B,oBAAoB;AACpB,8BAA8B;AAC9B,qBAAqB;AACrB,+BAA+B;AAC/B,uBAAuB;AACvB,iCAAiC;AACjC,sBAAsB;AACtB,mCAAmC;AACnC,yBAAyB;AACzB,mCAAmC;AACnC,eAAe;AACf,2BAA2B;AAC3B,mCAAmC;AACnC,MAAM;AACN,IAAI;AAEJ,+DAA+D;AAC/D,qCAAqC;AACrC,2EAA2E;AAC3E,aAAa;AACb,iCAAiC;AACjC,2BAA2B;AAC3B,OAAO;AACP,IAAI;AAEJ,MAAM;AACN,iCAAiC;AACjC,mBAAmB;AACnB,oBAAoB;AACpB,mBAAmB;AACnB,cAAc;AACd,MAAM;AACN,sCAAsC;AACtC,yBAAyB;AACzB,6BAA6B;AAC7B,iCAAiC;AACjC,8BAA8B;AAC9B,2DAA2D;AAC3D,+CAA+C;AAC/C,6CAA6C;AAC7C,0DAA0D;AAC1D,sDAAsD;AACtD,6CAA6C;AAC7C,8BAA8B;AAC9B,kBAAkB;AAClB,oBAAoB;AACpB,0BAA0B;AAC1B,6BAA6B;AAC7B,sCAAsC;AACtC,8EAA8E;AAC9E,YAAY;AACZ,gBAAgB;AAChB,oDAAoD;AACpD,+DAA+D;AAC/D,8CAA8C;AAC9C,WAAW;AACX,uBAAuB;AACvB,sCAAsC;AAEtC,6BAA6B;AAC7B,uCAAuC;AACvC,6BAA6B;AAC7B,6DAA6D;AAC7D,gDAAgD;AAChD,6BAA6B;AAC7B,YAAY;AAEZ,wBAAwB;AACxB,6EAA6E;AAC7E,0DAA0D;AAC1D,WAAW;AACX,gCAAgC;AAChC,eAAe;AACf,0BAA0B;AAC1B,oCAAoC;AACpC,gCAAgC;AAChC,wCAAwC;AACxC,sCAAsC;AACtC,yBAAyB;AACzB,SAAS;AACT,SAAS;AACT,IAAI"}

package/dist/esm/features/_internal/index.js

@@ -0,0 +1,3 @@
+"use strict";
+// export * from "./checkFeatureAccess";
+//# sourceMappingURL=index.js.map

package/dist/esm/features/_internal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/features/_internal/index.ts"],"names":[],"mappings":";AAAA,wCAAwC"}

package/dist/esm/features/checkFeature.js

@@ -0,0 +1,107 @@
+import { isHubFeature } from "./types";
+const QaExtFeatures = {
+    workspaces: true,
+};
+const DevExtFeatures = Object.assign({}, QaExtFeatures);
+const LocalDevFeatures = Object.assign({}, QaExtFeatures);
+const SandboxDevFeatures = Object.assign({}, QaExtFeatures);
+const ProductionFeatures = {
+    workspaces: false,
+};
+const EnterpriseFeatures = {
+    workspaces: false,
+};
+function getFeaturesForEnvironment(environment) {
+    switch (environment) {
+        case "qaext":
+            return QaExtFeatures;
+        case "devext":
+            return DevExtFeatures;
+        case "localdev":
+            return LocalDevFeatures;
+        case "sandbox":
+            return SandboxDevFeatures;
+        case "enterprise":
+            return EnterpriseFeatures;
+        default:
+            // default to prod
+            return ProductionFeatures;
+    }
+}
+function getFeatures(context) {
+    const { environment } = context;
+    const featuresForEnvironment = getFeaturesForEnvironment(environment);
+    return Object.assign(Object.assign({}, featuresForEnvironment), context.features);
+}
+/**
+ * Check if a capability is enabled for a given entity and if the current user has necessary permissions to access it
+ * @param capability
+ * @param context
+ * @param entity
+ * @returns
+ */
+export function checkFeature(feature, context, entity) {
+    /*
+      TODO:
+        - by env
+        - by org??? checkAlpha? probably not checkLicense - that would be for a capability...
+        - by entity??? or is it entity type???
+          - if it is turned off for the env it is off for all entities???
+          - if it is on for the env but off for the entity then it is off for that entity???
+          - url params can ovverride everything???
+    */
+    // const entityType: HubEntityType = getTypeFromEntity(entity);
+    // Find the rule for the given entity type and capability
+    const isValid = isHubFeature(feature);
+    if (isValid) {
+        const featuresHash = getFeatures(context);
+        const enabled = featuresHash[feature];
+        if (enabled) {
+            return {
+                feature,
+                access: true,
+                code: "enabled",
+                response: "granted",
+            };
+        }
+        else {
+            return {
+                feature,
+                access: false,
+                code: "disabled",
+                response: "feature-not-available",
+                message: `Feature "${feature}" is not enabled for this environment.`,
+            };
+        }
+        // ======
+        // const rule = CapabilityPermissions.find(
+        //   hubFeature => hubFeature.entity === entityType && hubFeature.feature === feature
+        // );
+        // if (rule) {
+        //   // check each capability access rule
+        //   return checkFeatureAccess(rule, context, entity);
+        // } else {
+        //   // No rule found
+        //   return {
+        //     feature,
+        //     access: false,
+        //     code: "disabled",
+        //     response: "not-available",
+        //     message: `Feature "${feature}" is not defined for ${entityType}.`,
+        //     responses: [],
+        //   } as IFeatureAccessResponse;
+        // }
+    }
+    else {
+        // Invalid Feature
+        return {
+            feature,
+            access: false,
+            code: "disabled",
+            response: "invalid-feature",
+            message: `Value "${feature}" is not a valid Hub Feature.`,
+            responses: [],
+        };
+    }
+}
+//# sourceMappingURL=checkFeature.js.map

package/dist/esm/features/checkFeature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkFeature.js","sourceRoot":"","sources":["../../../src/features/checkFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmD,YAAY,EAAE,MAAM,SAAS,CAAC;AAiBxF,MAAM,aAAa,GAAgB;IACjC,UAAU,EAAE,IAAI;CACjB,CAAC;AAEF,MAAM,cAAc,qBAAqB,aAAa,CAAE,CAAC;AACzD,MAAM,gBAAgB,qBAAqB,aAAa,CAAE,CAAC;AAC3D,MAAM,kBAAkB,qBAAqB,aAAa,CAAE,CAAC;AAE7D,MAAM,kBAAkB,GAAgB;IACtC,UAAU,EAAE,KAAK;CAClB,CAAC;AAEF,MAAM,kBAAkB,GAAgB;IACtC,UAAU,EAAE,KAAK;CAClB,CAAC;AAEF,SAAS,yBAAyB,CAAC,WAA2B;IAC5D,QAAQ,WAAW,EAAE;QACnB,KAAK,OAAO;YACV,OAAO,aAAa,CAAC;QACvB,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC;QACxB,KAAK,UAAU;YACb,OAAO,gBAAgB,CAAC;QAC1B,KAAK,SAAS;YACZ,OAAO,kBAAkB,CAAC;QAC5B,KAAK,YAAY;YACf,OAAO,kBAAkB,CAAC;QAC5B;YACE,kBAAkB;YAClB,OAAO,kBAAkB,CAAC;KAC7B;AACH,CAAC;AAED,SAAS,WAAW,CAAC,OAAuB;IAC1C,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,sBAAsB,GAAG,yBAAyB,CAAC,WAAW,CAAC,CAAC;IACtE,uCACK,sBAAsB,GACtB,OAAO,CAAC,QAAQ,EACnB;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAmB,EACnB,OAAuB,EACvB,MAAkC;IAElC;;;;;;;;MAQE;IACF,+DAA+D;IAC/D,yDAAyD;IACzD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,OAAO,EAAE;QACX,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,OAAO,EAAE;YACX,OAAO;gBACL,OAAO;gBACP,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,SAAS;aACM,CAAC;SAC7B;aAAM;YACL,OAAO;gBACL,OAAO;gBACP,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,OAAO,EAAE,YAAY,OAAO,wCAAwC;aAC3C,CAAC;SAC7B;QACD,SAAS;QACT,2CAA2C;QAC3C,qFAAqF;QACrF,KAAK;QACL,cAAc;QACd,yCAAyC;QACzC,sDAAsD;QACtD,WAAW;QACX,qBAAqB;QACrB,aAAa;QACb,eAAe;QACf,qBAAqB;QACrB,wBAAwB;QACxB,iCAAiC;QACjC,yEAAyE;QACzE,qBAAqB;QACrB,iCAAiC;QACjC,IAAI;KACL;SAAM;QACL,kBAAkB;QAClB,OAAO;YACL,OAAO;YACP,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,iBAAiB;YAC3B,OAAO,EAAE,UAAU,OAAO,+BAA+B;YACzD,SAAS,EAAE,EAAE;SACY,CAAC;KAC7B;AACH,CAAC"}

package/dist/esm/features/index.js

@@ -0,0 +1,5 @@
+export * from "./types";
+// export * from "./processEntityCapabilities";
+// export * from "./getWorkspaceCapabilities";
+export * from "./checkFeature";
+//# sourceMappingURL=index.js.map

package/dist/esm/features/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/features/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,+CAA+C;AAC/C,8CAA8C;AAC9C,cAAc,gBAAgB,CAAC"}

package/dist/esm/features/types.js

@@ -0,0 +1,28 @@
+/**
+ * Hub System Features
+ */
+const validFeaures = [
+    "workspaces",
+];
+/**
+ * Validate a feature. This is used because the libary can be used outside of typescript and we want to be able to return a message is the string passed in is not a valid capability
+ * @param Feature
+ * @returns
+ */
+export function isHubFeature(maybeFeature) {
+    return validFeaures.includes(maybeFeature);
+}
+// /**
+//  * All capability checks for an Entity's workspace
+//  */
+// export interface IWorkspaceCapabilityResponse {
+//   /**
+//    * Array of capabilities the current user has access to, in the context of a given entity
+//    */
+//   granted: Capability[];
+//   /**
+//    * Detailed checks for each capability. Used for observability
+//    */
+//   details: ICapabilityAccessResponse[];
+// }
+//# sourceMappingURL=types.js.map

package/dist/esm/features/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/features/types.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,YAAY,GAAG;IACnB,YAAY;CACJ,CAAC;AAcX;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,YAAoB;IAC/C,OAAO,YAAY,CAAC,QAAQ,CAAC,YAA0B,CAAC,CAAC;AAC3D,CAAC;AAyBD,MAAM;AACN,qDAAqD;AACrD,MAAM;AACN,kDAAkD;AAClD,QAAQ;AACR,8FAA8F;AAC9F,QAAQ;AACR,2BAA2B;AAC3B,QAAQ;AACR,mEAAmE;AACnE,QAAQ;AACR,0CAA0C;AAC1C,IAAI"}

package/dist/esm/groups/HubGroup.js

@@ -0,0 +1,258 @@
+import { createHubGroup, updateHubGroup, fetchHubGroup, deleteHubGroup, } from "./HubGroups";
+import { convertHubGroupToGroup } from "./_internal/convertHubGroupToGroup";
+import { DEFAULT_GROUP } from "./defaults";
+import { addPermissionPolicy, checkPermission, removePermissionPolicy, } from "../permissions";
+import { cloneObject } from "../util";
+import { getEditorConfig } from "../core/schemas/getEditorConfig";
+import { setGroupThumbnail } from "./setGroupThumbnail";
+import { getGroupThumbnailUrl } from "../search/utils";
+import { deleteGroupThumbnail } from "./deleteGroupThumbnail";
+import { enrichEntity } from "../core/enrichEntity";
+/**
+ * Hub Group Class
+ */
+export class HubGroup {
+    constructor(group, context) {
+        this.isDestroyed = false;
+        this.thumbnailCache = null;
+        this.entity = group;
+        this.context = context;
+    }
+    /**
+     * Whether the user can edit the group,
+     * only the owner or admins of the group can
+     */
+    get canEdit() {
+        return ((this.entity.memberType &&
+            (this.entity.memberType === "owner" ||
+                this.entity.memberType === "admin")) ||
+            this.entity.owner === this.context.currentUser.username);
+    }
+    /**
+     * Whether the user can delete the group
+     * only the owner or admins of the group can
+     */
+    get canDelete() {
+        return this.canEdit;
+    }
+    /**
+     * Whether the group is protected, if so, it can't be deleted
+     */
+    get isProtected() {
+        return this.entity.protected;
+    }
+    /**
+     * Create an instance from an IHubGroup object
+     * @param json - JSON object to create a HubGroup from
+     * @param context - ArcGIS context
+     * @returns
+     */
+    static fromJson(json, context) {
+        // merge what we have with the default values
+        const pojo = this.applyDefaults(json);
+        return new HubGroup(pojo, context);
+    }
+    /**
+     * Create a new HubGroup, returning a HubGroup instance.
+     * Note: This does not persist the Group into the backing store
+     * @param partialGroup
+     * @param context
+     * @returns
+     */
+    static async create(partialGroup, context, save = false) {
+        const pojo = this.applyDefaults(partialGroup);
+        // return an instance of HubGroup
+        const instance = HubGroup.fromJson(pojo, context);
+        if (save) {
+            await instance.save();
+        }
+        return instance;
+    }
+    /**
+     * Fetch a Group from the backing store and return a HubGroup instance.
+     * @param identifier - Identifier of the group to load
+     * @param context
+     * @returns
+     */
+    static async fetch(identifier, context) {
+        try {
+            const group = await fetchHubGroup(identifier, context.userRequestOptions);
+            // create an instance of HubGroup from the group
+            return HubGroup.fromJson(group, context);
+        }
+        catch (ex) {
+            if (ex.message ===
+                "COM_0003: Group does not exist or is inaccessible.") {
+                throw new Error(`Group not found.`);
+            }
+            else {
+                throw ex;
+            }
+        }
+    }
+    static applyDefaults(partialGroup) {
+        // extend the partial over the defaults
+        return Object.assign(Object.assign({}, DEFAULT_GROUP), partialGroup);
+    }
+    /**
+     * Return the backing entity as an object literal
+     */
+    toJson() {
+        if (this.isDestroyed) {
+            throw new Error("HubGroup is already destroyed.");
+        }
+        return cloneObject(this.entity);
+    }
+    /**
+     * Apply a new state to the instance
+     * @param changes
+     */
+    update(changes) {
+        if (this.isDestroyed) {
+            throw new Error("HubGroup is already destroyed.");
+        }
+        // merge partial onto existing entity
+        this.entity = Object.assign(Object.assign({}, this.entity), changes);
+    }
+    /**
+     * Save the HubGroup to the backing store
+     * @returns
+     */
+    async save() {
+        if (this.isDestroyed) {
+            throw new Error("HubGroup is already destroyed.");
+        }
+        if (this.entity.id) {
+            // update it
+            this.entity = await updateHubGroup(this.entity, this.context.userRequestOptions);
+        }
+        else {
+            // create it
+            this.entity = await createHubGroup(this.entity, this.context.userRequestOptions);
+        }
+        return;
+    }
+    /**
+     * Delete the HubGroup from the store
+     * set a flag to indicate that it is destroyed
+     * @returns
+     */
+    async delete() {
+        if (this.isDestroyed) {
+            throw new Error("HubGroup is already destroyed.");
+        }
+        this.isDestroyed = true;
+        // Delegate to module fn
+        await deleteHubGroup(this.entity.id, this.context.userRequestOptions);
+    }
+    /**
+     * Check if current user has a specific permission, accounting for
+     * both system and entity level policies
+     * @param permission
+     * @returns
+     */
+    checkPermission(permission) {
+        return checkPermission(permission, this.context, this.entity);
+    }
+    /**
+     * Get all policies related to a specific permission
+     * @param permission
+     * @returns
+     */
+    getPermissionPolicies(permission) {
+        const permissions = this.entity.permissions;
+        return permissions.filter((p) => p.permission === permission);
+    }
+    /**
+     * Add a policy to the entity
+     * @param policy
+     */
+    addPermissionPolicy(policy) {
+        this.entity.permissions = addPermissionPolicy(this.entity.permissions, policy);
+    }
+    /**
+     * Remove a policy from the entity
+     * @param permission
+     * @param id
+     */
+    removePermissionPolicy(permission, id) {
+        this.entity.permissions = removePermissionPolicy(this.entity.permissions, permission, id);
+    }
+    /*
+     * Get the editor config for the HubGroup entity.
+     * @param i18nScope translation scope to be interpolated into the uiSchema
+     * @param type editor type - corresonds to the returned uiSchema
+     * @param options optional hash of dynamic uiSchema element options
+     */
+    async getEditorConfig(i18nScope, type) {
+        // delegate to the schema subsystem
+        return getEditorConfig(i18nScope, type, this.entity, this.context);
+    }
+    /**
+     * Return the group as an editor object
+     */
+    async toEditor(editorContext = {}, include = []) {
+        // 1. optionally enrich entity and cast to editor
+        const editor = include.length
+            ? (await enrichEntity(cloneObject(this.entity), include, this.context.hubRequestOptions))
+            : cloneObject(this.entity);
+        // 2. Apply transforms to relevant entity values so they
+        // can be consumed by the editor
+        return editor;
+    }
+    /**
+     * Load the group from the editor object
+     * @param editor
+     * @returns
+     */
+    async fromEditor(editor) {
+        const isCreate = !editor.id;
+        // Setting the thumbnailCache will ensure that
+        // the thumbnail is updated on next save
+        if (editor._thumbnail) {
+            if (editor._thumbnail.blob) {
+                this.thumbnailCache = {
+                    file: editor._thumbnail.blob,
+                    filename: editor._thumbnail.fileName,
+                    clear: false,
+                };
+            }
+            else {
+                this.thumbnailCache = {
+                    clear: true,
+                };
+            }
+        }
+        delete editor._thumbnail;
+        if (this.thumbnailCache) {
+            if (this.thumbnailCache.clear) {
+                await deleteGroupThumbnail(this.entity.id, this.context.userRequestOptions);
+            }
+            else {
+                await setGroupThumbnail(this.entity.id, this.thumbnailCache.file, this.thumbnailCache.filename, this.context.userRequestOptions, this.entity.owner);
+                // Note: updating the thumbnail alone does not update the modified date of the group
+                // thus we can just set props on the entity w/o re-fetching
+                this.entity.thumbnail = `thumbnail/${this.thumbnailCache.filename}`;
+                // Cover the Hub Group to an IGoup
+                const group = convertHubGroupToGroup(this.entity);
+                this.entity.thumbnailUrl = getGroupThumbnailUrl(this.context.userRequestOptions.portal, group);
+                // clear the thumbnail cache
+                this.thumbnailCache = null;
+            }
+        }
+        // convert back to an entity. Apply any reverse transforms used in
+        // of the toEditor method
+        const entity = cloneObject(editor);
+        // create it if it does not yet exist...
+        if (isCreate) {
+            throw new Error("Cannot create group using the Editor.");
+        }
+        else {
+            // ...otherwise, update the in-memory entity and save it
+            this.entity = entity;
+            await this.save();
+        }
+        return this.entity;
+    }
+}
+//# sourceMappingURL=HubGroup.js.map

package/dist/esm/groups/HubGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubGroup.js","sourceRoot":"","sources":["../../../src/groups/HubGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,cAAc,EACd,aAAa,EACb,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAIL,mBAAmB,EACnB,eAAe,EACf,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AAIxB,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAKtC,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAG9D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,OAAO,QAAQ;IAYnB,YAAoB,KAAgB,EAAE,OAAuB;QAJnD,gBAAW,GAAG,KAAK,CAAC;QACpB,mBAAc,GACtB,IAAI,CAAC;QAGL,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,CACL,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU;YACrB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,OAAO;gBACjC,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,OAAO,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CACxD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAwB,EAAE,OAAuB;QAC/D,6CAA6C;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,YAAgC,EAChC,OAAuB,EACvB,OAAgB,KAAK;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC9C,iCAAiC;QACjC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAClD,IAAI,IAAI,EAAE;YACR,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;SACvB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,UAAkB,EAClB,OAAuB;QAEvB,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAC1E,gDAAgD;YAChD,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SAC1C;QAAC,OAAO,EAAE,EAAE;YACX,IACG,EAAY,CAAC,OAAO;gBACrB,oDAAoD,EACpD;gBACA,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;aACrC;iBAAM;gBACL,MAAM,EAAE,CAAC;aACV;SACF;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,YAAgC;QAC3D,uCAAuC;QACvC,OAAO,gCAAK,aAAa,GAAK,YAAY,CAAe,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAA2B;QAChC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,qCAAqC;QACrC,IAAI,CAAC,MAAM,mCAAQ,IAAI,CAAC,MAAM,GAAK,OAAO,CAAE,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE;YAClB,YAAY;YACZ,IAAI,CAAC,MAAM,GAAG,MAAM,cAAc,CAChC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;SACH;aAAM;YACL,YAAY;YACZ,IAAI,CAAC,MAAM,GAAG,MAAM,cAAc,CAChC,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;SACH;QACD,OAAO;IACT,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACV,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,wBAAwB;QACxB,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,UAAsB;QACpC,OAAO,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,UAAsB;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QAC5C,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,MAA+B;QACjD,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,mBAAmB,CAC3C,IAAI,CAAC,MAAM,CAAC,WAAW,EACvB,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,UAAsB,EAAE,EAAU;QACvD,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,sBAAsB,CAC9C,IAAI,CAAC,MAAM,CAAC,WAAW,EACvB,UAAU,EACV,EAAE,CACH,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CACnB,SAAiB,EACjB,IAAqB;QAErB,mCAAmC;QACnC,OAAO,eAAe,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,gBAAsC,EAAE,EACxC,UAAoB,EAAE;QAEtB,iDAAiD;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAE,CAAC,MAAM,YAAY,CAClB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EACxB,OAAO,EACP,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAC/B,CAAqB;YACxB,CAAC,CAAE,WAAW,CAAC,IAAI,CAAC,MAAM,CAAqB,CAAC;QAElD,wDAAwD;QACxD,gCAAgC;QAEhC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,MAAuB;QACtC,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAE5B,8CAA8C;QAC9C,wCAAwC;QACxC,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE;gBAC1B,IAAI,CAAC,cAAc,GAAG;oBACpB,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;oBAC5B,QAAQ,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ;oBACpC,KAAK,EAAE,KAAK;iBACb,CAAC;aACH;iBAAM;gBACL,IAAI,CAAC,cAAc,GAAG;oBACpB,KAAK,EAAE,IAAI;iBACZ,CAAC;aACH;SACF;QACD,OAAO,MAAM,CAAC,UAAU,CAAC;QAEzB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE;gBAC7B,MAAM,oBAAoB,CACxB,IAAI,CAAC,MAAM,CAAC,EAAE,EACd,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAChC,CAAC;aACH;iBAAM;gBACL,MAAM,iBAAiB,CACrB,IAAI,CAAC,MAAM,CAAC,EAAE,EACd,IAAI,CAAC,cAAc,CAAC,IAAI,EACxB,IAAI,CAAC,cAAc,CAAC,QAAQ,EAC5B,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAClB,CAAC;gBAEF,oFAAoF;gBACpF,2DAA2D;gBAC3D,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,aAAa,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;gBACpE,kCAAkC;gBAClC,MAAM,KAAK,GAAG,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAClD,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,oBAAoB,CAC7C,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,EACtC,KAAK,CACN,CAAC;gBACF,4BAA4B;gBAC5B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;aAC5B;SACF;QAED,kEAAkE;QAClE,yBAAyB;QACzB,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAc,CAAC;QAEhD,wCAAwC;QACxC,IAAI,QAAQ,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;aAAM;YACL,wDAAwD;YACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}

package/dist/esm/groups/_internal/AddOrInviteUsersToGroupUtils.js

@@ -0,0 +1,195 @@
+import { processAutoAddUsers } from "./processAutoAddUsers";
+import { processInviteUsers } from "./processInviteUsers";
+// Add or invite flow based on the type of user begins here
+/**
+ * @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 async function addOrInviteCollaborationCoordinators(context) {
+    // If there are no org users return handling no users
+    if (!context.collaborationCoordinator ||
+        context.collaborationCoordinator.length === 0) {
+        // we return an empty object 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.
+        return handleNoUsers();
+    }
+    return processAutoAddUsers(context, "collaborationCoordinator");
+}
+/**
+ * @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 async function addOrInviteCommunityUsers(context) {
+    // We default to handleNoUsers
+    // we return an empty object 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.
+    let fnToCall = handleNoUsers;
+    let shouldEmail = false;
+    // If community users were passed in...
+    if (context.community && context.community.length > 0) {
+        // Default to either autoAdd or invite based on canAutoAddUser.
+        fnToCall = context.canAutoAddUser
+            ? processAutoAddUsers
+            : processInviteUsers;
+        // If we have an email object
+        // Then we will auto add...
+        // But whether or not we email is still in question
+        if (context.email) {
+            // If the email object has the groupId property...
+            if (context.email.hasOwnProperty("groupId")) {
+                // If the email objects groupId property is the same as the current groupId in context...
+                // (This function is part of a flow that could work for N groupIds)
+                if (context.email.groupId === context.groupId) {
+                    // Then we auto add and send email
+                    fnToCall = processAutoAddUsers;
+                    shouldEmail = true;
+                } // ELSE if the groupId's do NOT match, we will fall back
+                // To autoAdd or invite as per line 32.
+                // We are doing the above logic (lines 43 - 47) because
+                // We wish to add users to core groups, followers, and content groups
+                // but only to email the core group.
+            }
+            else {
+                // If it does not have a groupId at all then we will autoAdd and email.
+                fnToCall = processAutoAddUsers;
+                shouldEmail = true;
+            }
+        }
+    }
+    // Return/call the function
+    return fnToCall(context, "community", shouldEmail);
+}
+/**
+ * @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 async function addOrInviteOrgUsers(context) {
+    // If there are no org users return handling no users
+    if (!context.org || context.org.length === 0) {
+        // we return an empty object 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.
+        return handleNoUsers();
+    }
+    // for org user if you have assignUsers then auto add the user
+    // if not then invite the user
+    return context.canAutoAddUser
+        ? processAutoAddUsers(context, "org")
+        : processInviteUsers(context, "org");
+}
+/**
+ * @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 async function addOrInvitePartneredUsers(context) {
+    // If there are no org users return handling no users
+    if (!context.partnered || context.partnered.length === 0) {
+        // we return an empty object 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.
+        return handleNoUsers();
+    }
+    // process invite
+    return processInviteUsers(context, "partnered");
+}
+/**
+ * @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 async function addOrInviteWorldUsers(context) {
+    // If there are no world users return handling no users
+    if (!context.world || context.world.length === 0) {
+        // we return an empty object 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.
+        return handleNoUsers();
+    }
+    // process invite
+    return processInviteUsers(context, "world");
+}
+// Add or invite flow based on the type of user ends here
+/**
+ * @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 async function handleNoUsers(context, userType, shouldEmail) {
+    return {
+        notAdded: [],
+        notEmailed: [],
+        notInvited: [],
+        users: [],
+        errors: [],
+    };
+}
+/**
+ * @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 function groupUsersByOrgRelationship(users) {
+    return users.reduce((acc, user) => {
+        // keyof needed to make bracket notation work without TS throwing a wobbly.
+        const orgType = user.orgType;
+        acc[orgType].push(user);
+        return acc;
+    }, {
+        world: [],
+        org: [],
+        community: [],
+        partnered: [],
+        collaborationCoordinator: [],
+    });
+}
+//# sourceMappingURL=AddOrInviteUsersToGroupUtils.js.map

package/dist/esm/groups/_internal/AddOrInviteUsersToGroupUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOrInviteUsersToGroupUtils.js","sourceRoot":"","sources":["../../../../src/groups/_internal/AddOrInviteUsersToGroupUtils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,2DAA2D;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oCAAoC,CACxD,OAA4B;IAE5B,qDAAqD;IACrD,IACE,CAAC,OAAO,CAAC,wBAAwB;QACjC,OAAO,CAAC,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAC7C;QACA,oCAAoC;QACpC,oCAAoC;QACpC,8EAA8E;QAC9E,oEAAoE;QACpE,OAAO,aAAa,EAAE,CAAC;KACxB;IACD,OAAO,mBAAmB,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAA4B;IAE5B,8BAA8B;IAC9B,oCAAoC;IACpC,oCAAoC;IACpC,8EAA8E;IAC9E,oEAAoE;IACpE,IAAI,QAAQ,GAAG,aAAa,CAAC;IAC7B,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,uCAAuC;IACvC,IAAI,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QACrD,+DAA+D;QAC/D,QAAQ,GAAG,OAAO,CAAC,cAAc;YAC/B,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,kBAAkB,CAAC;QACvB,6BAA6B;QAC7B,2BAA2B;QAC3B,mDAAmD;QACnD,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,kDAAkD;YAClD,IAAI,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;gBAC3C,yFAAyF;gBACzF,mEAAmE;gBACnE,IAAI,OAAO,CAAC,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE;oBAC7C,kCAAkC;oBAClC,QAAQ,GAAG,mBAAmB,CAAC;oBAC/B,WAAW,GAAG,IAAI,CAAC;iBACpB,CAAC,wDAAwD;gBAC1D,uCAAuC;gBACvC,uDAAuD;gBACvD,qEAAqE;gBACrE,oCAAoC;aACrC;iBAAM;gBACL,uEAAuE;gBACvE,QAAQ,GAAG,mBAAmB,CAAC;gBAC/B,WAAW,GAAG,IAAI,CAAC;aACpB;SACF;KACF;IACD,2BAA2B;IAC3B,OAAO,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAA4B;IAE5B,qDAAqD;IACrD,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5C,oCAAoC;QACpC,oCAAoC;QACpC,8EAA8E;QAC9E,oEAAoE;QACpE,OAAO,aAAa,EAAE,CAAC;KACxB;IACD,8DAA8D;IAC9D,8BAA8B;IAC9B,OAAO,OAAO,CAAC,cAAc;QAC3B,CAAC,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC;QACrC,CAAC,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAA4B;IAE5B,qDAAqD;IACrD,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QACxD,oCAAoC;QACpC,oCAAoC;QACpC,8EAA8E;QAC9E,oEAAoE;QACpE,OAAO,aAAa,EAAE,CAAC;KACxB;IACD,iBAAiB;IACjB,OAAO,kBAAkB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAA4B;IAE5B,uDAAuD;IACvD,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QAChD,oCAAoC;QACpC,oCAAoC;QACpC,8EAA8E;QAC9E,oEAAoE;QACpE,OAAO,aAAa,EAAE,CAAC;KACxB;IACD,iBAAiB;IACjB,OAAO,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC9C,CAAC;AAED,yDAAyD;AAEzD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAA6B,EAC7B,QAAsD,EACtD,WAAqB;IAErB,OAAO;QACL,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,EAAE;QACd,UAAU,EAAE,EAAE;QACd,KAAK,EAAE,EAAE;QACT,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACzC,KAAyB;IAEzB,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACZ,2EAA2E;QAC3E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAqC,CAAC;QAC3D,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,EAAE;QACb,wBAAwB,EAAE,EAAE;KAC7B,CACF,CAAC;AACJ,CAAC"}