kg-ssot 0.0.0-stage → 4.9.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/NOTICE

@@ -0,0 +1,12 @@
+KG-SSOT — contrato formal do .kg.yaml e do .kg.json, suíte de conformidade e kit de adoção
+Copyright 2026 Marcio Carvalho
+
+Licenciado sob a Apache License, Version 2.0 (ver o arquivo LICENSE).
+
+Escopo: este LICENSE e este NOTICE cobrem os arquivos que a release leva, listados em spec/release.json:
+o contrato (os JSON Schemas em spec/), a suíte de conformidade (spec/conformance/, inclusive os casos
+.kg.yaml e .kg.json, os manifestos e os metaschema-tests), o kit em tools/ (leitor de referência, runner da suíte,
+gate, vendor, armazém, servidor MCP, exportador PROV-O e o leitor JS em tools/runners/ajv/), as receitas dos pacotes
+em packaging/ (PyPI, npm e MCPB), o README.md, o ADOPTING.md, os llms.txt e o manual em docs/manual/. Os pacotes kg-ssot
+publicados no PyPI e no npm e o MCP Bundle saem desses arquivos e seguem a mesma licença. Os casos .kg.yaml da suíte são parte do contrato e seguem esta licença,
+não uma licença de material de método.

package/README.md

@@ -1,3 +1,79 @@
-# Temporary Holding Version
+# kg-ssot
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**O leitor JavaScript do contrato do KG-SSOT, o grafo de conhecimento verificável: toda afirmação diz de onde veio,
+quando foi conferida e o que depende dela.**
+
+Este pacote julga um grafo `.kg.yaml` ou `.kg.json` contra o contrato vigente e devolve o veredito MUST com os
+códigos estáveis da suíte de conformidade. Ele traz:
+- o **núcleo do leitor**, sem `fs` e sem processo;
+- o **validador do contrato pré-compilado**, que não usa `new Function` nem `eval`. Por isso roda em motores sem
+  geração de código, como o Hermes do React Native e do Expo, e no Node;
+- os **schemas** do contrato e do veredito.
+
+O leitor de referência é o pacote Python [`kg-ssot`](https://pypi.org/project/kg-ssot/). Este leitor passa em todos
+os casos da suíte de conformidade (`latest/`), com o veredito e os códigos esperados. O CI confere isso pelo pacote
+instalado a cada mudança no leitor.
+
+## Instalar
+
+```bash
+npm install kg-ssot
+```
+
+## No código
+
+```js
+import { verdict } from 'kg-ssot';
+
+verdict(texto);                      // .kg.yaml (o default)
+verdict(texto, { format: 'json' });  // .kg.json
+// { verdict: 'accept', codes: [], warnings: null, detail: '' }
+// { verdict: 'reject', codes: ['form.range.node.impact'], warnings: null, detail: '' }
+```
+
+- `verdict(texto, { format, corpus })` devolve o veredito no contrato de runner da suíte: `verdict` é `accept` ou
+  `reject`, e `codes` traz os códigos MUST, ordenados e sem repetição.
+- `check(texto, { format, corpus })` devolve só os códigos (vazio quando passa).
+- `kg-ssot/core` é o núcleo sem o validador, para quem compila o schema por conta própria. `kg-ssot/node` traz os
+  auxiliares de Node, como `corpusIndex(dir)`, que indexa os `.kg.yaml` de um diretório para conferir as
+  `external_edges`. Os schemas ficam em `kg-ssot/spec/*`.
+
+Este leitor mede só o MUST: `warnings` sai nulo. Para os avisos SHOULD, a linha de cada ocorrência e as dicas de
+correção, use o leitor de referência em Python.
+
+## TypeScript e CommonJS
+
+O pacote traz os tipos (`index.d.mts`, `core.d.mts` e `node.d.mts`) e funciona com `moduleResolution` `bundler` ou
+`nodenext`, o que cobre o template TypeScript do Expo. É um pacote ESM. Num projeto CommonJS, o `require('kg-ssot')`
+funciona a partir do Node 22.12, que é o mínimo declarado em `engines`.
+
+## Na linha de comando
+
+```bash
+npx kg-ssot-validate grafo.kg.yaml outro.kg.json
+```
+
+```text
+PASSA   grafo.kg.yaml
+REPROVA outro.kg.json
+  MUST   form.range.node.impact · integrity.orphan-node
+```
+
+O rc é 0 quando todos passam, 1 quando algum reprova e 2 com arquivo ilegível ou opção desconhecida. Com `--json`, sai uma linha JSON por
+arquivo. Com `--corpus DIR`, a ponta externa das `external_edges` é conferida contra os `.kg.yaml` sob `DIR`.
+
+## Num app React Native ou Expo
+
+O pacote é ESM e a entrada não importa nada do Node. Um bundler (Metro, esbuild) resolve as dependências, `yaml` e o
+runtime do `ajv`. O validador já vem compilado, então nada precisa gerar código no aparelho. O comportamento foi
+medido no Hermes: os mesmos vereditos do Node.
+
+## Documentação
+
+- [Manual](https://github.com/marciocar/kg-ssot/tree/main/docs/manual): o formato, o contrato, as ferramentas e os problemas comuns
+- [Suíte de conformidade](https://github.com/marciocar/kg-ssot/blob/main/spec/conformance/README.md)
+- [Guia de adoção](https://github.com/marciocar/kg-ssot/blob/main/ADOPTING.md)
+
+## Licença
+
+Apache-2.0. Veja `LICENSE` e `NOTICE`.

package/cli.mjs

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+// kg-ssot-validate: julga grafos .kg.yaml e .kg.json contra o contrato vigente, com o validador pré-compilado.
+//
+//   kg-ssot-validate <arquivo>... [--json] [--corpus DIR]
+//
+// rc 0 quando todos passam no MUST, 1 quando algum reprova, 2 com entrada quebrada (arquivo ilegível, UTF-8
+// inválido). --json imprime uma linha JSON por arquivo, no contrato de runner da suíte. --corpus confere a ponta
+// externa das external_edges contra os .kg.yaml sob DIR.
+import { readFileSync } from 'node:fs';
+
+import { verdict } from './index.mjs';
+import { corpusIndex } from './run.mjs';
+
+const USAGE = 'uso: kg-ssot-validate <arquivo.kg.yaml|arquivo.kg.json>... [--json] [--corpus DIR]\n';
+const args = process.argv.slice(2);
+let json = false;
+let corpusDir = null;
+const files = [];
+for (let i = 0; i < args.length; i += 1) {
+  const a = args[i];
+  if (a === '--help' || a === '-h') {
+    process.stdout.write(USAGE);
+    process.exit(0);
+  } else if (a === '--json') json = true;
+  else if (a === '--corpus') {
+    corpusDir = args[++i];
+    if (!corpusDir) {
+      process.stdout.write(`ENTRADA QUEBRADA  --corpus sem diretório\n${USAGE}`);
+      process.exit(2);
+    }
+  } else if (a === '--') files.push(...args.slice(i + 1)), (i = args.length);
+  else if (a.startsWith('-')) {
+    process.stdout.write(`ENTRADA QUEBRADA  opção desconhecida: ${a}\n${USAGE}`);
+    process.exit(2);
+  } else files.push(a);
+}
+if (!files.length) {
+  process.stdout.write(USAGE);
+  process.exit(2);
+}
+let rc = 0;
+let corpus = null;
+try {
+  corpus = corpusDir ? corpusIndex(corpusDir) : null;
+} catch (exc) {
+  process.stdout.write(`ENTRADA QUEBRADA  ${exc.message}\n`);
+  process.exit(2);
+}
+for (const file of files) {
+  let out;
+  try {
+    const text = new TextDecoder('utf-8', { fatal: true, ignoreBOM: true }).decode(readFileSync(file));
+    out = verdict(text, { format: file.endsWith('.json') ? 'json' : 'yaml', corpus });
+  } catch (exc) {
+    out = { verdict: 'error', codes: null, warnings: null, detail: `${exc?.name}: ${exc?.message}` };
+  }
+  if (out.verdict === 'error') rc = 2;
+  else if (out.verdict === 'reject' && rc === 0) rc = 1;
+  if (json) process.stdout.write(`${JSON.stringify({ file, ...out })}\n`);
+  else if (out.verdict === 'accept') process.stdout.write(`PASSA   ${file}\n`);
+  else if (out.verdict === 'reject') process.stdout.write(`REPROVA ${file}\n  MUST   ${out.codes.join(' · ')}\n`);
+  else process.stdout.write(`ERRO    ${file}\n  ${out.detail}\n`);
+}
+process.exit(rc);

package/core.d.mts

@@ -0,0 +1,3 @@
+// Tipos de kg-ssot/core: o núcleo do leitor, sem o validador pré-compilado (para quem compila o schema).
+export type { Corpus, Format, MustValidator, Options, Verdict } from './index.mjs';
+export { codes, indexTexts, parse, verdictOf } from './index.mjs';

package/index.d.mts

@@ -0,0 +1,47 @@
+// Tipos do pacote kg-ssot: a entrada (verdict, check, validateMust) e o núcleo que ela reexporta.
+
+/** O formato do texto: 'yaml' para .kg.yaml (o default) ou 'json' para .kg.json. */
+export type Format = 'yaml' | 'json';
+
+/** O corpus para conferir a ponta externa das external_edges: caminho do .kg.yaml → ids dos nós dele. */
+export type Corpus = Map<string, Set<string>>;
+
+export interface Options {
+  format?: Format;
+  corpus?: Corpus | null;
+}
+
+/** O veredito no contrato de runner da suíte. Este leitor mede só o MUST: warnings é sempre null. */
+export interface Verdict {
+  verdict: 'accept' | 'reject';
+  codes: string[];
+  warnings: null;
+  detail: string;
+}
+
+/** Um validador do schema MUST compilado (o pré-compilado do pacote ou um do ajv). */
+export interface MustValidator {
+  (data: unknown): boolean;
+  errors?: unknown[] | null;
+}
+
+/** O validador MUST do contrato vigente, pré-compilado sem new Function nem eval. */
+export const validateMust: MustValidator;
+
+/** O veredito do contrato vigente para o texto de um grafo. */
+export function verdict(text: string, options?: Options): Verdict;
+
+/** Os códigos MUST do texto de um grafo, ordenados e sem repetição; vazio quando passa. */
+export function check(text: string, options?: Options): string[];
+
+/** O veredito com um validador MUST qualquer (o núcleo, para quem compila o schema). */
+export function verdictOf(text: string, validate: MustValidator, options?: Options): Verdict;
+
+/** Os códigos MUST com um validador MUST qualquer. */
+export function codes(text: string, validate: MustValidator, options?: Options): string[];
+
+/** O parse no perfil do formato: { doc } quando lê, { code } com o código parse.* quando não. */
+export function parse(text: string, format?: Format): { doc?: Record<string, unknown>; code?: string };
+
+/** O corpus a partir de pares [caminho, texto .kg.yaml]. */
+export function indexTexts(items: Iterable<[string, string]>): Corpus;

package/index.mjs

@@ -0,0 +1,20 @@
+// Entrada do pacote npm kg-ssot: o núcleo do leitor (kg.mjs, sem fs nem geração de código) com o validador MUST do
+// contrato já pré-compilado (must.mjs, sem new Function nem eval). Serve a Node e a bundles de React Native/Expo.
+//
+//   import { verdict } from 'kg-ssot';
+//   verdict(texto, { format: 'yaml' })   // { verdict: 'accept' | 'reject', codes: [...], warnings: null, detail: '' }
+import validateMust from './must.mjs';
+import { codes as codesWith, verdictOf } from './kg.mjs';
+
+export * from './kg.mjs';
+export { validateMust };
+
+/** O veredito do contrato vigente para o texto de um grafo; format é 'yaml' (o default) ou 'json'. */
+export function verdict(text, { format = 'yaml', corpus = null } = {}) {
+  return verdictOf(text, validateMust, { format, corpus });
+}
+
+/** Os códigos MUST do texto de um grafo, ordenados e sem repetição; vazio quando passa. */
+export function check(text, { format = 'yaml', corpus = null } = {}) {
+  return codesWith(text, validateMust, { format, corpus });
+}