Merge pull request #137 from contentstack/fix/cs-44541-stack-delete-function

Fix/cs 44541 stack delete function

Author: harshithad0703

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.15.5](https://github.com/contentstack/contentstack-management-javascript/tree/v1.15.4) (2024-04-02)
+ - Enhancement
+   - delete stack implemetation and test cases
+
 ## [v1.15.4](https://github.com/contentstack/contentstack-management-javascript/tree/v1.15.4) (2024-03-26)
  - Fixes
    - sanity test and dependency upgrades

lib/stack/index.js

@@ -2,7 +2,7 @@ import cloneDeep from 'lodash/cloneDeep'
 import error from '../core/contentstackError'
 import { UserCollection } from '../user/index'
 import { Role } from './roles/index'
-import { create, query, update, fetch } from '../entity'
+import { create, query, update, fetch, deleteEntity } from '../entity'
 import { ContentType } from './contentType/index'
 import { GlobalField } from './globalField/index'
 import { DeliveryToken } from './deliveryToken/index'
@@ -259,7 +259,7 @@ export function Stack (http, data) {
     }
 
     /**
-     * @description Management Tokens are tokens that provide you with read-write access to the content of your stack. 
+     * @description Management Tokens are tokens that provide you with read-write access to the content of your stack.
      * @param {String} managementTokenUid The UID of the Management Token field you want to get details.
      * @returns {ManagementToken} Instance of ManagementToken.
      * @example
@@ -730,6 +730,21 @@ export function Stack (http, data) {
       }
       return new Taxonomy(http, data)
     }
+
+    /**
+     * @description The delete stack call lets you delete the stack.
+     * @memberof Stack
+     * @func delete
+     * @returns {Promise<Stack.Stack>} Promise for Stack instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).delete()
+     * .then((stack) => console.log(stack))
+     *
+     */
+    this.delete = deleteEntity(http)
   } else {
     /**
      * @description The Create stack call creates a new stack in your Contentstack account.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.15.4",
+  "version": "1.15.5",
   "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",

package.json

@@ -59,6 +59,7 @@ describe('Assets api Test', () => {
     makeAsset().folder().create({ asset: { name: 'Sample Folder' } })
       .then((asset) => {
         folderUID = asset.uid
+        jsonWrite(asset, 'folder.json')
         expect(asset.uid).to.be.not.equal(null)
         expect(asset.name).to.be.equal('Sample Folder')
         expect(asset.is_dir).to.be.equal(true)

test/sanity-check/api/asset-test.js

@@ -123,6 +123,25 @@ describe('Branch Alias delete api Test', () => {
   })
 })
 
+describe('Delete Asset Folder api Test', () => {
+  let folderUid = ''
+  setup(() => {
+    const user = jsonReader('loggedinuser.json')
+    const folder = jsonReader('folder.json')
+    folderUid = folder.uid
+    client = contentstackClient(user.authtoken)
+  })
+  it('should delete an environment', done => {
+    makeAssetFolder(folderUid)
+      .delete()
+      .then((data) => {
+        expect(data.notice).to.be.equal('Folder deleted successfully.')
+        done()
+      })
+      .catch(done)
+  })
+})
+
 function makeEnvironment (uid = null) {
   return client.stack({ api_key: process.env.API_KEY }).environment(uid)
 }
@@ -138,3 +157,7 @@ function makeDeliveryToken (uid = null) {
 function makeBranchAlias (uid = null) {
   return client.stack({ api_key: process.env.API_KEY }).branchAlias(uid)
 }
+
+function makeAssetFolder (uid = null) {
+  return client.stack({ api_key: process.env.API_KEY }).asset().folder(uid)
+}

test/sanity-check/api/delete-test.js

@@ -157,6 +157,16 @@ describe('Stack api Test', () => {
       })
       .catch(done)
   })
+
+  it('should delete stack', done => {
+    client.stack({ api_key: stacks.api_key })
+      .delete()
+      .then((stack) => {
+        expect(stack.notice).to.be.equal('Stack deleted successfully!')
+        done()
+      })
+      .catch(done)
+  })
 })
 
 describe('Branch creation api Test', () => {