@contentstack/datasync-mongodb-sdk 1.0.9-beta.1

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

@@ -0,0 +1,68 @@
+# 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

@@ -0,0 +1,33 @@
+name: Create JIRA ISSUE
+on:
+  pull_request:
+    types: [opened]
+jobs:
+  security-jira:
+    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: |
+            Snyk | Vulnerability | ${{ github.event.repository.name }} | ${{ github.event.pull_request.title }}
+          description: |
+            PR: ${{ github.event.pull_request.html_url }}
+
+          fields: "${{ secrets.JIRA_FIELDS }}"
+      - name: Transition issue
+        uses: atlassian/gajira-transition@v3
+        with:
+          issue: ${{ steps.create.outputs.issue }}
+          transition: ${{ secrets.JIRA_TRANSITION }}

package/.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: Release
+
+on:
+  push:
+    branches: [feat/2326-npm-publish]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Setup Node.js environment
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22.x"
+
+      # Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Fetch package details (name and version)
+      - name: Get package details
+        id: package
+        uses: codex-team/action-nodejs-package-info@v1.1
+
+      # Install npm-pack-all to create a package archive
+      - name: Install npm-pack-all
+        run: npm install npm-pack-all
+
+      # Pack the package into a .tgz archive
+      - name: Pack the npm package
+        run: node node_modules/.bin/npm-pack-all
+
+      # Publish the package to npm
+      - name: Publish to npm
+        id: publish_npm
+        uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          access: public # Uncomment this line if you want to publish the package as public for first time
+
+      # Auto-tag the new version if a change is detected
+      - name: Auto-tag new version
+        id: update_tag
+        uses: Klemensas/action-autotag@stable
+        with:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          tag_prefix: "v"
+
+      # Create a new GitHub Release
+      - name: Create GitHub Release
+        if: steps.update_tag.outputs.tagname != ''
+        uses: actions/create-release@v1
+        id: create_release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.update_tag.outputs.tagname }}
+          release_name: Release ${{ steps.update_tag.outputs.tagname }}
+          draft: false
+          prerelease: false
+
+      # Upload the packaged .tgz file as a release asset
+      - name: Upload Release Asset
+        if: steps.update_tag.outputs.tagname != ''
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: "./contentstack-datasync-mongodb-sdk-${{ steps.package.outputs.version }}.tgz"
+          asset_name: "contentstack-datasync-mongodb-sdk-${{ steps.package.outputs.version }}.tgz"
+          asset_content_type: application/tgz

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

@@ -0,0 +1,11 @@
+name: SAST Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-sast:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Semgrep Scan
+        run: docker run -v /var/run/docker.sock:/var/run/docker.sock -v "${PWD}:/src" returntocorp/semgrep semgrep scan --config auto

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

@@ -0,0 +1,15 @@
+name: Source Composition Analysis Scan
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  security-sca:
+    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 --fail-on=all

package/.talismanrc

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

package/CODEOWNERS

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

package/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2025 Contentstack LLC <https://www.contentstack.com/>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,191 @@
+[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
+
+## Contentstack DataSync MongoDB SDK
+
+[Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync) provides MongoDB SDK to query applications that have locally stored contents in mongodb. Given below is the detailed guide and helpful resources to get started.
+
+### Prerequisite
+
+- Nodejs, v20+
+- MongoDB, v3.6 or higher
+- You should have the data synced through [Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync) 
+
+**Note**
+For optimal performance, we recommend that you add indexes on the following keys of your collections
+- `_content_type_uid: 1`
+- `uid: 1`
+- `locale: 1`
+<!-- Since by default, the contents are sorted in descending order on 'updated_at' key -->
+- `updated_at: -1`
+
+### Configuration
+
+|Property|Type|Default value|Description|
+|--|--|--|--|
+|dbName|string|contentstack-persistent-db|**Optional** The MongoDB database name|
+|collection|string|contents|**Optional** MongoDB database's collection names|
+|url|string|mongodb://localhost:27017 |**Optional.** The MongoDB connection URI|
+|limit|number|100|**Optional.** Caps the total no of objects returned in a single call|
+|skip|number|0|**Optional.** Number of objects skipped before the result is returned|
+| indexes | object |**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Option to create db indexes via configuration|
+|projections|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Mongodb projections. Keys provided here would be displayed/filtered out when fetching the result|
+|options|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** MongoDB connection options [Ref.](http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html) for more info|
+|referenceDepth|number|2|**Optional** The default nested-reference-field depth that'd be considered when calling .includeReferences(). This can be overridden by passing a numerical argument to .includeReferences(4)|
+
+### Config Overview
+
+Here's an overview of the SDK's configurable properties
+
+```ts
+{
+  contentStore: {
+    collection: {
+      asset: 'contents',
+      entry: 'contents',
+      schema: 'content_types',
+    },
+    dbName: 'contentstack-db',
+    indexes: {
+      _content_type_uid: 1,
+      locale: 1,
+      uid: 1,
+      updated_at: -1,
+    },
+    limit: 100,
+    locale: 'en-us',
+    // http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html
+    options: {
+      autoReconnect: true,
+      connectTimeoutMS: 15000,
+      keepAlive: true,
+      noDelay: true,
+      reconnectInterval: 1000,
+      reconnectTries: 20,
+      useNewUrlParser: true,
+    },
+    projections: {
+      _content_type_uid: 0,
+      _id: 0,
+    },
+    referenceDepth: 2,
+    skip: 0,
+    url: 'mongodb://localhost:27017',
+  },
+}
+```
+
+### Sample SDK Query
+
+Here's a sample SDK query to get started.
+
+Learn more on how to query using datasync-mongodb-sdk [here](https://contentstack.github.io/datasync-mongodb-sdk/).
+
+```ts
+import { Contentstack } from 'datasync-mongodb-sdk'
+const Stack = Contentstack.Stack(config)
+
+Stack.connect()
+  .then(() => {
+    return Stack.contentType('blog')
+      .entries()
+      .language('en-gb') // Optional. If not provided, defaults to en-us
+      .include(['authors'])
+      .includeCount()
+      .includeContentType()
+      .queryReferences({'authors.firstName': 'R.R. Martin'})
+      .then((result) => {
+        // Your result would be
+        // {
+        //   entries: [...], // All entries, who's first name is R.R. Martin
+        //   content_type_uid: 'blog',
+        //   locale: 'es-es',
+        //   content_type: {...}, // Blog content type's schema
+        //   count: 3, // Total count of blog content type
+        // }
+      })
+  })
+  .catch((error) => {
+    // handle errors..
+  })
+```
+> Important: You need to call .connect(), to initiate SDK queries!
+
+Once you have initialized the SDK, you can start querying on mongodb
+
+### Querying
+- Notes
+  - By default, 'content_type_uid' and 'locale' keys as part of the response.
+  - If `.language()` is not provided, then the 1st language, provided in `config.defaultLocale` would be considered.
+  - If querying for a single entry/asset (using `.entry()` OR `.findOne()`), the result will be an object i.e. `{ entry: {} }`, if the entry or asset is not found, `{ entry: null }` will be returned.
+  - Querying multiple entries, would return `{ entries: [ {...} ] }`.
+  - By default, all entry responses would include their referred assets. If `.excludeReferences()` is called, no references (including assets) would **not** be returned in the response.
+
+- Query a single entry
+```ts
+// Sample 1. Returns the 1st entry that matches query filters
+Stack.contentType('blog')
+  .entry() // OR .asset()
+  .find()
+  .then((result) => {
+    // Response
+    // result = {
+    //   entry: any | null,
+    //   content_type_uid: string,
+    //   locale: string,
+    // }
+  })
+  .catch(reject)
+
+// Sample 2. Returns the 1st entry that matches query filters
+Stack.contentType('blogs')
+  .entries() // for .assets() 
+  .findOne()
+  .then((result) => {
+    // Response
+    // result = {
+    //   entry: any | null,
+    //   content_type_uid: string,
+    //   locale: string,
+    // }
+  })
+  .catch(reject)
+```
+
+- Querying a set of entries, assets or content types
+```ts
+Stack.contentType('blog')
+  .entries() // for .assets() 
+  .includeCount()
+  .find()
+  .then((result) => {
+    // Response
+    // result = {
+    //   entry: any | null,
+    //   content_type_uid: string,
+    //   count: number,
+    //   locale: string,
+    // }
+  })
+  .catch(reject)
+```
+
+## Advanced Queries
+
+In order to learn more about advance queries please refer the API documentation, [here](https://contentstack.github.io/datasync-mongodb-sdk/).
+
+### Further Reading
+
+- [Getting started with Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync)    
+- [Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync/configuration-files-for-contentstack-datasync) doc lists the configuration for different modules
+
+### Support and Feature requests
+
+If you have any issues working with the library, please file an issue [here](https://github.com/contentstack/datasync-mongodb-sdk/issues) at Github.
+
+You can send us an e-mail at [support@contentstack.com](mailto:support@contentstack.com) if you have any support or feature requests. Our support team is available 24/7 on the intercom. You can always get in touch and give us an opportunity to serve you better!
+
+### License
+
+This repository is published under the [MIT license](LICENSE).

package/SECURITY.md

@@ -0,0 +1,27 @@
+## 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/dist/config.js

@@ -0,0 +1,47 @@
+"use strict";
+/*!
+ * Contentstack DataSync Mongodb SDK
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+exports.config = {
+    contentStore: {
+        collection: {
+            asset: 'contents',
+            entry: 'contents',
+            schema: 'content_types',
+        },
+        dbName: 'contentstack-db',
+        indexes: {
+            _content_type_uid: 1,
+            locale: 1,
+            uid: 1,
+            updated_at: -1,
+        },
+        internal: {
+            types: {
+                assets: '_assets',
+                content_types: '_content_types',
+                references: '_references',
+            },
+        },
+        limit: 100,
+        locale: 'en-us',
+        // http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html
+        options: {
+            connectTimeoutMS: 15000,
+            // keepAlive: true, // The keepAlive option was deprecated in the Node.js Driver starting from version 5.3. In version 6.0 of the driver, the keepAlive option is permanently set to true
+            noDelay: true,
+            useNewUrlParser: true,
+        },
+        projections: {
+            _content_type_uid: 0,
+            _id: 0,
+        },
+        referenceDepth: 2,
+        skip: 0,
+        url: 'mongodb://localhost:27017',
+    },
+};

package/dist/index.js

@@ -0,0 +1,42 @@
+"use strict";
+/*!
+ * Contentstack DataSync Mongodb SDK
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contentstack = void 0;
+const stack_1 = require("./stack");
+/**
+ * @class Stack
+ * @description Initialize an instance of `Stack`
+ * @api public
+ * @example
+ * const Stack = Contentstack.Stack({
+ *  contentStore: {
+ *    baseDir: '../../dev-contents'
+ *  },
+ *  locales: [
+ *    {
+ *      code: 'en-us',
+ *      relative_url_prefix: '/'
+ *    }
+ *  ]
+ * })
+ *
+ * @returns {Stack} Returns Stack method, which's used to create an instance of Stack
+ */
+class Contentstack {
+    /**
+     * @public
+     * @method Stack
+     * @summary Initialize Stack instance
+     * @param {object} config Stack config
+     * @param {object} db Existing db connection
+     * @returns {Stack} - Returns an instance of `Stack`
+     */
+    static Stack(config, db) {
+        return new stack_1.Stack(config, db);
+    }
+}
+exports.Contentstack = Contentstack;