ts-d2 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 spa5k
+
+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/README.md

@@ -0,0 +1,109 @@
+# ts-d2
+
+This is the TypeScript version of the [Deuterium](https://www.d2lib.io) library.
+
+Deuterium is a "document as code" library, which allows you to create format-independent documents, which then are converted into a specific format using the three components DocFrame, docPIPE and docTYPE.
+
+The following output formats are supported:
+* HTML
+* PDF (including PDF/UA support)
+* Plaintext
+* Images (BMP, PNG and more)
+* PostScript
+
+This is a small example creating a document with the content "Hello World" as PDF:
+
+```typescript
+import * as fs from "fs";
+import Deuterium from "ts-d2";
+
+new Deuterium.Content.Document("Hello World")
+  .convertTo(Deuterium.OutputFormat.PDF)
+  .then(async (buffer) => {
+    // save blob to file
+    fs.writeFileSync("output.pdf", Buffer.from(await buffer.arrayBuffer()));
+  });
+```
+
+# Basics
+
+Documents are divided into DocumentElements, which are the smallest part of a document (like text, vertical space, etc.).
+
+DocumentElements also may be branch elements and therefore have child-elements (like tables, paragraphs, etc.).
+
+DocumentElements may be grouped together to a document, which then may be converted to the desired output format.
+
+All the supported DocumentElements are placed in the package `Deuterium.Content`.
+
+## Leaf elements
+
+The following leaf elements are currently supported:
+* Barcode
+* ColumnDefinition (only useful for page-based formats)
+* Directory
+* Footer
+* Formatted (may be used to directly insert docTYPE code and/or HTML code)
+* Header
+* Pagebreak
+* PageDefinition (only useful for page-based formats)
+* Paragraph
+* SpaceVertically
+* Span
+* Table
+* TableCell
+* TableRow
+* Text
+
+Any leaf element may be added to multiple branch elements (there is no connection from a leaf element to its parent element).
+
+### Text
+
+To create a text element you may use the following code:
+
+```typescript
+new Deuterium.Content.Text("Hello World!")
+```
+
+The text may then be added to any branch element.
+
+When creating branch elements, you may also pass strings directly in order to create a text element.
+
+```typescript
+new Deuterium.Content.Span("Hello World!", {
+  bold: true
+});
+```
+
+## Branch elements
+
+Branch elements have two functionalities:
+* Group elements together (like Directory)
+* Apply formatting/properties to their child elements.
+
+The following branch elements are supported:
+* Directory
+* Document
+* Footer
+* Formatted
+* Header
+* Paragraph
+* Span
+* Table
+* TableCell
+* TableRow
+
+### Content parameter
+
+When creating branch document elements, the first parameter is the so called "content" parameter, which is used to define the child elements of the new branch document element.
+
+The content parameter may be one of the following:
+
+* string -> Creates a Text Document Element for the given string
+* DocumentElement -> Just uses the passed DocumentElement
+* (DocumentElement | string)[] -> Uses all the passed DocumentElements (and converts passed strings to Text objects)
+
+Especially the first variant of the content parameter can result in small code:
+
+```typescript
+new Deuterium.Content.Footer("...");
+```

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "ts-d2",
+  "version": "0.0.1",
+  "description": "Deuterium is a TypeScript library for professional output creation.",
+  "keywords": [
+    "pdf",
+    "postscript",
+    "output",
+    "formatting",
+    "rendering",
+    "typescript",
+    "document"
+  ],
+  "homepage": "https://d2lib.io",
+  "bugs": {
+    "url": "https://github.com/documatrix/ts-d2/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/documatrix/ts-d2.git"
+  },
+  "license": "MIT",
+  "author": "DocuMatrix GmbH",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "cross-env NODE_ENV=production tsup-node",
+    "build:dev": " cross-env NODE_ENV=development tsup-node",
+    "format": "dprint fmt",
+    "lint": "eslint src --ext .ts",
+    "prepare": "husky",
+    "test": "jest"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "pnpm format && pnpm lint",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "devDependencies": {
+    "@babel/preset-typescript": "^7.26.0",
+    "@commitlint/cli": "19.8.0",
+    "@commitlint/config-conventional": "19.8.0",
+    "@jest/globals": "^29.5.0",
+    "@swc/core": "^1.11.9",
+    "@swc/helpers": "^0.5.15",
+    "@types/jest": "^29.5.14",
+    "@types/node": "22.13.10",
+    "@types/uuid": "^10.0.0",
+    "typescript-eslint": "8.26.1",
+    "cross-env": "^7.0.3",
+    "dotenv": "16.4.7",
+    "dprint": "^0.49.0",
+    "esbuild": "0.25.1",
+    "eslint": "9.22.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "semantic-release": "24.2.3",
+    "ts-jest": "^29.2.6",
+    "tslib": "2.8.1",
+    "tsup": "8.4.0",
+    "typescript": "5.8.2",
+    "uuid": "^11.1.0"
+  },
+  "dependencies": {
+    "axios": "^1.8.3",
+    "docframe-types": "^0.4.2",
+    "form-data": "^4.0.2"
+  }
+}