linked-rolls 0.70.0 → 0.72.0

package/lib/validate.js

@@ -1,3 +1,10 @@
+/**
+ * Checks an edition's JSON-LD document, as `asJsonLd` writes one, against
+ * the schema of the format. The same `validate` is exported from the root
+ * module; this entry point offers it alone.
+ *
+ * @module linked-rolls/validate
+ */
 import Ajv from "ajv";
 // A default import, not a namespace one: Node's ESM gives a JSON module
 // only a default export, so `import * as` hands ajv the namespace object
@@ -9,6 +16,14 @@ const compileEditionSchema = () => new Ajv({ strict: false, formats: { "date": t
  * pay for it, so the compiled form is made on first use and kept.
  */
 let compiled;
+/**
+ * Whether the document is an edition as the schema of the format
+ * describes it, such as `asJsonLd` writes. What a call found wrong is in
+ * `validate.errors` until the next call. A document written by an earlier
+ * release may fail where `importJsonLd` would still read it, since the
+ * import migrates it first (`migrate`).
+ * @category Reading and writing
+ */
 const validate = (document) => {
     compiled ?? (compiled = compileEditionSchema());
     const valid = compiled(document);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linked-rolls",
-  "version": "0.70.0",
+  "version": "0.72.0",
   "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
   "license": "MIT",
   "repository": {
@@ -46,6 +46,7 @@
     "lint": "oxlint -c .oxlintrc.json src test scripts schema",
     "build:schema": "npx ts-json-schema-generator --additional-properties --validation-keywords see --path 'src/**/*.ts' --type 'Edition' > schema_.json && node schema/postprocess.js && rm schema_.json && mv schema.json src/schema.json",
     "build:docs": "node schema/docs/generate.ts src/schema.json docs/index.html",
+    "build:api": "npm ci --prefix tools/typedoc --silent --no-audit --no-fund && tools/typedoc/node_modules/.bin/typedoc",
     "smoke": "node scripts/smoke.mjs"
   },
   "devDependencies": {