layout-data 0.0.0-stage → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## v0.2.0
+
+The first release.
+
+### Features
+
+- **Typed data blocks in a fixed layout.** A data block (the class `Ldata`) is a `Buffer`-backed block of named, typed tags (`Bool`, `Byte`, `SInt`, `USInt`, `Int`, `UInt`, `Word`, `DInt`, `UDInt`, `DWord`, `Real`), stored big-endian. A `Word` made of `Bool`s is a combined word that shares its bytes with its bits. A tag is read and written by name, `ldata.pressure = 1.5`, or through its `Ltag` handle, `ldata.get("pressure")`.
+- **Layouts in YAML or in code.** A layout is described in a YAML 1.2 file, with reusable fragments, `includes` and `coupling`, or as the same structure already parsed, and is registered with `register_layout(sources)`. A source is a file path, a parsed description, or a list of them; the fragments of all the sources are collected before they are resolved, so a layout may name a fragment of any source, whatever the order. The layouts are validated as a whole, every violation is reported at once, and either all of them are registered or none. The registration is made once per process, and a call that fails does not use it up. After that a data block is created by the layout name, `new Ldata("Pump", "pump_1")`, and `get_layout(name)` returns the layout, which is read-only.
+- **Names that are safe to use.** A tag name is an identifier (letters, digits and `_`, not starting with a digit), unique in its layout, and not one of the reserved names, which are a fixed list in the spec: the members of a data block, the methods of `EventEmitter` in Node.js 20.11 and the names of `Object.prototype`. The `name` of a data block is a string and cannot be changed.
+- **Values are checked before they are written.** A value that is not a number written to a numeric tag throws `TypeError`; `NaN`, an infinity, a non-integer or an integer out of range written to an integer tag, or a finite number beyond float32 written to a `Real` tag, throws `RangeError`. Nothing is truncated or converted, and the old value is kept.
+- **Change detection and events.** `change` `(name, old_value, new_value)` is emitted for every tag whose value changes, and by the `Ltag` of that tag as `(old_value, new_value)`; `write` is emitted after every write. Only the byte range a write touched is compared. `transaction(fn)` makes a group of writes one whole: its events are emitted together at the end, and its writes are undone if `fn` throws. When a handler throws, every listener of every event is still called, and the first exception is thrown by the write afterwards; the new value stands. `on`, `once` and `off` are typed for the reserved events `change`, `write`, `access` and `read`.
+- **Raw access.** `read_bytes`, `write_bytes` and `write_bit` read and write the bytes by offset, for a server that works with register addresses and for an IO layer. The buffer itself stays private, so no write goes unnoticed.
+- **Device byte order.** `load_tag` and `store_tag` (`Ltag.load` and `Ltag.store`) convert one tag between the data block and a device-ordered IO buffer in `BE`, `LE`, `BEBS` or `LEBS`, and `io_index_table` gives the byte indexes for exchanging a whole block at once.
+- **Observing accesses.** The `access` event `(kind, tags)` tells which tags a read or a write touched, by name or by bytes, and `Ldata.on_access` and `Ldata.off_access` do the same for every data block of the process. It is a diagnostic, for example to check the dependencies a rule declares against the ones it really has; without a listener an access pays one check.
+- **Types for editors.** The type declarations are generated from the JSDoc of the source into `dist/types`, with typed layout descriptions (`Layout_Description`, `Tag_Item`, `Include_Item`) and `Tag_Type`, and are covered by a type test. `render_types` writes an interface of the tags of each layout, `<Layout>_Tags` and `<Layout>_Ldata`, and the JSDoc cast that names the type of a data block gives completion of its tags in plain JavaScript.
+- **Tooling.** ESM only, for Node.js >= 20.11, with `yaml` bundled; `pnpm bench` measures loading a data block from a device image. MPL-2.0.
+
+## v0.2.0 (中文)
+
+首个发布版本。
+
+### 功能
+
+- **按固定布局存放的、有类型的数据块。** 数据块（类 `Ldata`）是以 `Buffer` 为底的一块数据，由具名、有类型的 tag（`Bool`、`Byte`、`SInt`、`USInt`、`Int`、`UInt`、`Word`、`DInt`、`UDInt`、`DWord`、`Real`）组成，内部按大端存放。由若干 `Bool` 组成的 `Word` 是组合字，与各组成位共用字节。tag 按名读写，`ldata.pressure = 1.5`，也可以通过它的 `Ltag` 句柄，`ldata.get("pressure")`。
+- **用 YAML 或在代码里写布局。** 布局可以写在 YAML 1.2 文件里（可复用片段，有 `includes` 和 `coupling`），也可以是同样结构的已解析对象，用 `register_layout(sources)` 注册。来源可以是文件路径、已解析的描述，或它们组成的列表；先收集所有来源的片段再解析引用，所以布局可以引用任何来源中的片段，与顺序无关。布局作为整体校验，所有违规一次报出，要么全部登记，要么都不登记。注册每个进程只做一次，失败的调用不会用掉这一次。此后按布局名创建数据块，`new Ldata("Pump", "pump_1")`，`get_layout(name)` 返回只读的布局。
+- **可以放心使用的名字。** tag 名是标识符（字母、数字和 `_`，不以数字开头），在布局内唯一，且不是保留名；保留名是规格里的固定清单：数据块的成员、Node.js 20.11 的 `EventEmitter` 方法和 `Object.prototype` 的名字。数据块的 `name` 是字符串，且不能修改。
+- **写入之前先检查值。** 向数值 tag 写入不是数字的值抛出 `TypeError`；向整型 tag 写入 `NaN`、无穷大、非整数或超出范围的整数，或向 `Real` tag 写入超出 float32 的有限数，抛出 `RangeError`。不截断，不转换，原值保留。
+- **变化检测与事件。** tag 的值变化时发出 `change` `(name, old_value, new_value)`，该 tag 的 `Ltag` 也发出 `(old_value, new_value)`；每次写入之后发出 `write`。只比较写入触及的字节范围。`transaction(fn)` 让一组写入成为一个整体：事件在结束时一起发出，`fn` 抛出异常时所有写入都被撤销。处理器抛出异常时，每个事件的每个监听函数仍然都会被调用，之后由这次写入抛出第一个异常；新值保留。`on`、`once`、`off` 对保留的事件 `change`、`write`、`access`、`read` 带类型。
+- **原始访问。** `read_bytes`、`write_bytes`、`write_bit` 按偏移读写字节，供按寄存器地址工作的服务端和 IO 层使用。缓冲区本身是私有的，所以任何写入都不会被漏掉。
+- **设备字节序。** `load_tag` 和 `store_tag`（`Ltag.load` 和 `Ltag.store`）按 `BE`、`LE`、`BEBS`、`LEBS` 在数据块与设备字节序的 IO 缓冲区之间转换一个 tag，`io_index_table` 给出整块一次交换时的字节下标。
+- **观察访问。** `access` 事件 `(kind, tags)` 指出一次读或写触及了哪些 tag，不论是按名还是按字节；`Ldata.on_access` 和 `Ldata.off_access` 对进程里所有数据块做同样的事。它是诊断手段，例如核对一条规则声明的依赖与它实际的依赖；没有监听器时，每次访问只多一次检查。
+- **供编辑器使用的类型。** 类型声明由源码的 JSDoc 生成到 `dist/types`，布局描述有类型（`Layout_Description`、`Tag_Item`、`Include_Item`），tag 类型有 `Tag_Type`，并有类型测试。`render_types` 为每个布局写出 tag 的接口，`<Layout>_Tags` 和 `<Layout>_Ldata`，用 JSDoc 类型转换为数据块指定这个类型，就能在纯 JavaScript 里补全它的 tag。
+- **工具。** 只有 ESM，要求 Node.js >= 20.11，已内置 `yaml`；`pnpm bench` 测量从设备映像装载数据块的开销。MPL-2.0。

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 https://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

@@ -1,3 +1,126 @@
-# Temporary Holding Version
+# layout-data
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Structured, reactive, buffer-based data blocks with named, typed tags.
+
+A data block is a fixed-layout `Buffer` (big-endian inside). The layout is described in YAML. You read and write tags by name, subscribe to their changes, and convert byte order only at the edge where you talk to a device. It does no I/O, scheduling or logging; those belong to the program that uses it (a controller, a device simulator, ...).
+
+## Features
+
+- **Fixed, validated layouts**: tag types `Bool`, `Byte`, `SInt`, `USInt`, `Int`, `UInt`, `Word`, `DInt`, `UDInt`, `DWord`, `Real`; the layout is checked as a whole and every violation is reported at once.
+- **Access by name**: `data.pressure = 1.5`, or through a `Ltag` handle (`data.get("pressure")`).
+- **Combined words**: a `Word` made of `Bool` bits shares its bytes with them, so writing either side updates the other.
+- **Change events**: emitted after the new value is in place, for writes by name and raw writes (`write_bytes`, `write_bit`); the internal buffer is not exposed, so no write is missed. Writes that leave a value unchanged emit nothing.
+- **Immediate detection and transactions**: events fire when a write returns; `transaction(fn)` makes a group of writes one whole, with its events emitted together at the end and its writes undone if `fn` fails.
+- **Device byte order**: `BE`, `LE`, `BEBS`, `LEBS` conversion per tag (`load_tag` / `store_tag`), or by a byte index table for a whole block (`io_index_table`).
+- **TypeScript types**: declarations are generated from JSDoc, and `render_types` generates per-layout interfaces for editor completion.
+
+## Install
+
+Requires Node.js >= 20.11. The package is ESM only.
+
+```bash
+pnpm add layout-data
+```
+
+`yaml` is bundled into the library, so nothing else needs to be installed.
+
+## Usage
+
+Describe the layout (`pump.yaml`). Entries other than `layouts` are fragments that entries can reference by name. Offsets are in bits.
+
+```yaml
+status_bits:
+  - { name: run, type: Bool, offset: 8 }
+  - { name: fault, type: Bool, offset: 9, comment: Fault latch }
+
+layouts:
+  Pump:
+    - { name: id, type: UInt, offset: 0, init_value: 1 }
+    - { name: status, type: Word, offset: 16, coupling: status_bits }
+    - { name: pressure, type: Real, offset: 32, init_value: 0.5, comment: Outlet pressure }
+```
+
+Register it once, then use it by the layout name:
+
+```js
+import { register_layout, Ldata } from "layout-data";
+
+register_layout("pump.yaml");
+const pump = new Ldata("Pump", "pump_1");
+
+pump.on("change", (name, old_value, new_value) => {
+	console.log(name, old_value, "->", new_value);
+});
+pump.get("pressure").on("change", (old_value, new_value) => { /* ... */ });
+
+pump.pressure = 1.5;            // pressure 0.5 -> 1.5
+pump.run = true;               // status 0 -> 1, then run false -> true
+pump.write_bytes(2, Buffer.from([0x00, 0x02])); // raw write by byte offset: fault becomes true
+pump.id = 70000;                // throws RangeError, the old value is kept
+```
+
+Exchanging data with a device in another byte order:
+
+```js
+pump.load_tag("pressure", io_buffer, "LEBS");  // device -> big-endian, the change is reported
+pump.get("pressure").store(io_buffer, "LEBS"); // the same through the Ltag, big-endian -> device
+
+// a batch of loads is one write with one detection
+pump.transaction(() => {
+	for (const { name } of pump.layout.items) pump.load_tag(name, io_buffer, "LEBS");
+});
+```
+
+## Exports
+
+| Export | Purpose |
+| --- | --- |
+| `Ldata`, `Ltag` | The data object and the tag handle |
+| `register_layout(sources)` | Register the layouts of YAML files or parsed descriptions (a path, an object, or a list of them), once per process; then create `Ldata` by layout name |
+| `render_types(layouts, options)` | Generate TypeScript interfaces for layouts, for editor completion (see below) |
+| `get_layout(name)` | Look up a registered layout by name |
+| `io_index_table` | Byte index table for exchanging a whole block with a device (per-tag conversion is `load_tag` / `store_tag` of `Ldata`) |
+
+## Editor completion
+
+`new Ldata("Pump", "pump_1")` is typed `Ldata`. To have the tags of the layout completed, generate the types of the registered layouts once, write them to a file beside your code, and name the type of the value with a JSDoc cast:
+
+```js
+import { writeFileSync } from "node:fs";
+import { register_layout, render_types } from "layout-data";
+
+const { layouts } = register_layout("pump.yaml");
+writeFileSync("layout_types.d.ts", render_types(layouts, { source: "pump.yaml" }));
+```
+
+```js
+const pump = /** @type {import("./layout_types.js").Pump_Ldata} */ (new Ldata("Pump", "pump_1"));
+pump.pressure = 1.5;   // completed, and known to be a number
+```
+
+The parentheses are part of the cast. With `checkJs` or `// @ts-check` a misspelled tag or a value of the wrong type is reported too.
+
+The types are named after the layout: `Pump_Tags` and `Pump_Ldata` for the layout `Pump`. In TypeScript write `new Ldata("Pump", "pump_1") as Pump_Ldata`.
+
+## Documentation
+
+The specification and design documents are in [doc/](doc/spec.md) (English, `*.md`; the Chinese primary version is `*.zh-cn.md`):
+
+- [Specification](doc/spec.md): goals, scope and data block requirements
+- [Data object interface](doc/spec-data-api.md): `Ldata`, `Ltag`, change events and the layout description format
+- [Design](doc/design.md): how it is implemented
+
+## Development
+
+```bash
+pnpm install
+pnpm build      # bundle to dist/ and generate dist/types
+pnpm test       # build, type tests, node --test
+pnpm lint
+```
+
+## License
+
+[MPL-2.0](LICENSE). You may use this library as a component of your own products, commercial or not, under any license. If you modify the files of this library, the modified files must be published under MPL-2.0, and the copyright and license notices must be kept.
+
+The license grants no trademark rights: the name "layout-data" may not be used to promote a modified or repackaged copy of this library.