@contentstack/datasync-manager 1.2.4 → 2.0.1

package/dist/util/validations.js

@@ -13,7 +13,7 @@ const lodash_1 = require("lodash");
  * @description Check's if the application's config is enough to start the app without errors
  * @param {Object} config - Application config
  */
-exports.validateConfig = (config) => {
+const validateConfig = (config) => {
     const keys = ['listener', 'assetStore', 'contentStore', 'syncManager', 'contentstack',
         'locales',
     ];
@@ -23,7 +23,7 @@ exports.validateConfig = (config) => {
         }
     });
     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\'');
+        throw new Error('Config \'contentstack\' should be of type object and have \'apiKey\', \'token\'');
     }
     if (config.queue) {
         if (config.queue.resume_threshold >= config.queue.pause_threshold) {
@@ -31,92 +31,98 @@ exports.validateConfig = (config) => {
         }
     }
 };
+exports.validateConfig = validateConfig;
 /**
  * @public
  * @method validateAssetStore
  * @description Validates if provided asset store has required methods
  * @param {Object} assetStore - Asset store
  */
-exports.validateAssetStore = (assetStore) => {
+const validateAssetStore = (assetStore) => {
     if (typeof assetStore !== 'object' && typeof assetStore !== 'function') {
         throw new Error('Invalid Type! Asset store is of neither \'object\' or \'function\'!');
     }
     const methods = ['getConfig', 'getAssetLocation', 'setConfig', 'start'];
     methods.forEach((method) => {
-        if (!(lodash_1.hasIn(assetStore, method)) && typeof assetStore[method] === 'function') {
+        if (!((0, lodash_1.hasIn)(assetStore, method)) && typeof assetStore[method] === 'function') {
             throw new Error(`Missing required methods! Asset store is missing '${method}()'!`);
         }
     });
 };
+exports.validateAssetStore = validateAssetStore;
 /**
  * @public
  * @method validateContentStore
  * @description Validates if provided content store has required methods
  * @param {Object} contentStore - Content store
  */
-exports.validateContentStore = (contentStore) => {
+const validateContentStore = (contentStore) => {
     if (typeof contentStore !== 'object' && typeof contentStore !== 'function') {
         throw new Error('Invalid Type! Content store is of neither \'object\' or \'function\'!');
     }
     const methods = ['getConfig', 'setConfig', 'setAssetStore', 'start'];
     methods.forEach((method) => {
-        if (!(lodash_1.hasIn(contentStore, method)) && typeof contentStore[method] === 'function') {
+        if (!((0, lodash_1.hasIn)(contentStore, method)) && typeof contentStore[method] === 'function') {
             throw new Error(`Missing required methods! Content store is missing '${method}()'!`);
         }
     });
 };
+exports.validateContentStore = validateContentStore;
 /**
  * @public
  * @method validateListener
  * @description Validates if the provided listener supports required methods
  * @param {Object} listener - Listener instance
  */
-exports.validateListener = (listener) => {
+const validateListener = (listener) => {
     if (typeof listener !== 'object' && typeof listener !== 'function') {
         throw new Error('Invalid Type! Listener is of neither \'object\' or \'function\'!');
     }
     const methods = ['getConfig', 'setConfig', 'start', 'register'];
     methods.forEach((method) => {
-        if (!(lodash_1.hasIn(listener, method)) || typeof listener[method] !== 'function') {
+        if (!((0, lodash_1.hasIn)(listener, method)) || typeof listener[method] !== 'function') {
             throw new Error(`Missing required methods! Listener is missing '${method}()'!`);
         }
     });
 };
+exports.validateListener = validateListener;
 /**
  * @public
  * @method validateContentStoreInstance
  * @description Validates if the registered content store supports required methods
  * @param {Object} instance - Content store instance
  */
-exports.validateContentStoreInstance = (instance) => {
+const validateContentStoreInstance = (instance) => {
     const fns = ['publish', 'unpublish', 'delete', 'updateContentType'];
     fns.forEach((fn) => {
-        if (!(lodash_1.hasIn(instance, fn)) && typeof instance[fn] === 'function') {
+        if (!((0, lodash_1.hasIn)(instance, fn)) && typeof instance[fn] === 'function') {
             throw new Error(`${instance} content store does not support '${fn}()'`);
         }
     });
 };
+exports.validateContentStoreInstance = validateContentStoreInstance;
 /**
  * @public
  * @method validateAssetStoreInstance
  * @description Validates if the registered asset store supports required methods
  * @param {Object} instance - Asset store instance
  */
-exports.validateAssetStoreInstance = (instance) => {
+const validateAssetStoreInstance = (instance) => {
     const fns = ['delete', 'download', 'unpublish'];
     fns.forEach((fn) => {
-        if (!(lodash_1.hasIn(instance, fn)) && typeof instance[fn] === 'function') {
+        if (!((0, lodash_1.hasIn)(instance, fn)) && typeof instance[fn] === 'function') {
             throw new Error(`${instance} asset store does not support '${fn}()'`);
         }
     });
 };
+exports.validateAssetStoreInstance = validateAssetStoreInstance;
 /**
  * @public
  * @method validateExternalInput
  * @description Validates if the input provided by external method into 'Q' conforms standards
  * @param {Object} data - Input data
  */
-exports.validateExternalInput = (data) => {
+const validateExternalInput = (data) => {
     if (typeof data._content_type_uid !== 'string' || data._content_type_uid.length === 0) {
         throw new Error('data._content_type_uid should be of type string and not empty!');
     }
@@ -126,15 +132,16 @@ exports.validateExternalInput = (data) => {
     if (typeof data.locale !== 'string' || data.locale.length === 0) {
         throw new Error('data.locale should be of type string and not empty!');
     }
-    if (!(lodash_1.isPlainObject(data)) || lodash_1.isEmpty(data)) {
+    if (!((0, lodash_1.isPlainObject)(data)) || (0, lodash_1.isEmpty)(data)) {
         throw new Error('data should be of type object and not empty!');
     }
 };
+exports.validateExternalInput = validateExternalInput;
 /**
  * @description Validates if the custom logger set supports required methods
  * @param {Object} instance - Custom logger instance
  */
-exports.validateLogger = (instance) => {
+const validateLogger = (instance) => {
     let flag = false;
     if (!instance) {
         return flag;
@@ -147,7 +154,8 @@ exports.validateLogger = (instance) => {
     });
     return !flag;
 };
-exports.validateItemStructure = (item) => {
+exports.validateLogger = validateLogger;
+const validateItemStructure = (item) => {
     try {
         if (!(item.type) || typeof item.type !== 'string' || !(item.type.length)) {
             item._error = '\'type\' key is missing!';
@@ -174,12 +182,13 @@ exports.validateItemStructure = (item) => {
         return false;
     }
 };
+exports.validateItemStructure = validateItemStructure;
 const assetPublishedStructure = (asset) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.url', 'data.publish_details',
         'data.publish_details.locale', 'data.title',
     ];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(asset, key))) {
+        if (!((0, lodash_1.hasIn)(asset, key))) {
             asset._error = asset._error || '';
             asset._error += `${key} is missing!\t`;
         }
@@ -189,17 +198,18 @@ const assetPublishedStructure = (asset) => {
     }
     return true;
 };
-exports.validatePlugin = (plugin) => {
+const validatePlugin = (plugin) => {
     if (!plugin.name || typeof plugin.name !== 'string' || plugin.name.length < 1) {
         throw new Error(`Invalid plugin config, 'plugin.name' is a required property!`);
     }
 };
+exports.validatePlugin = validatePlugin;
 const entryPublishedStructure = (entry) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.publish_details',
         'data.publish_details.locale',
     ];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(entry, key))) {
+        if (!((0, lodash_1.hasIn)(entry, key))) {
             entry._error = entry._error || '';
             entry._error += `${key} is missing!`;
         }
@@ -212,7 +222,7 @@ const entryPublishedStructure = (entry) => {
 const assetDeletedStructure = (asset) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.locale'];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(asset, key))) {
+        if (!((0, lodash_1.hasIn)(asset, key))) {
             asset._error = asset._error || '';
             asset._error += `${key} is missing!`;
         }
@@ -225,7 +235,7 @@ const assetDeletedStructure = (asset) => {
 const entryDeletedStructure = (entry) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.locale'];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(entry, key))) {
+        if (!((0, lodash_1.hasIn)(entry, key))) {
             entry._error = entry._error || '';
             entry._error += `${key} is missing!`;
         }
@@ -238,7 +248,7 @@ const entryDeletedStructure = (entry) => {
 const assetUnpublishedStructure = (asset) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.locale'];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(asset, key))) {
+        if (!((0, lodash_1.hasIn)(asset, key))) {
             asset._error = asset._error || '';
             asset._error += `${key} is missing!`;
         }
@@ -251,7 +261,7 @@ const assetUnpublishedStructure = (asset) => {
 const entryUnpublishedStructure = (entry) => {
     const requiredKeys = ['content_type_uid', 'data', 'data.uid', 'data.locale'];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(entry, key))) {
+        if (!((0, lodash_1.hasIn)(entry, key))) {
             entry._error = entry._error || '';
             entry._error += `${key} is missing!`;
         }
@@ -264,7 +274,7 @@ const entryUnpublishedStructure = (entry) => {
 const contentTypeDeletedStructure = (contentType) => {
     const requiredKeys = ['content_type_uid'];
     requiredKeys.forEach((key) => {
-        if (!(lodash_1.hasIn(contentType, key))) {
+        if (!((0, lodash_1.hasIn)(contentType, key))) {
             contentType._error = contentType._error || '';
             contentType._error += `${key} is missing!`;
         }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@contentstack/datasync-manager",
   "author": "Contentstack LLC <support@contentstack.com>",
-  "version": "1.2.4",
+  "version": "2.0.1",
   "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",
@@ -56,6 +57,11 @@
     "DataSync",
     "utility"
   ],
+  "files": [
+    "/dist",
+    "/typings",
+    "/npm-shrinkwrap.json"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/contentstack/datasync-manager"

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: "[BUG]"
-labels: bug
-assignees: iyerrama29, ninadhatkar
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Setup
-2. Configuration info (except api_key/tokens)
-3. Content type schema & entry details / asset details (if possible)
-4. Copy paste the error in detail
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: "[FEATURE]"
-labels: enhancement
-assignees: iyerrama29, ninadhatkar
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/codeql-analysis.yml

@@ -1,68 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: '*'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2

package/.github/workflows/jira.yml

@@ -1,28 +0,0 @@
-name: Create JIRA ISSUE
-on:
-  pull_request:
-    types: [opened]
-jobs:
-  security:
-    if: ${{ github.actor == 'dependabot[bot]' || github.actor == 'snyk-bot' || contains(github.event.pull_request.head.ref, 'snyk-fix-')  || contains(github.event.pull_request.head.ref, 'snyk-upgrade-')}}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Login into JIRA
-        uses: atlassian/gajira-login@master
-        env:
-          JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
-          JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
-          JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
-      - name: Create a JIRA Issue
-        id: create
-        uses: atlassian/gajira-create@master
-        with:
-          project: ${{ secrets.JIRA_PROJECT }}
-          issuetype: ${{ secrets.JIRA_ISSUE_TYPE }}
-          summary: |
-            ${{ github.event.pull_request.title }}
-          description: |
-            PR: ${{ github.event.pull_request.html_url }}
-
-          fields: "${{ secrets.JIRA_FIELDS }}"

package/.github/workflows/release.yml

@@ -1,53 +0,0 @@
-name: Release
-on:
-  push:
-    branches:
-      - master
-jobs:
-  build:
-    name: Build and upload
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12
-      - name: Install dependencies
-        run: npm install
-      - name: Build
-        run: npm run build-ts
-      - name: Upload dist
-        uses: actions/upload-artifact@v3
-        with:
-          name: dist
-          path: dist
-
-  release:
-    name: Download dist and release
-    runs-on: ubuntu-latest
-    needs: build
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12
-      - name: Install dependencies
-        run: npm install
-      - name: Download dist
-        uses: actions/download-artifact@v3
-        with:
-          name: dist
-          run: ls dist
-      - name: Release
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release

package/.github/workflows/sast-scan.yml

@@ -1,11 +0,0 @@
-name: SAST Scan
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-jobs:
-  security:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Horusec Scan
-        run: docker run -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/src horuszup/horusec-cli:latest horusec start -p /src -P $(pwd)

package/.github/workflows/sca-scan.yml

@@ -1,15 +0,0 @@
-name: Source Composition Analysis Scan
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-jobs:
-  security:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Run Snyk to check for vulnerabilities
-        uses: snyk/actions/node@master
-        env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-        with:
-          args: --all-projects

package/.github/workflows/secrets-scan.yml

@@ -1,11 +0,0 @@
-name: Secrets Scan
-on:
-  pull_request:
-    types: [opened, synchronize, reopened]
-jobs:
-  security:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Gittyleaks
-        uses: gupy-io/gittyleaks-action@v0.1

package/.releaserc

@@ -1,9 +0,0 @@
-{
-    "branches": ["master"],
-    "plugins": [
-        "@semantic-release/commit-analyzer",
-        "@semantic-release/release-notes-generator",
-        "@semantic-release/npm",
-        "@semantic-release/git"
-    ]
-}

package/.talismanrc

@@ -1,4 +0,0 @@
-fileignoreconfig:
-- filename: package-lock.json
-  checksum: c95ab8723f7a15c72d1e6f2f6b2eb173ce46b14e4bcd864cc47119b60e1866de
-version: ""

package/CODEOWNERS

@@ -1 +0,0 @@
-* @contentstack/security-admin @contentstack/cli-admin

package/SECURITY.md

@@ -1,27 +0,0 @@
-## Security
-
-Contentstack takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations.
-
-If you believe you have found a security vulnerability in any Contentstack-owned repository, please report it to us as described below.
-
-## Reporting Security Issues
-
-**Please do not report security vulnerabilities through public GitHub issues.**
-
-Send email to [security@contentstack.com](mailto:security@contentstack.com).
-
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
-
-Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
-
-- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
-- Full paths of source file(s) related to the manifestation of the issue
-- The location of the affected source code (tag/branch/commit or direct URL)
-- Any special configuration required to reproduce the issue
-- Step-by-step instructions to reproduce the issue
-- Proof-of-concept or exploit code (if possible)
-- Impact of the issue, including how an attacker might exploit the issue
-
-This information will help us triage your report more quickly.
-
-[https://www.contentstack.com/trust/](https://www.contentstack.com/trust/)

package/example/config.js

@@ -1,60 +0,0 @@
-module.exports = {
-  contentstack: {
-    apiKey: '',
-    deliveryToken: ''
-  },
-  contentStore: {
-    dbName: 'contentstack',
-    collectionName: 'development'
-  },
-  assetStore: {
-    baseDir: './_development_contents'
-  },
-  plugins: [
-    {
-      disabled: false,
-      name: '_cs_internal_transform_entries',
-      // path: '',
-      options: {
-        // other overrides...
-      },
-    },
-    {
-      disabled: false,
-      name: '_cs_internal_transform_schemas',
-      options: {
-        logAssetPaths: true,
-        logReferencePaths: true,
-        // other overrides...
-      },
-    },
-    {
-      disabled: false,
-      name: '_cs_internal_save_rte_markdown_assets',
-      options: {
-        // other overrides...
-      },
-    },
-  ],
-  syncManager: {
-    inet: {
-      dns: '8.8.8.8',
-      host: 'google.com',
-      port: 53,
-      retries: 2,
-      retryTimeout: 3 * 1000,
-      retryIncrement: 1 * 1000,
-      timeout: 6 * 1000,
-      type: 'A',
-    },
-    processTimeout: 0
-  },
-  // filtering now available!
-  // syncManager: {
-  //   filters: {
-  //     content_type_uid: ['authors'],
-  //     locale: ['en-us'],
-  //     action: ['publish']
-  //   }
-  // }
-}

package/example/index.js

@@ -1,30 +0,0 @@
-const assetStore = require('@contentstack/datasync-asset-store-filesystem')
-//const contentStore = require('@contentstack/datasync-content-store-mongodb')
-
-const contentStore = require('@contentstack/datasync-content-store-filesystem')
-const listener = require('@contentstack/webhook-listener')
-const syncManager = require('../dist/index')
-const config = require('./config')
-
-syncManager.setAssetStore(assetStore)
-syncManager.setContentStore(contentStore)
-syncManager.setListener(listener)
-syncManager.setConfig(config)
-
-syncManager.start().then(() => {
-  console.log('Sync utility started successfully!')
-}).catch(console.error)
-
-syncManager.notifications
-  .on('publish', (obj) => {
-    // console.log('SYNC-PUBLISH: ', obj)
-  })
-  .on('unpublish', (obj) => {
-    // console.log('SYNC-UNPUBLISH: ', obj)
-  })
-  .on('delete', (obj) => {
-    // console.log('SYNC-DELETE: ', obj)
-  })
-  .on('error', (obj) => {
-    // console.log('SYNC-ERROR: ', obj)
-  })