@ignifx/core 0.11.0 → 0.13.0

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 (28) hide show
  1. package/dist/{environment-BCjfp1jB.js → environment-C9AjYJgV.js} +2 -2
  2. package/dist/{environment-BCjfp1jB.js.map → environment-C9AjYJgV.js.map} +1 -1
  3. package/dist/{ignifx-error-RpK-lWwE.js → ignifx-error-Dq2qJMkZ.js} +10 -3
  4. package/dist/ignifx-error-Dq2qJMkZ.js.map +1 -0
  5. package/dist/index.d.ts +142 -18
  6. package/dist/index.d.ts.map +1 -1
  7. package/dist/index.js +409 -89
  8. package/dist/index.js.map +1 -1
  9. package/dist/json-CzZZ6K4x.js +24 -0
  10. package/dist/json-CzZZ6K4x.js.map +1 -0
  11. package/dist/{material-plugin-CWtV7DkH.js → material-plugin-BOCB7Stt.js} +2 -2
  12. package/dist/{material-plugin-CWtV7DkH.js.map → material-plugin-BOCB7Stt.js.map} +1 -1
  13. package/dist/{post-effect-C42XJFmo.js → post-effect-BHl7U56q.js} +5 -4
  14. package/dist/post-effect-BHl7U56q.js.map +1 -0
  15. package/dist/{post-effect-compiler-pOvXae-i.js → post-effect-compiler-Dw6zW2cG.js} +3 -3
  16. package/dist/{post-effect-compiler-pOvXae-i.js.map → post-effect-compiler-Dw6zW2cG.js.map} +1 -1
  17. package/dist/{shader-material-B6wwFCKB.js → shader-material-BxQn9FT4.js} +2 -2
  18. package/dist/{shader-material-B6wwFCKB.js.map → shader-material-BxQn9FT4.js.map} +1 -1
  19. package/dist/{shader-material-C4VjLTfV.js → shader-material-DRZmqA_S.js} +10 -6
  20. package/dist/shader-material-DRZmqA_S.js.map +1 -0
  21. package/dist/{shader-pragma-qO9_6sTd.js → shader-pragma-DrFm5f5m.js} +2 -2
  22. package/dist/{shader-pragma-qO9_6sTd.js.map → shader-pragma-DrFm5f5m.js.map} +1 -1
  23. package/dist/{surface-shader-BaR7Kg-F.js → surface-shader-BgZchRBe.js} +4 -4
  24. package/dist/{surface-shader-BaR7Kg-F.js.map → surface-shader-BgZchRBe.js.map} +1 -1
  25. package/package.json +1 -1
  26. package/dist/ignifx-error-RpK-lWwE.js.map +0 -1
  27. package/dist/post-effect-C42XJFmo.js.map +0 -1
  28. package/dist/shader-material-C4VjLTfV.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -147,6 +147,8 @@ export declare const CoreErrorCode: {
147
147
  readonly hotReloadSchemaChanged: "IGX-0207";
148
148
  /** `app.hotReload.apply()` was called from inside a lifecycle callback. */
149
149
  readonly hotReloadInsideCallback: "IGX-0208";
150
+ /** A component class's `static requires` chain loops, through the class itself or a class it requires. */
151
+ readonly requiresCycle: "IGX-0209";
150
152
  /** A scene was instantiated before it had finished loading. */
151
153
  readonly sceneNotLoaded: "IGX-0301";
152
154
  /** Instantiating a scene would place an instance inside itself. */
@@ -211,7 +213,11 @@ export declare const CoreErrorCode: {
211
213
  readonly schemaTypeMismatch: "IGX-0605";
212
214
  /** A value had the right type but fell outside its schema field's declared value domain. */
213
215
  readonly schemaOutOfRange: "IGX-0606";
214
- /** A schema declaration or a property bag named a field the schema does not declare. */
216
+ /**
217
+ * A property bag named a field the schema does not declare, or a schema declaration named a field
218
+ * it may not use: not identifier-like, a `Component`/`Script` member, or an `Object.prototype`
219
+ * member such as `constructor` or `__proto__`.
220
+ */
215
221
  readonly schemaUnknownField: "IGX-0607";
216
222
  /** A scene file failed structural validation against the generated scene-file JSON Schema. */
217
223
  readonly sceneFileInvalid: "IGX-0608";
@@ -1892,6 +1898,10 @@ interface ComponentClassInfo {
1892
1898
  readonly requires: readonly ComponentType[];
1893
1899
  /** `false` when at most one instance may live on an entity. */
1894
1900
  readonly allowMultiple: boolean;
1901
+ /** The class's own `static title`, or `null` when it declares none (an inherited one is ignored). */
1902
+ readonly title: string | null;
1903
+ /** The class's own `static description`, or `null` when it declares none (an inherited one is ignored). */
1904
+ readonly description: string | null;
1895
1905
  /**
1896
1906
  * The class and every component class it derives from, nearest first, ending at `Component`.
1897
1907
  * `world.components(Type)` and `getComponent(Type)` match against this list, which is why they
@@ -1953,7 +1963,9 @@ export declare class ComponentRegistry {
1953
1963
  * an id is kept, and {@link ComponentRegistry.registrarOf} reports it.
1954
1964
  * @returns What the registry worked out about the class.
1955
1965
  * @throws IgnifxError with code `IGX-0203` when the id is already registered by another class, or
1956
- * when the id is not `<namespace>/<Name>`.
1966
+ * when the id is not `<namespace>/<Name>`, `IGX-0209` when the class's `static requires`
1967
+ * graph contains a cycle, and `IGX-0607` when its `static schema` names a field after an
1968
+ * `Object.prototype` member.
1957
1969
  */
1958
1970
  register(type: ConcreteComponentType, typeId?: string, registrar?: string): ComponentClassInfo;
1959
1971
  /**
@@ -1990,7 +2002,10 @@ export declare class ComponentRegistry {
1990
2002
  *
1991
2003
  * @param type - The replacement class. It must declare the `typeId` it replaces.
1992
2004
  * @returns The freshly built info for the replacement, and the class it replaced.
1993
- * @throws IgnifxError with code `IGX-0204` when the replacement declares no `typeId`.
2005
+ * @throws IgnifxError with code `IGX-0204` when the replacement declares no `typeId`,
2006
+ * `IGX-0209` when its `static requires` graph contains a cycle, and `IGX-0607` when its
2007
+ * `static schema` names a field after an `Object.prototype` member; in every case the registry is
2008
+ * left unchanged.
1994
2009
  *
1995
2010
  * @example
1996
2011
  * ```ts
@@ -2005,6 +2020,8 @@ export declare class ComponentRegistry {
2005
2020
  *
2006
2021
  * @param type - The component class.
2007
2022
  * @returns The cached class info.
2023
+ * @throws IgnifxError with code `IGX-0209` when the class's `static requires` graph contains a
2024
+ * cycle, and `IGX-0607` when its `static schema` names a field after an `Object.prototype` member.
2008
2025
  */
2009
2026
  describe(type: ComponentType): ComponentClassInfo;
2010
2027
  /**
@@ -3699,6 +3716,8 @@ export declare class Transform extends Component {
3699
3716
  #private;
3700
3717
  /** The registration id of the one component every entity carries. */
3701
3718
  static typeId: string;
3719
+ /** What the component does, in one line, for an inspector. */
3720
+ static description: string;
3702
3721
  /** An entity has exactly one transform. */
3703
3722
  static allowMultiple: boolean;
3704
3723
  /** Creates an unbound transform. The entity constructor binds it to a Lite node immediately. */
@@ -4099,6 +4118,14 @@ interface SchemaDescription {
4099
4118
  * prop by prop. Absent on every other component and on file formats.
4100
4119
  */
4101
4120
  readonly builtIn?: boolean;
4121
+ /**
4122
+ * The components the class lists in `static requires`, as type ids (`null` for a class without a
4123
+ * `typeId`), in declaration order. `addComponent` adds each one that is missing, so an editor adds
4124
+ * them itself, and a scene file may list them in any order. A component on the entity whose class
4125
+ * extends a required class counts as present. Set by {@link describeRegisteredSchemas}, or by the
4126
+ * caller through {@link SchemaDescriptionMeta}; absent when the class requires nothing.
4127
+ */
4128
+ readonly requires?: readonly (string | null)[];
4102
4129
  }
4103
4130
  /**
4104
4131
  * Optional overrides for {@link describeSchema}.
@@ -4118,6 +4145,8 @@ interface SchemaDescriptionMeta {
4118
4145
  readonly package?: string;
4119
4146
  /** Whether the component is the entity's own built-in block, copied onto the description. */
4120
4147
  readonly builtIn?: boolean;
4148
+ /** The type ids of the components the class requires, copied onto the description. */
4149
+ readonly requires?: readonly (string | null)[];
4121
4150
  }
4122
4151
  /**
4123
4152
  * A JSON Schema fragment. Kept as a plain JSON object because the generated document is assembled
@@ -4139,7 +4168,7 @@ type JsonSchemaObject = JsonObject;
4139
4168
  * @param typeId - The component's namespaced registration id, for example `mygame/Mover`.
4140
4169
  * @param schema - The component's declared fields.
4141
4170
  * @param meta - Overrides for the title, format grouping, and summary, and the component's
4142
- * `allowMultiple`, `package` and `builtIn` when the caller knows them.
4171
+ * `allowMultiple`, `package`, `builtIn` and `requires` when the caller knows them.
4143
4172
  * @returns The description entry.
4144
4173
  *
4145
4174
  * @example
@@ -4489,7 +4518,11 @@ export declare const SchemaIssueCode: {
4489
4518
  readonly typeMismatch: "IGX-0605";
4490
4519
  /** A value had the right type but fell outside the field's declared value domain. */
4491
4520
  readonly outOfRange: "IGX-0606";
4492
- /** A property was supplied that the schema does not declare. */
4521
+ /**
4522
+ * A property was supplied that the schema does not declare, or a schema declaration named a field
4523
+ * it may not use: not identifier-like, a `Component`/`Script` member, or an `Object.prototype`
4524
+ * member such as `constructor` or `__proto__`.
4525
+ */
4493
4526
  readonly unknownField: "IGX-0607";
4494
4527
  };
4495
4528
  /**
@@ -4928,8 +4961,8 @@ export declare abstract class Script extends Component {
4928
4961
  * @typeParam S - The schema being declared.
4929
4962
  * @param schema - The field definitions, keyed by the property name they become.
4930
4963
  * @returns An abstract class to extend.
4931
- * @throws IgnifxError with code `IGX-0607` when a field name is not identifier-like or collides
4932
- * with a `Component`/`Script` member.
4964
+ * @throws IgnifxError with code `IGX-0607` when a field name is not identifier-like, collides
4965
+ * with a `Component`/`Script` member, or names an `Object.prototype` member such as `constructor`.
4933
4966
  *
4934
4967
  * @example
4935
4968
  * ```ts
@@ -9430,6 +9463,8 @@ export declare class Camera extends Component implements ComponentHooks {
9430
9463
  #private;
9431
9464
  /** The namespaced registration id. */
9432
9465
  static typeId: string;
9466
+ /** What the component does, in one line, for an inspector. */
9467
+ static description: string;
9433
9468
  /** At most one camera per entity: two views from one transform would be the same view. */
9434
9469
  static allowMultiple: boolean;
9435
9470
  /** The serialized field declarations (ADR-0004). */
@@ -9591,6 +9626,15 @@ interface InstantiateSceneOptions {
9591
9626
  readonly rootEntity?: Entity | null;
9592
9627
  /** `true` turns an `IGX-0604` hash mismatch from a diagnostic into a throw. */
9593
9628
  readonly strictInstanceHashes?: boolean;
9629
+ /**
9630
+ * How an `entityRef` or `componentRef` resolves when the build made nothing with its uid: a uid
9631
+ * the file does not declare, or one of a component an instance's `remove` override deleted. A
9632
+ * tool that builds part of a larger document, such as an editor rebuilding one prefab instance,
9633
+ * resolves the rest of the document here, so the part decodes as the whole file would; this
9634
+ * includes a reference an instance's overrides hold. The uids the build made come first, and
9635
+ * `asset()` fields never use it. Omitted, such a reference is `null` with an `IGX-0602` issue.
9636
+ */
9637
+ readonly outsideReferences?: Pick<ReferenceDecoder, "entity" | "component">;
9594
9638
  }
9595
9639
  /**
9596
9640
  * What {@link instantiateScene} produced.
@@ -10940,7 +10984,8 @@ export declare class Entity {
10940
10984
  * @returns The attached component.
10941
10985
  * @throws IgnifxError with code `IGX-0202` when the class does not allow multiple instances and
10942
10986
  * the entity already has one, `IGX-0605`/`IGX-0606`/`IGX-0607` when `init` does not match the
10943
- * schema, and `IGX-0101` when the entity has been destroyed.
10987
+ * schema, `IGX-0209` when the class's `static requires` graph contains a cycle, and `IGX-0101`
10988
+ * when the entity has been destroyed.
10944
10989
  */
10945
10990
  addComponent<T extends Component>(type: ConcreteComponentType<T>, init?: ComponentInit<T>): T;
10946
10991
  /**
@@ -11176,8 +11221,8 @@ export declare abstract class Component implements SignalOwner {
11176
11221
  * @typeParam S - The schema being declared.
11177
11222
  * @param schema - The field definitions, keyed by the property name they become.
11178
11223
  * @returns An abstract class to extend.
11179
- * @throws IgnifxError with code `IGX-0607` when a field name is not identifier-like or collides
11180
- * with a `Component`/`Script` member.
11224
+ * @throws IgnifxError with code `IGX-0607` when a field name is not identifier-like, collides
11225
+ * with a `Component`/`Script` member, or names an `Object.prototype` member such as `constructor`.
11181
11226
  *
11182
11227
  * @example
11183
11228
  * ```ts
@@ -11386,6 +11431,17 @@ interface ComponentStatics {
11386
11431
  readonly requires?: readonly ComponentType[];
11387
11432
  /** `false` when at most one instance may be attached to an entity; defaults to `true`. */
11388
11433
  readonly allowMultiple?: boolean;
11434
+ /**
11435
+ * The name an inspector shows for the component, for example `"Rigidbody mover"`. Read only from
11436
+ * the class that declares it, never inherited; without one, tools title the component from its
11437
+ * type id.
11438
+ */
11439
+ readonly title?: string;
11440
+ /**
11441
+ * A one-line summary of what the component does, shown by an inspector. Read only from the class
11442
+ * that declares it, never inherited.
11443
+ */
11444
+ readonly description?: string;
11389
11445
  }
11390
11446
  /**
11391
11447
  * The static members a script class may declare: everything {@link ComponentStatics} allows plus
@@ -11948,7 +12004,9 @@ interface HotReloadHost {
11948
12004
  * Applies replaced component classes to the running app.
11949
12005
  *
11950
12006
  * @param modules - The replaced modules and the classes they export.
11951
- * @returns What was reloaded.
12007
+ * @returns What was reloaded. A replacement the registry refuses — for example one whose
12008
+ * `static requires` loops (`IGX-0209`) — is collected in `errors`, and the class it would have
12009
+ * replaced stays registered.
11952
12010
  * @throws IgnifxError with code `IGX-0208` when called from inside a lifecycle callback, where a
11953
12011
  * half-swapped world would be observable.
11954
12012
  */
@@ -11959,7 +12017,7 @@ interface HotReloadHost {
11959
12017
  *
11960
12018
  * @param instance - The instance to rebuild. It is unloaded and a fresh one takes its place.
11961
12019
  * @returns The new instance.
11962
- * @throws IgnifxError with code `IGX-0209` when the instance was not built from a scene asset.
12020
+ * @throws IgnifxError with code `IGX-1506` when the instance was not built from a scene asset.
11963
12021
  */
11964
12022
  reloadScene(instance: SceneInstance): Promise<SceneInstance>;
11965
12023
  }
@@ -15970,6 +16028,8 @@ export declare class Environment extends Component implements ComponentHooks {
15970
16028
  #private;
15971
16029
  /** The namespaced registration id. */
15972
16030
  static typeId: string;
16031
+ /** What the component does, in one line, for an inspector. */
16032
+ static description: string;
15973
16033
  /** One per entity, and effectively one per world: the fields are all scene state. */
15974
16034
  static allowMultiple: boolean;
15975
16035
  /** The serialized field declarations (ADR-0004). */
@@ -16278,6 +16338,8 @@ export declare class Light extends Component implements ComponentHooks {
16278
16338
  #private;
16279
16339
  /** The namespaced registration id. */
16280
16340
  static typeId: string;
16341
+ /** What the component does, in one line, for an inspector. */
16342
+ static description: string;
16281
16343
  /** At most one light per entity: two lights from one transform want two entities. */
16282
16344
  static allowMultiple: boolean;
16283
16345
  /** The serialized field declarations (ADR-0004). */
@@ -17351,6 +17413,11 @@ export declare function meshFileJsonSchema(): JsonSchemaObject;
17351
17413
  * flag flips. That is `07-rendering.md` §2.3's rule, and the browser test asserts both halves: the
17352
17414
  * pixel returns to the clear colour, and the mesh is still in the scene.
17353
17415
  *
17416
+ * `displayHidden` hides the same way, and makes the clone unpickable too, but is not a field: scene
17417
+ * files do not save it, so a system
17418
+ * that chooses what is drawn without changing the document (a `LodGroup` in an edit-mode app,
17419
+ * ADR-0028) switches it instead of `enabled`.
17420
+ *
17354
17421
  * ## Decisions the documents left open
17355
17422
  *
17356
17423
  * - **The clone's Lite `id` is the entity's uid.** Lite's light include/exclude lists match on
@@ -17383,6 +17450,8 @@ export declare class MeshRenderer extends Component implements ComponentHooks {
17383
17450
  #private;
17384
17451
  /** The namespaced registration id. */
17385
17452
  static typeId: string;
17453
+ /** What the component does, in one line, for an inspector. */
17454
+ static description: string;
17386
17455
  /** Several renderers on one entity draw several meshes from one transform, which is useful. */
17387
17456
  static allowMultiple: boolean;
17388
17457
  /** The serialized field declarations (ADR-0004). */
@@ -17404,9 +17473,42 @@ export declare class MeshRenderer extends Component implements ComponentHooks {
17404
17473
  get lite(): {
17405
17474
  readonly mesh: LiteSceneNode | null;
17406
17475
  };
17476
+ /**
17477
+ * A display-only hide: while `true` the mesh is neither drawn nor picked, whatever `enabled` and
17478
+ * `pickable` say.
17479
+ *
17480
+ * @remarks
17481
+ * It is not a schema field, so scene files do not save it, a serializer never reads it, and
17482
+ * `enabled` keeps its authored value. That makes it the switch for a system that chooses what is
17483
+ * drawn without changing the document: `@ignifx/3d`'s `LodGroup` uses it in place of `enabled` in
17484
+ * an edit-mode app (ADR-0028). It starts `false` and takes effect at the next render sync;
17485
+ * {@link MeshRenderer.isVisible} reports the outcome. Lite's pickers ignore visibility, so the
17486
+ * clone is also made unpickable while hidden: `app.renderer.pickAsync` and `world.raycastRender`
17487
+ * neither return it nor let it occlude, as with `pickable: false`.
17488
+ *
17489
+ * It is one flag with one owner, not a count. In an edit-mode app the `LodGroup` that lists the
17490
+ * renderer as a level owns it: the group sets and clears it whenever it switches, so a value
17491
+ * written by anything else lasts only until then. A renderer belongs to at most one `LodGroup`; a
17492
+ * second group that lists it leaves it alone and warns with `IGX-1217`.
17493
+ *
17494
+ * @returns `true` while the mesh is hidden for display.
17495
+ *
17496
+ * @example
17497
+ * ```ts
17498
+ * renderer.displayHidden = true; // not drawn, and `renderer.enabled` is still `true`
17499
+ * ```
17500
+ */
17501
+ get displayHidden(): boolean;
17502
+ /**
17503
+ * Hides the mesh for display, or shows it again; `enabled` is not touched.
17504
+ *
17505
+ * @param value - `true` to hide it.
17506
+ */
17507
+ set displayHidden(value: boolean);
17407
17508
  /**
17408
17509
  * Whether the mesh is currently drawn: its own `enabled` flag and its entity's
17409
- * `activeInHierarchy`, materialised onto Lite's `visible`.
17510
+ * `activeInHierarchy`, less {@link MeshRenderer.displayHidden}, materialised onto Lite's
17511
+ * `visible`.
17410
17512
  *
17411
17513
  * @returns `true` when the clone is visible.
17412
17514
  */
@@ -17851,6 +17953,8 @@ export declare class InstancedMeshRenderer extends Component implements Componen
17851
17953
  #private;
17852
17954
  /** The namespaced registration id. */
17853
17955
  static typeId: string;
17956
+ /** What the component does, in one line, for an inspector. */
17957
+ static description: string;
17854
17958
  /** Several instanced renderers on one entity draw several clouds from one transform. */
17855
17959
  static allowMultiple: boolean;
17856
17960
  /** The serialized field declarations (ADR-0004). */
@@ -18001,6 +18105,8 @@ export declare class Model extends Component implements ComponentHooks {
18001
18105
  #private;
18002
18106
  /** The namespaced registration id. */
18003
18107
  static typeId: string;
18108
+ /** What the component does, in one line, for an inspector. */
18109
+ static description: string;
18004
18110
  /** One model per entity: a second instance under the same transform wants its own entity. */
18005
18111
  static allowMultiple: boolean;
18006
18112
  /** The serialized field declarations (ADR-0004). */
@@ -18258,6 +18364,8 @@ export declare class PostProcessStack extends Component implements ComponentHook
18258
18364
  #private;
18259
18365
  /** The namespaced registration id. */
18260
18366
  static typeId: string;
18367
+ /** What the component does, in one line, for an inspector. */
18368
+ static description: string;
18261
18369
  /** One chain per camera entity; a second would fight the first for the swapchain. */
18262
18370
  static allowMultiple: boolean;
18263
18371
  /** The serialized field declarations (ADR-0004). */
@@ -18443,7 +18551,8 @@ type EntityOverrideField = "name" | "active" | "static" | "layer" | "tags";
18443
18551
  *
18444
18552
  * @param path - The `path` string from the file.
18445
18553
  * @returns The parsed path.
18446
- * @throws IgnifxError with code `IGX-0609` when the path does not match the grammar.
18554
+ * @throws IgnifxError with code `IGX-0609` when the path does not match the grammar, or when a
18555
+ * property step is `__proto__`.
18447
18556
  *
18448
18557
  * @example
18449
18558
  * ```ts
@@ -18657,6 +18766,10 @@ interface SceneFileIssue {
18657
18766
  * (`CONSTITUTION.md` §2.3). The generated document remains the artefact the Vite plugin and editors
18658
18767
  * validate against; this is the same rule set, executable at load time.
18659
18768
  *
18769
+ * Two checks go beyond what JSON Schema can say: uids are unique within the file, and no two
18770
+ * overrides of one instance share an identity (path, `op`, and an added component's uid), both
18771
+ * reported as issues like any other.
18772
+ *
18660
18773
  * Component `props` are *not* checked here: `decodeProps` already reports every field problem with
18661
18774
  * a schema issue code, per field, which is more precise than a document-level match.
18662
18775
  *
@@ -18679,7 +18792,8 @@ export declare function validateSceneFile(value: unknown): readonly SceneFileIss
18679
18792
  /**
18680
18793
  * Describes every component an app has registered, the engine's, its extensions' and the game's,
18681
18794
  * the way {@link describeSchema} describes one, plus what only the registry knows: whether an
18682
- * entity may hold more than one (`allowMultiple`) and which package registered it (`package`).
18795
+ * entity may hold more than one (`allowMultiple`), which package registered it (`package`), and
18796
+ * which components it adds when they are missing (`requires`, its classes' type ids).
18683
18797
  * This is what an external inspector, such as the ignifx editor, is generated from.
18684
18798
  *
18685
18799
  * @remarks
@@ -18692,9 +18806,14 @@ export declare function validateSceneFile(value: unknown): readonly SceneFileIss
18692
18806
  * and marked `builtIn`, because every entity carries exactly one and a scene file stores it as the
18693
18807
  * entity's `transform` block rather than in its `components`.
18694
18808
  *
18809
+ * A component's `title` and `description` come from `curated` when it has an entry, else from the
18810
+ * class's own `static title` and `static description`, which is how an extension's components
18811
+ * reach an inspector with their curated names without the inspector importing the extension.
18812
+ *
18695
18813
  * @param registry - The registry to walk, usually `app.world.registry`.
18696
18814
  * @param curated - Titles, formats and summaries by type id, for example a package's own
18697
- * `describeSchemas()`; a component without an entry is titled from its type id.
18815
+ * `describeSchemas()`; an entry wins over the class's own `static title` and `static description`, and a component
18816
+ * with neither is titled from its type id.
18698
18817
  * @returns The descriptions, keyed by type id, in registration order.
18699
18818
  *
18700
18819
  * @example
@@ -18702,6 +18821,7 @@ export declare function validateSceneFile(value: unknown): readonly SceneFileIss
18702
18821
  * const schemas = describeRegisteredSchemas(app.world.registry, describeSchemas());
18703
18822
  * schemas["ignifx/Camera"]?.package; // "@ignifx/core"
18704
18823
  * schemas["ignifx/Camera"]?.allowMultiple; // false
18824
+ * schemas["ignifx/ThirdPersonController"]?.requires; // ["ignifx/CharacterController"] once @ignifx/3d is registered
18705
18825
  * ```
18706
18826
  *
18707
18827
  * @public
@@ -18963,6 +19083,8 @@ export declare function array<T>(item: FieldDefinition<T>, defaultValue?: readon
18963
19083
  * @param fields - The sub-fields.
18964
19084
  * @param options - Inspector and serializer metadata.
18965
19085
  * @returns The field definition.
19086
+ * @throws IgnifxError with code `IGX-0607` when a sub-field name is an `Object.prototype` member
19087
+ * such as `__proto__`, `constructor`, or `toString`.
18966
19088
  *
18967
19089
  * @example
18968
19090
  * ```ts
@@ -19075,8 +19197,10 @@ export declare function custom<T>(codec: CustomFieldCodec<T>, options?: FieldOpt
19075
19197
  *
19076
19198
  * @param fields - The field definitions, keyed by the property name they become.
19077
19199
  * @returns The same object, with its precise type preserved.
19078
- * @throws A `TypeError` when a field name is not identifier-like, starts with `_`, or collides with
19079
- * a `Component`/`Script` member such as `enabled` or `update`.
19200
+ * @throws IgnifxError with code `IGX-0607` when a field name is not identifier-like, starts with
19201
+ * `_`, collides with a `Component`/`Script` member such as `enabled` or `update`, or names an
19202
+ * `Object.prototype` member such as `constructor` or `toString`, or when `fields` is not a plain
19203
+ * object (a literal `__proto__: …` key sets its prototype rather than declaring a field).
19080
19204
  *
19081
19205
  * @example
19082
19206
  * ```ts