@kashscript/lexicons 0.1.1 → 0.1.2

package/README.md

@@ -10,8 +10,8 @@ A *lexicon* is the Kash equivalent of an AT-Protocol record schema: a
 versioned, NSID-addressed JSON shape that describes what valid `kash.*`
 records look like. This package gives you the primitives to **define**,
 **register**, and **validate** lexicons — but ships zero domain content
-out of the box. The domain extensions (`social`, `trade`, `zkp`) are
-explicit subpath imports.
+out of the box. The domain extensions (`social`, `trade`, `zkp`,
+`education`, `civic`, `community`) are explicit subpath imports.
 
 ---
 
@@ -19,51 +19,51 @@ explicit subpath imports.
 
 | Subpath                                | Purpose                                              |
 |----------------------------------------|------------------------------------------------------|
-| `@kashscript/lexicons`                 | Default — re-exports `envelope`, `schema`, `registry`, `engine` |
-| `@kashscript/lexicons/envelope`        | Record envelope shape + `wrap()` / `unwrap()`        |
-| `@kashscript/lexicons/schema`          | Schema DSL — `string()`, `object()`, `union()`, etc. |
+| `@kashscript/lexicons`                 | Default — the framework + identity-tier `STANDARD_LIBRARY` |
+| `@kashscript/lexicons/envelope`        | Kash-Event envelope shape (header + body + signature) + `RecordRef` |
+| `@kashscript/lexicons/schema`          | Schema DSL — the `S` builder (`S.object`, `S.string`, …) + `validate()` |
 | `@kashscript/lexicons/registry`        | `LexiconRegistry` — register, lookup, version-resolve |
-| `@kashscript/lexicons/engine`          | `validate(envelope, registry)` — pure-TS validator   |
+| `@kashscript/lexicons/engine`          | `validateEvent` / `validateBody` / `getSchemaDefinition` |
 | `@kashscript/lexicons/json-schema`     | Export lexicons as JSON Schema (draft 2020-12)       |
 | `@kashscript/lexicons/semver`          | Strict semver for lexicon evolution                  |
 | `@kashscript/lexicons/extensions/social` | The `kash.social.*` vocabulary                     |
 | `@kashscript/lexicons/extensions/trade`  | The `kash.trade.*` vocabulary                      |
 | `@kashscript/lexicons/extensions/zkp`    | The `kash.zkp.*` vocabulary                        |
+| `@kashscript/lexicons/extensions/{education,civic,community}` | Further opt-in vocabularies |
 
 ---
 
 ## Quickstart
 
 ```typescript
-import { object, string, number } from "@kashscript/lexicons/schema";
+import { S } from "@kashscript/lexicons/schema";
 import { LexiconRegistry } from "@kashscript/lexicons/registry";
-import { validate } from "@kashscript/lexicons/engine";
-
-// 1. Define a lexicon
-const myPost = {
-  nsid: "com.example.post",
-  version: "1.0.0",
-  shape: object({
-    text:      string({ maxLength: 280 }),
-    createdAt: number(),
-  }),
-};
-
-// 2. Register it
-const registry = new LexiconRegistry();
-registry.register(myPost);
+import { validateBody, validateEvent } from "@kashscript/lexicons/engine";
 
-// 3. Validate a record
-const result = validate(
+// 1. Define a body schema with the `S` builder (3rd arg of S.object = required keys).
+const noteSchema = S.object(
   {
-    $type:   "com.example.post",
-    $version:"1.0.0",
-    text:    "hello world",
-    createdAt: Date.now(),
+    text:      S.string({ maxLength: 280 }),
+    createdAt: S.string({ format: "iso8601" }),
   },
+  ["text", "createdAt"],
+);
+
+// 2. Register it under `<nsid>@<semver>` (register() is chainable).
+const registry = new LexiconRegistry();
+registry.register("com.example.note@1.0.0", noteSchema, { title: "Example Note" });
+
+// 3a. Validate a record body before signing it.
+const bodyResult = validateBody(
+  "com.example.note@1.0.0",
+  { text: "hello world", createdAt: new Date().toISOString() },
   registry,
 );
-if (!result.ok) console.error(result.errors);
+if (!bodyResult.ok) console.error(bodyResult.errors); // [{ path, message, received }]
+
+// 3b. Or validate a full signed Kash-Event envelope (header.lexicon picks the schema).
+const eventResult = validateEvent(incomingEvent, registry); // incomingEvent: unknown
+if (eventResult.ok) console.log("valid:", eventResult.value.header.lexicon);
 ```
 
 ---

package/dist/types.d.ts

@@ -1,7 +1,7 @@
 /**
- * Shared brand types used across the lexicon framework.
- * Phase-3 may re-export these from @kashscript/identity once that package
- * publishes its own brand types.
+ * Shared brand types used across the lexicon framework. Kept local to
+ * preserve the zero-dependency posture; the canonical did:kash types
+ * live in `@kashscript/identity-core/types`.
  */
 /** W3C DID restricted to the did:kash method emitted by `@kashscript/identity-core`. */
 export type DID = `did:kash:${string}`;

package/dist/types.js

@@ -1,7 +1,7 @@
 /**
- * Shared brand types used across the lexicon framework.
- * Phase-3 may re-export these from @kashscript/identity once that package
- * publishes its own brand types.
+ * Shared brand types used across the lexicon framework. Kept local to
+ * preserve the zero-dependency posture; the canonical did:kash types
+ * live in `@kashscript/identity-core/types`.
  */
 /** Domain-Separation Tag for record-tier signatures (Identity Protocol §5.5). */
 export const KASH_RECORD_DST = "kash-record-v1\n";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kashscript/lexicons",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Zero-dependency lexicon framework — envelope, schema DSL, registry, validator. Agnostic core; domain content ships as opt-in extensions.",
   "type": "module",
   "main": "./dist/index.js",

package/src/types.ts

@@ -1,7 +1,7 @@
 /**
- * Shared brand types used across the lexicon framework.
- * Phase-3 may re-export these from @kashscript/identity once that package
- * publishes its own brand types.
+ * Shared brand types used across the lexicon framework. Kept local to
+ * preserve the zero-dependency posture; the canonical did:kash types
+ * live in `@kashscript/identity-core/types`.
  */
 
 /** W3C DID restricted to the did:kash method emitted by `@kashscript/identity-core`. */