Feat/cs 44599 ungrouped variants (#8)

* sca-scan.yml

* jira.yml

* sast-scan.yml

* secrets-scan.yml

* codeql-analysis.yml

* Implemented ungrouped Variants with test cases

* Removed github action file

* Added fetchByUIDs method

* Fixed issue

* Fixed merge conflits error

---------

Co-authored-by: Aravind Kumar <[email protected]>

Author: sunil-lakshman

lib/stack/index.js

@@ -20,6 +20,7 @@ import { BranchAlias } from './branchAlias'
 import { AuditLog } from './auditlog'
 import { Taxonomy } from './taxonomy'
 import { ManagementToken } from './managementToken'
+import { Variants } from './variants'
 import { VariantGroup } from './variantGroup'
 
 /**
@@ -369,6 +370,29 @@ export function Stack (http, data) {
       return new Label(http, data)
     }
 
+    /**
+     * @description For creating ungrouped variants.
+     * @param {String} uid The UID of the variants you want to get details.
+     * @returns {Variants} Instance of variants.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).variants().create()
+     * .then((variants) => console.log(variants))
+     *
+     * client.stack({ api_key: 'api_key'}).variants('variants_uid').fetch()
+     * .then((variants) => console.log(variants))
+     */
+    this.variants = (variantsUid = null) => {
+      const data = { stackHeaders: this.stackHeaders }
+      if (variantsUid) {
+        data.variants = { uid: variantsUid }
+      }
+      return new Variants(http, data)
+    }
+
+
     /**
      * @description You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a ‘release’, and then deploy this release to an environment.
      * @param {String} releaseUid The UID of the Releases you want to get details.

lib/stack/variants/index.js

@@ -0,0 +1,134 @@
+import cloneDeep from 'lodash/cloneDeep'
+import {
+  deleteEntity,
+  fetch,
+  query,
+  create
+} from '../../entity'
+/**
+ * Variantss allow you to group a collection of content within a stack. Using variants you can group content types that need to work together. Read more about <a href='https://www.contentstack.com/docs/developers/create-content-types/manage-variants'>Variantss</a>.
+ * @namespace Variants
+ */
+export function Variants (http, data) {
+  this.stackHeaders = data.stackHeaders
+  this.urlPath = `/variants`
+
+  if (data.variants) {
+    Object.assign(this, cloneDeep(data.variants))
+    this.urlPath += `/${this.uid}`
+
+    /**
+     * @description The Delete variants call is used to delete a specific variants.
+     * @memberof Variants
+     * @func delete
+     * @returns {Object} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).variants('variants_uid').delete()
+     * .then((response) => console.log(response.notice))
+     */
+    this.delete = deleteEntity(http)
+
+    /**
+     * @description The fetch Variants returns information about a particular variants of a stack.
+     * @memberof Variants
+     * @func fetch
+     * @returns {Promise<Variants.Variants>} Promise for Variants instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).variants('variants_uid').fetch()
+     * .then((variants) => console.log(variants))
+     *
+     */
+    this.fetch = fetch(http, 'variants')
+  } else {
+    /**
+     * @description The Create an variants call creates a new variants.
+     * @memberof Variants
+     * @func create
+     * @returns {Promise<Variants.Variants>} Promise for Variants instance
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const variants = {
+     *       "uid": "iphone_color_white", // optional
+     *       "name": "White",
+     *       "personalize_metadata": {
+     *           "experience_uid": "exp1",
+     *           "experience_short_uid": "expShortUid1",
+     *           "project_uid": "project_uid1",
+     *           "variant_short_uid": "variantShort_uid1"
+     *       },
+     *       }
+     * client.stack().variants().create({ variants })
+     * .then((variants) => console.log(variants))
+     */
+    this.create = create({ http })
+
+    /**
+     * @description The Query on Variants will allow to fetch details of all or specific Variants.
+     * @memberof Variants
+     * @param {Object} params - URI parameters
+     * @prop {Object} params.query - Queries that you can use to fetch filtered results.
+     * @func query
+     * @returns {Array<Variants>} Array of Variants.
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack().variants().query({ query: { name: 'Variants Name' } }).find()
+     * .then((variants) => console.log(variants))
+     */
+    this.query = query({ http: http, wrapperCollection: VariantsCollection })
+
+    /**
+     * @description The fetchByUIDs on Variants will allow to fetch details of specific Variants UID.
+     * @memberof Variants
+     * @param {Object} params - URI parameters
+     * @prop {Object} params.query - fetchByUIDs that you can use to fetch filtered results.
+     * @func query
+     * @returns {Array<Variants>} Array of Variants.
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+      * client.stack().variants().fetchByUIDs(['uid1','uid2']).find()
+      * .then((variants) => console.log(variants))
+     */
+    this.fetchByUIDs = async (variantUids) => {
+      
+      try {
+        const response = await http.get(this.urlPath, {
+          params: {
+            uids: variantUids
+          },
+          headers: {
+            ...cloneDeep(this.stackHeaders)
+          }
+        })
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+  }
+}
+
+export function VariantsCollection (http, data) {
+  const obj = cloneDeep(data.variants) || []
+  const VariantsCollection = obj.map((userdata) => {
+    return new Variants(http, { variants: userdata, stackHeaders: data.stackHeaders })
+  })
+  return VariantsCollection
+}

test/api/ungroupedVariants-test.js

@@ -0,0 +1,107 @@
+import { expect } from 'chai'
+import { describe, it, setup } from 'mocha'
+import { jsonReader } from '../utility/fileOperations/readwrite'
+import { contentstackClient } from '../utility/ContentstackClient.js'
+
+var client = {}
+var stack = {}
+
+const variants ={
+    "uid": "iphone_color_white", // optional
+    "name": "White",
+    "personalize_metadata": {
+        "experience_uid": "exp1",
+        "experience_short_uid": "expShortUid1",
+        "project_uid": "project_uid1",
+        "variant_short_uid": "variantShort_uid1"
+    },
+  }
+
+var variantsUID = ''
+var deleteVariantsUID = ''
+describe('Variants api Test', () => {
+  setup(() => {
+    const user = jsonReader('loggedinuser.json')
+    stack = jsonReader('stack.json')
+    client = contentstackClient(user.authtoken)
+  })
+
+  it('Variants create', done => {
+    makeVariants()
+      .create({ variants })
+      .then((variantsResponse) => {
+        variantsUID = variantsResponse.uid
+        expect(variantsResponse.uid).to.be.not.equal(null)
+        expect(variantsResponse.name).to.be.equal(variants.name)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Fetch variants from uid', done => {
+    makeVariants(variantsUID)
+      .fetch()
+      .then((variantsResponse) => {
+        expect(variantsResponse.uid).to.be.equal(variantsUID)
+        expect(variantsResponse.name).to.be.equal(variants.name)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Query to get all variantss', done => {
+    makeVariants()
+      .query({ query: { name: variants.name } })
+      .find()
+      .then((response) => {
+        response.items.forEach((variantsResponse) => {
+          expect(variantsResponse.uid).to.be.not.equal(null)
+          expect(variantsResponse.name).to.be.not.equal(null)
+        })
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Query variants with name', done => {
+    makeVariants()
+      .query({ query: { name: variants.name } })
+      .find()
+      .then((response) => {
+        response.items.forEach((variantsResponse) => {
+          expect(variantsResponse.uid).to.be.equal(variantsUID)
+          expect(variantsResponse.name).to.be.equal(variants.name)
+        })
+        done()
+      })
+      .catch(done)
+  })
+
+  it('Fetch By variants UIDs ', done => {
+    makeVariants()
+      .fetchByUIDs(['uid1', 'uid2'])
+      .then((response) => {
+        response.variants.forEach((variantsResponse) => {
+          expect(variantsResponse.uid).to.be.equal(variantsUID)
+          expect(variantsResponse.name).to.be.equal(variants.name)
+        })
+        done()
+      })
+      .catch(done)
+  })
+
+
+  it('Delete variants from uid', done => {
+    makeVariants(deleteVariantsUID)
+      .delete()
+      .then((data) => {
+        expect(data.notice).to.be.equal('Variants deleted successfully.')
+        done()
+      })
+      .catch(done)
+  })
+})
+
+function makeVariants (uid = null) {
+  return client.stack({ api_key: stack.api_key }).variants(uid)
+}

test/typescript/index.test.ts

@@ -25,6 +25,8 @@ import { testTerm } from './terms';
 import { testTeams } from './teams';
 import { testTeamUsers } from './teamUsers';
 import { testTeamStackRoleMapping } from './teamsStackRoleMappings';
+import { createVariants, deleteVariants, variants, queryVariants } from './ungroupedVariants';
+
 dotenv.config()
 jest.setTimeout(10000);
 
@@ -87,6 +89,10 @@ describe('Typescript API test', () => {
     managementToken(stack)
     deleteManagementToken(stack)
 
+    createVariants(stack)
+    deleteVariants(stack)
+    variants(stack.variant)
+    queryVariants(stack.variant)
     createVariantGroup(stack.VariantGroup())
     queryVariantGroup(stack.VariantGroup())
     variantGroup(stack)
@@ -96,7 +102,6 @@ describe('Typescript API test', () => {
     queryVariant(stack.VariantGroup().Variants())
     variant(stack.VariantGroup().variants())
 
-
     findAllRole(stack.role())
     createRole(stack.role())
     getRole(stack)

test/typescript/mock/ungroupedvariants.ts

@@ -0,0 +1,49 @@
+const variant = {
+    "created_by": "blt6cdf4e0b02b1c446",
+    "updated_by": "blt303b74fa96e1082a",
+    "created_at": "2022-10-26T06:52:20.073Z",
+    "updated_at": "2023-09-25T04:55:56.549Z",
+    "uid": "iphone_color_white",
+    "name": "White"
+  }
+
+const variants1 = {
+          "uid": "iphone_color_white", // optional
+          "name": "White",
+          "personalize_metadata": {
+             "experience_uid": "exp1",
+              "experience_short_uid": "expShortUid1",
+               "project_uid": "project_uid1",
+              "variant_short_uid": "variantShort_uid1"
+          },
+    }
+const variants2 = {
+    "uid": "variant_1",
+    "created_by": "user_id",
+    "updated_by": "user_id",
+    "name": "Variant 1",
+    "personalize_metadata": {
+          "experience_uid": "exp1",
+          "experience_short_uid": "expShortUid1",
+          "project_uid": "project_uid1",
+          "variant_short_uid": "variantShort_uid1"
+    },
+    "created_at": "2024-04-16T05:53:50.547Z",
+    "updated_at": "2024-04-16T05:53:50.547Z",
+    "variant_group": {
+        "uid": "variant_group_1",
+        "name": "Variant Group 1",
+        "content_types": [
+            "CTSTAET123"
+        ],
+        "personalize_metadata": {
+            "experience_uid": "variant_group_ex_uid",
+            "experience_short_uid": "variant_group_short_uid",
+            "project_uid": "variant_group_project_uid"
+        }
+    }
+}
+
+
+
+export { variant, variants1, variants2 }