mailschema 0.1.1 → 0.1.3

package/README.md

@@ -1,41 +1,65 @@
-# MailSchema
+# MailSchema for JavaScript
 
-JSON Schemas and validation tools for Mail Action Protocol 0.1 and the MailSchema Registry.
+[![npm](https://img.shields.io/npm/v/mailschema)](https://www.npmjs.com/package/mailschema)
+[![CI](https://github.com/mailschema/javascript/actions/workflows/test.yml/badge.svg)](https://github.com/mailschema/javascript/actions/workflows/test.yml)
 
-Validate MAP descriptions, requests, results and problems, or prepare a Registry contribution. The package is local and performs no network requests.
+Validate Mail Action Protocol documents and MailSchema Registry contributions without making a network request.
+
+[Specification](https://mailschema.org/specification/) · [Registry](https://mailschema.org/registry/) · [Tools](https://mailschema.org/tools/) · [Source](https://github.com/mailschema/javascript)
+
+## Install
 
 ```sh
 npm install mailschema
-npx mailschema check contribution.json
-npx mailschema schema > contribution.schema.json
+```
+
+Node.js 22 or newer is required. The package is ESM and includes TypeScript declarations.
+
+## Validate MAP documents
+
+```js
+import { assertMapDocument, assertContentReviewRequest, getMapSchema } from 'mailschema';
+
+assertMapDocument(description);
+assertContentReviewRequest(request);
+const mapSchema = getMapSchema();
+```
+
+The CLI performs the same checks against local JSON files:
+
+```sh
 npx mailschema check description.json --map
 npx mailschema check request.json --content-review
 ```
 
-Node.js 22 or newer. The JavaScript API is ESM; the CLI reads a local JSON file of at most 256 KiB and does not upload or modify it.
+## Work with Registry data
 
 ```js
-import { assertContribution, contributionErrors, getContributionSchema } from 'mailschema';
+import {
+  assertContribution,
+  contributionErrors,
+  getContributionSchema,
+  referenceErrors,
+} from 'mailschema';
 
 const errors = contributionErrors(candidate);
 if (errors.length) console.error(errors);
 else assertContribution(candidate);
 
-const schema = getContributionSchema(); // Independent copy, JSON Schema Draft 2020-12.
+const schema = getContributionSchema();
+const referenceProblems = referenceErrors(candidate, catalog);
 ```
 
-```js
-import { assertMapDocument, assertContentReviewRequest, getMapSchema } from 'mailschema';
+`assertTypeRecord`, `getRecordSchema` and `mailschema check record.json --record` handle expanded Registry records. Reference checks use a catalogue supplied by the caller; the package never fetches one automatically.
 
-assertMapDocument(description);
-assertContentReviewRequest(request);
-const mapSchema = getMapSchema();
-```
+Raw Draft 2020-12 schemas are exported as:
 
-Use `assertTypeRecord(value)` or `mailschema check record.json --record` for expanded Registry records. `getRecordSchema()` returns the equivalent schema. The raw contribution schema is also exported as `mailschema/contribution.schema.json`.
+- `mailschema/map-0.1.schema.json`
+- `mailschema/content-review-0.1.schema.json`
+- `mailschema/contribution.schema.json`
 
-For a structurally valid contribution, `referenceErrors(contribution, catalog)` checks references against a supplied catalogue: current amendment bases, existing type names, exact implementation records, versions, profiles and operations. The catalogue contains `types` and `snapshots` arrays of `{ record, digest }` entries. It is never fetched automatically.
+## Trust boundary
 
-`Contribution`, `TypeRecord`, `TypeDefinition`, `Implementation`, `Party` and `CatalogView` are exported TypeScript types. Successful validation does not verify a contributor's identity, establish product compatibility or accept a submission. Full repository review also checks competing amendments and contribution identifiers.
+A valid document is structured input. Validation does not authenticate a service, grant authority, approve an action or establish product conformance. Implementations must apply their own endpoint trust, credentials, permissions and policy before executing a request.
 
-Raw schemas are exported as `mailschema/map-0.1.schema.json`, `mailschema/content-review-0.1.schema.json` and `mailschema/contribution.schema.json`. Package version `0.2.0` is independent of the MAP profile version. MIT licensed.
+The CLI reads one local file of at most 256 KiB and does not upload or modify it. Package versions and MAP profile versions advance independently. MIT licensed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailschema",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Schemas and validation tools for Mail Action Protocol and the MailSchema Registry",
   "type": "module",
   "license": "MIT",
@@ -8,10 +8,10 @@
   "homepage": "https://mailschema.org/tools/",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mailschema/mailschema.git"
+    "url": "git+https://github.com/mailschema/javascript.git"
   },
   "bugs": {
-    "url": "https://github.com/mailschema/mailschema/issues"
+    "url": "https://github.com/mailschema/javascript/issues"
   },
   "engines": {
     "node": ">=22"
@@ -36,10 +36,17 @@
     "README.md",
     "LICENSE"
   ],
+  "scripts": {
+    "build": "node build.mjs",
+    "test": "npm run build && node --test test/*.test.mjs"
+  },
   "dependencies": {
     "ajv": "8.20.0",
     "ajv-formats": "3.0.1"
   },
+  "devDependencies": {
+    "typescript": "5.9.3"
+  },
   "keywords": [
     "email",
     "schema",