linked-rolls 0.0.1 → 0.1.1

package/package.json

@@ -1,25 +1,58 @@
 {
   "name": "linked-rolls",
-  "version": "0.0.1",
+  "version": "0.1.1",
+  "description": "Digital editions of piano rolls: import, collation, editorial assumptions, JSON-LD export, and emulation through a reproducing system",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pfefferniels/linked-rolls.git"
+  },
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "files": ["lib", "README.md", "LICENSE"],
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./welte-t100": {
+      "types": "./lib/systems/welteT100.d.ts",
+      "default": "./lib/systems/welteT100.js"
+    },
+    "./lib/*": "./lib/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "build": "tsc",
+    "build": "npm run build:schema && rm -rf lib && tsc",
+    "prepublishOnly": "npm run build && vitest run",
     "test": "vitest",
-    "compile:schema": "tsc build-schema.ts --outDir lib --esModuleInterop --skipLibCheck && mv lib/build-schema.js lib/build-schema.cjs",
-    "build:schema": "npm run compile:schema && node lib/build-schema.cjs"
+    "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"
   },
   "devDependencies": {
+    "@types/node": "^24.13.3",
     "typescript": "^5.6.0-dev.20240809",
-    "vite": "^5.0.8",
-    "vitest": "^1.2.0"
+    "vite": "^5.4.20",
+    "vitest": "^1.2.0",
+    "welte-t100-emulator": "file:../roll-nuance-tracer/emulator"
+  },
+  "peerDependencies": {
+    "welte-t100-emulator": "*"
+  },
+  "peerDependenciesMeta": {
+    "welte-t100-emulator": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@types/uuid": "^10.0.0",
+    "ajv": "^8.17.1",
     "aton": "^0.0.4",
-    "fast-xml-parser": "^4.4.1",
+    "fast-xml-parser": "^4.5.4",
+    "immer": "^10.1.3",
     "midifile-ts": "^1.5.1",
     "ts-json-schema-generator": "^2.4.0",
     "uuid": "^10.0.0"

package/lib/Condition.d.ts

@@ -1,10 +0,0 @@
-import { WithId } from "./WithId";
-/**
- * Describes the physical condition of a roll or
- * of a feature on the roll (e.g. a damaged
- * or unsuccessful perforation).
- */
-export interface ConditionState<T extends string> extends WithId {
-    type: T;
-    description?: string;
-}

package/lib/EditorialAssumption.d.ts

@@ -1,67 +0,0 @@
-import { WithId } from "./WithId";
-import { Person } from "./Edition";
-export declare const certainties: readonly ["true", "likely", "possible", "unlikely", "false"];
-export type Certainty = typeof certainties[number];
-export type WithActor = {
-    actor?: Person;
-};
-export type WithNote = {
-    note?: string;
-};
-export interface Argumentation<T extends string = 'simpleArgumentation'> extends WithActor, WithNote {
-    type: T;
-}
-export interface MeaningComprehension<T> extends Argumentation<'meaningComprehension'> {
-    comprehends: T[];
-}
-export interface Inference extends Argumentation<'inference'> {
-    premises: Belief[];
-}
-export interface BeliefAdoption extends Argumentation<'beliefAdoption'> {
-    note: string;
-}
-export type AnyArgumentation = MeaningComprehension<any> | Inference | BeliefAdoption | Argumentation;
-export declare function isMeaningComprehension<AboutT>(object: AnyArgumentation, aboutGuard: (x: any) => x is AboutT): object is MeaningComprehension<AboutT>;
-export interface Belief extends WithId {
-    type: 'belief';
-    certainty: Certainty;
-    reasons: AnyArgumentation[];
-}
-/**
- * An editorial assumpton is always a One-Proposition Set.
- */
-export interface EditorialAssumption<Name, AssignedType> extends WithId {
-    type: Name;
-    assigned: AssignedType;
-    belief?: Belief;
-}
-export declare function flat<Name, Type>(assumption: EditorialAssumption<Name, Type>): Type;
-export declare function flat<Name, Type>(assumption: EditorialAssumption<Name, Type>[]): Type[];
-export declare function assign<Type extends string, T>(type: Type, object: T): EditorialAssumption<Type, T>;
-export type DimensionMarker = {
-    point: 'start' | 'end';
-    of: Symbol;
-};
-type PlacementType = 'after' | 'before' | 'with';
-export interface Constraint {
-    placed: DimensionMarker;
-    placement: PlacementType;
-    relativeTo: DimensionMarker | {
-        number: number;
-        unit: string;
-    };
-}
-export interface Motivation<MotivationT> extends EditorialAssumption<'motivationAssignment', MotivationT> {
-}
-export declare const isMotivation: (object: any) => object is Motivation<any>;
-export interface QuestionMaking extends WithActor {
-    premises: (Belief | Question)[];
-    raise: Question;
-}
-/**
- * Modelled on IAM's Question, cf. M. Doerr et al., p. 12
- */
-export interface Question {
-    question: string;
-}
-export {};

package/lib/EditorialAssumption.js

@@ -1,26 +0,0 @@
-import { v4 } from "uuid";
-export const certainties = [
-    'true',
-    'likely',
-    'possible',
-    'unlikely',
-    'false'
-];
-export function isMeaningComprehension(object, aboutGuard) {
-    return object.type === 'meaningComprehension' && object.comprehends.every(aboutGuard);
-}
-export function flat(assumption) {
-    return Array.isArray(assumption)
-        ? assumption.map(a => a.assigned)
-        : assumption.assigned;
-}
-export function assign(type, object) {
-    return {
-        type,
-        id: v4(),
-        assigned: object
-    };
-}
-export const isMotivation = (object) => {
-    return 'type' in object && object.type === 'motivationAssignment';
-};

package/lib/Measurement.d.ts

@@ -1,9 +0,0 @@
-import { WithId } from "./WithId";
-/**
- * Based on D11 Digital Measurement Event and D10 Software Execution
- */
-export interface RollMeasurement extends WithId {
-    actor?: string;
-    software: string;
-    date: string;
-}

package/lib/PlaceTimeConversion.d.ts

@@ -1,65 +0,0 @@
-export declare abstract class PlaceTimeConversion {
-    abstract get summary(): string;
-    abstract placeToTime(x1: number): number;
-    abstract timeToPlace(t1: number): number;
-}
-export declare class NoAccelerationConversion implements PlaceTimeConversion {
-    get summary(): string;
-    metersPerMinute: number;
-    /**
-     * Converts physical place (in cm) to time (in seconds).
-     * @param x1 - The distance in mm.
-     * @returns Time in seconds.
-     */
-    placeToTime(cm: number): number;
-    /**
-     * Converts time (in seconds) to physical place (in cm).
-     * @param t1 - The time in seconds.
-     * @returns Distance in cm.
-     */
-    timeToPlace(t1: number): number;
-}
-declare enum SpeedUnit {
-    MetersPerMinute = 0,
-    FeetPerMinute = 1
-}
-declare enum AccelerationUnit {
-    MillimetersPerSecondSquared = 0,
-    FeetPerMinuteSquared = 1
-}
-export declare class KinematicConversion implements PlaceTimeConversion {
-    get summary(): string;
-    static readonly slowSpeed = 9.46;
-    static readonly normalSpeed = 9.85;
-    static readonly stanfordAcceleration = 0.3147;
-    static readonly baertschAcceleration = 0.1772;
-    private feetPerMinute;
-    private acceleration;
-    constructor(feetPerMinute?: number, acceleration?: number);
-    setSpeed(speed: number, unit: SpeedUnit): void;
-    setAcceleration(acceleration: number, unit: AccelerationUnit): void;
-    /**
-     * Converts physical place (in cm) to time (in seconds).
-     * @param x1 - The distance in mm.
-     * @returns Time in seconds.
-     */
-    placeToTime(cm: number): number;
-    /**
-     * Converts time (in seconds) to physical place (in cm).
-     * @param t1 - The time in seconds.
-     * @returns Distance in cm.
-     */
-    timeToPlace(t1: number): number;
-}
-export declare class GottschewskiConversion implements PlaceTimeConversion {
-    get summary(): string;
-    paperThickness: number;
-    initialCircumference: number;
-    secondsPerTurn: number;
-    /**
-     * @param x1 in centimeters
-     */
-    placeToTime(x1: number): number;
-    timeToPlace(t1: number): number;
-}
-export {};

package/lib/PlaceTimeConversion.js

@@ -1,175 +0,0 @@
-export class PlaceTimeConversion {
-}
-export class NoAccelerationConversion {
-    constructor() {
-        Object.defineProperty(this, "metersPerMinute", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 3
-        }); // according to most sources
-    }
-    get summary() {
-        return `no aceleration (${this.metersPerMinute} m/min)`;
-    }
-    /**
-     * Converts physical place (in cm) to time (in seconds).
-     * @param x1 - The distance in mm.
-     * @returns Time in seconds.
-     */
-    placeToTime(cm) {
-        const meters = cm / 100; // convert to m
-        const t = meters / this.metersPerMinute;
-        return t * 60;
-    }
-    /**
-     * Converts time (in seconds) to physical place (in cm).
-     * @param t1 - The time in seconds.
-     * @returns Distance in cm.
-     */
-    timeToPlace(t1) {
-        return (this.metersPerMinute * (t1 / 60)) * 100;
-    }
-}
-var SpeedUnit;
-(function (SpeedUnit) {
-    SpeedUnit[SpeedUnit["MetersPerMinute"] = 0] = "MetersPerMinute";
-    SpeedUnit[SpeedUnit["FeetPerMinute"] = 1] = "FeetPerMinute";
-})(SpeedUnit || (SpeedUnit = {}));
-var AccelerationUnit;
-(function (AccelerationUnit) {
-    AccelerationUnit[AccelerationUnit["MillimetersPerSecondSquared"] = 0] = "MillimetersPerSecondSquared";
-    AccelerationUnit[AccelerationUnit["FeetPerMinuteSquared"] = 1] = "FeetPerMinuteSquared";
-})(AccelerationUnit || (AccelerationUnit = {}));
-export class KinematicConversion {
-    get summary() {
-        return `kinematic (acceleration: ${this.acceleration} ft/s², speed: ${this.feetPerMinute} ft/min)`;
-    }
-    constructor(feetPerMinute = KinematicConversion.normalSpeed, acceleration = KinematicConversion.baertschAcceleration) {
-        Object.defineProperty(this, "feetPerMinute", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "acceleration", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.feetPerMinute = feetPerMinute;
-        this.acceleration = acceleration;
-    }
-    setSpeed(speed, unit) {
-        if (unit === SpeedUnit.FeetPerMinute) {
-            this.feetPerMinute = speed;
-        }
-        else if (unit === SpeedUnit.MetersPerMinute) {
-            this.feetPerMinute = speed * 3.2808399;
-        }
-        else {
-            throw new Error('Unsupported unit');
-        }
-    }
-    setAcceleration(acceleration, unit) {
-        if (unit === AccelerationUnit.FeetPerMinuteSquared) {
-            this.acceleration = acceleration;
-        }
-        else if (unit === AccelerationUnit.MillimetersPerSecondSquared) {
-            this.acceleration = acceleration * 0.0032808399 * 3600;
-        }
-        else {
-            throw new Error('Unsupported unit');
-        }
-    }
-    /**
-     * Converts physical place (in cm) to time (in seconds).
-     * @param x1 - The distance in mm.
-     * @returns Time in seconds.
-     */
-    placeToTime(cm) {
-        const x1 = cm / 30.48;
-        const v = this.feetPerMinute;
-        const a = this.acceleration;
-        const t = (Math.sqrt(2 * a * x1 + Math.pow(v, 2)) - v) / a;
-        return t * 60;
-    }
-    /**
-     * Converts time (in seconds) to physical place (in cm).
-     * @param t1 - The time in seconds.
-     * @returns Distance in cm.
-     */
-    timeToPlace(t1) {
-        // Convert seconds -> minutes
-        const T = t1 / 60;
-        const xFeet = this.feetPerMinute * T + 0.5 * this.acceleration * Math.pow(T, 2);
-        // Convert feet -> millimeters
-        const xMM = xFeet * 304.8;
-        return xMM / 10;
-    }
-}
-Object.defineProperty(KinematicConversion, "slowSpeed", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: 9.46
-});
-Object.defineProperty(KinematicConversion, "normalSpeed", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: 9.85
-});
-Object.defineProperty(KinematicConversion, "stanfordAcceleration", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: 0.3147
-}); // cf. https://github.com/pianoroll/midi2exp/commit/6a29060
-Object.defineProperty(KinematicConversion, "baertschAcceleration", {
-    enumerable: true,
-    configurable: true,
-    writable: true,
-    value: 0.1772
-}); // = 0.015 mm/s^2, cf. Baertsch p. 33
-export class GottschewskiConversion {
-    constructor() {
-        Object.defineProperty(this, "paperThickness", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 0.0075
-        });
-        Object.defineProperty(this, "initialCircumference", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 22.25
-        });
-        Object.defineProperty(this, "secondsPerTurn", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4.64
-        }); // is that correct? Philips says 120 RPM (p. 113)
-    }
-    get summary() {
-        return `Gottschewski (assuming paper thickness: ${this.paperThickness}, initial circumference: ${this.initialCircumference}, seconds per turn: ${this.secondsPerTurn})`;
-    }
-    /**
-     * @param x1 in centimeters
-     */
-    placeToTime(x1) {
-        const Q0 = Math.pow(this.initialCircumference, 2) / (4 * Math.PI);
-        const v0 = this.initialCircumference / this.secondsPerTurn;
-        const d = Q0 / this.paperThickness;
-        return Math.pow(d, 0.5) * (1 / v0) * 2 * (Math.pow(d + x1, 0.5) - Math.pow(d, 0.5));
-    }
-    timeToPlace(t1) {
-        const Q0 = Math.pow(this.initialCircumference, 2) / (4 * Math.PI);
-        const v0 = this.initialCircumference / this.secondsPerTurn;
-        const d = Q0 / this.paperThickness;
-        return Math.pow((t1 * v0) / (2 * Math.pow(d, 0.5)) + Math.pow(d, 0.5), 2) - d;
-    }
-}

package/lib/RollEvent.d.ts

@@ -1,76 +0,0 @@
-import { RollMeasurement } from "./Measurement";
-import { WithId } from "./WithId";
-export interface HorizontalSpan {
-    unit: 'mm';
-    from: number;
-    to: number;
-}
-export interface VerticalSpan {
-    unit: 'track';
-    from: number;
-    to?: number;
-}
-export interface RollFeature<T> extends WithId {
-    type: T;
-    /**
-     * IIIF region in string form.
-     */
-    annotates?: string;
-    horizontal: HorizontalSpan;
-    vertical: VerticalSpan;
-    /**
-     * Describes whether the event takes place
-     * on the verso or recto side of the roll.
-     * Since the same perforation is present on both
-     * sides, this property is left optional for now.
-     */
-    side?: 'verso' | 'recto';
-    measurement: RollMeasurement;
-}
-export interface Note extends RollFeature<'note'> {
-    pitch: number;
-}
-export type ExpressionScope = 'bass' | 'treble';
-export type ExpressionType = 'SustainPedalOn' | 'SustainPedalOff' | 'SoftPedalOn' | 'SoftPedalOff' | 'MezzoforteOff' | 'MezzoforteOn' | 'SlowCrescendoOn' | 'SlowCrescendoOff' | 'ForzandoOn' | 'ForzandoOff' | 'MotorOff' | 'MotorOn' | 'Rewind' | 'ElectricCutOff';
-export interface Expression extends RollFeature<'expression'> {
-    scope: ExpressionScope;
-    expressionType: ExpressionType;
-}
-export declare const isRollEvent: (e: any) => e is AnyRollEvent;
-export interface Perforation extends RollFeature<'perforation'> {
-    accelerating?: boolean;
-}
-/**
- * This denotes perforations that are covered by an editor.
- * The covered perforation is not considered to be part
- * of the original note or expression hole anymore.
- */
-export interface Cover extends RollFeature<'cover'> {
-    /**
-     * This property can be used to indicate e.g. the
-     * color or material of the cover.
-     */
-    note?: string;
-}
-/**
- * For handwritten insertions like e. g. the
- * perforation date in the end of a roll.
- */
-export interface HandwrittenText extends RollFeature<'handwrittenText'> {
-    text: string;
-    rotation?: number;
-}
-/**
- * This type can be used to indicate stamps like e. g. the
- * "controlliert" stamp in the beginning of rolls or the
- * date at the end of (later) Welte rolls.
- */
-export interface Stamp extends RollFeature<'stamp'> {
-    text: string;
-    rotation?: number;
-}
-export interface RollLabel extends RollFeature<'rollLabel'> {
-    text: string;
-    signed: boolean;
-}
-export type AnyRollEvent = Note | Expression | HandwrittenText | Stamp | Cover | RollLabel;

package/lib/RollEvent.js

@@ -1,3 +0,0 @@
-export const isRollEvent = (e) => {
-    return 'horizontal' in e && 'vertical' in e;
-};

package/lib/Stage.d.ts

@@ -1,37 +0,0 @@
-import { ActorAssignment, Edit } from "./Edit";
-import { EditorialAssumption, Motivation } from "./EditorialAssumption";
-import { AnySymbol } from "./Symbol";
-export interface Derivation extends EditorialAssumption<'derivation', Stage> {
-}
-declare const versionType: readonly ["edition", "authorised-revision", "unauthorised-revision", "gloss"];
-export type VersionType = typeof versionType[number];
-/**
- * Stage + Stage Creation
- */
-export interface Stage {
-    id: string;
-    siglum: string;
-    actor?: ActorAssignment;
-    basedOn?: Derivation;
-    edits: Edit[];
-    motivations: Motivation<string>[];
-    type: VersionType;
-}
-export declare const traverseStages: (stage: Stage, callback: (stage: Stage) => void) => void;
-export declare const getSnapshot: (stage: Stage) => AnySymbol[];
-/**
- * Walks through the stages. If it finds a symbol that is still
- * part of the tradition (i.e. it is included in the current snapshot)
- * and is equivalent with the given symbol, it will add the feature
- * carrying the symbol to the collated symbol. Otherwise, the
- * given symbol will be added to the current stage's insertions.
- *
- * All symbols of the tradition that are not included in the given
- * symbols are considered to be deleted.
- *
- * @param creation
- * @param symbols
- * @returns
- */
-export declare function fillEdits(currentStage: Stage, symbols: AnySymbol[]): void;
-export {};