Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement →
Sign In

@trigo/fsm

Package Overview
Dependencies
Maintainers
3
Versions
23
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@trigo/fsm - npm Package Compare versions

Comparing version
3.0.1
 to
3.1.0
docs/ast/source/parse-transition-api.js.json

Sorry, the diff of this file is too big to display

docs/ast/source/parse-transition-api.specs.js.json

Sorry, the diff of this file is too big to display

+127
docs/file/lib/parse-transition-api.js.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../">
<title data-ice="title">lib/parse-transition-api.js | API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/lib/composit-state.js~CompositState.html">CompositState</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/lib/fsm.js~FSM.html">FSM</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-findpossibletransitions">findpossibletransitions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isvalidstatevalue">isvalidstatevalue</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1 data-ice="title">lib/parse-transition-api.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">&apos;use strict&apos;;
function getNested(theObject, path) {
try {
const separator = &apos;.&apos;;
return path
.replace(&apos;[&apos;, separator).replace(&apos;]&apos;, &apos;&apos;)
.split(separator)
.reduce(
(obj, property) =&gt; obj[property], theObject,
);
} catch (err) {
return undefined;
}
}
const replaceFromParams = (path, params, ctx) =&gt; {
let href = path;
Object.keys(params).forEach((key) =&gt; {
const value = getNested(ctx, params[key]);
if (value === undefined) {
throw new Error(`Cannot resolve param: &quot;${key}&quot; data path: &quot;${params[key]}&quot;`);
}
href = href.replace(new RegExp(`{${key}}`, &apos;g&apos;), value);
});
return href;
};
const extractParams = (path) =&gt; {
const matches = path.match(/\{.*?\}/g);
if (!matches) return undefined;
const params = {};
matches.forEach((m) =&gt; {
params[m.replace(/\{/, &apos;&apos;).replace(/\}/, &apos;&apos;)] = true;
});
return params;
};
/** @private */
module.exports = ({ api, ctx }) =&gt; {
if (!api) throw new Error(&apos;Argument &quot;api&quot; missing&apos;);
if (!api.path) throw new Error(&apos;Argument &quot;api.path&quot; missing&apos;);
const method = api.method || &apos;get&apos;;
let href = api.path;
if (ctx &amp;&amp; ctx.api &amp;&amp; ctx.api.params) {
href = replaceFromParams(href, ctx.api.params, ctx);
}
if (api.params) {
href = replaceFromParams(href, api.params, ctx);
}
const params = extractParams(href);
const link = {
href,
method,
};
if (params) {
link.params = params;
}
return link;
};
</code></pre>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
+151
docs/file/lib/parse-transition-api.specs.js.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../">
<title data-ice="title">lib/parse-transition-api.specs.js | API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/lib/composit-state.js~CompositState.html">CompositState</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/lib/fsm.js~FSM.html">FSM</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-findpossibletransitions">findpossibletransitions</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-isvalidstatevalue">isvalidstatevalue</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><h1 data-ice="title">lib/parse-transition-api.specs.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">&apos;use strict&apos;;
const parseApi = require(&apos;./parse-transition-api&apos;);
const { expect } = require(&apos;chai&apos;);
describe(&apos;parse transition api&apos;, () =&gt; {
it(&apos;throws with missing &quot;api&quot;&apos;, () =&gt; {
expect(() =&gt; parseApi({ })).to.throw(&apos;Argument &quot;api&quot; missing&apos;);
});
it(&apos;throws with missing &quot;api.path&quot;&apos;, () =&gt; {
expect(() =&gt; parseApi({ api: { method: &apos;patch&apos; } })).to.throw(&apos;Argument &quot;api.path&quot; missing&apos;);
});
it(&apos;returns corrct object&apos;, () =&gt; {
const res = parseApi({ api: {
path: &apos;/test&apos;,
method: &apos;patch&apos;,
} });
expect(res).to.eql({
href: &apos;/test&apos;,
method: &apos;patch&apos;,
});
});
it(&apos;resolves params from ctx object&apos;, () =&gt; {
expect(parseApi({
api: {
path: &apos;/test/{resId}&apos;,
method: &apos;patch&apos;,
params: {
resId: &apos;data.event.resId&apos;,
},
},
ctx: {
data: {
event: {
resId: &apos;42&apos;,
},
},
},
})).to.eql({
href: &apos;/test/42&apos;,
method: &apos;patch&apos;,
});
});
it(&apos;throws error when param cannot be resolved&apos;, () =&gt; {
expect(() =&gt; parseApi({
api: {
path: &apos;/test/{resId}&apos;,
method: &apos;patch&apos;,
params: {
resId: &apos;data.event.resId&apos;,
},
},
ctx: {
data: {
event: {
},
},
},
})).to.throw(&apos;Cannot resolve param: &quot;resId&quot; data path: &quot;data.event.resId&quot;&apos;);
});
it(&apos;creates &quot;templates&quot; object for unresolved path segments&apos;, () =&gt; {
expect(parseApi({
api: {
path: &apos;/test/{resId}/{eventId}/{seminarId}&apos;,
method: &apos;patch&apos;,
params: {
resId: &apos;data.event.resId&apos;,
},
},
ctx: {
data: {
event: {
resId: &apos;42&apos;,
},
},
},
})).to.eql({
href: &apos;/test/42/{eventId}/{seminarId}&apos;,
method: &apos;patch&apos;,
params: {
eventId: true,
seminarId: true,
},
});
});
});
</code></pre>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.5.2)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
+136
-14
docs/class/lib/fsm.js~FSM.html

@@ -44,3 +44,3 @@ <!DOCTYPE html>

<div class="content" data-ice="content"><div class="header-notice">
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import FSM from &apos;<span><a href="file/lib/fsm.js.html#lineNumber24">@trigo/fsm/lib/fsm.js</a></span>&apos;</code></pre></div>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import FSM from &apos;<span><a href="file/lib/fsm.js.html#lineNumber25">@trigo/fsm/lib/fsm.js</a></span>&apos;</code></pre></div>
<span data-ice="access">public</span>

@@ -51,3 +51,3 @@ <span data-ice="kind">class</span>

<span data-ice="source">| <span><a href="file/lib/fsm.js.html#lineNumber24">source</a></span></span>
<span data-ice="source">| <span><a href="file/lib/fsm.js.html#lineNumber25">source</a></span></span>
</div>

@@ -410,2 +410,30 @@

<span data-ice="name"><span><a href="class/lib/fsm.js~FSM.html#instance-method-restApi">restApi</a></span></span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Get rest API links for all currently available transitions than define the</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="class/lib/fsm.js~FSM.html#instance-method-transitions">transitions</a></span></span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span>&lt;<span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>&gt;</span>

@@ -583,3 +611,3 @@ </p>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber59">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber80">source</a></span></span>
</span>

@@ -671,6 +699,28 @@ </h3>

<td data-ice="appendix"></td>
<td data-ice="description"><p>object containin hander for specific trasaction
{ beforeTransName: async (ctx, args) =&gt; {...}, afterTransName: async (ctx, args) =&gt; {...}</p>
</td>
<td data-ice="description"><p>object containin hander for specific trasaction</p>
<pre><code><code class="source-code prettyprint">{
beforeTransName: async (ctx, args) =&gt; {...},
afterTransName: async (ctx, args) =&gt; {...},
}</code>
</code></pre></td>
</tr>
<tr data-ice="property" data-depth="1">
<td data-ice="name" data-depth="1">options.api</td>
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>object containing global REST API data:</p>
<pre><code><code class="source-code prettyprint">{
self: {
path: &apos;/{entityName}/{id}&apos;
},
params: {
id: &apos;data.event.id&apos;,
entityName: &apos;api.data.entityName&apos;
},
data: {
entityName: &apos;events&apos;
}
}</code>
</code></pre></td>
</tr>
</tbody>

@@ -713,3 +763,3 @@ </table>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber198">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber266">source</a></span></span>
</span>

@@ -771,3 +821,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber112">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber134">source</a></span></span>
</span>

@@ -829,3 +879,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber121">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber143">source</a></span></span>
</span>

@@ -874,3 +924,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber96">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber118">source</a></span></span>
</span>

@@ -935,3 +985,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber168">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber236">source</a></span></span>
</span>

@@ -1043,3 +1093,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber142">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber210">source</a></span></span>
</span>

@@ -1125,3 +1175,3 @@ </h3>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber86">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber108">source</a></span></span>
</span>

@@ -1189,2 +1239,74 @@ </h3>

<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-restApi">
<span class="access" data-ice="access">public</span>
<span data-ice="name">restApi</span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber176">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Get rest API links for all currently available transitions than define the</p>
</div>
<div data-ice="properties">
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></td>
<td class="return-desc" data-ice="returnDescription"><p>&quot;restApi&quot; object.</p>
<pre><code class="lang-javascript"><code class="source-code prettyprint">// example output:
{
self: {
href: &apos;/events/42&apos;,
method: &apos;get&apos;
},
&apos;transition:name:1&apos;: {
href: &apos;/events/42/transition/{param1}&apos;,
method: &apos;put&apos;,
params: {
param1: true,
}
}
}</code>
</code></pre>
</td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-transitions">

@@ -1201,3 +1323,3 @@ <span class="access" data-ice="access">public</span>

<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber130">source</a></span></span>
<span data-ice="source"><span><a href="file/lib/fsm.js.html#lineNumber152">source</a></span></span>
</span>

@@ -1204,0 +1326,0 @@ </h3>

+5
-5
docs/coverage.json
{
"coverage": "88.23%",
"expectCount": 17,
"actualCount": 15,
"coverage": "88.88%",
"expectCount": 18,
"actualCount": 16,
"files": {

@@ -12,4 +12,4 @@ "lib/composit-state.js": {

"lib/fsm.js": {
"expectCount": 12,
"actualCount": 12,
"expectCount": 13,
"actualCount": 13,
"undocumentLines": []

@@ -16,0 +16,0 @@ },

+78
-6
docs/file/lib/fsm.js.html

@@ -54,2 +54,3 @@ <!DOCTYPE html>

const getAllTakenNames = require(&apos;./get-all-taken-names&apos;);
const parseTrasitionApi = require(&apos;./parse-transition-api&apos;);

@@ -69,3 +70,2 @@ const callIfSet = async (handler, ctx, args) =&gt; {

class FSM {
/**

@@ -90,2 +90,3 @@ * Returns the composit state tool used to parse and build state strings from objects

}
/**

@@ -103,5 +104,25 @@ * Create a new state machine.

* @param {object} options.eventHandler object containin hander for specific trasaction
* { beforeTransName: async (ctx, args) =&gt; {...}, afterTransName: async (ctx, args) =&gt; {...}
* ```
* {
* beforeTransName: async (ctx, args) =&gt; {...},
* afterTransName: async (ctx, args) =&gt; {...},
* }
* ```
* @param {object} options.api object containing global REST API data:
* ```
* {
* self: {
* path: &apos;/{entityName}/{id}&apos;
* },
* params: {
* id: &apos;data.event.id&apos;,
* entityName: &apos;api.data.entityName&apos;
* },
* data: {
* entityName: &apos;events&apos;
* }
* }
* ```
*/
constructor({ initialState, transitions, data, saveState, willChangeState, didChangeState, willSaveState, didSaveState, eventHandler }) {
constructor({ initialState, transitions, data, saveState, willChangeState, didChangeState, willSaveState, didSaveState, eventHandler, api }) {
this._state = &apos;__uninitialized__&apos;;

@@ -117,2 +138,3 @@ this._transitions = [];

this._trasitionFunctionNames = [];
this._api = api || {};

@@ -183,2 +205,48 @@ if (transitions) {

/**
* Get rest API links for all currently available transitions than define the
* @return {object} &quot;restApi&quot; object.
* ```javascript
* // example output:
* {
* self: {
* href: &apos;/events/42&apos;,
* method: &apos;get&apos;
* },
* &apos;transition:name:1&apos;: {
* href: &apos;/events/42/transition/{param1}&apos;,
* method: &apos;put&apos;,
* params: {
* param1: true,
* }
* }
* }
* ```
*/
restApi() {
const api = {};
if (this._api &amp;&amp; this._api.self) {
api.self = parseTrasitionApi({
api: this._api.self,
ctx: {
data: this._data,
api: this._api,
},
});
}
findPossibleTransitions(this.state, this._transitions)
.filter(t =&gt; t.api)
.forEach((t) =&gt; {
api[t.name] = parseTrasitionApi({
api: t.api,
ctx: {
data: this._data,
api: this._api,
},
});
});
return api;
}
/**
* Execute a transition

@@ -285,9 +353,9 @@ *

result.willChangeState = await callIfSet(this._willChangeState, ctx, args);
ctx.results = Object.assign({}, result);
result[beforeHandler] = await callIfSet(this._eventHandler[beforeHandler], ctx, args);
// console.log(`Change state: &quot;${from}&quot; =&gt; &quot;${to}&quot;`)
// console.log(`Change state: &quot;${from}&quot; =&gt; &quot;${to}&quot;`)
this._state = to;
ctx.results = Object.assign({}, result);
result[afterHandler] = await callIfSet(this._eventHandler[afterHandler], ctx, args);
ctx.results = Object.assign({}, result);
result.didChangeState = await callIfSet(this._didChangeState, ctx, args);

@@ -298,7 +366,11 @@

result.willSaveState = await callIfSet(this._willSaveState, ctx, args);
ctx.results = Object.assign({}, result);
result.saveState = await this._saveState(ctx, args);
ctx.results = Object.assign({}, result);
result.didSaveState = await callIfSet(this._didSaveState, ctx, args);
}
ctx.results = Object.assign({}, result);
result[afterHandler] = await callIfSet(this._eventHandler[afterHandler], ctx, args);

@@ -305,0 +377,0 @@ this.__inTransition = false;

+155
-8
docs/file/lib/fsm.specs.js.html

@@ -324,5 +324,5 @@ <!DOCTYPE html>

beforeTrans: null,
afterTrans: null,
didChangeState: null,
willSaveState: null,
didSaveState: null,
saveState: undefined,

@@ -428,5 +428,5 @@ },

beforeTrans: &apos;beforeTrans&apos;,
afterTrans: &apos;afterTrans&apos;,
didChangeState: &apos;didChangeState&apos;,
willSaveState: &apos;willSaveState&apos;,
didSaveState: &apos;didSaveState&apos;,
saveState: &apos;saveState&apos;,

@@ -450,5 +450,5 @@ },

beforeTrans: &apos;beforeTrans&apos;,
afterTrans: &apos;afterTrans&apos;,
didChangeState: &apos;didChangeState&apos;,
willSaveState: &apos;willSaveState&apos;,
didSaveState: &apos;didSaveState&apos;,
saveState: &apos;saveState&apos;,

@@ -465,6 +465,6 @@ },

expect(ts[1].name).to.equal(&apos;beforeTrans&apos;);
expect(ts[2].name).to.equal(&apos;afterTrans&apos;);
expect(ts[3].name).to.equal(&apos;didChangeState&apos;);
expect(ts[4].name).to.equal(&apos;willSaveState&apos;);
expect(ts[5].name).to.equal(&apos;didSaveState&apos;);
expect(ts[2].name).to.equal(&apos;didChangeState&apos;);
expect(ts[3].name).to.equal(&apos;willSaveState&apos;);
expect(ts[4].name).to.equal(&apos;didSaveState&apos;);
expect(ts[5].name).to.equal(&apos;afterTrans&apos;);
});

@@ -520,3 +520,6 @@

expect(ts[1].name).to.equal(&apos;beforeTrans&apos;);
expect(ts.length).to.equal(2);
expect(ts[2].name).to.equal(&apos;didChangeState&apos;);
expect(ts[3].name).to.equal(&apos;willSaveState&apos;);
expect(ts[4].name).to.equal(&apos;didSaveState&apos;);
expect(ts.length).to.equal(5);
expect(fsm.state).to.equal(&apos;b&apos;);

@@ -638,2 +641,146 @@ });

});
describe(&apos;transition REST API&apos;, () =&gt; {
let fsm, cfg;
beforeEach(() =&gt; {
cfg = {
initialState: &apos;a&apos;,
transitions: [{
name: &apos;t1&apos;,
from: &apos;*&apos;,
to: &apos;a&apos;,
api: {
path: &apos;/entity/trans&apos;,
method: &apos;patch&apos;,
},
}, {
name: &apos;t2&apos;,
from: &apos;*&apos;,
to: &apos;a&apos;,
api: {
path: &apos;/entity/{resId}/trans/{subId}&apos;,
method: &apos;patch&apos;,
params: {
resId: &apos;data.resId&apos;,
subId: &apos;data._embedded.event.resId&apos;,
},
},
}, {
name: &apos;t3&apos;,
from: &apos;*&apos;,
to: &apos;a&apos;,
}, {
name: &apos;t4&apos;,
from: &apos;*&apos;,
to: &apos;a&apos;,
api: {
path: &apos;/{entity}/{resId}/trans/{subId}&apos;,
method: &apos;patch&apos;,
params: {
resId: &apos;data.resId&apos;,
subId: &apos;data._embedded.event.resId&apos;,
},
},
}],
saveState: () =&gt; {},
willChangeState: () =&gt; bb.delay(5),
data: {
resId: &apos;42&apos;,
_embedded: {
event: {
resId: &apos;22&apos;,
},
},
},
};
});
it(&apos;exposes &quot;restApi()&quot; function&apos;, async () =&gt; {
fsm = new FSM(cfg);
expect(fsm.restApi).to.be.a(&apos;function&apos;);
});
it(&apos;filters transitions without &quot;api&quot; property&apos;, async () =&gt; {
fsm = new FSM(cfg);
const r = fsm.restApi();
expect(r.t1).to.exist;
expect(r.t2).to.exist;
expect(r.t3).not.to.exist;
});
it(&apos;returns parsed api object&apos;, async () =&gt; {
fsm = new FSM(cfg);
const r = fsm.restApi();
expect(r.t1).to.eql({
href: &apos;/entity/trans&apos;,
method: &apos;patch&apos;,
});
});
it(&apos;returns &quot;self&quot; when declared&apos;, async () =&gt; {
fsm = new FSM(Object.assign({}, cfg, {
api: {
self: {
path: &apos;/entity/{resId}&apos;,
},
params: {
resId: &apos;data.resId&apos;,
},
},
}));
const r = fsm.restApi();
expect(r.self).to.eql({
href: &apos;/entity/42&apos;,
method: &apos;get&apos;,
});
});
it(&apos;can mix global &amp; transition local params in same route&apos;, () =&gt; {
fsm = new FSM(Object.assign({}, cfg, {
api: {
data: {
entity: &apos;events&apos;,
},
self: {
path: &apos;/{entity}/{resId}&apos;,
},
params: {
entity: &apos;api.data.entity&apos;,
resId: &apos;data.resId&apos;,
},
},
}));
const r = fsm.restApi();
expect(r.t4).to.eql({
href: &apos;/events/42/trans/22&apos;,
method: &apos;patch&apos;,
});
});
it(&apos;can declare static params data in &quot;api.data&quot; object&apos;, () =&gt; {
fsm = new FSM(Object.assign({}, cfg, {
api: {
data: {
entity: &apos;events&apos;,
},
self: {
path: &apos;/{entity}/{resId}&apos;,
},
params: {
entity: &apos;api.data.entity&apos;,
resId: &apos;data.resId&apos;,
},
},
}));
const r = fsm.restApi();
expect(r.self).to.eql({
href: &apos;/events/42&apos;,
method: &apos;get&apos;,
});
});
});
});

@@ -640,0 +787,0 @@ </code></pre>

+8
-8
docs/package.json
{
"name": "@trigo/fsm",
"version": "2.0.0",
"version": "3.0.1",
"description": "FSM - Finite State Machine",

@@ -15,11 +15,11 @@ "main": "index.js",

"bluebird": "^3.5.0",
"chai": "^3.5.0",
"chai": "^4.0.2",
"esdoc": "^0.5.2",
"eslint": "^3.17.1",
"eslint-config-airbnb-base": "^11.1.1",
"eslint-plugin-import": "^2.2.0",
"eslint-plugin-mocha": "^4.9.0",
"mocha": "^3.2.0",
"eslint": "^4.1.1",
"eslint-config-airbnb-base": "^11.2.0",
"eslint-plugin-import": "^2.6.1",
"eslint-plugin-mocha": "^4.11.0",
"mocha": "^3.4.2",
"nodemon": "^1.11.0",
"nyc": "^10.2.0"
"nyc": "^11.0.3"
},

@@ -26,0 +26,0 @@ "nyc": {

+18
-0
docs/script/search_index.js

@@ -465,2 +465,8 @@ window.esdocSearchIndex = [

[
"lib/fsm.js~fsm#restapi",
"class/lib/fsm.js~FSM.html#instance-method-restApi",
"lib/fsm.js~FSM#restApi",
"method"
],
[
"lib/fsm.js~fsm#state",

@@ -508,2 +514,14 @@ "class/lib/fsm.js~FSM.html#instance-get-state",

[
"lib/parse-transition-api.js",
"file/lib/parse-transition-api.js.html",
"lib/parse-transition-api.js",
"file"
],
[
"lib/parse-transition-api.specs.js",
"file/lib/parse-transition-api.specs.js.html",
"lib/parse-transition-api.specs.js",
"file"
],
[
"lib/parse-transition.js",

@@ -510,0 +528,0 @@ "file/lib/parse-transition.js.html",

+24
-8
docs/source.html

@@ -43,3 +43,3 @@ <!DOCTYPE html>

<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">15/17</span></h1>
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">16/18</span></h1>

@@ -126,6 +126,6 @@ <table class="files-summary" data-ice="files" data-use-coverage="true">

<td data-ice="identifier" class="identifiers"><span><a href="class/lib/fsm.js~FSM.html">FSM</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">12/12</span></td>
<td style="display: none;" data-ice="size">9296 byte</td>
<td style="display: none;" data-ice="lines">264</td>
<td style="display: none;" data-ice="updated">2017-05-03 11:30:09 (UTC)</td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">13/13</span></td>
<td style="display: none;" data-ice="size">10575 byte</td>
<td style="display: none;" data-ice="lines">336</td>
<td style="display: none;" data-ice="updated">2017-08-04 14:40:32 (UTC)</td>
</tr>

@@ -136,5 +136,5 @@ <tr data-ice="file">

<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">15802 byte</td>
<td style="display: none;" data-ice="lines">590</td>
<td style="display: none;" data-ice="updated">2017-05-03 11:37:52 (UTC)</td>
<td style="display: none;" data-ice="size">18673 byte</td>
<td style="display: none;" data-ice="lines">737</td>
<td style="display: none;" data-ice="updated">2017-08-04 14:29:46 (UTC)</td>
</tr>

@@ -158,2 +158,18 @@ <tr data-ice="file">

<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/lib/parse-transition-api.js.html">lib/parse-transition-api.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">1404 byte</td>
<td style="display: none;" data-ice="lines">67</td>
<td style="display: none;" data-ice="updated">2017-08-04 14:30:03 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/lib/parse-transition-api.specs.js.html">lib/parse-transition-api.specs.js</a></span></td>
<td data-ice="identifier" class="identifiers">-</td>
<td class="coverage"><span data-ice="coverage">-</span></td>
<td style="display: none;" data-ice="size">1723 byte</td>
<td style="display: none;" data-ice="lines">91</td>
<td style="display: none;" data-ice="updated">2017-08-04 14:26:46 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/lib/parse-transition.js.html">lib/parse-transition.js</a></span></td>

@@ -160,0 +176,0 @@ <td data-ice="identifier" class="identifiers">-</td>

+39
-2
lib/fsm.js

@@ -45,2 +45,3 @@ 'use strict';

}
/**

@@ -58,3 +59,23 @@ * Create a new state machine.

* @param {object} options.eventHandler object containin hander for specific trasaction
* { beforeTransName: async (ctx, args) => {...}, afterTransName: async (ctx, args) => {...}
* ```
* {
* beforeTransName: async (ctx, args) => {...},
* afterTransName: async (ctx, args) => {...},
* }
* ```
* @param {object} options.api object containing global REST API data:
* ```
* {
* self: {
* path: '/{entityName}/{id}'
* },
* params: {
* id: 'data.event.id',
* entityName: 'api.data.entityName'
* },
* data: {
* entityName: 'events'
* }
* }
* ```
*/

@@ -139,3 +160,19 @@ constructor({ initialState, transitions, data, saveState, willChangeState, didChangeState, willSaveState, didSaveState, eventHandler, api }) {

* Get rest API links for all currently available transitions than define the
* "restApi" object
* @return {object} "restApi" object.
* ```javascript
* // example output:
* {
* self: {
* href: '/events/42',
* method: 'get'
* },
* 'transition:name:1': {
* href: '/events/42/transition/{param1}',
* method: 'put',
* params: {
* param1: true,
* }
* }
* }
* ```
*/

@@ -142,0 +179,0 @@ restApi() {

+3
-3
lib/fsm.specs.js

@@ -613,3 +613,3 @@ 'use strict';

api: {
path: '/entity/{resId}/{trans}/{subId}',
path: '/entity/{resId}/trans/{subId}',
method: 'patch',

@@ -630,3 +630,3 @@ params: {

api: {
path: '/{entity}/{resId}/{trans}/{subId}',
path: '/{entity}/{resId}/trans/{subId}',
method: 'patch',

@@ -710,3 +710,3 @@ params: {

expect(r.t4).to.eql({
href: '/events/42/{trans}/22',
href: '/events/42/trans/22',
method: 'patch',

@@ -713,0 +713,0 @@ });

+19
-1
lib/parse-transition-api.js

@@ -31,2 +31,13 @@ 'use strict';

const extractParams = (path) => {
const matches = path.match(/\{.*?\}/g);
if (!matches) return undefined;
const params = {};
matches.forEach((m) => {
params[m.replace(/\{/, '').replace(/\}/, '')] = true;
});
return params;
};
/** @private */
module.exports = ({ api, ctx }) => {

@@ -46,6 +57,13 @@ if (!api) throw new Error('Argument "api" missing');

return {
const params = extractParams(href);
const link = {
href,
method,
};
if (params) {
link.params = params;
}
return link;
};
+26
-0
lib/parse-transition-api.specs.js

@@ -65,2 +65,28 @@ 'use strict';

});
it('creates "templates" object for unresolved path segments', () => {
expect(parseApi({
api: {
path: '/test/{resId}/{eventId}/{seminarId}',
method: 'patch',
params: {
resId: 'data.event.resId',
},
},
ctx: {
data: {
event: {
resId: '42',
},
},
},
})).to.eql({
href: '/test/42/{eventId}/{seminarId}',
method: 'patch',
params: {
eventId: true,
seminarId: true,
},
});
});
});
+1
-1
package.json
{
"name": "@trigo/fsm",
"version": "3.0.1",
"version": "3.1.0",
"description": "FSM - Finite State Machine",

@@ -5,0 +5,0 @@ "main": "index.js",

docs/ast/source/fsm.js.json

Sorry, the diff of this file is too big to display

docs/ast/source/fsm.specs.js.json

Sorry, the diff of this file is too big to display

docs/dump.json

Sorry, the diff of this file is too big to display