Merge pull request #63 from contentstack/feature/live-preview

Feature/live preview

Author: uttamukkoji

.gitignore

@@ -1,6 +1,5 @@
 *.DS_Store
-examples/*
-node_modules/*
+**/node_modules/*
 .idea/*
 reports/*
 apidocs-templates/*
@@ -10,4 +9,5 @@ test/sync_config.js/*
 test/report.json/*
 tap-html.html
 *html-report
-coverage
+coverage
+.env

CHANGELOG.md

@@ -1,4 +1,8 @@
 ## Change log
+### Version: 3.14.0
+#### Date: Oct-19-2021
+#####  New Features:
+ - Live preview feature support added
 
 ### Version: 3.13.2
 #### Date: May-26-2021

index.d.ts

@@ -61,14 +61,25 @@ export interface StackConfig {
 
 // ContentTypeCollection
 export interface ContentTypeCollection{
-    contentTypes: Array<any>
+    content_types: Array<any>
     count?: number
 }
 
+export interface LivePreview {
+    host: string
+    authorization: string
+    enable: boolean
+}
+
+export interface LivePreviewQuery {
+    hash: string
+    content_type_uid: string
+}
+
 // Stack 
 export class Stack {
     constructor(config: Config);
-    constructor(api_key: string, delivery_token: string, environment_name: string, region?: Region, fetchOptions?: any);
+    constructor(api_key: string, delivery_token: string, environment_name: string, region?: Region, fetchOptions?: any, live_preview?: LivePreview);
 
     environment: string;
     cachePolicy: CachePolicy;
@@ -84,6 +95,7 @@ export class Stack {
     setHost(host: string): Stack;
     setCachePolicy(policy: CachePolicy): Stack;
     setCacheProvider(provider: object): Stack;
+    livePreviewQuery(query: LivePreviewQuery): void;
     clearByQuery(): Stack;
     clearByContentType(): Stack;
     clearAll(): Stack;
@@ -219,4 +231,4 @@ export class Query extends Entry {
 
     find(fetchOptions?: object): Promise<any>;
     findOne(): Promise<any>;
-}
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "contentstack",
-  "version": "3.13.3",
+  "version": "3.14.0",
   "description": "Contentstack Javascript SDK",
   "homepage": "https://www.contentstack.com/",
   "author": {
@@ -10,14 +10,14 @@
   "main": "dist/node/contentstack.js",
   "browser": "dist/web/contentstack.js",
   "types": "./index.d.ts",
-  "_id": "contentstack@3.13.2",
+  "_id": "contentstack@3.14.0",
   "scripts": {
     "test": "npm run test:e2e && npm run test:typescript",
     "test:e2e": "istanbul cover tape test/index.js | tap-html --out ./tap-html.html",
     "test:typescript": "jest --testPathPattern=test/typescript",
     "automate": "node test.js",
     "build:node": "webpack --config webpack/webpack.node.js",
-    "build:web": "webpack -p --config webpack/webpack.web.js",
+    "build:web": "webpack --config webpack/webpack.web.js",
     "build:react-native": "webpack --config webpack/webpack.react-native.js",
     "build:native-script": "webpack --config webpack/webpack.nativescript.js",
     "build": "NODE_ENV=production && npm run build:node && npm run build:web && npm run build:react-native && npm run build:native-script",
@@ -54,14 +54,14 @@
   ],
   "dist": {
     "shasum": "a328ed07240476a26b31a23261355dc929e1da63",
-    "tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.13.2.tgz"
+    "tarball": "https://registry.npmjs.org/contentstack/-/contentstack-3.14.0.tgz"
   },
   "license": "MIT",
   "directories": {},
-  "_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.13.2.tgz",
+  "_resolved": "https://registry.npmjs.org/contentstack/-/contentstack-3.14.0.tgz",
   "_npmOperationalInternal": {
     "host": "packages-18-east.internal.npmjs.com",
-    "tmp": "tmp/contentstack-3.13.2.tgz_1477830884275_0.9869455888401717"
+    "tmp": "tmp/contentstack-3.14.0.tgz_1477830884275_0.9869455888401717"
   },
   "devDependencies": {
     "@types/jest": "^26.0.24",
@@ -73,33 +73,34 @@
     "babel-preset-es2016": "6.24.1",
     "babel-preset-stage-1": "6.24.1",
     "babel-runtime": "6.26.0",
+    "clean-webpack-plugin": "^4.0.0",
     "compression-webpack-plugin": "1.0.1",
     "es3ify-loader": "0.2.0",
     "fetch-mock-jest": "^1.3.0",
     "http-proxy-agent": "^3.0.0",
     "istanbul": "^0.4.5",
-    "jest": "^26.4.2",
+    "jest": "^27.2.5",
     "jest-html-reporters": "^2.1.6",
     "jsdoc": "^3.6.7",
-    "jshint": "^2.13.0",
-    "nodemailer": "^6.6.3",
+    "jshint": "^2.13.1",
+    "nodemailer": "^6.6.5",
     "request": "^2.88.2",
     "string-replace-loader": "1.3.0",
     "string-replace-webpack-plugin": "0.1.3",
     "tap-html": "^1.0.1",
     "tap-json": "1.0.0",
     "tape": "4.8.0",
     "ts-jest": "^26.5.6",
-    "typescript": "^4.3.5",
+    "typescript": "^4.4.3",
     "uglify-js": "2.8.29",
-    "webpack": "^5.44.0",
-    "webpack-cli": "^3.3.12",
+    "webpack": "^5.56.1",
+    "webpack-cli": "^4.9.0",
     "webpack-md5-hash": "0.0.5",
     "webpack-merge": "4.1.0"
   },
   "dependencies": {
     "@contentstack/utils": "^1.0.2",
-    "es6-promise": "4.1.1",
+    "es6-promise": "^4.1.1",
     "isomorphic-fetch": "^3.0.0",
     "localStorage": "1.0.3"
   }

package.json

@@ -1,7 +1,7 @@
 'use strict';
 
 const webpack = require('webpack');
-const path = require('path');
+const { CleanWebpackPlugin } = require('clean-webpack-plugin')
 
 const Package = require('./../package.json');
 
@@ -28,7 +28,7 @@ module.exports = function(options) {
                     },
                     {
                         loader: 'string-replace-loader',
-                        query: {
+                        options: {
                             search: '{{VERSION}}',
                             replace: Package.version
                         }
@@ -37,7 +37,13 @@ module.exports = function(options) {
             }]
         },
         plugins: [
-            new webpack.IgnorePlugin(/vertx/),
+            new webpack.WatchIgnorePlugin({
+                paths: [/vertx/]
+              }),
+            new CleanWebpackPlugin({
+                protectWebpackAssets: false,
+                cleanAfterEveryBuildPatterns: ['*.LICENSE.txt']
+            })
         ]
     };
 }

webpack/webpack.common.js

@@ -29,7 +29,7 @@ module.exports = function(options) {
                 exclude: '/node_modules/',
                 use: [{
                     loader: 'string-replace-loader',
-                    query: {
+                    options: {
                         search: '{{PLATFORM}}',
                         replace: 'react-native'
                     }

webpack/webpack.nativescript.js

@@ -7,7 +7,6 @@ const commonConfig = require('./webpack.common.js');
 module.exports = function(options) {
     return webpackMerge(commonConfig(), {
         output: {
-            library: "Contentstack",
             libraryTarget: "commonjs2",
             path: path.join(__dirname, "../dist/node"),
             filename: "contentstack.js"
@@ -29,12 +28,12 @@ module.exports = function(options) {
                 exclude: '/node_modules/',
                 use: [{
                     loader: 'string-replace-loader',
-                    query: {
+                    options: {
                         search: '{{PLATFORM}}',
                         replace: 'nodejs'
                     }
                 }],
             }]
-        }
+        },
     });
 }

webpack/webpack.node.js

@@ -29,7 +29,7 @@ module.exports = function(options) {
                 exclude: '/node_modules/',
                 use: [{
                     loader: 'string-replace-loader',
-                    query: {
+                    options: {
                         search: '{{PLATFORM}}',
                         replace: 'react-native'
                     }

webpack/webpack.react-native.js

@@ -29,7 +29,7 @@ module.exports = function(options) {
                 exclude: '/node_modules/',
                 use: [{
                     loader: 'string-replace-loader',
-                    query: {
+                    options: {
                         search: '{{PLATFORM}}',
                         replace: 'web'
                     }