@ahoo-wang/wow-generator 9.2.0-rc.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2024] [ahoo wang <ahoowang@qq.com>]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,177 @@
+# `@ahoo-wang/wow-generator`
+
+Generate TypeScript models, Fetcher decorator clients, and Wow clients from a
+local or remote OpenAPI document.
+
+## Install and run
+
+```bash
+pnpm add @ahoo-wang/fetcher @ahoo-wang/fetcher-decorator \
+  @ahoo-wang/fetcher-eventstream @ahoo-wang/wow-client
+pnpm add -D @ahoo-wang/wow-generator typescript
+pnpm exec wow-generator generate \
+  --input ./openapi.yaml \
+  --output ./src/generated \
+  --ts-config-file-path ./tsconfig.json
+```
+
+The version follows Wow, so a minor release may contain breaking changes: keep the Wow packages on one minor with `save-prefix=~` or `--save-exact`, as [version ranges](https://wow.ahoo.me/guide/typescript/compatibility#version-ranges) explains.
+
+The first line installs what the generated code imports at run time, the
+second the generator and TypeScript. The generator's peers (`fetcher`,
+`fetcher-decorator`, `fetcher-eventstream`, `wow-client`) are the runtime
+packages of the first line; `wow-client` has to be on the generator's minor
+version. Node 22.12 or later is required, and TypeScript 6 or later: CI tests
+6.0 through the latest 7.x. The command
+used to be `fetcher-generator`; that name stays as an alias until v10.
+
+Generated clients are decorator classes, so the project that compiles them
+needs `"experimentalDecorators": true` in its `tsconfig.json`. Released with
+Wow 9.2.0, from the same tag and with the same version.
+
+A successful run prints its warnings, if any, and one summary line:
+
+```text
+Generated 12 files into src/generated with /work/app/wow-generator.config.json, 1 warning
+```
+
+## Options and exit codes
+
+| Option                             | Meaning                                                                   |
+| ---------------------------------- | ------------------------------------------------------------------------- |
+| `-i, --input <file>`               | OpenAPI 3.x document: a file path or an http(s) URL (required)            |
+| `-o, --output <path>`              | Output directory, `src/generated` by default                              |
+| `-c, --config <file>`              | Configuration file, `./wow-generator.config.json` by default              |
+| `-t, --ts-config-file-path <file>` | The project's `tsconfig.json`                                             |
+| `-H, --header <header>`            | `Name: value` header for an http(s) input or configuration; repeatable    |
+| `--timeout <ms>`                   | Abandon an http(s) fetch after this many milliseconds, 30000 by default   |
+| `--schema-docs <mode>`             | `summary` (default) or `full`, which also embeds each model's JSON schema |
+| `--strict`                         | Exit with code 4 when the run logged a warning                            |
+| `--verbose`                        | Log every step with timestamps, and the stack trace of a failure          |
+| `--quiet`                          | Log only warnings and errors                                              |
+
+An http(s) input fails on a response outside 2xx or when the timeout expires.
+Swagger 2.0 documents are refused; convert them to OpenAPI 3 first.
+
+| Exit code | Meaning                                                                                                                    |
+| --------- | -------------------------------------------------------------------------------------------------------------------------- |
+| 0         | Generated; or `--help`, `help` or `--version` printed                                                                      |
+| 1         | Internal error; rerun with `--verbose` for the stack trace                                                                 |
+| 2         | Input or usage: unreadable, unfetchable, not OpenAPI 3.x; or an invalid or missing option, an unknown option or command    |
+| 3         | Configuration: cannot be read, parsed or validated                                                                         |
+| 4         | Specification: the document cannot be generated, or `--strict` and the run had warnings                                    |
+| 5         | Output: the manifest cannot be parsed or a newer generator wrote it, a path escapes the output, or a write or delete fails |
+| 130       | Interrupted (Ctrl-C)                                                                                                       |
+
+A failure prints one line naming what failed; `--verbose` adds the cause.
+
+## Configuration
+
+```json
+{
+  "apiClients": {
+    "Catalog": {
+      "ignorePathParameters": ["tenantId", "ownerId"],
+      "methodNames": { "getCatalog_1": "getArchivedCatalog" }
+    }
+  }
+}
+```
+
+The default config path is `./wow-generator.config.json`, resolved against
+the working directory the CLI runs in. Only that default path is optional: when
+no file is there the CLI generates with defaults. A
+`./fetcher-generator.config.json`, the name the file had before, is still read
+when the new name is absent, with a deprecation warning; rename it, as v10 no
+longer reads it. A path passed to
+`--config` has to exist, and a configuration that cannot be read, cannot be
+parsed, or declares an option with the wrong shape fails the run rather than
+degrading to defaults. Options the generator does not read - a misspelled
+`apiClient`, say - are warned about by name and ignored.
+
+The summary line names the absolute path of the configuration it read, so a
+run answers "did my configuration take effect?" on its own. `--verbose` also
+prints the settings it resolved to:
+
+```text
+[10:42:07] Configuration loaded from /work/app/wow-generator.config.json: apiClients=Catalog
+```
+
+If the summary names no configuration, the file never reached the generator -
+check which directory the CLI ran in.
+
+The generator records the files it wrote in `.wow-generator.json` at the root
+of the output directory, so a later run removes the files it no longer
+generates. Commit it with the output. A `.fetcher-generator.json` left by an
+older version is read once and replaced.
+
+`ignorePathParameters` defaults to `['tenantId', 'ownerId']` only in a Wow
+document (one with `x-wow-context-alias` or aggregate routes); other documents
+keep those path parameters. `methodNames` names the method of an operationId.
+
+## Generated code
+
+- Every file starts with `// Code generated by wow-generator. DO NOT EDIT.`.
+  Relative imports end in `.js`, so the output compiles under `NodeNext` as
+  well as `bundler`, and it is the same wherever it is written.
+- A method is named by `methodNames`, else `x-fetcher-method`, else the last
+  segment of the operationId camel-cased (`example.cart.add_cart_item` →
+  `addCartItem`). Adding an operation never renames a method; two operations
+  of one client with the same name fail with exit code 4.
+- Command clients, and API clients of a document with `x-wow-context-alias`,
+  merge the constructor's `apiMetadata` over their defaults:
+  `new CartCommandClient({ fetcher })` keeps the bounded-context base path.
+  Pass `basePath: ''` (query factories: `contextAlias: ''`) to reach a service
+  directly.
+- Query client factories type their fields as `` `${CartAggregatedFields}` ``;
+  annotate a query as ``ListQuery<`${CartAggregatedFields}`>``.
+- `--schema-docs full` embeds each model's JSON schema in its doc comment;
+  the default is a summary.
+
+## Property optionality
+
+Every property a schema declares is generated as required. A statically typed
+service has no absent `int` or `boolean` to hand back, so a model full of `?`
+describes its exporter rather than its wire format - exporters routinely drop
+properties that carry a default value from `required`, and the resulting nulls
+checks are noise.
+
+Optionality that the document genuinely means is carried where it belongs:
+
+- **Null** stays in the type. A nullable property generates `T | null`, so a
+  value that may be absent is still impossible to forget.
+- **Commands** keep their declared optionality at the command type. A command
+  client wraps its body in `PartialBy<Command, 'field' | ...>` built from the
+  document's `required`, so a caller may still omit what the API says is
+  optional - `AddCartItemCommand = CommandBody<PartialBy<AddCartItem,
+'quantity'>>`. Requiring the model never narrows what a client may send.
+- **API client bodies** are wrapped the same way: a JSON request body is
+  `PartialBy<Model, 'field' | ...>` for the properties its schema leaves out of
+  `required`.
+
+One consequence is worth knowing: a non-nullable property that references its
+own schema has no finite literal, since every level needs the next. A recursive
+model that terminates declares its link nullable, which generates `T | null` and
+constructs fine.
+
+## Core capabilities
+
+- Local JSON/YAML and HTTP(S) OpenAPI input.
+- TypeScript models and decorator API clients grouped by tag, with typed path,
+  query and header parameters and request bodies, required ones first.
+- Wow bounded-context, command, snapshot, event, and query discovery.
+- Recursive `index.ts` generation and ts-morph formatting.
+- Programmatic `CodeGenerator` API with injectable logging, returning the files
+  written and the warning count.
+
+Regenerate after every contract change and compile the result before publishing.
+
+## Documentation
+
+- [Quick start: generate a client from a Wow service and call it](https://wow.ahoo.me/guide/typescript/quick-start)
+- [Regenerate in CI](https://wow.ahoo.me/guide/typescript/regenerate-in-ci)
+- [Generate a client from any OpenAPI document](https://wow.ahoo.me/guide/typescript/generated-client)
+- [wow-generator reference](https://wow.ahoo.me/reference/typescript/wow-generator/)
+- [Compatibility and versions](https://wow.ahoo.me/guide/typescript/compatibility)
+
+[中文](./README.zh-CN.md) · [License](https://github.com/Ahoo-Wang/Wow/blob/main/LICENSE)

package/README.zh-CN.md

@@ -0,0 +1,149 @@
+# `@ahoo-wang/wow-generator`
+
+从本地或远程 OpenAPI 文档生成 TypeScript 模型、Fetcher Decorator 客户端与 Wow
+客户端。
+
+## 安装与运行
+
+```bash
+pnpm add @ahoo-wang/fetcher @ahoo-wang/fetcher-decorator \
+  @ahoo-wang/fetcher-eventstream @ahoo-wang/wow-client
+pnpm add -D @ahoo-wang/wow-generator typescript
+pnpm exec wow-generator generate \
+  --input ./openapi.yaml \
+  --output ./src/generated \
+  --ts-config-file-path ./tsconfig.json
+```
+
+版本号跟随 Wow，次版本可能带有破坏性改动：用 `save-prefix=~` 或 `--save-exact` 让 Wow 包停在同一个次版本上，见[版本范围](https://wow.ahoo.me/zh/guide/typescript/compatibility#版本范围)。
+
+第一行安装生成代码运行时导入的包，第二行安装生成器和 TypeScript。生成器的 peer（`fetcher`、
+`fetcher-decorator`、`fetcher-eventstream`、`wow-client`）就是第一行的运行时包；`wow-client`
+须与生成器的次版本一致。需要 Node 22.12 或更高版本，以及 TypeScript 6 或更高版本：CI 测试
+6.0 到最新的 7.x。命令原名
+`fetcher-generator`，这个名字作为别名保留到 v10。
+
+生成的客户端是装饰器类，编译它们的项目需要在 `tsconfig.json` 中设置
+`"experimentalDecorators": true`。随 Wow 9.2.0 发布，与 Wow 同一个 tag、同一个版本号。
+
+生成成功时先输出警告（如有），最后输出一行摘要：
+
+```text
+Generated 12 files into src/generated with /work/app/wow-generator.config.json, 1 warning
+```
+
+## 选项与退出码
+
+| 选项                               | 含义                                                         |
+| ---------------------------------- | ------------------------------------------------------------ |
+| `-i, --input <file>`               | OpenAPI 3.x 文档：文件路径或 http(s) URL（必填）             |
+| `-o, --output <path>`              | 输出目录，默认 `src/generated`                               |
+| `-c, --config <file>`              | 配置文件，默认 `./wow-generator.config.json`                 |
+| `-t, --ts-config-file-path <file>` | 项目的 `tsconfig.json`                                       |
+| `-H, --header <header>`            | 读取 http(s) 输入或配置时发送的 `Name: value` 请求头，可重复 |
+| `--timeout <ms>`                   | http(s) 请求超过这个毫秒数即放弃，默认 30000                 |
+| `--schema-docs <mode>`             | `summary`（默认）或 `full`，后者还嵌入每个模型的 JSON schema |
+| `--strict`                         | 本次运行有警告时以退出码 4 结束                              |
+| `--verbose`                        | 输出每一步（带时间戳），失败时输出堆栈                       |
+| `--quiet`                          | 只输出警告和错误                                             |
+
+http(s) 输入的响应不是 2xx 或超时都会失败。Swagger 2.0 文档会被拒绝，请先转换为 OpenAPI 3。
+
+| 退出码 | 含义                                                                                     |
+| ------ | ---------------------------------------------------------------------------------------- |
+| 0      | 生成成功；或已输出 `--help`、`help`、`--version`                                         |
+| 1      | 内部错误；加 `--verbose` 重跑可看到堆栈                                                  |
+| 2      | 输入或用法：读不到、取不到、不是 OpenAPI 3.x；或选项值无效、缺少必填选项、未知选项或命令 |
+| 3      | 配置：读不到、解析不了或校验不通过                                                       |
+| 4      | 规范：文档无法生成代码，或开启 `--strict` 且本次运行有警告                               |
+| 5      | 输出：清单解析不了或由更新版本的生成器写出、路径越出输出目录，或写入、删除文件失败       |
+| 130    | 被中断（Ctrl-C）                                                                         |
+
+失败时只输出一行，说明哪里失败；`--verbose` 会附上原因。
+
+## 配置
+
+```json
+{
+  "apiClients": {
+    "Catalog": {
+      "ignorePathParameters": ["tenantId", "ownerId"],
+      "methodNames": { "getCatalog_1": "getArchivedCatalog" }
+    }
+  }
+}
+```
+
+默认配置路径为 `./wow-generator.config.json`，相对 CLI 的运行目录解析。只有这个默认路径是
+可选的：该位置没有文件时，CLI 按默认值生成。新文件名不存在时，仍会读取旧名
+`./fetcher-generator.config.json` 并给出弃用警告；请改名，v10 起不再读取旧名。`--config` 指定的路径必须
+存在；配置读不到、解析不了，或某个选项的形态不对，都会让本次生成失败，而不是退回默认值。
+生成器不认识的选项——例如拼错的 `apiClient`——会被逐个点名警告并忽略。
+
+摘要行会写出实际读取的配置的绝对路径，一次运行就能回答"我的配置生效了吗"；`--verbose` 还会
+写出解析出的设置：
+
+```text
+[10:42:07] Configuration loaded from /work/app/wow-generator.config.json: apiClients=Catalog
+```
+
+如果摘要里没有配置路径，说明配置文件根本没送到生成器——请检查 CLI 的运行目录。
+
+生成器把写出的文件记录在输出目录根下的 `.wow-generator.json` 中，之后的运行据此删除不再生成的
+文件。请把它和输出一起提交。旧版本留下的 `.fetcher-generator.json` 会被读取一次并替换。
+
+`ignorePathParameters` 只在 Wow 文档（带 `x-wow-context-alias` 或聚合路由）中默认为
+`['tenantId', 'ownerId']`；其他文档保留这两个路径参数。`methodNames` 为 operationId 指定方法名。
+
+## 生成的代码
+
+- 每个文件以 `// Code generated by wow-generator. DO NOT EDIT.` 开头。相对导入以 `.js` 结尾，
+  所以输出在 `NodeNext` 和 `bundler` 下都能编译，且写到哪里都一样。
+- 方法名依次取 `methodNames`、`x-fetcher-method`，否则取 operationId 最后一段的 camelCase
+  （`example.cart.add_cart_item` → `addCartItem`）。新增操作不会让已有方法改名；同一客户端的两个
+  操作同名时以退出码 4 失败。
+- 命令客户端，以及文档带 `x-wow-context-alias` 时的 API 客户端，把构造器的 `apiMetadata` 合并到
+  默认值之上：`new CartCommandClient({ fetcher })` 保留限界上下文的基础路径。直接访问服务时传
+  `basePath: ''`（查询客户端工厂传 `contextAlias: ''`）。
+- 查询客户端工厂的字段类型为 `` `${CartAggregatedFields}` ``；标注查询时写
+  ``ListQuery<`${CartAggregatedFields}`>``。
+- `--schema-docs full` 会在每个模型的文档注释中嵌入其 JSON schema；默认只含摘要。
+
+## 属性可选性
+
+schema 声明的每个属性都生成为必填。强类型后端根本没有"缺席的 `int`/`boolean`"可以返回，
+满屏 `?` 的模型描述的是导出器而不是线上格式——导出器常把带默认值的属性排除在 `required`
+之外，由此产生的空值判断纯属噪音。
+
+文档真正想表达的可选性，则由各自合适的位置承载：
+
+- **可空**留在类型里。可空属性生成 `T | null`，可能缺席的值依然不可能被忘记。
+- **命令**在命令类型上保留声明的可选性。命令客户端会依据文档的 `required` 把请求体包成
+  `PartialBy<Command, 'field' | ...>`，调用方仍可省略 API 允许省略的字段——
+  `AddCartItemCommand = CommandBody<PartialBy<AddCartItem, 'quantity'>>`。把模型改成必填
+  绝不会收紧客户端能发的内容。
+- **API 客户端请求体**也同样处理：JSON 请求体生成为 `PartialBy<Model, 'field' | ...>`，覆盖 schema
+  未列入 `required` 的属性。
+
+有一点值得知道：引用自身 schema 的非空属性没有有限字面量，因为每一层都还要下一层。能终止
+的递归模型会把这条链声明为可空，生成 `T | null`，构造起来毫无问题。
+
+## 核心能力
+
+- 本地 JSON/YAML 与 HTTP(S) OpenAPI 输入。
+- 按 tag 分组的 TypeScript 模型与 Decorator API 客户端，path、query、header 参数和请求体都带类型，必填的在前。
+- Wow bounded-context、命令、快照、事件与查询发现。
+- 递归生成 `index.ts`，并通过 ts-morph 格式化。
+- 支持注入日志的编程式 `CodeGenerator` API，返回写出的文件与警告数。
+
+每次契约变更后重新生成，并在发布前编译结果。
+
+## 文档
+
+- [快速开始：从 Wow 服务生成客户端并调用](https://wow.ahoo.me/zh/guide/typescript/quick-start)
+- [在 CI 中重新生成](https://wow.ahoo.me/zh/guide/typescript/regenerate-in-ci)
+- [从任意 OpenAPI 文档生成客户端](https://wow.ahoo.me/zh/guide/typescript/generated-client)
+- [wow-generator 参考](https://wow.ahoo.me/zh/reference/typescript/wow-generator/)
+- [兼容性与版本](https://wow.ahoo.me/zh/guide/typescript/compatibility)
+
+[English](./README.md) · [许可证](https://github.com/Ahoo-Wang/Wow/blob/main/LICENSE)

package/dist/analysis/aggregates.d.cts

@@ -0,0 +1,21 @@
+import { OpenApiDocument } from '../openapi/document.cjs';
+import { WowModel } from '../wow/model.cjs';
+import { AggregateModel, ModelDeclaration } from './model.cjs';
+/**
+ * The command and query clients of every aggregate that has state and query
+ * fields, by bounded context in the order the Wow metadata lists them.
+ */
+export declare function analyzeAggregates(document: OpenApiDocument, wow: WowModel): AggregateModel[];
+/**
+ * Fails when a command's type would take a name its module or its package
+ * already holds: the alias of another command, a command body the client
+ * imports, or a model of the aggregate's package, which the package's index
+ * exports beside it. `Foo` and `FooCommand` as two commands of one aggregate
+ * do this: `Foo`'s alias is `FooCommand`, the other's body.
+ *
+ * @param aggregates - The aggregates, as analysed
+ * @param models - The models of the document
+ * @throws GeneratorError naming the command, the model it collides with and
+ * the schemas to rename
+ */
+export declare function assertCommandTypeNamesFree(aggregates: readonly AggregateModel[], models: readonly ModelDeclaration[]): void;

package/dist/analysis/aggregates.d.ts

@@ -0,0 +1,21 @@
+import { OpenApiDocument } from '../openapi/document.js';
+import { WowModel } from '../wow/model.js';
+import { AggregateModel, ModelDeclaration } from './model.js';
+/**
+ * The command and query clients of every aggregate that has state and query
+ * fields, by bounded context in the order the Wow metadata lists them.
+ */
+export declare function analyzeAggregates(document: OpenApiDocument, wow: WowModel): AggregateModel[];
+/**
+ * Fails when a command's type would take a name its module or its package
+ * already holds: the alias of another command, a command body the client
+ * imports, or a model of the aggregate's package, which the package's index
+ * exports beside it. `Foo` and `FooCommand` as two commands of one aggregate
+ * do this: `Foo`'s alias is `FooCommand`, the other's body.
+ *
+ * @param aggregates - The aggregates, as analysed
+ * @param models - The models of the document
+ * @throws GeneratorError naming the command, the model it collides with and
+ * the schemas to rename
+ */
+export declare function assertCommandTypeNamesFree(aggregates: readonly AggregateModel[], models: readonly ModelDeclaration[]): void;

package/dist/analysis/analyze.d.cts

@@ -0,0 +1,18 @@
+import { GeneratorConfiguration } from '../api/configuration.cjs';
+import { OpenApiDocument } from '../openapi/document.cjs';
+import { WowModel } from '../wow/model.cjs';
+import { Analysis } from './model.cjs';
+/**
+ * Decides what a document generates: its bounded contexts, models, command
+ * and query clients and API clients. A pure function of the document, its
+ * Wow model and the configuration; nothing is written and nothing logged.
+ *
+ * @param document - The document, left unchanged
+ * @param wow - Its Wow model
+ * @param config - The generator configuration
+ * @returns The generation model, and the warnings for what it leaves out
+ * @throws GeneratorError when the document asks for code that cannot
+ * compile: two schemas of one model, a command type named like a model,
+ * two operations of one method
+ */
+export declare function analyze(document: OpenApiDocument, wow: WowModel, config: GeneratorConfiguration): Analysis;

package/dist/analysis/analyze.d.ts

@@ -0,0 +1,18 @@
+import { GeneratorConfiguration } from '../api/configuration.js';
+import { OpenApiDocument } from '../openapi/document.js';
+import { WowModel } from '../wow/model.js';
+import { Analysis } from './model.js';
+/**
+ * Decides what a document generates: its bounded contexts, models, command
+ * and query clients and API clients. A pure function of the document, its
+ * Wow model and the configuration; nothing is written and nothing logged.
+ *
+ * @param document - The document, left unchanged
+ * @param wow - Its Wow model
+ * @param config - The generator configuration
+ * @returns The generation model, and the warnings for what it leaves out
+ * @throws GeneratorError when the document asks for code that cannot
+ * compile: two schemas of one model, a command type named like a model,
+ * two operations of one method
+ */
+export declare function analyze(document: OpenApiDocument, wow: WowModel, config: GeneratorConfiguration): Analysis;

package/dist/analysis/apiClients.d.cts

@@ -0,0 +1,14 @@
+import { GeneratorConfiguration } from '../api/configuration.cjs';
+import { OpenApiDocument } from '../openapi/document.cjs';
+import { WowModel } from '../wow/model.cjs';
+import { ApiClientModel } from './model.cjs';
+/**
+ * The API clients of a document: one per tag that is neither Wow's own, the
+ * actuator's, nor an aggregate's, holding a method per operation.
+ *
+ * @param warnings - Receives a line for every operation left out and every
+ * client renamed
+ * @throws GeneratorError when two operations of a client name the same
+ * method, or a configured or extension method name is not one
+ */
+export declare function analyzeApiClients(document: OpenApiDocument, wow: WowModel, config: GeneratorConfiguration, warnings: string[]): ApiClientModel[];

package/dist/analysis/apiClients.d.ts

@@ -0,0 +1,14 @@
+import { GeneratorConfiguration } from '../api/configuration.js';
+import { OpenApiDocument } from '../openapi/document.js';
+import { WowModel } from '../wow/model.js';
+import { ApiClientModel } from './model.js';
+/**
+ * The API clients of a document: one per tag that is neither Wow's own, the
+ * actuator's, nor an aggregate's, holding a method per operation.
+ *
+ * @param warnings - Receives a line for every operation left out and every
+ * client renamed
+ * @throws GeneratorError when two operations of a client name the same
+ * method, or a configured or extension method name is not one
+ */
+export declare function analyzeApiClients(document: OpenApiDocument, wow: WowModel, config: GeneratorConfiguration, warnings: string[]): ApiClientModel[];