Skip to content

feat!: migrate to document-schema.js 4.0.0 (formatVersion retired, depth-only list memberships) #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mearman merged 1 commit into from
Aug 18, 2026
Merged

feat!: migrate to document-schema.js 4.0.0 (formatVersion retired, depth-only list memberships) #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Every construct `src/lower`/`src/emit` cannot represent losslessly is a document
- **`md/heading-level-clamped`** — styleId beyond `Heading6` (from another format) clamps to level 6 via document-schema.js's shared `clampHeadingLevel()`.
- **`md/adjacent-links-merged`** / **`md/code-span-as-monospace-run`** — same-destination adjacent links merge; monospace runs emit as code spans.
- **`md/paragraph-indent-dropped`** — `indentLeftPt` without a recognised styleId; indent dropped, paragraph renders.
- **`md/list-numid-fallback`** — a foreign `numId` falls back to a plain bullet list.
- **`md/list-numid-fallback`** — a foreign or absent `numId` (depth-only `ContentListMembership`) falls back to a plain bullet list.
- **`md/table-cell-formatting-dropped`** / **`md/table-cell-multi-paragraph-joined`** — GFM cells have no rich-formatting or multi-paragraph representation.

## Fidelity
Expand Down
276 changes: 252 additions & 24 deletions dist/codec.d.cts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,6 @@ import { z } from "zod";
//#region src/codec.d.ts
declare const MarkdownBytesSchema: z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, z.ZodDiscriminatedUnion<[z.ZodObject<{
kind: z.ZodLiteral<"wordprocessing">;
formatVersion: z.ZodLiteral<3>;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
subject: z.ZodOptional<z.ZodString>;
keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
creator: z.ZodOptional<z.ZodString>;
producer: z.ZodOptional<z.ZodString>;
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
sections: z.ZodArray<z.ZodObject<{
pageSize: z.ZodObject<{
widthPt: z.ZodNumber;
Expand All @@ -27,9 +15,50 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
}, z.core.$strip>;
blocks: z.ZodArray<z.ZodCustom<import("document-schema.js").ContentBlock, import("document-schema.js").ContentBlock>>;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodObject<{
kind: z.ZodLiteral<"presentation">;
formatVersion: z.ZodLiteral<3>;
symbolTable: z.ZodOptional<z.ZodObject<{
symbols: z.ZodArray<z.ZodObject<{
glyph: z.ZodString;
scope: z.ZodString;
id: z.ZodString;
quantityKind: z.ZodOptional<z.ZodString>;
preferredUnit: z.ZodOptional<z.ZodString>;
definitionSource: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
units: z.ZodArray<z.ZodObject<{
id: z.ZodString;
symbol: z.ZodString;
name: z.ZodOptional<z.ZodString>;
dimension: z.ZodRecord<z.ZodEnum<{
time: "time";
length: "length";
mass: "mass";
electricCurrent: "electricCurrent";
thermodynamicTemperature: "thermodynamicTemperature";
amountOfSubstance: "amountOfSubstance";
luminousIntensity: "luminousIntensity";
}> & z.core.$partial, z.ZodNumber>;
factorToSi: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
offsetToSi: z.ZodOptional<z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>>;
context: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
contexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
bases: z.ZodArray<z.ZodObject<{
unit: z.ZodString;
value: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
kind: z.ZodLiteral<"wordprocessing">;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
Expand All @@ -40,6 +69,7 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
}, z.core.$strip>, z.ZodObject<{
slides: z.ZodArray<z.ZodObject<{
size: z.ZodObject<{
widthPt: z.ZodNumber;
Expand Down Expand Up @@ -73,9 +103,50 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
}, z.core.$strip>>;
notes: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodObject<{
kind: z.ZodLiteral<"spreadsheet">;
formatVersion: z.ZodLiteral<3>;
symbolTable: z.ZodOptional<z.ZodObject<{
symbols: z.ZodArray<z.ZodObject<{
glyph: z.ZodString;
scope: z.ZodString;
id: z.ZodString;
quantityKind: z.ZodOptional<z.ZodString>;
preferredUnit: z.ZodOptional<z.ZodString>;
definitionSource: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
units: z.ZodArray<z.ZodObject<{
id: z.ZodString;
symbol: z.ZodString;
name: z.ZodOptional<z.ZodString>;
dimension: z.ZodRecord<z.ZodEnum<{
time: "time";
length: "length";
mass: "mass";
electricCurrent: "electricCurrent";
thermodynamicTemperature: "thermodynamicTemperature";
amountOfSubstance: "amountOfSubstance";
luminousIntensity: "luminousIntensity";
}> & z.core.$partial, z.ZodNumber>;
factorToSi: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
offsetToSi: z.ZodOptional<z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>>;
context: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
contexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
bases: z.ZodArray<z.ZodObject<{
unit: z.ZodString;
value: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
kind: z.ZodLiteral<"presentation">;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
Expand All @@ -86,6 +157,7 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
}, z.core.$strip>, z.ZodObject<{
sheets: z.ZodArray<z.ZodObject<{
name: z.ZodString;
cells: z.ZodArray<z.ZodObject<{
Expand Down Expand Up @@ -226,6 +298,15 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
bottom: "bottom";
middle: "middle";
}>>;
comment: z.ZodOptional<z.ZodObject<{
text: z.ZodString;
author: z.ZodOptional<z.ZodString>;
createdAt: z.ZodOptional<z.ZodString>;
replies: z.ZodOptional<z.ZodArray<z.ZodObject<{
text: z.ZodString;
author: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
sourcePath: z.ZodOptional<z.ZodString>;
frames: z.ZodOptional<z.ZodArray<z.ZodObject<{
pageIndex: z.ZodNumber;
Expand Down Expand Up @@ -311,9 +392,50 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
}, z.core.$strip>;
embeddedObjects: z.ZodOptional<z.ZodArray<z.ZodCustom<import("document-schema.js").ContentEmbeddedObject, import("document-schema.js").ContentEmbeddedObject>>>;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodObject<{
kind: z.ZodLiteral<"drawing">;
formatVersion: z.ZodLiteral<3>;
symbolTable: z.ZodOptional<z.ZodObject<{
symbols: z.ZodArray<z.ZodObject<{
glyph: z.ZodString;
scope: z.ZodString;
id: z.ZodString;
quantityKind: z.ZodOptional<z.ZodString>;
preferredUnit: z.ZodOptional<z.ZodString>;
definitionSource: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
units: z.ZodArray<z.ZodObject<{
id: z.ZodString;
symbol: z.ZodString;
name: z.ZodOptional<z.ZodString>;
dimension: z.ZodRecord<z.ZodEnum<{
time: "time";
length: "length";
mass: "mass";
electricCurrent: "electricCurrent";
thermodynamicTemperature: "thermodynamicTemperature";
amountOfSubstance: "amountOfSubstance";
luminousIntensity: "luminousIntensity";
}> & z.core.$partial, z.ZodNumber>;
factorToSi: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
offsetToSi: z.ZodOptional<z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>>;
context: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
contexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
bases: z.ZodArray<z.ZodObject<{
unit: z.ZodString;
value: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
kind: z.ZodLiteral<"spreadsheet">;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
Expand All @@ -324,6 +446,7 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
}, z.core.$strip>, z.ZodObject<{
pages: z.ZodArray<z.ZodObject<{
size: z.ZodObject<{
widthPt: z.ZodNumber;
Expand Down Expand Up @@ -533,9 +656,50 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
}, z.core.$strip>>>;
}, z.core.$strip>], "kind">>;
}, z.core.$strip>>;
}, z.core.$strip>, z.ZodObject<{
kind: z.ZodLiteral<"formula">;
formatVersion: z.ZodLiteral<3>;
symbolTable: z.ZodOptional<z.ZodObject<{
symbols: z.ZodArray<z.ZodObject<{
glyph: z.ZodString;
scope: z.ZodString;
id: z.ZodString;
quantityKind: z.ZodOptional<z.ZodString>;
preferredUnit: z.ZodOptional<z.ZodString>;
definitionSource: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
units: z.ZodArray<z.ZodObject<{
id: z.ZodString;
symbol: z.ZodString;
name: z.ZodOptional<z.ZodString>;
dimension: z.ZodRecord<z.ZodEnum<{
time: "time";
length: "length";
mass: "mass";
electricCurrent: "electricCurrent";
thermodynamicTemperature: "thermodynamicTemperature";
amountOfSubstance: "amountOfSubstance";
luminousIntensity: "luminousIntensity";
}> & z.core.$partial, z.ZodNumber>;
factorToSi: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
offsetToSi: z.ZodOptional<z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>>;
context: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
contexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
bases: z.ZodArray<z.ZodObject<{
unit: z.ZodString;
value: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
kind: z.ZodLiteral<"drawing">;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
Expand All @@ -546,9 +710,73 @@ declare const markdownCodec: z.ZodCodec<z.ZodCustom<Uint8Array<ArrayBuffer>, Uin
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
}, z.core.$strip>, z.ZodObject<{
formula: z.ZodObject<{
mathml: z.ZodArray<z.ZodCustom<import("document-schema.js").MathMlNode, import("document-schema.js").MathMlNode>>;
starMath: z.ZodOptional<z.ZodString>;
presentation: z.ZodOptional<z.ZodObject<{
latex: z.ZodString;
}, z.core.$strip>>;
content: z.ZodOptional<z.ZodCustom<import("document-schema.js").MathExpression, import("document-schema.js").MathExpression>>;
provenance: z.ZodOptional<z.ZodObject<{
source: z.ZodString;
pageRef: z.ZodOptional<z.ZodString>;
editTrail: z.ZodArray<z.ZodString>;
}, z.core.$strip>>;
}, z.core.$strip>;
symbolTable: z.ZodOptional<z.ZodObject<{
symbols: z.ZodArray<z.ZodObject<{
glyph: z.ZodString;
scope: z.ZodString;
id: z.ZodString;
quantityKind: z.ZodOptional<z.ZodString>;
preferredUnit: z.ZodOptional<z.ZodString>;
definitionSource: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
units: z.ZodArray<z.ZodObject<{
id: z.ZodString;
symbol: z.ZodString;
name: z.ZodOptional<z.ZodString>;
dimension: z.ZodRecord<z.ZodEnum<{
time: "time";
length: "length";
mass: "mass";
electricCurrent: "electricCurrent";
thermodynamicTemperature: "thermodynamicTemperature";
amountOfSubstance: "amountOfSubstance";
luminousIntensity: "luminousIntensity";
}> & z.core.$partial, z.ZodNumber>;
factorToSi: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
offsetToSi: z.ZodOptional<z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>>;
context: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
contexts: z.ZodOptional<z.ZodArray<z.ZodObject<{
id: z.ZodString;
bases: z.ZodArray<z.ZodObject<{
unit: z.ZodString;
value: z.ZodObject<{
numerator: z.ZodString;
denominator: z.ZodString;
}, z.core.$strip>;
}, z.core.$strip>>;
}, z.core.$strip>>>;
}, z.core.$strip>>;
kind: z.ZodLiteral<"formula">;
metadata: z.ZodObject<{
title: z.ZodOptional<z.ZodString>;
author: z.ZodOptional<z.ZodString>;
subject: z.ZodOptional<z.ZodString>;
keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
creator: z.ZodOptional<z.ZodString>;
producer: z.ZodOptional<z.ZodString>;
createdIso: z.ZodOptional<z.ZodString>;
modifiedIso: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
}, z.core.$strip>], "kind">>;
//#endregion
Expand Down
Loading
Loading