Merge pull request #424 from contentstack/staging

DX | 18-08-2025 | Release

Author: harshithad0703

.talismanrc

@@ -9,7 +9,7 @@ fileignoreconfig:
     ignore_detectors:
       - filecontent
   - filename: package-lock.json
-    checksum: b043facad4b4aca7a013730746bdb9cb9e9dfca1e5d6faf11c068fc2525569c0
+    checksum: c37956b0e6ccd5267dac7fd6f4347fbb5ad41defe1c42d39aaaeaf64d2cf8605
   - filename: .husky/pre-commit
     checksum: 52a664f536cf5d1be0bea19cb6031ca6e8107b45b6314fe7d47b7fad7d800632
   - filename: test/sanity-check/api/user-test.js
@@ -26,4 +26,8 @@ fileignoreconfig:
     checksum: e8a32ffbbbdba2a15f3d327273f0a5b4eb33cf84cd346562596ab697125bbbc6
   - filename: test/sanity-check/api/bulkOperation-test.js
     checksum: f40a14c84ab9a194aaf830ca68e14afde2ef83496a07d4a6393d7e0bed15fb0e
+  - filename: lib/contentstackClient.js
+    checksum: b76ca091caa3a1b2658cd422a2d8ef3ac9996aea0aff3f982d56bb309a3d9fde
+  - filename: test/unit/ContentstackClient-test.js
+    checksum: 974a4f335aef025b657d139bb290233a69bed1976b947c3c674e97baffe4ce2f
 version: "1.0"

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## [v1.23.1](https://github.com/contentstack/contentstack-management-javascript/tree/v1.24.0) (2025-07-28)
+## [v1.24.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.24.0) (2025-08-18)
+ - Feat
+   - Added Support for MFA
+
+## [v1.23.1](https://github.com/contentstack/contentstack-management-javascript/tree/v1.23.1) (2025-07-28)
  - Fix
    - Add asset types support in bulk operations
 

README.md

@@ -19,12 +19,31 @@ Install it via npm:
 ```bash
 npm i @contentstack/management
 ```
-To import the SDK, use the following command:
-```javascript
-import contentstack from ‘@contentstack/management’
-
-contentstackClient = contentstack.client()
-```
+To import the SDK, use one of the following ways :
+1. **JavaScript ES Modules** 
+   ```javascript
+	import contentstack from '@contentstack/management';
+	 ```
+   - Requires `"type": "module"` in package.json
+
+2. **TypeScript with esModuleInterop**   
+   ```typescript
+	import contentstack from '@contentstack/management';
+	 ```
+   - Requires `"esModuleInterop": true` in tsconfig.json
+
+3. **TypeScript Namespace Import** 
+   ```typescript
+	import * as contentstack from '@contentstack/management';
+	 ``` 
+   - Works regardless of esModuleInterop setting
+
+4. **TypeScript Destructuring** 
+   ```typescript
+	import contentstack from '@contentstack/management';
+	const { client } = contentstack;
+	 ```
+   - Access client function from default export
 
 ### Authentication
 To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).

lib/contentstackClient.js

@@ -7,6 +7,7 @@ import cloneDeep from 'lodash/cloneDeep'
 import { User } from './user/index'
 import error from './core/contentstackError'
 import OAuthHandler from './core/oauthHandler'
+import { authenticator } from 'otplib'
 
 export default function contentstackClient ({ http }) {
   /**
@@ -16,7 +17,8 @@ export default function contentstackClient ({ http }) {
    * @param {Object} parameters - login parameters
    * @prop {string} parameters.email - email id for user to login
    * @prop {string} parameters.password - password for user to login
-   * @prop {string} parameters.token - token for user to login
+   * @prop {string} parameters.tfa_token - tfa token for user to login (2FA token)
+   * @prop {string} parameters.mfaSecret - TOTP secret key for generating 2FA token
    * @returns {Promise}
    * @example
    * import * as contentstack from '@contentstack/management'
@@ -25,10 +27,23 @@ export default function contentstackClient ({ http }) {
    * client.login({ email: <emailid>, password: <password> })
    * .then(() => console.log('Logged in successfully'))
    *
+   * @example
+   * client.login({ email: <emailid>, password: <password>, tfa_token: <tfa_token> })
+   * .then(() => console.log('Logged in successfully'))
+   *
+   * @example
+   * client.login({ email: <emailid>, password: <password>, mfaSecret: <mfa_secret> })
+   * .then(() => console.log('Logged in successfully'))
    */
-  function login (requestBody, params = {}) {
+  function login (requestBody = {}, params = {}) {
     http.defaults.versioningStrategy = 'path'
 
+    const { mfaSecret, ...credentials } = requestBody
+    requestBody = credentials
+
+    if (!requestBody.tfa_token && mfaSecret) {
+      requestBody.tfa_token = authenticator.generate(mfaSecret)
+    }
     return http.post('/user-session', { user: requestBody }, { params: params })
       .then((response) => {
         if (response.data.user != null && response.data.user.authtoken != null) {
@@ -55,10 +70,9 @@ export default function contentstackClient ({ http }) {
    */
   function getUser (params = {}) {
     http.defaults.versioningStrategy = 'path'
-    return http.get('/user', { params: params })
-      .then((response) => {
-        return new User(http, response.data)
-      }, error)
+    return http.get('/user', { params: params }).then((response) => {
+      return new User(http, response.data)
+    }, error)
   }
   /**
    * @description Get Stack instance. A stack is a space that stores the content of a project.
@@ -127,13 +141,16 @@ export default function contentstackClient ({ http }) {
    */
   function organization (uid = null) {
     http.defaults.versioningStrategy = 'path'
-    return new Organization(http, uid !== null ? { organization: { uid: uid } } : null)
+    return new Organization(
+      http,
+      uid !== null ? { organization: { uid: uid } } : null
+    )
   }
 
   /**
    * @description The Log out of your account call is used to sign out the user of Contentstack account.
    * @memberof ContentstackClient
-    * @param {String} authtoken - Authtoken to logout from.
+   * @param {String} authtoken - Authtoken to logout from.
    * @func logout
    * @returns {Object} Response object.
    *
@@ -152,25 +169,25 @@ export default function contentstackClient ({ http }) {
   function logout (authtoken) {
     http.defaults.versioningStrategy = 'path'
     if (authtoken !== undefined) {
-      return http.delete('/user-session', {
-        headers: {
-          authtoken: authtoken
-        }
-      })
+      return http
+        .delete('/user-session', {
+          headers: {
+            authtoken: authtoken
+          }
+        })
         .then((response) => {
           return response.data
         }, error)
     }
-    return http.delete('/user-session')
-      .then((response) => {
-        if (http.defaults.headers.common) {
-          delete http.defaults.headers.common.authtoken
-        }
-        delete http.defaults.headers.authtoken
-        delete http.httpClientParams.authtoken
-        delete http.httpClientParams.headers.authtoken
-        return response.data
-      }, error)
+    return http.delete('/user-session').then((response) => {
+      if (http.defaults.headers.common) {
+        delete http.defaults.headers.common.authtoken
+      }
+      delete http.defaults.headers.authtoken
+      delete http.httpClientParams.authtoken
+      delete http.httpClientParams.headers.authtoken
+      return response.data
+    }, error)
   }
 
   /**
@@ -201,7 +218,15 @@ export default function contentstackClient ({ http }) {
     const responseType = params.responseType || 'code'
     const scope = params.scope
     const clientSecret = params.clientSecret
-    return new OAuthHandler(http, appId, clientId, redirectUri, clientSecret, responseType, scope)
+    return new OAuthHandler(
+      http,
+      appId,
+      clientId,
+      redirectUri,
+      clientSecret,
+      responseType,
+      scope
+    )
   }
 
   return {

lib/core/contentstackError.js

@@ -34,6 +34,7 @@ export default function error (errorResponse) {
     errorDetails.errorCode = data.error_code || 0
     errorDetails.errors = data.errors || {}
     errorDetails.error = data.error || ''
+    errorDetails.tfa_type = data.tfa_type
   }
 
   var error = new Error()

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.23.2",
+  "version": "1.24.0",
   "description": "The Content Management API is used to manage the content of your Contentstack account",
   "main": "./dist/node/contentstack-management.js",
   "browser": "./dist/web/contentstack-management.js",
@@ -58,6 +58,7 @@
     "form-data": "^4.0.4",
     "husky": "^9.1.7",
     "lodash": "^4.17.21",
+    "otplib": "^12.0.1",
     "qs": "^6.14.0",
     "stream-browserify": "^3.0.0"
   },

package.json

@@ -4,7 +4,6 @@ const fs = require("fs");
 
 dotenv.config();
 
-const user1 = process.env.USER1;
 const user2 = process.env.USER2;
 const user3 = process.env.USER3;
 const user4 = process.env.USER4;
@@ -35,7 +34,7 @@ const goCdServer = process.env.GOCD_SERVER;
 const reportUrl = `http://${goCdServer}/go/files/${pipelineName}/${pipelineCounter}/sanity/1/sanity/test-results/mochawesome-report/sanity-report.html`;
 
 let tagUsers =
-  failedTests > 0 ? `<@${user1}> <@${user2}> <@${user3}> <@${user4}>` : "";
+  failedTests > 0 ? `<@${user2}> <@${user3}> <@${user4}>` : "";
 
 const slackMessage = {
   text: `Dev11, SDK-JS-CMA Sanity\n*Result:* ${resultMessage}. ${durationInMinutes}m ${durationInSeconds}s\n*Failed Tests:* ${failedTests}\n<${reportUrl}|View Report>\n${tagUsers}`,