@vsirotin/ts-stop 1.13.1 → 2.4.1

package/tutorial/04-tools.md

@@ -0,0 +1,164 @@
+# StOP Tutorial. Part 4: Tools
+
+## 7. Tools
+
+Beyond the core `Sfsm` engine, the StOP SDK ships a handful of functions with corresponding CLI-scripts for working with FA definitions themselves.
+
+StOP SDK ships with a few AI-skills, that can be useful by working with SFSMs. These skills are described in the paragraph 7.6 of this document.
+
+### 7.1 Extended vs. compact format, and `reduceFA`
+
+Every example so far has used the **compact** (runtime) format: a plain list of `[from, signal, to]` tuples or `[from, signal, to, command]` tuples. For larger FAs, an **extended** (declaration) format is available where every state, signal, and command can carry a human-readable `name`/`description`, and a `sender`/`receiver` — much more pleasant to read and maintain by hand, and to auto-generate documentation from.
+
+The `reduceFA()` function converts an extended definition into the flat compact form that `Sfsm.loadFA()` actually consumes internally:
+
+```typescript
+import { reduceFA, FaDefinition } from '@vsirotin/ts-stop/sfsm';
+
+const compact = reduceFA(extendedTurnstileFa as FaDefinition);
+```
+
+Passing an already-compact definition through `reduceFA()` returns it unchanged, so it is always safe to call.
+
+### 7.2 The multi-FA compact format
+
+Once an FA has children, the compact format lists **every** FA (root and all descendants) as separate top-level keys of the same object — the parent's `ts` list simply refers to a child by name as a transition target, exactly like `CoinCheck` in the example below. The root FA is auto-detected as whichever key is never referenced as a target (3rd element) in any FA's transitions. Both this format and a single flat FA are accepted by `loadFA()` without any change to the calling code.
+
+### 7.3 `updateCompactFA` / `updateFullFA` — evolving an FA definition without rewriting it
+
+`updateCompactFA()` (and its extended-format counterpart `updateFullFA()`) apply a small, structured `FaUpdate` descriptor — `{ remove?: string[], add?: Record<string, ...> }` — to an existing FA definition and return a new one, without mutating the source. This is the mechanism the CLI tools `update-compact-fa` / `update-full-fa` use under the hood.
+
+A particularly useful pattern: **turning a plain leaf state into a sub-FA**, so a device's behaviour becomes more detailed over time without touching the rest of the definition. Suppose our turnstile starts out trusting any coin unconditionally:
+
+```json
+{
+  "Turnstile": [
+    ["I",        "start", "locked"],
+    ["locked",   "coin",  "unlocked"],
+    ["unlocked", "push",  "locked"]
+  ]
+}
+```
+
+Later, we decide coins should actually be validated before unlocking. Instead of hand-editing this list, we describe the change as an update that (a) adds a new `CoinCheck` sub-FA, and (b) replaces the root so that `"coin"` now leads into it instead of straight to `"unlocked"`:
+
+```typescript
+import { updateCompactFA, FaDefinition, FaUpdate } from '@vsirotin/ts-stop/sfsm';
+
+const update: FaUpdate = {
+  add: {
+    Turnstile: [
+      ["I",          "start",  "locked"],
+      ["locked",     "coin",   "CoinCheck"],
+      ["CoinCheck",  "CC.ok",  "unlocked"],
+      ["CoinCheck",  "CC.bad", "locked"],
+      ["unlocked",   "push",   "locked"]
+    ],
+    CoinCheck: [
+      ["I",        "coin",   "checking"],
+      ["checking", "CC.ok",  "E_ok"],
+      ["checking", "CC.bad", "E_bad"]
+    ]
+  }
+};
+
+const detailedTurnstileFa = updateCompactFA(simpleTurnstileFa as FaDefinition, update);
+```
+
+`simpleTurnstileFa` is untouched; `detailedTurnstileFa` now behaves exactly like the original for `start`/`push`, but pushes `CoinCheck` onto the stack on `"coin"` (rule 4 from the previous chapter) and only reaches `"unlocked"` once a `CC.ok` signal arrives — otherwise it falls back to `"locked"` on `CC.bad`. No existing consumer of the FA (nor the SFSM engine itself) needs to change for this to work.
+
+A runnable version of this example is available as a unit test: [07-update-fa-add-detail.test.ts](../../ts/ts-stop/test/sfsm/tutorial/07-update-fa-add-detail.test.ts). The full behaviour of `updateCompactFA` / `updateFullFA` (removing FAs, replacing existing ones, pruning dangling transitions, non-mutation of the source) is covered by [FaUpdater.test.ts](../../ts/ts-stop/test/sfsm/FaUpdater.test.ts).
+
+### 7.4 Loading FA definitions from files and URLs
+
+Two small helpers load a `FaDefinition` from outside the source code, so FA JSON files can live alongside the code that uses them (or be served remotely) instead of being inlined:
+
+```typescript
+import { Sfsm, loadFAFromFile, FaDefinition } from '@vsirotin/ts-stop/sfsm';
+
+const sfsm = new Sfsm({ byMissingTransition: 'error' });
+sfsm.loadFA(loadFAFromFile('./turnstile-fa.json'));   // Node.js only (uses fs)
+```
+
+```typescript
+import { Sfsm, loadFAFromURL, FaDefinition } from '@vsirotin/ts-stop/sfsm';
+
+const sfsm = new Sfsm({ byMissingTransition: 'error' });
+sfsm.loadFA(await loadFAFromURL('https://example.com/turnstile-fa.json'));  // browser & Node.js ≥ 18
+```
+
+Both accept extended or compact JSON and throw on a failed read/fetch or invalid JSON. Their full behaviour is covered by [FaLoader.test.ts](../../ts/ts-stop/test/sfsm/FaLoader.test.ts).
+
+### 7.5 CLI tools and scripts
+
+For one-off conversions and FA manipulations without writing code, the package ships several npm scripts (run from `ts/ts-stop`, after `npm run build`).
+
+#### 7.5.1 `reduce-fa` — Convert extended FA to compact format
+
+```bash
+npm run reduce-fa -- <path-to-fa-file>
+# writes <path-to-fa-file>-compact.json (or to stdout if no file extension)
+```
+
+Converts an **extended** (hand-authored) FA definition into the flat **compact** format used at runtime by `Sfsm.loadFA()`. Input can be either extended or compact; compact input passes through unchanged. Thin wrapper around `reduceFA()`, whose behaviour is covered by [FaReducer.test.ts](../../ts/ts-stop/test/sfsm/FaReducer.test.ts).
+
+#### 7.5.2 `update-compact-fa` / `update-full-fa` — Apply structured changes to FA definitions
+
+```bash
+npm run update-compact-fa -- --source=<path> --update=<path> [--result=<path>]
+npm run update-full-fa    -- --source=<path> --update=<path> [--result=<path>]
+```
+
+Applies a small structured `FaUpdate` descriptor (JSON file with `remove` and/or `add` keys) to an existing FA definition, returning a modified copy without mutating the source. By default, `--result` outputs to `<source-basename>-updated.json` if omitted. Thin wrappers around `updateCompactFA()` / `updateFullFA()`, whose behaviour is covered by [FaUpdater.test.ts](../../ts-stop/test/sfsm/FaUpdater.test.ts).
+
+#### 7.5.3 `json-to-drawio` — Convert compact FA JSON to UML state diagram
+
+```bash
+node scripts/json-to-drawio.js <input.json> <output.drawio>
+```
+
+Converts a compact SFSM JSON file into a professional draw.io (.drawio) UML state diagram. Features:
+- **Hierarchical container layout**: Each FA rendered as a swimlane; sub-FAs as nested light-grey containers (100×60 px).
+- **ELK.js hierarchical layout**: Professional automatic positioning of states within each FA using Eclipse Layout Kernel.
+- **Vertical stacking**: Multiple FAs stacked without overlap with 30px spacing.
+- **SFSM metadata preservation**: All state roles, FA names, signals, and commands embedded in cell styles for round-trip conversion.
+- **Initial, plain, sub-FA, and exit states**: All SFSM state types rendered correctly with appropriate UML shapes.
+
+Output diagram can be opened in draw.io, inspected visually, and subjected to small manual adjustments (state/container repositioning, style tweaks) to achieve visual perfection without affecting the underlying SFSM data.
+
+#### 7.5.4 `drawio-to-json` — Extract compact FA JSON from UML diagram
+
+```bash
+node scripts/drawio-to-json.js <input.drawio> <output.json>
+```
+
+Reverse conversion: reads a draw.io diagram (preferably generated by `json-to-drawio.js`, but can parse hand-drawn diagrams with heuristic fallbacks) and extracts a compact SFSM JSON file. Parses the custom SFSM metadata (sfsmRole, sfsmFa, sfsmKey, sfsmSignal, sfsmCommand) from cell styles; if metadata is absent, applies shape-based heuristics (ellipses for states, swimlanes for sub-FAs, etc.).
+
+Output is a valid compact-format FA ready for `Sfsm.loadFA()`.
+
+#### 7.5.5 `compare-compact-jsons` — Validate diagram vs. JSON correspondence
+
+```bash
+node scripts/compare-compact-jsons.js <file-a.json> <file-b.json>
+```
+
+Intelligent comparison of two compact SFSM JSON files. Reports per-FA alignment: matching transitions, missing/extra transitions, mismatched targets or commands. Exits with code 0 if files are identical, non-zero if differences found. Designed for round-trip validation: after converting JSON → Diagram → JSON, this script confirms the resulting file matches the original exactly.
+
+#### 7.5.6 `merge-fas` / `merge-fas-from-dir` — Combine FA definitions
+
+```bash
+node scripts/merge-fas.js <input1.json> <input2.json> ... --result=<output.json>
+node scripts/merge-fas-from-dir.js <input-dir> --result=<output.json>
+```
+
+Combine multiple compact or extended FA definitions into a single multi-FA output file. Later input files override earlier ones with the same FA key. Useful for modular FA composition and testing multi-FA hierarchies.
+
+### 7.6 AI skills for diagram generation and validation
+
+Three AI skills in the [ai-skills directory](../../ts/ts-stop/ai/skills) automate common diagram workflows:
+
+- **`sfsm-json-to-uml-diagram`**: Wraps `json-to-drawio.js`. Use when you need to visualize an SFSM JSON definition as a professional draw.io UML state diagram. Generates hierarchical layout with nested sub-FAs and full metadata preservation. Note: the generated diagram is production-ready but may benefit from small manual repositioning of states or containers for optimal visual polish.
+
+- **`sfsm-uml-diagram-to-json`**: Wraps `drawio-to-json.js`. Use when you need to extract or reverse-convert a draw.io state diagram back to compact SFSM JSON (e.g., after hand-editing the diagram, or starting from a collaborator's visual design).
+
+- **`sfsm-compare-json-uml-diagram`**: Combines `drawio-to-json.js` and `compare-compact-jsons.js`. Use when you need to validate a draw.io diagram against its source JSON (or vice versa). Identifies every discrepancy—missing transitions, state mismatches, command errors—and reports them in a clear diff format. Accepts user-specified input/output paths, requesting them if not provided.

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

package/LICENSE-COMMERCIAL.md

@@ -1,41 +0,0 @@
-# StOP Commercial License
-
-**Version 1.0**
-
-## 1. Grant of Commercial License
-
-This Commercial License grants you permission to use the StOP library in commercial projects under the conditions specified in Section 2.
-
-## 2. Commercial Use Restrictions
-
-You may use StOP under the **free Apache 2.0 license** if:
-
-- Your organization has fewer than 10 employees, **AND**
-- Your project generates less than $10,000 USD in annual revenue
-
-If your organization or project exceeds either threshold, you must:
-
-- Obtain a separate Commercial License from the copyright holder, or
-- Use the library under the Apache 2.0 license with explicit written permission from the copyright holder
-
-## 3. Obtaining a Commercial License
-
-To request a Commercial License for organizations with 10+ employees or projects generating $10,000+ USD annually:
-
-**Contact the author through the GitHub repository for licensing terms and pricing.**
-
-Commercial licenses are available at reasonable rates. Please reach out to discuss your specific use case.
-
-## 4. Terms
-
-- Commercial licenses are granted on a per-project or per-organization basis
-- Licensing terms will be negotiated based on project scope and revenue
-- All commercial licensees must comply with the underlying Apache 2.0 obligations regarding patents and attribution
-
-## 5. Disclaimer
-
-This Commercial License is provided in addition to, not in place of, the Apache 2.0 License. In the event of conflict, the more restrictive terms apply. For clarity on your licensing obligations, please contact the copyright holder.
-
-## 6. Termination
-
-If you exceed the commercial use thresholds (10+ employees or $10,000+ annual revenue) without obtaining a Commercial License, your right to use the library terminates immediately upon notice.

package/README.md

@@ -1,19 +0,0 @@
-# @vsirotin/ts-stop
-
-State-Oriented Programming library for TypeScript.
-
-For an introduction to the concept, read the [StOP Tutorial](https://github.com/vsirotin/StOP/blob/main/docs/Tutorial/01-StOP-Tutorial.md).
-
-For usage and API documentation, see the Angular 17 demo in [ts/ts-example](https://github.com/vsirotin/StOP/blob/main/ts/ts-example).
-
-## License
-
-This project is dual-licensed:
-
-- **[Apache 2.0](./LICENSE)** - Free for open-source, academic, and small commercial use
-- **[Commercial License](./LICENSE-COMMERCIAL.md)** - For organizations with 10+ employees or projects with $10,000+ annual revenue
-
-**Quick Summary:**
-- ✅ Free for individuals and small teams (< 10 employees)
-- ✅ Free for non-commercial and low-revenue projects (< $10K/year)
-- 📧 Commercial licensing available - contact the author

package/lib/DefaultState.d.ts

@@ -1,9 +0,0 @@
-/**
- * Marker base class for states that should be used processed by invalid signals and
- * in situation, then no transitions set for pair (current signal, current state).
- * Only one state in a state machine can have this role.
- */
-export declare abstract class DefaultState {
-    isDefaultState(): boolean;
-}
-//# sourceMappingURL=DefaultState.d.ts.map

package/lib/DefaultState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DefaultState.d.ts","sourceRoot":"","sources":["../src/DefaultState.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,8BAAsB,YAAY;IAC9B,cAAc,IAAI,OAAO;CAG5B"}

package/lib/DefaultState.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultState = void 0;
-/**
- * Marker base class for states that should be used processed by invalid signals and
- * in situation, then no transitions set for pair (current signal, current state).
- * Only one state in a state machine can have this role.
- */
-class DefaultState {
-    isDefaultState() {
-        return true;
-    }
-}
-exports.DefaultState = DefaultState;
-//# sourceMappingURL=DefaultState.js.map

package/lib/DefaultState.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DefaultState.js","sourceRoot":"","sources":["../src/DefaultState.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAsB,YAAY;IAC9B,cAAc;QACV,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAJD,oCAIC"}