npm - @cobaltio/cobalt-js - Versions diffs - 0.0.6 → 0.0.9 - Mend

@cobaltio/cobalt-js 0.0.6 → 0.0.9

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 (53) hide show

package/README.md +2 -0
package/cobalt.js +60 -0
package/cobalt.min.js +1 -1
package/docs.md +203 -0
package/package.json +4 -5
package/docs/Cobalt.html +0 -1198
package/docs/cobalt.js.html +0 -182
package/docs/css/bootstrap.min.css +0 -6
package/docs/css/prism.css +0 -138
package/docs/css/prism.min.css +0 -1
package/docs/css/template.min.css +0 -1
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
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 +0 -1830
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 +0 -1830
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 +0 -1831
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 +0 -1835
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 +0 -1831
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/fonts/glyphicons-halflings-regular.eot +0 -0
package/docs/fonts/glyphicons-halflings-regular.svg +0 -288
package/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
package/docs/fonts/glyphicons-halflings-regular.woff +0 -0
package/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
package/docs/global.html +0 -786
package/docs/index.html +0 -100
package/docs/js/bootstrap.min.js +0 -7
package/docs/js/clipboard.min.js +0 -7
package/docs/js/jquery.min.js +0 -2
package/docs/js/lunr-data.js +0 -923
package/docs/js/lunr-data.json +0 -923
package/docs/js/lunr.min.js +0 -6
package/docs/js/prism.js +0 -869
package/docs/js/prism.min.js +0 -1
package/docs/js/template.min.js +0 -1
package/docs/list_class.html +0 -128
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/styles/jsdoc-default.css +0 -358
package/docs/styles/prettify-jsdoc.css +0 -111
package/docs/styles/prettify-tomorrow.css +0 -132

package/docs/Cobalt.html DELETED Viewed

@@ -1,1198 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: Cobalt</title>
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </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: Cobalt</h1>
-<section>
-<header>
-        <h2><span class="attribs"><span class="type-signature"></span></span>Cobalt<span class="signature">(options)</span><span class="type-signature"></span></h2>
-            <div class="class-description">Cobalt Frontend SDK</div>
-</header>
-<article>
-    <div class="container-overview">
-    <h2>Constructor</h2>
-    <h4 class="name" id="Cobalt"><span class="type-signature"></span>new Cobalt<span class="signature">(options)</span><span class="type-signature"></span></h4>
-<div class="description">
-    Cobalt Frontend SDK
-</div>
-    <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>options</code></td>
-            <td class="type">
-<span class="param-type">object</span>
-            </td>
-            <td class="description last">The options to configure the Cobalt SDK.
-                <h6>Properties</h6>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Attributes</th>
-        <th>Default</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>token</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                </td>
-            <td class="description last">The session token.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>baseUrl</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-                <td class="attributes">
-                    &lt;optional><br>
-                </td>
-                <td class="default">
-                    https://api.gocobalt.io
-                </td>
-            <td class="description last">The base URL of your Cobalt API.</td>
-        </tr>
-    </tbody>
-</table>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line4">line 4</a>
-    </li></ul></dd>
-</dl>
-    </div>
-        <h3 class="subsection-title">Members</h3>
-<h4 class="name" id="baseUrl"><span class="type-signature"></span>baseUrl<span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line33">line 33</a>
-    </li></ul></dd>
-</dl>
-<h4 class="name" id="token"><span class="type-signature"></span>token<span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line19">line 19</a>
-    </li></ul></dd>
-</dl>
-<h4 class="name" id="token"><span class="type-signature"></span>token<span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line26">line 26</a>
-    </li></ul></dd>
-</dl>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id="getAppAuthStatus"><span class="type-signature">(async) </span>getAppAuthStatus<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>
-<div class="description">
-    Returns the auth status of the user for the specified application.
-</div>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>application</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">The application type.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line84">line 84</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    The auth status of the user.
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;boolean></span>
-    </dd>
-</dl>
-    <h4 class="name" id="getAppAuthUrl"><span class="type-signature">(async) </span>getAppAuthUrl<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
-<div class="description">
-    Returns the auth URL that users can use to authenticate themselves to the
-specified application.
-</div>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>application</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">The application type.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line100">line 100</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    The auth URL where users can authenticate themselves.
-</div>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;string></span>
-    </dd>
-</dl>
-    <h4 class="name" id="installTemplate"><span class="type-signature">(async) </span>installTemplate<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#Workflow">Workflow</a>>}</span></h4>
-<div class="description">
-    Install the given template.
-</div>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>templateId</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">The ID of the template you want to install.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line69">line 69</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="global.html#Workflow">Workflow</a>></span>
-    </dd>
-</dl>
-    <h4 class="name" id="saveNode"><span class="type-signature">(async) </span>saveNode<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#Workflow">Workflow</a>>}</span></h4>
-<div class="description">
-    Save the input data for the specified node.
-</div>
-    <h5 class="subsection-title">Properties:</h5>
-<table class="props">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>workflowId</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">The ID of the workflow.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>nodeId</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last">The ID of the node.</td>
-        </tr>
-        <tr>
-                <td class="name"><code>inputData</code></td>
-            <td class="type">
-<span class="param-type">object</span>
-            </td>
-            <td class="description last">The input data for the node.</td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line117">line 117</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Promise.&lt;<a href="global.html#Workflow">Workflow</a>></span>
-    </dd>
-</dl>
-</article>
-</section>
-</div>
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Cobalt.html">Cobalt</a></li></ul><h3><a href="global.html">Global</a></h3>
-</nav>
-<br class="clear">
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Sep 09 2022 11:59:06 GMT+0530 (India Standard Time)
-</footer>
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>