npm - worldorbit - Versions diffs - 2.5.2 - Mend

worldorbit 2.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (113) hide show

package/LICENSE.md +5 -0
package/README.md +250 -0
package/dist/browser/core/dist/index.js +4009 -0
package/dist/browser/markdown/dist/index.js +3951 -0
package/dist/browser/viewer/dist/index.js +5981 -0
package/dist/constants.d.ts +8 -0
package/dist/constants.js +84 -0
package/dist/errors.d.ts +7 -0
package/dist/errors.js +16 -0
package/dist/index.d.ts +18 -0
package/dist/index.js +25 -0
package/dist/normalize.d.ts +2 -0
package/dist/normalize.js +243 -0
package/dist/parse.d.ts +2 -0
package/dist/parse.js +126 -0
package/dist/render.d.ts +6 -0
package/dist/render.js +683 -0
package/dist/tokenize.d.ts +4 -0
package/dist/tokenize.js +68 -0
package/dist/types.d.ts +208 -0
package/dist/types.js +1 -0
package/dist/unpkg/core/dist/index.js +4081 -0
package/dist/unpkg/markdown/dist/index.js +3979 -0
package/dist/unpkg/test.html +1 -0
package/dist/unpkg/viewer/dist/index.js +6038 -0
package/dist/unpkg/worldorbit-core.min.js +5 -0
package/dist/unpkg/worldorbit-markdown.min.js +81 -0
package/dist/unpkg/worldorbit-viewer.min.js +232 -0
package/dist/unpkg/worldorbit.d.ts +2 -0
package/dist/unpkg/worldorbit.js +2 -0
package/dist/unpkg/worldorbit.min.js +236 -0
package/dist/validate.d.ts +2 -0
package/dist/validate.js +31 -0
package/dist/viewer-state.d.ts +16 -0
package/dist/viewer-state.js +130 -0
package/dist/viewer.d.ts +2 -0
package/dist/viewer.js +434 -0
package/package.json +64 -0
package/packages/core/README.md +13 -0
package/packages/core/dist/atlas-edit.d.ts +11 -0
package/packages/core/dist/atlas-edit.js +210 -0
package/packages/core/dist/diagnostics.d.ts +10 -0
package/packages/core/dist/diagnostics.js +109 -0
package/packages/core/dist/draft-parse.d.ts +3 -0
package/packages/core/dist/draft-parse.js +642 -0
package/packages/core/dist/draft.d.ts +15 -0
package/packages/core/dist/draft.js +343 -0
package/packages/core/dist/errors.d.ts +7 -0
package/packages/core/dist/errors.js +16 -0
package/packages/core/dist/format.d.ts +4 -0
package/packages/core/dist/format.js +364 -0
package/packages/core/dist/index.d.ts +28 -0
package/packages/core/dist/index.js +44 -0
package/packages/core/dist/load.d.ts +4 -0
package/packages/core/dist/load.js +130 -0
package/packages/core/dist/markdown.d.ts +2 -0
package/packages/core/dist/markdown.js +37 -0
package/packages/core/dist/normalize.d.ts +2 -0
package/packages/core/dist/normalize.js +304 -0
package/packages/core/dist/parse.d.ts +2 -0
package/packages/core/dist/parse.js +133 -0
package/packages/core/dist/scene.d.ts +3 -0
package/packages/core/dist/scene.js +1484 -0
package/packages/core/dist/schema.d.ts +8 -0
package/packages/core/dist/schema.js +298 -0
package/packages/core/dist/tokenize.d.ts +4 -0
package/packages/core/dist/tokenize.js +68 -0
package/packages/core/dist/types.d.ts +382 -0
package/packages/core/dist/types.js +1 -0
package/packages/core/dist/validate.d.ts +2 -0
package/packages/core/dist/validate.js +56 -0
package/packages/editor/dist/editor.d.ts +2 -0
package/packages/editor/dist/editor.js +2620 -0
package/packages/editor/dist/index.d.ts +2 -0
package/packages/editor/dist/index.js +1 -0
package/packages/editor/dist/types.d.ts +53 -0
package/packages/editor/dist/types.js +1 -0
package/packages/markdown/README.md +9 -0
package/packages/markdown/dist/html.d.ts +3 -0
package/packages/markdown/dist/html.js +57 -0
package/packages/markdown/dist/index.d.ts +4 -0
package/packages/markdown/dist/index.js +3 -0
package/packages/markdown/dist/rehype.d.ts +10 -0
package/packages/markdown/dist/rehype.js +49 -0
package/packages/markdown/dist/remark.d.ts +9 -0
package/packages/markdown/dist/remark.js +28 -0
package/packages/markdown/dist/types.d.ts +11 -0
package/packages/markdown/dist/types.js +1 -0
package/packages/viewer/README.md +12 -0
package/packages/viewer/dist/atlas-state.d.ts +12 -0
package/packages/viewer/dist/atlas-state.js +251 -0
package/packages/viewer/dist/atlas-viewer.d.ts +2 -0
package/packages/viewer/dist/atlas-viewer.js +448 -0
package/packages/viewer/dist/custom-element.d.ts +1 -0
package/packages/viewer/dist/custom-element.js +64 -0
package/packages/viewer/dist/embed.d.ts +20 -0
package/packages/viewer/dist/embed.js +138 -0
package/packages/viewer/dist/index.d.ts +9 -0
package/packages/viewer/dist/index.js +8 -0
package/packages/viewer/dist/minimap.d.ts +3 -0
package/packages/viewer/dist/minimap.js +63 -0
package/packages/viewer/dist/render.d.ts +6 -0
package/packages/viewer/dist/render.js +585 -0
package/packages/viewer/dist/theme.d.ts +4 -0
package/packages/viewer/dist/theme.js +98 -0
package/packages/viewer/dist/tooltip.d.ts +3 -0
package/packages/viewer/dist/tooltip.js +154 -0
package/packages/viewer/dist/types.d.ts +256 -0
package/packages/viewer/dist/types.js +1 -0
package/packages/viewer/dist/viewer-state.d.ts +19 -0
package/packages/viewer/dist/viewer-state.js +162 -0
package/packages/viewer/dist/viewer.d.ts +2 -0
package/packages/viewer/dist/viewer.js +1156 -0

package/LICENSE.md ADDED Viewed

@@ -0,0 +1,5 @@
+Copyright 2026 Hanjo Winter
+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.
+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 ADDED Viewed

@@ -0,0 +1,250 @@
+# WorldOrbit
+**WorldOrbit is a text-first DSL, atlas viewer, and editor platform for fictional orbital systems.**
+Built for worldbuilders, sci-fi authors, game designers, and hobbyists, WorldOrbit makes it easy to design, visualize, and share complex stellar systems without getting tangled in node-spaghetti or hard math.
+With `v2.5`, WorldOrbit provides a production-ready authoring baseline that turns simple text into interactive, beautiful system atlases.
+## Why WorldOrbit?
+- **Text-First & Git-Friendly**: Write your systems in a simple, human-readable Domain Specific Language (DSL). Perfect for version control and Markdown integration.
+- **Relational by Position**: No complex edge types or manual graph drawing. You define where an object is (`orbit`, `at`, `surface`, `free`), and the relationships emerge naturally.
+- **Lore Meets Data**: An intuitive `info` block allows you to attach narrative metadata (factions, population, climate) directly to the physical bodies.
+- **Beautiful Results**: The built-in viewer renders your text into interactive SVG atlases with themes, viewpoints, and rich tooltips.
+## ⚡ Quick Example
+Here is how simple it is to build a star system:
+```worldorbit
+schema 2.0
+system Iyath
+  title "Iyath System"
+defaults
+  view isometric
+  scale presentation
+  preset atlas-card
+  theme atlas
+star Iyath
+planet Naar
+  orbit Iyath
+  semiMajor 1.18au
+  period 412d
+  info
+    faction "Veyrathische Republik"
+    population "8.4 billion"
+    description "Heimatwelt der Enari."
+```
+## The Studio Editor
+The easiest way to get started is the **WorldOrbit Studio**, our browser-based authoring environment.
+Capabilities include:
+- Interactive 2D stage with themes (`atlas`, `nightglass`, `ember`).
+- Live inspector editing for system defaults, viewpoints, annotations, and object properties.
+- Direct manipulation handles for `orbit`, `at`, `surface`, and `free` placements.
+- Split-pane view with live source synchronization.
+- Export to static SVG or interactive Embeds.
+**[Try the browser demo](/demo/index.html)**
+**[Open Studio Editor](/studio/index.html)**
+---
+## Quick Setup (Browser/CDN)
+You don't need a Node.js project to use WorldOrbit. You can drop it directly into any HTML file using our pre-built bundles! Let WorldOrbit parse your data and initialize an interactive atlas directly from a single script block.
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <style>
+      #view { width: 100vw; height: 100vh; }
+    </style>
+    <!-- Include WorldOrbit pre-bundled library -->
+    <script src="https://unpkg.com/worldorbit@2.5.2/dist/unpkg/worldorbit.min.js"></script>
+  </head>
+  <body>
+    <div id="view"></div>
+    <script>
+      const source = `
+        system Iyath
+        star Iyath
+        planet Naar orbit Iyath distance 1.18au period 412d
+      `;
+      const parsed = WorldOrbit.loadWorldOrbitSource(source);
+      WorldOrbit.createInteractiveViewer(document.getElementById('view'), {
+        document: parsed.document
+      });
+    </script>
+  </body>
+</html>
+```
+---
+## For Developers: The Ecosystem
+Under the hood, WorldOrbit is a monorepo offering several packages to integrate orbital worldbuilding into your own tools, games, or sites.
+### `@worldorbit/core`
+The engine room. Use `core` when you need language tooling, schema conversion, diagnostics, or scene generation.
+- Parsing, normalization, validation, and AST generation.
+- Turn WorldOrbit source into a structured document and stable render scene.
+<details>
+<summary><b>Show Example Usage</b></summary>
+```ts
+import {
+  formatDocument,
+  loadWorldOrbitSource,
+  parse,
+  parseWorldOrbitAtlas,
+  renderDocumentToScene,
+  upgradeDocumentToV2,
+} from "@worldorbit/core";
+const stable = parse(`
+system Iyath
+star Iyath
+planet Naar orbit Iyath distance 1.18au
+`.trim());
+// Upgrade and format
+const atlasDocument = upgradeDocumentToV2(stable.document, { preset: "atlas-card" });
+const atlasSource = formatDocument(atlasDocument, { schema: "2.0" });
+// Load and render
+const loaded = loadWorldOrbitSource(atlasSource);
+const scene = renderDocumentToScene(loaded.document, {
+  projection: "isometric",
+  scaleModel: {
+    orbitDistanceMultiplier: 1.1,
+    bodyRadiusMultiplier: 1.15,
+  },
+});
+```
+</details>
+### `@worldorbit/viewer`
+The presentation layer. Use `viewer` for SVG output, atlas navigation, embeds, and browser interactivity.
+- Scene-based SVG rendering with theme presets (`atlas`, `nightglass`, `ember`).
+- Rich tooltip cards, layers, projections, and serialized state for embeds.
+<details>
+<summary><b>Show Example Usage</b></summary>
+```ts
+import { loadWorldOrbitSource } from "@worldorbit/core";
+import {
+  createAtlasViewer,
+  createInteractiveViewer,
+  renderSceneToSvg,
+} from "@worldorbit/viewer";
+const loaded = loadWorldOrbitSource(source);
+const scene = renderDocumentToScene(loaded.document, {
+  projection: "isometric",
+});
+const svg = renderSceneToSvg(scene, {
+  theme: "atlas",
+  preset: "atlas-card",
+});
+// High-level atlas with search, filters, and viewpoints
+const atlasViewer = createAtlasViewer(document.getElementById("atlas"), {
+  source,
+  theme: "atlas",
+});
+```
+</details>
+### `@worldorbit/markdown`
+The publishing bridge. Use `markdown` to transform fenced `worldorbit` blocks into static or hydrated atlas output.
+- Remark/Rehype plugins to parse and render `.md` files.
+- Modes for inline static SVGs or fully interactive serialised embeds.
+<details>
+<summary><b>Show Example Usage</b></summary>
+```ts
+import rehypeStringify from "rehype-stringify";
+import remarkParse from "remark-parse";
+import remarkRehype from "remark-rehype";
+import { unified } from "unified";
+import { remarkWorldOrbit } from "@worldorbit/markdown";
+const html = String(
+  await unified()
+    .use(remarkParse)
+    .use(remarkWorldOrbit, { mode: "interactive" })
+    .use(remarkRehype, { allowDangerousHtml: true })
+    .use(rehypeStringify, { allowDangerousHtml: true })
+    .process(markdownSource),
+);
+```
+</details>
+### `@worldorbit/editor`
+The authoring component. Use `editor` when you want a browser-based authoring surface that roundtrips to canonical `schema 2.0`.
+- The foundation of the Studio app, exposing `createWorldOrbitEditor(...)`.
+<details>
+<summary><b>Show Example Usage</b></summary>
+```ts
+import { createWorldOrbitEditor } from "@worldorbit/editor";
+const editor = createWorldOrbitEditor(document.getElementById("studio"), {
+  source,
+  showInspector: true,
+  showTextPane: true,
+  showPreview: true,
+});
+```
+</details>
+---
+## Installation & Build
+Want to build WorldOrbit locally or contribute to the packages?
+```bash
+# Install dependencies
+npm install
+# Build all packages locally
+npm run build
+# Run tests
+npm test
+```
+The workspace builds package outputs into `packages/*/dist` and refreshes local package shims in `node_modules/@worldorbit/...` for seamless package-style development.
+### Development Notes
+- `npm run build` compiles all packages and refreshes local package shims.
+- `npm test` rebuilds first, then runs the Node and jsdom-based regression suite.
+- **Parser-first**: The repository guarantees that rendering and atlas interaction always stay downstream of parse, normalize, and validate.
+---
+## Documentation & Resources
+- API inventory: [docs/api-inventory.md](docs/api-inventory.md)
+- Changelog: [docs/changelog.md](docs/changelog.md)
+### Examples
+You can find various example atlases and markdown files in the [`examples/`](examples/) directory, showcasing minimal setups, complex systems, and markdown integrations.