@papack/pdf 1.0.0

package/licence.md

@@ -0,0 +1,41 @@
+# MIT License
+
+Copyright (c) 2025 Matthias Steiner
+
+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.
+
+## Third-Party Software
+
+This software bundles and/or includes code from the following third-party
+projects. These components are distributed under their respective licenses.
+
+### React
+
+Copyright (c) Meta Platforms, Inc. and affiliates  
+License: MIT  
+https://github.com/facebook/react
+
+### @react-pdf/renderer
+
+Copyright (c) Diego Muracciole  
+License: MIT  
+https://github.com/diegomura/react-pdf
+
+The original license texts of these projects apply to the portions of the
+software derived from them and are not superseded by the license above.

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@papack/pdf",
+  "description": "Minimal PDF rendering wrapper built on React and react-pdf",
+  "version": "1.0.0",
+  "author": "Matthias Steiner",
+  "repository": "github:papack/pdf",
+  "homepage": "https://github.com/papack/pdf",
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "dist/index.mjs",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.mts",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown"
+  },
+  "devDependencies": {
+    "@react-pdf/renderer": "^4.3.1",
+    "@types/bun": "latest",
+    "@types/react": "^19.2.7",
+    "react": "^19.2.3",
+    "tsdown": "^0.18.2"
+  }
+}

package/readme.md

@@ -0,0 +1,194 @@
+# @papack/pdf
+
+Minimal PDF rendering wrapper built on React and react-pdf.
+
+This package provides a very small abstraction layer around **React** and **@react-pdf/renderer**.
+
+## Core Idea
+
+- JSX rendered directly to PDF (buffer)
+- Built on React + @react-pdf/renderer
+
+This is **PDF rendering only**:  
+define document → render → buffer / file.
+
+## What this is
+
+- A thin wrapper
+- Some helpers (`<For />`, `<Show />`, `<Repeat />`)
+- A custom JSX runtime for controlled usage
+- Convenience utilities for layout and styling
+
+## Install
+
+```bash
+npm install @papack/pdf
+```
+
+## Quick Start
+
+```ts
+import { jsx, render } from "@papack/pdf/core";
+import { writeFile } from "fs/promises";
+import { Document, Page, Text } from "@papack/pdf/layout";
+
+const MyDocument = () => (
+  <Document title="Example">
+    <Page size="A4">
+      <Text>Hello PDF</Text>
+    </Page>
+  </Document>
+);
+
+const buffer = await render(<MyDocument />);
+await writeFile("example.pdf", buffer);
+```
+
+## Rendering
+
+```ts
+import { render } from "@papack/pdf/core";
+
+const buf = await render(<MyDocument />);
+```
+
+- Returns a `Buffer`
+- Internally calls `@react-pdf/renderer/pdf().toBuffer()`
+
+## JSX Runtime
+
+The package ships with a minimal JSX runtime.
+
+```ts
+import { jsx, fragment } from "@papack/pdf/core";
+```
+
+- Uses `React.createElement`
+- No transforms, no extensions
+- Intended for controlled environments (Node.js)
+
+## Components
+
+### `<For />`
+
+```tsx
+<For each={items}>{(item, index) => <Text>{item}</Text>}</For>
+```
+
+- Simple array iteration
+- No keys
+- No diffing
+- Render-only
+
+### `<Show />`
+
+```tsx
+<Show when={loggedIn}>
+  <Text>Dashboard</Text>
+</Show>
+```
+
+- Conditional rendering
+- Returns `null` when false
+
+### `<Repeat />`
+
+```tsx
+<Repeat n={3}>
+  <Text>Line</Text>
+</Repeat>
+```
+
+- Repeats children `n` times
+- Internally uses fragments
+
+## Layout Helpers
+
+The library provides basic layout primitives built on react-pdf:
+
+- `Box`
+- `Flex`
+- `Stack`
+- `Page`
+- `Document`
+- `Text`
+
+These are thin wrappers with predictable props.
+
+Example:
+
+```tsx
+<Page size="A4" p="2cm">
+  <Stack g="1cm">
+    <Text>Title</Text>
+    <Text>Content</Text>
+  </Stack>
+</Page>
+```
+
+## Absolute Positioning
+
+```tsx
+import { Absolute } from "@papack/pdf/layout";
+
+<Absolute top="2cm" left="2cm">
+  <Text>Overlay</Text>
+</Absolute>;
+```
+
+- Maps directly to `position: absolute`
+- No layout engine involved
+
+## Styling
+
+Shared style constants are provided:
+
+- `font`
+- `color`
+- `size`
+- `space`
+
+Example:
+
+```ts
+font.size.lg;
+font.weight.bold;
+```
+
+## Font Registration
+
+Use static imports (e.g. via bundler `?url`):
+
+```ts
+import sourceRegular from "./assets/source-code-pro-regular.ttf?url";
+import sourceItalic from "./assets/source-code-pro-italic.ttf?url";
+```
+
+### Register Fonts
+
+```ts
+import { Font } from "@papack/pdf";
+
+Font.register({
+  family: family.mono,
+  src: new URL(sourceRegular, import.meta.url).pathname,
+  fontWeight: 400,
+});
+
+Font.register({
+  family: family.mono,
+  src: new URL(sourceItalic, import.meta.url).pathname,
+  fontWeight: 400,
+  fontStyle: "italic",
+});
+```
+
+- One `Font.register` call per weight/style
+- `src` must resolve to a filesystem path
+- `fontWeight` and `fontStyle` must match usage exactly
+
+### Usage
+
+```tsx
+<Text style={{ fontFamily: family.mono, fontWeight: 400 }}>Code</Text>
+```