Merge pull request #265 from contentstack/feat/dx-1889-api-version-variants

feat | dx 1889 api version variants

Author: harshithad0703

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
-## [v1.19.2](https://github.com/contentstack/contentstack-management-javascript/tree/v1.19.2) (2025-01-27)
+## [v1.19.2](https://github.com/contentstack/contentstack-management-javascript/tree/v1.19.2) (2025-02-11)
  - Enhancement
     - Added support for nested global fields.
+    - Added api_version support for variants
 
 ## [v1.19.1](https://github.com/contentstack/contentstack-management-javascript/tree/v1.19.1) (2025-01-27)
  - Feature

lib/stack/contentType/entry/index.js

@@ -25,6 +25,10 @@ export function Entry (http, data) {
   this.urlPath = `/content_types/${this.content_type_uid}/entries`
 
   if (data && data.entry) {
+    this.apiVersion = data.api_version || undefined;
+    if (this.apiVersion && !this.stackHeaders.api_version) {
+      this.stackHeaders.api_version = this.apiVersion;
+    }
     Object.assign(this, cloneDeep(data.entry))
     this.urlPath = `/content_types/${this.content_type_uid}/entries/${this.uid}`
 

lib/stack/contentType/index.js

@@ -147,12 +147,16 @@ export function ContentType (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).contentType('content_type_uid').entry('entry_uid').fetch()
      * .then((contentType) => console.log(contentType))
      */
-    this.entry = (uid = null) => {
+    this.entry = (uid = null, options = {}) => {
       const data = { stackHeaders: this.stackHeaders }
       data.content_type_uid = this.uid
       if (uid) {
         data.entry = { uid: uid }
       }
+      options = options || {}; // Ensure `options` is always an object
+      if (options && typeof options === 'object' && options.api_version) {
+        data.api_version = options.api_version;
+      }
       return new Entry(http, data)
     }
 

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

@@ -3,27 +3,29 @@ import { describe, it, setup } from "mocha";
 import { jsonReader } from "../utility/fileOperations/readwrite";
 import { createVariantGroup } from "../mock/variantGroup.js";
 import { variant } from "../mock/variants.js";
-import { variantEntryFirst } from "../mock/variantEntry.js";
+import {
+  variantEntryFirst,
+  publishVariantEntryFirst,
+  unpublishVariantEntryFirst,
+} from "../mock/variantEntry.js";
 import { contentstackClient } from "../utility/ContentstackClient.js";
 
 var client = {};
 
 var stack = {};
 var variantUid = "";
-var variantName = "";
 var variantGroupUid = "";
 var contentTypeUid = "";
 var entryUid = "";
 
-const entry = jsonReader("entry.json");
-entryUid = entry[2].uid;
-contentTypeUid = entry[2].content_type_uid;
-
 describe("Entry Variants api Test", () => {
   setup(() => {
     const user = jsonReader("loggedinuser.json");
     stack = jsonReader("stack.json");
     client = contentstackClient(user.authtoken);
+    const entry = jsonReader("entry.json");
+    entryUid = entry[2].uid;
+    contentTypeUid = entry[2].content_type_uid;
   });
 
   it("should create a Variant Group", (done) => {
@@ -76,24 +78,8 @@ describe("Entry Variants api Test", () => {
   });
 
   it("should publish entry variant", (done) => {
-    var publishVariantEntryFirst = {
-      entry: {
-        environments: ["development"],
-        locales: ["en-us", "en-at"],
-        variants: [
-          {
-            uid: variantUid,
-            version: 1,
-          },
-        ],
-        variant_rules: {
-          publish_latest_base: false,
-          publish_latest_base_conditionally: true,
-        },
-      },
-      locale: "en-us",
-      version: 1,
-    };
+    publishVariantEntryFirst.entry.variants[0].uid = variantUid;
+
     makeEntry()
       .entry(entryUid)
       .publish({
@@ -111,24 +97,7 @@ describe("Entry Variants api Test", () => {
   });
 
   it("should unpublish entry variant", (done) => {
-    var publishVariantEntryFirst = {
-      entry: {
-        environments: ["development"],
-        locales: ["en-at"],
-        variants: [
-          {
-            uid: variantUid,
-            version: 1,
-          },
-        ],
-        variant_rules: {
-          publish_latest_base: false,
-          publish_latest_base_conditionally: true,
-        },
-      },
-      locale: "en-us",
-      version: 1,
-    };
+    unpublishVariantEntryFirst.entry.variants[0].uid = variantUid;
     makeEntry()
       .entry(entryUid)
       .unpublish({
@@ -145,6 +114,41 @@ describe("Entry Variants api Test", () => {
       .catch(done);
   });
 
+  it("should publish entry variant using api_version", (done) => {
+    publishVariantEntryFirst.entry.variants[0].uid = variantUid;
+    makeEntry()
+      .entry(entryUid, { api_version: "3.2" })
+      .publish({
+        publishDetails: publishVariantEntryFirst.entry,
+        locale: publishVariantEntryFirst.locale,
+      })
+      .then((data) => {
+        expect(data.notice).to.be.equal(
+          "The requested action has been performed."
+        );
+        expect(data.job_id).to.be.not.equal(null);
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should unpublish entry variant using api_version", (done) => {
+    unpublishVariantEntryFirst.entry.variants[0].uid = variantUid;
+    makeEntry()
+      .entry(entryUid, { api_version: "3.2" })
+      .unpublish({
+        publishDetails: unpublishVariantEntryFirst.entry,
+        locale: unpublishVariantEntryFirst.locale,
+      })
+      .then((data) => {
+        expect(data.notice).to.be.equal(
+          "The requested action has been performed."
+        );
+        expect(data.job_id).to.be.not.equal(null);
+        done();
+      })
+      .catch(done);
+  });
   it("should get all entry variants", (done) => {
     makeEntryVariants()
       .query({})

test/sanity-check/mock/variantEntry.js

@@ -6,6 +6,44 @@ const variantEntryFirst = {
       _change_set: ["title", "url"],
     },
   },
-}
+};
 
-export { variantEntryFirst };
+var publishVariantEntryFirst = {
+  entry: {
+    environments: ["development"],
+    locales: ["en-us", "en-at"],
+    variants: [
+      {
+        uid: "",
+        version: 1,
+      },
+    ],
+    variant_rules: {
+      publish_latest_base: false,
+      publish_latest_base_conditionally: true,
+    },
+  },
+  locale: "en-us",
+  version: 1,
+};
+
+const unpublishVariantEntryFirst = {
+  entry: {
+    environments: ["development"],
+    locales: ["en-at"],
+    variants: [
+      {
+        uid: "",
+        version: 1,
+      },
+    ],
+    variant_rules: {
+      publish_latest_base: false,
+      publish_latest_base_conditionally: true,
+    },
+  },
+  locale: "en-us",
+  version: 1,
+};
+
+export { variantEntryFirst, publishVariantEntryFirst, unpublishVariantEntryFirst };

test/sanity-check/sanity.js

@@ -15,16 +15,16 @@ require('./api/contentType-test')
 require('./api/asset-test')
 require('./api/extension-test')
 require('./api/entry-test')
+require('./api/variantGroup-test')
+require('./api/variants-test')
+require('./api/ungroupedVariants-test')
+require('./api/entryVariants-test')
 require('./api/bulkOperation-test')
 require('./api/webhook-test')
 require('./api/workflow-test')
 require('./api/globalfield-test')
 require('./api/release-test')
 require('./api/label-test')
-require('./api/variantGroup-test')
-require('./api/variants-test')
-require('./api/ungroupedVariants-test')
-require('./api/entryVariants-test')
 require('./api/contentType-delete-test')
 require('./api/delete-test')
 require('./api/team-test')

test/unit/asset-test.js

@@ -315,6 +315,67 @@ describe('Contentstack Asset test', () => {
       })
       .catch(done)
   })
+
+
+  it('Asset download test', done => {
+    var mock = new MockAdapter(Axios)
+    const downloadResponse = new Blob(['file content'], { type: 'text/plain' })
+
+    mock.onGet('/assets/download_url').reply(200, downloadResponse)
+
+    makeAsset({
+      asset: {
+        ...systemUidMock
+      },
+      stackHeaders: stackHeadersMock
+    })
+      .download({ url: '/assets/download_url', responseType: 'blob' })
+      .then((response) => {
+        expect(response.data).to.be.instanceOf(Blob)
+        expect(response.data.type).to.be.equal('text/plain')
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Asset download test without url', done => {
+    var mock = new MockAdapter(Axios)
+    const downloadResponse = new Blob(['file content'], { type: 'text/plain' })
+
+    mock.onGet(`/assets/${systemUidMock.uid}`).reply(200, downloadResponse)
+
+    makeAsset({
+      asset: {
+        ...systemUidMock
+      },
+      stackHeaders: stackHeadersMock
+    })
+      .download({ responseType: 'blob' })
+      .then((response) => {
+        console.log("🚀 ~ .then ~ response:", response)
+        expect(response.data).to.be.instanceOf(Blob)
+        expect(response.data.type).to.be.equal('text/plain')
+        done()
+      })
+      .catch((err) => {
+        expect(err.message).to.be.equal('Asset URL can not be empty')
+        done()
+      })
+  })
+
+  it('Asset download test with missing url', done => {
+    makeAsset({
+      asset: {
+        ...systemUidMock
+      },
+      stackHeaders: stackHeadersMock
+    })
+      .download({ responseType: 'blob' })
+      .catch((err) => {
+        expect(err.message).to.be.equal('Asset URL can not be empty')
+        done()
+      })
+  })
 })
 
 function makeAsset (data) {

test/unit/contentType-test.js

@@ -280,6 +280,34 @@ describe('Contentstack ContentType test', () => {
         done()
       })
   })
+  it('should fetch references of a ContentType', done => {
+    var mock = new MockAdapter(Axios)
+    const referencesResponse = {
+      references: [
+        {
+          uid: 'entry_uid',
+          title: 'Entry Title',
+          content_type: 'UID'
+        }
+      ]
+    }
+    mock.onGet(`/content_types/UID/references`).reply(200, referencesResponse)
+    makeContentType({
+      content_type: {
+        ...systemUidMock
+      },
+      stackHeaders: stackHeadersMock
+    })
+      .references()
+      .then((response) => {
+        expect(response.references).to.be.an('array')
+        expect(response.references[0].uid).to.be.equal('entry_uid')
+        expect(response.references[0].title).to.be.equal('Entry Title')
+        expect(response.references[0].content_type).to.be.equal('UID')
+        done()
+      })
+      .catch(done)
+  })
 })
 
 function makeContentType (data) {

test/unit/entry-test.js

@@ -640,6 +640,37 @@ describe('Contentstack Entry test', () => {
       })
       .catch(done)
   })
+
+  it('should fetch variants of an Entry', done => {
+    var mock = new MockAdapter(Axios)
+    const variantsResponse = {
+      variants: [
+        {
+          uid: 'variant_uid',
+          title: 'Variant Title',
+          content_type: 'content_type_uid'
+        }
+      ]
+    }
+
+    mock.onGet(`/content_types/content_type_uid/entries/UID/variants/variantUid`).reply(200, variantsResponse)
+
+    makeEntry({
+      entry: {
+        ...systemUidMock
+      }
+    })
+      .variants('variantUid')
+      .fetch()
+      .then((response) => {
+        expect(response.variants).to.be.an('array')
+        expect(response.variants[0].uid).to.be.equal('variant_uid')
+        expect(response.variants[0].title).to.be.equal('Variant Title')
+        expect(response.variants[0].content_type).to.be.equal('content_type_uid')
+        done()
+      })
+      .catch(done)
+  })
 })
 
 function makeEntry (data) {