linked-rolls 0.57.0 → 0.58.0

package/lib/emulation/negotiation.js

@@ -0,0 +1,20 @@
+/**
+ * The symbol as a performance needs it: where it lies, and the
+ * position the performing bar reads it on.
+ *
+ * Nothing where that bar reads nothing of it, which is the case a
+ * transfer between systems leaves behind: a red `ForzandoOn` a
+ * green version still inherits cannot be performed on a green
+ * machine, and an edit has yet to say what took its place.
+ */
+export const negotiatedEventOf = (view, symbol, bar) => {
+    const horizontal = view.placeOf(symbol);
+    const position = bar.positionOf(symbol);
+    if (!horizontal || position === undefined)
+        return null;
+    return {
+        ...symbol,
+        horizontal,
+        vertical: { unit: 'track', from: position }
+    };
+};

package/lib/index.d.ts

@@ -1,43 +1,51 @@
-export * from './utils.js';
-export * from './Quantity.js';
-export * from './Agent.js';
-export * from './Assumption.js';
-export * from './ConditionState.js';
-export * from './Symbol.js';
-export * from './Feature.js';
-export * from './Edit.js';
-export * from './Version.js';
-export * from './Collation.js';
-export * from './TrackCalibration.js';
-export * from './TrackerBar.js';
+/**
+ * The public interface of the library. Everything else under lib/ is its
+ * implementation and may change in any release: the in-place helpers the
+ * operations are built from, the date conversions of the serialisation,
+ * and the general utilities.
+ */
+export type { WithId, WithNote, WithType } from './shared/utils.js';
+export * from './model/Quantity.js';
+export * from './model/Agent.js';
+export * from './model/Assumption.js';
+export * from './model/ConditionState.js';
+export * from './model/Symbol.js';
+export * from './model/Feature.js';
+export * from './model/Edit.js';
+export * from './model/Version.js';
+export * from './collation/Collation.js';
+export * from './model/TrackCalibration.js';
+export * from './systems/TrackerBar.js';
 export * from './systems/welteT100/bar.js';
 export * from './systems/welteLicensee/bar.js';
 export * from './systems/welteT98/bar.js';
 export * from './systems/index.js';
-export * from './ReproducingSystem.js';
-export * from './FeatureSource.js';
-export * from './Perforator.js';
-export * from './RollCopy.js';
-export * from './procedures.js';
-export * from './vocabulary.js';
-export * from './reservations.js';
-export * from './witnesses.js';
-export * from './alignment.js';
-export * from './statistics.js';
-export * from './Edition.js';
-export * from './EditionView.js';
-export * from './scatter.js';
-export * from './editionOps.js';
-export * from './Emulation.js';
+export * from './systems/ReproducingSystem.js';
+export * from './model/FeatureSource.js';
+export * from './model/Perforator.js';
+export * from './model/RollCopy.js';
+export * from './model/procedures.js';
+export * from './model/vocabulary.js';
+export * from './analysis/reservations.js';
+export * from './analysis/witnesses.js';
+export { alignFeatures, tooShortToShorten, type AlignmentResult } from './collation/alignment.js';
+export * from './collation/statistics.js';
+export * from './model/Edition.js';
+export * from './view/EditionView.js';
+export * from './analysis/ownPaper.js';
+export * from './emulation/negotiation.js';
+export * from './collation/scatter.js';
+export * from './ops/index.js';
+export * from './emulation/Emulation.js';
 export * from './validate.js';
-export * from './constraints.js';
-export * from './substitution.js';
-export * from './context.js';
-export * from './sigla.js';
-export * from './notes.js';
-export * from './asJsonLd.js';
-export * from './importJsonLd.js';
-export * from './migrate.js';
+export * from './analysis/constraints.js';
+export * from './collation/substitution.js';
+export * from './io/context.js';
+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 { 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

@@ -1,43 +1,44 @@
-export * from './utils.js';
-export * from './Quantity.js';
-export * from './Agent.js';
-export * from './Assumption.js';
-export * from './ConditionState.js';
-export * from './Symbol.js';
-export * from './Feature.js';
-export * from './Edit.js';
-export * from './Version.js';
-export * from './Collation.js';
-export * from './TrackCalibration.js';
-export * from './TrackerBar.js';
+export * from './model/Quantity.js';
+export * from './model/Agent.js';
+export * from './model/Assumption.js';
+export * from './model/ConditionState.js';
+export * from './model/Symbol.js';
+export * from './model/Feature.js';
+export * from './model/Edit.js';
+export * from './model/Version.js';
+export * from './collation/Collation.js';
+export * from './model/TrackCalibration.js';
+export * from './systems/TrackerBar.js';
 export * from './systems/welteT100/bar.js';
 export * from './systems/welteLicensee/bar.js';
 export * from './systems/welteT98/bar.js';
 export * from './systems/index.js';
-export * from './ReproducingSystem.js';
-export * from './FeatureSource.js';
-export * from './Perforator.js';
-export * from './RollCopy.js';
-export * from './procedures.js';
-export * from './vocabulary.js';
-export * from './reservations.js';
-export * from './witnesses.js';
-export * from './alignment.js';
-export * from './statistics.js';
-export * from './Edition.js';
-export * from './EditionView.js';
-export * from './scatter.js';
-export * from './editionOps.js';
-export * from './Emulation.js';
+export * from './systems/ReproducingSystem.js';
+export * from './model/FeatureSource.js';
+export * from './model/Perforator.js';
+export * from './model/RollCopy.js';
+export * from './model/procedures.js';
+export * from './model/vocabulary.js';
+export * from './analysis/reservations.js';
+export * from './analysis/witnesses.js';
+export { alignFeatures, tooShortToShorten } from './collation/alignment.js';
+export * from './collation/statistics.js';
+export * from './model/Edition.js';
+export * from './view/EditionView.js';
+export * from './analysis/ownPaper.js';
+export * from './emulation/negotiation.js';
+export * from './collation/scatter.js';
+export * from './ops/index.js';
+export * from './emulation/Emulation.js';
 export * from './validate.js';
-export * from './constraints.js';
-export * from './substitution.js';
-export * from './context.js';
-export * from './sigla.js';
-export * from './notes.js';
-export * from './asJsonLd.js';
-export * from './importJsonLd.js';
-export * from './migrate.js';
+export * from './analysis/constraints.js';
+export * from './collation/substitution.js';
+export * from './io/context.js';
+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 { 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/{asJsonLd.d.ts → io/asJsonLd.d.ts}

@@ -1,4 +1,4 @@
-import { Edition } from "./Edition.js";
+import { Edition } from "../model/Edition.js";
 /**
  * The keys an export derives from the tree, which no node of the
  * edition states itself. An import reads them off again.

package/lib/{asJsonLd.js → io/asJsonLd.js}

@@ -1,6 +1,7 @@
-import { systemIdIn } from "./TrackerBar.js";
-import { certaintyOf, isAsserted } from "./Assumption.js";
-import context from "./spec/context.json" with { type: 'json' };
+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.
@@ -163,6 +164,7 @@ export const asJsonLd = (edition) => {
             }
         ],
         '@id': edition.base,
+        formatVersion,
         ...rest,
         ...(quoted.length > 0 && { '@included': quoted })
     };

package/lib/{context.d.ts → io/context.d.ts}

@@ -1,12 +1,12 @@
-export { default as jsonLdContext } from './spec/context.json';
+export { default as jsonLdContext } from '../spec/context.json';
 /** The context of the Welte-Mignon T-100, added to a version coded for it. */
-export { default as welteT100JsonLdContext } from './spec/welte-t100.context.json';
+export { default as welteT100JsonLdContext } from '../spec/welte-t100.context.json';
 /**
  * The context of the Welte-Mignon Licensee. Its expression terms are
  * the T-100's, the two systems differing in the tracker scale rather
  * than in the coding, so it reads them out of the T-100's vocabulary
  * rather than minting a second set of IRIs for the same commands.
  */
-export { default as welteLicenseeJsonLdContext } from './spec/welte-licensee.context.json';
+export { default as welteLicenseeJsonLdContext } from '../spec/welte-licensee.context.json';
 /** The context of the Welte-Mignon T-98, added to an edition of a green roll. */
-export { default as welteT98JsonLdContext } from './spec/welte-t98.context.json';
+export { default as welteT98JsonLdContext } from '../spec/welte-t98.context.json';

package/lib/{context.js → io/context.js}

@@ -1,12 +1,12 @@
-export { default as jsonLdContext } from './spec/context.json' with { type: 'json' };
+export { default as jsonLdContext } from '../spec/context.json' with { type: 'json' };
 /** The context of the Welte-Mignon T-100, added to a version coded for it. */
-export { default as welteT100JsonLdContext } from './spec/welte-t100.context.json' with { type: 'json' };
+export { default as welteT100JsonLdContext } from '../spec/welte-t100.context.json' with { type: 'json' };
 /**
  * The context of the Welte-Mignon Licensee. Its expression terms are
  * the T-100's, the two systems differing in the tracker scale rather
  * than in the coding, so it reads them out of the T-100's vocabulary
  * rather than minting a second set of IRIs for the same commands.
  */
-export { default as welteLicenseeJsonLdContext } from './spec/welte-licensee.context.json' with { type: 'json' };
+export { default as welteLicenseeJsonLdContext } from '../spec/welte-licensee.context.json' with { type: 'json' };
 /** The context of the Welte-Mignon T-98, added to an edition of a green roll. */
-export { default as welteT98JsonLdContext } from './spec/welte-t98.context.json' with { type: 'json' };
+export { default as welteT98JsonLdContext } from '../spec/welte-t98.context.json' with { type: 'json' };

package/lib/{importJsonLd.d.ts → io/importJsonLd.d.ts}

@@ -1,4 +1,4 @@
-import { Edition } from "./Edition.js";
+import { Edition } from "../model/Edition.js";
 export declare const importDate: (str: string) => Date;
 type Json = any;
 export declare const importJsonLd: (json: Json) => Edition;

package/lib/io/importJsonLd.js

@@ -0,0 +1,128 @@
+import { derivedKeys } from "./asJsonLd.js";
+import { migrate, plainCopyId } from "./migrate.js";
+import { isDateString } from "../shared/utils.js";
+import schema from "../schema.json" with { type: 'json' };
+export const importDate = (str) => {
+    const [y, m, d] = str.split('-').map(s => parseInt(s, 10));
+    if ([y, m, d].some(n => isNaN(n))) {
+        throw new Error(`Invalid date format: "${str}". Expected "YYYY-MM-DD".`);
+    }
+    return new Date(y, m - 1, d);
+};
+/** The names of the properties the schema holds dates under, wherever they stand in it. */
+const dateKeysIn = (node, keys = new Set()) => {
+    if (Array.isArray(node))
+        node.forEach(item => dateKeysIn(item, keys));
+    else if (node !== null && typeof node === 'object') {
+        Object.entries(node).forEach(([key, value]) => {
+            if (key === 'properties' && value !== null && typeof value === 'object') {
+                Object.entries(value)
+                    .filter(([, property]) => property?.format === 'date')
+                    .forEach(([name]) => keys.add(name));
+            }
+            dateKeysIn(value, keys);
+        });
+    }
+    return keys;
+};
+/**
+ * The keys a date is read under. Only these: a string elsewhere that
+ * happens to read like a date, such as the transcription of a dated
+ * label, is text and stays text.
+ */
+const dateKeys = dateKeysIn(schema);
+/** A value as the edition holds it under the key: a date read, an entity converted, anything else as it stands. */
+const fromJsonLdValue = (key, value) => {
+    if (typeof value === 'string')
+        return dateKeys.has(key) && isDateString(value) ? importDate(value) : value;
+    if (Array.isArray(value))
+        return value.map(item => fromJsonLdValue(key, item));
+    if (value !== null && typeof value === 'object')
+        return fromJsonLdEntity(value);
+    return value;
+};
+/** A node without what the export derived from it: what an act changed follows from where the act stands. */
+const asStated = (json) => Object.keys(json).some(key => derivedKeys.has(key))
+    ? Object.fromEntries(Object.entries(json).filter(([key]) => !derivedKeys.has(key)))
+    : json;
+/**
+ * An entity with its keywords read as plain keys. The input is left as
+ * it is. The `@type` of a value object names the datatype of the value,
+ * not a class, and is dropped. So is a context: a version carries one
+ * naming its system's vocabulary, and it belongs to the serialisation
+ * rather than to the edition, which states the system as data.
+ */
+const fromJsonLdEntity = (json) => {
+    const { '@type': type, '@id': id, '@context': context, ...rest } = asStated(json);
+    const entity = Object.fromEntries(Object.entries(rest).map(([key, value]) => [key, fromJsonLdValue(key, value)]));
+    if (type !== undefined && !('@value' in json))
+        entity.type = type;
+    if (id !== undefined)
+        entity.id = id;
+    return entity;
+};
+// Every entity is named by its id alone. Documents written before that was so
+// prefixed a copy's with `copy/`, and are read here as though they had not.
+const withPlainCopyIds = (json) => ({
+    ...json,
+    copies: (json.copies ?? []).map((copy) => ({
+        ...copy,
+        '@id': typeof copy['@id'] === 'string' ? plainCopyId(copy['@id']) : copy['@id']
+    }))
+});
+/** A statement an export quoted rather than stated: an included node whose id is a triple. */
+const isQuotedStatement = (node) => node !== null && typeof node === 'object' && node['@id'] !== null && typeof node['@id'] === 'object';
+/** The reference a quoted statement made, annotated again with the belief the export set beside it. */
+const referenceOf = (statement) => {
+    const { '@id': { '@id': subject, ...made }, annotation, ...about } = statement;
+    const [key, value] = Object.entries(made)[0];
+    const listed = Array.isArray(value);
+    return {
+        subject,
+        key,
+        listed,
+        reference: {
+            ...(listed ? value[0] : value),
+            '@annotation': { ...(annotation !== undefined && { '@id': annotation }), ...about }
+        }
+    };
+};
+/** Whether the object states anything beside its id, which a reference to a node does not. */
+const isNode = (value) => typeof value['@id'] === 'string' && Object.keys(value).some(key => key !== '@id' && key !== '@annotation');
+/** The document with each quoted reference back on the node that makes it. */
+const withReferencesOn = (value, bySubject) => {
+    if (Array.isArray(value))
+        return value.map(item => withReferencesOn(item, bySubject));
+    if (!value || typeof value !== 'object')
+        return value;
+    const walked = Object.fromEntries(Object.entries(value).map(([key, child]) => [key, withReferencesOn(child, bySubject)]));
+    const references = isNode(value)
+        ? bySubject.get(value['@id']) ?? []
+        : [];
+    return references.reduce((node, { key, listed, reference }) => ({ ...node, [key]: listed ? [...(node[key] ?? []), reference] : reference }), walked);
+};
+/**
+ * Puts back what an export quoted. A reference the edition doubts goes
+ * out as a JSON-LD-star embedded node beside the document, so that RDF
+ * does not state it; in the edition it belongs on the node that makes
+ * it, under its belief. In a list it comes back after the references
+ * that were stated.
+ */
+const withQuotedStatementsInPlace = (edition) => {
+    const included = Array.isArray(edition['@included']) ? edition['@included'] : [];
+    const statements = included.filter(isQuotedStatement);
+    if (statements.length === 0)
+        return edition;
+    const others = included.filter(node => !isQuotedStatement(node));
+    const { '@included': _quoted, ...rest } = edition;
+    const bySubject = Map.groupBy(statements.map(referenceOf), ({ subject }) => subject);
+    return withReferencesOn({ ...rest, ...(others.length > 0 && { '@included': others }) }, bySubject);
+};
+export const importJsonLd = (json) => {
+    const { '@context': context, formatVersion: _revision, ...document } = withPlainCopyIds(migrate(withQuotedStatementsInPlace(json)));
+    const edition = fromJsonLdEntity(document);
+    edition.base = Array.isArray(context)
+        ? context.find((c) => c['@base'])?.['@base'] || ''
+        : '';
+    return edition;
+};

package/lib/{migrate.d.ts → io/migrate.d.ts}

@@ -13,5 +13,14 @@
 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/{migrate.js → io/migrate.js}

@@ -1,11 +1,24 @@
-import { conditions, isFeatureType, media, techniques } from "./Feature.js";
-import { rollConditions } from "./RollCopy.js";
-import { systemIdIn, systemOf, translationBetween } from "./TrackerBar.js";
-import { trackerBars } from "./systems/index.js";
-import { welteT100 } from "./systems/welteT100/bar.js";
-import { isDateString } from "./utils.js";
+import { systemIdIn, systemOf, translationBetween } from "../systems/TrackerBar.js";
+import { trackerBars } from "../systems/index.js";
+import { welteT100 } from "../systems/welteT100/bar.js";
+import { isDateString } from "../shared/utils.js";
 const retiredVersionTypes = new Set(['edition', 'unicum']);
-const conditionTypeValues = new Set([...rollConditions, ...Object.values(conditions).flat()]);
+/**
+ * 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
+ * asked, being the layout of instruments rather than a choice of the
+ * format.
+ */
+const conditionTypeValues = new Set([
+    'general', 'paper-stretch',
+    'partially-torn', 'missing-perforation', 'illegible', 'faded', 'detaching', 'ripped'
+]);
+const techniques = ['print', 'handwriting', 'stamp'];
+const media = ['ink', 'pencil', 'crayon'];
+const featureTypes = ['HoleChain', 'Writing', 'Mark', 'Patch'];
+const isFeatureType = (value) => typeof value === 'string' && featureTypes.includes(value);
 const renamedKeys = {
     productionEvent: 'production',
     annotates: 'depiction',
@@ -128,6 +141,38 @@ const withScale = (node) => {
     const factor = (node.conditions ?? []).find(isPaperStretch)?.factor;
     return factor === undefined ? node : { ...node, measurements: { ...node.measurements, scale: factor } };
 };
+/**
+ * What each entry of a copy's former `ops` list stands for among its
+ * measurements, and the value that does nothing where the list claimed
+ * an act whose amount was never recorded.
+ */
+const opsInMeasurements = [
+    ['shifted', 'shift', { horizontal: 0, vertical: 0 }],
+    ['stretched', 'scale', 1],
+    ['shortened', 'readerExtension', { length: 0 }]
+];
+/**
+ * A copy listed what had been done to line its features up, which said
+ * again what its measurements state; the measurements now say it alone.
+ * Where the two disagreed, the list is what the alignment went by, so
+ * the measurements are made to say what it said: a measurement it does
+ * not list is dropped, and an act it lists without a recorded amount is
+ * recorded as one that moved nothing. `withScale` has read the list by
+ * the time this runs.
+ */
+const withoutOps = (node) => {
+    if (!Array.isArray(node.ops))
+        return node;
+    const { ops, ...rest } = node;
+    const measurements = { ...rest.measurements };
+    opsInMeasurements.forEach(([op, key, nothing]) => {
+        if (!ops.includes(op))
+            delete measurements[key];
+        else if (measurements[key] === undefined)
+            measurements[key] = nothing;
+    });
+    return { ...rest, measurements };
+};
 /** A copy's id without the `copy/` that documents of earlier releases put before it. */
 export const plainCopyId = (id) => id.replace(/^copy\//, '');
 /**
@@ -327,7 +372,7 @@ const withTimeSpanDates = (node) => {
     return { ...rest, within };
 };
 const migrateNode = (node) => [withRenamedKeys, withTypology, withRenamedType, withoutVersionType, withoutVersionSiglum, withLowerCaseTerms, withSplitMethod, withReferences, withKeeper, withoutEmptyKeeper,
-    withPerforator, withProductionNodes, withTypedPerforator, withScale, withDerivationList, withReadingKind, withTimeSpanDates,
+    withPerforator, withProductionNodes, withTypedPerforator, withScale, withoutOps, withDerivationList, withReadingKind, withTimeSpanDates,
     withoutFeatureKind, withBorneFeaturesNamed, withFeaturesInActs, withDriveOfStaggering, withoutPattern, withoutBearings, withoutEntailedType]
     .reduce((result, step) => step(result), node);
 /** The items each walked, or the very same list where the walk changed none. */
@@ -466,53 +511,27 @@ const withDerivationTolerance = (edition) => {
             : version)
     };
 };
-/** A statement an export quoted rather than stated: an included node whose id is a triple. */
-const isQuotedStatement = (node) => node !== null && typeof node === 'object' && node['@id'] !== null && typeof node['@id'] === 'object';
-/** The reference a quoted statement made, annotated again with the belief the export set beside it. */
-const referenceOf = (statement) => {
-    const { '@id': { '@id': subject, ...made }, annotation, ...about } = statement;
-    const [key, value] = Object.entries(made)[0];
-    const listed = Array.isArray(value);
-    return {
-        subject,
-        key,
-        listed,
-        reference: {
-            ...(listed ? value[0] : value),
-            '@annotation': { ...(annotation !== undefined && { '@id': annotation }), ...about }
-        }
-    };
-};
-/** Whether the object states anything beside its id, which a reference to a node does not. */
-const isNode = (value) => typeof value['@id'] === 'string' && Object.keys(value).some(key => key !== '@id' && key !== '@annotation');
-/** The document with each quoted reference back on the node that makes it. */
-const withReferencesOn = (value, bySubject) => {
-    if (Array.isArray(value))
-        return value.map(item => withReferencesOn(item, bySubject));
-    if (!value || typeof value !== 'object')
-        return value;
-    const walked = Object.fromEntries(Object.entries(value).map(([key, child]) => [key, withReferencesOn(child, bySubject)]));
-    const references = isNode(value)
-        ? bySubject.get(value['@id']) ?? []
-        : [];
-    return references.reduce((node, { key, listed, reference }) => ({ ...node, [key]: listed ? [...(node[key] ?? []), reference] : reference }), walked);
-};
+const editionSteps = [withoutEditionType, withSystems, withEditors, withDerivationTolerance];
 /**
- * Puts back what an export quoted. A reference the edition doubts goes
- * out as a JSON-LD-star embedded node beside the document, so that RDF
- * does not state it; in the edition it belongs on the node that makes
- * it, under its belief. In a list it comes back after the references
- * that were stated.
+ * 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.
  */
-const withQuotedStatementsInPlace = (edition) => {
-    const included = Array.isArray(edition['@included']) ? edition['@included'] : [];
-    const statements = included.filter(isQuotedStatement);
-    if (statements.length === 0)
+export const formatVersion = 1;
+export const migrate = (edition) => {
+    const stated = edition?.formatVersion;
+    if (stated === formatVersion)
         return edition;
-    const others = included.filter(node => !isQuotedStatement(node));
-    const { '@included': _quoted, ...rest } = edition;
-    const bySubject = Map.groupBy(statements.map(referenceOf), ({ subject }) => subject);
-    return withReferencesOn({ ...rest, ...(others.length > 0 && { '@included': others }) }, bySubject);
+    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 editionSteps = [withoutEditionType, withQuotedStatementsInPlace, withSystems, withEditors, withDerivationTolerance];
-export const migrate = (edition) => walk(editionSteps.reduce((result, step) => step(result), edition));

package/lib/{Agent.d.ts → model/Agent.d.ts}

@@ -1,4 +1,4 @@
-import { WithId } from "./utils.js";
+import { WithId } from "../shared/utils.js";
 /**
  * Something with a name and, where one exists, an authority record.
  */

package/lib/{Assumption.d.ts → model/Assumption.d.ts}

@@ -1,4 +1,4 @@
-import { WithNote, WithId } from "./utils.js";
+import { WithNote, WithId } from "../shared/utils.js";
 import { Person, WithActor } from "./Agent.js";
 export declare const certainties: readonly ['true', 'likely', 'possible', 'unlikely', 'false'];
 /**

package/lib/{Edit.d.ts → model/Edit.d.ts}

@@ -1,6 +1,6 @@
 import { Assumption } from "./Assumption.js";
 import { AnySymbol } from "./Symbol.js";
-import { WithId } from "./utils.js";
+import { WithId } from "../shared/utils.js";
 export declare const editTypes: readonly [
 /**
  * An additional accent that can only be encoded with

package/lib/{Edition.d.ts → model/Edition.d.ts}

@@ -1,9 +1,9 @@
 import { RollCopy } from "./RollCopy.js";
 import { Version } from "./Version.js";
-import { CollationTolerance } from "./Collation.js";
+import { CollationTolerance } from "../collation/Collation.js";
 import { DateAssignment, ObjectAssumption } from "./Assumption.js";
 import { Editor, Person, Place } from "./Agent.js";
-import { RollTempo } from "./ReproducingSystem.js";
+import { RollTempo } from "../systems/ReproducingSystem.js";
 /**
  * This type describes the creation of an edition,
  * i.e. the editor, publisher, and publication date.

package/lib/{Feature.d.ts → model/Feature.d.ts}

@@ -1,7 +1,7 @@
 import { ObjectAssumption } from "./Assumption.js";
 import { ConditionState } from "./ConditionState.js";
 import { Text } from "./Symbol.js";
-import { PartialBy, WithId, WithType } from "./utils.js";
+import { PartialBy, WithId, WithType } from "../shared/utils.js";
 import { Measure, Millimeters, Track } from "./Quantity.js";
 /**
  * Describes the horizontal extent of a feature on the roll,

package/lib/{FeatureSource.d.ts → model/FeatureSource.d.ts}

@@ -1,7 +1,7 @@
 import { ActorAssignment, DateAssignment, ObjectAssumption } from "./Assumption.js";
 import { Concept, Named } from "./Agent.js";
 import { ConditionState } from "./ConditionState.js";
-import { WithNote } from "./utils.js";
+import { WithNote } from "../shared/utils.js";
 /**
  * What a copy's features were read from. The kinds run from the paper
  * itself, through files in which the roll has already been read into

package/lib/{Perforator.d.ts → model/Perforator.d.ts}

@@ -1,7 +1,7 @@
 import { ObjectAssumption } from "./Assumption.js";
 import { ConditionState } from "./ConditionState.js";
 import { Measure, Millimeters } from "./Quantity.js";
-import { WithId, WithType } from "./utils.js";
+import { WithId, WithType } from "../shared/utils.js";
 /**
  * The pitch in the engineering sense: the distance along the roll from
  * one punch of a chain to the next, which is the slot one firing cut