bevy-ts 0.1.0-alpha.7 → 0.1.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bevy-ts",
-  "version": "0.1.0-alpha.7",
+  "version": "0.1.0-alpha.9",
   "description": "TypeScript for Bevy: components, systems and hot reload without recompiling Rust",
   "license": "MIT OR Apache-2.0",
   "repository": {
@@ -59,11 +59,11 @@
     "examples"
   ],
   "optionalDependencies": {
-    "@bevy-ts/darwin-arm64": "0.1.0-alpha.7",
-    "@bevy-ts/darwin-x64": "0.1.0-alpha.7",
-    "@bevy-ts/linux-arm64": "0.1.0-alpha.7",
-    "@bevy-ts/linux-x64": "0.1.0-alpha.7",
-    "@bevy-ts/win32-x64": "0.1.0-alpha.7"
+    "@bevy-ts/darwin-arm64": "0.1.0-alpha.9",
+    "@bevy-ts/darwin-x64": "0.1.0-alpha.9",
+    "@bevy-ts/linux-arm64": "0.1.0-alpha.9",
+    "@bevy-ts/linux-x64": "0.1.0-alpha.9",
+    "@bevy-ts/win32-x64": "0.1.0-alpha.9"
   },
   "devDependencies": {
     "json-schema-to-typescript": "^15.0.4",

package/protocol.d.ts

@@ -1,7 +1,7 @@
 // @generated by packages/bevy-ts/scripts/gen-protocol.mjs from protocol/bevy-ts.openrpc.json. Do not edit.
 
 /** The protocol version these types describe. */
-export const PROTOCOL_VERSION: "1.20.0";
+export const PROTOCOL_VERSION: "1.23.0";
 
 /**
  * An entity id: Entity::to_bits.
@@ -52,6 +52,13 @@ export type TsxNodeId = string;
  * via the `definition` "TsxProvenance".
  */
 export type TsxProvenance = "controlled" | "initial" | "default" | "bound" | "override";
+/**
+ * (1.21) Why a level entry is a placeholder: no live code registers the type (`unregistered`), its code threw or the TS build failed (`failed`), or saved fields or props do not fit live code (`mismatch`).
+ *
+ * This interface was referenced by `ProtocolTypes`'s JSON-Schema
+ * via the `definition` "MissingReason".
+ */
+export type MissingReason = "unregistered" | "failed" | "mismatch";
 /**
  * A ViewportInput type.
  *
@@ -842,6 +849,20 @@ export interface TsxTreeNode {
      * Written in that file, rather than coming from a prefab, an included level or the scene's TSX.
      */
     written: boolean;
+    /**
+     * (1.21) One per placeholder entry on the entity: a component the level writes whose code is missing, failed or does not fit. Absent when there is none.
+     */
+    missing?: {
+      /**
+       * The name the level writes.
+       */
+      component: string;
+      reason: MissingReason;
+      /**
+       * (1.23) True when the component is the entity's own scene component, the one its row instances; absent for a patch component.
+       */
+      scene?: boolean;
+    }[];
   };
   /**
    * (1.15) The root the node is in.
@@ -2029,7 +2050,7 @@ export interface LevelNodeResult {
   source?: SourceLocation[];
   overrides: LevelOverride[];
   /**
-   * The scene component the entity instances, if any.
+   * The scene component the entity instances, if any; still named when it is a placeholder (1.21).
    */
   prefab?: string | null;
   /**
@@ -2037,9 +2058,13 @@ export interface LevelNodeResult {
    */
   props?: LevelProp[];
   /**
-   * (1.12) Components the file adds that the entity's prefab does not give, named as LevelOverride.component names them.
+   * (1.12) Components the file adds that the entity's prefab does not give, named as LevelOverride.component names them. (1.23) A placeholder patch component the file writes is listed too, by the name the file writes; the entity's own scene component never is.
    */
   patches?: string[];
+  /**
+   * (1.21) The entity's placeholder entries; absent when there is none.
+   */
+  missing?: MissingComponent[];
 }
 /**
  * One @prop of a scene component instance: its type, the value it takes, and whether the level sets it.
@@ -2074,6 +2099,72 @@ export interface SourceLocation1 {
   line: number;
   column: number;
 }
+/**
+ * (1.21) A component a level writes whose code is missing, failed or does not fit. Its saved text is kept in the file.
+ *
+ * This interface was referenced by `ProtocolTypes`'s JSON-Schema
+ * via the `definition` "MissingComponent".
+ */
+export interface MissingComponent {
+  /**
+   * The name the level writes (`game::Loot`).
+   */
+  component: string;
+  reason: MissingReason;
+  /**
+   * (1.23) True when the component is the entity's own scene component, the one it instances; absent for a patch component.
+   */
+  scene?: boolean;
+  /**
+   * One line of why.
+   */
+  message?: string;
+  /**
+   * Saved fields and props as written, each value its saved text; a prop keeps its `@`. A mismatch lists only the misfits.
+   */
+  fields: {
+    [k: string]: string;
+  };
+  location: SourceLocation2;
+  expected?: SourceLocation3;
+  /**
+   * mismatch: why each listed field or prop does not fit.
+   */
+  misfit?: {
+    [k: string]: string;
+  };
+  /**
+   * A missing scene component: the entries below it with no base of their own, kept and not spawned.
+   */
+  overrides?: {
+    /**
+     * The name path below the instance.
+     */
+    path: string[];
+    /**
+     * Its patches' saved text, keyed `Component.field`.
+     */
+    fields: {
+      [k: string]: string;
+    };
+  }[];
+}
+/**
+ * Where the level writes it.
+ */
+export interface SourceLocation2 {
+  file: string;
+  line: number;
+  column: number;
+}
+/**
+ * Where its code was expected: the throw, the file that did not build, or the declaration this process last saw live. Absent when unknown, as after a restart.
+ */
+export interface SourceLocation3 {
+  file: string;
+  line: number;
+  column: number;
+}
 /**
  * This interface was referenced by `ProtocolTypes`'s JSON-Schema
  * via the `definition` "LevelWriteParams".
@@ -2096,7 +2187,7 @@ export interface LevelWriteResult {
   file: string;
   status: "written" | "rebased" | "conflict" | "refused";
   /**
-   * conflict: `target removed` or `changed on disk`; refused: `not-found`, `prefab-internal`, `exists`, `invalid`, `internal` or `io`.
+   * conflict: `target removed` or `changed on disk`; refused: `not-found`, `prefab-internal`, `exists`, `invalid`, `internal` or `io`; (1.21) `missing`: a set, revert, set_prop or revert_prop on a placeholder component, `unknown`: a write of a type no live code registers.
    */
   reason?: string | null;
   message?: string | null;
@@ -2178,6 +2269,9 @@ export interface LevelWatchMessage {
    */
   id?: number | null;
   reason?: string | null;
+  /**
+   * failed: the errors; loaded (1.21): the level's diagnostics, a `warning:` per placeholder entry among them.
+   */
   diagnostics?: LevelDiagnostic[];
   opener?: LevelOpener1;
 }

package/runtime/jsx-runtime.js

@@ -376,6 +376,11 @@ class Computation extends Owner {
   }
 }
 
+/** An error as it crosses to Rust. */
+function errorRecord(e, location) {
+  return { message: e && e.message ? `${e.name || "Error"}: ${e.message}` : String(e), location: location || null, stack: e && e.stack ? String(e.stack) : null };
+}
+
 function reportError(e) {
   console.error(e && e.stack ? e.stack : String(e));
 }
@@ -702,19 +707,15 @@ export class TsxContext {
     return { $b: id, $s: site.id };
   }
 
-  /** One scene component instance, by name or `module#export`: its description, or null. */
+  /** One scene component instance, by name or `module#export`: its description, or the error it raised. */
   expand(name, props, at) {
     const C = hostSceneComponent ? hostSceneComponent(name) : null;
-    if (!C || typeof C.scene !== "function") {
-      this.error(new Error(`no scene component named ${name}`), at || null);
-      return null;
-    }
+    if (!C || typeof C.scene !== "function") return { failure: errorRecord(new Error(`no scene component named ${name}`), at) };
     try {
       const nodes = runScene(this, () => describe(create(C, props || {}, undefined, at, false), this));
-      return nodes[0] || null;
+      return { node: nodes[0] || null };
     } catch (e) {
-      this.error(e, (e && e.bevyTsLocation) || at || null);
-      return null;
+      return { failure: errorRecord(e, (e && e.bevyTsLocation) || at) };
     }
   }
 
@@ -757,7 +758,7 @@ export class TsxContext {
   }
 
   error(e, location) {
-    this.errors.push({ message: e && e.message ? `${e.name || "Error"}: ${e.message}` : String(e), location: location || null, stack: e && e.stack ? String(e.stack) : null });
+    this.errors.push(errorRecord(e, location));
   }
 
   /**
@@ -836,9 +837,13 @@ export class TsxContext {
       });
       // Scene component instances a Rust plugin (levels) asks for: described after this call's
       // computations started, so their bindings wait until the plugin has mounted them.
+      // Each failed item's own error goes beside it, not among the call's.
       const expanded = (payload.expand || []).map(([name, props, at]) => this.expand(name, props, at));
       const out = this.output();
-      if (payload.expand) out.expanded = expanded;
+      if (payload.expand) {
+        out.expanded = expanded.map((x) => x.node || null);
+        out.failures = expanded.map((x) => x.failure || null);
+      }
       return out;
     } finally {
       this.inCall = false;