mailschema 0.1.3 → 0.1.5

package/README.md

@@ -3,9 +3,9 @@
 [![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 Mail Action Protocol documents and MailSchema Registry contributions without making a network request.
+The Mail Action Protocol 0.2 core artifacts, and local validation of MailSchema Registry contributions, with no network requests.
 
-[Specification](https://mailschema.org/specification/) · [Registry](https://mailschema.org/registry/) · [Tools](https://mailschema.org/tools/) · [Source](https://github.com/mailschema/javascript)
+[Specification](https://mailschema.org/specification) · [Registry](https://mailschema.org/registry) · [Tools](https://mailschema.org/tools) · [Source](https://github.com/mailschema/javascript)
 
 ## Install
 
@@ -15,51 +15,40 @@ npm install mailschema
 
 Node.js 22 or newer is required. The package is ESM and includes TypeScript declarations.
 
-## Validate MAP documents
+## MAP 0.2 core artifacts
 
 ```js
-import { assertMapDocument, assertContentReviewRequest, getMapSchema } from 'mailschema';
-
-assertMapDocument(description);
-assertContentReviewRequest(request);
-const mapSchema = getMapSchema();
+import {
+  MAP_PROFILE,
+  getContractFormatSchema,
+  getFormsSchema,
+  getMapContext,
+  getMapSchema,
+} from 'mailschema';
 ```
 
-The CLI performs the same checks against local JSON files:
-
-```sh
-npx mailschema check description.json --map
-npx mailschema check request.json --content-review
-```
+Each is byte-identical to the file the [profile record](https://mailschema.org/profiles/map/0.2.json) binds by SHA-256, and is also exported raw as `mailschema/map-0.2.schema.json`, `mailschema/map-0.2.jsonld`, `mailschema/type-contract-0.2.schema.json` and `mailschema/forms-0.1.schema.json`. Type contracts are not bundled: a client obtains them from the [Registry catalogue](https://mailschema.org/registry/catalog.json) by digest. Processing MAP messages is outside this package; see the [profile](https://mailschema.org/specification/profile).
 
-## Work with Registry data
+## Registry data
 
 ```js
-import {
-  assertContribution,
-  contributionErrors,
-  getContributionSchema,
-  referenceErrors,
-} from 'mailschema';
+import { assertContribution, contributionErrors, referenceErrors } from 'mailschema';
 
 const errors = contributionErrors(candidate);
 if (errors.length) console.error(errors);
 else assertContribution(candidate);
 
-const schema = getContributionSchema();
 const referenceProblems = referenceErrors(candidate, catalog);
 ```
 
-`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.
-
-Raw Draft 2020-12 schemas are exported as:
+`assertTypeRecord` and `getRecordSchema` handle expanded Registry records. Reference checks use a catalogue supplied by the caller; the package never fetches one.
 
-- `mailschema/map-0.1.schema.json`
-- `mailschema/content-review-0.1.schema.json`
-- `mailschema/contribution.schema.json`
+```sh
+npx mailschema check contribution.json
+npx mailschema check record.json --record
+npx mailschema schema --map
+```
 
 ## Trust boundary
 
-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.
-
-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.
+A valid document is structured input. Validation does not authenticate a service, grant authority or establish product conformance. 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/bin/mailschema.js

@@ -3,59 +3,52 @@ import { open } from 'node:fs/promises';
 import { parseArgs } from 'node:util';
 import {
   assertContribution,
-  assertContentReviewRequest,
-  assertMapDocument,
   assertTypeRecord,
-  getContentReviewSchema,
+  getContractFormatSchema,
   getContributionSchema,
+  getFormsSchema,
+  getMapContext,
   getMapSchema,
   getRecordSchema,
 } from '../dist/index.js';
 
-const help = `MailSchema contribution tools
+const help = `MailSchema Registry tools
 
-  mailschema check <file.json> [--record | --map | --content-review]
-  mailschema schema [--record | --map | --content-review]
+  mailschema check <file.json> [--record]
+  mailschema schema [--record | --map | --context | --contract-format | --forms]
 
-Checks JSON structure and required fields locally. Registry references and
-editorial acceptance are separate checks. No files are uploaded or changed.`;
+check validates a Registry contribution, or with --record an expanded record,
+locally. schema prints a bundled schema: the contribution schema by default, or
+a MAP 0.2 core artifact. No files are uploaded or changed.`;
+
+const schemas = {
+  record: getRecordSchema,
+  map: getMapSchema,
+  context: getMapContext,
+  'contract-format': getContractFormatSchema,
+  forms: getFormsSchema,
+};
 
 try {
   const { values, positionals } = parseArgs({
     allowPositionals: true,
     options: {
-      record: { type: 'boolean' },
-      map: { type: 'boolean' },
-      'content-review': { type: 'boolean' },
+      ...Object.fromEntries(Object.keys(schemas).map((name) => [name, { type: 'boolean' }])),
       help: { type: 'boolean', short: 'h' },
     },
   });
   const [command, path, ...extra] = positionals;
-  const formats = [values.record, values.map, values['content-review']].filter(Boolean);
-  if (formats.length > 1) throw new Error('Choose only one document format.');
-  const selected = values['content-review']
-    ? 'Content Review request'
-    : values.map
-      ? 'MAP document'
-      : values.record
-        ? 'type record'
-        : 'contribution';
+  const chosen = Object.keys(schemas).filter((name) => values[name]);
+  if (chosen.length > 1) throw new Error('Choose only one schema.');
   if (values.help || !command) console.log(help);
   else if (command === 'schema' && !path && !extra.length)
-    console.log(
-      JSON.stringify(
-        values['content-review']
-          ? getContentReviewSchema()
-          : values.map
-            ? getMapSchema()
-            : values.record
-              ? getRecordSchema()
-              : getContributionSchema(),
-        null,
-        2,
-      ),
-    );
-  else if (command === 'check' && path && !extra.length) {
+    console.log(JSON.stringify((schemas[chosen[0]] ?? getContributionSchema)(), null, 2));
+  else if (
+    command === 'check' &&
+    path &&
+    !extra.length &&
+    chosen.every((name) => name === 'record')
+  ) {
     const file = await open(path, 'r');
     let value;
     try {
@@ -69,11 +62,9 @@ try {
     } finally {
       await file.close();
     }
-    if (values['content-review']) assertContentReviewRequest(value);
-    else if (values.map) assertMapDocument(value);
-    else if (values.record) assertTypeRecord(value);
+    if (values.record) assertTypeRecord(value);
     else assertContribution(value);
-    console.log(`Valid MailSchema ${selected}.`);
+    console.log(`Valid MailSchema ${values.record ? 'type record' : 'contribution'}.`);
   } else throw new Error(help);
 } catch (error) {
   console.error(error instanceof Error ? error.message : String(error));

package/dist/forms-0.1.schema.json

@@ -0,0 +1,329 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mailschema.org/schemas/forms-0.1.schema.json",
+  "title": "MailSchema form fields 0.1",
+  "description": "Shared, immutable blocks for types that collect values: a closed subset of JSON Schema based on Model Context Protocol elicitation, with HTML autofill field names.",
+  "$defs": {
+    "fieldName": {
+      "type": "string",
+      "pattern": "^[a-z][A-Za-z0-9]{0,63}$"
+    },
+    "text": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2000,
+      "pattern": "[^\\t\\n\\u000b\\f\\r \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]"
+    },
+    "autocomplete": {
+      "type": "string",
+      "maxLength": 200,
+      "pattern": "^(?:section-[a-z0-9-]+ )?(?:(?:shipping|billing) )?(?:(?:home|work|mobile|fax|pager) )?[a-z][a-z0-9-]*$",
+      "not": {
+        "pattern": "(?:^| )(?:current-password|new-password|one-time-code|cc-[a-z-]+)$"
+      }
+    },
+    "choice": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "const": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 240,
+          "pattern": "[^\\t\\n\\u000b\\f\\r \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]"
+        }
+      },
+      "required": ["const", "title"]
+    },
+    "choices": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/choice"
+      },
+      "minItems": 1,
+      "maxItems": 100
+    },
+    "textField": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "string"
+        },
+        "title": {
+          "$ref": "#/$defs/text"
+        },
+        "description": {
+          "$ref": "#/$defs/text"
+        },
+        "minLength": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 12000
+        },
+        "maxLength": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12000
+        },
+        "format": {
+          "enum": ["email", "uri", "date", "date-time"]
+        },
+        "default": {
+          "type": "string",
+          "maxLength": 12000
+        },
+        "autocomplete": {
+          "$ref": "#/$defs/autocomplete"
+        }
+      },
+      "required": ["type", "title"]
+    },
+    "numberField": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "enum": ["number", "integer"]
+        },
+        "title": {
+          "$ref": "#/$defs/text"
+        },
+        "description": {
+          "$ref": "#/$defs/text"
+        },
+        "minimum": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "maximum": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "default": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "autocomplete": {
+          "$ref": "#/$defs/autocomplete"
+        }
+      },
+      "required": ["type", "title"]
+    },
+    "booleanField": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "boolean"
+        },
+        "title": {
+          "$ref": "#/$defs/text"
+        },
+        "description": {
+          "$ref": "#/$defs/text"
+        },
+        "default": {
+          "type": "boolean"
+        }
+      },
+      "required": ["type", "title"]
+    },
+    "choiceField": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "string"
+        },
+        "title": {
+          "$ref": "#/$defs/text"
+        },
+        "description": {
+          "$ref": "#/$defs/text"
+        },
+        "oneOf": {
+          "$ref": "#/$defs/choices"
+        },
+        "default": {
+          "type": "string",
+          "maxLength": 200
+        },
+        "autocomplete": {
+          "$ref": "#/$defs/autocomplete"
+        }
+      },
+      "required": ["type", "title", "oneOf"]
+    },
+    "choicesField": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "array"
+        },
+        "title": {
+          "$ref": "#/$defs/text"
+        },
+        "description": {
+          "$ref": "#/$defs/text"
+        },
+        "items": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "anyOf": {
+              "$ref": "#/$defs/choices"
+            }
+          },
+          "required": ["anyOf"]
+        },
+        "minItems": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 100
+        },
+        "maxItems": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 100
+        },
+        "uniqueItems": {
+          "const": true
+        },
+        "default": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "maxLength": 200
+          },
+          "maxItems": 100,
+          "uniqueItems": true
+        }
+      },
+      "required": ["type", "title", "items", "uniqueItems"]
+    },
+    "fields": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "object"
+        },
+        "properties": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 50,
+          "propertyNames": {
+            "$ref": "#/$defs/fieldName"
+          },
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/textField"
+              },
+              {
+                "$ref": "#/$defs/numberField"
+              },
+              {
+                "$ref": "#/$defs/booleanField"
+              },
+              {
+                "$ref": "#/$defs/choiceField"
+              },
+              {
+                "$ref": "#/$defs/choicesField"
+              }
+            ]
+          }
+        },
+        "required": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/fieldName"
+          },
+          "uniqueItems": true,
+          "maxItems": 50
+        }
+      },
+      "required": ["type", "properties"]
+    },
+    "choiceFields": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "object"
+        },
+        "properties": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 50,
+          "propertyNames": {
+            "$ref": "#/$defs/fieldName"
+          },
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/booleanField"
+              },
+              {
+                "$ref": "#/$defs/choiceField"
+              },
+              {
+                "$ref": "#/$defs/choicesField"
+              }
+            ]
+          }
+        },
+        "required": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/fieldName"
+          },
+          "uniqueItems": true,
+          "maxItems": 50
+        }
+      },
+      "required": ["type", "properties"]
+    },
+    "fieldValues": {
+      "type": "object",
+      "maxProperties": 50,
+      "propertyNames": {
+        "$ref": "#/$defs/fieldName"
+      },
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "type": "string",
+            "maxLength": 12000
+          },
+          {
+            "type": "number"
+          },
+          {
+            "type": "boolean"
+          },
+          {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "maxItems": 100,
+            "uniqueItems": true
+          }
+        ]
+      }
+    }
+  }
+}

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { contributionErrors, assertContribution, assertTypeRecord, referenceErro
 export type { CatalogView } from './validation.js';
 export { typeStages } from './model.js';
 export type { Party, TypeDefinition, TypeRecord, Contribution, Implementation } from './model.js';
-export { mapErrors, assertMapDocument, contentReviewRequestErrors, assertContentReviewRequest, getMapSchema, getContentReviewSchema, } from './map.js';
+export { MAP_PROFILE, getMapSchema, getMapContext, getContractFormatSchema, getFormsSchema, } from './map.js';
 /** Return an independent copy of the contribution JSON Schema (Draft 2020-12). */
 export declare function getContributionSchema(): Record<string, unknown>;
 /** Return the schema for an expanded Registry record, including attribution and history. */

package/dist/index.js

@@ -1,8 +1,8 @@
-/** Schemas and validation tools for MAP documents and MailSchema Registry contributions. */
+/** The MAP 0.2 core artifacts and validation tools for MailSchema Registry contributions. */
 import schema from './contribution.schema.json' with { type: 'json' };
 export { contributionErrors, assertContribution, assertTypeRecord, referenceErrors, } from './validation.js';
 export { typeStages } from './model.js';
-export { mapErrors, assertMapDocument, contentReviewRequestErrors, assertContentReviewRequest, getMapSchema, getContentReviewSchema, } from './map.js';
+export { MAP_PROFILE, getMapSchema, getMapContext, getContractFormatSchema, getFormsSchema, } from './map.js';
 /** Return an independent copy of the contribution JSON Schema (Draft 2020-12). */
 export function getContributionSchema() {
     return structuredClone(schema);

package/dist/map-0.2.jsonld

@@ -0,0 +1,91 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "map": "https://mailschema.org/ns/map#",
+    "schema": "https://schema.org/",
+    "MailAction": "map:MailAction",
+    "profile": {
+      "@id": "map:profile",
+      "@type": "@id"
+    },
+    "type": {
+      "@id": "map:interactionType",
+      "@context": {
+        "id": {
+          "@id": "map:id",
+          "@type": "@id"
+        }
+      }
+    },
+    "version": "schema:version",
+    "contractDigest": "map:contractDigest",
+    "describedAt": {
+      "@id": "schema:dateCreated",
+      "@type": "http://www.w3.org/2001/XMLSchema#dateTime"
+    },
+    "expiresAt": {
+      "@id": "schema:expires",
+      "@type": "http://www.w3.org/2001/XMLSchema#dateTime"
+    },
+    "service": {
+      "@id": "schema:provider",
+      "@context": {
+        "id": {
+          "@id": "map:id",
+          "@type": "@id"
+        }
+      }
+    },
+    "name": "schema:name",
+    "authority": "map:authority",
+    "onBehalfOf": {
+      "@id": "map:onBehalfOf",
+      "@context": {
+        "id": {
+          "@id": "map:id",
+          "@type": "@id"
+        }
+      }
+    },
+    "resource": {
+      "@id": "map:resource",
+      "@type": "@id"
+    },
+    "execution": "map:execution",
+    "url": {
+      "@id": "schema:url",
+      "@type": "@id"
+    },
+    "resultUrlTemplate": "map:resultUrlTemplate",
+    "resultRetentionSeconds": "map:resultRetentionSeconds",
+    "humanUrl": {
+      "@id": "map:humanUrl",
+      "@type": "@id"
+    },
+    "target": {
+      "@id": "schema:object",
+      "@context": {
+        "id": {
+          "@id": "map:id",
+          "@type": "@id"
+        }
+      }
+    },
+    "recipient": "schema:recipient",
+    "details": {
+      "@id": "map:details",
+      "@type": "@json"
+    },
+    "revision": "schema:version",
+    "title": "schema:name",
+    "digest": "map:digest",
+    "operations": {
+      "@id": "schema:potentialAction",
+      "@container": "@set",
+      "@context": {
+        "id": "map:operationId"
+      }
+    },
+    "description": "schema:description"
+  }
+}