Create batch users (#553) RELEASE

* feat: users create batch

* commit file

* proofread

Author: asafshen

README.md

@@ -717,6 +717,7 @@ await descopeClient.management.user.invite('[email protected]', {
 // Make sure to configure the invite URL in the Descope console prior to using this function,
 // and that an email address / phone number is provided in the information. You can also set
 // a cleartext password or import a prehashed one from another service.
+// Note: This function will send an invitation to each user in the `users` array. If you want to create users without sending invitations, use `createBatch` instead.
 await descopeClient.management.user.inviteBatch(
   [
     {
@@ -737,6 +738,25 @@ await descopeClient.management.user.inviteBatch(
   false,
 );
 
+// Create a batch of users.
+// This is useful when you want to create users programmatically without triggering the invitation flow.
+// You can set a cleartext password or import a prehashed one from another service.
+// Note: This function will NOT send an invitation to the created users. If invitations are required use `inviteBatch` instead.
+await descopeClient.management.user.createBatch([
+  {
+    loginId: '[email protected]',
+    email: '[email protected]',
+    phone: '+123456789123',
+    displayName: 'Desmond Copeland',
+    userTenants: [{ tenantId: 'tenant-ID1', roleNames: ['role-name1'] }],
+    hashedPassword: {
+      bcrypt: {
+        hash: '$2a$...',
+      },
+    },
+  },
+]);
+
 // Update will override all fields as is. Use carefully.
 await descopeClient.management.user.update('[email protected]', {
   email: '[email protected]',

lib/constants.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/prefer-default-export
 /** Refresh JWT cookie name */
 export const refreshTokenCookieName = 'DSR';
 /** Session JWT cookie name */

lib/errors.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/prefer-default-export
 /** Common Error Codes */
 export default {
   badRequest: 'E011001',

lib/helpers.ts

@@ -25,7 +25,6 @@ export const getCookieValue = (cookie: string | null | undefined, name: string)
   return match ? match[1] : null;
 };
 
-// eslint-disable-next-line import/prefer-default-export
 /**
  * Add cookie generation to core-js functions.
  * @param fn the function we are wrapping

lib/management/helpers.ts

@@ -0,0 +1,12 @@
+/* eslint-disable import/prefer-default-export */
+import { User } from './types';
+
+/**
+ * Transforms user objects by converting roles to roleNames
+ */
+export function transformUsersForBatch(users: User[]): any[] {
+  return users.map(({ roles, ...user }) => ({
+    ...user,
+    roleNames: roles,
+  }));
+}

lib/management/types.ts

@@ -549,7 +549,7 @@ export type UserFailedResponse = {
   user: UserResponse;
 };
 
-export type InviteBatchResponse = {
+export type CreateOrInviteBatchResponse = {
   createdUsers: UserResponse[];
   failedUsers: UserFailedResponse[];
   additionalErrors: Record<string, string>;

lib/management/user.test.ts

@@ -8,7 +8,7 @@ import {
   GenerateEnchantedLinkForTestResponse,
   ProviderTokenResponse,
   GenerateEmbeddedLinkResponse,
-  InviteBatchResponse,
+  CreateOrInviteBatchResponse,
   UserPasswordHashed,
 } from './types';
 
@@ -385,7 +385,7 @@ describe('Management User', () => {
         },
       };
 
-      const resp: SdkResponse<InviteBatchResponse> = await management.user.inviteBatch(
+      const resp: SdkResponse<CreateOrInviteBatchResponse> = await management.user.inviteBatch(
         [
           { loginId: 'one', roles: ['r1'], email: 'one@one', password: 'clear', seed: 'aaa' },
           { loginId: 'two', roles: ['r1'], email: 'two@two', hashedPassword: hashed },
@@ -437,6 +437,74 @@ describe('Management User', () => {
     });
   });
 
+  describe('create batch', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => mockMgmtInviteBatchResponse,
+        clone: () => ({
+          json: () => Promise.resolve(mockMgmtInviteBatchResponse),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const hashed: UserPasswordHashed = {
+        firebase: {
+          hash: 'h',
+          salt: 's',
+          saltSeparator: 'ss',
+          signerKey: 'sk',
+          memory: 14,
+          rounds: 8,
+        },
+      };
+
+      const resp: SdkResponse<CreateOrInviteBatchResponse> = await management.user.createBatch([
+        { loginId: 'one', roles: ['r1'], email: 'one@one', password: 'clear', seed: 'aaa' },
+        { loginId: 'two', roles: ['r1'], email: 'two@two', hashedPassword: hashed },
+      ]);
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.user.createBatch,
+        {
+          users: [
+            {
+              loginId: 'one',
+              roleNames: ['r1'],
+              email: 'one@one',
+              password: 'clear',
+              seed: 'aaa',
+            },
+            {
+              loginId: 'two',
+              roleNames: ['r1'],
+              email: 'two@two',
+              hashedPassword: {
+                firebase: {
+                  hash: 'h',
+                  salt: 's',
+                  saltSeparator: 'ss',
+                  signerKey: 'sk',
+                  memory: 14,
+                  rounds: 8,
+                },
+              },
+            },
+          ],
+        },
+        { token: 'key' },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        data: mockMgmtInviteBatchResponse,
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+
   describe('update', () => {
     it('should send the correct request and receive correct response with multiple arguments', async () => {
       const httpResponse = {

lib/management/user.ts

@@ -15,13 +15,14 @@ import {
   AttributesTypes,
   UserStatus,
   User,
-  InviteBatchResponse,
+  CreateOrInviteBatchResponse,
   TemplateOptions,
   ProviderTokenOptions,
   UserOptions,
 } from './types';
 import { CoreSdk, DeliveryMethodForTestUser } from '../types';
 import apiPaths from './paths';
+import { transformUsersForBatch } from './helpers';
 
 type SearchSort = {
   field: string;
@@ -443,19 +444,12 @@ const withUser = (sdk: CoreSdk, managementKey?: string) => {
       sendSMS?: boolean, // send invite via text message, default is according to project settings
       templateOptions?: TemplateOptions,
       templateId?: string,
-    ): Promise<SdkResponse<InviteBatchResponse>> =>
-      transformResponse<InviteBatchResponse, InviteBatchResponse>(
+    ): Promise<SdkResponse<CreateOrInviteBatchResponse>> =>
+      transformResponse<CreateOrInviteBatchResponse, CreateOrInviteBatchResponse>(
         sdk.httpClient.post(
           apiPaths.user.createBatch,
           {
-            users: users.map((u) => {
-              const res = {
-                ...u,
-                roleNames: u.roles,
-              };
-              delete res.roles;
-              return res;
-            }),
+            users: transformUsersForBatch(users),
             invite: true,
             inviteUrl,
             sendMail,
@@ -467,6 +461,17 @@ const withUser = (sdk: CoreSdk, managementKey?: string) => {
         ),
         (data) => data,
       ),
+    createBatch: (users: User[]): Promise<SdkResponse<CreateOrInviteBatchResponse>> =>
+      transformResponse<CreateOrInviteBatchResponse, CreateOrInviteBatchResponse>(
+        sdk.httpClient.post(
+          apiPaths.user.createBatch,
+          {
+            users: transformUsersForBatch(users),
+          },
+          { token: managementKey },
+        ),
+        (data) => data,
+      ),
     update,
     patch,
     /**