Overview
SOPFlow is an open-source TypeScript toolkit for structured Standard Operating Procedures. I built the workflow model, package architecture, diagram layer, React components, and integration playground.
The repository is split by responsibility:
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
One workflow model
@sopflow/core contains the rules that every consumer needs:
- runtime schema parsing;
- workflow validation;
- actor and step operations;
- batch edits;
- graph traversal helpers;
- undo/redo history;
- stable error codes.
A valid SOP requires one start, at least one end, valid references, unique IDs, full reachability from the start, and a path to an end for every non-end step.
Keeping those checks in the core package prevents an editor or renderer from inventing its own version of a valid workflow.
Array order is not workflow order
Steps are stored as a collection. Their array position does not define execution order.
Edges define the workflow. Helpers such as getOrderedSteps() derive a presentation order when an editor or renderer needs one.
That avoids coupling three different concerns: how steps were authored, how they are displayed, and how the workflow actually connects.
Deterministic diagrams
@sopflow/diagram converts the workflow into repeatable diagram models for layout, routing, BPMN-style views, formal flowcharts, pagination, SVG rendering, labels, and path editing.
Because the diagram package consumes the validated workflow model, rendering code does not decide whether the SOP itself is valid.
React components
@sopflow/react provides editor and visualization components on top of the core and diagram packages.
The UI handles interaction and controlled state, while edits still go through shared workflow operations. Tests cover history, actor/step editing, deletion constraints, diagram behavior, procedure rendering, and the public package API.
Published package and domain boundaries
The playground intentionally installs pinned public npm releases instead of importing local package source. That separation tests the actual consumer contract and prevents unpublished library changes from silently appearing as released behavior. The government-specific SOP-AP validation profile lives in the core package’s ./sop-ap export; an older SOP-TA integration remains private.
SOPFlow is a toolkit and playground, not a deployed SOP approval backend. Persistence, authorization, and administration belong to each consuming product.
Result
SOPFlow is now a reusable toolkit rather than workflow logic tied to one application. The same validated document can drive editing, history, diagrams, and React surfaces.
Gambaran umum
SOPFlow adalah toolkit TypeScript open-source untuk Standard Operating Procedures (SOP) yang terstruktur. Saya membangun model workflow, arsitektur package, lapisan diagram, komponen React, dan playground integrasinya.
Repository dibagi berdasarkan tanggung jawab:
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
Satu model workflow
@sopflow/core menyimpan aturan yang dibutuhkan oleh semua consumer:
- Parsing schema saat runtime.
- Validasi workflow.
- Operasi actor dan step.
- Batch edit.
- Helper untuk traversal graph.
- Riwayat undo/redo.
- Error code yang stabil.
SOP yang valid harus memiliki satu start, minimal satu end, referensi yang valid, ID unik, semua node dapat dijangkau dari start, dan setiap step non-end memiliki jalur menuju end.
Memusatkan pemeriksaan ini di package core mencegah editor atau renderer membuat definisi validitas workflow sendiri.
Urutan array bukan urutan workflow
Step disimpan sebagai koleksi. Posisi step di array tidak menentukan urutan eksekusi.
Edge mendefinisikan hubungan workflow. Helper seperti getOrderedSteps() menghasilkan urutan tampilan saat editor atau renderer membutuhkannya.
Ini memisahkan tiga aspek: urutan penulisan step, cara menampilkan step, dan hubungan aktual dalam workflow.
Diagram deterministik
@sopflow/diagram mengubah workflow menjadi model diagram yang konsisten untuk layout, routing, tampilan bergaya BPMN, flowchart formal, pagination, SVG rendering, label, dan pengeditan path.
Karena package diagram memakai model workflow yang sudah divalidasi, kode rendering tidak perlu memutuskan kembali apakah SOP valid.
Komponen React
@sopflow/react menyediakan komponen editor dan visualisasi di atas package core serta diagram.
UI menangani interaksi dan controlled state, sedangkan perubahan data tetap melewati operasi workflow bersama. Tests mencakup riwayat, pengeditan actor/step, batasan penghapusan, perilaku diagram, rendering prosedur, dan API publik.
Hasil
SOPFlow kini menjadi toolkit reusable, bukan logic workflow yang terikat satu aplikasi. Satu dokumen tervalidasi dapat digunakan untuk editing, history, diagram, dan antarmuka React.
Resumen
SOPFlow es un toolkit TypeScript open-source para Standard Operating Procedures (SOP) estructurados. Desarrollé el modelo de workflow, la arquitectura de packages, la capa de diagramas, los componentes React y el playground de integración.
El repositorio se divide por responsabilidades:
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
Un único modelo de workflow
@sopflow/core contiene las reglas que necesitan todos los consumidores:
- Parsing de schemas en runtime.
- Validación de workflows.
- Operaciones sobre actors y steps.
- Ediciones por lotes.
- Helpers de recorrido de graphs.
- Historial undo/redo.
- Error codes estables.
Un SOP válido requiere un inicio, al menos un final, referencias correctas, IDs únicos, accesibilidad completa desde el inicio y un camino hacia un final para cada step no terminal.
Centralizar estas comprobaciones en el core impide que el editor o el renderer definan sus propias reglas de validez.
El orden del array no define el workflow
Los steps se almacenan como colección, pero su posición en el array no determina el orden de ejecución.
Los edges definen el workflow. Helpers como getOrderedSteps() derivan un orden de presentación para el editor o renderer.
Esto separa cómo se crearon los steps, cómo se muestran y cómo se conectan realmente.
Diagramas deterministas
@sopflow/diagram convierte workflows en modelos reproducibles para layout, routing, vistas BPMN, flowcharts, paginación, SVG rendering, etiquetas y edición de paths.
Como la capa de diagramas utiliza un modelo previamente validado, el código de rendering no tiene que decidir si el SOP es válido.
Componentes React
@sopflow/react ofrece componentes de edición y visualización sobre los packages core y diagram.
La UI gestiona la interacción y el controlled state, mientras que los cambios pasan por operaciones compartidas. Los tests cubren historial, edición de actors/steps, restricciones de borrado, diagramas, rendering y API pública.
Resultado
SOPFlow es ahora un toolkit reutilizable en lugar de lógica ligada a una sola aplicación. El mismo documento validado permite editar, recuperar versiones, generar diagramas y utilizar interfaces React.
Présentation
SOPFlow est un toolkit TypeScript open-source pour les Standard Operating Procedures (SOP) structurées. J’ai développé le modèle de workflow, l’architecture des packages, la couche de diagrammes, les composants React et le playground d’intégration.
Le repository est organisé par responsabilités :
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
Un modèle de workflow partagé
@sopflow/core regroupe les règles nécessaires à chaque consommateur :
- Parsing des schémas au runtime.
- Validation des workflows.
- Opérations sur les actors et steps.
- Modifications par lots.
- Helpers de parcours de graphs.
- Historique undo/redo.
- Error codes stables.
Un SOP valide comporte un start, au moins un end, des références correctes, des IDs uniques, une accessibilité totale depuis le start et un chemin vers un end pour chaque step non terminal.
Centraliser ces contrôles dans le core évite que chaque editor ou renderer invente ses propres règles de validité.
L’ordre du tableau n’est pas l’ordre du workflow
Les steps sont stockés dans une collection ; leur position dans un array ne définit pas l’ordre d’exécution.
Les edges définissent le workflow. Des helpers comme getOrderedSteps() produisent un ordre d’affichage pour l’editor ou le renderer.
On sépare ainsi la création des steps, leur représentation visuelle et leur connectivité réelle.
Diagrammes déterministes
@sopflow/diagram transforme les workflows en modèles reproductibles pour layout, routing, vues BPMN, flowcharts, pagination, SVG rendering, labels et modification des paths.
La couche diagram utilise un modèle déjà validé ; elle ne décide pas elle-même si le SOP est correct.
Composants React
@sopflow/react fournit des composants d’édition et de visualisation reposant sur les packages core et diagram.
L’interface gère les interactions et le controlled state, tandis que les modifications utilisent les opérations partagées. Les tests couvrent l’historique, l’édition des actors/steps, les contraintes de suppression, les diagrammes, le rendu des procédures et l’API publique.
Résultat
SOPFlow est devenu un toolkit réutilisable plutôt qu’une logique de workflow propre à une seule application. Un document validé alimente l’édition, l’historique, les diagrammes et les interfaces React.
Überblick
SOPFlow ist ein Open-Source-TypeScript-Toolkit für strukturierte Standard Operating Procedures (SOP). Ich entwickelte das Workflow-Modell, die Package-Architektur, die Diagrammschicht, React-Komponenten und den Integrations-Playground.
Das Repository ist nach Verantwortlichkeiten aufgeteilt:
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
Ein gemeinsames Workflow-Modell
@sopflow/core enthält die Regeln, die alle Consumer benötigen:
- Schema-Parsing zur Laufzeit.
- Workflow-Validierung.
- Operationen für Actors und Steps.
- Batch-Edits.
- Graph-Traversal-Helpers.
- Undo/Redo-Historie.
- Stabile Error Codes.
Ein gültiger SOP benötigt genau einen Start, mindestens ein Ende, gültige Referenzen, eindeutige IDs, vollständige Erreichbarkeit vom Start sowie einen Weg zu einem Ende für jeden Nicht-End-Step.
Die Regeln im Core-Package verhindern, dass Editor und Renderer unterschiedliche Vorstellungen eines gültigen Workflows entwickeln.
Array-Reihenfolge ist keine Workflow-Reihenfolge
Steps werden als Sammlung gespeichert. Ihre Position im Array bestimmt nicht die Ausführungsreihenfolge.
Edges definieren den Workflow. Helpers wie getOrderedSteps() leiten bei Bedarf eine Darstellungsreihenfolge ab.
So bleiben Erstellung, Anzeige und tatsächliche Verknüpfung der Steps unabhängig voneinander.
Deterministische Diagramme
@sopflow/diagram wandelt Workflows in reproduzierbare Diagrammmodelle für Layout, Routing, BPMN-Ansichten, formale Flowcharts, Pagination, SVG Rendering, Beschriftungen und Pfadbearbeitung um.
Da die Diagrammschicht das validierte Workflow-Modell verwendet, muss Rendering-Code die Gültigkeit des SOP nicht erneut bestimmen.
React-Komponenten
@sopflow/react stellt Editor- und Visualisierungskomponenten auf Basis der Core- und Diagram-Pakete bereit.
Die UI übernimmt Interaktion und Controlled State, während Änderungen weiterhin über gemeinsame Workflow-Operationen laufen. Tests decken Historie, Actor-/Step-Bearbeitung, Löschregeln, Diagramme, Verfahrensdarstellung und öffentliche API ab.
Ergebnis
SOPFlow ist ein wiederverwendbares Toolkit statt einer an eine Anwendung gebundenen Workflow-Logik. Dasselbe validierte Dokument unterstützt Bearbeitung, Historie, Diagramme und React-Oberflächen.
概要
SOPFlowは、構造化されたStandard Operating Procedures(SOP)のためのopen-source TypeScript Toolkitです。私はWorkflowモデル、Packageアーキテクチャ、Diagramレイヤー、Reactコンポーネント、統合Playgroundを開発しました。
Repositoryは役割ごとに分割されています。
@sopflow/core
↓
@sopflow/diagram
↓
@sopflow/react
apps/playground
└── integration consumer
単一のWorkflowモデル
@sopflow/coreには、すべてのConsumerが必要とする次のルールを集約しています。
- RuntimeでのSchema Parsing。
- Workflow Validation。
- ActorおよびStepの操作。
- Batch Edit。
- Graph Traversal Helper。
- Undo/Redo履歴。
- 安定したError Code。
有効なSOPには、1つのStart、1つ以上のEnd、正しい参照、一意のID、Startからの完全な到達可能性、すべての非終端StepからEndへの経路が必要です。
Core Packageに検証を集約することで、EditorとRendererが異なる有効性のルールを持つことを防ぎます。
Arrayの順序とWorkflowの順序は異なる
StepはCollectionとして保存され、Array内の位置によって実行順序は決まりません。
Workflowの接続はEdgeで定義されます。getOrderedSteps()などのHelperは、EditorやRendererに必要な表示順序を導出します。
これにより、Stepの作成順序、表示順序、実際の接続構造を分離できます。
決定的なDiagram
@sopflow/diagramはWorkflowから、Layout、Routing、BPMN形式の表示、Flowchart、Pagination、SVG Rendering、Label、Path編集に利用できる再現可能なDiagramモデルを生成します。
Diagram Packageは検証済みのWorkflowを使うため、RenderingコードがSOPの有効性を判定する必要はありません。
Reactコンポーネント
@sopflow/reactはCoreとDiagramの上にEditorと可視化コンポーネントを提供します。
UIは操作とControlled Stateを担当し、データ更新は共通のWorkflow Operationを経由します。Testsは履歴、Actor/Step編集、削除制約、Diagram動作、手順のRendering、公開Package APIを対象としています。
成果
SOPFlowは単一アプリに依存するWorkflow Logicから再利用可能なToolkitへ発展しました。同じ検証済みDocumentを編集、履歴、Diagram、React UIに利用できます。