-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Variants Implementation with Unit testcases (#3)
* Variants Implementation with Unit testcases * Upgraded node version * Updated packagelock.json file * Added Typescript support * Added feature for fetch base entry with variants details * Fixed PR comments * Will enable once api's get ready * Updated node version * Deleted CodeQL action in private repo * Fixed error in includeVariants method and docs corrections * Fixed unit test error
- Loading branch information
1 parent
1149b5f
commit dcbeb49
Showing
16 changed files
with
1,939 additions
and
11,572 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| import cloneDeep from 'lodash/cloneDeep' | ||
| import { | ||
| update, | ||
| deleteEntity, | ||
| fetch, | ||
| upload, | ||
| query, | ||
| parseData | ||
| } | ||
| from '../../../../entity' | ||
| import FormData from 'form-data' | ||
| import { | ||
| createReadStream | ||
| } from 'fs' | ||
| import error from '../../../../core/contentstackError' | ||
| /** | ||
| * An variants is the actual piece of content created using one of the defined content types. Read more about <a href='https://www.contentstack.com/docs/guide/content-management'>Entries</a>. | ||
| * @namespace Variants | ||
| */ | ||
| export function Variants(http, data) { | ||
| Object.assign(this, cloneDeep(data)) | ||
| this.urlPath = `/content_types/${this.content_type_uid}/entries/${this.entry_uid}/variants` | ||
| if (data && data.variants_uid) { | ||
| this.urlPath += `/${this.variants_uid}` | ||
| /** | ||
| * @description The Create an variants call creates a new variants for the selected content type. | ||
| * @memberof Variants | ||
| * @func update | ||
| * @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'}).contentType('content_type_uid').entry('entry_uid').variants('uid').fetch() | ||
| * .then((variants) => { | ||
| * variants.title = 'My New Variants' | ||
| * variants.description = 'Variants description' | ||
| * return variants.update() | ||
| * }) | ||
| * .then((variants) => console.log(variants)) | ||
| */ | ||
| this.update = update(http, 'variants') | ||
|
|
||
| /** | ||
| * @description The Delete an variants call is used to delete a specific variants from a content type. | ||
| * @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'}).contentType('content_type_uid').entry('entry_uid').variants('uid').delete() | ||
| * .then((response) => console.log(response.notice)) | ||
| */ | ||
| this.delete = deleteEntity(http) | ||
|
|
||
| /** | ||
| * @description The fetch Variants call fetches Variants details. | ||
| * @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'}).contentType('content_type_uid').entry('entry_uid').variants('uid').fetch() | ||
| * .then((variants) => console.log(variants)) | ||
| * | ||
| */ | ||
| this.fetch = fetch(http, 'variants') | ||
| } else { | ||
| /** | ||
| * @description The Query on Variants will allow to fetch details of all or specific Variants | ||
| * @memberof Variants | ||
| * @func query | ||
| * @param {Int} locale Enter the code of the language of which the entries need to be included. Only the entries published in this locale will be displayed. | ||
| * @param {Object} query Queries that you can use to fetch filtered results. | ||
| * @returns {Array<Variants>} Array of Variants. | ||
| * | ||
| * @example | ||
| * import * as contentstack from '@contentstack/management' | ||
| * const client = contentstack.client() | ||
| * | ||
| * client.stack().contentType('content_type_uid').entry('entry_uid').variants().query({ query: { title: 'Variants title' } }).find() | ||
| * .then((entries) => console.log(entries)) | ||
| */ | ||
| this.query = query({ http: http, wrapperCollection: VariantsCollection }) | ||
| } | ||
| } | ||
| export function VariantsCollection(http, data) { | ||
| const obj = cloneDeep(data.entries) || [] | ||
| const variantCollection = obj.map((variants) => { | ||
| return new Variants(http, { | ||
| content_type_uid: data.content_type_uid, | ||
| entry_uid: data.entry_uid, | ||
| variants_uid: data.variants_uid, | ||
| stackHeaders: data.stackHeaders | ||
| }) | ||
| }) | ||
| return variantCollection | ||
| } | ||
|
|
||
| export function createFormData(variants) { | ||
| return () => { | ||
| const formData = new FormData() | ||
| const uploadStream = createReadStream(variants) | ||
| formData.append('variants', uploadStream) | ||
| return formData | ||
| } | ||
| } |
Oops, something went wrong.