@carbonenginejs/runtime 0.1.0-alpha.0 → 0.1.0-alpha.1

package/docs/resource/reference/classes/core.md

@@ -1,236 +1,256 @@
-# Core class catalog
-
-Status: Evolving  
-Scope: `@carbonenginejs/runtime/resource` classes under `src/`, `src/resource`, and `src/resource/format/`
-Audience: Users, maintainers, and automated readers  
-Summary: Provides one-sentence purpose descriptors for the resource manager, registry, resource, source, and format/probe base classes.
-
-<!-- class:CjsMotherLode -->
-## `CjsMotherLode`
-
-Strong, deterministic resource registry that owns canonical path/variant identities and evicts entries only through explicit ownership removal, inactivity sweeps, or recorded-byte cache trimming, replacing Carbon's weak-live/strong-cache ownership transition.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/CjsMotherLode.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsResMan -->
-## `CjsResMan`
-
-GPU-free resource manager that resolves paths through registered sources and formats, publishes canonical resources into a `CjsMotherLode` registry under exact-owner generation guards, and drives the main/background work queues, read-operation caching, reload staging, and automatic purge policy.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/CjsResMan.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsResManWorkQueue -->
-## `CjsResManWorkQueue`
-
-Small FIFO executor used inside `CjsResMan` that tracks item ids, pause state, concurrency, cancellation, and sync/async completion while queue policy stays in the manager.
-
-- Export: None
-- Source: `src/resource/CjsResManWorkQueue.js`
-- Visibility: Internal
-- Kind: Internal implementation class
-
-<!-- class:CjsResource -->
-## `CjsResource`
-
-Base runtime resource handle that carries normalized path/extension/requirement identity, load state, and an attached CPU payload, with manager lifecycle callbacks supplied by `CjsResMan` after canonical insertion.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/CjsResource.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsLoadingObject -->
-## `CjsLoadingObject`
-
-Resource-compatible handler whose public loading result is the constructed object produced by an extension route.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/CjsLoadingObject.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsResManMainThreadLoader -->
-## `CjsResManMainThreadLoader`
-
-Direct execution strategy that reads through a structural source and invokes registered format facades on the caller thread.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/worker/CjsResManMainThreadLoader.js`
-- Visibility: Public
-- Kind: Adapted ccpwgl loader strategy
-
-<!-- class:CjsResManWorkerLoader -->
-## `CjsResManWorkerLoader`
-
-Browser module-worker strategy that correlates source/format requests, transfers owned buffers, propagates cancellation and fatal failure, and delegates unsupported operations to a main-thread loader.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/worker/CjsResManWorkerLoader.js`
-- Visibility: Public
-- Kind: Adapted ccpwgl loader strategy
-
-<!-- class:CjsResManWorker -->
-## `CjsResManWorker`
-
-Static browser-worker host that owns its operation/message vocabulary, executes clone-safe source and format operations, installs the message envelope, transfers owned buffers, and serializes failures for `CjsResMan`.
-
-- Export: `@carbonenginejs/runtime/resource/worker`
-- Source: `src/resource/worker/CjsResManWorker.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsResManFetchProvider -->
-## `CjsResManFetchProvider`
-
-`CjsResMan` provider that fetches an already-resolved URL on the caller thread or through the resource worker.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/CjsResManFetchProvider.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsBlueReader -->
-## `CjsBlueReader`
-
-Shared output and hydration backend for Blue persistence readers that owns common payload/runtime targets, reference emission, hydration adapter phases, reports, finalization, and schema-descriptor helpers, while transports keep framing and member decoding.
-
-- Export: None
-- Source: `src/resource/format/CjsBlueReader.js`
-- Visibility: Internal
-- Kind: Internal implementation class
-
-<!-- class:CjsFormat -->
-## `CjsFormat`
-
-Decorator-free base for every format facade. It owns normalized statics, boolean `is()` routing, structural `inspect()`, synchronous advisory `getSupport()`, exact asynchronous `verifySupport()`, and shared instance option handling.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/format/CjsFormat.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsReader -->
-## `CjsReader`
-
-Internal base for construction-bound readers that are created for one source and dropped after use, relying on garbage collection instead of explicit dispose/clear cleanup.
-
-- Export: None
-- Source: `src/resource/format/CjsReader.js`
-- Visibility: Internal
-- Kind: Internal implementation class
-
-<!-- class:CjsFormatRoute -->
-## `CjsFormatRoute`
-
-Captures one registered extension, content probe, reader, and output-capability route for format dispatch.
-
-- Export: `None`
-- Source: `src/resource/format/CjsFormatStore.js`
-- Visibility: Internal
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsFormatStore -->
-## `CjsFormatStore`
-
-Registers ordered content-aware format routes without coupling resource classes to concrete format implementations.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/format/CjsFormatStore.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsFormatReadError -->
-## `CjsFormatReadError`
-
-Error raised when shared binary format bytes cannot be decoded safely.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/CjsFormatError.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsFormatWriteError -->
-## `CjsFormatWriteError`
-
-Error raised when shared binary format bytes cannot be encoded safely.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/CjsFormatError.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsByteReader -->
-## `CjsByteReader`
-
-Little-endian cursor over resource bytes, with optional string-table arena resolution.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/CjsByteReader.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsByteWriter -->
-## `CjsByteWriter`
-
-Growable little-endian append cursor with reserve-and-patch support.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/CjsByteWriter.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
-
-<!-- class:CjsStringTable -->
-## `CjsStringTable`
-
-Carbon's compiled-effect string table: a deduplicated blob arena whose offsets are assigned by a bytewise sort rather than by insertion order.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/CjsStringTable.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsCarbonEffectBodyReader -->
-## `CjsCarbonEffectBodyReader`
-
-Plain byte cursor over one description blob, carrying the Carbon effect error class and message.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/carbonEffect/CjsCarbonEffectReader.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsCarbonEffectReader -->
-## `CjsCarbonEffectReader`
-
-Reader for Carbon's compiled-effect container at version 15.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/carbonEffect/CjsCarbonEffectReader.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsCarbonEffectWriter -->
-## `CjsCarbonEffectWriter`
-
-Builder for a Carbon compiled-effect container.
-
-- Export: `@carbonenginejs/runtime/resource/format`
-- Source: `src/resource/format/carbonEffect/CjsCarbonEffectWriter.js`
-- Visibility: Public
-- Kind: Adapted Carbon concept
-
-<!-- class:CjsResourceProbe -->
-## `CjsResourceProbe`
-
-Optional decorated resource-layer model for a plain format support report. It records recognition, the selected output, advisory or verified support, declared output capabilities, metadata, warnings, and structured errors, and exposes `canUseSelected()` and `canUse(output)`.
-
-- Export: `@carbonenginejs/runtime/resource`
-- Source: `src/resource/format/CjsResourceProbe.js`
-- Visibility: Public
-- Kind: Original CarbonEngineJS class
+# Core class catalog
+
+Status: Evolving  
+Scope: `@carbonenginejs/runtime/resource` classes under `src/`, `src/resource`, and `src/resource/format/`
+Audience: Users, maintainers, and automated readers  
+Summary: Provides one-sentence purpose descriptors for the resource manager, registry, resource, source, and format/probe base classes.
+
+<!-- class:CjsMotherLode -->
+## `CjsMotherLode`
+
+Strong, deterministic resource registry that owns canonical path/variant identities and evicts entries only through explicit ownership removal, inactivity sweeps, or recorded-byte cache trimming, replacing Carbon's weak-live/strong-cache ownership transition.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/CjsMotherLode.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsResMan -->
+## `CjsResMan`
+
+GPU-free resource manager that resolves paths through registered sources and formats, publishes canonical resources into a `CjsMotherLode` registry under exact-owner generation guards, and drives the main/background work queues, read-operation caching, reload staging, and automatic purge policy.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/CjsResMan.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsResManWorkQueue -->
+## `CjsResManWorkQueue`
+
+Small FIFO executor used inside `CjsResMan` that tracks item ids, pause state, concurrency, cancellation, and sync/async completion while queue policy stays in the manager.
+
+- Export: None
+- Source: `src/resource/CjsResManWorkQueue.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:CjsResource -->
+## `CjsResource`
+
+Base runtime resource handle that carries normalized path/extension/requirement identity, load state, and an attached CPU payload, with manager lifecycle callbacks supplied by `CjsResMan` after canonical insertion.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/CjsResource.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsLoadingObject -->
+## `CjsLoadingObject`
+
+Resource-compatible handler whose public loading result is the constructed object produced by an extension route.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/CjsLoadingObject.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsResManMainThreadLoader -->
+## `CjsResManMainThreadLoader`
+
+Direct execution strategy that reads through a structural source and invokes registered format facades on the caller thread.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/worker/CjsResManMainThreadLoader.js`
+- Visibility: Public
+- Kind: Adapted ccpwgl loader strategy
+
+<!-- class:CjsResManWorkerLoader -->
+## `CjsResManWorkerLoader`
+
+Browser module-worker strategy that correlates source/format requests, transfers owned buffers, propagates cancellation and fatal failure, and delegates unsupported operations to a main-thread loader.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/worker/CjsResManWorkerLoader.js`
+- Visibility: Public
+- Kind: Adapted ccpwgl loader strategy
+
+<!-- class:CjsResManWorker -->
+## `CjsResManWorker`
+
+Static browser-worker host that owns its operation/message vocabulary, executes clone-safe source and format operations, installs the message envelope, transfers owned buffers, and serializes failures for `CjsResMan`.
+
+- Export: `@carbonenginejs/runtime/resource/worker`
+- Source: `src/resource/worker/CjsResManWorker.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsResManFetchProvider -->
+## `CjsResManFetchProvider`
+
+`CjsResMan` provider that fetches an already-resolved URL on the caller thread or through the resource worker.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/CjsResManFetchProvider.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsBlueReader -->
+## `CjsBlueReader`
+
+Shared output and hydration backend for Blue persistence readers that owns common payload/runtime targets, reference emission, hydration adapter phases, reports, finalization, and schema-descriptor helpers, while transports keep framing and member decoding.
+
+- Export: None
+- Source: `src/resource/format/CjsBlueReader.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:CjsFormat -->
+## `CjsFormat`
+
+Decorator-free base for every format facade. It owns normalized statics, boolean `is()` routing, structural `inspect()`, synchronous advisory `getSupport()`, exact asynchronous `verifySupport()`, and shared instance option handling.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/format/CjsFormat.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsReader -->
+## `CjsReader`
+
+Internal base for construction-bound readers that are created for one source and dropped after use, relying on garbage collection instead of explicit dispose/clear cleanup.
+
+- Export: None
+- Source: `src/resource/format/CjsReader.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:CjsFormatRoute -->
+## `CjsFormatRoute`
+
+Captures one registered extension, content probe, reader, and output-capability route for format dispatch.
+
+- Export: `None`
+- Source: `src/resource/format/CjsFormatStore.js`
+- Visibility: Internal
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsFormatStore -->
+## `CjsFormatStore`
+
+Registers ordered content-aware format routes without coupling resource classes to concrete format implementations.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/format/CjsFormatStore.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsFormatReadError -->
+## `CjsFormatReadError`
+
+Error raised when shared binary format bytes cannot be decoded safely.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsFormatError.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsFormatRangeError -->
+## `CjsFormatRangeError`
+
+Error raised when a read would run past the end of its source, or resolve an out-of-range string-table offset.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsFormatError.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsFormatWriteError -->
+## `CjsFormatWriteError`
+
+Error raised when shared binary format bytes cannot be encoded safely.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsFormatError.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsByteReader -->
+## `CjsByteReader`
+
+Little-endian cursor over resource bytes, with optional string-table arena resolution.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsByteReader.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsBitReader -->
+## `CjsBitReader`
+
+LSB-first bit cursor over a byte range, shared by the Wwise Vorbis, Ogg packet, FBX deflate, and BC7 block readers.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsBitReader.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsByteWriter -->
+## `CjsByteWriter`
+
+Growable little-endian append cursor with reserve-and-patch support.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsByteWriter.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CjsStringTable -->
+## `CjsStringTable`
+
+Carbon's compiled-effect string table: a deduplicated blob arena whose offsets are assigned by a bytewise sort rather than by insertion order.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/CjsStringTable.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsCarbonEffectBodyReader -->
+## `CjsCarbonEffectBodyReader`
+
+Plain byte cursor over one description blob, carrying the Carbon effect error class and message.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/carbonEffect/CjsCarbonEffectReader.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsCarbonEffectReader -->
+## `CjsCarbonEffectReader`
+
+Reader for Carbon's compiled-effect container at version 15.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/carbonEffect/CjsCarbonEffectReader.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsCarbonEffectWriter -->
+## `CjsCarbonEffectWriter`
+
+Builder for a Carbon compiled-effect container.
+
+- Export: `@carbonenginejs/runtime/resource/format`
+- Source: `src/resource/format/carbonEffect/CjsCarbonEffectWriter.js`
+- Visibility: Public
+- Kind: Adapted Carbon concept
+
+<!-- class:CjsResourceProbe -->
+## `CjsResourceProbe`
+
+Optional decorated resource-layer model for a plain format support report. It records recognition, the selected output, advisory or verified support, declared output capabilities, metadata, warnings, and structured errors, and exposes `canUseSelected()` and `canUse(output)`.
+
+- Export: `@carbonenginejs/runtime/resource`
+- Source: `src/resource/format/CjsResourceProbe.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class