npm - @contentstack/datasync-mongodb-sdk - Versions diffs - 1.0.9-beta.1 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

package/.github/workflows/codeql-analysis.yml +68 -0
package/.github/workflows/jira.yml +33 -0
package/.github/workflows/release.yml +77 -0
package/.github/workflows/sast-scan.yml +11 -0
package/.github/workflows/sca-scan.yml +15 -0
package/.talismanrc +4 -0
package/CODEOWNERS +1 -0
package/LICENCE +21 -0
package/README.md +191 -0
package/SECURITY.md +27 -0
package/contentstack-datasync-mongodb-sdk-1.0.9-beta.1.tgz +0 -0
package/dist/config.js +47 -0
package/dist/index.js +42 -0
package/dist/stack.js +2272 -0
package/dist/util.js +86 -0
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/global.html +7520 -0
package/docs/global.html#Stack +1070 -0
package/docs/index.html +291 -0
package/docs/index.js.html +92 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/stack.js.html +2244 -0
package/docs/styles/jsdoc-default.css +358 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/example/index.js +56 -0
package/package.json +59 -0
package/test/comparison-operators.ts +257 -0
package/test/conditional-operators.ts +106 -0
package/test/config.ts +12 -0
package/test/core.ts +333 -0
package/test/count.ts +98 -0
package/test/data/assets.ts +35 -0
package/test/data/author.ts +168 -0
package/test/data/blog.ts +138 -0
package/test/data/category.ts +20 -0
package/test/data/content_types.ts +164 -0
package/test/data/products.ts +64 -0
package/test/expressions.ts +108 -0
package/test/include-exclude.ts +176 -0
package/test/logical-operators.ts +140 -0
package/test/projections.ts +109 -0
package/test/queries.ts +143 -0
package/test/references.ts +162 -0
package/test/skip-limit.ts +150 -0
package/test/sorting.ts +177 -0
package/tslint.json +45 -0
package/typings/config.d.ts +42 -0
package/typings/index.d.ts +36 -0
package/typings/stack.d.ts +1097 -0
package/typings/util.d.ts +28 -0

package/docs/global.html#Stack ADDED Viewed

@@ -0,0 +1,1070 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Stack</title>
+    <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js" integrity="sha384-hDHlUtmnjnJimeAhT+DpLqjLdp8vFgSFHhZO1zq2EtqpwFsNM7H5cpSUYqT1Uh2E" crossorigin="anonymous"> </script>
+    <script src="scripts/prettify/lang-css.js" integrity="=sha384-ZVW4Q90WP44LAxvcmnOQ3FYYiuBwyy/plPaSRSP9g4z61NRCtowdPA4A2to4Ui9A%" crossorigin="anonymous"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<div id="main">
+    <h1 class="page-title">Class: Stack</h1>
+<section>
+<header>
+        <h2><span class="attribs"><span class="type-signature"></span></span>Stack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h2>
+            <div class="class-description">Stack</div>
+</header>
+<article>
+    <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="Stack"><span class="type-signature"></span>new Stack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="stack.js.html">stack.js</a>, <a href="stack.js.html#line32">line 32</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    Returns an instance of `Stack`
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#Stack">Stack</a></span>
+    </dd>
+</dl>
+    </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="includeSchema"><span class="type-signature"></span>includeSchema<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h4>
+<div class="description">
+    Includes 'content_type' key in response, which is the content type schema of the entries filtered/scanned
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="stack.js.html">stack.js</a>, <a href="stack.js.html#line1295">line 1295</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    Returns an instance of 'stack'
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#Stack">Stack</a></span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>Stack
+ .contentType('blog')
+ .entries()
+ .includeSchema()
+ .find()
+ .then((result) => {
+   // returns entries, along with a 'content_type' property, which is 'blog' content type's schema
+ })
+ .catch((error) => {
+   // handle query errors
+ })</code></pre>
+    <h4 class="name" id="includeSpecificReferences"><span class="type-signature"></span>includeSpecificReferences<span class="signature">(entry, contentTypeUid, locale, include)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <p class="summary">Internal method, that iteratively calls itself and binds entries reference</p>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>entry</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">An entry or a collection of entries, who's references are to be found</td>
+        </tr>
+        <tr>
+                <td class="name"><code>contentTypeUid</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Content type uid</td>
+        </tr>
+        <tr>
+                <td class="name"><code>locale</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Locale, in which the reference is to be found</td>
+        </tr>
+        <tr>
+                <td class="name"><code>include</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">Array of field paths, to be included</td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="stack.js.html">stack.js</a>, <a href="stack.js.html#line1801">line 1801</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    - Returns `entries`, that has all of its reference binded
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Object</span>
+    </dd>
+</dl>
+</article>
+</section>
+<section>
+<header>
+        <h2><span class="attribs"><span class="type-signature"></span></span>Stack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h2>
+</header>
+<article>
+    <div class="container-overview">
+    <h4 class="name" id="Stack"><span class="type-signature"></span>new Stack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h4>
+<div class="description">
+    Initialize an instance of `Stack`
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line9">line 9</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    Returns Stack method, which's used to create an instance of Stack
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#Stack">Stack</a></span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>const Stack = Contentstack.Stack({
+ contentStore: {
+   baseDir: '../../dev-contents'
+ },
+ locales: [
+   {
+     code: 'en-us',
+     relative_url_prefix: '/'
+   }
+ ]
+})</code></pre>
+    </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="includeSchema"><span class="type-signature"></span>includeSchema<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="global.html#Stack">Stack</a>}</span></h4>
+<div class="description">
+    Includes 'content_type' key in response, which is the content type schema of the entries filtered/scanned
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="stack.js.html">stack.js</a>, <a href="stack.js.html#line1295">line 1295</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    Returns an instance of 'stack'
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type"><a href="global.html#Stack">Stack</a></span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <pre class="prettyprint"><code>Stack
+ .contentType('blog')
+ .entries()
+ .includeSchema()
+ .find()
+ .then((result) => {
+   // returns entries, along with a 'content_type' property, which is 'blog' content type's schema
+ })
+ .catch((error) => {
+   // handle query errors
+ })</code></pre>
+    <h4 class="name" id="includeSpecificReferences"><span class="type-signature"></span>includeSpecificReferences<span class="signature">(entry, contentTypeUid, locale, include)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    <p class="summary">Internal method, that iteratively calls itself and binds entries reference</p>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>entry</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">An entry or a collection of entries, who's references are to be found</td>
+        </tr>
+        <tr>
+                <td class="name"><code>contentTypeUid</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Content type uid</td>
+        </tr>
+        <tr>
+                <td class="name"><code>locale</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">Locale, in which the reference is to be found</td>
+        </tr>
+        <tr>
+                <td class="name"><code>include</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">Array of field paths, to be included</td>
+        </tr>
+    </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="stack.js.html">stack.js</a>, <a href="stack.js.html#line1801">line 1801</a>
+    </li></ul></dd>
+</dl>
+<h5>Returns:</h5>
+<div class="param-desc">
+    - Returns `entries`, that has all of its reference binded
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Object</span>
+    </dd>
+</dl>
+</article>
+</section>
+</div>
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="global.html#Stack">Stack</a></li></ul><h3>Global</h3><ul><li><a href="global.html#and">and</a></li><li><a href="global.html#ascending">ascending</a></li><li><a href="global.html#asset">asset</a></li><li><a href="global.html#assets">assets</a></li><li><a href="global.html#close">close</a></li><li><a href="global.html#connect">connect</a></li><li><a href="global.html#containedIn">containedIn</a></li><li><a href="global.html#contentType">contentType</a></li><li><a href="global.html#contentTypes">contentTypes</a></li><li><a href="global.html#count">count</a></li><li><a href="global.html#descending">descending</a></li><li><a href="global.html#entries">entries</a></li><li><a href="global.html#entry">entry</a></li><li><a href="global.html#except">except</a></li><li><a href="global.html#excludeReferences">excludeReferences</a></li><li><a href="global.html#exists">exists</a></li><li><a href="global.html#fetch">fetch</a></li><li><a href="global.html#find">find</a></li><li><a href="global.html#findOne">findOne</a></li><li><a href="global.html#getQuery">getQuery</a></li><li><a href="global.html#greaterThan">greaterThan</a></li><li><a href="global.html#greaterThanOrEqualTo">greaterThanOrEqualTo</a></li><li><a href="global.html#include">include</a></li><li><a href="global.html#includeContentType">includeContentType</a></li><li><a href="global.html#includeCount">includeCount</a></li><li><a href="global.html#includeReferences">includeReferences</a></li><li><a href="global.html#language">language</a></li><li><a href="global.html#lessThan">lessThan</a></li><li><a href="global.html#lessThanOrEqualTo">lessThanOrEqualTo</a></li><li><a href="global.html#limit">limit</a></li><li><a href="global.html#notContainedIn">notContainedIn</a></li><li><a href="global.html#notEqualTo">notEqualTo</a></li><li><a href="global.html#notExists">notExists</a></li><li><a href="global.html#only">only</a></li><li><a href="global.html#or">or</a></li><li><a href="global.html#query">query</a></li><li><a href="global.html#queryReferences">queryReferences</a></li><li><a href="global.html#regex">regex</a></li><li><a href="global.html#schema">schema</a></li><li><a href="global.html#schemas">schemas</a></li><li><a href="global.html#skip">skip</a></li><li><a href="global.html#tags">tags</a></li><li><a href="global.html#where">where</a></li></ul>
+</nav>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sat Aug 03 2019 21:26:39 GMT+0530 (India Standard Time)
+</footer>
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js" integrity="gjKEaAtJoBN94tFHTJO/QMWm2iZN7DSXY/EAGrHzx30=%" crossorigin="anonymous"> </script>
+</body>
+</html>