Merge branch 'development' into feat/oauth-support

aman19K · aman19K · commit 300b90f11ea0 · 2025-03-26T15:08:43.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,11 @@
     - Handle retry the requests that were pending due to token expiration
     - Updated Axios Version
 
+## [v1.19.6](https://github.com/contentstack/contentstack-management-javascript/tree/v1.19.6) (2025-03-24)
+ - Enhancement
+    - Added stack headers in global fields response
+    - Added buffer upload in assets
+
 ## [v1.19.5](https://github.com/contentstack/contentstack-management-javascript/tree/v1.19.5) (2025-03-17)
  - Fix
     - Added AuditLog in the stack class
diff --git a/lib/stack/asset/index.js b/lib/stack/asset/index.js
@@ -291,11 +291,21 @@ export function createFormData (data) {
     if (typeof data.title === 'string') {
       formData.append('asset[title]', data.title)
     }
-    const uploadStream = createReadStream(data.upload)
-    if (typeof data.content_type === 'string') {
-      formData.append('asset[upload]', uploadStream, { contentType: data.content_type })
+    // Handle Buffer Upload
+    if (Buffer.isBuffer(data.upload)) {
+      formData.append('asset[upload]', data.upload, {
+        filename: data.filename || 'uploaded_file',
+        contentType: data.content_type || 'application/octet-stream'
+      })
+    } else if (typeof data.upload === 'string') { // Handle File Path Upload
+      const uploadStream = createReadStream(data.upload)
+      if (typeof data.content_type === 'string') {
+        formData.append('asset[upload]', uploadStream, { contentType: data.content_type })
+      } else {
+        formData.append('asset[upload]', uploadStream)
+      }
     } else {
-      formData.append('asset[upload]', uploadStream)
+      throw new Error('Invalid upload format. Must be a file path or Buffer.')
     }
     return formData
   }
diff --git a/lib/stack/globalField/index.js b/lib/stack/globalField/index.js
@@ -55,8 +55,12 @@ export function GlobalField (http, data = {}) {
         if (this.apiVersion) {
           delete this.stackHeaders.api_version
         }
-        if (response.data) {
-          return response.data
+        const data = response.data
+        if (data) {
+          if (this.stackHeaders) {
+            data.stackHeaders = this.stackHeaders
+          }
+          return data
         } else {
           throw error(response)
         }
@@ -105,8 +109,12 @@ export function GlobalField (http, data = {}) {
           headers: { ...cloneDeep(this.stackHeaders) }
         }
         const response = await http.put(`${this.urlPath}`, config, headers)
-        if (response.data) {
-          return response.data
+        const data = response.data
+        if (data) {
+          if (this.stackHeaders) {
+            data.stackHeaders = this.stackHeaders
+          }
+          return data
         } else {
           throw error(response)
         }
@@ -146,8 +154,12 @@ export function GlobalField (http, data = {}) {
         if (this.apiVersion) {
           delete this.stackHeaders.api_version
         }
-        if (response.data) {
-          return response.data
+        const data = response.data
+        if (data) {
+          if (this.stackHeaders) {
+            data.stackHeaders = this.stackHeaders
+          }
+          return data
         } else {
           throw error(response)
         }
@@ -183,8 +195,12 @@ export function GlobalField (http, data = {}) {
           }
         }
         const response = await http.get(this.urlPath, headers)
-        if (response.data) {
-          return response.data
+        const data = response.data
+        if (data) {
+          if (this.stackHeaders) {
+            data.stackHeaders = this.stackHeaders
+          }
+          return data
         } else {
           throw error(response)
         }
@@ -214,7 +230,7 @@ export function GlobalField (http, data = {}) {
      * client.stack().globalField().create({ global_field })
      * .then((globalField) => console.log(globalField))
      */
-    this.create = async (data) => {
+    this.create = async (payload) => {
       try {
         if (this.apiVersion) {
           this.stackHeaders.api_version = this.apiVersion
@@ -224,11 +240,15 @@ export function GlobalField (http, data = {}) {
             ...cloneDeep(this.stackHeaders)
           }
         }
-        const response = await http.post(`${this.urlPath}`, data, headers)
-        if (response.data) {
-          return response.data
+        const response = await http.post(`${this.urlPath}`, payload, headers)
+        const data = response.data
+        if (data) {
+          if (this.stackHeaders) {
+            data.stackHeaders = this.stackHeaders
+          }
+          return data
         } else {
-          return error(response)
+          throw error(response)
         }
       } catch (err) {
         return error(err)
diff --git a/sanity-report-dev11.js b/sanity-report-dev11.js
@@ -1,74 +1,88 @@
-const dotenv = require('dotenv')
-const fs = require('fs')
+import Slack from "@slack/bolt";
+const { App } = Slack;
+import dotenv from "dotenv";
+import fs from "fs";
 
-dotenv.config()
+dotenv.config();
 
-const user1 = process.env.USER1
-const user2 = process.env.USER2
-const user3 = process.env.USER3
-const user4 = process.env.USER4
+const user1 = process.env.USER1;
+const user2 = process.env.USER2;
+const user3 = process.env.USER3;
+const user4 = process.env.USER4;
 
 const mochawesomeJsonOutput = fs.readFileSync(
-  './mochawesome-report/mochawesome.json',
-  'utf-8'
-)
-const mochawesomeReport = JSON.parse(mochawesomeJsonOutput)
+  "./mochawesome-report/mochawesome.json",
+  "utf-8"
+);
+const mochawesomeReport = JSON.parse(mochawesomeJsonOutput);
 
-const totalTests = mochawesomeReport.stats.tests
-const passedTests = mochawesomeReport.stats.passes
-const failedTests = mochawesomeReport.stats.failures
+const totalTests = mochawesomeReport.stats.tests;
+const passedTests = mochawesomeReport.stats.passes;
+const failedTests = mochawesomeReport.stats.failures;
 
-let durationInSeconds = Math.floor(mochawesomeReport.stats.duration / 1000)
-const durationInMinutes = Math.floor(durationInSeconds / 60)
-durationInSeconds %= 60
+let durationInSeconds = Math.floor(mochawesomeReport.stats.duration / 1000);
+const durationInMinutes = Math.floor(durationInSeconds / 60);
+durationInSeconds %= 60;
 
 const resultMessage =
   passedTests === totalTests
     ? `:white_check_mark: Success (${passedTests} / ${totalTests} Passed)`
-    : `:x: Failure (${passedTests} / ${totalTests} Passed)`
+    : `:x: Failure (${passedTests} / ${totalTests} Passed)`;
 
-const pipelineName = process.env.GO_PIPELINE_NAME
-const pipelineCounter = process.env.GO_PIPELINE_COUNTER
-const goCdServer = process.env.GOCD_SERVER
+const pipelineName = process.env.GO_PIPELINE_NAME;
+const pipelineCounter = process.env.GO_PIPELINE_COUNTER;
+const goCdServer = process.env.GOCD_SERVER;
 
-const reportUrl = `http://${goCdServer}/go/files/${pipelineName}/${pipelineCounter}/sanity/1/sanity/test-results/mochawesome-report/sanity-report.html`
+const reportUrl = `http://${goCdServer}/go/files/${pipelineName}/${pipelineCounter}/sanity/1/sanity/test-results/mochawesome-report/sanity-report.html`;
 
-let tagUsers = ``
-if (failedTests > 0) {
-  tagUsers = `<@${user1}> <@${user2}> <@${user3}> <@${user4}>`
-}
+let tagUsers =
+  failedTests > 0 ? `<@${user1}> <@${user2}> <@${user3}> <@${user4}>` : "";
 
 const slackMessage = {
-  text: `Dev11, SDK-CMA Sanity
-*Result:* ${resultMessage}. ${durationInMinutes}m ${durationInSeconds}s
-*Failed Tests:* ${failedTests}
-<${reportUrl}|View Report>
-${tagUsers}`
-}
+  text: `Dev11, SDK-CMA Sanity\n*Result:* ${resultMessage}. ${durationInMinutes}m ${durationInSeconds}s\n*Failed Tests:* ${failedTests}\n<${reportUrl}|View Report>\n${tagUsers}`,
+};
 
-const slackWebhookUrl = process.env.SLACK_WEBHOOK_URL
+const app = new App({
+  token: process.env.SLACK_BOT_TOKEN,
+  signingSecret: process.env.SLACK_SIGNING_SECRET,
+});
 
 const sendSlackMessage = async (message) => {
-  const payload = {
-    text: message
-  }
-
   try {
-    const response = await fetch(slackWebhookUrl, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(payload)
-    })
-
-    if (!response.ok) {
-      throw new Error(`Error sending message to Slack: ${response.statusText}`)
+    const result = await app.client.chat.postMessage({
+      token: process.env.SLACK_BOT_TOKEN,
+      channel: process.env.SLACK_CHANNEL2,
+      text: message,
+    });
+
+    if (failedTests > 0) {
+      await sendFailureDetails(result.ts); 
     }
+  } catch (error) {
+    console.error("Error sending Slack message:", error);
+  }
+};
 
-    console.log('Message sent to Slack successfully')
+const sendFailureDetails = async (threadTs) => {
+  const failedSuites = mochawesomeReport.results
+    .flatMap((result) => result.suites)
+    .filter((suite) => suite.failures.length > 0);
+
+  let failureDetails = "*Failed Test Modules:*\n";
+  for (const suite of failedSuites) {
+    failureDetails += `- *${suite.title}*: ${suite.failures.length} failed\n`;
+  }
+
+  try {
+    await app.client.chat.postMessage({
+      token: process.env.SLACK_BOT_TOKEN,
+      channel: process.env.SLACK_CHANNEL,
+      text: failureDetails,
+      thread_ts: threadTs,
+    });
   } catch (error) {
-    console.error('Error:', error)
+    console.error("Error sending failure details:", error);
   }
-}
-sendSlackMessage(slackMessage.text)
+};
+
+sendSlackMessage(slackMessage.text);
diff --git a/test/sanity-check/api/asset-test.js b/test/sanity-check/api/asset-test.js
@@ -1,3 +1,4 @@
+import fs from 'fs'
 import path from 'path'
 import { expect } from 'chai'
 import { describe, it, setup } from 'mocha'
@@ -39,6 +40,31 @@ describe('Assets api Test', () => {
       .catch(done)
   })
 
+  it('should upload asset from buffer', (done) => {
+    const filePath = path.join(__dirname, '../mock/customUpload.html')
+    const fileBuffer = fs.readFileSync(filePath) // Read file into Buffer
+    const asset = {
+      upload: fileBuffer, // Buffer upload
+      filename: 'customUpload.html', // Ensure filename is provided
+      content_type: 'text/html', // Set content type
+      title: 'buffer-asset',
+      description: 'Buffer Asset Desc',
+      tags: ['Buffer']
+    }
+    makeAsset().create(asset)
+      .then((asset) => {
+        jsonWrite(asset, 'bufferAsset.json')
+        expect(asset.uid).to.be.not.equal(null)
+        expect(asset.url).to.be.not.equal(null)
+        expect(asset.filename).to.be.equal('customUpload.html')
+        expect(asset.title).to.be.equal('buffer-asset')
+        expect(asset.description).to.be.equal('Buffer Asset Desc')
+        expect(asset.content_type).to.be.equal('text/html')
+        done()
+      })
+      .catch(done)
+  })
+
   it('should download asset from URL.', done => {
     makeAsset().download({ url: assetURL, responseType: 'stream' })
       .then((response) => {
diff --git a/test/unit/asset-test.js b/test/unit/asset-test.js
@@ -1,3 +1,4 @@
+import fs from 'fs'
 import path from 'path'
 import Axios from 'axios'
 import { expect } from 'chai'
@@ -171,6 +172,49 @@ describe('Contentstack Asset test', () => {
       .catch(done)
   })
 
+  it('should upload asset from buffer', (done) => {
+    const mock = new MockAdapter(Axios)
+    mock.onPost('/assets').reply(200, {
+      asset: {
+        uid: 'mock-uid',
+        url: '/assets',
+        filename: 'customUpload.html',
+        title: 'buffer-asset',
+        description: 'Buffer Asset Desc',
+        content_type: 'text/html',
+        tags: ['Buffer'],
+        parent_uid: 'UID'
+      }
+    })
+    const filePath = path.join(__dirname, '../api/mock/customUpload.html')
+    const fileBuffer = fs.readFileSync(filePath)
+    const assetUpload = {
+      upload: fileBuffer, // Buffer upload
+      filename: 'customUpload.html', // Filename to identify the file
+      content_type: 'text/html', // MIME type
+      title: 'buffer-asset',
+      description: 'Buffer Asset Desc',
+      tags: ['Buffer'],
+      parent_uid: 'UID'
+    }
+    const form = createFormData(assetUpload)() // Create FormData for Buffer upload
+    const boundary = form.getBoundary()
+    expect(boundary).to.be.equal(form.getBoundary())
+    expect(boundary.length).to.be.greaterThan(30)
+    makeAsset()
+      .create(assetUpload)
+      .then((asset) => {
+        expect(asset.uid).to.be.equal('mock-uid')
+        expect(asset.filename).to.be.equal('customUpload.html')
+        expect(asset.title).to.be.equal('buffer-asset')
+        expect(asset.description).to.be.equal('Buffer Asset Desc')
+        expect(asset.content_type).to.be.equal('text/html')
+        expect(asset.tags).to.include('Buffer')
+        done()
+      })
+      .catch(done)
+  })
+
   it('Asset replace test', done => {
     var mock = new MockAdapter(Axios)
     mock.onPut('/assets/UID').reply(200, {
diff --git a/types/stack/globalField/index.d.ts b/types/stack/globalField/index.d.ts
@@ -8,7 +8,6 @@ export interface GlobalField extends SystemFields, SystemFunction<GlobalField> {
 
 export interface GlobalFields extends Queryable<GlobalField, {global_field: GlobalFieldData}> {
     import(data: {global_field: string}, params?: any): Promise<GlobalField>
-    (globalFieldUidOrOptions: string | { api_version?: string }, options?: { api_version?: string }): GlobalField;
 }
 
 export interface GlobalFieldData extends AnyProperty {
diff --git a/types/stack/index.d.ts b/types/stack/index.d.ts
@@ -61,10 +61,12 @@ export interface Stack extends SystemFields {
     contentType(): ContentTypes
     contentType(uid: string): ContentType
 
-    globalField(): GlobalFields
-    globalField({}): GlobalFields
-    globalField(uid: string): GlobalField
-    globalField(uid: string, option: object): GlobalField
+    globalField(): GlobalFields;
+    globalField(uid: string, option?: object): GlobalField;
+    globalField(options: { api_version: string }): GlobalFields;
+    globalField(uidOrOptions?: string | { api_version: string }, option?: object): GlobalFields | GlobalField;
+
+    
 
     asset(): Assets
     asset(uid: string): Asset

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,6 @@ export interface GlobalField extends SystemFields, SystemFunction<GlobalField> {`
`8`	`8`
`9`	`9`	`export interface GlobalFields extends Queryable<GlobalField, {global_field: GlobalFieldData}> {`
`10`	`10`	`import(data: {global_field: string}, params?: any): Promise<GlobalField>`
`11`		`- (globalFieldUidOrOptions: string \| { api_version?: string }, options?: { api_version?: string }): GlobalField;`
`12`	`11`	`}`
`13`	`12`
`14`	`13`	`export interface GlobalFieldData extends AnyProperty {`