postext 0.0.2 → 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Postext contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/__tests__/createLayout.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=createLayout.test.d.ts.map

package/dist/__tests__/createLayout.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLayout.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/createLayout.test.tsx"],"names":[],"mappings":""}

package/dist/__tests__/createLayout.test.js

@@ -0,0 +1,141 @@
+import { describe, it, expect } from "vitest";
+import { createElement } from "react";
+import { createLayout } from "../createLayout";
+describe("createLayout", () => {
+    const minimalContent = {
+        markdown: "# Hello\n\nA paragraph of text.",
+    };
+    it("returns a React function component", () => {
+        const Layout = createLayout(minimalContent);
+        expect(typeof Layout).toBe("function");
+    });
+    it("returned component has displayName 'PostextLayout'", () => {
+        const Layout = createLayout(minimalContent);
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("returned component renders without throwing", () => {
+        const Layout = createLayout(minimalContent);
+        // createElement exercises the component function
+        expect(() => createElement(Layout)).not.toThrow();
+    });
+    it("accepts content with resources", () => {
+        const content = {
+            markdown: "# Article\n\nSome text with a figure reference.",
+            resources: [
+                {
+                    id: "fig-1",
+                    type: "image",
+                    src: "/photo.jpg",
+                    alt: "A photo",
+                    caption: "Figure 1",
+                    width: 800,
+                    height: 600,
+                },
+                {
+                    id: "tbl-1",
+                    type: "table",
+                    content: "| A | B |\n|---|---|\n| 1 | 2 |",
+                },
+                {
+                    id: "pq-1",
+                    type: "pullQuote",
+                    content: "A compelling quote.",
+                },
+            ],
+        };
+        const Layout = createLayout(content);
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("accepts content with notes", () => {
+        const content = {
+            markdown: "Text with a footnote reference.",
+            notes: [
+                { id: "fn-1", type: "footnote", content: "A footnote.", marker: "1" },
+                { id: "en-1", type: "endnote", content: "An endnote." },
+                { id: "mn-1", type: "marginNote", content: "A margin note." },
+            ],
+        };
+        const Layout = createLayout(content);
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("accepts a full config object", () => {
+        const config = {
+            columns: 2,
+            gutter: "2rem",
+            columnConfig: {
+                count: 2,
+                gutter: "2rem",
+                columnRule: { width: "1px", style: "solid", color: "#ccc" },
+                balancing: true,
+            },
+            typography: {
+                orphans: 2,
+                widows: 2,
+                hyphenation: true,
+                ragOptimization: true,
+                spacing: {
+                    beforeHeading: "1.5em",
+                    afterHeading: "0.5em",
+                    beforeFigure: "1em",
+                    afterFigure: "1em",
+                    beforeBlockQuote: "1em",
+                    afterBlockQuote: "1em",
+                },
+                keepTogether: {
+                    headingWithParagraph: true,
+                    figureWithCaption: true,
+                },
+            },
+            resourcePlacement: {
+                defaultStrategy: "topOfColumn",
+                deferPlacement: false,
+                preserveAspectRatio: true,
+            },
+            references: {
+                footnotes: { placement: "columnBottom", marker: "number" },
+                figureNumbering: true,
+                tableNumbering: true,
+                marginNotes: true,
+            },
+            sectionOverrides: [
+                {
+                    selector: ".intro",
+                    columns: { count: 1 },
+                    typography: { orphans: 3 },
+                },
+            ],
+            renderer: "web",
+        };
+        const Layout = createLayout(minimalContent, config);
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("accepts config with pdf renderer", () => {
+        const Layout = createLayout(minimalContent, { renderer: "pdf" });
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("works with no config (optional)", () => {
+        const Layout = createLayout(minimalContent);
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("works with empty config", () => {
+        const Layout = createLayout(minimalContent, {});
+        expect(Layout.displayName).toBe("PostextLayout");
+    });
+    it("accepts all resource placement strategies", () => {
+        const strategies = [
+            "topOfColumn",
+            "inline",
+            "floatLeft",
+            "floatRight",
+            "fullWidthBreak",
+            "margin",
+        ];
+        for (const strategy of strategies) {
+            const Layout = createLayout(minimalContent, {
+                resourcePlacement: { defaultStrategy: strategy },
+            });
+            expect(Layout.displayName).toBe("PostextLayout");
+        }
+    });
+});
+//# sourceMappingURL=createLayout.test.js.map

package/dist/__tests__/createLayout.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLayout.test.js","sourceRoot":"","sources":["../../src/__tests__/createLayout.test.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG/C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,cAAc,GAAmB;QACrC,QAAQ,EAAE,iCAAiC;KAC5C,CAAC;IAEF,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;QAC5C,iDAAiD;QACjD,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,OAAO,GAAmB;YAC9B,QAAQ,EAAE,iDAAiD;YAC3D,SAAS,EAAE;gBACT;oBACE,EAAE,EAAE,OAAO;oBACX,IAAI,EAAE,OAAO;oBACb,GAAG,EAAE,YAAY;oBACjB,GAAG,EAAE,SAAS;oBACd,OAAO,EAAE,UAAU;oBACnB,KAAK,EAAE,GAAG;oBACV,MAAM,EAAE,GAAG;iBACZ;gBACD;oBACE,EAAE,EAAE,OAAO;oBACX,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,iCAAiC;iBAC3C;gBACD;oBACE,EAAE,EAAE,MAAM;oBACV,IAAI,EAAE,WAAW;oBACjB,OAAO,EAAE,qBAAqB;iBAC/B;aACF;SACF,CAAC;QACF,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,OAAO,GAAmB;YAC9B,QAAQ,EAAE,iCAAiC;YAC3C,KAAK,EAAE;gBACL,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE;gBACrE,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE;gBACvD,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE;aAC9D;SACF,CAAC;QACF,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAkB;YAC5B,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,MAAM;YACd,YAAY,EAAE;gBACZ,KAAK,EAAE,CAAC;gBACR,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE;gBAC3D,SAAS,EAAE,IAAI;aAChB;YACD,UAAU,EAAE;gBACV,OAAO,EAAE,CAAC;gBACV,MAAM,EAAE,CAAC;gBACT,WAAW,EAAE,IAAI;gBACjB,eAAe,EAAE,IAAI;gBACrB,OAAO,EAAE;oBACP,aAAa,EAAE,OAAO;oBACtB,YAAY,EAAE,OAAO;oBACrB,YAAY,EAAE,KAAK;oBACnB,WAAW,EAAE,KAAK;oBAClB,gBAAgB,EAAE,KAAK;oBACvB,eAAe,EAAE,KAAK;iBACvB;gBACD,YAAY,EAAE;oBACZ,oBAAoB,EAAE,IAAI;oBAC1B,iBAAiB,EAAE,IAAI;iBACxB;aACF;YACD,iBAAiB,EAAE;gBACjB,eAAe,EAAE,aAAa;gBAC9B,cAAc,EAAE,KAAK;gBACrB,mBAAmB,EAAE,IAAI;aAC1B;YACD,UAAU,EAAE;gBACV,SAAS,EAAE,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE;gBAC1D,eAAe,EAAE,IAAI;gBACrB,cAAc,EAAE,IAAI;gBACpB,WAAW,EAAE,IAAI;aAClB;YACD,gBAAgB,EAAE;gBAChB;oBACE,QAAQ,EAAE,QAAQ;oBAClB,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;oBACrB,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE;iBAC3B;aACF;YACD,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,UAAU,GAAG;YACjB,aAAa;YACb,QAAQ;YACR,WAAW;YACX,YAAY;YACZ,gBAAgB;YAChB,QAAQ;SACA,CAAC;QAEX,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,EAAE;gBAC1C,iBAAiB,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE;aACjD,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/exports.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=exports.test.d.ts.map

package/dist/__tests__/exports.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/exports.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/exports.test.js

@@ -0,0 +1,14 @@
+import { describe, it, expect } from "vitest";
+import * as postext from "../index";
+describe("package exports", () => {
+    it("exports createLayout function", () => {
+        expect(postext.createLayout).toBeDefined();
+        expect(typeof postext.createLayout).toBe("function");
+    });
+    it("does not export unexpected values", () => {
+        const exportedKeys = Object.keys(postext);
+        // Only createLayout should be a runtime export; types are compile-time only
+        expect(exportedKeys).toEqual(["createLayout"]);
+    });
+});
+//# sourceMappingURL=exports.test.js.map

package/dist/__tests__/exports.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.test.js","sourceRoot":"","sources":["../../src/__tests__/exports.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,UAAU,CAAC;AAEpC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,CAAC,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,4EAA4E;QAC5E,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "postext",
-  "version": "0.0.2",
-  "description": "A programmable typesetter for the web",
+  "version": "0.0.4",
+  "description": "A programmable typesetter for the web. Layout engine that applies professional editorial rules — columns, orphan/widow prevention, resource placement, footnotes — to semantic content. Built on @chenglou/pretext for DOM-free text measurement.",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -23,14 +23,19 @@
   },
   "devDependencies": {
     "@types/react": "^19",
+    "@vitejs/plugin-react": "^6.0.1",
+    "eslint": "^9.39.4",
     "react": "^19.2.4",
     "typescript": "latest",
+    "typescript-eslint": "^8.58.0",
+    "vitest": "^4.1.3",
     "@postext/typescript-config": "0.0.0"
   },
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
     "check-types": "tsc --noEmit",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "test": "vitest run"
   }
 }