@typstream/universe 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ikram Hasan
+
+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/NOTICE

@@ -0,0 +1,20 @@
+Third-party notices for @typstream/universe
+
+vendor/ holds Typst Universe packages, each tarball exactly as packages.typst.org serves it. They are not part of
+typstream and keep their own licenses: each tarball contains its license file (LICENSE, or LICENSE.txt for
+physica), which applies to that package. The source of each is the tarball itself and the repository named below.
+
+* alchemist 0.2.0: MIT, by Robotechnic (https://github.com/Typsium/alchemist)
+* cetz 0.3.4: LGPL-3.0-or-later, by Johannes Wolf, fenjalien (https://github.com/cetz-package/cetz)
+* cetz 0.5.2: LGPL-3.0-or-later, by Johannes Wolf, fenjalien (https://github.com/cetz-package/cetz)
+* cetz 0.5.3: LGPL-3.0-or-later, by Johannes Wolf, fenjalien (https://github.com/cetz-package/cetz)
+* cetz-plot 0.1.4: LGPL-3.0-or-later, by Johannes Wolf, fenjalien (https://github.com/cetz-package/cetz-plot)
+* chemformula 0.1.3: MIT, by pacaunt (https://github.com/pacaunt/chemformula)
+* fletcher 0.5.8: MIT, by Joseph Wilson (Jollywatt) (https://github.com/Jollywatt/typst-fletcher)
+* oxifmt 0.2.1: MIT-0, by PgBiel (https://github.com/PgBiel/typst-oxifmt)
+* oxifmt 1.0.0: MIT OR Apache-2.0, by PgBiel (https://github.com/PgBiel/typst-oxifmt)
+* physica 0.9.8: MIT, by Leedehai (https://github.com/Leedehai/typst-physics)
+* unify 0.8.1: MIT, by Christopher Hecker (https://github.com/ChHecker/unify)
+
+cetz and cetz-plot are under the GNU Lesser General Public License, version 3 or later. They are distributed
+here unmodified, in source form (Typst packages are their source).

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @typstream/universe
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The [Typst Universe](https://typst.app/universe) packages typstream allows by default, vendored with their integrity hashes. They cover diagrams, chemistry and math:
+
+| For | Package | Import |
+|---|---|---|
+| Diagrams | `@preview/cetz:0.5.3` | `#import "@preview/cetz:0.5.3"` |
+| Diagrams | `@preview/fletcher:0.5.8` | `#import "@preview/fletcher:0.5.8": diagram, node, edge` |
+| Math | `@preview/cetz-plot:0.1.4` | `#import "@preview/cetz-plot:0.1.4": plot` |
+| Math | `@preview/physica:0.9.8` | `#import "@preview/physica:0.9.8": *` |
+| Math | `@preview/unify:0.8.1` | `#import "@preview/unify:0.8.1": num, qty, unit` |
+| Chemistry | `@preview/chemformula:0.1.3` | `#import "@preview/chemformula:0.1.3": ch` |
+| Chemistry | `@preview/alchemist:0.2.0` | `#import "@preview/alchemist:0.2.0": *` |
+
+Their dependencies come too, pinned as the packages pin them: cetz 0.5.2 and 0.3.4 and oxifmt 1.0.0 and 0.2.1.
+
+```ts
+import { universe, UNIVERSE_PACKAGES } from "@typstream/universe";
+
+// As a plugin: the engine's allowlist (engine.packages) and prompt rules (prompt.rules).
+<Typstream source={text} plugins={[universe]} />;
+// Or engine-wide:
+createEngine({ spawn: engineWorker(), initialize: { packages: [...UNIVERSE_PACKAGES] } });
+```
+
+`typstream`'s `<Typstream>` adds the plugin by default (`packages={false}` turns it off).
+
+- **Tarballs.** `vendor/` holds the `.tar.gz` files exactly as packages.typst.org serves them. Each `url` is a `new URL("../vendor/…", import.meta.url)`, which bundlers emit as an asset. The engine fetches one from your origin only when a document imports it, and keeps it in Cache Storage after that.
+- **Integrity.** `integrity` is the SHA-256 of the uncompressed tar, so it holds even when a server sends the `.gz` with `Content-Encoding: gzip` (Vite's dev server does) and the browser hands over the tar.
+- **CeTZ needs Typst's wasm plugins.** It calls its `cetz-core` plugin for geometry, so the engine keeps plugin support.
+- **HTML target.** With `@typstream/html-compat`, CeTZ canvases become inline SVG. fletcher diagrams stay empty in HTML (a known gap, listed in html-compat's README) and render in paged output.
+
+## Licenses
+
+The plugin's own code is MIT. The vendored packages keep their licenses: each tarball carries its own, unmodified,
+and `NOTICE` lists every package with its license and authors.
+- **LGPL-3.0-or-later:** cetz and cetz-plot.
+- **MIT:** fletcher, physica, unify, chemformula and alchemist.
+- **oxifmt:** MIT OR Apache-2.0 (1.0.0) and MIT-0 (0.2.1).
+
+An app that can't ship LGPL code can leave this plugin out and pass its own allowlist.
+
+## Updating
+
+Adding or updating a package:
+
+1. `node scripts/vendor.mjs name:version` downloads it and prints its integrity.
+2. Add it to `src/index.ts` with its dependencies. The tests list any imported package that is missing.
+3. `node scripts/vendor.mjs --check` compares every tarball with upstream.

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { PackageSpec } from '@typstream/core';
+
+/** What a document imports a package for. @public */
+type UniverseTopic = "diagrams" | "math" | "chemistry";
+/**
+ * A vendored Typst Universe package: a {@link @typstream/core#PackageSpec} with
+ * its tarball's URL and integrity (of the uncompressed tar) always set.
+ * @public
+ */
+interface UniversePackage extends PackageSpec {
+    /** The vendored `.tar.gz`, next to this package's JS: bundlers emit it as an asset. */
+    url: string;
+    /** `sha256-…` of the uncompressed tar. */
+    integrity: string;
+    /** Set on the packages documents import; unset on those that only come in as another's dependency. */
+    topic?: UniverseTopic;
+    /** One line for the prompt: what it's for and how it's called. */
+    summary?: string;
+}
+/**
+ * Every vendored package, dependencies included. Each `new URL` is a literal so
+ * bundlers can see it.
+ * @public
+ */
+declare const UNIVERSE_PACKAGES: readonly UniversePackage[];
+/**
+ * The vendored packages as a typstream plugin: the engine's package allowlist
+ * (`engine.packages`) and prompt rules naming what the model may import.
+ * `typstream`'s `<Typstream>` adds it by default.
+ * @public
+ */
+declare const universe: {
+    key: string;
+    engine: {
+        packages: {
+            namespace: string;
+            name: string;
+            version: string;
+            url: string;
+            integrity: string;
+            imports: readonly string[] | undefined;
+        }[];
+    };
+    prompt: {
+        rules: string[];
+    };
+};
+
+export { UNIVERSE_PACKAGES, type UniversePackage, type UniverseTopic, universe };

package/dist/index.js

@@ -0,0 +1,136 @@
+// src/index.ts
+import { definePlugin } from "@typstream/core";
+var preview = (name, version, url, integrity, imports, use) => ({ namespace: "preview", name, version, url: url.href, integrity, imports, ...use });
+var UNIVERSE_PACKAGES = [
+  preview(
+    "cetz",
+    "0.5.3",
+    new URL("../vendor/cetz-0.5.3.tar.gz", import.meta.url),
+    "sha256-7uRpaPfYuRjZ0EkPoOM2gkZlOASeDzSguTSJWUx+PVo=",
+    ["@preview/oxifmt:1.0.0"],
+    {
+      topic: "diagrams",
+      // #24: models call Typst's `polygon` and `ellipse` in a canvas, where `cetz.draw` shadows them.
+      summary: "drawings: `#cetz.canvas({ import cetz.draw: *; line((0, 0), (4, 0), (2, 3), close: true); circle((6, 1), radius: (2, 1)); rect((9, 0), (11, 2)); content((2, -0.5), [4 cm]) })`. In a canvas these replace Typst's shapes: a polygon is `line(.., close: true)`, an ellipse a `circle` with two radii"
+    }
+  ),
+  preview(
+    "fletcher",
+    "0.5.8",
+    new URL("../vendor/fletcher-0.5.8.tar.gz", import.meta.url),
+    "sha256-vtCQZc1kBvcTg4tcVXGaNsHxtiqCQEq3JVbegOy5rXw=",
+    ["@preview/cetz:0.3.4"],
+    {
+      topic: "diagrams",
+      summary: 'flowcharts, state and commutative diagrams; import `diagram, node, edge`: `#diagram(node((0, 0), [A]), edge("-|>"), node((1, 0), [B]))`'
+    }
+  ),
+  preview(
+    "cetz-plot",
+    "0.1.4",
+    new URL("../vendor/cetz-plot-0.1.4.tar.gz", import.meta.url),
+    "sha256-I/KwwAqNhHnJ9ghzhtfoWY6ZYIfOzPMktulXDX2CMc0=",
+    ["@preview/cetz:0.5.2"],
+    {
+      topic: "math",
+      summary: "function graphs and charts in a CeTZ canvas; import `plot`: `#cetz.canvas(plot.plot(size: (6, 4), { plot.add(domain: (-2, 2), x => x * x) }))`"
+    }
+  ),
+  preview(
+    "physica",
+    "0.9.8",
+    new URL("../vendor/physica-0.9.8.tar.gz", import.meta.url),
+    "sha256-gLyLUm7L9oiszlLGmleQxWZRE4LWGZnWaGgQacVQBQs=",
+    [],
+    {
+      topic: "math",
+      summary: "calculus and physics notation in math; import `*`: `$dv(f, x)$`, `$pdv(u, x, y)$`, `$vb(F)$`"
+    }
+  ),
+  preview(
+    "unify",
+    "0.8.1",
+    new URL("../vendor/unify-0.8.1.tar.gz", import.meta.url),
+    "sha256-m5t0SW3fByFSrqtdTqvD87gky+/ZphP4wY6a3cVm9T8=",
+    [],
+    {
+      topic: "math",
+      summary: 'numbers and SI units; import `num, qty, unit`: `#qty("9.81", "m/s^2")`, `#num("1.2e5")`, `#unit("kg m s^-2")`'
+    }
+  ),
+  preview(
+    "chemformula",
+    "0.1.3",
+    new URL("../vendor/chemformula-0.1.3.tar.gz", import.meta.url),
+    "sha256-g9dEimwQXuFvLIk70BB78v5DHwZVqkyI66yIJk/kUMw=",
+    [],
+    {
+      topic: "chemistry",
+      summary: 'formulas and equations, mhchem-style; import `ch`: `#ch("2H2 + O2 -> 2H2O")`, `#ch("CuSO4*5H2O")`; arrow labels are math, so quote words: `->["heat"]`'
+    }
+  ),
+  preview(
+    "alchemist",
+    "0.2.0",
+    new URL("../vendor/alchemist-0.2.0.tar.gz", import.meta.url),
+    "sha256-wp9SMhMi3ZJtK/nDi5cRrE8xBJQ4NsGhDz+G82kBUMg=",
+    ["@preview/cetz:0.5.2"],
+    {
+      topic: "chemistry",
+      summary: 'structural formulas; import `*`: `#skeletize({ fragment("H_3C"); single(); fragment("OH") })`'
+    }
+  ),
+  // Dependencies, pinned exactly by the packages above.
+  preview(
+    "cetz",
+    "0.5.2",
+    new URL("../vendor/cetz-0.5.2.tar.gz", import.meta.url),
+    "sha256-1HwM5S7MWYfEKdi/jA5hf/er+oCJ5G8OAmJFqTO94NI=",
+    ["@preview/oxifmt:1.0.0"]
+  ),
+  preview(
+    "cetz",
+    "0.3.4",
+    new URL("../vendor/cetz-0.3.4.tar.gz", import.meta.url),
+    "sha256-HBkbw1TTedKFYNU/UE0Rxm/XIFvzanWHS37qp12rXK8=",
+    ["@preview/oxifmt:0.2.1"]
+  ),
+  preview(
+    "oxifmt",
+    "1.0.0",
+    new URL("../vendor/oxifmt-1.0.0.tar.gz", import.meta.url),
+    "sha256-XS/0bduus8C6ZZTZ999XCbC5z8JILO0EbFryxrztj0o=",
+    []
+  ),
+  preview(
+    "oxifmt",
+    "0.2.1",
+    new URL("../vendor/oxifmt-0.2.1.tar.gz", import.meta.url),
+    "sha256-SHrUfkIQznu2YJIMfuGQDBLgkHTQefibSdMwJ/oG78k=",
+    []
+  )
+];
+var spec = (p) => `@${p.namespace}/${p.name}:${p.version}`;
+var universe = definePlugin({
+  key: "universe",
+  engine: {
+    packages: UNIVERSE_PACKAGES.map(({ namespace, name, version, url, integrity, imports }) => ({
+      namespace,
+      name,
+      version,
+      url,
+      integrity,
+      imports
+    }))
+  },
+  prompt: {
+    rules: [
+      "Typst packages: import only these, at exactly these versions. Anything else fails to compile.",
+      ...UNIVERSE_PACKAGES.filter((p) => p.topic).map((p) => `\`#import "${spec(p)}"\` (${p.topic}): ${p.summary}`)
+    ]
+  }
+});
+export {
+  UNIVERSE_PACKAGES,
+  universe
+};

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@typstream/universe",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "The Typst Universe packages typstream allows by default (CeTZ, fletcher, cetz-plot, physica, unify, chemformula, alchemist), vendored with integrity hashes, as an engine allowlist plugin.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ikramhasan/typstream.git",
+    "directory": "packages/universe"
+  },
+  "homepage": "https://typstream.vercel.app/docs/reference/universe",
+  "bugs": "https://github.com/ikramhasan/typstream/issues",
+  "keywords": [
+    "typst",
+    "typst-packages",
+    "cetz"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "vendor",
+    "NOTICE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@typstream/core": "0.1.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run --project node",
+    "test:paged": "vitest run --project paged",
+    "test:docx": "vitest run --project docx",
+    "vendor": "node scripts/vendor.mjs",
+    "check-types": "tsc -p tsconfig.json",
+    "check:api": "api-extractor run",
+    "api:update": "api-extractor run --local",
+    "check:package": "publint --strict --pack npm && attw --pack . --profile esm-only"
+  }
 }