@manta-eu/ldo 0.1.0 → 0.1.1

package/README.md

@@ -1,47 +1,48 @@
-# manta-ldo
+# @manta-eu/ldo
 
-This package generates TS types (via LDKit) from SHACL shapes.
+TypeScript types for the Manta knowledge graph, generated from its SHACL shapes with
+[LDkit](https://ldkit.io/).
 
-## Build process
+## Installation
 
-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.
+```bash
+pnpm add @manta-eu/ldo
+```
 
-`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.
+## Usage
 
-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.
+Each export is a set of generated LDkit schemas and the namespaces they are built from:
 
-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`.
+```typescript
+import { namespaces } from "@manta-eu/ldo/namespaces";
+import * as schemas from "@manta-eu/ldo/schemas";
+```
 
-## Per-realm SHACL (a separate concern, not built here)
+The types describe the graph as a whole. `./realm` carries the vocabulary roots a deployment
+rebases them onto:
 
-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.
+```typescript
+import { realmRegistry, realmVocabRoots, defaultRealm } from "@manta-eu/ldo/realm";
+```
 
-## Rebuild Process
+These read injected configuration: without `VITE_REALM_REGISTRY` carrying the roster your
+application deploys, `realmVocabRoots` is empty and `defaultRealm` is `""`. `VITE_KEYCLOAK_REALM`
+picks which of them is active, and is optional — unset means the default.
 
-Whenever the realm shapes change, this needs to be rebuilt to regenerate the TS types.
+## Exports
 
-> pnpm codegen
+| Export             | Contents                                             |
+| ------------------ | ---------------------------------------------------- |
+| `.`                | The generated schemas and namespaces together        |
+| `./schemas`        | LDkit schemas for every shape                        |
+| `./namespaces`     | Namespace prefixes the schemas are built from        |
+| `./realm`          | Vocabulary roots and the registry that resolves them |
+| `./sparql-types`   | Types for SPARQL result bindings                     |
+| `./manual-schemas` | Hand-written schemas for shapes that are not derived |
 
-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.
+`./ad-platform-links`, `./external-links`, `./figma-links` and `./redirect-queries` carry the
+link-shaped helpers that go with them.
 
-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.
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manta-eu/ldo",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Package that generates TS types from SHACL shapes using LDkit",
   "exports": {
     ".": {
@@ -83,6 +83,6 @@
     "codegen": "pnpm build:shacl && pnpm build:ldkit",
     "test": "vitest --run",
     "types": "tsc --noEmit",
-    "build": "tsc --project tsconfig.build.json && tsc-alias --project tsconfig.build.json --resolve-full-paths"
+    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc --project tsconfig.build.json && tsc-alias --project tsconfig.build.json --resolve-full-paths"
   }
 }