Merge pull request #22 from contentstack/feat/branches

feat: added support for branches

Author: shafeeqd959

package-lock.json

@@ -1,10 +1,11 @@
 {
   "name": "@contentstack/datasync-manager",
   "author": "Contentstack LLC <support@contentstack.com>",
-  "version": "1.2.4",
+  "version": "2.0.0",
   "description": "The primary module of Contentstack DataSync. Syncs Contentstack data with your server using Contentstack Sync API",
   "main": "dist/index.js",
   "dependencies": {
+    "@braintree/sanitize-url": "^6.0.2",
     "debug": "^4.3.4",
     "dns-socket": "^4.2.2",
     "lodash": "^4.17.21",
@@ -34,7 +35,7 @@
     "semantic-release": "^19.0.5",
     "ts-jest": "^29.0.1",
     "tslint": "^5.18.0",
-    "typescript": "^3.9.2"
+    "typescript": "^4.9.4"
   },
   "scripts": {
     "clean": "rimraf dist typings coverage .tokens .ledger .checkpoint",

package.json

@@ -8,6 +8,7 @@ import Debug from 'debug'
 import { request } from 'https'
 import { join } from 'path'
 import { stringify } from 'querystring'
+import { sanitizeUrl } from '@braintree/sanitize-url';
 import { readFileSync } from './util/fs'
 
 const debug = Debug('api')
@@ -25,6 +26,7 @@ export const init = (contentstack) => {
     'X-User-Agent': `datasync-manager/v${packageInfo.version}`,
     'access_token': Contentstack.deliveryToken,
     'api_key': Contentstack.apiKey,
+    branch: Contentstack.branch,
   }
 
   if (Contentstack.MAX_RETRY_LIMIT) {
@@ -52,7 +54,7 @@ export const get = (req, RETRY = 1) => {
       headers: Contentstack.headers,
       hostname: Contentstack.host,
       method: Contentstack.verbs.get,
-      path: req.path,
+      path: sanitizeUrl(req.path),
       port: Contentstack.port,
       protocol: Contentstack.protocol,
     }

src/api.ts

@@ -14,6 +14,7 @@ import { series } from '../util/series'
 import { saveFailedItems } from '../util/unprocessible'
 import { load } from './plugins'
 import { saveToken } from './token-management'
+import { getConfig } from '../index';
 
 const debug = Debug('q')
 const notifications = new EventEmitter()
@@ -159,6 +160,8 @@ export class Q extends EventEmitter {
       const contentType = data._content_type_uid
       const locale = data.locale
       const uid = data.uid
+      const branch = getConfig().contentstack.branch
+      data.branch = branch
 
       if (data.hasOwnProperty('_checkpoint')) {
         checkpoint = data._checkpoint
@@ -216,6 +219,7 @@ export class Q extends EventEmitter {
 
       debug(`Completed '${action}' on connector successfully!`)
       if (typeof schema !== 'undefined') {
+        schema.branch = branch
         await this.contentStore.updateContentType(schema)
       }
 

src/core/q.ts

@@ -110,7 +110,7 @@ export const saveToken = (name, token) => {
         await writeFile(file, JSON.stringify(ledgerDetails))
       }
 
-      return resolve()
+      return resolve('')
     } catch (error) {
       return reject(error)
     }

src/core/token-management.ts

@@ -229,7 +229,7 @@ export const start = (config: IConfig = {}): Promise<{}> => {
       }).then(() => {
         logger.info('Contentstack sync utility started successfully!')
 
-        return resolve()
+        return resolve('')
       }).catch(reject)
     } catch (error) {
       return reject(error)

src/index.ts

@@ -36,7 +36,7 @@ export const writeFile = (filePath, data) => {
           return reject(wfError)
         }
 
-        return resolve()
+        return resolve('')
       })
     } catch (writeFileError) {
 
@@ -108,7 +108,7 @@ export const mkdir = (path) => {
           return reject(error)
         }
 
-        return resolve()
+        return resolve('')
       })
     } catch (error) {
       return reject(error)

src/util/fs.ts

@@ -50,7 +50,7 @@ export const saveFilteredItems = (items, name, token) => {
       const config = getConfig()
       let filename
       if (!config.syncManager.saveFilteredItems) {
-        return resolve()
+        return resolve('')
       }
       const objDetails = {
         items,
@@ -80,21 +80,21 @@ export const saveFilteredItems = (items, name, token) => {
             logger.error(`Failed to write ${JSON.stringify(loggedItems)} at ${error}`)
             logger.error(error)
 
-            return resolve()
+            return resolve('')
           })
         }).catch((error) => {
           logger.error(`Failed to read file from path ${fail}`)
           logger.error(error)
 
-          return resolve()
+          return resolve('')
         })
       }
 
       return writeFile(file, JSON.stringify([objDetails])).then(resolve).catch((error) => {
         logger.error(`Failed while writing ${JSON.stringify(objDetails)} at ${file}`)
         logger.error(error)
 
-        return resolve()
+        return resolve('')
       })
     } catch (error) {
       return reject(error)

src/util/unprocessible.ts

@@ -21,8 +21,8 @@ export const validateConfig = (config) => {
       throw new Error(`Config '${key}' key cannot be undefined`)
     }
   })
-  if (typeof config.contentstack !== 'object' || !config.contentstack.apiKey || !config.contentstack.deliveryToken) {
-    throw new Error('Config \'contentstack\' should be of type object and have \'apiKey\' and \'token\'')
+  if (typeof config.contentstack !== 'object' || !config.contentstack.apiKey || !config.contentstack.deliveryToken || !config.contentstack.branch) {
+    throw new Error('Config \'contentstack\' should be of type object and have \'apiKey\', \'token\' and \'branch\'')
   }
 
   if (config.queue) {