linked-rolls 0.58.0 → 0.59.0

package/lib/index.d.ts

@@ -45,7 +45,7 @@ export * from './analysis/sigla.js';
 export * from './model/notes.js';
 export { asJsonLd } from './io/asJsonLd.js';
 export { importJsonLd } from './io/importJsonLd.js';
-export { formatVersion, migrate } from './io/migrate.js';
+export { migrate } from './io/migrate.js';
 export { readFromStanfordAton, type StanfordAtonOptions } from './readers/stanfordAton.js';
 export { readFromPhillipsEroll, CONTROL_OFFSET, phillipsSystems, type PhillipsErollOptions } from './readers/phillipsEroll.js';
 export { readFromSpencerBar, readSpencerAnn, paperSpeedOfSpencerAnn, SPENCER_ROWS_PER_INCH, type SpencerBarOptions } from './readers/spencerBar.js';

package/lib/index.js

@@ -38,7 +38,7 @@ export * from './analysis/sigla.js';
 export * from './model/notes.js';
 export { asJsonLd } from './io/asJsonLd.js';
 export { importJsonLd } from './io/importJsonLd.js';
-export { formatVersion, migrate } from './io/migrate.js';
+export { migrate } from './io/migrate.js';
 export { readFromStanfordAton } from './readers/stanfordAton.js';
 export { readFromPhillipsEroll, CONTROL_OFFSET, phillipsSystems } from './readers/phillipsEroll.js';
 export { readFromSpencerBar, readSpencerAnn, paperSpeedOfSpencerAnn, SPENCER_ROWS_PER_INCH } from './readers/spencerBar.js';

package/lib/io/asJsonLd.js

@@ -1,7 +1,6 @@
 import { systemIdIn } from "../systems/TrackerBar.js";
 import { certaintyOf, isAsserted } from "../model/Assumption.js";
 import context from "../spec/context.json" with { type: 'json' };
-import { formatVersion } from "./migrate.js";
 /**
  * The keys an export derives from the tree, which no node of the
  * edition states itself. An import reads them off again.
@@ -164,7 +163,6 @@ export const asJsonLd = (edition) => {
             }
         ],
         '@id': edition.base,
-        formatVersion,
         ...rest,
         ...(quoted.length > 0 && { '@included': quoted })
     };

package/lib/io/importJsonLd.js

@@ -119,7 +119,7 @@ const withQuotedStatementsInPlace = (edition) => {
     return withReferencesOn({ ...rest, ...(others.length > 0 && { '@included': others }) }, bySubject);
 };
 export const importJsonLd = (json) => {
-    const { '@context': context, formatVersion: _revision, ...document } = withPlainCopyIds(migrate(withQuotedStatementsInPlace(json)));
+    const { '@context': context, ...document } = withPlainCopyIds(migrate(withQuotedStatementsInPlace(json)));
     const edition = fromJsonLdEntity(document);
     edition.base = Array.isArray(context)
         ? context.find((c) => c['@base'])?.['@base'] || ''

package/lib/io/migrate.d.ts

@@ -13,14 +13,5 @@
 type Json = any;
 /** A copy's id without the `copy/` that documents of earlier releases put before it. */
 export declare const plainCopyId: (id: string) => string;
-/**
- * The revision of the format this release writes, stated in every export
- * as `formatVersion`. A document stating it is in the current shape and
- * passes through untouched; one stating none was written before the
- * revisions were numbered and is brought up by recognising its shapes.
- * A step added later is to run on the documents of the revisions before
- * it, and to raise this number.
- */
-export declare const formatVersion = 1;
 export declare const migrate: (edition: Json) => Json;
 export {};

package/lib/io/migrate.js

@@ -4,10 +4,10 @@ import { welteT100 } from "../systems/welteT100/bar.js";
 import { isDateString } from "../shared/utils.js";
 const retiredVersionTypes = new Set(['edition', 'unicum']);
 /**
- * The vocabulary the steps below were written against, as it stood when
- * the format was first given a revision number. It is copied here rather
- * than imported from the model, so that changing today's vocabulary
- * cannot change how an old document is read. The tracker bars are still
+ * The vocabulary the steps below were written against, as it stood in
+ * release 0.58.0. It is copied here rather than imported from the model,
+ * so that changing today's vocabulary cannot change how an old document
+ * is read. The tracker bars are still
  * asked, being the layout of instruments rather than a choice of the
  * format.
  */
@@ -511,27 +511,12 @@ const withDerivationTolerance = (edition) => {
             : version)
     };
 };
-const editionSteps = [withoutEditionType, withSystems, withEditors, withDerivationTolerance];
-/**
- * The revision of the format this release writes, stated in every export
- * as `formatVersion`. A document stating it is in the current shape and
- * passes through untouched; one stating none was written before the
- * revisions were numbered and is brought up by recognising its shapes.
- * A step added later is to run on the documents of the revisions before
- * it, and to raise this number.
- */
-export const formatVersion = 1;
-export const migrate = (edition) => {
-    const stated = edition?.formatVersion;
-    if (stated === formatVersion)
+/** Release 0.58.0 stated a revision of the format, which the format does not state. */
+const withoutFormatVersion = (edition) => {
+    if (!Object.hasOwn(edition, 'formatVersion'))
         return edition;
-    if (typeof stated === 'number' && stated > formatVersion) {
-        throw new Error(`The document is written in revision ${stated} of the format, which this release, reading up to ${formatVersion}, does not know`);
-    }
-    const current = walk(editionSteps.reduce((result, step) => step(result), edition));
-    // What comes out is in the current revision and says so, so that it
-    // passes through untouched when it is migrated again.
-    return current !== null && typeof current === 'object' && !Array.isArray(current)
-        ? { ...current, formatVersion }
-        : current;
+    const { formatVersion: _stated, ...rest } = edition;
+    return rest;
 };
+const editionSteps = [withoutFormatVersion, withoutEditionType, withSystems, withEditors, withDerivationTolerance];
+export const migrate = (edition) => walk(editionSteps.reduce((result, step) => step(result), edition));

package/lib/spec/context.json

@@ -89,7 +89,6 @@
             "@type": "xsd:date"
         },
         "collationTolerance": null,
-        "formatVersion": null,
         "annotation": null,
         "roll": "lrmoo:R3i_realises",
         "catalogueNumber": "dcterms:identifier",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linked-rolls",
-  "version": "0.58.0",
+  "version": "0.59.0",
   "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
   "license": "MIT",
   "repository": {