@manta-eu/ldo 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Manta AI AS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# manta-ldo
+
+This package generates TS types (via LDKit) from SHACL shapes.
+
+## Build process
+
+1. `pnpm build:shacl` — assembles `.shapes/shacl.ttl` from the kgc sources below.
+2. `pnpm build:ldkit` — regenerates the codegen-only `.shapes/shacl-ldkit.ttl` projection, then
+   generates `.ldkit/*.ts` from `.shapes/shacl.ttl` + that projection.
+
+`pnpm codegen` runs both in order. Only `.ldkit/*.ts` is committed to git (see `.gitattributes`,
+`linguist-generated=true`). The two `.shapes/*.ttl` files above are intermediates of that run and are
+git-ignored; `.shapes/reference/shacl-shacl.ttl` is a committed input and stays.
+
+Shapes are authored against the canonical vocabulary as a
+realm-invariant superset; `@manta-eu/ldo/realm` (`realm.ts`) rebases the generated `.ldkit/namespaces.ts`
+onto whichever realm the app runs as (`VITE_KEYCLOAK_REALM`), so one generation serves every realm.
+
+Running `pnpm build:shacl` assembles `.shapes/shacl.ttl` from three kgc sources for one pinned realm
+(`codegenRealm` in `scripts/build-shacl.mjs`): the realm's `all-shacl.ttl` from
+`devenv build outputs.all-shacl-by-realm`, its `ontology/memory-schemas.ttl`, and its
+`shacl/shapes/observed-entities.ttl`. Every realm's IRIs are rebased onto one canonical vocabulary
+root, since the generated types recompose them at runtime from `realm.ts`.
+
+## Per-realm SHACL (a separate concern, not built here)
+
+The per-realm bundle `<realm>/all-shacl.ttl` — the shared bundle rebased to the realm, plus the
+realm's own shapes — is unrelated to the codegen above and is committed at the repo root. It carries
+no `ontology/memory-schemas.ttl`. Only `.shapes/shacl.ttl` above merges that file.
+`make generate-shacl-all` builds the bundle with Nix (`devenv/packages/all-shacl-by-realm.nix`) into
+`shacl/<realm>/all-shacl.ttl`. `manta-shacl-upload` uploads it to RDFox for SHACL validation, and
+`manta.action-handlers-codegen`'s `shacl.clj` reads the same file.
+
+## Rebuild Process
+
+Whenever the realm shapes change, this needs to be rebuilt to regenerate the TS types.
+
+> pnpm codegen
+
+That runs `build:shacl` and `build:ldkit` in order. CI runs the same script (in the `devenv build`
+workflow, where nix is set up) and fails when the committed output differs, so regenerate and commit
+whenever the realm shapes change.
+
+The memory subclass shapes inside it are authored and tested kgc-side — see
+`kgc/tests/test_memory_schema_shapes.py` (structural invariants) and
+`kgc/tests/test_memory_subclass_parity.py` (subclass ↔ inference-rule parity), both parametrized
+over every realm.