@miguelduran14/knowflow 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Miguel Ángel Durán
+
+   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/README.md

@@ -0,0 +1,182 @@
+<div align="center">
+
+# KnowFlow
+
+**Entiende un programa COBOL sin leer el código.**
+
+Le das un `.cbl` y sus copybooks `.cpy`, y KnowFlow te devuelve el flujo de ejecución, el
+esquema de datos byte a byte, qué toca (ficheros, DB2, CICS), dónde se usa cada campo y una
+explicación en lenguaje llano — todo anclado a la línea del fuente que lo demuestra.
+
+Pensado para el desarrollador **junior que hereda** un programa de mainframe cuando el veterano
+que lo escribió ya no está.
+
+`local-first` · `BYOK` · `Apache-2.0` · `sin backend`
+
+[![CI](https://github.com/miguelduran14/KnowFlow/actions/workflows/ci.yml/badge.svg)](https://github.com/miguelduran14/KnowFlow/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/miguelduran14/KnowFlow/blob/master/LICENSE)
+![Node](https://img.shields.io/badge/node-%E2%89%A518-informational)
+
+<br>
+
+<img src="https://raw.githubusercontent.com/miguelduran14/KnowFlow/master/docs/hero.png" alt="Pantalla de inicio de KnowFlow" width="860">
+
+</div>
+
+---
+
+## Por qué existe
+
+Las herramientas de análisis COBOL existentes están pensadas para *proyectos de migración*
+(IBM watsonx, AWS Transform, consultoras): pesadas, caras, y no resuelven el problema real del
+día a día — entender un programa concreto para mantenerlo. La alternativa real de un junior hoy
+es pegar el código en un chat genérico, que **alucina** en dialecto mainframe (confunde
+`SYSCAT.COLUMNS` con `SYSIBM.SYSCOLUMNS` en DB2 z/OS, por ejemplo) y no verifica nada de lo que
+dice.
+
+KnowFlow separa las dos cosas:
+
+- Un **parser determinista** extrae los hechos estructurales exactos: divisiones, párrafos,
+  grafo `PERFORM`/`CALL`/`GO TO`, resolución de `COPY`, niveles/`PIC`/`OCCURS`/`REDEFINES`/`COMP`,
+  bloques `EXEC SQL`/`EXEC CICS`, y de dónde viene y a dónde va cada dato.
+- La **IA solo narra** esos hechos ya verificados, en lenguaje llano — nunca ve el código fuente
+  crudo, así que no puede inventar estructura que no esté verificada.
+
+Todo resultado lleva su **nivel de fidelidad**: lo que el parser verificó, y lo que queda marcado
+como hueco (copybook ausente, `CALL` dinámica, destino no encontrado) en vez de rellenarse con una
+suposición. Es el principio de no-invención del proyecto ([ADR-0003](docs/adr/0003-niveles-de-fidelidad-y-no-invencion.md)).
+
+## Requisitos
+
+Solo **[Node.js](https://nodejs.org) 18 o superior** (incluye `npm`). Para comprobar si ya lo
+tienes: `node --version`. Si no, instálalo con el instalador LTS de nodejs.org o por línea de
+comandos:
+
+```bash
+# Windows
+winget install OpenJS.NodeJS.LTS
+# macOS
+brew install node
+# con nvm (cualquier SO)
+nvm install --lts
+```
+
+## Empezar en 30 segundos
+
+Sin instalar nada, con un solo comando:
+
+```bash
+npx @miguelduran14/knowflow
+```
+
+O desde el código, si quieres trastear:
+
+```bash
+git clone https://github.com/miguelduran14/KnowFlow.git
+cd KnowFlow
+npm install
+npm run build
+npm start
+```
+
+Abre `http://localhost:4173` en tu navegador. Pulsa **«Cargar ejemplo»** para ver la herramienta
+en marcha con una cadena de programas de banca sintéticos (`examples/`) — sin subir nada tuyo — o
+arrastra tu propio `.cbl` y sus `.cpy`.
+
+> **Local-first / BYOK.** Tu código nunca sale de tu máquina salvo la llamada al proveedor de IA
+> que tú mismo configures (Claude, o un endpoint corporativo compatible con OpenAI) para la capa de
+> explicación. Esa clave se guarda solo en tu navegador. Todo lo demás —flujo, datos, inventario,
+> usos, trazabilidad, avisos— corre siempre local y no necesita ninguna clave. No hay backend
+> propio ([ADR-0002](docs/adr/0002-gui-web-local-motor-como-libreria.md)).
+
+## Qué ves
+
+| Vista | Qué responde |
+|---|---|
+| **Explicación** | Resumen y recorrido en lenguaje llano, generado por IA sobre los hechos del parser — cada etapa enlaza al párrafo real que la demuestra. |
+| **Flujo** | Cómo se recorre el programa: párrafos y secciones, `PERFORM`/`CALL`/`GO TO`, la condición bajo la que ocurre cada arista, caídas naturales. Lienzo interactivo: clic en un nodo abre su ficha (a qué llama, quién lo llama, qué EXEC/E-S contiene), busca párrafos, pliega secciones y **exporta a Mermaid, SVG o PNG**. |
+| **Datos** | El esquema como memoria: un mapa de bytes proporcional (cada campo ocupa el ancho de sus bytes reales) con `PIC`, `OCCURS`, `REDEFINES`, `COMP-3`, niveles 88/66 y offsets. Fija un campo (clic) para ver, en la misma ficha, **dónde se usa** y su **trazabilidad**. Tabla clásica siempre disponible como alternativa. |
+| **Qué toca** | Ficheros con su E/S, tablas DB2, cursores y su ciclo `DECLARE`/`OPEN`/`FETCH`/`CLOSE`, comandos CICS — extracción literal, sin interpretar qué hace una consulta. |
+| **Avisos** | Trampas de mantenimiento verificadas contra el fuente: `STOP RUN` en un subprograma, `UPDATE`/`DELETE` sin `WHERE`, `GO TO` que cruza de sección, fichero o cursor sin cerrar, párrafo inalcanzable, `ALTER`… No son huecos de fidelidad: son cosas que *sí* están, pero muerden. |
+| **Cadena** | Qué `CALL` cruza a qué programa, cuando aportas varios fuentes a la vez. |
+
+### Dónde se usa cada campo (where-used)
+
+Fija un campo en el mapa de bytes y KnowFlow lista cada punto de la `PROCEDURE DIVISION` donde se
+**lee** o se **escribe**, con verbo, párrafo y línea, incluyendo las host variables de `EXEC SQL`.
+Cada uso salta al diagrama de Flujo o al código. Lo que el reparto de roles no puede afirmar con
+certeza (`CALL … USING` por referencia, `MOVE CORRESPONDING`, un homónimo) va **marcado**, no
+adivinado.
+
+### Trazabilidad de datos
+
+Desde ese mismo campo, sigue **de dónde viene** su valor y **a dónde va**, encadenando
+`MOVE`/`COMPUTE`/aritmética/`STRING` y los solapes `REDEFINES`:
+
+```
+MOV-IMPORTE → WS-BRUTO → WS-INTERES → WS-TOTAL → WS-TOTAL-ED → RPT-REGISTRO
+```
+
+Es insensible al orden de ejecución (cada tramo es un flujo *posible*, no el que gana al final):
+una respuesta honesta y acotada a «¿de dónde sale este importe del informe?».
+
+### Dossier de onboarding
+
+Un botón exporta todo el análisis a un `.md` autocontenido —prosa de IA (si la hay) + diagrama
+Mermaid + esquema + usos + trazabilidad + inventario + avisos + límites de lo verificado— listo
+para pegar en una wiki o un PR. Se arma en el navegador; nada sale de tu máquina.
+
+### Modo aprendiz
+
+Resalta los términos COBOL (`COMP-3`, `REDEFINES`, `EVALUATE`…) con una ficha explicativa al pasar
+el ratón — no la genera un modelo, es un glosario propio.
+
+## Qué NO es
+
+- No es un traductor/migrador COBOL→Java.
+- No es una plataforma de análisis de *estate* completo.
+- No genera código ni tipos a partir de copybooks.
+
+Cuanto más estrecho el propósito —entender UN programa para mantenerlo— mejor. El contexto
+completo del producto, la arquitectura y las decisiones están en [`CONTEXT.md`](CONTEXT.md) y en
+[`docs/adr/`](docs/adr/).
+
+## El ejemplo
+
+`examples/` contiene una cadena de banca **sintética** (`ctamov01` → `valida01` / `fecha01` +
+copybooks) escrita desde patrones típicos, no copiada de nadie. Ejercita todas las vistas y lleva
+dos avisos plantados a propósito. Ver [`examples/README.md`](examples/README.md).
+
+## Restricción importante
+
+**Nunca** proceses COBOL de clientes/empleador con esta herramienta ni con ningún agente de IA
+sobre este repo. La herramienta y cualquier agente envían lo que leen a un proveedor de IA: la
+violación ocurre en el primer *read*, no en el *push*. Usa solo COBOL sintético o público
+(GnuCOBOL, suite NIST, repos abiertos). Es una cuestión de propiedad intelectual, no negociable.
+
+## Desarrollo
+
+```bash
+npm install
+npm run dev --prefix gui   # servidor de desarrollo con recarga en caliente (Vite)
+```
+
+```bash
+npm test        # suite de tests del motor (parser, flujo, inventario, usos, trazabilidad, cadena)
+npm run verify  # typecheck + tests + build completo (motor + GUI) — lo que corre antes de publicar
+```
+
+El motor (`src/`) es una librería TypeScript independiente de la GUI (`gui/`) y se puede ejercitar
+sin interfaz con el arnés de desarrollo: `npx tsx harness/flow.ts <fichero.cbl>`.
+
+```ts
+import { parse, parseFlow, parseInventory, collectReferences, traceField } from '@miguelduran14/knowflow'
+```
+
+Para sacar una versión nueva (subir versión, alinear GitHub y npm, publicar), ver
+[`RELEASING.md`](RELEASING.md).
+
+## Licencia
+
+Apache-2.0. Ver [ADR-0004](docs/adr/0004-licencia-apache-2.md) para el porqué (cláusula de
+patentes + pasa revisiones legales corporativas; AGPL está prohibido por política en banca).

package/dist/advisories.d.ts

@@ -0,0 +1,16 @@
+import type { Advisory, FlowResult, Inventory, ParseResult } from './types.js';
+/**
+ * Trampas de mantenimiento COBOL conocidas, detectadas sobre hechos YA
+ * verificados por el parser (datos, flujo, inventario) — nunca sobre una
+ * interpretación nueva. Es una pasada determinista más, hermana de
+ * `factsFidelity`: mientras esa marca lo que NO se pudo verificar, esta
+ * marca lo que SÍ está verificado pero es arriesgado. Ver el tipo
+ * `Advisory` en `types.ts` para la distinción completa.
+ *
+ * Cada regla es independiente y de alta confianza — prefiere no avisar a
+ * avisar con un falso positivo. Ninguna regla necesita el fuente crudo
+ * salvo la de STOP RUN (que masca literales y recorta columnas fijas con
+ * las mismas utilidades que ya usan flow-parser/inventory, para no
+ * duplicar esa lógica con una regex ingenua).
+ */
+export declare function checkAdvisories(source: string, data: ParseResult | undefined, flow: FlowResult | undefined, inventory: Inventory | undefined): Advisory[];