@carbonenginejs/runtime-resource 0.13.0 → 0.14.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 (453) hide show
  1. package/LICENSE +21 -21
  2. package/NOTICE +32 -32
  3. package/README.md +129 -129
  4. package/dist/CjsMotherLode.js +1271 -1271
  5. package/dist/CjsResMan.js +3858 -3858
  6. package/dist/CjsResManFetchProvider.js +94 -94
  7. package/dist/CjsResManWorkQueue.js +301 -301
  8. package/dist/_virtual/_rollupPluginBabelHelpers.js +150 -150
  9. package/dist/format/CjsBlueReader.js +358 -358
  10. package/dist/format/CjsByteReader.js +310 -310
  11. package/dist/format/CjsByteWriter.js +242 -242
  12. package/dist/format/CjsFormat.js +223 -223
  13. package/dist/format/CjsFormatError.js +41 -41
  14. package/dist/format/CjsReader.js +22 -22
  15. package/dist/format/CjsResourceProbe.js +279 -279
  16. package/dist/format/CjsStringTable.js +268 -268
  17. package/dist/format/carbonEffect/CjsCarbonEffectReader.js +265 -265
  18. package/dist/format/carbonEffect/CjsCarbonEffectWriter.js +373 -373
  19. package/dist/format/carbonEffect/buildCarbonEffectContainer.js +182 -182
  20. package/dist/format/carbonEffect/carbonEffectBackendBlock.js +321 -321
  21. package/dist/format/carbonEffect/carbonEffectRecords.js +1147 -1147
  22. package/dist/format/carbonEffect/carbonEffectResourceTransform.js +197 -197
  23. package/dist/format/compareUtf8.js +36 -36
  24. package/dist/format/effect/effectBodyInventory.js +146 -146
  25. package/dist/format/effect/effectPermutationGraph.js +257 -257
  26. package/dist/format/effect/sha256.js +114 -114
  27. package/dist/format/index.js +11 -11
  28. package/dist/format/payloadContract.js +193 -193
  29. package/dist/formats/black/CjsBlackFormat.js +310 -310
  30. package/dist/formats/black/core/CjsBlackBinaryReader.js +260 -260
  31. package/dist/formats/black/core/CjsBlackPropertyReaders.js +448 -448
  32. package/dist/formats/black/core/CjsBlackReader.js +764 -764
  33. package/dist/formats/black/core/CjsBlackSchemaRegistry.js +540 -540
  34. package/dist/formats/black/core/black-schema-v1-2026-07-23.json.js +4 -4
  35. package/dist/formats/black/core/blackConstants.js +7 -7
  36. package/dist/formats/black/core/blackDefinitions.js +10 -10
  37. package/dist/formats/black/core/blackEnums.js +6 -6
  38. package/dist/formats/black/core/blackSchema.js +3 -3
  39. package/dist/formats/black/core/blackVersion.js +22 -22
  40. package/dist/formats/black/core/helpers.js +199 -199
  41. package/dist/formats/black/core/schema.js +4 -4
  42. package/dist/formats/black/index.js +2 -2
  43. package/dist/formats/bnk/CjsBnkFormat.js +175 -175
  44. package/dist/formats/bnk/core/busNodes.js +252 -252
  45. package/dist/formats/bnk/core/effectNodes.js +147 -147
  46. package/dist/formats/bnk/core/eventAction.js +416 -416
  47. package/dist/formats/bnk/core/globalSettings.js +215 -215
  48. package/dist/formats/bnk/core/graph.js +137 -137
  49. package/dist/formats/bnk/core/helpers.js +512 -512
  50. package/dist/formats/bnk/core/musicNodes.js +540 -540
  51. package/dist/formats/bnk/core/nodeBase.js +553 -553
  52. package/dist/formats/bnk/core/sfxNodes.js +632 -632
  53. package/dist/formats/bnk/core/soundbanksInfo.js +209 -209
  54. package/dist/formats/bnk/index.js +2 -2
  55. package/dist/formats/cmf/CjsCmfFormat.js +497 -497
  56. package/dist/formats/cmf/core/binary.js +194 -194
  57. package/dist/formats/cmf/core/buffers.js +237 -237
  58. package/dist/formats/cmf/core/constants.js +47 -47
  59. package/dist/formats/cmf/core/gr2Anim.js +453 -453
  60. package/dist/formats/cmf/core/helpers.js +318 -318
  61. package/dist/formats/cmf/core/pack.js +276 -276
  62. package/dist/formats/cmf/core/schema.js +374 -374
  63. package/dist/formats/cmf/core/shared.js +277 -277
  64. package/dist/formats/cmf/core/writer.js +571 -571
  65. package/dist/formats/cmf/index.js +2 -2
  66. package/dist/formats/dds/CjsDdsFormat.js +200 -200
  67. package/dist/formats/dds/core/bc6h.js +298 -298
  68. package/dist/formats/dds/core/bc7.js +272 -272
  69. package/dist/formats/dds/core/helpers.js +901 -862
  70. package/dist/formats/dds/core/helpers.js.map +1 -1
  71. package/dist/formats/dds/index.js +2 -2
  72. package/dist/formats/dxbc/CjsDxbcFormat.js +187 -142
  73. package/dist/formats/dxbc/CjsDxbcFormat.js.map +1 -1
  74. package/dist/formats/dxbc/core/DxbcReader.js +266 -266
  75. package/dist/formats/dxbc/core/container.js +169 -169
  76. package/dist/formats/dxbc/core/decoder.js +789 -789
  77. package/dist/formats/dxbc/core/disassemble.js +240 -0
  78. package/dist/formats/dxbc/core/disassemble.js.map +1 -0
  79. package/dist/formats/dxbc/core/errors.js +19 -19
  80. package/dist/formats/dxbc/core/helpers.js +220 -220
  81. package/dist/formats/dxbc/core/opcodes.js +45 -45
  82. package/dist/formats/dxbc/core/program.js +91 -91
  83. package/dist/formats/dxbc/core/signature.js +172 -172
  84. package/dist/formats/dxbc/index.js +2 -2
  85. package/dist/formats/fbx/CjsFbxFormat.js +266 -266
  86. package/dist/formats/fbx/core/helpers.js +3932 -3932
  87. package/dist/formats/fbx/index.js +2 -2
  88. package/dist/formats/flac/CjsFlacFormat.js +142 -142
  89. package/dist/formats/flac/core/helpers.js +315 -315
  90. package/dist/formats/flac/index.js +2 -2
  91. package/dist/formats/gif/CjsGifFormat.js +141 -141
  92. package/dist/formats/gif/core/helpers.js +380 -380
  93. package/dist/formats/gif/index.js +2 -2
  94. package/dist/formats/gltf/CjsGltfFormat.js +252 -290
  95. package/dist/formats/gltf/CjsGltfFormat.js.map +1 -1
  96. package/dist/formats/gltf/core/helpers.js +287 -307
  97. package/dist/formats/gltf/core/helpers.js.map +1 -1
  98. package/dist/formats/gltf/core/json.js +79 -79
  99. package/dist/formats/gltf/core/parser.js +679 -679
  100. package/dist/formats/gltf/core/targets.js +173 -173
  101. package/dist/formats/gltf/index.js +2 -2
  102. package/dist/formats/gr2/CjsGr2Format.js +289 -289
  103. package/dist/formats/gr2/core/bitknit2.js +282 -282
  104. package/dist/formats/gr2/core/curves.js +1047 -1047
  105. package/dist/formats/gr2/core/gsf.js +72 -72
  106. package/dist/formats/gr2/core/helpers.js +352 -352
  107. package/dist/formats/gr2/core/json.js +622 -622
  108. package/dist/formats/gr2/core/oodle1.js +388 -388
  109. package/dist/formats/gr2/core/tangents.js +48 -48
  110. package/dist/formats/gr2/core/targets.js +361 -361
  111. package/dist/formats/gr2/index.js +2 -2
  112. package/dist/formats/hlsl/CjsHlslFormat.js +233 -254
  113. package/dist/formats/hlsl/CjsHlslFormat.js.map +1 -1
  114. package/dist/formats/hlsl/core/HlslBinaryUtils.js +15 -15
  115. package/dist/formats/hlsl/core/HlslEffectReadError.js +19 -19
  116. package/dist/formats/hlsl/core/HlslEffectStateManager.js +130 -130
  117. package/dist/formats/hlsl/core/HlslRenderStateSetup.js +37 -37
  118. package/dist/formats/hlsl/core/HlslResourceSetDescription.js +94 -94
  119. package/dist/formats/hlsl/core/HlslShaderBytecode.js +44 -44
  120. package/dist/formats/hlsl/core/analysis.js +51 -51
  121. package/dist/formats/hlsl/core/carbonDescriptionToRuntime.js +850 -850
  122. package/dist/formats/hlsl/core/detailMapFamily.js +128 -128
  123. package/dist/formats/hlsl/core/helpers.js +270 -270
  124. package/dist/formats/hlsl/core/json.js +284 -284
  125. package/dist/formats/hlsl/core/localLightFamily.js +133 -133
  126. package/dist/formats/hlsl/core/metadata.js +327 -327
  127. package/dist/formats/hlsl/core/render-states.js +280 -280
  128. package/dist/formats/hlsl/core/tr2/HlslRenderContextEnum.js +43 -43
  129. package/dist/formats/hlsl/core/tr2/resources/HlslEffectRes.js +320 -320
  130. package/dist/formats/hlsl/core/tr2/resources/HlslShaderPermutation.js +33 -33
  131. package/dist/formats/hlsl/core/tr2/shader/HlslEffectBindingManifest.js +423 -416
  132. package/dist/formats/hlsl/core/tr2/shader/HlslEffectBindingManifest.js.map +1 -1
  133. package/dist/formats/hlsl/core/tr2/shader/HlslEffectConstant.js +40 -40
  134. package/dist/formats/hlsl/core/tr2/shader/HlslEffectDescription.js +62 -62
  135. package/dist/formats/hlsl/core/tr2/shader/HlslEffectLibrary.js +52 -52
  136. package/dist/formats/hlsl/core/tr2/shader/HlslEffectParameterAnnotation.js +38 -38
  137. package/dist/formats/hlsl/core/tr2/shader/HlslEffectResource.js +50 -50
  138. package/dist/formats/hlsl/core/tr2/shader/HlslEffectStageInput.js +86 -86
  139. package/dist/formats/hlsl/core/tr2/shader/HlslEffectTechnique.js +31 -31
  140. package/dist/formats/hlsl/core/tr2/shader/HlslPass.js +42 -42
  141. package/dist/formats/hlsl/core/tr2/shader/HlslSamplerDescription.js +55 -55
  142. package/dist/formats/hlsl/core/tr2/shader/HlslSamplerSetup.js +29 -29
  143. package/dist/formats/hlsl/core/tr2/shader/HlslShader.js +220 -220
  144. package/dist/formats/hlsl/core/tr2/shader/HlslShaderOption.js +30 -30
  145. package/dist/formats/hlsl/index.js +3 -3
  146. package/dist/formats/index.js +33 -33
  147. package/dist/formats/jpeg/CjsJpegFormat.js +212 -212
  148. package/dist/formats/jpeg/core/helpers.js +402 -402
  149. package/dist/formats/jpeg/core/jpeg.js +480 -480
  150. package/dist/formats/jpeg/index.js +2 -2
  151. package/dist/formats/mp3/CjsMp3Format.js +197 -197
  152. package/dist/formats/mp3/core/helpers.js +375 -375
  153. package/dist/formats/mp3/index.js +2 -2
  154. package/dist/formats/mp4/CjsMp4Format.js +197 -197
  155. package/dist/formats/mp4/core/helpers.js +484 -484
  156. package/dist/formats/mp4/index.js +2 -2
  157. package/dist/formats/obj/CjsObjFormat.js +232 -253
  158. package/dist/formats/obj/CjsObjFormat.js.map +1 -1
  159. package/dist/formats/obj/core/helpers.js +553 -573
  160. package/dist/formats/obj/core/helpers.js.map +1 -1
  161. package/dist/formats/obj/core/json.js +64 -64
  162. package/dist/formats/obj/core/parser.js +321 -321
  163. package/dist/formats/obj/index.js +2 -2
  164. package/dist/formats/ogg/CjsOggFormat.js +143 -143
  165. package/dist/formats/ogg/core/helpers.js +410 -410
  166. package/dist/formats/ogg/core/imdct.js +178 -178
  167. package/dist/formats/ogg/core/vorbis.js +1017 -1017
  168. package/dist/formats/ogg/index.js +2 -2
  169. package/dist/formats/pickle/CjsPickleFormat.js +214 -214
  170. package/dist/formats/pickle/core/CjsPickleProtocol0Reader.js +551 -551
  171. package/dist/formats/pickle/index.js +2 -2
  172. package/dist/formats/png/CjsPngFormat.js +201 -201
  173. package/dist/formats/png/core/helpers.js +635 -635
  174. package/dist/formats/png/index.js +2 -2
  175. package/dist/formats/red/CjsRedFormat.js +263 -263
  176. package/dist/formats/red/core/CjsRedReader.js +246 -246
  177. package/dist/formats/red/core/blackDefinitions.js +3 -3
  178. package/dist/formats/red/core/helpers.js +158 -158
  179. package/dist/formats/red/core/redGraph.js +71 -71
  180. package/dist/formats/red/core/schema.js +4 -4
  181. package/dist/formats/red/index.js +2 -2
  182. package/dist/formats/stl/CjsStlFormat.js +320 -365
  183. package/dist/formats/stl/CjsStlFormat.js.map +1 -1
  184. package/dist/formats/stl/core/helpers.js +241 -261
  185. package/dist/formats/stl/core/helpers.js.map +1 -1
  186. package/dist/formats/stl/core/json.js +51 -51
  187. package/dist/formats/stl/core/stl.js +642 -642
  188. package/dist/formats/stl/core/targets.js +173 -173
  189. package/dist/formats/stl/index.js +2 -2
  190. package/dist/formats/tga/CjsTgaFormat.js +197 -197
  191. package/dist/formats/tga/core/helpers.js +493 -493
  192. package/dist/formats/tga/index.js +2 -2
  193. package/dist/formats/wav/CjsWavFormat.js +198 -198
  194. package/dist/formats/wav/core/helpers.js +365 -365
  195. package/dist/formats/wav/index.js +2 -2
  196. package/dist/formats/webgl/CjsWebglFormat.js +199 -199
  197. package/dist/formats/webgl/core/buildGlslEffectContainer.js +70 -70
  198. package/dist/formats/webgl/core/effectPackage.js +900 -900
  199. package/dist/formats/webgl/core/errors.js +27 -27
  200. package/dist/formats/webgl/core/glsl/DxbcGlslEmitter.js +2820 -2820
  201. package/dist/formats/webgl/core/glsl/DxbcGlslHelpers.js +89 -89
  202. package/dist/formats/webgl/core/glsl/DxbcGlslOperandFormatter.js +486 -486
  203. package/dist/formats/webgl/core/glsl/packedLightFixups.js +98 -98
  204. package/dist/formats/webgl/core/glslBackendBlock.js +552 -552
  205. package/dist/formats/webgl/core/glslBackendBodySet.js +243 -243
  206. package/dist/formats/webgl/core/glslEffectCompleteness.js +85 -85
  207. package/dist/formats/webgl/core/glslEffectCompleteness.js.map +1 -1
  208. package/dist/formats/webgl/core/helpers.js +167 -167
  209. package/dist/formats/webgl/core/inspectGlslEffectContainer.js +122 -122
  210. package/dist/formats/webgl/core/readGlslEffectContainer.js +202 -256
  211. package/dist/formats/webgl/core/readGlslEffectContainer.js.map +1 -1
  212. package/dist/formats/webgl/index.js +2 -2
  213. package/dist/formats/webgpu/CjsWebgpuFormat.js +357 -357
  214. package/dist/formats/webgpu/core/buildCarbonEffectContainer.js +89 -89
  215. package/dist/formats/webgpu/core/carbonWebgpu/CarbonWebgpuContainer.js +354 -354
  216. package/dist/formats/webgpu/core/carbonWebgpu/containerViews.js +355 -355
  217. package/dist/formats/webgpu/core/carbonWebgpu/validateContainer.js +90 -90
  218. package/dist/formats/webgpu/core/effectAnalysis.js +82 -82
  219. package/dist/formats/webgpu/core/effectBackendBodySet.js +306 -306
  220. package/dist/formats/webgpu/core/errors.js +20 -20
  221. package/dist/formats/webgpu/core/helpers.js +443 -443
  222. package/dist/formats/webgpu/core/ir/analyzeRegisterValues.js +212 -212
  223. package/dist/formats/webgpu/core/ir/buildControlFlow.js +220 -220
  224. package/dist/formats/webgpu/core/ir/indexableTemps.js +137 -137
  225. package/dist/formats/webgpu/core/ir/inferValueTypes.js +449 -449
  226. package/dist/formats/webgpu/core/ir/lowerDxbcToIr.js +494 -494
  227. package/dist/formats/webgpu/core/ir/resolveRegisterFlow.js +177 -177
  228. package/dist/formats/webgpu/core/ir/sourceLanes.js +61 -61
  229. package/dist/formats/webgpu/core/packageEffect.js +381 -381
  230. package/dist/formats/webgpu/core/packageEffectSelection.js +164 -164
  231. package/dist/formats/webgpu/core/packageMetadata.js +17 -17
  232. package/dist/formats/webgpu/core/schema.js +4 -4
  233. package/dist/formats/webgpu/core/wgsl/buildResourceTransformPlan.js +263 -263
  234. package/dist/formats/webgpu/core/wgsl/buildWgslBindingPlan.js +172 -172
  235. package/dist/formats/webgpu/core/wgsl/buildWgslSet.js +325 -325
  236. package/dist/formats/webgpu/core/wgsl/emitWgsl.js +356 -356
  237. package/dist/formats/webgpu/core/wgsl/hoistEscapingValues.js +77 -77
  238. package/dist/formats/webgpu/core/wgsl/lowerBindingLayout.js +451 -451
  239. package/dist/formats/webgpu/core/wgsl/lowerComputeProgram.js +735 -735
  240. package/dist/formats/webgpu/core/wgsl/lowerCreateHistogramsComputeProgram.js +457 -457
  241. package/dist/formats/webgpu/core/wgsl/lowerFragmentProgram.js +1572 -1572
  242. package/dist/formats/webgpu/core/wgsl/lowerMergeHistogramsComputeProgram.js +659 -659
  243. package/dist/formats/webgpu/core/wgsl/lowerParticleClearComputePrograms.js +734 -734
  244. package/dist/formats/webgpu/core/wgsl/lowerParticleEmitComputeProgram.js +583 -583
  245. package/dist/formats/webgpu/core/wgsl/lowerSkinVerticesComputeProgram.js +621 -621
  246. package/dist/formats/webgpu/core/wgsl/lowerSortComputeProgram.js +824 -824
  247. package/dist/formats/webgpu/core/wgsl/lowerSortInnerComputeProgram.js +697 -697
  248. package/dist/formats/webgpu/core/wgsl/lowerSortStepComputeProgram.js +559 -559
  249. package/dist/formats/webgpu/core/wgsl/lowerVertexProgram.js +1328 -1328
  250. package/dist/formats/webgpu/core/wgsl/particleEmitSemanticDigest.js +110 -110
  251. package/dist/formats/webgpu/core/wgsl/precisionControls.js +55 -55
  252. package/dist/formats/webgpu/core/wgsl/selectionPlans.js +717 -717
  253. package/dist/formats/webgpu/core/wgsl/uniformity.js +78 -78
  254. package/dist/formats/webgpu/core/wgsl/validateExactComputeIr.js +196 -196
  255. package/dist/formats/webgpu/core/wgsl/validateHandleOperand.js +37 -37
  256. package/dist/formats/webgpu/index.js +2 -2
  257. package/dist/formats/webm/CjsWebmFormat.js +197 -197
  258. package/dist/formats/webm/core/helpers.js +572 -572
  259. package/dist/formats/webm/index.js +2 -2
  260. package/dist/formats/webp/CjsWebpFormat.js +140 -140
  261. package/dist/formats/webp/core/helpers.js +237 -237
  262. package/dist/formats/webp/index.js +2 -2
  263. package/dist/formats/wem/CjsWemFormat.js +250 -250
  264. package/dist/formats/wem/core/bitStream.js +261 -261
  265. package/dist/formats/wem/core/codebookLibrary.js +164 -164
  266. package/dist/formats/wem/core/helpers.js +437 -437
  267. package/dist/formats/wem/core/packedCodebooksAotuv603.js +30 -30
  268. package/dist/formats/wem/core/ptadpcm.js +77 -77
  269. package/dist/formats/wem/core/resolve.js +121 -121
  270. package/dist/formats/wem/core/wemToOgg.js +485 -485
  271. package/dist/formats/wem/index.js +2 -2
  272. package/dist/formats/yaml/CjsYamlFormat.js +134 -134
  273. package/dist/formats/yaml/core/CjsYamlReader.js +400 -400
  274. package/dist/formats/yaml/core/helpers.js +196 -196
  275. package/dist/formats/yaml/index.js +2 -2
  276. package/dist/index.js +64 -64
  277. package/dist/resource/CjsLoadingObject.js +19 -19
  278. package/dist/resource/CjsResource.js +801 -801
  279. package/dist/resource/ResourceHandlerMode.js +14 -14
  280. package/dist/resource/Tr2LightProfileRes.js +32 -32
  281. package/dist/resource/audio/AudioGeometryResData.js +47 -47
  282. package/dist/resource/audio/CjsAudioBufferRes.js +86 -86
  283. package/dist/resource/audio/CjsAudioRes.js +213 -213
  284. package/dist/resource/audio/index.js +4 -4
  285. package/dist/resource/geometry/MeshDecalData.js +37 -37
  286. package/dist/resource/geometry/MeshDecalLodData.js +34 -34
  287. package/dist/resource/geometry/TriGeometryRes.js +675 -675
  288. package/dist/resource/geometry/TriGeometryResAreaData.js +59 -59
  289. package/dist/resource/geometry/TriGeometryResJointData.js +38 -38
  290. package/dist/resource/geometry/TriGeometryResLodData.js +88 -88
  291. package/dist/resource/geometry/TriGeometryResMeshData.js +63 -63
  292. package/dist/resource/geometry/TriGeometryResSkeletonData.js +34 -34
  293. package/dist/resource/geometry/TriJointBinding.js +38 -38
  294. package/dist/resource/geometry/TriMorphTargetGeometryConstants.js +46 -46
  295. package/dist/resource/geometry/TriRtGeometryConstants.js +88 -88
  296. package/dist/resource/geometry/granny/GStateBindingCallbackData.js +31 -31
  297. package/dist/resource/geometry/granny/Tr2GrannyIntersectionResult.js +60 -60
  298. package/dist/resource/geometry/granny/Tr2GrannyStateRes.js +36 -36
  299. package/dist/resource/geometry/granny/TriGrannyRes.js +35 -35
  300. package/dist/resource/geometry/granny/enums.js +10 -10
  301. package/dist/resource/geometry/granny/index.js +6 -6
  302. package/dist/resource/geometry/index.js +17 -17
  303. package/dist/resource/index.js +54 -54
  304. package/dist/resource/resourceBoundary.js +64 -64
  305. package/dist/resource/shader/Tr2EffectRes.js +336 -336
  306. package/dist/resource/shader/Tr2MaterialArea.js +31 -31
  307. package/dist/resource/shader/Tr2MaterialMesh.js +27 -27
  308. package/dist/resource/shader/Tr2MaterialRes.js +31 -31
  309. package/dist/resource/shader/Tr2Shader.js +283 -283
  310. package/dist/resource/shader/Tr2ShaderPermutation.js +43 -43
  311. package/dist/resource/shader/index.js +17 -17
  312. package/dist/resource/shader/reflection/Tr2EffectConstant.js +143 -143
  313. package/dist/resource/shader/reflection/Tr2EffectDefine.js +30 -30
  314. package/dist/resource/shader/reflection/Tr2EffectDescription.js +114 -114
  315. package/dist/resource/shader/reflection/Tr2EffectLibrary.js +168 -168
  316. package/dist/resource/shader/reflection/Tr2EffectParameterAnnotation.js +125 -125
  317. package/dist/resource/shader/reflection/Tr2EffectResource.js +120 -120
  318. package/dist/resource/shader/reflection/Tr2EffectStageInput.js +372 -372
  319. package/dist/resource/shader/reflection/Tr2EffectTechnique.js +78 -78
  320. package/dist/resource/shader/reflection/Tr2Pass.js +168 -168
  321. package/dist/resource/shader/reflection/carbonRecordFields.js +159 -159
  322. package/dist/resource/shader/reflection/shaderStage.js +22 -22
  323. package/dist/resource/shader/sampler/Tr2SamplerSetup.js +135 -135
  324. package/dist/resource/texture/CjsTextureArrayRes.js +472 -472
  325. package/dist/resource/texture/CjsTextureArrayResParameterProxy.js +179 -179
  326. package/dist/resource/texture/Tr2ImageRes.js +120 -120
  327. package/dist/resource/texture/Tr2TextureLodManager.js +82 -82
  328. package/dist/resource/texture/Tr2TextureLodUpdateRequest.js +37 -37
  329. package/dist/resource/texture/Tr2TexturePackChannel.js +37 -37
  330. package/dist/resource/texture/Tr2TexturePipeline.js +54 -54
  331. package/dist/resource/texture/Tr2TexturePipelineParams.js +34 -34
  332. package/dist/resource/texture/Tr2TexturePipelineStepCompress.js +40 -40
  333. package/dist/resource/texture/Tr2TexturePipelineStepGenerateMips.js +22 -22
  334. package/dist/resource/texture/Tr2TexturePipelineStepLimitSize.js +34 -34
  335. package/dist/resource/texture/Tr2TexturePipelineStepLoad.js +31 -31
  336. package/dist/resource/texture/Tr2TexturePipelineStepPack.js +43 -43
  337. package/dist/resource/texture/TriTextureRes.js +359 -359
  338. package/dist/resource/texture/index.js +15 -15
  339. package/dist/resource/texture/texturePipelineBehavior.js +308 -308
  340. package/dist/worker/CjsResManMainThreadLoader.js +89 -89
  341. package/dist/worker/CjsResManWorker.js +218 -218
  342. package/dist/worker/CjsResManWorkerLoader.js +437 -437
  343. package/dist/worker/protocol.js +12 -12
  344. package/docs/README.md +98 -98
  345. package/docs/architecture.md +118 -118
  346. package/docs/concepts/resource-lifecycle.md +226 -226
  347. package/docs/concepts/shader-resource-model.md +111 -111
  348. package/docs/concepts/writing-an-engine-adapter.md +115 -115
  349. package/docs/formats/README.md +138 -138
  350. package/docs/formats/carbon-effect-container.md +553 -553
  351. package/docs/formats/dxbc/README.md +68 -68
  352. package/docs/formats/dxbc/architecture.md +80 -80
  353. package/docs/formats/dxbc/reference/api.md +105 -77
  354. package/docs/formats/dxbc/reference/classes/README.md +9 -9
  355. package/docs/formats/dxbc/reference/decoded-output.md +122 -122
  356. package/docs/formats/gr2.md +160 -160
  357. package/docs/formats/hlsl/README.md +54 -54
  358. package/docs/formats/hlsl/architecture.md +66 -65
  359. package/docs/formats/hlsl/guides/hydrating-json-output.md +60 -60
  360. package/docs/formats/hlsl/guides/reading-effects.md +68 -64
  361. package/docs/formats/hlsl/reference/advanced-analysis.md +61 -61
  362. package/docs/formats/hlsl/reference/api.md +91 -92
  363. package/docs/formats/hlsl/reference/classes/README.md +11 -11
  364. package/docs/formats/hlsl/reference/json-graph.md +97 -97
  365. package/docs/formats/pickle.md +82 -82
  366. package/docs/formats/provenance.md +196 -196
  367. package/docs/formats/stl.md +37 -37
  368. package/docs/formats/webgl/README.md +115 -115
  369. package/docs/formats/webgl/architecture.md +69 -69
  370. package/docs/formats/webgl/carbon-constant-layouts.md +326 -326
  371. package/docs/formats/webgl/decl-io.md +1234 -1234
  372. package/docs/formats/webgl/memory-structured.md +890 -890
  373. package/docs/formats/webgl/reference/classes/README.md +9 -9
  374. package/docs/formats/webgl/texture-sample.md +964 -964
  375. package/docs/formats/webgpu/README.md +84 -84
  376. package/docs/formats/webgpu/architecture.md +95 -95
  377. package/docs/formats/webgpu/formats/carbon-webgpu.md +215 -215
  378. package/docs/formats/webgpu/guides/effect-packaging.md +189 -189
  379. package/docs/formats/webgpu/reference/api.md +196 -196
  380. package/docs/formats/webgpu/reference/classes/README.md +9 -9
  381. package/docs/formats/webgpu/reference/wgsl-compatibility.md +1546 -1546
  382. package/docs/formats/wwise.md +146 -146
  383. package/docs/reference/classes/README.md +35 -35
  384. package/docs/reference/classes/audio.md +30 -30
  385. package/docs/reference/classes/core.md +216 -216
  386. package/docs/reference/classes/dropped.md +46 -46
  387. package/docs/reference/classes/formats.md +944 -944
  388. package/docs/reference/classes/resources.md +456 -456
  389. package/docs/reference/classes/texture.md +26 -26
  390. package/docs/reference/events.md +117 -117
  391. package/docs/reference/motherlode-cache.md +275 -275
  392. package/docs/reference/queues.md +194 -194
  393. package/docs/reference/reload.md +107 -107
  394. package/docs/reference/texture-arrays.md +113 -113
  395. package/docs/reference/texture-pipeline.md +53 -53
  396. package/docs/reference/workers.md +142 -142
  397. package/docs/roadmap.md +150 -150
  398. package/format-notices/black/LICENSE +21 -21
  399. package/format-notices/black/NOTICE +47 -47
  400. package/format-notices/bnk/LICENSE +21 -21
  401. package/format-notices/bnk/NOTICE +21 -21
  402. package/format-notices/cmf/LICENSE +21 -21
  403. package/format-notices/cmf/NOTICE +36 -36
  404. package/format-notices/dds/LICENSE +21 -21
  405. package/format-notices/dds/NOTICE +14 -14
  406. package/format-notices/dxbc/LICENSE +21 -21
  407. package/format-notices/dxbc/NOTICE +20 -20
  408. package/format-notices/fbx/LICENSE +21 -21
  409. package/format-notices/fbx/NOTICE +14 -14
  410. package/format-notices/flac/LICENSE +21 -21
  411. package/format-notices/flac/NOTICE +14 -14
  412. package/format-notices/gif/LICENSE +21 -21
  413. package/format-notices/gif/NOTICE +14 -14
  414. package/format-notices/gltf/LICENSE +21 -21
  415. package/format-notices/gltf/NOTICE +27 -27
  416. package/format-notices/gr2/LICENSE +21 -21
  417. package/format-notices/gr2/NOTICE +60 -60
  418. package/format-notices/gr2/THIRD-PARTY-NOTICES.md +93 -93
  419. package/format-notices/hlsl/LICENSE +21 -21
  420. package/format-notices/hlsl/NOTICE +25 -25
  421. package/format-notices/jpeg/LICENSE +21 -21
  422. package/format-notices/jpeg/NOTICE +14 -14
  423. package/format-notices/mp3/LICENSE +21 -21
  424. package/format-notices/mp3/NOTICE +14 -14
  425. package/format-notices/mp4/LICENSE +21 -21
  426. package/format-notices/mp4/NOTICE +14 -14
  427. package/format-notices/obj/LICENSE +21 -21
  428. package/format-notices/obj/NOTICE +26 -26
  429. package/format-notices/ogg/LICENSE +21 -21
  430. package/format-notices/ogg/NOTICE +28 -28
  431. package/format-notices/png/LICENSE +21 -21
  432. package/format-notices/png/NOTICE +14 -14
  433. package/format-notices/red/LICENSE +21 -21
  434. package/format-notices/red/NOTICE +31 -31
  435. package/format-notices/stl/LICENSE +21 -21
  436. package/format-notices/stl/NOTICE +21 -21
  437. package/format-notices/tga/LICENSE +21 -21
  438. package/format-notices/tga/NOTICE +14 -14
  439. package/format-notices/wav/LICENSE +21 -21
  440. package/format-notices/wav/NOTICE +14 -14
  441. package/format-notices/webgl/LICENSE +21 -21
  442. package/format-notices/webgl/NOTICE +35 -35
  443. package/format-notices/webgpu/LICENSE +21 -21
  444. package/format-notices/webgpu/NOTICE +31 -31
  445. package/format-notices/webm/LICENSE +21 -21
  446. package/format-notices/webm/NOTICE +14 -14
  447. package/format-notices/webp/LICENSE +21 -21
  448. package/format-notices/webp/NOTICE +14 -14
  449. package/format-notices/wem/LICENSE +57 -57
  450. package/format-notices/wem/NOTICE +33 -33
  451. package/format-notices/yaml/LICENSE +21 -21
  452. package/format-notices/yaml/NOTICE +44 -44
  453. package/package.json +63 -63
@@ -1,437 +1,437 @@
1
- import { Operation, Message } from './protocol.js';
2
- import { CjsResManMainThreadLoader } from './CjsResManMainThreadLoader.js';
3
-
4
- const DEFAULT_WORKER_OPTIONS = Object.freeze({
5
- type: "module",
6
- name: "CjsResManWorker"
7
- });
8
-
9
- /**
10
- * 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.
11
- *
12
- * One module worker can overlap fetch requests and serializes synchronous
13
- * reader work on its own event loop. Sources opt in through
14
- * `CreateWorkerRequest(path, options)`. Formats opt in through a static
15
- * `worker` declaration containing their module URL and export name.
16
- */
17
- class CjsResManWorkerLoader {
18
- #boundError;
19
- #boundMessage;
20
- #nextId = 1;
21
- #pending = new Map();
22
-
23
- /**
24
- * @param {object} [options={}] Worker construction and fallback options.
25
- * @param {CjsResManMainThreadLoader|object} [options.fallback] Unsupported-operation fallback.
26
- * @param {Worker|object} [options.worker] Existing Worker-compatible instance.
27
- * @param {(url: string|URL, options: object) => Worker|object} [options.workerFactory] Worker factory.
28
- * @param {string|URL} [options.workerUrl] Module worker entry URL.
29
- * @param {object} [options.workerOptions] Options passed to the Worker constructor.
30
- * @param {boolean} [options.enabled=true] Whether worker execution may be used.
31
- */
32
- constructor(options = {}) {
33
- if (!options || typeof options !== "object" || Array.isArray(options)) {
34
- throw new TypeError("CjsResManWorkerLoader options must be an object.");
35
- }
36
- this.fallback = options.fallback || new CjsResManMainThreadLoader();
37
- assertResourceLoader(this.fallback, "fallback");
38
- this.workerFactory = options.workerFactory || defaultWorkerFactory;
39
- if (typeof this.workerFactory !== "function") {
40
- throw new TypeError("CjsResManWorkerLoader workerFactory must be a function.");
41
- }
42
- this.workerUrl = options.workerUrl || new URL("./CjsResManWorker.js", import.meta.url);
43
- this.workerOptions = Object.freeze({
44
- ...DEFAULT_WORKER_OPTIONS,
45
- ...(options.workerOptions || {})
46
- });
47
- this.enabled = options.enabled !== false;
48
- this.failed = false;
49
- this.worker = options.worker || null;
50
- this.#boundMessage = event => this.#OnMessage(event);
51
- this.#boundError = event => this.#OnError(event);
52
- if (this.worker) this.#Attach(this.worker);
53
- }
54
-
55
- /**
56
- * Enable and lazily create the configured worker.
57
- *
58
- * @param {string|URL} [workerUrl] Optional replacement worker URL.
59
- * @returns {boolean} Whether a worker is ready.
60
- */
61
- Enable(workerUrl = this.workerUrl) {
62
- this.enabled = true;
63
- if (workerUrl !== undefined && workerUrl !== null) this.workerUrl = workerUrl;
64
- if (this.worker) return true;
65
- if (this.failed) return false;
66
- try {
67
- const worker = this.workerFactory(this.workerUrl, this.workerOptions);
68
- if (!worker || typeof worker.postMessage !== "function") {
69
- throw new TypeError("Worker factory did not return a Worker-compatible object.");
70
- }
71
- this.worker = worker;
72
- this.#Attach(worker);
73
- return true;
74
- } catch {
75
- this.worker = null;
76
- this.failed = true;
77
- return false;
78
- }
79
- }
80
-
81
- /**
82
- * Stop worker use and reject every pending request.
83
- *
84
- * @param {*} [reason] Optional failure reason.
85
- * @returns {CjsResManWorkerLoader} This loader.
86
- */
87
- Disable(reason = null) {
88
- const worker = this.worker;
89
- if (worker) {
90
- this.#Detach(worker);
91
- worker.terminate?.();
92
- }
93
- this.worker = null;
94
- this.enabled = false;
95
- this.failed = reason !== null && reason !== undefined;
96
- if (this.#pending.size) {
97
- const error = normalizeWorkerError(reason || createWorkerUnavailableError("Resource worker was disabled."));
98
- for (const request of this.#pending.values()) {
99
- cleanupPendingRequest(request);
100
- request.reject(error);
101
- }
102
- this.#pending.clear();
103
- }
104
- return this;
105
- }
106
-
107
- /**
108
- * Clear a previous creation/fatal failure so a later enable can retry.
109
- *
110
- * @returns {CjsResManWorkerLoader} This loader.
111
- */
112
- Reset() {
113
- this.failed = false;
114
- this.enabled = true;
115
- return this;
116
- }
117
-
118
- /**
119
- * Replace the unsupported-operation fallback.
120
- *
121
- * @param {CjsResManMainThreadLoader|object} fallback Loader exposing Read and ReadFormat.
122
- * @returns {CjsResManWorkerLoader} This loader.
123
- */
124
- SetFallback(fallback) {
125
- assertResourceLoader(fallback, "fallback");
126
- this.fallback = fallback;
127
- return this;
128
- }
129
-
130
- /**
131
- * Report whether worker execution is configured and constructible.
132
- *
133
- * @returns {boolean}
134
- */
135
- IsAvailable() {
136
- return this.enabled && (Boolean(this.worker) || this.Enable());
137
- }
138
-
139
- /**
140
- * Read a source through its declared worker request, falling back when the
141
- * source is not worker-aware or a worker cannot be created.
142
- *
143
- * @param {object|Function} source Source implementation.
144
- * @param {string} path Normalized resource path.
145
- * @param {object} [options={}] Source options.
146
- * @returns {Promise<*>|*} Source result.
147
- */
148
- Read(source, path, options = {}) {
149
- assertResourceSource(source);
150
- if (typeof source.CreateWorkerRequest !== "function") {
151
- return this.fallback.Read(source, path, options);
152
- }
153
- const request = normalizeWorkerRequest(source.CreateWorkerRequest(path, options));
154
- if (!request || !this.IsAvailable()) {
155
- return this.fallback.Read(source, path, options);
156
- }
157
- return this.Execute(request.operation, request.payload, {
158
- signal: request.signal || options.signal,
159
- transfer: request.transfer
160
- });
161
- }
162
-
163
- /**
164
- * Test whether a registered format can be safely dispatched to this worker.
165
- *
166
- * @param {object} descriptor Registered format descriptor.
167
- * @param {object} [formatOptions={}] Normalized format options.
168
- * @param {object|null} [context=null] Clone-safe normalized resource path context.
169
- * @returns {boolean}
170
- */
171
- CanReadFormat(descriptor, formatOptions = {}, context = null) {
172
- const declaration = normalizeFormatWorkerDeclaration(descriptor);
173
- return Boolean(declaration && isWorkerFormatOutputSupported(declaration, formatOptions) && canCloneWorkerValue(formatOptions) && canCloneWorkerValue(context) && this.IsAvailable());
174
- }
175
-
176
- /**
177
- * Execute a worker-safe format reader or use the main-thread fallback.
178
- *
179
- * Inputs are cloned by default so shared source-cache ownership is not
180
- * detached. A format may explicitly declare `transferInput: true` when its
181
- * caller guarantees exclusive ownership.
182
- *
183
- * @param {object} descriptor Registered format descriptor.
184
- * @param {*} input Reader input.
185
- * @param {object} [formatOptions={}] Normalized format options.
186
- * @param {object|null} [context=null] Clone-safe normalized resource path context.
187
- * @returns {Promise<*>} Format result.
188
- */
189
- ReadFormat(descriptor, input, formatOptions = {}, context = null) {
190
- const declaration = normalizeFormatWorkerDeclaration(descriptor);
191
- if (!declaration || !isWorkerFormatOutputSupported(declaration, formatOptions) || !canCloneWorkerValue(formatOptions) || !canCloneWorkerValue(context) || !this.IsAvailable()) {
192
- return this.fallback.ReadFormat(descriptor, input, formatOptions, context);
193
- }
194
- const transfer = declaration.transferInput ? getExclusiveInputTransferables(input) : [];
195
- return this.Execute(Operation.FORMAT_READ, {
196
- module: declaration.module,
197
- exportName: declaration.exportName,
198
- input,
199
- options: formatOptions,
200
- context
201
- }, {
202
- transfer
203
- });
204
- }
205
-
206
- /**
207
- * Dispatch one operation using the stable worker message protocol.
208
- *
209
- * @param {string} operation Operation name.
210
- * @param {*} payload Structured-cloneable operation payload.
211
- * @param {object} [options={}] Transfer and cancellation options.
212
- * @returns {Promise<*>} Worker result.
213
- */
214
- Execute(operation, payload, options = {}) {
215
- if (typeof operation !== "string" || operation.trim() === "") {
216
- return Promise.reject(new TypeError("Worker operation must be a non-empty string."));
217
- }
218
- if (!this.IsAvailable()) {
219
- return Promise.reject(createWorkerUnavailableError());
220
- }
221
- const signal = options.signal || null;
222
- if (signal?.aborted) return Promise.reject(createAbortError(signal.reason));
223
- const id = this.#nextId++;
224
- let resolve;
225
- let reject;
226
- const promise = new Promise((onResolve, onReject) => {
227
- resolve = onResolve;
228
- reject = onReject;
229
- });
230
- const request = {
231
- id,
232
- resolve,
233
- reject,
234
- signal,
235
- onAbort: null
236
- };
237
- if (signal && typeof signal.addEventListener === "function") {
238
- request.onAbort = () => {
239
- if (!this.#pending.delete(id)) return;
240
- cleanupPendingRequest(request);
241
- try {
242
- this.worker?.postMessage({
243
- type: Message.CANCEL,
244
- id
245
- });
246
- } catch {
247
- // The local abort remains authoritative if the worker is already gone.
248
- }
249
- reject(createAbortError(signal.reason));
250
- };
251
- signal.addEventListener("abort", request.onAbort, {
252
- once: true
253
- });
254
- }
255
- this.#pending.set(id, request);
256
- try {
257
- this.worker.postMessage({
258
- type: Message.EXECUTE,
259
- id,
260
- operation,
261
- payload
262
- }, normalizeTransferList(options.transfer));
263
- } catch (error) {
264
- this.#pending.delete(id);
265
- cleanupPendingRequest(request);
266
- reject(error);
267
- }
268
- return promise;
269
- }
270
-
271
- /**
272
- * Return the number of unresolved worker requests.
273
- *
274
- * @returns {number}
275
- */
276
- GetPendingCount() {
277
- return this.#pending.size;
278
- }
279
-
280
- /** Attach this loader's result and failure listeners to a worker. */
281
- #Attach(worker) {
282
- if (typeof worker.addEventListener === "function") {
283
- worker.addEventListener("message", this.#boundMessage);
284
- worker.addEventListener("error", this.#boundError);
285
- worker.addEventListener("messageerror", this.#boundError);
286
- } else {
287
- worker.onmessage = this.#boundMessage;
288
- worker.onerror = this.#boundError;
289
- worker.onmessageerror = this.#boundError;
290
- }
291
- }
292
-
293
- /** Detach this loader's result and failure listeners from a worker. */
294
- #Detach(worker) {
295
- if (typeof worker.removeEventListener === "function") {
296
- worker.removeEventListener("message", this.#boundMessage);
297
- worker.removeEventListener("error", this.#boundError);
298
- worker.removeEventListener("messageerror", this.#boundError);
299
- } else {
300
- if (worker.onmessage === this.#boundMessage) worker.onmessage = null;
301
- if (worker.onerror === this.#boundError) worker.onerror = null;
302
- if (worker.onmessageerror === this.#boundError) worker.onmessageerror = null;
303
- }
304
- }
305
-
306
- /** Settle the pending request identified by one worker result message. */
307
- #OnMessage(event) {
308
- const data = event?.data;
309
- if (!data || data.type !== Message.RESULT) return;
310
- const request = this.#pending.get(data.id);
311
- if (!request) return;
312
- this.#pending.delete(data.id);
313
- cleanupPendingRequest(request);
314
- if (data.ok) request.resolve(data.result);else request.reject(normalizeWorkerError(data.error));
315
- }
316
-
317
- /** Disable worker execution after a fatal worker or message failure. */
318
- #OnError(event) {
319
- const reason = event?.error || event || new Error("Resource worker failed.");
320
- this.Disable(reason);
321
- }
322
- }
323
- function assertResourceSource(source) {
324
- if (!source || typeof source !== "object" && typeof source !== "function" || typeof source.Read !== "function") {
325
- throw new TypeError("Resource source must provide Read(path, options).");
326
- }
327
- }
328
- function assertResourceLoader(loader, name = "loader") {
329
- if (!loader || typeof loader.Read !== "function" || typeof loader.ReadFormat !== "function") {
330
- throw new TypeError(`CjsResManWorkerLoader ${name} must provide Read and ReadFormat.`);
331
- }
332
- }
333
- function defaultWorkerFactory(url, options) {
334
- if (typeof Worker === "undefined") {
335
- throw new ReferenceError("Browser Worker is not available.");
336
- }
337
- return new Worker(url, options);
338
- }
339
- function normalizeWorkerRequest(request) {
340
- if (request === null || request === undefined || request === false) return null;
341
- if (!request || typeof request !== "object" || Array.isArray(request)) {
342
- throw new TypeError("CreateWorkerRequest must return an object or null.");
343
- }
344
- if (typeof request.operation !== "string" || request.operation.trim() === "") {
345
- throw new TypeError("Worker source request requires a non-empty operation.");
346
- }
347
- return {
348
- operation: request.operation,
349
- payload: request.payload,
350
- signal: request.signal || null,
351
- transfer: normalizeTransferList(request.transfer)
352
- };
353
- }
354
- function normalizeFormatWorkerDeclaration(descriptor) {
355
- const Format = descriptor?.Format;
356
- const declaration = descriptor?.worker || Format?.worker;
357
- if (!declaration) return null;
358
- const value = typeof declaration === "string" ? {
359
- module: declaration
360
- } : declaration;
361
- if (!value || typeof value !== "object" || !value.module) return null;
362
- return Object.freeze({
363
- module: String(value.module),
364
- exportName: String(value.exportName || Format?.name || "default"),
365
- outputTypes: Array.isArray(value.outputTypes) ? Object.freeze(value.outputTypes.map(String)) : null,
366
- defaultOutput: value.defaultOutput === undefined ? undefined : String(value.defaultOutput),
367
- transferInput: value.transferInput === true
368
- });
369
- }
370
- function isWorkerFormatOutputSupported(declaration, formatOptions) {
371
- if (!declaration.outputTypes) return true;
372
- const output = formatOptions.emit ?? declaration.defaultOutput;
373
- return output !== undefined && declaration.outputTypes.includes(String(output));
374
- }
375
- function normalizeTransferList(value) {
376
- if (value === null || value === undefined) return [];
377
- if (!Array.isArray(value)) {
378
- throw new TypeError("Worker transfer list must be an array.");
379
- }
380
- return value;
381
- }
382
- function getExclusiveInputTransferables(input) {
383
- if (input instanceof ArrayBuffer) return [input];
384
- if (ArrayBuffer.isView(input) && input.byteOffset === 0 && input.byteLength === input.buffer.byteLength) {
385
- return [input.buffer];
386
- }
387
- return [];
388
- }
389
- function canCloneWorkerValue(value, seen = new Set()) {
390
- if (value === null || value === undefined) return true;
391
- const type = typeof value;
392
- if (type === "string" || type === "number" || type === "boolean" || type === "bigint") {
393
- return true;
394
- }
395
- if (type !== "object") return false;
396
- if (value instanceof ArrayBuffer || ArrayBuffer.isView(value) || value instanceof Date) {
397
- return true;
398
- }
399
- if (seen.has(value)) return false;
400
- seen.add(value);
401
- if (Array.isArray(value)) {
402
- return value.every(entry => canCloneWorkerValue(entry, seen));
403
- }
404
- const prototype = Object.getPrototypeOf(value);
405
- if (prototype !== Object.prototype && prototype !== null) return false;
406
- return Object.values(value).every(entry => canCloneWorkerValue(entry, seen));
407
- }
408
- function cleanupPendingRequest(request) {
409
- if (request.signal && request.onAbort && typeof request.signal.removeEventListener === "function") {
410
- request.signal.removeEventListener("abort", request.onAbort);
411
- }
412
- }
413
- function createWorkerUnavailableError(message = "Resource worker is unavailable.") {
414
- const error = new Error(message);
415
- error.name = "CjsResManWorkerUnavailableError";
416
- error.code = "CJS_RESOURCE_WORKER_UNAVAILABLE";
417
- return error;
418
- }
419
- function createAbortError(reason) {
420
- if (reason instanceof Error) return reason;
421
- const error = new Error(reason === undefined ? "Resource worker request was aborted." : String(reason));
422
- error.name = "AbortError";
423
- error.code = "ABORT_ERR";
424
- return error;
425
- }
426
- function normalizeWorkerError(value) {
427
- if (value instanceof Error) return value;
428
- const error = new Error(value?.message || "Resource worker operation failed.");
429
- error.name = value?.name || "CjsResManWorkerError";
430
- for (const key of ["code", "operation", "path", "status", "statusText"]) {
431
- if (value?.[key] !== undefined) error[key] = value[key];
432
- }
433
- return error;
434
- }
435
-
436
- export { CjsResManWorkerLoader };
437
- //# sourceMappingURL=CjsResManWorkerLoader.js.map
1
+ import { Operation, Message } from './protocol.js';
2
+ import { CjsResManMainThreadLoader } from './CjsResManMainThreadLoader.js';
3
+
4
+ const DEFAULT_WORKER_OPTIONS = Object.freeze({
5
+ type: "module",
6
+ name: "CjsResManWorker"
7
+ });
8
+
9
+ /**
10
+ * 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.
11
+ *
12
+ * One module worker can overlap fetch requests and serializes synchronous
13
+ * reader work on its own event loop. Sources opt in through
14
+ * `CreateWorkerRequest(path, options)`. Formats opt in through a static
15
+ * `worker` declaration containing their module URL and export name.
16
+ */
17
+ class CjsResManWorkerLoader {
18
+ #boundError;
19
+ #boundMessage;
20
+ #nextId = 1;
21
+ #pending = new Map();
22
+
23
+ /**
24
+ * @param {object} [options={}] Worker construction and fallback options.
25
+ * @param {CjsResManMainThreadLoader|object} [options.fallback] Unsupported-operation fallback.
26
+ * @param {Worker|object} [options.worker] Existing Worker-compatible instance.
27
+ * @param {(url: string|URL, options: object) => Worker|object} [options.workerFactory] Worker factory.
28
+ * @param {string|URL} [options.workerUrl] Module worker entry URL.
29
+ * @param {object} [options.workerOptions] Options passed to the Worker constructor.
30
+ * @param {boolean} [options.enabled=true] Whether worker execution may be used.
31
+ */
32
+ constructor(options = {}) {
33
+ if (!options || typeof options !== "object" || Array.isArray(options)) {
34
+ throw new TypeError("CjsResManWorkerLoader options must be an object.");
35
+ }
36
+ this.fallback = options.fallback || new CjsResManMainThreadLoader();
37
+ assertResourceLoader(this.fallback, "fallback");
38
+ this.workerFactory = options.workerFactory || defaultWorkerFactory;
39
+ if (typeof this.workerFactory !== "function") {
40
+ throw new TypeError("CjsResManWorkerLoader workerFactory must be a function.");
41
+ }
42
+ this.workerUrl = options.workerUrl || new URL("./CjsResManWorker.js", import.meta.url);
43
+ this.workerOptions = Object.freeze({
44
+ ...DEFAULT_WORKER_OPTIONS,
45
+ ...(options.workerOptions || {})
46
+ });
47
+ this.enabled = options.enabled !== false;
48
+ this.failed = false;
49
+ this.worker = options.worker || null;
50
+ this.#boundMessage = event => this.#OnMessage(event);
51
+ this.#boundError = event => this.#OnError(event);
52
+ if (this.worker) this.#Attach(this.worker);
53
+ }
54
+
55
+ /**
56
+ * Enable and lazily create the configured worker.
57
+ *
58
+ * @param {string|URL} [workerUrl] Optional replacement worker URL.
59
+ * @returns {boolean} Whether a worker is ready.
60
+ */
61
+ Enable(workerUrl = this.workerUrl) {
62
+ this.enabled = true;
63
+ if (workerUrl !== undefined && workerUrl !== null) this.workerUrl = workerUrl;
64
+ if (this.worker) return true;
65
+ if (this.failed) return false;
66
+ try {
67
+ const worker = this.workerFactory(this.workerUrl, this.workerOptions);
68
+ if (!worker || typeof worker.postMessage !== "function") {
69
+ throw new TypeError("Worker factory did not return a Worker-compatible object.");
70
+ }
71
+ this.worker = worker;
72
+ this.#Attach(worker);
73
+ return true;
74
+ } catch {
75
+ this.worker = null;
76
+ this.failed = true;
77
+ return false;
78
+ }
79
+ }
80
+
81
+ /**
82
+ * Stop worker use and reject every pending request.
83
+ *
84
+ * @param {*} [reason] Optional failure reason.
85
+ * @returns {CjsResManWorkerLoader} This loader.
86
+ */
87
+ Disable(reason = null) {
88
+ const worker = this.worker;
89
+ if (worker) {
90
+ this.#Detach(worker);
91
+ worker.terminate?.();
92
+ }
93
+ this.worker = null;
94
+ this.enabled = false;
95
+ this.failed = reason !== null && reason !== undefined;
96
+ if (this.#pending.size) {
97
+ const error = normalizeWorkerError(reason || createWorkerUnavailableError("Resource worker was disabled."));
98
+ for (const request of this.#pending.values()) {
99
+ cleanupPendingRequest(request);
100
+ request.reject(error);
101
+ }
102
+ this.#pending.clear();
103
+ }
104
+ return this;
105
+ }
106
+
107
+ /**
108
+ * Clear a previous creation/fatal failure so a later enable can retry.
109
+ *
110
+ * @returns {CjsResManWorkerLoader} This loader.
111
+ */
112
+ Reset() {
113
+ this.failed = false;
114
+ this.enabled = true;
115
+ return this;
116
+ }
117
+
118
+ /**
119
+ * Replace the unsupported-operation fallback.
120
+ *
121
+ * @param {CjsResManMainThreadLoader|object} fallback Loader exposing Read and ReadFormat.
122
+ * @returns {CjsResManWorkerLoader} This loader.
123
+ */
124
+ SetFallback(fallback) {
125
+ assertResourceLoader(fallback, "fallback");
126
+ this.fallback = fallback;
127
+ return this;
128
+ }
129
+
130
+ /**
131
+ * Report whether worker execution is configured and constructible.
132
+ *
133
+ * @returns {boolean}
134
+ */
135
+ IsAvailable() {
136
+ return this.enabled && (Boolean(this.worker) || this.Enable());
137
+ }
138
+
139
+ /**
140
+ * Read a source through its declared worker request, falling back when the
141
+ * source is not worker-aware or a worker cannot be created.
142
+ *
143
+ * @param {object|Function} source Source implementation.
144
+ * @param {string} path Normalized resource path.
145
+ * @param {object} [options={}] Source options.
146
+ * @returns {Promise<*>|*} Source result.
147
+ */
148
+ Read(source, path, options = {}) {
149
+ assertResourceSource(source);
150
+ if (typeof source.CreateWorkerRequest !== "function") {
151
+ return this.fallback.Read(source, path, options);
152
+ }
153
+ const request = normalizeWorkerRequest(source.CreateWorkerRequest(path, options));
154
+ if (!request || !this.IsAvailable()) {
155
+ return this.fallback.Read(source, path, options);
156
+ }
157
+ return this.Execute(request.operation, request.payload, {
158
+ signal: request.signal || options.signal,
159
+ transfer: request.transfer
160
+ });
161
+ }
162
+
163
+ /**
164
+ * Test whether a registered format can be safely dispatched to this worker.
165
+ *
166
+ * @param {object} descriptor Registered format descriptor.
167
+ * @param {object} [formatOptions={}] Normalized format options.
168
+ * @param {object|null} [context=null] Clone-safe normalized resource path context.
169
+ * @returns {boolean}
170
+ */
171
+ CanReadFormat(descriptor, formatOptions = {}, context = null) {
172
+ const declaration = normalizeFormatWorkerDeclaration(descriptor);
173
+ return Boolean(declaration && isWorkerFormatOutputSupported(declaration, formatOptions) && canCloneWorkerValue(formatOptions) && canCloneWorkerValue(context) && this.IsAvailable());
174
+ }
175
+
176
+ /**
177
+ * Execute a worker-safe format reader or use the main-thread fallback.
178
+ *
179
+ * Inputs are cloned by default so shared source-cache ownership is not
180
+ * detached. A format may explicitly declare `transferInput: true` when its
181
+ * caller guarantees exclusive ownership.
182
+ *
183
+ * @param {object} descriptor Registered format descriptor.
184
+ * @param {*} input Reader input.
185
+ * @param {object} [formatOptions={}] Normalized format options.
186
+ * @param {object|null} [context=null] Clone-safe normalized resource path context.
187
+ * @returns {Promise<*>} Format result.
188
+ */
189
+ ReadFormat(descriptor, input, formatOptions = {}, context = null) {
190
+ const declaration = normalizeFormatWorkerDeclaration(descriptor);
191
+ if (!declaration || !isWorkerFormatOutputSupported(declaration, formatOptions) || !canCloneWorkerValue(formatOptions) || !canCloneWorkerValue(context) || !this.IsAvailable()) {
192
+ return this.fallback.ReadFormat(descriptor, input, formatOptions, context);
193
+ }
194
+ const transfer = declaration.transferInput ? getExclusiveInputTransferables(input) : [];
195
+ return this.Execute(Operation.FORMAT_READ, {
196
+ module: declaration.module,
197
+ exportName: declaration.exportName,
198
+ input,
199
+ options: formatOptions,
200
+ context
201
+ }, {
202
+ transfer
203
+ });
204
+ }
205
+
206
+ /**
207
+ * Dispatch one operation using the stable worker message protocol.
208
+ *
209
+ * @param {string} operation Operation name.
210
+ * @param {*} payload Structured-cloneable operation payload.
211
+ * @param {object} [options={}] Transfer and cancellation options.
212
+ * @returns {Promise<*>} Worker result.
213
+ */
214
+ Execute(operation, payload, options = {}) {
215
+ if (typeof operation !== "string" || operation.trim() === "") {
216
+ return Promise.reject(new TypeError("Worker operation must be a non-empty string."));
217
+ }
218
+ if (!this.IsAvailable()) {
219
+ return Promise.reject(createWorkerUnavailableError());
220
+ }
221
+ const signal = options.signal || null;
222
+ if (signal?.aborted) return Promise.reject(createAbortError(signal.reason));
223
+ const id = this.#nextId++;
224
+ let resolve;
225
+ let reject;
226
+ const promise = new Promise((onResolve, onReject) => {
227
+ resolve = onResolve;
228
+ reject = onReject;
229
+ });
230
+ const request = {
231
+ id,
232
+ resolve,
233
+ reject,
234
+ signal,
235
+ onAbort: null
236
+ };
237
+ if (signal && typeof signal.addEventListener === "function") {
238
+ request.onAbort = () => {
239
+ if (!this.#pending.delete(id)) return;
240
+ cleanupPendingRequest(request);
241
+ try {
242
+ this.worker?.postMessage({
243
+ type: Message.CANCEL,
244
+ id
245
+ });
246
+ } catch {
247
+ // The local abort remains authoritative if the worker is already gone.
248
+ }
249
+ reject(createAbortError(signal.reason));
250
+ };
251
+ signal.addEventListener("abort", request.onAbort, {
252
+ once: true
253
+ });
254
+ }
255
+ this.#pending.set(id, request);
256
+ try {
257
+ this.worker.postMessage({
258
+ type: Message.EXECUTE,
259
+ id,
260
+ operation,
261
+ payload
262
+ }, normalizeTransferList(options.transfer));
263
+ } catch (error) {
264
+ this.#pending.delete(id);
265
+ cleanupPendingRequest(request);
266
+ reject(error);
267
+ }
268
+ return promise;
269
+ }
270
+
271
+ /**
272
+ * Return the number of unresolved worker requests.
273
+ *
274
+ * @returns {number}
275
+ */
276
+ GetPendingCount() {
277
+ return this.#pending.size;
278
+ }
279
+
280
+ /** Attach this loader's result and failure listeners to a worker. */
281
+ #Attach(worker) {
282
+ if (typeof worker.addEventListener === "function") {
283
+ worker.addEventListener("message", this.#boundMessage);
284
+ worker.addEventListener("error", this.#boundError);
285
+ worker.addEventListener("messageerror", this.#boundError);
286
+ } else {
287
+ worker.onmessage = this.#boundMessage;
288
+ worker.onerror = this.#boundError;
289
+ worker.onmessageerror = this.#boundError;
290
+ }
291
+ }
292
+
293
+ /** Detach this loader's result and failure listeners from a worker. */
294
+ #Detach(worker) {
295
+ if (typeof worker.removeEventListener === "function") {
296
+ worker.removeEventListener("message", this.#boundMessage);
297
+ worker.removeEventListener("error", this.#boundError);
298
+ worker.removeEventListener("messageerror", this.#boundError);
299
+ } else {
300
+ if (worker.onmessage === this.#boundMessage) worker.onmessage = null;
301
+ if (worker.onerror === this.#boundError) worker.onerror = null;
302
+ if (worker.onmessageerror === this.#boundError) worker.onmessageerror = null;
303
+ }
304
+ }
305
+
306
+ /** Settle the pending request identified by one worker result message. */
307
+ #OnMessage(event) {
308
+ const data = event?.data;
309
+ if (!data || data.type !== Message.RESULT) return;
310
+ const request = this.#pending.get(data.id);
311
+ if (!request) return;
312
+ this.#pending.delete(data.id);
313
+ cleanupPendingRequest(request);
314
+ if (data.ok) request.resolve(data.result);else request.reject(normalizeWorkerError(data.error));
315
+ }
316
+
317
+ /** Disable worker execution after a fatal worker or message failure. */
318
+ #OnError(event) {
319
+ const reason = event?.error || event || new Error("Resource worker failed.");
320
+ this.Disable(reason);
321
+ }
322
+ }
323
+ function assertResourceSource(source) {
324
+ if (!source || typeof source !== "object" && typeof source !== "function" || typeof source.Read !== "function") {
325
+ throw new TypeError("Resource source must provide Read(path, options).");
326
+ }
327
+ }
328
+ function assertResourceLoader(loader, name = "loader") {
329
+ if (!loader || typeof loader.Read !== "function" || typeof loader.ReadFormat !== "function") {
330
+ throw new TypeError(`CjsResManWorkerLoader ${name} must provide Read and ReadFormat.`);
331
+ }
332
+ }
333
+ function defaultWorkerFactory(url, options) {
334
+ if (typeof Worker === "undefined") {
335
+ throw new ReferenceError("Browser Worker is not available.");
336
+ }
337
+ return new Worker(url, options);
338
+ }
339
+ function normalizeWorkerRequest(request) {
340
+ if (request === null || request === undefined || request === false) return null;
341
+ if (!request || typeof request !== "object" || Array.isArray(request)) {
342
+ throw new TypeError("CreateWorkerRequest must return an object or null.");
343
+ }
344
+ if (typeof request.operation !== "string" || request.operation.trim() === "") {
345
+ throw new TypeError("Worker source request requires a non-empty operation.");
346
+ }
347
+ return {
348
+ operation: request.operation,
349
+ payload: request.payload,
350
+ signal: request.signal || null,
351
+ transfer: normalizeTransferList(request.transfer)
352
+ };
353
+ }
354
+ function normalizeFormatWorkerDeclaration(descriptor) {
355
+ const Format = descriptor?.Format;
356
+ const declaration = descriptor?.worker || Format?.worker;
357
+ if (!declaration) return null;
358
+ const value = typeof declaration === "string" ? {
359
+ module: declaration
360
+ } : declaration;
361
+ if (!value || typeof value !== "object" || !value.module) return null;
362
+ return Object.freeze({
363
+ module: String(value.module),
364
+ exportName: String(value.exportName || Format?.name || "default"),
365
+ outputTypes: Array.isArray(value.outputTypes) ? Object.freeze(value.outputTypes.map(String)) : null,
366
+ defaultOutput: value.defaultOutput === undefined ? undefined : String(value.defaultOutput),
367
+ transferInput: value.transferInput === true
368
+ });
369
+ }
370
+ function isWorkerFormatOutputSupported(declaration, formatOptions) {
371
+ if (!declaration.outputTypes) return true;
372
+ const output = formatOptions.emit ?? declaration.defaultOutput;
373
+ return output !== undefined && declaration.outputTypes.includes(String(output));
374
+ }
375
+ function normalizeTransferList(value) {
376
+ if (value === null || value === undefined) return [];
377
+ if (!Array.isArray(value)) {
378
+ throw new TypeError("Worker transfer list must be an array.");
379
+ }
380
+ return value;
381
+ }
382
+ function getExclusiveInputTransferables(input) {
383
+ if (input instanceof ArrayBuffer) return [input];
384
+ if (ArrayBuffer.isView(input) && input.byteOffset === 0 && input.byteLength === input.buffer.byteLength) {
385
+ return [input.buffer];
386
+ }
387
+ return [];
388
+ }
389
+ function canCloneWorkerValue(value, seen = new Set()) {
390
+ if (value === null || value === undefined) return true;
391
+ const type = typeof value;
392
+ if (type === "string" || type === "number" || type === "boolean" || type === "bigint") {
393
+ return true;
394
+ }
395
+ if (type !== "object") return false;
396
+ if (value instanceof ArrayBuffer || ArrayBuffer.isView(value) || value instanceof Date) {
397
+ return true;
398
+ }
399
+ if (seen.has(value)) return false;
400
+ seen.add(value);
401
+ if (Array.isArray(value)) {
402
+ return value.every(entry => canCloneWorkerValue(entry, seen));
403
+ }
404
+ const prototype = Object.getPrototypeOf(value);
405
+ if (prototype !== Object.prototype && prototype !== null) return false;
406
+ return Object.values(value).every(entry => canCloneWorkerValue(entry, seen));
407
+ }
408
+ function cleanupPendingRequest(request) {
409
+ if (request.signal && request.onAbort && typeof request.signal.removeEventListener === "function") {
410
+ request.signal.removeEventListener("abort", request.onAbort);
411
+ }
412
+ }
413
+ function createWorkerUnavailableError(message = "Resource worker is unavailable.") {
414
+ const error = new Error(message);
415
+ error.name = "CjsResManWorkerUnavailableError";
416
+ error.code = "CJS_RESOURCE_WORKER_UNAVAILABLE";
417
+ return error;
418
+ }
419
+ function createAbortError(reason) {
420
+ if (reason instanceof Error) return reason;
421
+ const error = new Error(reason === undefined ? "Resource worker request was aborted." : String(reason));
422
+ error.name = "AbortError";
423
+ error.code = "ABORT_ERR";
424
+ return error;
425
+ }
426
+ function normalizeWorkerError(value) {
427
+ if (value instanceof Error) return value;
428
+ const error = new Error(value?.message || "Resource worker operation failed.");
429
+ error.name = value?.name || "CjsResManWorkerError";
430
+ for (const key of ["code", "operation", "path", "status", "statusText"]) {
431
+ if (value?.[key] !== undefined) error[key] = value[key];
432
+ }
433
+ return error;
434
+ }
435
+
436
+ export { CjsResManWorkerLoader };
437
+ //# sourceMappingURL=CjsResManWorkerLoader.js.map