worldorbit 2.5.13 → 2.5.16

package/packages/core/dist/draft.d.ts

@@ -4,9 +4,12 @@ interface UpgradeOptions extends Pick<SceneRenderOptions, "preset" | "projection
 export declare function upgradeDocumentToV2(document: WorldOrbitDocument, options?: UpgradeOptions): WorldOrbitAtlasDocument;
 export declare function upgradeDocumentToDraftV2(document: WorldOrbitDocument, options?: UpgradeOptions): {
     version: "2.0-draft";
+    schemaVersion: "2.0-draft";
     format: "worldorbit";
     sourceVersion: import("./types.js").WorldOrbitDocumentVersion;
     system: WorldOrbitAtlasSystem | null;
+    groups: import("./types.js").WorldOrbitGroup[];
+    relations: import("./types.js").WorldOrbitRelation[];
     objects: WorldOrbitObject[];
     diagnostics: WorldOrbitDiagnostic[];
 };

package/packages/core/dist/draft.js

@@ -19,8 +19,11 @@ export function upgradeDocumentToV2(document, options = {}) {
     return {
         format: "worldorbit",
         version: "2.0",
+        schemaVersion: "2.0",
         sourceVersion: document.version,
         system,
+        groups: structuredClone(document.groups ?? []),
+        relations: structuredClone(document.relations ?? []),
         objects: document.objects.map(cloneWorldOrbitObject),
         diagnostics,
     };
@@ -33,6 +36,10 @@ export function materializeAtlasDocument(document) {
         ? {
             type: "system",
             id: document.system.id,
+            title: document.system.title,
+            description: document.system.description,
+            epoch: document.system.epoch,
+            referencePlane: document.system.referencePlane,
             properties: materializeDraftSystemProperties(document.system),
             info: materializeDraftSystemInfo(document.system),
         }
@@ -40,7 +47,10 @@ export function materializeAtlasDocument(document) {
     return {
         format: "worldorbit",
         version: "1.0",
+        schemaVersion: document.version,
         system,
+        groups: structuredClone(document.groups ?? []),
+        relations: structuredClone(document.relations ?? []),
         objects: document.objects.map(cloneWorldOrbitObject),
     };
 }
@@ -55,9 +65,12 @@ function createDraftSystem(document, defaults, atlasMetadata, annotations, diagn
     return {
         type: "system",
         id: document.system?.id ?? "WorldOrbit",
-        title: typeof document.system?.properties.title === "string"
+        title: document.system?.title ?? (typeof document.system?.properties.title === "string"
             ? document.system.properties.title
-            : null,
+            : null),
+        description: document.system?.description ?? null,
+        epoch: document.system?.epoch ?? null,
+        referencePlane: document.system?.referencePlane ?? null,
         defaults,
         atlasMetadata,
         viewpoints: scene.viewpoints.map(mapSceneViewpointToDraftViewpoint),
@@ -200,6 +213,27 @@ function mapSceneViewpointToDraftViewpoint(viewpoint) {
 function cloneWorldOrbitObject(object) {
     return {
         ...object,
+        groups: object.groups ? [...object.groups] : undefined,
+        resonance: object.resonance ? { ...object.resonance } : object.resonance,
+        renderHints: object.renderHints ? { ...object.renderHints } : object.renderHints,
+        deriveRules: object.deriveRules ? object.deriveRules.map((rule) => ({ ...rule })) : undefined,
+        validationRules: object.validationRules
+            ? object.validationRules.map((rule) => ({ ...rule }))
+            : undefined,
+        lockedFields: object.lockedFields ? [...object.lockedFields] : undefined,
+        tolerances: object.tolerances
+            ? object.tolerances.map((entry) => ({
+                field: entry.field,
+                value: entry.value && typeof entry.value === "object" && "value" in entry.value
+                    ? { value: entry.value.value, unit: entry.value.unit }
+                    : Array.isArray(entry.value)
+                        ? [...entry.value]
+                        : entry.value,
+            }))
+            : undefined,
+        typedBlocks: object.typedBlocks
+            ? Object.fromEntries(Object.entries(object.typedBlocks).map(([key, block]) => [key, { ...(block ?? {}) }]))
+            : undefined,
         properties: cloneProperties(object.properties),
         placement: object.placement ? structuredClone(object.placement) : null,
         info: { ...object.info },
@@ -255,6 +289,15 @@ function materializeDraftSystemProperties(system) {
     if (system.defaults.units) {
         properties.units = system.defaults.units;
     }
+    if (system.description) {
+        properties.description = system.description;
+    }
+    if (system.epoch) {
+        properties.epoch = system.epoch;
+    }
+    if (system.referencePlane) {
+        properties.referencePlane = system.referencePlane;
+    }
     return properties;
 }
 function materializeDraftSystemInfo(system) {
@@ -328,7 +371,7 @@ function serializeViewpointLayers(layers) {
     if (orbitFront !== undefined || orbitBack !== undefined) {
         tokens.push(orbitFront !== false || orbitBack !== false ? "orbits" : "-orbits");
     }
-    for (const key of ["background", "guides", "objects", "labels", "metadata"]) {
+    for (const key of ["background", "guides", "relations", "objects", "labels", "metadata"]) {
         if (layers[key] !== undefined) {
             tokens.push(layers[key] ? key : `-${key}`);
         }
@@ -339,5 +382,6 @@ function convertAtlasDocumentToLegacyDraft(document) {
     return {
         ...document,
         version: "2.0-draft",
+        schemaVersion: "2.0-draft",
     };
 }

package/packages/core/dist/format.js

@@ -37,29 +37,40 @@ const CANONICAL_FIELD_ORDER = [
 export function formatDocument(document, options = {}) {
     const schema = options.schema ?? "auto";
     const useDraft = schema === "2.0" ||
+        schema === "2.1" ||
         schema === "2.0-draft" ||
         document.version === "2.0" ||
+        document.version === "2.1" ||
         document.version === "2.0-draft";
     if (useDraft) {
         if (schema === "2.0-draft") {
             const legacyDraftDocument = document.version === "2.0-draft"
                 ? document
-                : document.version === "2.0"
+                : document.version === "2.0" || document.version === "2.1"
                     ? {
                         ...document,
                         version: "2.0-draft",
+                        schemaVersion: "2.0-draft",
                     }
                     : upgradeDocumentToDraftV2(document);
             return formatDraftDocument(legacyDraftDocument);
         }
-        const atlasDocument = document.version === "2.0"
+        const atlasDocument = document.version === "2.0" || document.version === "2.1"
             ? document
             : document.version === "2.0-draft"
                 ? {
                     ...document,
                     version: "2.0",
+                    schemaVersion: "2.0",
                 }
                 : upgradeDocumentToV2(document);
+        if (schema === "2.1" && atlasDocument.version !== "2.1") {
+            return formatAtlasDocument({
+                ...atlasDocument,
+                version: "2.1",
+                schemaVersion: "2.1",
+            });
+        }
         return formatAtlasDocument(atlasDocument);
     }
     const lines = [];
@@ -77,10 +88,18 @@ export function formatDocument(document, options = {}) {
     return lines.join("\n");
 }
 export function formatAtlasDocument(document) {
-    const lines = ["schema 2.0", ""];
+    const lines = [`schema ${document.version}`, ""];
     if (document.system) {
         lines.push(...formatAtlasSystem(document.system));
     }
+    for (const group of [...document.groups].sort(compareIdLike)) {
+        lines.push("");
+        lines.push(...formatAtlasGroup(group));
+    }
+    for (const relation of [...document.relations].sort(compareIdLike)) {
+        lines.push("");
+        lines.push(...formatAtlasRelation(relation));
+    }
     const sortedObjects = [...document.objects].sort(compareObjects);
     if (sortedObjects.length > 0 && lines.at(-1) !== "") {
         lines.push("");
@@ -99,11 +118,20 @@ export function formatDraftDocument(document) {
         : {
             ...document,
             version: "2.0-draft",
+            schemaVersion: "2.0-draft",
         };
     const lines = ["schema 2.0-draft", ""];
     if (legacy.system) {
         lines.push(...formatAtlasSystem(legacy.system));
     }
+    for (const group of [...legacy.groups].sort(compareIdLike)) {
+        lines.push("");
+        lines.push(...formatAtlasGroup(group));
+    }
+    for (const relation of [...legacy.relations].sort(compareIdLike)) {
+        lines.push("");
+        lines.push(...formatAtlasRelation(relation));
+    }
     const sortedObjects = [...legacy.objects].sort(compareObjects);
     if (sortedObjects.length > 0 && lines.at(-1) !== "") {
         lines.push("");
@@ -119,11 +147,38 @@ export function formatDraftDocument(document) {
 function formatSystem(system) {
     return formatLines("system", system.id, system.properties, null, system.info);
 }
+function formatLines(objectType, id, properties, placement, info) {
+    const lines = [`${objectType} ${id}`];
+    const fieldLines = [...formatPlacement(placement), ...formatProperties(properties)];
+    for (const fieldLine of fieldLines) {
+        lines.push(`  ${fieldLine}`);
+    }
+    const infoEntries = Object.entries(info).sort(([left], [right]) => left.localeCompare(right));
+    if (infoEntries.length > 0) {
+        if (fieldLines.length > 0) {
+            lines.push("");
+        }
+        lines.push("  info");
+        for (const [key, value] of infoEntries) {
+            lines.push(`    ${key} ${quoteIfNeeded(value)}`);
+        }
+    }
+    return lines;
+}
 function formatAtlasSystem(system) {
     const lines = [`system ${system.id}`];
     if (system.title) {
         lines.push(`  title ${quoteIfNeeded(system.title)}`);
     }
+    if (system.description) {
+        lines.push(`  description ${quoteIfNeeded(system.description)}`);
+    }
+    if (system.epoch) {
+        lines.push(`  epoch ${quoteIfNeeded(system.epoch)}`);
+    }
+    if (system.referencePlane) {
+        lines.push(`  referencePlane ${quoteIfNeeded(system.referencePlane)}`);
+    }
     lines.push("");
     lines.push("defaults");
     lines.push(`  view ${system.defaults.view}`);
@@ -158,18 +213,22 @@ function formatAtlasSystem(system) {
     return lines;
 }
 function formatObject(object) {
-    return formatLines(object.type, object.id, object.properties, object.placement, object.info);
+    return formatWorldOrbitObject(object.type, object.id, object);
 }
 function formatAtlasObject(object) {
-    return formatLines(`object ${object.type}`, object.id, object.properties, object.placement, object.info);
+    return formatWorldOrbitObject(`object ${object.type}`, object.id, object);
 }
-function formatLines(objectType, id, properties, placement, info) {
+function formatWorldOrbitObject(objectType, id, object) {
     const lines = [`${objectType} ${id}`];
-    const fieldLines = [...formatPlacement(placement), ...formatProperties(properties)];
+    const fieldLines = [
+        ...formatPlacement(object.placement),
+        ...formatProperties(object.properties),
+        ...formatObjectMetadata(object),
+    ];
     for (const fieldLine of fieldLines) {
         lines.push(`  ${fieldLine}`);
     }
-    const infoEntries = Object.entries(info).sort(([left], [right]) => left.localeCompare(right));
+    const infoEntries = Object.entries(object.info).sort(([left], [right]) => left.localeCompare(right));
     if (infoEntries.length > 0) {
         if (fieldLines.length > 0) {
             lines.push("");
@@ -179,6 +238,16 @@ function formatLines(objectType, id, properties, placement, info) {
             lines.push(`    ${key} ${quoteIfNeeded(value)}`);
         }
     }
+    for (const blockName of ["climate", "habitability", "settlement"]) {
+        const blockEntries = Object.entries(object.typedBlocks?.[blockName] ?? {}).sort(([left], [right]) => left.localeCompare(right));
+        if (blockEntries.length > 0) {
+            lines.push("");
+            lines.push(`  ${blockName}`);
+            for (const [key, value] of blockEntries) {
+                lines.push(`    ${key} ${quoteIfNeeded(value)}`);
+            }
+        }
+    }
     return lines;
 }
 function formatPlacement(placement) {
@@ -209,6 +278,46 @@ function formatProperties(properties) {
         .sort(compareFieldKeys)
         .map((key) => `${key} ${formatValue(properties[key])}`);
 }
+function formatObjectMetadata(object) {
+    const lines = [];
+    if (object.groups?.length) {
+        lines.push(`groups ${object.groups.join(" ")}`);
+    }
+    if (object.epoch) {
+        lines.push(`epoch ${quoteIfNeeded(object.epoch)}`);
+    }
+    if (object.referencePlane) {
+        lines.push(`referencePlane ${quoteIfNeeded(object.referencePlane)}`);
+    }
+    if (object.tidalLock !== undefined) {
+        lines.push(`tidalLock ${object.tidalLock ? "true" : "false"}`);
+    }
+    if (object.renderHints?.renderLabel !== undefined) {
+        lines.push(`renderLabel ${object.renderHints.renderLabel ? "true" : "false"}`);
+    }
+    if (object.renderHints?.renderOrbit !== undefined) {
+        lines.push(`renderOrbit ${object.renderHints.renderOrbit ? "true" : "false"}`);
+    }
+    if (object.renderHints?.renderPriority !== undefined) {
+        lines.push(`renderPriority ${object.renderHints.renderPriority}`);
+    }
+    if (object.resonance) {
+        lines.push(`resonance ${object.resonance.targetObjectId} ${object.resonance.ratio}`);
+    }
+    for (const rule of object.deriveRules ?? []) {
+        lines.push(`derive ${rule.field} ${rule.strategy}`);
+    }
+    for (const rule of object.validationRules ?? []) {
+        lines.push(`validate ${rule.rule}`);
+    }
+    if (object.lockedFields?.length) {
+        lines.push(`locked ${object.lockedFields.join(" ")}`);
+    }
+    for (const tolerance of object.tolerances ?? []) {
+        lines.push(`tolerance ${tolerance.field} ${formatValue(tolerance.value)}`);
+    }
+    return lines;
+}
 function formatAtlasViewpoint(viewpoint) {
     const lines = [`viewpoint ${viewpoint.id}`, `  label ${quoteIfNeeded(viewpoint.label)}`];
     if (viewpoint.focusObjectId) {
@@ -264,6 +373,50 @@ function formatAtlasAnnotation(annotation) {
     }
     return lines;
 }
+function formatAtlasGroup(group) {
+    const lines = [`group ${group.id}`, `  label ${quoteIfNeeded(group.label)}`];
+    if (group.summary) {
+        lines.push(`  summary ${quoteIfNeeded(group.summary)}`);
+    }
+    if (group.color) {
+        lines.push(`  color ${quoteIfNeeded(group.color)}`);
+    }
+    if (group.tags.length > 0) {
+        lines.push(`  tags ${group.tags.map(quoteIfNeeded).join(" ")}`);
+    }
+    if (group.hidden) {
+        lines.push("  hidden true");
+    }
+    return lines;
+}
+function formatAtlasRelation(relation) {
+    const lines = [`relation ${relation.id}`];
+    if (relation.from) {
+        lines.push(`  from ${quoteIfNeeded(relation.from)}`);
+    }
+    if (relation.to) {
+        lines.push(`  to ${quoteIfNeeded(relation.to)}`);
+    }
+    if (relation.kind) {
+        lines.push(`  kind ${quoteIfNeeded(relation.kind)}`);
+    }
+    if (relation.label) {
+        lines.push(`  label ${quoteIfNeeded(relation.label)}`);
+    }
+    if (relation.summary) {
+        lines.push(`  summary ${quoteIfNeeded(relation.summary)}`);
+    }
+    if (relation.tags.length > 0) {
+        lines.push(`  tags ${relation.tags.map(quoteIfNeeded).join(" ")}`);
+    }
+    if (relation.color) {
+        lines.push(`  color ${quoteIfNeeded(relation.color)}`);
+    }
+    if (relation.hidden) {
+        lines.push("  hidden true");
+    }
+    return lines;
+}
 function formatValue(value) {
     if (Array.isArray(value)) {
         return value.map((item) => quoteIfNeeded(item)).join(" ");
@@ -309,7 +462,7 @@ function formatDraftLayers(layers) {
             ? "orbits"
             : "-orbits");
     }
-    for (const key of ["background", "guides", "objects", "labels", "metadata"]) {
+    for (const key of ["background", "guides", "relations", "objects", "labels", "metadata"]) {
         if (layers[key] !== undefined) {
             tokens.push(layers[key] ? key : `-${key}`);
         }
@@ -334,6 +487,9 @@ function compareObjects(left, right) {
         return leftIndex - rightIndex;
     return left.id.localeCompare(right.id);
 }
+function compareIdLike(left, right) {
+    return left.id.localeCompare(right.id);
+}
 function objectTypeIndex(objectType) {
     switch (objectType) {
         case "star":

package/packages/core/dist/load.js

@@ -5,10 +5,11 @@ import { WorldOrbitError } from "./errors.js";
 import { normalizeDocument } from "./normalize.js";
 import { parseWorldOrbit } from "./parse.js";
 import { validateDocument } from "./validate.js";
-const ATLAS_SCHEMA_PATTERN = /^schema\s+2(?:\.0)?$/i;
+const ATLAS_SCHEMA_PATTERN = /^schema\s+2(?:\.0|\.1)?$/i;
+const ATLAS_SCHEMA_21_PATTERN = /^schema\s+2\.1$/i;
 const LEGACY_DRAFT_SCHEMA_PATTERN = /^schema\s+2\.0-draft$/i;
 export function detectWorldOrbitSchemaVersion(source) {
-    for (const line of source.split(/\r?\n/)) {
+    for (const line of stripCommentsForSchemaDetection(source).split(/\r?\n/)) {
         const trimmed = line.trim();
         if (!trimmed) {
             continue;
@@ -16,6 +17,9 @@ export function detectWorldOrbitSchemaVersion(source) {
         if (LEGACY_DRAFT_SCHEMA_PATTERN.test(trimmed)) {
             return "2.0-draft";
         }
+        if (ATLAS_SCHEMA_21_PATTERN.test(trimmed)) {
+            return "2.1";
+        }
         if (ATLAS_SCHEMA_PATTERN.test(trimmed)) {
             return "2.0";
         }
@@ -23,6 +27,49 @@ export function detectWorldOrbitSchemaVersion(source) {
     }
     return "1.0";
 }
+function stripCommentsForSchemaDetection(source) {
+    const chars = [...source];
+    let inString = false;
+    let inBlockComment = false;
+    for (let index = 0; index < chars.length; index++) {
+        const ch = chars[index];
+        const next = chars[index + 1];
+        if (inBlockComment) {
+            if (ch === "*" && next === "/") {
+                chars[index] = " ";
+                chars[index + 1] = " ";
+                inBlockComment = false;
+                index++;
+                continue;
+            }
+            if (ch !== "\n" && ch !== "\r") {
+                chars[index] = " ";
+            }
+            continue;
+        }
+        if (!inString && ch === "/" && next === "*") {
+            chars[index] = " ";
+            chars[index + 1] = " ";
+            inBlockComment = true;
+            index++;
+            continue;
+        }
+        if (!inString && ch === "#") {
+            chars[index] = " ";
+            let inner = index + 1;
+            while (inner < chars.length && chars[inner] !== "\n" && chars[inner] !== "\r") {
+                chars[inner] = " ";
+                inner++;
+            }
+            index = inner - 1;
+            continue;
+        }
+        if (ch === '"' && chars[index - 1] !== "\\") {
+            inString = !inString;
+        }
+    }
+    return chars.join("");
+}
 export function loadWorldOrbitSource(source) {
     const result = loadWorldOrbitSourceWithDiagnostics(source);
     if (!result.ok || !result.value) {
@@ -33,7 +80,7 @@ export function loadWorldOrbitSource(source) {
 }
 export function loadWorldOrbitSourceWithDiagnostics(source) {
     const schemaVersion = detectWorldOrbitSchemaVersion(source);
-    if (schemaVersion === "2.0" || schemaVersion === "2.0-draft") {
+    if (schemaVersion === "2.0" || schemaVersion === "2.0-draft" || schemaVersion === "2.1") {
         return loadAtlasSourceWithDiagnostics(source, schemaVersion);
     }
     let ast;
@@ -93,25 +140,23 @@ function loadAtlasSourceWithDiagnostics(source, schemaVersion) {
             diagnostics: [diagnosticFromError(error, "parse", "load.atlas.failed")],
         };
     }
-    let document;
-    try {
-        document = materializeAtlasDocument(atlasDocument);
-    }
-    catch (error) {
+    const atlasDiagnostics = [...atlasDocument.diagnostics];
+    if (atlasDiagnostics.some((diagnostic) => diagnostic.severity === "error")) {
         return {
             ok: false,
             value: null,
-            diagnostics: [diagnosticFromError(error, "normalize", "load.atlas.materialize.failed")],
+            diagnostics: atlasDiagnostics,
         };
     }
+    let document;
     try {
-        validateDocument(document);
+        document = materializeAtlasDocument(atlasDocument);
     }
     catch (error) {
         return {
             ok: false,
             value: null,
-            diagnostics: [diagnosticFromError(error, "validate", "load.atlas.validate.failed")],
+            diagnostics: [diagnosticFromError(error, "normalize", "load.atlas.materialize.failed")],
         };
     }
     const loaded = {
@@ -120,11 +165,11 @@ function loadAtlasSourceWithDiagnostics(source, schemaVersion) {
         document,
         atlasDocument,
         draftDocument: atlasDocument,
-        diagnostics: [...atlasDocument.diagnostics],
+        diagnostics: atlasDiagnostics,
     };
     return {
         ok: true,
         value: loaded,
-        diagnostics: [...atlasDocument.diagnostics],
+        diagnostics: atlasDiagnostics,
     };
 }

package/packages/core/dist/normalize.js

@@ -26,7 +26,10 @@ export function normalizeDocument(ast) {
     return {
         format: "worldorbit",
         version: "1.0",
+        schemaVersion: "1.0",
         system,
+        groups: [],
+        relations: [],
         objects,
     };
 }
@@ -41,6 +44,10 @@ function normalizeObject(node) {
         return {
             type: "system",
             id: node.name,
+            title: typeof properties.title === "string" ? properties.title : null,
+            description: null,
+            epoch: null,
+            referencePlane: null,
             properties,
             info,
         };