Development to staging (11-02-2025) Release

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

@@ -0,0 +1,228 @@
+import { expect } from "chai";
+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,
+  publishVariantEntryFirst,
+  unpublishVariantEntryFirst,
+} from "../mock/variantEntry.js";
+import { contentstackClient } from "../utility/ContentstackClient.js";
+
+var client = {};
+
+var stack = {};
+var variantUid = "";
+var variantGroupUid = "";
+var contentTypeUid = "";
+var entryUid = "";
+
+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) => {
+    makeVariantGroup()
+      .create(createVariantGroup)
+      .then((variantGroup) => {
+        variantGroupUid = variantGroup.uid;
+        expect(variantGroup.name).to.be.equal(createVariantGroup.name);
+        expect(variantGroup.uid).to.be.equal(createVariantGroup.uid);
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should create a Variants", (done) => {
+    makeVariants()
+      .create(variant)
+      .then((variants) => {
+        variantUid = variants.uid;
+        expect(variants.name).to.be.equal(variant.name);
+        expect(variants.uid).to.be.not.equal(null);
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should update/create variant of an entry", (done) => {
+    makeEntryVariants(variantUid)
+      .update(variantEntryFirst)
+      .then((variantEntry) => {
+        expect(variantEntry.entry.title).to.be.equal("First page variant");
+        expect(variantEntry.entry._variant._uid).to.be.not.equal(null);
+        expect(variantEntry.notice).to.be.equal(
+          "Entry variant created successfully."
+        );
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should get an entry variant", (done) => {
+    makeEntryVariants(variantUid)
+      .fetch(variantUid)
+      .then((variantEntry) => {
+        expect(variantEntry.entry.title).to.be.equal("First page variant");
+        expect(variantEntry.entry._variant._uid).to.be.not.equal(null);
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should publish entry variant", (done) => {
+    publishVariantEntryFirst.entry.variants[0].uid = variantUid;
+
+    makeEntry()
+      .entry(entryUid)
+      .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", (done) => {
+    unpublishVariantEntryFirst.entry.variants[0].uid = variantUid;
+    makeEntry()
+      .entry(entryUid)
+      .unpublish({
+        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 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({})
+      .find()
+      .then((variantEntries) => {
+        expect(variantEntries.items).to.be.an("array");
+        expect(variantEntries.items[0].variants.title).to.be.equal(
+          "First page variant"
+        );
+        expect(variantEntries.items[0].variants._variant._uid).to.be.not.equal(
+          null
+        );
+        done();
+      })
+      .catch(done);
+  });
+
+  it("should delete entry variant from uid", (done) => {
+    makeEntryVariants(variantUid)
+      .delete(variantUid)
+      .then((variantEntry) => {
+        expect(variantEntry.notice).to.be.equal(
+          "Entry variant deleted successfully."
+        );
+        done();
+      })
+      .catch(done);
+  });
+
+  it("Delete a Variant from uid", (done) => {
+    makeVariantGroup(variantGroupUid)
+      .variants(variantUid)
+      .delete()
+      .then((data) => {
+        expect(data.message).to.be.equal("Variant deleted successfully");
+        done();
+      })
+      .catch(done);
+  });
+
+  it("Delete a Variant Group from uid", (done) => {
+    makeVariantGroup(variantGroupUid)
+      .delete()
+      .then((data) => {
+        expect(data.message).to.be.equal(
+          "Variant Group and Variants deleted successfully"
+        );
+        done();
+      })
+      .catch(done);
+  });
+});
+
+function makeVariants(uid = null) {
+  return client
+    .stack({ api_key: process.env.API_KEY })
+    .variantGroup(variantGroupUid)
+    .variants(uid);
+}
+
+function makeVariantGroup(uid = null) {
+  return client.stack({ api_key: process.env.API_KEY }).variantGroup(uid);
+}
+
+function makeEntryVariants(uid = null) {
+  return client
+    .stack({ api_key: process.env.API_KEY })
+    .contentType(contentTypeUid)
+    .entry(entryUid)
+    .variants(uid);
+}
+
+function makeEntry() {
+  return client
+    .stack({ api_key: process.env.API_KEY })
+    .contentType(contentTypeUid);
+}

test/sanity-check/mock/variantEntry.js

@@ -0,0 +1,49 @@
+const variantEntryFirst = {
+  entry: {
+    title: "First page variant",
+    url: "/first-page-variant",
+    _variant: {
+      _change_set: ["title", "url"],
+    },
+  },
+};
+
+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,15 +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/contentType-delete-test')
 require('./api/delete-test')
 require('./api/team-test')