@jsprismarine/content 0.0.0 → 0.16.0-unstable-20261029132853

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# @jsprismarine/content
+
+## 0.16.0-unstable-20261029132853
+
+### Patch Changes
+
+- [#2628](https://github.com/JSPrismarine/JSPrismarine/pull/2628) [`d4a2a0b`](https://github.com/JSPrismarine/JSPrismarine/commit/d4a2a0b2787e171583e6db0aec1b750e8aeb1e95) Thanks [@filiphsps](https://github.com/filiphsps)! - Add `@jsprismarine/content`, the runtime every content domain builds on. It holds the three layers
+  the plan names, `Definition`, `Type` and `Instance`, plus a `Registry<T>` with dense positional ids
+  and a `Holder<T>` that survives a content reload, `Tags<T>` with Java Edition's append-unless-replace
+  merge and transitive `#tag` references whose cycles are reported rather than thrown, a
+  `ComponentRegistry` whose factories declare an injectable parameter schema and the hooks they may
+  implement, a `BehaviorRegistry` that attaches named behaviors by identifier, list or predicate, a
+  `HookTable` generic over a domain-supplied hook map that dispatches in declaration order with
+  Bedrock's permutation override, and `flatten` for Dragonfly-style load-time flattening into typed
+  arrays indexed by a dense id, with a reviewed-exception list that fails the build when a row matches
+  nothing. The package names no block, item or entity concept; domains supply their own hooks,
+  component factories and definition reader.
+
+- [#2628](https://github.com/JSPrismarine/JSPrismarine/pull/2628) [`d220519`](https://github.com/JSPrismarine/JSPrismarine/commit/d220519e2e460148a90cbde9d643033e27bf8f5e) Thanks [@filiphsps](https://github.com/filiphsps)! - Select block behavior from loaded component data
+
+- [#2628](https://github.com/JSPrismarine/JSPrismarine/pull/2628) [`bffe7a8`](https://github.com/JSPrismarine/JSPrismarine/commit/bffe7a89abe4151001fe7a8c323f5ce31ad55d1c) Thanks [@filiphsps](https://github.com/filiphsps)! - Serve the vanilla behavior pack alone, and let Mojang's content load without 55 warnings about
+  itself.
+  
+  The default stack handed the whole BDS `behavior_packs` folder to the loader, so a default build
+  served the editor pack's five `editor:` entities, chemistry's balloon and ice bomb, and eight
+  chemistry reducer recipes that won over the vanilla recipes of the same name. It now composes the
+  packs it was asked for, by the header UUID a world references a pack by, and the default asks for
+  the vanilla behavior pack: 129 entity types rather than 136. `PackStackRequest.bedrockPacks` names
+  more packs by UUID, or `'all'` composes the folder whole, for a server that does want chemistry or
+  the editor.
+  
+  A clean build reported 102 warnings and no error. 26 of them were the `"events": null` an entity
+  with no events is written with, and 26 the empty `"remove": {}` of a randomize branch that changes
+  nothing; the parser already read both correctly, so the warnings only taught an operator to skip
+  the report. Both are silent now, and an events key that is neither an object nor null, and a
+  `component_groups` that is there and is not a list, still report. What is left is 47 warnings that
+  each name something the server does not do, and an unknown component now names the first file that
+  declared it.

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,174 @@
+# @jsprismarine/content
+
+The runtime every content domain is built on. Blocks, items and entities each get their own package;
+this one holds the parts they all need and knows nothing about any of them.
+
+That split is the whole point. Nothing here names a block, an item or a hook. A domain supplies its
+own hook map, its own component factories and its own reader for the shape of its JSON, and gets
+registries, tags, component resolution, hook dispatch and load-time flattening back.
+
+## The three layers
+
+Content moves through three layers, in this order, and the code uses these names.
+
+A **definition** is parsed, validated, immutable JSON for one identifier. `@jsprismarine/packs`
+produces them from a pack stack and its `Definition` is assignable to the one declared here. The
+shape is accepted structurally rather than imported, because a domain can also build types from
+data that never passed through a pack, such as the Java Edition jar dump behind the block property
+table.
+
+A **type** is a definition resolved once at load. `resolveTypes` parses each component's value
+through its factory's schema, binds the handlers, attaches the behaviors registered for that
+identifier, builds the dispatch table and computes the flags the domain asked for. After that a
+type answers questions without parsing anything.
+
+An **instance** is one live thing of a type: an item stack or an entity, holding a reference to its
+type plus whatever state the domain keeps per instance. A block in chunk storage is deliberately not
+an instance. It is a runtime id, and the hot path reads a flattened array instead.
+
+## Registries and holders
+
+A `Registry<T>` is a named table keyed by namespaced identifier, with a dense numeric id per entry.
+Ids run from 0 in insertion order. They are positional, not persistent: rebuilding with the same
+keys in the same order reproduces every id, and rebuilding with a different order renumbers from 0.
+So persist keys rather than ids.
+
+To keep a reference across a content reload, take a `Holder<T>` instead. A holder resolves by key
+every time, so after a reload it reads the new value and the new id, and a holder whose key the
+reload dropped reports that rather than going stale. `registry.holder(key)` returns the same object
+for the same key, including for a key no build has introduced yet.
+
+```typescript
+import { Registry } from '@jsprismarine/content';
+
+const blocks = new Registry<BlockType>('blocks');
+blocks.rebuild(types); // a ReadonlyMap, an array of pairs, anything iterable
+
+const stone = blocks.holder('minecraft:stone');
+stone.id; // 0
+stone.value(); // throws while unbound
+```
+
+## Tags
+
+`Tags<T>` holds the tag files of a whole pack stack for one registry. Merging follows Java Edition's
+rule: a later file appends to the tag unless it sets `replace`, which drops everything earlier packs
+contributed. A `#namespace:tag` member expands to that tag's own members, transitively.
+
+A reference that closes a cycle is dropped and reported as a `tag.cycle` diagnostic rather than
+thrown, so one bad pack cannot stop a load. Build the registry before the tags, because resolution
+reports a required member the registry does not have. Members are holders, so the resolved sets
+follow a later registry rebuild on their own.
+
+## Components and behaviors
+
+A component is one documented component name bound to a parameter schema and a set of hooks. The
+schema is a plain function, so a domain can inject whatever checking it already has. It runs once
+per type at load, and the factory turns the parsed parameters into handlers.
+
+```typescript
+import { accepted, type ComponentFactory, ComponentRegistry, rejected } from '@jsprismarine/content';
+
+interface BlockHooks {
+    onPlace: (position: Vector3) => void;
+    onInteract: (player: Player) => boolean | undefined;
+}
+
+const friction: ComponentFactory<BlockHooks, number> = {
+    name: 'minecraft:friction',
+    hooks: [],
+    schema: (value) => (typeof value === 'number' ? accepted(value) : rejected('expected a number')),
+    create: () => ({})
+};
+
+const components = new ComponentRegistry<BlockHooks>();
+components.register(friction);
+```
+
+A factory's `hooks` list is an upper bound. The parsed parameters may leave a hook out, which is how
+a non-looping tick component implements nothing, but returning a hook the factory never declared is
+a registration error. Domains read the list to decide which types can ever reach a hook.
+
+A behavior is the same idea attached from the other side. It is registered by name and attached to
+identifiers, which is how one door behavior covers every door. The selector is an identifier, a
+list of them, or a predicate. A predicate receives the identifier and the loaded definition, so it
+can select behavior from a component as well as from a closed-over tag index. Identifier-only
+predicates remain valid.
+
+Mojang's `minecraft:custom_components` is read as one more way to name a behavior rather than the
+binding mechanism, because that hook is marked deprecated in Mojang's own documentation while its
+version 2 still needs two experimental toggles.
+
+## Hook dispatch
+
+A domain declares its own hook map, so this package never knows a hook name:
+
+```typescript
+interface BlockHooks {
+    onPlace: (position: Vector3) => void;
+}
+```
+
+Declare it as an `interface` or a `type`, whichever you prefer. The generic parameter is written
+`H extends HookSignatures<H>` for that reason: a plain index-signature constraint would reject an
+interface, because TypeScript gives an implicit index signature to a type alias and not to one.
+
+Each type gets a `HookTable` built once at load, which turns every hook into a frozen array of
+handlers. Dispatch is an array lookup and a loop, with no map lookup and no allocation per call.
+Order is the definition's component order first, then behaviors in attachment order, so the server's
+own code has the last word over what a pack declared.
+
+Either side can set `override`, which replaces every handler collected so far for the hooks that
+contribution implements and leaves the others alone. That is Bedrock's permutation rule, and a
+domain's `ComponentReader` sets it per entry when it emits a permutation's component list.
+
+## Flattening
+
+`flatten` is the Dragonfly `Finalize` idea: precompute the hot properties at load so the tick loop
+reads an array slot instead of calling through a type.
+
+```typescript
+import { flatten } from '@jsprismarine/content';
+
+const table = flatten(types.values(), {
+    id: (type) => runtimeIdOf(type.identifier),
+    length: paletteSize,
+    columns: {
+        friction: { kind: 'f32', read: (type) => type.params(friction) },
+        lightEmission: { kind: 'u8', read: (type) => type.params(light), default: 0 }
+    },
+    exceptions: [{ id: 0, column: 'friction', value: 0.6, reason: 'minecraft:unknown has no Java row' }]
+});
+
+table.friction[runtimeId]; // a Float32Array read
+```
+
+The column's `kind` picks the typed array, and the return type carries it, so `table.friction` is a
+`Float32Array` and `table.lightEmission` is a `Uint8Array`.
+
+An id with no source value falls back to the column's `default` and then to a reviewed exception. An
+id with neither fails the build, and so does an exception that matched nothing. That second rule is
+what keeps the list honest: every gap is a row with a reason, and a row outlives the gap it covers
+for exactly one build.
+
+Values are range checked against the column kind, so 300 in a `u8` column and 0.5 in any integer
+column fail the build instead of being silently truncated.
+
+## Plugging in a domain
+
+A domain package does five things, in this order.
+
+1. Declare its hook map and register a `ComponentFactory` for every component name it implements.
+2. Register its behaviors and attach them to identifiers or tags.
+3. Write a `ComponentReader` that pulls the component list out of its own JSON shape, including
+   `component_groups` and permutations if it has them.
+4. Call `resolveTypes` on the definitions `@jsprismarine/packs` loaded, then
+   `registry.rebuild(result.types)`.
+5. Call `flatten` for the properties its tick loop reads, and hand out `Instance` handles or dense
+   ids, whichever fits.
+
+Diagnostics come back as a list rather than through a logger, with the same `Diagnostic` shape
+`@jsprismarine/packs` uses, so you can concatenate a load report and a resolve report. An unknown
+component name resolves the type anyway and is reported once per pack, which turns "component not
+implemented" into a log line instead of a missing class. Pass `strict: true` to turn any diagnostic
+into a `ContentLoadError`, which is what the test suites do.