- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 | - - - - - - - - - - - -10x - -10x - - - - -10x - -10x - -10x - -10x -10x -12x - - - - - - - - - -1x - - - - - - - - - - - - - - - - -2x -1x -1x -1x -1x -1x - -1x - - - - - - - - -2x -2x -1x -1x - - -1x - - - - - - | import Field from "./field.js";
-
-/** Class representing a entry from contentstack ui. */
-
-class Entry {
-
- constructor(initializationData, connection, emitter) {
-
- /**
- * Gets contenttype of the current entry.
- * @type {Object}
- */
- this.content_type = initializationData.data.content_type;
-
- this._data = initializationData.data.entry;
- /**
- * Gets locale of the current entry.
- * @type {string}
- */
- this.locale = initializationData.data.locale;
-
- this._connection = connection;
-
- this._emitter = emitter;
-
- let thisEntry = this
- this._emitter.on('entryUpdate', function (event) {
- thisEntry._data = event.data;
- });
- }
-
- /**
- * Gets data of the current entry.
- * @return {Object} Returns entry data.
- */
-
- getData() {
- return this._data;
- }
-
-
- /**
- * Gets the field object which allows you to interact with the field. These object will have all the same methods and properties of extension.field except for field.setData().
- * @example
- * var field = entry.getField('field_uid');
- * var fieldSchema = field.schema;
- * var fieldUid = field.uid;
- * var fieldData = field.getData();
- * @param {string} uid of the field
- * @return {Object} Field Object
- */
-
-
- getField(uid) {
- if (this._data[uid]) {
- let schema = this.content_type.schema.find(x => x.uid === uid);
- let fieldIntilaizationDataObject = { data: { uid: uid, value: this._data[uid], schema: schema, data_type: schema.data_type } };
- let fieldObject = new Field(fieldIntilaizationDataObject, this._connection, this._emitter );
- fieldObject.setData = null;
- return fieldObject;
- }
- throw Error('Invalid uid, Field not found')
- }
-
- /**
- * Fires the callback function every time entry data is updated.
- * @param {Function} cd Callback function
- */
-
- onChange(callback) {
- let entryObj = this;
- if (callback && typeof (callback) === "function") {
- entryObj._emitter.on('entryUpdate', function (event) {
- callback(event.data);
- });
- }else {
- throw Error('Callback must be a function')
- }
- }
-}
-
-
-export default Entry; |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 | - - - - - - -6x - - - - - - - - - - - -4x - - - - -4x - - - - -4x - - - - -4x -4x - - - - -2x - - - - - -4x - - - - -4x - -4x -4x - - - - -3x - - - -1x - - - - - - | import postRobot from "post-robot";
-import Field from "./field.js";
-import Window from "./window.js";
-import Stack from "./stack.js";
-import Entry from "./entry.js";
-import EventEmitter from 'wolfy87-eventemitter';
-
-const emitter = new EventEmitter();
-
-/** Class representing a extension from contentstack ui. */
-
-class Extension {
-
- constructor(initializationData) {
- /**
- * This method gives you the configuration parameters. Check out our [UI eEtension config documentation](https://www.contentstack.com/docs/apis/content-delivery-api/).
- * @type {Object}
- */
-
- this.config = initializationData.data.config;
- /**
- * This object holds details of the current user. The details include roles assigned to users.
- * @type {Object}
- */
- this.currentUser = initializationData.data.user;
- /**
- * type of extension, 'FIELD' || 'SIDEBAR'.
- * @type {string}
- */
- this.type = initializationData.data.type || 'FIELD';
- /**
- * This gives you the entry object which allows you to interact with the current entry.
- * @type {Entry}
- */
- this.entry = new Entry(initializationData, postRobot, emitter);
- if (this.type === 'FIELD') {
- /**
- * Gives you the extension field object which allows you to interact with the field.
- * @type {Field}
- */
- this.field = new Field(initializationData, postRobot, emitter);
- }
- /**
- * The window object provides users with methods that allow them to adjust the size of the iframe that contains the extension.
- * @type {Window}
- */
- this.window = new Window(postRobot);
- /**
- * This method returns stack object which allows users to interact with the stack.
- * @type {Stack}
- */
- this.stack = new Stack(initializationData.data.stack, postRobot);
-
- postRobot.on('entryUpdate', function (event) {
- emitter.emitEvent('entryUpdate', [event]);
- })
- }
-
- static initialize() {
- return postRobot.sendToParent('init', {})
- }
-
- setReady() {
- return postRobot.sendToParent('ready')
- }
-
-}
-
-
-export default Extension; |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 | - - - - - - - - - -9x - - - - -9x - - - - -9x - -9x - -9x - -9x - -9x -10x -10x -9x - - - - - - - - - - - -2x -2x -2x -1x -1x -1x - - - - - - - - -1x - - - - - - - -1x - - - - - - | /** Class representing a field from contentstack ui. */
-
-class Field {
-
- constructor(fieldDataObject, connection, emitter) {
-
- /**
- * The uid of the current field is defined in the content type of the entry..
- * @type {string}
- */
- this.uid = fieldDataObject.data.uid;
- /**
- * The data type of the current field is set using this method.
- * @type {string}
- */
- this.data_type = fieldDataObject.data.schema.data_type;
- /**
- * The schema of the current field (schema of fields such as ‘Single Line Textbox’, ‘Number’, and so on) is set using this method.
- * @type {Object}
- */
- this.schema = fieldDataObject.data.schema;
-
- this._data = fieldDataObject.data.value;
-
- this._connection = connection;
-
- let fieldObj = this
-
- emitter.on('entryUpdate', function (event) {
- let newData = event.data[fieldObj.uid];
- if (fieldObj._data !== newData) {
- fieldObj._data === newData;
- }
- });
- }
-
- /**
- * Sets the data for the current field.
- * @param {Object|string|number} data Data to be set on the field
- * @return {Object} A Promise object which will return Field object.
- */
-
- setData(data) {
- let currentFieldObj = this;
- let dataObj = {data, uid:currentFieldObj.uid}
- return this._connection.sendToParent('setData', dataObj).then(() => {
- this._data = data;
- return Promise.resolve(currentFieldObj);
- }).catch((e) => Promise.reject(e));
- }
-
- /**
- * Gets data of the current field
- * @return {Object|string|number} Returns field data.
- */
-
- getData() {
- return this._data;
- }
-
- /**
- * Sets the focus for a field when an extension is being used. This method shows user presence and highlights field in Contentstack UI by returning a promise object.
- * @return {Object} A Promise object which will resolve on Contentstack UI acknowledgement of focused state.
- */
- setFocus() {
- return this._connection.sendToParent('focus')
- }
-
-}
-
-
-export default Field; |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| lib | -
-
- |
- 100% | -218/218 | -100% | -137/137 | -100% | -55/55 | -100% | -209/209 | -
| lib/stack | -
-
- |
- 100% | -102/102 | -100% | -76/76 | -100% | -27/27 | -100% | -101/101 | -
| lib/stack/api | -
-
- |
- 100% | -134/134 | -100% | -83/83 | -100% | -28/28 | -100% | -128/128 | -
| lib/stack/api/asset | -
-
- |
- 100% | -27/27 | -100% | -19/19 | -100% | -11/11 | -100% | -26/26 | -
| lib/stack/api/content-type | -
-
- |
- 100% | -45/45 | -100% | -27/27 | -100% | -15/15 | -100% | -45/45 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 | - -3x - -3x - - - - - - - - - - - - - - - - - - - - -3x -1x -2x -1x -1x -1x - - - - - - - - -1x - - - - | import Extension from "./extension.js";
- import postRobot from "post-robot";
- const version = "1.0.0"
-
- postRobot.CONFIG.LOG_LEVEL = 'error';
-
- /**Class to intialize the plugin on Contentstack ui. */
-
- class ContentstackUIExtension {
-
- /**
- * You need to first include Contentstack UI Extensions SDK and Contentstack UI Stylesheet in you HTML file and then call ContentstackUIExtension.init in the script tag.
- * @example
- * HTML
- * <script src="https://sdklink"></script>
- * <link href="https://style sheet link" rel="stylesheet" >
- * @example
- * // javascript
- * ContentstackUIExtension.init().then(function (extension) {
- * var value = extension.field.getData()
- * extension.field.setData("New Field Data")
- * })
- * @return {Extension} An Extension object, will contain all the data recived from the Contentstack UI.
- */
- static init() {
- if (this._extension)
- return Promise.resolve(this._extension)
- return Extension.initialize().then((initializationData) => {
- this._extension = new Extension(initializationData)
- return Promise.resolve(this._extension)
- }).catch((e) => Promise.reject(e))
- }
-
-
- /**
- * Version of Contentstack ui extension.
- * @type {string}
- */
- static get SDK_VERSION() {
- return version;
- }
- }
-
- export default ContentstackUIExtension; |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 | - - - - - - - - - - - - -26x - -26x - - - - -26x - -26x - -26x - -26x - -26x -75x - - -26x -75x - - - - - - - - - -1x - - - - - - - - - - - - - - - - - - -12x -12x -12x - -12x - -12x -1x - - -11x -11x -11x -11x -31x -8x -4x - -4x - -8x - - -82x -23x - -22x - -22x - -22x - -10x -12x - -2x -2x -2x -10x -4x -12x -4x -2x - -2x -2x - - -4x -4x - - - -1x - -10x - - - - -10x -10x -10x - - - - - - - - - -2x -2x -1x -3x - - -1x - - - - - - - - - - -2x -2x -1x -3x - - -1x - - - - - - - - - - -2x -2x -1x -3x - - -1x - - - - - - - - - - -2x -2x -1x -3x - - -1x - - - - - | import Field from './field.js';
-
-/** Class representing an entry from Contentstack UI. Not available for Dashboard Widget extension. */
-
-class Entry {
- /**
- * @hideconstructor
- */
- constructor(initializationData, connection, emitter) {
- /**
- * Gets the content type of the current entry.
- * @type {Object}
- */
- this.content_type = initializationData.data.content_type;
-
- this._data = initializationData.data.entry;
- /**
- * Gets the locale of the current entry.
- * @type {string}
- */
- this.locale = initializationData.data.locale;
-
- this._connection = connection;
-
- this._emitter = emitter;
-
- const thisEntry = this;
-
- this._emitter.on('entrySave', (event) => {
- thisEntry._data = event.data;
- });
-
- this._emitter.on('entryChange', (event) => {
- thisEntry._changedData = event.data;
- });
- }
-
- /**
- * Gets data of the current entry.
- * @return {Object} Returns entry data.
- */
-
- getData() {
- return this._data;
- }
-
-
- /**
- * Gets the field object for the saved data, which allows you to interact with the field.
- * This object will have all the same methods and properties of extension.field.
- * Note: For fields initialized using the getFields function, the setData function currently works only for the following fields: as single_line, multi_line, RTE, markdown, select, number, boolean, date, link, and extension of data type text, number, boolean, and date.
- * @example
- * var field = entry.getField('field_uid');
- * var fieldSchema = field.schema;
- * var fieldUid = field.uid;
- * var fieldData = field.getData();
- * @param {string} uid Unique ID of the field
- * @return {Object} Field object
- */
-
-
- getField(uid) {
- const path = uid.split('.');
- let value = this._data;
- let schema = this.content_type.schema;
-
- const isDataEmpty = Object.keys(value).length === 0;
-
- if (isDataEmpty) {
- throw new Error('The data is unsaved. Save the data before requesting the field.');
- }
-
- try {
- let skipNext = false;
- let skipNextTwo = false;
- path.forEach((key, index) => {
- if (skipNext) {
- if (skipNextTwo) {
- skipNextTwo = false;
- } else {
- skipNext = false;
- }
- return;
- }
-
- schema = schema.find(x => x.uid === key);
- if (!schema) { throw Error('schema not found'); }
-
- console.log('mayhem', value);
-
- value = value[key];
-
- if ((schema.data_type === 'group' || schema.data_type === 'global_field') && schema.multiple === false
- && path.length !== (index + 1)) {
- schema = schema.schema;
- } else if ((schema.data_type === 'group' || schema.data_type === 'global_field') && schema.multiple === true
- && path.length !== (index + 1)) {
- schema = schema.schema;
- value = value[path[index + 1]];
- skipNext = true;
- } else if (schema.data_type === 'blocks' && path.length !== (index + 1)) {
- let blockId = Object.keys(value[path[index + 1]])[0];
- schema = schema.blocks.find(block => block.uid === blockId);
- if (path.length === index + 2) { // complete block value with uid
- value = value[path[index + 1]];
- } else { // block value without uid
- value = value[path[index + 1]][blockId];
- schema = schema.schema;
- }
-
- skipNext = true;
- skipNextTwo = true;
- }
- });
- } catch (e) {
- throw Error('Invalid uid, Field not found');
- }
- const fieldIntilaizationDataObject = {
- data: {
- uid, value, schema, data_type: schema.data_type
- }
- };
- const fieldObject = new Field(fieldIntilaizationDataObject, this._connection, this._emitter);
- delete fieldObject.onChange;
- return fieldObject;
- }
-
- /**
- * This function executes the callback function every time an entry is saved.
- * @param {function} callback The function to be called when an entry is saved.
- */
-
-
- onSave(callback) {
- const entryObj = this;
- if (callback && typeof (callback) === 'function') {
- entryObj._emitter.on('entrySave', (event) => {
- callback(event.data);
- });
- } else {
- throw Error('Callback must be a function');
- }
- }
-
- /**
- * The field.onChange() function is called when another extension programmatically changes the data of the current extension field using the field.setData() function. This function is only available for extension fields that support the following data types: text, number, boolean, or date.
- * @param {function} callback The function to be called when an entry is edited/changed.
- */
-
-
- onChange(callback) {
- const entryObj = this;
- if (callback && typeof (callback) === 'function') {
- entryObj._emitter.on('entryChange', (event) => {
- callback(event.data);
- });
- } else {
- throw Error('Callback must be a function');
- }
- }
-
- /**
- * The onPublish() function executes the callback function every time an entry has been published with the respective payload.
- * @param {function} callback The function to be called when an entry is published.
- */
-
-
- onPublish(callback) {
- const entryObj = this;
- if (callback && typeof (callback) === 'function') {
- entryObj._emitter.on('entryPublish', (event) => {
- callback(event.data);
- });
- } else {
- throw Error('Callback must be a function');
- }
- }
-
- /**
- * The onUnPublish() function executes the callback function every time an entry has been unpublished with the respective payload.
- * @param {function} callback The function to be called when an entry is un published.
- */
-
-
- onUnPublish(callback) {
- const entryObj = this;
- if (callback && typeof (callback) === 'function') {
- entryObj._emitter.on('entryUnPublish', (event) => {
- callback(event.data);
- });
- } else {
- throw Error('Callback must be a function');
- }
- }
-}
-export default Entry;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 | - - - - - - - -5x - - - - - - - - -5x - -5x - - - - - -5x - - - - -5x - - - - -5x - - -5x - - - - -2x - - -2x - - - - -2x - - - - - - - -5x - -5x - - - - -3x - - - -5x - - - - -4x - - - - - - -5x - -5x -25x -4x -4x - - -25x -4x - - -25x -4x - - -25x -4x - - -25x -4x - - -25x -4x - - - - - -3x - - - -1x - - - - - - | import postRobot from 'post-robot';
-import Field from './field.js';
-import Window from './window.js';
-import Stack from './stack';
-import Entry from './entry.js';
-import Store from './store.js';
-import EventEmitter from 'wolfy87-eventemitter';
-
-const emitter = new EventEmitter();
-
-/** Class representing an extension from Contentstack UI. */
-
-class Extension {
- /**
- * @hideconstructor
- */
- constructor(initData) {
- const initializationData = initData;
-
- this.postRobot = postRobot;
- /**
- * This method gives you the configuration parameters. Check out our {@link https://www.contentstack.com/docs/guide/extensions|UI Extension documentation} .
- * @type {Object}
- */
-
- this.config = initializationData.data.config;
- /**
- * This object holds details of the current user.
- * @type {Object}
- */
- this.currentUser = initializationData.data.user;
- /**
- * type of extension, 'FIELD' || 'WIDGET' || 'DASHBOARD'.
- * @type {string}
- */
- this.type = initializationData.data.type || 'FIELD';
-
-
- if (this.type === 'FIELD') {
- /**
- * This method gives you the instance configuration parameters set from the content type builder page in the field settings. This is only available for the Custom Field extension.
- * @type {Object}
- */
- this.fieldConfig = initializationData.data.field_config;
-
-
- initializationData.data.self = true;
- /**
- * Gives you the extension field object which allows you to interact with the field. Only available for the Custom Field extension.
- * @type {Field}
- */
- this.field = new Field(initializationData, postRobot, emitter);
- }
-
- /**
- * Store to persist data for extension.
- * Note: Data is stored in the browser {@link external:localStorage} and will be lost if the {@link external:localStorage} is cleared in the browser.
- * @type {Store}
- */
- this.store = new Store(postRobot);
-
- if (this.type !== 'DASHBOARD') {
- /**
- * This gives you the entry object which allows you to interact with the current entry. Not available in case of the Dashboard Widget extension.
- * @type {Entry}
- */
- this.entry = new Entry(initializationData, postRobot, emitter);
- }
-
-
- if (this.type === 'FIELD' || this.type === 'DASHBOARD') {
- /**
- * The window object provides users with methods that allow them to adjust the size of the iframe that contains the extension. Not available in case of custom widgets.
- * @type {Window}
- */
- this.window = new Window(postRobot, this.type, emitter, initializationData.data.dashboard_width);
- }
-
- /**
- * This method returns stack object which allows users to read and manipulate a range of objects in a stack.
- * @type {Stack}
- */
- this.stack = new Stack(initializationData.data.stack, postRobot);
-
- postRobot.on('extensionEvent', (event) => {
- if (event.data.name === 'entrySave') {
- emitter.emitEvent('entrySave', [{ data: event.data.data }]);
- emitter.emitEvent('updateFields', [{ data: event.data.data }]);
- }
-
- if (event.data.name === 'entryChange') {
- emitter.emitEvent('entryChange', [{ data: event.data.data }]);
- }
-
- if (event.data.name === 'entryPublish') {
- emitter.emitEvent('entryPublish', [{ data: event.data.data }]);
- }
-
- if (event.data.name === 'entryUnPublish') {
- emitter.emitEvent('entryUnPublish', [{ data: event.data.data }]);
- }
-
- if (event.data.name === 'dashboardResize') {
- emitter.emitEvent('dashboardResize', [{ state: event.data.state }]);
- }
-
- if (event.data.name === 'extensionFieldChange') {
- emitter.emitEvent('extensionFieldChange', [{ data: event.data.data }]);
- }
- });
- }
-
- static initialize(version) {
- return postRobot.sendToParent('init', { version });
- }
-
- setReady() {
- return this.postRobot.sendToParent('ready');
- }
-}
-
-
-export default Extension;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 | 1x - - -30x -30x -30x -12x -10x -10x -15x - -2x -1x -1x - - -30x - - - - - - - - - - - - -30x - - - - -30x - - - - - -30x -30x - -30x - -30x - -30x - -30x - -30x - -30x - -30x -51x -51x - -51x - -51x -111x - - -51x -27x - - - - - - - - - - - -4x -4x - -4x - -2x - -2x -1x -1x -1x - - - - - - - - - -7x - - - - - - - -1x - - - - - - - -2x -2x -1x -1x -1x -1x - - -1x - - - - - - | const excludedDataTypesForSetField = ['file', 'reference', 'blocks', 'group', 'global_field'];
-
-function separateResolvedData(field, value) {
- let resolvedData = value;
- let unResolvedData = value;
- if (field.data_type === 'file') {
- if (value) {
- resolvedData = value;
- unResolvedData = field.schema.multiple === true ?
- value.map(file => file.uid) :
- value.uid;
- } else if (field.schema.multiple === true) {
- resolvedData = [];
- unResolvedData = [];
- }
- }
- return { resolvedData, unResolvedData };
-}
-
-/** Class representing a field from Contentstack UI. Only available for Custom Field extension */
-class Field {
- /**
- * @hideconstructor
- */
- constructor(fieldDataObject, connection, emitter) {
- /**
- * The UID of the current field is defined in the content type of the entry.
- * @type {string}
- */
- this.uid = fieldDataObject.data.uid;
- /**
- * The data type of the current field is set using this method.
- * @type {string}
- */
- this.data_type = fieldDataObject.data.schema.data_type;
- /**
- * The schema of the current field (schema of fields such as ‘Single Line Textbox’, ‘Number’,
- * and so on) is set using this method.
- * @type {Object}
- */
- this.schema = fieldDataObject.data.schema;
- this._emitter = emitter;
-
- let separatedData = separateResolvedData(this, fieldDataObject.data.value);
-
- this._data = separatedData.unResolvedData;
-
- this._resolvedData = separatedData.resolvedData;
-
- this._connection = connection;
-
- this._self = fieldDataObject.data.self || false;
-
- const fieldObj = this;
-
- emitter.on('updateFields', (event) => {
- const schemaPath = this._self && '$uid' in fieldObj.schema ? fieldObj.schema.$uid : fieldObj.uid;
- const path = schemaPath.split('.');
-
- let value = event.data;
-
- path.forEach((key) => {
- if (value) { value = value[key]; }
- });
-
- if (fieldObj._data !== value) {
- fieldObj._data = value;
- }
- });
- }
-
- /**
- * Sets the data for the current field.
- * @param {Object|string|number} data Data to be set on the field
- * @return {external:Promise} A promise object which is resolved when data is set for a field. Note: The data set by this function will only be saved when user saves the entry.
- */
-
- setData(data) {
- const currentFieldObj = this;
- const dataObj = { data, uid: currentFieldObj.uid, self: currentFieldObj._self };
-
- if (!currentFieldObj._self &&
- ((excludedDataTypesForSetField.indexOf(currentFieldObj.data_type) !== -1) ||
- !currentFieldObj.data_type)) { return Promise.reject(new Error('Cannot call set data for current field type')); }
-
- return this._connection.sendToParent('setData', dataObj).then(() => {
- this._data = data;
- return Promise.resolve(currentFieldObj);
- }).catch(e => Promise.reject(e));
- }
-
- /**
- * Gets the data of the current field
- * @param {Object} options Options object for get Data method.
- * @param {boolean} options.resolved If the resolved parameter is set to true for the File field, then the method will return a resolved asset object along with all the field metadata, e.g. 'field.getData({resolved:true})'.
- * @return {Object|string|number} Returns the field data.
- */
- getData({ resolved = false } = {}) {
- return resolved ? this._resolvedData : this._data;
- }
-
- /**
- * Sets the focus for a field when an extension is being used. This method shows user presence and highlights the extension field that the user is currently accessing in Contentstack UI.
- * @return {Object} A promise object which is resolved when Contentstack UI returns an acknowledgement of the focused state.
- */
- setFocus() {
- return this._connection.sendToParent('focus');
- }
-
- /**
- * This function is called when another extension programmatically changes data of this field using field.setData() function, only available for extension field, only support extensions of data type text, number, boolean or date.
- * @param {function} callback The function to be called when an entry is published.
- */
- onChange(callback) {
- const fieldObj = this;
- if (callback && typeof (callback) === 'function') {
- fieldObj._emitter.on('extensionFieldChange', (event) => {
- this._data = event.data;
- this._resolvedData = event.data;
- callback(event.data);
- });
- } else {
- throw Error('Callback must be a function');
- }
- }
-}
-
-export default Field;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| entry.js | -
-
- |
- 100% | -73/73 | -100% | -42/42 | -100% | -16/16 | -100% | -70/70 | -
| extension.js | -
-
- |
- 100% | -32/32 | -100% | -22/22 | -100% | -4/4 | -100% | -32/32 | -
| field.js | -
-
- |
- 100% | -48/48 | -100% | -31/31 | -100% | -12/12 | -100% | -47/47 | -
| index.js | -
-
- |
- 100% | -8/8 | -100% | -2/2 | -100% | -4/4 | -100% | -7/7 | -
| store.js | -
-
- |
- 100% | -18/18 | -100% | -14/14 | -100% | -12/12 | -100% | -16/16 | -
| window.js | -
-
- |
- 100% | -39/39 | -100% | -26/26 | -100% | -7/7 | -100% | -37/37 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 | - - - -3x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -3x -2x -1x -1x -1x - - - - - - - - -1x - - - - - | import Extension from './extension.js';
-import postRobot from 'post-robot';
-import { version } from '../package.json';
-
-postRobot.CONFIG.LOG_LEVEL = 'error';
-
-/** Class to initialize the plugin on Contentstack UI. */
-/**
- * @hideconstructor
- */
-
-class ContentstackUIExtension {
- /**
- * You need to first include Contentstack UI Extensions SDK and
- * Contentstack UI Stylesheet in you HTML file and then call
- * ContentstackUIExtension.init in the script tag.
- * @example
- * HTML
- * <script src="https://www.contentstack.com/sdks/contentstack-ui-extensions/2.2.0/ui-extension-sdk.js"></script>
- * <link href="https://www.contentstack.com/sdks/contentstack-ui-extensions/2.2.0/ui-extension-sdk.css" rel="stylesheet" >
- * @example <caption>Custom Field</caption>
- * // javascript
- * ContentstackUIExtension.init().then(function (extension) {
- * var value = extension.field.getData()
- * extension.field.setData("New Field Data")
- * })
- * @example <caption>Custom Widget</caption>
- * // javascript
- * ContentstackUIExtension.init().then(function (extension) {
- * var entry = extension.entry.getData()
- * })
- * @example <caption>Dashboard Widget</caption>
- * // javascript
- * ContentstackUIExtension.init().then(function (extension) {
- * var stack = extension.stack;
- * var stackData = stack.getData();
- * })
- * @return {external:Promise} A promise object which will be resolved with an instance of the {@link Extension} class which is instantiated using the data received from the Contentstack UI.
- */
- static init() {
- if (this._extension) { return Promise.resolve(this._extension); }
- return Extension.initialize(version).then((initializationData) => {
- this._extension = new Extension(initializationData);
- return Promise.resolve(this._extension);
- }).catch((e) => Promise.reject(e));
- }
-
-
- /**
- * Version of Contentstack UI extension.
- * @type {string}
- */
- static get SDK_VERSION() {
- return version;
- }
-}
-
-export default ContentstackUIExtension;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| File | -- | Statements | -- | Branches | -- | Functions | -- | Lines | -- |
|---|---|---|---|---|---|---|---|---|---|
| index.js | -
-
- |
- 100% | -27/27 | -100% | -19/19 | -100% | -11/11 | -100% | -26/26 | -
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 | - - -1x - - - - - - - - - - - -3x -2x - - - -1x - - - - -11x -11x -11x -11x - - - - - - - - - - - - - - -3x -3x - - -3x - - - -8x - - - -13x - - - - - - - - - - -1x - - - - - - - - - - -3x -1x - -2x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x -1x - -1x - - - - - - - - - - - - - - - - - - - - - - - -2x -1x - -1x - - - - -96x -96x - -11x - - - - | import Base from '../base.js';
-import { getReferences, language, environment } from '../../utils.js';
-
-let connection = {};
-
-/**
- * @summary Creates an instance of `Asset`.
- * @description An initializer is responsible for creating an Asset object.
- * @param {String} uid - uid of the asset
- * @example
- * let Asset = extension.stack.Asset('bltsomething123');
- * @returns {Asset}
- * @ignore
- */
-function onData(data) {
- if (typeof (data.data) === 'string') { return Promise.reject(data.data); }
- return Promise.resolve(data.data);
-}
-
-function onError(error) {
- return Promise.reject(error);
-}
-
-class Asset extends Base {
- constructor(uid) {
- super(uid);
- this.getReferences = getReferences;
- this.environment = environment;
- return this;
- }
-
- /**
- * @function
- * @name Stack#Asset.Query
- * @description This static method instantiates the query module for assets. To see the list of methods that can be used for querying assets, refer the {@link Query} module.
- * @example
- * let assetQuery = extension.stack.Asset.Query();
- * assetQuery.where("title": "main.js").limit(10).skip(10).find().then(...).catch(...);
- * @return {Query}
- */
-
-
- static Query() {
- const entryQuery = super.Query();
- Object.assign(entryQuery, {
- language, environment
- });
- return entryQuery;
- }
-
- static module(plural = false) {
- return plural ? 'Assets' : 'Asset';
- }
-
- static get connection() {
- return connection;
- }
-
- /**
- * @function
- * @name Stack#Asset.getRteAssets
- * @description This static method retrieves comprehensive information on all assets uploaded through the Rich Text Editor field.
- * @return {external:Promise}
- */
-
- static getRteAssets() {
- return this.connection.sendToParent('stackQuery', { action: 'getRteAssets' }).then(onData).catch(onError);
- }
-
- /**
- * @function
- * @name Stack#Asset.getAssetsOfSpecificTypes
- * @description This static method retrieves assets that are either image or video files, based on the request query.
- * @param {String} assetType Type of asset to be received for e.g., ‘image/png’
- * @return {external:Promise}
- */
- static getAssetsOfSpecificTypes(assetType) {
- if (!assetType || typeof assetType !== 'string') {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- return this.connection.sendToParent('stackQuery', { action: 'getAssetsOfSpecificTypes', asset_type: assetType }).then(onData).catch(onError);
- }
-
-
- /**
- * @name Stack#Asset#only
- * @function
- * @description This method is used to show the selected fields of the assets in the result set.
- * @param {String} [key=BASE] - Single field of an asset
- * @param {Array} values - Array of fields to be shown in the result set
- * @example
- * <caption> Only with the field UID </caption>
- * extension.stack.Asset('bltsomething123').only('title').fetch();
- * @example
- * <caption> Only with the field UID </caption>
- * extension.stack.Asset('bltsomething123').only('BASE','title').fetch();
- * @example
- * <caption> Only with the field UIDs(array) </caption>
- * extension.stack.Asset('bltsomething123').only(['title','description']).fetch();
- * @returns {Stack#Asset}
- */
-
- /**
- * @name Stack#Asset#except
- * @function
- * @description This method is used to hide the selected fields of the assets in result set.
- * @param {String} [key=BASE] - Single field of an asset
- * @param {Array} values - Array of fields to be hidden in the result set
- * @example
- * <caption> .Except with the field UID </caption>
- * extension.stack.Asset('bltsomething123').except('title').fetch();
- * @example
- * <caption> .Except with the field UID </caption>
- * extension.stack.Asset('bltsomething123').except('BASE','title').fetch();
- * @example
- * <caption> .Except with the field UIDs(array) </caption>
- * extension.stack.Asset('bltsomething123').except(['title','description']).fetch();
- * @returns {Stack#Asset}
- */
-
- /**
- * @function
- * @name Stack#Asset#environment
- * @description This method is used to set the environment name of which you want to retrieve the data.
- * @param {String} environment_uid - UID/Name of environment
- * @example extension.stack.Asset('bltsomething123').environment('development').fetch()
- * @returns {Stack#Asset}
- */
-
-
- /**
- This method includes a query parameter in your query.
- @name Stack#Asset#addParam
- @function
- @example extension.stack.Asset('uid').addParam('key', 'value').fetch().then().catch();
- @param {string} key - Key of the parammeter
- @param {string} value - Value of the parammeter
- @return {Stack#Asset}
- */
-
- /**
- This method includes a query parameter in your query.
- @name Stack#Asset#addQuery
- @function
- @example extension.stack.Asset('uid').addQuery('key', 'value').fetch().then().catch();
- @param {string} key - Key of the parammeter
- @param {string} value - Value of the parammeter
- @return {Stack#Asset}
- */
-
-
- /**
- This method will fetch the details of the entries and the assets in which the specified asset is referenced.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#get-all-references-of-asset|
- Asset References}
- @name Stack#Asset#getReferences
- @function
- @example extension.stack.Asset('uid').getReferences().then().catch();
- @return {external:Promise}
- */
-
- /**
- This method deletes an existing asset.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#delete-an-asset|
- Delete Asset}
- @name Stack#Asset#delete
- @function
- @example extension.stack.Asset('uid').delete().then().catch();
- @return {external:Promise}
- */
-
-
- /**
- * @name Stack#Asset#publish
- * @function
- * @description This method allows you to publish the asset either immediately or schedule the publish for a later date/time.
- * @param {object} payload - Payload for the request.
- * @example extension.stack.Asset('bltsomething123')
- .publish(
- {
- "asset": {
- "locales": [
- "en-us"
- ],
- "environments": [
- "development"
- ]
- },
- "version": 1,
- "scheduled_at": "2019-02-08T18:30:00.000Z"
- });
- * @return {external:Promise}
- */
- publish(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- return this.fetch('publishAsset', payload);
- }
-
- /**
- * @function
- * @name Stack#Asset#unpublish
- * @description This method will instantly unpublish the asset, and also give you the provision to automatically unpublish the asset at a later date/time.
- * @param {object} payload - Payload for the request.
- * @example extension.stack.Asset('bltsomething123')
- .unpublish({
- "asset": {
- "locales": [
- "en-us"
- ],
- "environments": [
- "development"
- ]
- },
- "version": 1,
- "scheduled_at": "2019-02-08T18:30:00.000Z"
- });
- * @return {external:Promise}
- */
- unpublish(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- return this.fetch('unpublishAsset', payload);
- }
-}
-
-export default (uiConnection) => {
- connection = uiConnection;
- return new Proxy(Asset, {
- apply(Target, thisArg, argumentsList) {
- return new Target(...argumentsList);
- }
- });
-};
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 | - - - - -18x -16x - - - -2x - - - - - - - - -73x -72x -72x -72x -72x -72x - - - -18x - - - - -1x -1x - - - -2x -1x - -1x - - - -1x - - - -17x - - - - - - - -17x -17x -17x - - - - | import Query from './query.js';
-import { transform, addParam } from '../utils.js';
-
-
-function onData(data) {
- if (typeof (data.data) === 'string') { return Promise.reject(data.data); }
- return Promise.resolve(data.data);
-}
-
-function onError(error) {
- return Promise.reject(error);
-}
-/**
- * This is Base class, it holds all the methods required for Modle instance,
- * eg ContentType('uid').delete() or Asset('uid').update({...})
- * @ignore
- */
-export default class Base {
- constructor(uid) {
- if (!uid) { throw new Error('uid is required'); }
- this.uid = uid;
- this._query = {};
- this.only = transform('only');
- this.except = transform('except');
- this.addParam = addParam;
- }
-
- static Query() {
- return new Query(this.connection, this.module(true), this.contentTypeUid);
- }
-
-
- static create(payload) {
- const options = { payload, content_type_uid: this.contentTypeUid, action: `create${this.module()}` };
- return this.connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- update(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- return this.fetch(`update${this.constructor.module()}`, payload);
- }
-
- delete() {
- return this.fetch(`delete${this.constructor.module()}`);
- }
-
- fetch(action, payload) {
- const options = {
- payload,
- content_type_uid: this.constructor.contentTypeUid,
- uid: this.uid,
- params: this._query,
- action: action || `get${this.constructor.module()}`
- };
-
- if (!payload) { delete options.payload; }
- if (!this.constructor.contentTypeUid) { delete options.content_type_uid; }
- return this.constructor.connection.sendToParent('stackQuery', options)
- .then(onData).catch(onError);
- }
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 -247 -248 -249 -250 -251 -252 -253 -254 -255 -256 -257 -258 -259 -260 -261 -262 -263 -264 -265 -266 -267 -268 -269 -270 -271 -272 -273 -274 -275 -276 -277 -278 -279 -280 -281 -282 -283 -284 -285 -286 -287 -288 -289 -290 -291 -292 -293 -294 -295 -296 -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 -314 -315 -316 -317 -318 -319 -320 -321 -322 -323 -324 -325 -326 -327 -328 -329 -330 -331 -332 -333 -334 -335 -336 -337 -338 -339 -340 -341 -342 -343 -344 -345 -346 -347 -348 -349 -350 -351 -352 -353 -354 -355 -356 -357 -358 -359 -360 -361 -362 -363 -364 -365 -366 -367 -368 -369 -370 -371 -372 -373 | - - -1x -1x - - - - -23x -22x -22x - - - - - - - - - - - - - -15x -15x - - -15x - - - -26x - - - -36x - - - -20x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -1x - - - - - - - - - - - -2x -1x - -1x -1x - - - - - - - - - - - - - - - - - - - -2x -1x - -1x -1x - - - - - - - - - - - - - - - - - - - -2x -1x - -1x -1x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -2x -1x - -1x - - - - - - - - - - - - - - - - - - - - -2x -1x - -1x -1x - - - - -39x -39x -39x - -23x -22x - - -22x - - - - | import Base from '../base.js';
-import { getReferences, addQuery, language, environment, includeOwner, includeContentType, includeSchema, includeReference } from '../../utils.js';
-
-let connection = {};
-let contentTypeUid = '';
-
-
-class Entry extends Base {
- constructor(uid) {
- super(uid);
- this._query = {};
- return this;
- }
-
- /**
- * @function
- * @name Stack#ContentType#Entry.Query
- * @description This static method instantiates the query module for entries. To see the list of methods that can be used for querying entries, refer the {@link Query} module.
- * @example
- * let entryQuery = extension.stack.ContentType('content_type_uid').Entry.Query();
- * entryQuery.where("field_uid": "10").limit(10).skip(10).find().then(...).catch(...);
- * @return {Query}
- */
-
- static Query() {
- const entryQuery = super.Query();
- Object.assign(entryQuery, {
- language, environment, includeOwner, includeContentType, includeSchema, includeReference
- });
- return entryQuery;
- }
-
- static get connection() {
- return connection;
- }
-
- static get contentTypeUid() {
- return contentTypeUid;
- }
-
- static module(plural = false) {
- return plural ? 'Entries' : 'Entry';
- }
- /**
- This method creates a new entry.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#create-a-an-entry|
- Create Entry}
- @name Stack#ContentType#Entry.create
- @function
- @example extension.stack.ContentType('content_type_uid').Entry.create({
- "entry": {
- "title": "example",
- "url": "/example"
- }
- }).then(...).catch(...);
- @param {Object} payload Data to create an entry
- @return {external:Promise}
- Required data if resolved successfully
- */
-
- /**
- * @name Stack#ContentType#Entry#only
- * @function
- * @description This method is used to show the selected fields of an entry in the result set.
- * @param {String} [key=BASE] - Single field of an entry
- * @param {Array} values - Array of fields to be shown in the result set
- * @example
- * <caption> Only with field UID </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').only('title').fetch();
- * @example
- * <caption> Only with field UID </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').only('BASE','title').fetch();
- * @example
- * <caption> Only with field UIDs(array) </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').only(['title','description']).fetch();
- * @returns {Stack#ContentType#Entry}
- */
-
- /**
- * @name Stack#ContentType#Entry#except
- * @function
- * @description This method is used to hide the selected fields of an entry in the result set.
- * @param {String} [key=BASE] - Single field of an entry
- * @param {Array} values - Array of fields to be hidden in the result set
- * @example
- * <caption> Except with field uid </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').except('title').fetch();
- * @example
- * <caption> Except with field uid </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').except('BASE','title').fetch();
- * @example
- * <caption> Except with field uids(array) </caption>
- * extension.stack.ContentType('content_type_uid').Entry('bltsomething123').except(['title','description']).fetch();
- * @returns {Stack#ContentType#Entry}
- */
-
- /**
- * This method includes a query parameter in your query.
- * @name Stack#ContentType#Entry#addParam
- * @function
- * @example extension.stack.ContentType('content_type_uid').Entry('uid').addParam('include_count', 'true').fetch().then().catch();
- * @param {string} key - Key of the parameter
- * @param {string} value - Value of the parameter
- * @return {Stack#ContentType#Entry} Returns
- */
-
-
- /**
- This method will fetch all the entries in which the current entry is referenced.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#get-all-references-of-an-entry|
- Entry References}
- @name Stack#ContentType#Entry#getReferences
- @function
- @example extension.stack.ContentType('content_type_uid').Entry('uid').getReferences().then().catch();
- @return {external:Promise}
- Required data if resolved successfully
- */
-
-
- /**
- @example extension.stack.ContentType('content_type_uid').Entry('uid').update({"entry" : {...}}).then().catch();
- @param {Object} payload Data to be update exsisting entry
- @return {external:Promise}
- Required data if resolved successfully
- */
-
-
- /**
- This method deletes an existing entry.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#delete-an-entry|
- Delete Entry}
- @name Stack#ContentType#Entry#delete
- @function
- @example extension.stack.ContentType('content_type_uid').Entry('uid').delete().then().catch();
- @return {external:Promise}
- Required data if resolved successfully
- */
-
-
- /**
- This method fetches information of a specific entry.
- @see {@link
- https://www.contentstack.com/docs/apis/content-management-api/#get-a-single-an-entry|
- Get A Single Entry}
- @name Stack#ContentType#Entry#fetch
- @function
- @example extension.stack.ContentType('content_type_uid').Entry('uid').fetch().then().catch();
- @return {external:Promise}
- Required data if resolved successfully
- */
-
- /**
- * @function
- * @name Stack#ContentType#Entry#includeReference
- * @description This method is used to include referenced entries from other content types.
- * @example
- * <caption> .includeReference with reference_field_uids as array </caption>
- * stack.ContentType('contenttype_uid').Entry('bltsomething123').includeReference(['category', 'author']).fetch()
- * @example
- * <caption> .includeReference with reference_field_uids </caption>
- * stack.ContentType('contenttype_uid').Entry('bltsomething123').includeReference('category', 'author').fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#language
- * @description This method is used to set the language code of which you want to retrieve the data.
- * @param {String} languageCode - Language code, for e.g. 'en-us', 'ja-jp', and so on
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').language('en-us').fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
- /**
- * @function
- * @name Stack#ContentType#Entry#environment
- * @description This method is used to set the environment name of which you want to retrieve the data.
- * @param {String} environment_uid - UID/Name of environment
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').environment('development').fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#addQuery
- * @description This method is used to add a query to an entry object.
- * @param {String} key - Key of the query
- * @param {String} value - Value of the query
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').addQuery('include_schema',true).fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#includeSchema
- * @description This method is used to include the schema of the current contenttype in result set along with the entry/entries.
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').includeSchema().fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#includeContentType
- * @description This method is used to include the current content type in the result set along with the entry(ies).
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').includeContentType().fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#includeOwner
- * @description This method is used to include the owner of the entry(ies) in the result set.
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').includeOwner().fetch()
- * @returns {Stack#ContentType#Entry}
- */
-
-
- /**
- * @function
- * @name Stack#ContentType#Entry#getLanguages
- * @description This method returns the details of all the languages that an entry is localized in.
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').getLanguages()
- * @return {external:Promise}
- */
- getLanguages() {
- return this.fetch('getEntryLanguages');
- }
-
- /**
- * @function
- * @name Stack#ContentType#Entry#unlocalize
- * @description This method is used to unlocalize an entry
- * @param {string} locale Locale in which the entry has to be unlocalized
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').unlocalize('fr-fr').then(...).catch(...);
- * @return {external:Promise}
- */
- unlocalize(locale) {
- if (!locale || typeof locale !== 'string') {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- this._query.locale = locale;
- return this.fetch('unlocalizeEntry');
- }
-
- /**
- * @function
- * @name Stack#ContentType#Entry#publish
- * @description This method lets you publish an entry either immediately or schedule it to be published automatically at a later date/time.
- * @param {object} payload - Payload for the request
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').publish({
- "entry": {
- "environments": ["development"],
- "locales": ["en-us"]
- },
- "locale": "en-us",
- "version": 1,
- "scheduled_at": "2019-02-14T18:30:00.000Z"
- }).then(...).catch(...);
- * @return {external:Promise}
- */
- publish(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- this._query = {};
- return this.fetch('publishEntry', payload);
- }
-
- /**
- * @function
- * @name Stack#ContentType#Entry#unpublish
- * @description This method lets you publish an entry either immediately or schedule it to be published automatically at a later date/time.
- * @param {object} payload - Payload for the request
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').unpublish({
- "entry": {
- "environments": ["development"],
- "locales": ["en-us"]
- },
- "locale": "en-us",
- "version": 1,
- "scheduled_at": "2019-02-14T18:30:00.000Z"
- }).then(...).catch(...);
- * @return {external:Promise}
- */
- unpublish(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- this._query = {};
- return this.fetch('unpublishEntry', payload);
- }
-
- /**
- * @function
- * @name Stack#ContentType#Entry#setWorkflowStage
- * @description This method allows you to either set a particular workflow stage or update the workflow stage details of an entry.
- * @param {object} payload - Payload for the request
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').setWorkflowStage({
- "workflow": {
- "workflow_stage": {
- "comment": "Test Comment",
- "due_date": "Thu Dec 01 2018",
- "notify": false,
- "uid": "blt9f52a2cd5e0014fb",
- "assigned_to": [{
- "uid": "blt296a22e28cc0c63c",
- "name": "John Doe",
- "email": "john.doe@contentstack.com"
- }],
- "assigned_by_roles": [{
- "uid": "blt5b74c24c7ae25d94",
- "name": "Content Manager"
- }]
- }
- }
- }).then(...).catch(...);
- * @return {external:Promise}
- */
- setWorkflowStage(payload) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- return this.fetch('setWorkflowStageEntry', payload);
- }
-
- /**
- * @see {@link https://www.contentstack.com/docs/apis/content-management-api/#update-an-entry| Update Entry}
- * @name Stack#ContentType#Entry#update
- * @function
- * @description This call allows you to update entry content.
- * @param {object} payload - Payload for the request
- * @param {string} [locale] - Passing the ‘locale’ parameter will localize the entry in the specified locale
- * to be localized in the specified locale.
- * @example extension.stack.ContentType('contenttype_uid').Entry('bltsomething123').update(
- {
- "entry": {
- "title": "example",
- "url": "/example"
- }
- }).then(...).catch(...);
- * @return {external:Promise}
- */
- update(payload, locale) {
- if (!payload || (typeof payload !== 'object') || (payload instanceof Array)) {
- return Promise.reject(new Error('Kindly provide valid parameters'));
- }
- this._query.locale = locale;
- return this.fetch('updateEntry', payload);
- }
-}
-
-export default (uiConnection, contentType) => {
- connection = uiConnection;
- contentTypeUid = contentType;
- return new Proxy(Entry, {
- apply(Target, thisArg, argumentsList) {
- const entryTarget = new Target(...argumentsList);
- Object.assign(entryTarget, {
- getReferences, addQuery, language, environment, includeOwner, includeContentType, includeSchema, includeReference
- });
- return entryTarget;
- }
- });
-};
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 | - - -1x - - - - -39x - - - - - - - - - - -39x -39x - - - - - - -39x - - - -96x -96x - - -39x - - - - | import Entry from './entry.js';
-import Base from '../base.js';
-
-let connection = {};
-
-
-class ContentType extends Base {
- constructor(uid) {
- super(uid);
- /**
- * @constructor
- * @hideconstructor
- * @name Stack#ContentType#Entry
- * @version 2.2.0
- * @desc An entry is the actual piece of content created using one of the defined content types
- * @see {@link https://www.contentstack.com/docs/apis/content-management-api/#entries| Entries}
- */
-
-
- this.Entry = Entry(this.constructor.connection, this.uid);
- return this;
- }
-
- // static module(plural = false) {
- // return plural ? 'ContentTypes' : 'ContentType';
- // }
- static get connection() {
- return connection;
- }
-}
-export default (uiConnection) => {
- connection = uiConnection;
- return new Proxy(ContentType, {
- // target = Foo
- apply(Target, thisArg, argumentsList) {
- return new Target(...argumentsList);
- }
- });
-};
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 -247 -248 -249 -250 -251 -252 -253 -254 -255 -256 -257 -258 -259 -260 -261 -262 -263 -264 -265 -266 -267 -268 -269 -270 -271 -272 -273 -274 -275 -276 -277 -278 -279 -280 -281 -282 -283 -284 -285 -286 -287 -288 -289 -290 -291 -292 -293 -294 -295 -296 -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 -314 -315 -316 -317 -318 -319 -320 -321 -322 -323 -324 -325 -326 -327 -328 -329 -330 -331 -332 -333 -334 -335 -336 -337 -338 -339 -340 -341 -342 -343 -344 -345 -346 -347 -348 -349 -350 -351 -352 -353 -354 -355 -356 -357 -358 -359 -360 -361 -362 -363 -364 -365 -366 -367 -368 -369 -370 -371 -372 -373 -374 -375 -376 -377 -378 -379 -380 -381 -382 -383 -384 -385 -386 -387 -388 -389 -390 -391 -392 -393 -394 -395 -396 -397 -398 -399 -400 -401 -402 -403 -404 -405 -406 -407 -408 -409 -410 -411 -412 -413 -414 -415 -416 -417 -418 -419 -420 -421 -422 -423 -424 -425 -426 -427 -428 -429 -430 -431 -432 -433 -434 -435 -436 -437 -438 -439 -440 -441 -442 -443 -444 -445 -446 -447 -448 -449 -450 -451 -452 -453 -454 -455 -456 -457 -458 -459 -460 -461 -462 -463 -464 -465 -466 -467 -468 -469 -470 -471 -472 -473 -474 -475 -476 -477 -478 -479 -480 -481 -482 -483 -484 -485 -486 -487 -488 -489 -490 -491 -492 -493 -494 -495 -496 -497 -498 -499 -500 -501 -502 -503 -504 -505 -506 -507 -508 -509 -510 -511 -512 -513 -514 -515 -516 -517 -518 -519 -520 -521 -522 -523 -524 -525 -526 -527 -528 -529 -530 -531 -532 -533 -534 -535 -536 -537 -538 -539 -540 -541 -542 -543 -544 -545 -546 -547 -548 -549 -550 -551 -552 -553 -554 | - - - -9x -8x - - - -1x - - -1x - -90x -37x -32x -32x -32x - -5x - - - -36x -36x -14x -12x -12x -12x -12x - -2x - - - -36x -7x -6x -6x -6x - -1x - - - -36x -17x -17x -18x -4x -14x -12x - - -17x -1x - -16x - -17x - - - -72x -28x -24x -24x - -4x - - - -36x -14x -12x -12x - -2x - - - - - - - - - - - -18x -18x -18x -18x -18x - - - - - - - - - - - - - - - - - - -18x - - - - - - - - - - - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - - - - - - - - - - - -18x - - - - - - - - - - - - - - - - - - -18x - - - - - - - - - -18x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -7x -6x - -6x - -1x - - - -9x -8x -8x - -1x - - - - - - - - -2x -2x -2x - - - - - - - - -7x -6x -6x - -1x - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - -6x -6x - - - - - - - - - -15x - - - - - - - - - - - - - - - - -8x -7x - - -7x -7x - -1x - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - -3x -3x - - - - - - - - -4x -4x -4x -4x - - - - - | import * as Utils from '../utils.js';
-
-
-function onData(data) {
- if (typeof (data.data) === 'string') { return Promise.reject(data.data); }
- return Promise.resolve(data.data);
-}
-
-function onError(error) {
- return Promise.reject(error);
-}
-
-const _extend = {
- compare(type) {
- return function (key, value) {
- if (key && value && typeof key === 'string' && typeof value !== 'undefined') {
- this._query.query[key] = this._query.query.file_size || {};
- this._query.query[key][type] = value;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- };
- },
- contained(bool) {
- const type = (bool) ? '$in' : '$nin';
- return function (key, value) {
- if (key && value && typeof key === 'string' && Array.isArray(value)) {
- this._query.query[key] = this._query.query[key] || {};
- this._query.query[key][type] = this._query.query[key][type] || [];
- this._query.query[key][type] = this._query.query[key][type].concat(value);
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- };
- },
- exists(bool) {
- return function (key) {
- if (key && typeof key === 'string') {
- this._query.query[key] = this._query.query[key] || {};
- this._query.query[key].$exists = bool;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- };
- },
- logical(type) {
- return function () {
- const _query = [];
- for (let i = 0, _i = arguments.length; i < _i; i += 1) {
- if (arguments[i] instanceof Query && arguments[i]._query.query) {
- _query.push(arguments[i]._query.query);
- } else if (typeof arguments[i] === 'object') {
- _query.push(arguments[i]);
- }
- }
- if (this._query.query[type]) {
- this._query.query[type] = this._query.query[type].concat(_query);
- } else {
- this._query.query[type] = _query;
- }
- return this;
- };
- },
- sort(type) {
- return function (key) {
- if (key && typeof key === 'string') {
- this._query[type] = key;
- return this;
- }
- throw Error('Argument should be a string.');
- };
- },
- pagination(type) {
- return function (value) {
- if (typeof value === 'number') {
- this._query[type] = value;
- return this;
- }
- throw Error('Argument should be a number.');
- };
- }
-};
-
-/**
- * Creates an instance of the query
- * @version 2.2.0
- * @hideconstructor
- */
-class Query {
- constructor(connection, module, contentTypeUid) {
- this.module = module;
- this._connection = connection;
- this._query = {};
- this._query.query = this._query.query || {};
- this.contentTypeUid = contentTypeUid;
- /**
- * @name Query#only
- * @function
- * @description This method is used to show the selected fields of an entry in the result set.
- * @param {String} [key=BASE] - Single field of an entry
- * @param {Array} values - Array of fields to be shown in the result set
- * @example
- * <caption> Only with field UID </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().only('title').find();
- * @example
- * <caption> Only with field UID </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().only('BASE','title').find();
- * @example
- * <caption> Only with field UIDs(array) </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().only(['title','description']).find();
- * @returns {Query}
- */
-
- this.only = Utils.transform('only');
-
- /**
- * @name Query#except
- * @function
- * @description This method is used to hide the selected fields of an entry in the result set.
- * @param {String} [key=BASE] - Single field of an entry
- * @param {Array} values - Array of fields to be hidden in the result set
- * @example
- * <caption> Except with field uid </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().except('title').find();
- * @example
- * <caption> Except with field uid </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().except('BASE','title').find();
- * @example
- * <caption> Except with field uids(array) </caption>
- * extension.stack.ContentType('content_type_uid').Entry.Query().except(['title','description']).find();
- * @returns {Query}
- */
-
- this.except = Utils.transform('except');
- /**
- This method includes a query parameter in your query.
- @name Query#addQuery
- @function
- @example extension.stack.ContentType('content_type_uid').Entry.Query().addQuery('key', 'value').find().then().catch();
- @param {string} key - Key of the parammeter
- @param {string} value - Value of the parammeter
- @return {Query}
- */
- this.addQuery = Utils.addQuery;
-
- /**
- * @name Query#lessThan
- * @description This method provides only the entries with values less than the specified value for a field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').lessThan('created_at','2015-06-22')
- * @returns {Query}
- */
- this.lessThan = _extend.compare('$lt');
-
- /**
- * @name Query#lessThanOrEqualTo
- * @description This method provides only the entries with values less than or equal to the specified value for a field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').lessThanOrEqualTo('created_at','2015-03-12')
- * @returns {Query}
- */
- this.lessThanOrEqualTo = _extend.compare('$lte');
- /**
- * @function
- * @name Query#greaterThan
- * @description This method provides only the entrieswith values
- * greater than the specified value for a field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').greaterThan('created_at','2015-03-12')
- * @returns {Query}
- */
- this.greaterThan = _extend.compare('$gt');
-
- /**
- * @function
- * @name Query#greaterThanOrEqualTo
- * @description This method provides only the entries with values greater than or equal to the specified value for a field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').greaterThanOrEqualTo('created_at', '2015-06-22')
- * @returns {Query}
- */
- this.greaterThanOrEqualTo = _extend.compare('$gte');
-
- /**
- * @function
- * @name Query#notEqualTo
- * @description This method provides only the entries with values not equal to the specified value for a field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').notEqualTo('title','Demo')
- * @returns {Query}
- */
- this.notEqualTo = _extend.compare('$ne');
-
- /**
- * @function
- * @name Query#containedIn
- * @description This method provides only the entries with values matching the specified values for a field.
- * @param {String} key - UID of the field
- * @param {*} value - An array of values that are to be used to match or compare
- * @example extension.stack.ContentType('blog').containedIn('title', ['Demo', 'Welcome'])
- * @returns {Query}
- */
- this.containedIn = _extend.contained(true);
-
- /**
- * @function
- * @name Query#notContainedIn
- * @description This method provides only the entries that do not contain values matching the specified values for a field.
- * @param {String} key - UID of the field
- * @param {Array} value - An array of values that are to be used to match or compare
- * @example extension.stack.ContentType('blog').notContainedIn('title', ['Demo', 'Welcome'])
- * @returns {Query}
- */
- this.notContainedIn = _extend.contained(false);
-
- /**
- * @function
- * @name Query#exists
- * @description This method provides only the entries that contains the field matching the specified field UID.
- * @param {String} key - UID of the field
- * @example extension.stack.ContentType('blog').exists('featured')
- * @returns {Query}
- */
- this.exists = _extend.exists(true);
-
- /**
- * @function
- * @name Query#notExists
- * @description This method provides only the entries that do not contain the field matching the specified field UID.
- * @param {String} key - UID of the field
- * @example extension.stack.ContentType('blog').notExists('featured')
- * @returns {Query}
- */
- this.notExists = _extend.exists(false);
-
- /**
- * @function
- * @name Query#ascending
- * @description This parameter sorts the entries in ascending order on the basis of the value of the specified field.
- * @param {String} key - Field UID to be used for sorting.
- * @example extension.stack.ContentType('blog').ascending('created_at')
- * @returns {Query}
- */
- this.ascending = _extend.sort('asc');
-
- /**
- * @function
- * @name Query#descending
- * @description This method sorts the entries in descending order on the basis of the specified field.
- * @param {String} key - Field UID to be used for sorting
- * @example extension.stack.ContentType('blog').descending('created_at')
- * @returns {Query}
- */
- this.descending = _extend.sort('desc');
-
- /**
- * @function
- * @name Query#beforeUid
- * @description This method provides only the entries that are placed before the specified entry ID.
- * @param {String} uid - UID of the entry
- * @example extension.stack.ContentType('blog').beforeUid('blt1234567890abcdef')
- * @returns {Query}
- * @ignore
- */
- this.beforeUid = _extend.sort('before_uid');
-
- /**
- * @function
- * @name Query#afterUid
- * @description This method provides only the entries that are placed after the specified entry ID.
- * @param {String} uid - UID of the entry
- * @example extension.stack.ContentType('blog').afterUid('blt1234567890abcdef')
- * @returns {Query}
- * @ignore
- */
- this.afterUid = _extend.sort('after_uid');
-
- /**
- * @function
- * @name Query#skip
- * @description This method skips the specified number of entries.
- * @param {Number} skip - Number of entries to be skipped
- * @example extension.stack.ContentType('blog').skip(5)
- * @returns {Query}
- */
- this.skip = _extend.pagination('skip');
-
- /**
- * @function
- * @name Query#limit
- * @description This method limits the response by providing only the specified number of entries.
- * @param {Number} limit - Maximum number of entries to be returned in the result.
- * @example extension.stack.ContentType('blog').limit(10)
- * @returns {Query}
- */
- this.limit = _extend.pagination('limit');
-
- /**
- * @function
- * @name Query#or
- * @description This method performs the OR operation on the specified query objects and provides only the matching entries.
- * @param {object} Array of query objects/raw queries
- * to be taken into consideration
- * @example
- * <caption> OR with query instances</caption>
- * let Query1 = extension.stack.ContentType('blog').Entry.Query().where('title', 'Demo')
- * let Query2 = extension.stack.ContentType('blog').Entry.Query().lessThan('comments', 10)
- * let blogQuery = extension.stack.ContentType('blog').or(Query1, Query2)
- * @example
- * <caption> OR with query instances</caption>
- * let Query1 = extension.stack.ContentType('blog').Entry.Query().where('title', 'Demo').getQuery()
- * let Query2 = extension.stack.ContentType('blog').Entry.Query().lessThan('comments', 10).getQuery()
- * let blogQuery = extension.stack.ContentType('blog').or(Query1, Query2)
- * @returns {Query}
- */
- this.or = _extend.logical('$or');
-
- /**
- * @function
- * @name Query#and
- * @description This method performs the AND operation on the specified query objects and provides only the matching entries.
- * @param {object} Array of query objects/raw queries to be taken into consideration
- * @example
- * <caption> AND with raw queries</caption>
- * let Query1 = extension.stack.ContentType('blog').Entry.Query().where('title', 'Demo');
- * let Query2 = extension.stack.ContentType('blog').Entry.Query().lessThan('comments', 10);
- * let blogQuery = extension.stack.ContentType('blog').and(Query1, Query2)
- * @example
- * <caption> .and with raw queries</caption>
- * let Query1 = extension.stack.ContentType('blog').Entry.Query().where('title', 'Demo').getQuery();
- * let Query2 = extension.stack.ContentType('blog').Entry.Query().lessThan('comments', 10).getQuery();
- * let blogQuery = extension.stack.ContentType('blog').and(Query1, Query2)
- * @returns {Query}
- */
- this.and = _extend.logical('$and');
- /**
- This method includes a query parameter in your query.
- @name Query#addParam
- @function
- @example extension.stack.ContentType('content_type_uid').Entry.Query().addParam('key', 'value').find().then().catch();
- @param {string} key - Key of the parammeter
- @param {string} value - Value of the parammeter
- @return {Query}
- */
- this.addParam = Utils.addParam;
- }
-
- // -------------------------------------Entry Queries--------------------------------------------------
- /**
- * @function
- * @name Query#includeReference
- * @description This method is used to include referenced entries from other content types. Note: This method is only valid for querying {@link Stack#ContentType#Entry}.
- * @example
- * <caption> .includeReference with reference_field_uids as array </caption>
- * stack.ContentType('contenttype_uid').Entry.Query().includeReference(['category', 'author']).find()
- * @example
- * <caption> .includeReference with reference_field_uids </caption>
- * stack.ContentType('contenttype_uid').Entry.Query().includeReference('category', 'author').find()
- * @returns {Query}
- */
-
- /**
- * @function
- * @name Query#includeSchema
- * @description This method is used to include the schema of the current contenttype in result set along with the entry/entries. Note: This method is only valid for querying {@link Stack#ContentType#Entry}.
- * @example extension.stack.ContentType('contenttype_uid').Entry.Query().includeSchema().find()
- * @returns {Query}
- */
-
- /**
- * @function
- * @name Query#language
- * @description This method is used to set the language code of which you want to retrieve the data. Note: This method is only valid for querying {@link Stack#ContentType#Entry}.
- * @param {String} languageCode - Language code, for e.g. 'en-us', 'ja-jp', and so on
- * @example extension.stack.ContentType('contenttype_uid').Entry.Query().language('en-us').find()
- * @returns {Query}
- */
-
- /**
- * @function
- * @name Query#includeContentType
- * @description This method is used to include the current content type in the result set along with the entry(ies). Note: This method is only valid for querying {@link Stack#ContentType#Entry}.
- * @example extension.stack.ContentType('contenttype_uid').Entry.Query().includeContentType().find()
- * @returns {Query}
- */
-
- /**
- * @function
- * @name Query#includeOwner
- * @description This method is used to include the owner of the entry(ies) in the result set. Note: This method is only valid for querying {@link Stack#ContentType#Entry}.
- * @example extension.stack.ContentType('contenttype_uid').Entry.Query().includeOwner().find()
- * @returns {Query}
- */
- // -----------------------------------------Entry Queries End------------------------------------------------------
-
- /**
- * @function
- * @name Query#environment
- * @description This method is used to set the environment name of which you want to retrieve the data.
- * @param {String} environment_uid - UID/Name of environment
- * @example extension.stack.ContentType('contenttype_uid').Entry.Query().environment('development').find()
- * @returns {Query}
- */
-
- /**
- * @description This method provides only the entries containing field values matching the specified condition.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @example extension.stack.ContentType('blog').where('title','Demo')
- * @returns {Query}
- */
- equalTo(key, value) {
- if (key && typeof key === 'string') {
- this._query.query[key] = value;
-
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- }
-
- where(key, value) {
- if (key && typeof key === 'string') {
- this._query.query[key] = value;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- }
-
- /**
- * @description This method provides only the number of entries matching the specified filters.
- * @example extension.stack.ContentType('blog').count()
- * @returns {Query}
- */
- count() {
- this._query.count = true;
- const options = { content_type_uid: this.contentTypeUid, params: this._query, action: `get${this.module}` };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * @description This method is used to set raw queries on the Query instance.
- * @param {object} query - Raw{json} queries to filter the entries in the result set.
- * @returns {Query}
- */
- query(query) {
- if (typeof query === 'object') {
- this._query.query = Utils.mergeDeep(this._query.query, query);
- return this;
- }
- throw Error('Kindly provide valid parameters');
- }
-
- /**
- * @description The ’tags’ parameter allows you to specify an array of tags to search for objects.
- * @param {Array} values - Tags
- * @example extension.stack.ContentType('blog').tags(['technology', 'business'])
- * @returns {Query}
- */
- tags(values) {
- if (Array.isArray(values)) {
- this._query.tags = values;
- return this;
- }
- throw Error('Kindly provide valid parameters');
- }
-
- /**
- * @description This method also includes the total number of entries returned in the response.
- * @example extension.stack.ContentType('blog').includeCount()
- * @returns {Query}
- */
- includeCount() {
- this._query.include_count = true;
- return this;
- }
-
- /**
- * @summary returns Returns the raw query which can be used for further calls (.and/.or).
- * @description This method provides raw{json} queries based on the filters applied on the Query object.
- * @example extension.stack.ContentType('blog').where('title','Demo').getQuery()
- * @returns {Query}
- */
- getQuery() {
- return this._query.query;
- }
-
- /**
- * @description This method provides only the entries matching the regular expression for the specified field.
- * @param {String} key - UID of the field
- * @param {*} value - The value used to match or compare
- * @param {String} [options] - Match or compare a value in the entry
- * @example
- * <caption> .regex without options</caption>
- * let blogQuery = extension.stack.ContentType('blog').regex('title','^Demo')
- * @example
- * <caption> .regex with options</caption>
- * let blogQuery = extension.stack.ContentType('blog').regex('title','^Demo', 'i')
- * @returns {Query}
- */
- regex(key, value, options) {
- if (key && value && typeof key === 'string' && typeof value === 'string') {
- this._query.query[key] = {
- $regex: value
- };
- if (options) this._query.query[key].$options = options;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- }
-
- /**
- * @description This method is used to search data in entries.
- * @param {string} value - Value to search in the entries.
- * @example extension.stack.ContentType('blog').search('Welcome to demo')
- * @returns {Query}
- */
- search(value) {
- if (value && typeof value === 'string') {
- this._query.typeahead = value;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
- }
-
- /**
- * @description This method provides all the entries which satisfy the specified query.
- * @example
- * let blogQuery = extension.stack.ContentType('blog').find()
- */
- find() {
- const options = { content_type_uid: this.contentTypeUid, params: this._query, action: `get${this.module}` };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * @description This method provides a single entry from the result set.
- * @example
- * let blogQuery = extension.stack.ContentType('blog').findOne()
- */
- findOne() {
- this.singleEntry = true;
- this._query.limit = 1;
- const options = { content_type_uid: this.contentTypeUid, params: this._query, action: `get${this.module}` };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-}
-
-export default Query;
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 | - - - - - - - - - - - -3x -3x - - - - - - - - - - - - - - - - -3x -3x - - - - - - - - -2x -1x -1x - -1x - - - - - - - - - - -2x -2x - - - - - -2x -1x -1x - - - -1x - | import * as Utils from "./utils.js";
-/**
- * @summary Creates an instance of `Assets`.
- * @description An initializer is responsible for creating Asset object.
- * @param {String} uid - uid of the asset
- * @example
- * let Assets = stack.Assets('bltsomething123');
- * @returns {Assets}
- * @ignore
- */
-export default class Assets {
- constructor(connection) {
- this._connection = connection;
- this._query = {};
- /**
- * @method only
- * @description This method is use to show the selected fields of the assets in resultset.
- * @param {String} [key=BASE] - single field in asset
- * @param {Array} values - array of fields to be show in resultset
- * @example
- * <caption> .only with field uid </caption>
- * Assets().only('title')
- * @example
- * <caption> .only with field uid </caption>
- * Assets().only('BASE','title')
- * @example
- * <caption> .only with field uids(array) </caption>
- * Assets().only(['title','description'])
- * @returns {Asset}
- */
- this.only = Utils.transform('only');
- return this;
- }
-
- /**
- * @method AddParam
- * @description This method includes query parameter in query.
- * @example stack.Assets('bltsomething123').addParam('include_dimension', 'true').fetch()
- */
- addParam(key, value) {
- if (key && typeof key === 'string' && value && typeof value === 'string') {
- this._query[key] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- /**
- * @method fetch
- * @description fetch asset obhect of requested Asset uid of defined query if present.
- * @example
- * stack.Assets('bltsomething123').fetch()
- */
- fetch() {
- let options = { uid : this.asset_uid, params:this._query, action: "getAsset" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
-}
-
-function onData(data) {
- if (typeof (data.data) === "string")
- return Promise.reject(data.data)
- return Promise.resolve(data.data)
-}
-
-function onError(error) {
- return Promise.reject(error)
-} |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 | - - - - - - - - - - - -26x -26x - - - - - - - - - - - - - - - - - - - - - - -26x - - - - - - - - - - - - - - - - - - - - - -26x -26x - - - - - - - - - - - - - - -6x -3x -3x -3x - -3x -1x -1x -1x - - - -2x - -4x - - - - - - - - - - -2x -1x -1x - -1x - - - - - - - - - - - - -2x -1x -1x - -1x - - - - - - - - - - -1x -1x - - - - - - - - - -1x -1x - - - - - - - - - -1x -1x - - - - - - - - - - - - - - - - - - - - - - - - - - -2x -1x -1x - -1x - - - - - - - - - - - -5x -4x -4x - -1x - - - - - - -4x -1x -3x - - - -1x - | import * as Utils from "./utils.js";
-/**
- * @summary Creates an instance of `Entry`.
- * @description An initializer is responsible for creating Entry object.
- * @param {String} uid - uid of the entry
- * @example
- * let Entry = stack.ContentType('example).Entry();
- * @returns {Entry}
- * @ignore
- */
-export default class Entry {
- constructor(connection) {
- this._connection = connection;
- this._query = {};
- /**
- * @method only
- * @description This method is use to show the selected fields of the entries in resultset.
- * @param {String} [key=BASE] - reference field in the entry/single field in entry
- * @param {Array} values - array of fields to be show in resultset
- * @example
- * <caption> .only with field uid </caption>
- * blogEntry.only('title')
- * @example
- * <caption> .only with field uid </caption>
- * blogEntry.only('BASE','title')
- * @example
- * <caption> .only with field uids(array) </caption>
- * blogEntry.only(['title','description'])
- * @example
- * <caption> .only with reference_field_uid and field uid </caption>
- * blogEntry.includeReference('category').only('category','title')
- * @example
- * <caption> .only with reference_field_uid and field uids(array) </caption>
- * blogEntry.includeReference('category').only('category', ['title', 'description'])
- * @returns {Entry}
- */
- this.only = Utils.transform('only');
- /**
- * @method except
- * @description This method is use to hide the selected fields of the entries in resultset.
- * @param {String} [key=BASE] - reference field in the entry/single field in entry
- * @param {Array} values - array of fields to be show in resultset
- * @example
- * <caption> .except with field uid </caption>
- * blogEntry.except('title')
- * @example
- * <caption> .except with field uid </caption>
- * blogEntry.except('BASE','title')
- * @example
- * <caption> .except with field uids(array) </caption>
- * blogEntry.except(['title','description'])
- * @example
- * <caption> .except with reference_field_uid and field uid </caption>
- * blogEntry.includeReference('category').except('category','title')
- * @example
- * <caption> .except with reference_field_uid and field uids(array) </caption>
- * blogEntry.includeReference('category').except('category', ['title', 'description'])
- * @returns {Entry} */
- this.except = Utils.transform('except');
- return this;
- }
-
- /**
- * @method includeReference
- * @description This method is use to include referenced entries from the other Contenttype.
- * @example
- * <caption> .includeReference with reference_field_uids as array </caption>
- * blogEntry.includeReference(['category', 'author'])
- * @example
- * <caption> .includeReference with reference_field_uids </caption>
- * blogEntry.includeReference('category', 'author')
- * @returns {Entry}
- */
- includeReference(val) {
- if (Array.isArray(val)) {
- for (let i = 0; i < val.length; i++) {
- this._query['include'] = this._query['include'] || [];
- this._query['include'] = this._query['include'].concat(val[i]);
- }
- }else if (typeof val === "string") {
- for (let i = 0; i < arguments.length; i++) {
- this._query['include'] = this._query['include'] || [];
- this._query['include'] = this._query['include'].concat(arguments[i]);
- }
-
- } else {
- throw Error("Argument should be a String or an Array.");
- }
- return this;
- }
-
- /**
- * @method language
- * @description This method is used set language code, which language's data to be retrieve.
- * @param {String} language_code - language code. e.g. 'en-us', 'ja-jp', etc.
- * @example blogEntry.language('en-us')
- * @returns {Entry}
- */
- language(language_code) {
- if (language_code && typeof language_code === 'string') {
- this._query['locale'] = language_code;
- return this;
- } else {
- throw Error("Argument should be a String.");
- }
- }
-
- /**
- * @method addQuery
- * @description This method is used to add query to Entry object.
- * @param {String} key - key of the query
- * @param {String} value - value of the query
- * @example blogEntry.addQuery('include_schema',true)
- * @returns {Entry}
- */
- addQuery(key, value) {
- if (key && value && typeof key === 'string') {
- this._query[key] = value;
- return this;
- } else {
- throw Error("First argument should be a String.");
- }
- }
-
- /**
- * @method includeSchema
- * @description This method is used to include the schema of the current contenttype in result set along with the entry/entries.
- * @example blogEntry.includeSchema()
- * @returns {Entry}
- */
- includeSchema() {
- this._query['include_schema'] = true;
- return this;
- }
-
- /**
- * @method includeContentType
- * @description This method is used to include the current contenttype in result set along with the entry/entries.
- * @example blogEntry.includeContentType()
- * @returns {Entry}
- */
- includeContentType() {
- this._query['include_content_type'] = true;
- return this;
- }
-
- /**
- * @method includeOwner
- * @description This method is used to include the owner of the entry/entries in resultset.
- * @example blogEntry.includeOwner()
- * @returns {Entry}
- */
- includeOwner() {
- this._query['include_owner'] = true;
- return this;
- }
-
- /**
- * @method toJSON
- * @description This method is used to convert the result in to plain javascript object.
- * @example
- * blogEntry
- * .toJSON()
- * .then(function (result) {
- * let value = result.get(field_uid)
- * },function (error) {
- * // error function
- * })
- * @returns {Object}
- */
- // toJSON() {
- // this.tojson = true;
- // return this;
- // }
-
- /**
- * @method AddParam
- * @description This method includes query parameter in query.
- * @example blogQuery.addParam('include_count', 'true').fetch()
- */
- addParam(key, value) {
- if (key && value && typeof key === 'string' && typeof value === 'string') {
- this._query[key] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
-
- /**
- * @method fetch
- * @description fetch entry of requested content_type of defined query if present.
- * @example
- * blogEntry.fetch()
- */
- fetch() {
- if (this.entry_uid) {
- let options = { uid : this.entry_uid , content_type_uid :this.content_type_uid , params:this._query, action: "getEntry" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- } else {
- return Promise.reject("Kindly provide an entry uid. e.g. .Entry('bltsomething123')");
- }
- }
-
-}
-
-function onData(data) {
- if (typeof (data.data) === "string")
- return Promise.reject(data.data)
- return Promise.resolve(data.data)
-}
-
-function onError(error) {
- return Promise.reject(error)
-} |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 | - - - -12x -6x - - - -12x - - - - - - - - - - - - -96x -96x - - - - - - - - - -96x - - - - - - - - - -96x - - - - - - - - - -1x - - - - - - - - - - -4x -1x - -3x -3x - - - - - - - - - -3x -3x -3x -3x - - - - - - - - - -4x -1x - -3x -3x - - - - - - - - - -3x -3x -3x -3x - - - - - - - - - -4x -1x - -3x -3x - - - - - - - - - -3x -3x -3x -3x - - - - - | import Asset from './api/asset/index.js';
-import ContentType from './api/content-type/index.js';
-
-function onData(data) {
- if (typeof (data.data) === 'string') { return Promise.reject(data.data); }
- return Promise.resolve(data.data);
-}
-
-function onError(error) {
- return Promise.reject(error);
-}
-
-
-/**
- * Class representing the current stack in Contentstack UI.
- */
-
-class Stack {
- /**
- * @hideconstructor
- */
- constructor(data, connection) {
- this._connection = connection;
- this._data = data;
- /**
- * @constructor
- * @hideconstructor
- * @version 2.2.0
- * @desc Content type defines the structure or schema of a page or a section of your web or mobile property
- * @see {@link https://www.contentstack.com/docs/apis/content-management-api/#content-types| ContentType}
- * @param {string} uid - Uid of contenttype.
- * @example extension.stack.ContentType('content_type_uid')
- * */
- this.ContentType = ContentType(connection);
- /**
- * @constructor
- * @version 2.2.0
- * @hideconstructor
- * @desc An initializer is responsible for creating an Asset object.
- * @see {@link https://www.contentstack.com/docs/apis/content-management-api/#assets| Asset}
- * @param {string} uid - UID of the asset.
- * @example extension.stack.Asset('asset_uid')
- * */
- this.Asset = Asset(connection);
- }
-
-
- /**
- * This method returns the data of the current stack.
- * @return {Object} Returns stack data.
- */
-
- getData() {
- return this._data;
- }
-
-
- /**
- * This API allows you to retrieve data of a content type of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-a-single-content-type| Content Type API} requests. This method returns a Promise object.
- * @param {string} uid Uid of the desired content type
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A promise object which will be resolved with content type details.
- */
- getContentType(uid, params = {}) {
- if (!uid) {
- return Promise.reject(new Error('uid is required'));
- }
- const options = { uid, params, action: 'getContentType' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows you to retrieve data of a content types of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-all-content-types| Content Types API} requests. This method returns a Promise object.
- * @param {Object} query Query for the GET call
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A promise object which will be resolved with details of the content type.
- */
- getContentTypes(query = {}, params = {}) {
- const optionParams = params;
- optionParams.query = query;
- const options = { params: optionParams, action: 'getContentTypes' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows you to retrieve environment details of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-a-single-environment| Environment API} requests. This method returns a Promise object.
- * @param {string} name Name of the desired environment
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A promise object which will be resolved with environment details.
- */
- getEnvironment(name, params = {}) {
- if (!name) {
- return Promise.reject(new Error('name is required'));
- }
- const options = { name, params, action: 'getEnvironment' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows you to retrieve details of environments of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-all-environments| Environments API} requests. This method returns a Promise object.
- * @param {Object} query Query for the GET call
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A Promise object which will be resolved with details of the environments.
- */
- getEnvironments(query = {}, params = {}) {
- const optionParams = params;
- optionParams.query = query;
- const options = { params: optionParams, action: 'getEnvironments' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows you to retrive a locale of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-a-language| Language API} requests. Method returns a Promise object.
- * @param {string} code Code of the desired locale
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A promise object which will be resolved with locale details.
- */
- getLocale(code, params = {}) {
- if (!code) {
- return Promise.reject(new Error('code is required'));
- }
- const options = { code, params, action: 'getLocale' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows you to retrive the locales of a stack using the {@link https://www.contentstack.com/docs/apis/content-management-api/#get-all-content-types| Languages API} requests. Method returns a Promise object.
- * @param {Object} query Query for the GET call
- * @param {Object} params Optional parameters for the GET call
- * @return {Object} A Promise object which will be resolved with details of the locales.
- */
- getLocales(query = {}, params = {}) {
- const optionParams = params;
- optionParams.query = query;
- const options = { params: optionParams, action: 'getLocales' };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-}
-
-export default Stack;
- |
| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187 -188 -189 -190 -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242 -243 -244 -245 -246 -247 -248 -249 -250 -251 -252 -253 -254 -255 -256 -257 -258 -259 -260 -261 -262 -263 -264 -265 -266 -267 -268 -269 -270 -271 -272 -273 -274 -275 -276 -277 -278 -279 -280 -281 -282 -283 -284 -285 -286 -287 -288 -289 -290 -291 -292 -293 -294 -295 -296 -297 -298 -299 -300 -301 -302 -303 -304 -305 -306 -307 -308 -309 -310 -311 -312 -313 -314 -315 -316 -317 -318 -319 -320 -321 -322 -323 -324 -325 -326 -327 -328 -329 -330 -331 -332 -333 -334 -335 -336 -337 -338 -339 -340 -341 -342 -343 -344 -345 -346 -347 -348 -349 -350 -351 -352 -353 -354 -355 -356 -357 -358 -359 -360 -361 -362 -363 -364 -365 -366 -367 -368 -369 -370 -371 -372 -373 -374 -375 -376 -377 -378 -379 -380 -381 -382 -383 -384 -385 -386 -387 -388 -389 -390 -391 -392 -393 -394 -395 -396 -397 -398 -399 -400 -401 -402 -403 -404 -405 -406 -407 -408 -409 -410 -411 -412 -413 -414 -415 -416 -417 -418 -419 -420 -421 -422 -423 -424 -425 -426 -427 -428 -429 -430 -431 -432 -433 -434 -435 -436 -437 -438 -439 -440 -441 -442 -443 -444 -445 -446 -447 -448 -449 -450 -451 -452 -453 -454 -455 -456 -457 -458 -459 -460 -461 -462 -463 -464 -465 | - - -3x - -70x -37x -32x -32x -32x - -5x - - - - -28x -28x -14x -12x -12x -12x -12x - -2x - - - - -28x -7x -6x -6x -6x - -1x - - - - -28x -17x -17x -18x -4x -14x -12x - - -17x -1x - -16x - -17x - - - -56x -28x -24x -24x - -4x - - - - -28x -14x -12x -12x - -2x - - - - - - - - - - - - - - - - - - - -14x -14x -14x -14x - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - -14x - - - - - - - - - - - - - - - - - -14x - - - - - - - - - - - - - - - - - -14x - - - - - - - - - - - -7x -6x - -6x - -1x - - - - -9x -8x -8x - -1x - - - - - - - - - - -2x -2x -2x -2x - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - - - -6x -6x - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - - - - -15x - - - - - - - - - - - - - - - - - -8x -7x - - -7x -7x - -1x - - - - - - - - - - - -7x -6x -6x - -1x - - - - - - - - - - -3x -3x -3x - - - - - - - - - - -4x -4x -4x -4x -4x - - - - - -9x -1x -8x - - - -1x - | import * as Utils from './utils.js';
-import Entry from './entry';
-
-const _extend = {
- compare: function(type) {
- return function(key, value) {
- if (key && value && typeof key === 'string' && typeof value !== 'undefined') {
- this._query['query'][key] = this._query['query']['file_size'] || {};
- this._query['query'][key][type] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- };
- },
- contained: function(bool) {
- let type = (bool) ? '$in' : '$nin';
- return function(key, value) {
- if (key && value && typeof key === 'string' && Array.isArray(value)) {
- this._query['query'][key] = this._query['query'][key] || {};
- this._query['query'][key][type] = this._query['query'][key][type] || [];
- this._query['query'][key][type] = this._query['query'][key][type].concat(value);
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- };
- },
- exists: function(bool) {
- return function(key) {
- if (key && typeof key === 'string') {
- this._query['query'][key] = this._query['query'][key] || {};
- this._query['query'][key]['$exists'] = bool;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- };
- },
- logical: function(type) {
- return function() {
- let _query = [];
- for (let i = 0, _i = arguments.length; i < _i; i++) {
- if (arguments[i] instanceof Query && arguments[i]._query.query) {
- _query.push(arguments[i]._query.query);
- } else if (typeof arguments[i] === "object") {
- _query.push(arguments[i]);
- }
- }
- if (this._query['query'][type]) {
- this._query['query'][type] = this._query['query'][type].concat(_query);
- } else {
- this._query['query'][type] = _query;
- }
- return this;
- };
- },
- sort: function(type) {
- return function(key) {
- if (key && typeof key === 'string') {
- this._query[type] = key;
- return this;
- } else {
- throw Error("Argument should be a string.");
- }
- };
- },
- pagination: function(type) {
- return function(value) {
- if (typeof value === 'number') {
- this._query[type] = value;
- return this;
- } else {
- throw Error("Argument should be a number.");
- }
- }
- }
-};
-
-/**
- * @summary
- * Creates an instance of `Query`.
- * @description
- * An initializer is responsible for creating Query object.
- * @example
- * <caption>Query instance creation.</caption>
- * let Query = Contentstack.Stack().ContentType('example').Query();
- * let assetQuery = Contentstack.Stack().Assets().Query();
- * @ignore
- */
-export default class Query extends Entry {
-
- constructor(connection) {
- super();
- this._connection = connection;
- this._query = this._query;
- this._query['query'] = this._query['query'] || {};
- /**
- * @method lessThan
- * @description This method provides only the entries with values less than the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.lessThan('created_at','2015-06-22')
- * @returns {Query}
- */
- this.lessThan = _extend.compare('$lt');
-
- /**
- * @method lessThanOrEqualTo
- * @description This method provides only the entries with values less than or equal to the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.lessThanOrEqualTo('created_at','2015-03-12')
- * @returns {Query}
- */
- this.lessThanOrEqualTo = _extend.compare('$lte');
- /**
- * @method greaterThan
- * @description This method provides only the entries with values greater than the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.greaterThan('created_at','2015-03-12')
- * @returns {Query}
- */
- this.greaterThan = _extend.compare('$gt');
-
- /**
- * @method greaterThanOrEqualTo
- * @description This method provides only the entries with values greater than or equal to the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.greaterThanOrEqualTo('created_at', '2015-06-22')
- * @returns {Query}
- */
- this.greaterThanOrEqualTo = _extend.compare('$gte');
-
- /**
- * @method notEqualTo
- * @description This method provides only the entries with values not equal to the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.notEqualTo('title','Demo')
- * @returns {Query}
- */
- this.notEqualTo = _extend.compare('$ne');
-
- /**
- * @method containedIn
- * @description This method provides only the entries with values matching the specified values for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - An array of values that are to be used to match or compare
- * @example blogQuery.containedIn('title', ['Demo', 'Welcome'])
- * @returns {Query}
- */
- this.containedIn = _extend.contained(true);
-
- /**
- * @method notContainedIn
- * @description This method provides only the entries that do not contain values matching the specified values for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {Array} value - An array of values that are to be used to match or compare
- * @example blogQuery.notContainedIn('title', ['Demo', 'Welcome'])
- * @returns {Query}
- */
- this.notContainedIn = _extend.contained(false);
-
- /**
- * @method exists
- * @description This method provides only the entries that contains the field matching the specified field uid.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @example blogQuery.exists('featured')
- * @returns {Query}
- */
- this.exists = _extend.exists(true);
-
- /**
- * @method notExists
- * @description This method provides only the entries that do not contain the field matching the specified field uid.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @example blogQuery.notExists('featured')
- * @returns {Query}
- */
- this.notExists = _extend.exists(false);
-
- /**
- * @method ascending
- * @description This parameter sorts the provided entries in the ascending order on the basis of the specified field.
- * @param {String} key - field uid based on which the ordering should be done
- * @example blogQuery.ascending('created_at')
- * @returns {Query}
- */
- this.ascending = _extend.sort('asc');
-
- /**
- * @method descending
- * @description This method sorts the provided entries in the descending order on the basis of the specified field.
- * @param {String} key - field uid based on which the ordering should be done.
- * @example blogQuery.descending('created_at')
- * @returns {Query}
- */
- this.descending = _extend.sort('desc');
-
- /**
- * @method beforeUid
- * @description This method provides only the entries before the specified entry id.
- * @param {String} uid - uid of the entry
- * @example blogQuery.beforeUid('blt1234567890abcdef')
- * @returns {Query}
- * @ignore
- */
- this.beforeUid = _extend.sort('before_uid');
-
- /**
- * @method afterUid
- * @description This method provides only the entries after the specified entry id.
- * @param {String} uid - uid of the entry
- * @example blogQuery.afterUid('blt1234567890abcdef')
- * @returns {Query}
- * @ignore
- */
- this.afterUid = _extend.sort('after_uid');
-
- /**
- * @method skip
- * @description This method skips the specified number of entries.
- * @param {Number} skip - number of entries to be skipped
- * @example blogQuery.skip(5)
- * @returns {Query}
- */
- this.skip = _extend.pagination('skip');
-
- /**
- * @method limit
- * @description This method limits the response by providing only the specified number of entries.
- * @param {Number} limit - number of entries to be present in the result(at most)
- * @example blogQuery.limit(10)
- * @returns {Query}
- */
- this.limit = _extend.pagination('limit');
-
- /**
- * @method or
- * @description This method performs the OR operation on the specified query objects and provides only the matching entries.
- * @param {object} queries - array of Query objects/raw queries to be taken into consideration
- * @example
- * <caption> .or with Query instances</caption>
- * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo')
- * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10)
- * blogQuery.or(Query1, Query2)
- * @example
- * <caption> .or with raw queries</caption>
- * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo').getQuery()
- * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10).getQuery()
- * blogQuery.or(Query1, Query2)
- * @returns {Query}
- */
- this.or = _extend.logical('$or');
-
- /**
- * @method and
- * @description This method performs the AND operation on the specified query objects and provides only the matching entries.
- * @param {object} queries - array of Query objects/raw queries to be taken into consideration
- * @example
- * <caption> .and with Query instances</caption>
- * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo')
- * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10)
- * blogQuery.and(Query1, Query2)
- * @example
- * <caption> .and with raw queries</caption>
- * let Query1 = Stack.ContentType('blog').Query().where('title', 'Demo').getQuery()
- * let Query2 = Stack.ContentType('blog').Query().lessThan('comments', 10).getQuery()
- * blogQuery.and(Query1, Query2)
- * @returns {Query}
- */
- this.and = _extend.logical('$and');
- }
-
- /**
- * @method where(equalTo)
- * @description This method provides only the entries matching the specified value for a field.
- * @param {String} key - uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @example blogQuery.where('title','Demo')
- * @returns {Query}
- */
- equalTo(key, value) {
- if (key && typeof key === 'string') {
- this._query['query'][key] = value;
-
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- where(key, value) {
- if (key && typeof key === 'string') {
- this._query['query'][key] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- /**
- * @method count
- * @description This method provides only the number of entries matching the specified filters.
- * @example blogQuery.count()
- * @returns {Query}
- */
- count() {
- this._query['count'] = true;
- let options = {content_type_uid :this.content_type_uid , params:this._query};
- options.action = (this.type && this.type === 'asset') ? "getAssets" : "getEntries"
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * @method query
- * @description This method used to set raw queries on Query instance.
- * @param {object} query - raw{json} queries to filter the entries in result set.
- * @returns {Query}
- */
- query(query) {
- if (typeof query === "object") {
- this._query['query'] = Utils.mergeDeep(this._query['query'], query);
- return this;
- } else {
- throw Error("Kindly provide valid parameters");
- }
- }
-
- /**
- * @method tags
- * @description The "tags" parameter allows you to specify an array of tags to search objects.
- * @param {Array} values - tags
- * @example blogQuery.tags(['technology', 'business'])
- * @returns {Query}
- */
- tags(values) {
- if (Array.isArray(values)) {
- this._query['tags'] = values;
- return this;
- } else {
- throw Error("Kindly provide valid parameters");
- }
- }
-
- /**
- * @method includeCount
- * @description This method also includes the total number of entries returned in the response.
- * @example blogQuery.includeCount()
- * @returns {Query}
- */
- includeCount() {
- this._query['include_count'] = true;
- return this;
- }
-
- /**
- * @method AddParam
- * @description This method includes query parameter in query.
- * @example blogQuery.addParam('include_count', 'true')
- * @returns {Query}
- */
- addParam(key, value) {
- if (key && value && typeof key === 'string' && typeof value === 'string') {
- this._query[key] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- /**
- * @method getQuery
- * @summary returns the raw query which can be used for futher calls(.and/.or).
- * @description This method provides raw{json} queries based on the filters applied on Query objet.
- * @example blogQuery.where('title','Demo').getQuery()
- * @returns {Query}
- */
- getQuery() {
- return this._query.query;
- }
-
- /**
- * @method regex
- * @description This method provides only the entries matching the regular expression for the specified field.
- * @param {String} key - Uid of the field that is to be taken into consideration
- * @param {*} value - The value used to match or compare
- * @param {String} [options] - match or compare value in entry
- * @example
- * <caption> .regex without options</caption>
- * blogQuery.regex('title','^Demo')
- * @example
- * <caption> .regex with options</caption>
- * blogQuery.regex('title','^Demo', 'i')
- * @returns {Query}
- */
- regex(key, value, options) {
- if (key && value && typeof key === 'string' && typeof value === 'string') {
- this._query['query'][key] = {
- $regex: value
- };
- if (options) this._query['query'][key]['$options'] = options;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- /**
- * @method search
- * @description This method is used to search data in entries.
- * @param {string} value - value to search in entries
- * @example blogQuery.search('Welcome to demo')
- * @returns {Query}
- */
- search(value) {
- if (value && typeof value === 'string') {
- this._query['typeahead'] = value;
- return this;
- } else {
- throw Error("Kindly provide valid parameters.");
- }
- }
-
- /**
- * @method find
- * @description Provides all the entries which satisfied the query specified.
- * @example
- * blogQuery.find()
- */
- find() {
- let options = {content_type_uid :this.content_type_uid , params:this._query};
- options.action = (this.type && this.type === 'asset') ? "getAssets" : "getEntries"
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * @method findOne
- * @description Provides the single entry from the resultset.
- * @example
- * blogQuery.findOne()
- */
- findOne() {
-
- this.singleEntry = true;
- this._query.limit = 1;
- let options = {content_type_uid :this.content_type_uid , params:this._query};
- options.action = (this.type && this.type === 'asset') ? "getAssets" : "getEntries"
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
-}
-
-function onData(data) {
- if (typeof (data.data) === "string")
- return Promise.reject(data.data)
- return Promise.resolve(data.data)
-}
-
-function onError(error) {
- return Promise.reject(error)
-} |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 | -180x -13x - -5x -3x -3x -3x -3x - -2x - - -6x -4x -4x -4x -4x - -2x - - -2x - - - - - - - -2x -2x -1x -1x - - -2x - - - - -7x -7x -7x -10x -10x -22x -3x -19x -1x - -18x - - - -7x -7x - - - - -49x -49x -4x - -49x - - - -11x -8x -8x - -3x - - - -4x -2x -2x - -2x - - - -4x -2x -2x - -2x - - - -2x -1x -1x - -1x - - - -2x -2x - - - -2x -2x - - - -2x -2x - - - -10x -5x -5x -5x - -5x -2x -2x -2x - - -3x - -7x - - - -1x - - | export function transform(type) {
- return function () {
- switch (arguments.length) {
- case 1:
- if (Array.isArray(arguments[0]) || typeof arguments[0] === 'string') {
- let query = this._query[`${type}[BASE]`] || [];
- query = query.concat(arguments[0]);
- this._query[`${type}[BASE]`] = query;
- return this;
- }
- throw Error('Kindly provide valid parameters');
-
- case 2:
- if (typeof arguments[0] === 'string' && (Array.isArray(arguments[1]) || typeof arguments[1] === 'string')) {
- let query = this._query[`${type}[${arguments[0]}]`] || [];
- query = query.concat(arguments[1]);
- this._query[`${type}[${arguments[0]}]`] = query;
- return this;
- }
- throw Error('Kindly provide valid parameters');
-
- default:
- throw Error('Kindly provide valid parameters');
- }
- };
-}
-
-
-// merge two objects
-export function merge(target, source) {
- const newTraget = target;
- if (target && source) {
- Object.keys(source).forEach((key) => {
- newTraget[key] = source[key];
- });
- }
- return newTraget;
-}
-
-// merge two objects
-export function mergeDeep(oldTarget, oldSource) {
- const newTarget = oldTarget;
- const self = this;
- const _mergeRecursive = (anotherTarget, source) => {
- const target = anotherTarget;
- Object.keys(source).forEach((key) => {
- if (self._type(source[key]) === 'object' && self._type(target[key]) === self._type(source[key])) {
- _mergeRecursive(target[key], source[key]);
- } else if (self._type(source[key]) === 'array' && self._type(target[key]) === self._type(source[key])) {
- target[key] = target[key].concat(source[key]);
- } else {
- target[key] = source[key];
- }
- });
- };
- _mergeRecursive(newTarget, oldSource);
- return newTarget;
-}
-
-
-export function _type(val) {
- let __typeof = typeof val;
- if (__typeof === 'object' && Array.isArray(val)) {
- __typeof = 'array';
- }
- return __typeof;
-}
-
-export function addParam(key, value) {
- if (key && typeof key === 'string' && value && typeof value === 'string') {
- this._query[key] = value;
- return this;
- }
- throw Error('Kindly provide valid parameters.');
-}
-
-export function addQuery(key, value) {
- if (key && value && typeof key === 'string') {
- this._query[key] = value;
- return this;
- }
- throw Error('First argument should be a String.');
-}
-
-export function language(languageCode) {
- if (languageCode && typeof languageCode === 'string') {
- this._query.locale = languageCode;
- return this;
- }
- throw Error('Argument should be a String.');
-}
-
-export function environment(environmentCode) {
- if (environmentCode && typeof environmentCode === 'string') {
- this._query.environment = environmentCode;
- return this;
- }
- throw Error('Argument should be a String.');
-}
-
-export function includeOwner() {
- this._query.include_owner = true;
- return this;
-}
-
-export function includeContentType() {
- this._query.include_content_type = true;
- return this;
-}
-
-export function includeSchema() {
- this._query.include_schema = true;
- return this;
-}
-
-export function includeReference(val) {
- if (Array.isArray(val)) {
- for (let i = 0; i < val.length; i += 1) {
- this._query['include[]'] = this._query['include[]'] || [];
- this._query['include[]'] = this._query['include[]'].concat(val[i]);
- }
- } else if (typeof val === 'string') {
- for (let i = 0; i < arguments.length; i += 1) {
- this._query['include[]'] = this._query['include[]'] || [];
- this._query['include[]'] = this._query['include[]'].concat(arguments[i]);
- }
- } else {
- throw Error('Argument should be a String or an Array.');
- }
- return this;
-}
-
-export function getReferences() {
- return this.fetch(`get${this.constructor.module()}References`);
-}
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 | -1x - - - - - - - - - -15x - - - - - - - - -2x -1x -1x - - - - - - - - -1x -1x - - - - - - - - - - - -2x -1x - -1x -1x - - - - - - - - - - -3x -2x -1x - - - - - - - - - -1x -1x - - - - - | function onError(error) {
- return Promise.reject(error);
-}
-/**
- * Class used by an extension to store your data in {@link external:localStorage}.
- */
-class Store {
- /**
- * @hideconstructor
- */
- constructor(connection) {
- this._connection = connection;
- }
- /**
- * Gets the value of key
- * @param {string} key Key of the stored data
- * @example extension.store.get('key').then((value) => console.log(value)) // will log value for the given key
- * @return {external:Promise}
- */
- get(key) {
- if (!key || typeof key !== 'string') { throw new Error('Kindly provide valid parameters'); }
- return this._connection.sendToParent('store', { action: 'get', key })
- .then(event => Promise.resolve(event.data)).catch(onError);
- }
-
- /**
- * Gets an object with all the stored key-value pairs.
- * @example extension.store.getAll().then((obj) => obj)
- * @return {external:Promise}
- */
- getAll() {
- return this._connection.sendToParent('store', { action: 'getAll' })
- .then(({ data = {} }) => Promise.resolve(data)).catch(onError);
- }
-
- /**
- * Sets the value of a key
- * @param {string} key Key of the stored data.
- * @param {*} value Data to be stored.
- * @example extension.store.set('key', 'value').then((success) => console.log(success)) // will log ‘true’ when value is set
- * @return {external:Promise}
- */
-
- set(key, value) {
- if (!key || !value || typeof key !== 'string') {
- throw new Error('Kindly provide valid parameters');
- }
- return this._connection.sendToParent('store', { action: 'set', key, value })
- .then(() => Promise.resolve(true)).catch(onError);
- }
-
- /**
- * Removes the value of a key
- * @param {string} key Key of the data to be removed from the store
- * @example extension.store.remove('key').then((success) => console.log(success)) // will log ‘true’ when value is removed
- * @return {external:Promise}
- */
-
- remove(key) {
- if (!key || typeof key !== 'string') { throw new Error('Kindly provide valid parameters'); }
- return this._connection.sendToParent('store', { action: 'remove', key })
- .then(() => Promise.resolve(true)).catch(onError);
- }
-
- /**
- * Clears all the stored data of an extension
- * @example extension.store.clear().then((success) => console.log(success)) // will log ‘true’ when values are cleared
- * @return {external:Promise}
- */
-
- clear() {
- return this._connection.sendToParent('store', { action: 'clear' })
- .then(() => Promise.resolve(true)).catch(onError);
- }
-}
-
-export default Store;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
- -| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 | 1x - - - - - - - - - - -15x -15x -15x -15x -15x -15x - - - - - - - -2x -1x -1x - - - - - - - - - - -3x -3x -1x - -2x -1x -1x -1x - - -1x - -1x - - - - - - - - - - -12x -11x -9x -2x -1x - -1x - -10x - - - - - - - -3x -1x - -2x -2x -2x -2x - - - - - - - -2x -1x - -1x -1x -1x - - - - - | const config = { attributes: true, childList: true, subtree: true };
-let observer;
-/**
- * Class representing an iframe window from Contentstack UI. Not available for Custom Widgets.
- */
-
-class Window {
- /**
- * @hideconstructor
- */
- constructor(connection, type, emitter, state = 'half_width') {
- this._connection = connection;
- this._autoResizingEnabled = false;
- this._resizingEnabled = false;
- this.type = type;
- this.state = state;
- this._emitter = emitter;
- }
-
- /**
- * This method activates the resize button that gives you the provision to resize the window size of your Dashboard Widget.
- * @return {external:Promise} A promise object which will resolve when a resize button is visible on the Dashboard Widget.
- */
- enableResizing() {
- if (this.type !== 'DASHBOARD') { return Promise.resolve(); }
- this._resizingEnabled = true;
- return this._connection.sendToParent('window', { action: 'enableResizing' });
- }
-
-
- /**
- * This function executes the callback function whenever a Dashboard Widget extension is maximized or minimized. Only applicable on Dashboard Widget extensions.
- * @param {function} callback Function to be called when a Dashboard Widget extension is maximized or minimized
- * @return {boolean} Will return true
- */
-
- onDashboardResize(callback) {
- const windowObj = this;
- if (this.type !== 'DASHBOARD') {
- return false;
- }
- if (callback && typeof (callback) === 'function') {
- windowObj._emitter.on('dashboardResize', (event) => {
- windowObj.state = event.state;
- callback(event.state);
- });
- } else {
- throw Error('Callback must be a function');
- }
- return true;
- }
-
-
- /**
- * This method updates the extension height on Contentstack UI.
- * If the ‘height’ argument is not passed, it will calculate the scroll height and set the height of extension window accordingly.
- * @param {string|number} height Desired height of the iframe window
- * @return {external:Promise} A promise object which will be resolved when Contentstack UI sends an acknowledgement stating that the height has been updated.
- */
- updateHeight(height) {
- if (this.type === 'DASHBOARD' && this.state === 'half_width') { return Promise.resolve(); }
- if (!height || isNaN(height)) {
- this._height = Math.ceil(document.documentElement.getBoundingClientRect().height);
- } else if (this._height === height) {
- return Promise.resolve();
- } else {
- this._height = height;
- }
- return this._connection.sendToParent('resize', this._height);
- }
-
- /**
- * This method enables auto resizing of the extension height.
- * @return {Window}.
- */
- enableAutoResizing() {
- if (this._autoResizingEnabled || (this.state === 'half_width' && this.type === 'DASHBOARD')) {
- return this;
- }
- this._autoResizingEnabled = true;
- observer = new MutationObserver(this.updateHeight.bind(this));
- observer.observe(window.document.body, config);
- return this;
- }
-
- /**
- * This method disables auto resizing of the extension height.
- * @return {Window}.
- */
- disableAutoResizing() {
- if (!this._autoResizingEnabled) {
- return this;
- }
- this._autoResizingEnabled = false;
- observer.disconnect();
- return this;
- }
-}
-
-export default Window;
- |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 | - - - - -62x -62x - - - - - - - - - -1x - - - - - - - - - -4x -1x - -3x -3x -3x - - - - - - - - - -3x -3x -3x -3x -3x - - - - - - - - - - -5x -1x - -4x -1x - -3x -3x -3x - - - - - - - - - - -4x -1x - -3x -3x -3x -3x -3x - - - - - - - - - -4x -1x - -3x -3x -3x - - - - - - - - - -3x -3x -3x -3x -3x - - - - - - - - - -4x -1x - -3x -3x -3x - - - - - - - - - -3x -3x -3x -3x -3x - - - - - - - - - -4x -1x - -3x -3x -3x - - - - - - - - - -3x -3x -3x -3x -3x - - - - -20x -10x -10x - - - -20x - - - | /** Class representing the current stack from contentstack ui. */
-
-class Stack {
-
- constructor(data, connection) {
- this._connection = connection;
- this._data = data;
- }
-
-
-/**
- * This method returns data of the current stack.
- * @return {Object} Returns stack data.
- */
-
- getData() {
- return this._data;
- }
-
- /**
- * This API allows users to interact with a content type of a stack using the Content Type Content Delivery API requests. Method returns a Promise object.
- * @param {string} uid Uid of the desired content type
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with content type details.
- */
- getContentType(uid, params) {
- if (!uid){
- return Promise.reject('uid is required');
- }
- params = params || {};
- let options = { uid, params, action: "getContentType" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with the content types of a stack using the Content Type Content Delivery API requests. Method returns a Promise object.
- * @param {Object} query query for the get call
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with details of content type.
- */
- getContentTypes(query, params) {
- query = query || {};
- params = params || {};
- params.query = query;
- let options = { params, action: "getContentTypes" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with an entry of a stack using the Entries Content Delivery API requests. Method returns a Promise object.
- * @param {string} uid Uid of the desired entry
- * @param {string} content_type_uid Uid of the desired content type
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with entry details.
- */
- getEntry(uid, content_type_uid, params) {
- if (!uid){
- return Promise.reject('uid is required');
- }
- if (!content_type_uid){
- return Promise.reject('content_type_uid is required');
- }
- params = params || {};
- let options = { uid, content_type_uid, params, action: "getEntry" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with the entries of a stack using the Entries Content Delivery API requests. Method returns a Promise object.
- * @param {string} content_type_uid Uid of the desired content type
- * @param {Object} query query for the get call
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with details of entries.
- */
- getEntries(content_type_uid, query, params) {
- if (!content_type_uid){
- return Promise.reject('content_type_uid is required');
- }
- query = query || {};
- params = params || {};
- params.query = query;
- let options = { content_type_uid, params, action: "getEntries" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with an asset of a stack using the Assets Content Delivery API requests. Method returns a Promise object.
- * @param {string} uid Uid of the desired asset
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with asset details.
- */
- getAsset(uid, params) {
- if (!uid){
- return Promise.reject('uid is required');
- }
- params = params || {};
- let options = { uid, params, action: "getAsset" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with the assets of a stack using the Assets Content Delivery API requests. Method returns a Promise object.
- * @param {Object} query query for the get call
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with details of assets.
- */
- getAssets(query, params) {
- query = query || {};
- params = params || {};
- params.query = query;
- let options = { params, action: "getAssets" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with an environment of a stack using the Environment Content Delivery API requests. Method returns a Promise object.
- * @param {string} name Name of the desired environment
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with environment details.
- */
- getEnvironment(name, params) {
- if (!name){
- return Promise.reject('name is required');
- }
- params = params || {};
- let options = {name, params, action: "getEnvironment" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with the environments of a stack using the Environment Content Delivery API requests. Method returns a Promise object.
- * @param {Object} query query for the get call
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with details of environments.
- */
- getEnvironments(query, params) {
- query = query || {};
- params = params || {};
- params.query = query;
- let options = { params, action: "getEnvironments" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with a locale of a stack using the Languages Content Delivery API Requests. Method returns a Promise object.
- * @param {string} code Code of the desired locale
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with locale details.
- */
- getLocale(code, params) {
- if (!code){
- return Promise.reject('code is required');
- }
- params = params || {};
- let options = { code, params, action: "getLocale" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-
- /**
- * This API allows users to interact with the locales of a stack using the Languages Content Delivery API Requests. Method returns a Promise object.
- * @param {Object} query query for the get call
- * @param {Object} params optional params for the get call
- * @return {Object} A Promise object which will resolve with details of locales.
- */
- getLocales(query, params) {
- query = query || {};
- params = params || {};
- params.query = query;
- let options = { params, action: "getLocales" };
- return this._connection.sendToParent('stackQuery', options).then(onData).catch(onError);
- }
-}
-
-function onData(data){
- if(typeof(data.data) === "string")
- return Promise.reject(data.data)
- return Promise.resolve(data.data)
-}
-
-function onError(error){
- return Promise.reject(error)
-}
-
-export default Stack; |
- Press n or j to go to the next uncovered block, b, p or k for the previous block. -
-| 1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 | 3x - - - - - -10x -10x -10x - - - - - - - - -9x -7x - - -9x -3x - -6x -6x - - - - - - - -3x -1x - -2x -2x -2x -2x - -2x - - - - - - - -2x -1x - -1x -1x -1x - - - - | let config = { attributes: true, childList: true, subtree: true };
-let observer
-/** Class representing a iframe window from contentstack ui. */
-
-class Window {
- constructor(connection) {
- this._connection = connection;
- this._height;
- this._autoResizingEnabled = false;
- }
-
- /**
- * This method updates the extension height on Contentstack UI. If argument height is not passed then it will calculate the scroll height and set the height of extension window accordingly.
- * @param {string|number} height Desired height of the window iframe window
- * @return {Object} A Promise object which will resolve on acknowledgement for height update.
- */
- updateHeight(height) {
- if (!height || isNaN(height)) {
- height = Math.ceil(document.documentElement.getBoundingClientRect().height);
- }
-
- if (this._height === height) {
- return Promise.resolve();
- }
- this._height = height;
- return this._connection.sendToParent('resize', height);
- }
-
- /**
- * This method enables auto resizing of the extension height.
- * @return {Object} Field object.
- */
- enableAutoResizing() {
- if (this._autoResizingEnabled) {
- return this;
- }
- this._autoResizingEnabled = true;
- observer = new MutationObserver(this.updateHeight.bind(this));
- Eif (window.document.body) {
- observer.observe(window.document.body, config);
- }
- return this;
- }
-
- /**
- * This method disables auto resizing of the extension height.
- * @return {Object} Field object.
- */
- disableAutoResizing() {
- if (!this._autoResizingEnabled) {
- return this;
- }
- this._autoResizingEnabled = false;
- observer.disconnect();
- return this;
- }
-}
-
-export default Window; |