@zerolith/client 0.0.0-canary.20261102.g8292c77

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 [yyyy] [name of copyright owner]
+
+   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,32 @@
+# @zerolith/client
+
+A typed HTTP client over a neutral contract. `zerolith-client` reads an OpenAPI 3.x document and writes one TypeScript module: a type per component schema, an `Api` interface with one entry per operation, and the `routes` table the client runs on. `createClient` takes that table and checks every call against it: the operation name, its path and query parameters, its body, and what it resolves to.
+
+```
+npx zerolith-client openapi.json --out src/api.ts
+```
+
+```ts
+import { createClient } from "@zerolith/client";
+import { type Api, routes } from "./api.ts";
+
+const api = createClient<Api>(routes, { baseUrl: "/api" });
+const note = await api.call("getNote", { params: { id } });
+const notes = api.query("listNotes", () => ({ query: { q: search.get() } }));
+```
+
+A response outside 2xx rejects with a `ProblemError` carrying the RFC 9457 problem the server sent, or one built from the status line. `query` wraps an operation in a resource that calls again when the signals it reads change. A custom `transport` answers requests in process, for tests or an Electron bridge, and the client never assumes which server produced the document.
+
+The guide is on the [docs site](https://zerolith.dev/guide/client/).
+
+Status: alpha. Install with `npm install @zerolith/client@alpha`; the API may change before 1.0.
+
+## Documentation
+
+- The [typed client guide](https://zerolith.dev/guide/client/) explains it with examples that run as tests.
+- The [reference](https://zerolith.dev/reference/zerolith-client/) lists every export, generated from the source.
+- New to zerolith? The [tutorial](https://zerolith.dev/learn/) builds an app step by step, and the [playground](https://zerolith.dev/playground/) runs code in the browser.
+
+## License
+
+Apache-2.0. See `LICENSE`.

package/dist/cli.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+/** Runs the command with the given arguments and returns the exit code. */
+export declare function main(argv: readonly string[]): Promise<number>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAoDA,2EAA2E;AAC3E,wBAAsB,IAAI,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAoCnE"}

package/dist/cli.js

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+/**
+ * `zerolith-client <openapi.json> [--out <file.ts>]`: writes the contract
+ * module for an OpenAPI document to a file, or to standard output.
+ */
+import { readFile, writeFile } from "node:fs/promises";
+import { realpathSync } from "node:fs";
+import process from "node:process";
+import { pathToFileURL } from "node:url";
+import { generateClient } from "./generate.js";
+const USAGE = "usage: zerolith-client <openapi.json> [--out <file.ts>] [--name <Api>]\n";
+function parse(argv) {
+    const parsed = { input: undefined, out: undefined, name: undefined };
+    for (let index = 0; index < argv.length; index++) {
+        const argument = argv[index] ?? "";
+        if (argument === "--out" || argument === "--name") {
+            const value = argv[index + 1];
+            if (value === undefined) {
+                throw new Error(`${argument} needs a value`);
+            }
+            parsed[argument === "--out" ? "out" : "name"] = value;
+            index++;
+        }
+        else if (argument.startsWith("--")) {
+            throw new Error(`unknown option ${argument}`);
+        }
+        else if (parsed.input === undefined) {
+            parsed.input = argument;
+        }
+        else {
+            throw new Error(`unexpected argument ${argument}`);
+        }
+    }
+    return parsed;
+}
+/** Runs the command with the given arguments and returns the exit code. */
+export async function main(argv) {
+    let parsed;
+    try {
+        parsed = parse(argv);
+    }
+    catch (error) {
+        process.stderr.write(`zerolith-client: ${error instanceof Error ? error.message : String(error)}\n${USAGE}`);
+        return 2;
+    }
+    if (parsed.input === undefined) {
+        process.stderr.write(USAGE);
+        return 2;
+    }
+    try {
+        const document = JSON.parse(await readFile(parsed.input, "utf8"));
+        const code = generateClient(document, parsed.name === undefined ? {} : { apiName: parsed.name });
+        if (parsed.out === undefined) {
+            process.stdout.write(code);
+        }
+        else {
+            await writeFile(parsed.out, code);
+        }
+    }
+    catch (error) {
+        process.stderr.write(`zerolith-client: ${error instanceof Error ? error.message.replace(/^zerolith\/client: /, "") : String(error)}\n`);
+        return 1;
+    }
+    return 0;
+}
+/** True when node started this module, directly or through the bin link npm installs, which it resolves the way node resolves its entry. */
+function started() {
+    const entry = process.argv[1];
+    try {
+        return entry !== undefined && pathToFileURL(realpathSync(entry)).href === import.meta.url;
+    }
+    catch {
+        return false;
+    }
+}
+if (started()) {
+    process.exitCode = await main(process.argv.slice(2));
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAwB,cAAc,EAAE,MAAM,eAAe,CAAC;AAErE,MAAM,KAAK,GAAG,0EAA0E,CAAC;AASzF,SAAS,KAAK,CAAC,IAAuB;IAElC,MAAM,MAAM,GAAc,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAChF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAChD,CAAC;QACG,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ,EACjD,CAAC;YACG,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YAC9B,IAAI,KAAK,KAAK,SAAS,EACvB,CAAC;gBACG,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,gBAAgB,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YACtD,KAAK,EAAE,CAAC;QACZ,CAAC;aACI,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAClC,CAAC;YACG,MAAM,IAAI,KAAK,CAAC,kBAAkB,QAAQ,EAAE,CAAC,CAAC;QAClD,CAAC;aACI,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EACnC,CAAC;YACG,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC;QAC5B,CAAC;aAED,CAAC;YACG,MAAM,IAAI,KAAK,CAAC,uBAAuB,QAAQ,EAAE,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,2EAA2E;AAC3E,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAuB;IAE9C,IAAI,MAAiB,CAAC;IACtB,IACA,CAAC;QACG,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,KAAK,EACZ,CAAC;QACG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;QAC7G,OAAO,CAAC,CAAC;IACb,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAC9B,CAAC;QACG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC;IACb,CAAC;IACD,IACA,CAAC;QACG,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAoB,CAAC;QACrF,MAAM,IAAI,GAAG,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACjG,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS,EAC5B,CAAC;YACG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;aAED,CAAC;YACG,MAAM,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;IACD,OAAO,KAAK,EACZ,CAAC;QACG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxI,OAAO,CAAC,CAAC;IACb,CAAC;IACD,OAAO,CAAC,CAAC;AACb,CAAC;AAED,4IAA4I;AAC5I,SAAS,OAAO;IAEZ,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,IACA,CAAC;QACG,OAAO,KAAK,KAAK,SAAS,IAAI,aAAa,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,GAAG,CAAC;IAC9F,CAAC;IACD,MACA,CAAC;QACG,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,IAAI,OAAO,EAAE,EACb,CAAC;IACG,OAAO,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC"}

package/dist/generate.d.ts

@@ -0,0 +1,175 @@
+/**
+ * Generates the contract module from an OpenAPI 3.x document: one type per
+ * component schema, an `Api` interface with one entry per operation, and
+ * the `routes` table the client runs on. Pure string work, so it runs
+ * anywhere; the `zerolith-client` command wraps it for the shell.
+ */
+/** A JSON Schema object as OpenAPI 3.1 and later carry it (draft 2020-12 plus the OAS vocabulary). */
+export interface SchemaObject {
+    /** A reference to `#/components/schemas/<name>`, rendered as that component's generated type, intersected with the keywords beside it that shape a type, such as `properties`, as OpenAPI 3.1 allows; any other target fails generation. */
+    $ref?: string;
+    /** The JSON type, or since OpenAPI 3.1 an array of types rendered as a union; `integer` renders as `number`, and when it is absent the object or array keywords imply one, else the type is `unknown`. */
+    type?: string | string[];
+    /** The OpenAPI 3.0 flag that also allows `null`; when `true`, `null` joins the type. */
+    nullable?: boolean;
+    /** The allowed values, rendered as a union of their literal types; it takes precedence over `type`, and intersects with a composition keyword or `$ref` beside it. */
+    enum?: unknown[];
+    /** The single allowed value (OpenAPI 3.1 and later), rendered as its literal type; it takes precedence over `enum` and `type`, and intersects with a composition keyword or `$ref` beside it. */
+    const?: unknown;
+    /** The object's properties, each generated as a member that is optional unless `required` lists it, with the property's `description` as its doc comment. */
+    properties?: Record<string, SchemaObject>;
+    /** The names in `properties` that must be present; every other property is generated as optional. */
+    required?: string[];
+    /** The schema of keys beyond `properties`, rendered as a `Record<string, ...>` joined to them with `&`; `true` allows `unknown` values, and `false` makes an object without properties `Record<string, never>`. */
+    additionalProperties?: boolean | SchemaObject;
+    /** The schema of each array element, rendered as `T[]`, or `unknown[]` without it; beside `prefixItems` it types the elements after the tuple. */
+    items?: SchemaObject;
+    /** The schemas of the leading array elements by position (OpenAPI 3.1 and later), rendered as a tuple; without `items` the tuple has no rest element. */
+    prefixItems?: SchemaObject[];
+    /** Alternatives of which exactly one matches, rendered as a union; it takes precedence over `anyOf` and `allOf`, and the keywords beside it that shape a type, such as `properties`, intersect with it. */
+    oneOf?: SchemaObject[];
+    /** Alternatives of which at least one matches, rendered as a union unless `oneOf` is present; the keywords beside it that shape a type, such as `properties`, intersect with it. */
+    anyOf?: SchemaObject[];
+    /** Schemas that all match, rendered as an intersection unless `oneOf` or `anyOf` is present; the keywords beside it that shape a type, such as `properties`, join the intersection. */
+    allOf?: SchemaObject[];
+    /** Becomes the doc comment on a component schema's generated type, ahead of `title`, and on an object property's member. */
+    description?: string;
+    /** The doc comment on a component schema's generated type when `description` is absent; the type's name comes from the component's key, not from `title`. */
+    title?: string;
+}
+/** A Parameter Object or a reference to one. */
+export interface ParameterObject {
+    /** A reference to `#/components/parameters/<name>`, which replaces this object; any other target, or a missing one, fails generation. */
+    $ref?: string;
+    /** The member's key in the generated `params` or `query`, matching the `{name}` placeholder for a path parameter; a parameter without `name` or `in` fails generation. */
+    name?: string;
+    /** Where the parameter travels: `path` fills `params`, `query` adds a member to `query`, `querystring` (OpenAPI 3.2) lets `query` take any key, and `header` and `cookie` are left out. */
+    in?: "query" | "querystring" | "header" | "path" | "cookie";
+    /** Makes a query parameter's member, and the whole `query` input, required; path parameters are generated as required either way, since OpenAPI demands `true` for them. */
+    required?: boolean;
+    /** The doc comment on the parameter's generated member. */
+    description?: string;
+    /** The schema of the value, rendered as the member's type; without it or `content`, the type is `unknown`. */
+    schema?: SchemaObject;
+    /** The single media type entry OpenAPI allows in place of `schema`; when `schema` is absent, the entry's `schema` gives the member's type. */
+    content?: Record<string, MediaTypeObject>;
+}
+/** A Media Type Object. */
+export interface MediaTypeObject {
+    /** The content's schema, read for a JSON media type in a body and for any media type in a parameter's `content`; when absent, the type is `unknown`. */
+    schema?: SchemaObject;
+}
+/** A Request Body Object or a reference to one. */
+export interface RequestBodyObject {
+    /** A reference to `#/components/requestBodies/<name>`, which replaces this object; any other target, or a missing one, fails generation. */
+    $ref?: string;
+    /** A brief description of the body; the generator does not carry it into the output. */
+    description?: string;
+    /** Makes the generated `body` input required; OpenAPI's default is `false`, which generates it as optional. */
+    required?: boolean;
+    /** The body by media type, where a JSON type takes precedence and gives its schema's type; otherwise `multipart/form-data` gives `FormData`, `application/x-www-form-urlencoded` gives `URLSearchParams`, `text/*` gives `string`, and any other type gives `BodyInit`. */
+    content?: Record<string, MediaTypeObject>;
+}
+/** A Response Object or a reference to one. */
+export interface ResponseObject {
+    /** A reference to `#/components/responses/<name>`, which replaces this object; any other target, or a missing one, fails generation. */
+    $ref?: string;
+    /** A description of the response; the generator does not carry it into the output. */
+    description?: string;
+    /** The response body by media type: a JSON type, when present, gives its schema's type, `text/*` gives `string`, any other type gives `Blob`, as the client reads it, and no content gives `undefined`. */
+    content?: Record<string, MediaTypeObject>;
+}
+/** An Operation Object. */
+export interface OperationObject {
+    /** Names the operation's entry in `Api` and `routes`, in camelCase; without it the name comes from the method and path, such as `putNotesById` for `PUT /notes/{id}`, and two entries with one name fail generation. */
+    operationId?: string;
+    /** The first paragraph of the doc comment on the operation's entry in `Api`. */
+    summary?: string;
+    /** Follows `summary` in the doc comment on the operation's entry in `Api`. */
+    description?: string;
+    /** When `true`, the doc comment on the operation's entry ends with `@deprecated`. */
+    deprecated?: boolean;
+    /** The operation's parameters, merged with the path item's; one with the same `name` and `in` as a path item parameter replaces it. */
+    parameters?: ParameterObject[];
+    /** The request body, generated as the entry's `body` input; without it the entry has no `body`. */
+    requestBody?: RequestBodyObject;
+    /** The responses by status code; `output` is the union of every 2xx response, including `2XX`, or of `default` when there is none, and `unknown` without either. */
+    responses?: Record<string, ResponseObject>;
+}
+/** A Path Item Object. */
+export interface PathItemObject {
+    /** A reference to `#/components/pathItems/<name>`, which replaces this item; any other target, or a missing one, fails generation. */
+    $ref?: string;
+    /** A summary meant for every operation on the path; the generator does not carry it into the output. */
+    summary?: string;
+    /** A description meant for every operation on the path; the generator does not carry it into the output. */
+    description?: string;
+    /** Parameters shared by every operation on the path; an operation's own parameter with the same `name` and `in` replaces one. */
+    parameters?: ParameterObject[];
+    /** The `GET` operation on this path. */
+    get?: OperationObject;
+    /** The `PUT` operation on this path. */
+    put?: OperationObject;
+    /** The `POST` operation on this path. */
+    post?: OperationObject;
+    /** The `DELETE` operation on this path. */
+    delete?: OperationObject;
+    /** The `OPTIONS` operation on this path. */
+    options?: OperationObject;
+    /** The `HEAD` operation on this path. */
+    head?: OperationObject;
+    /** The `PATCH` operation on this path. */
+    patch?: OperationObject;
+    /** The `TRACE` operation on this path. */
+    trace?: OperationObject;
+    /** The `QUERY` operation on this path (OpenAPI 3.2): a safe, idempotent request that carries a body. */
+    query?: OperationObject;
+    /** Operations for other HTTP methods (OpenAPI 3.2), keyed by method name such as `COPY`; each key is lowercased, and one that is not a valid method token fails generation. */
+    additionalOperations?: Record<string, OperationObject>;
+}
+/** The parts of an OpenAPI document the generator reads. */
+export interface OpenApiDocument {
+    /** The OpenAPI version, such as `3.1.0`; a value that does not start with `3.` fails generation. */
+    openapi: string;
+    /** The API's title and version, which the generated file's header comment names as its source. */
+    info?: {
+        title?: string;
+        version?: string;
+    };
+    /** Path templates mapped to their items; every operation under them becomes an entry of `Api` and `routes`, sorted by path. */
+    paths?: Record<string, PathItemObject>;
+    /** Reusable objects: each entry of `schemas` becomes an exported type named after its key, and `$ref` values resolve into the other sections. */
+    components?: {
+        schemas?: Record<string, SchemaObject>;
+        parameters?: Record<string, ParameterObject>;
+        requestBodies?: Record<string, RequestBodyObject>;
+        responses?: Record<string, ResponseObject>;
+        pathItems?: Record<string, PathItemObject>;
+    };
+}
+/** Options for `generateClient`. */
+export interface GenerateOptions {
+    /** The module the generated file imports `RouteTable` from. Defaults to `@zerolith/client`. */
+    clientSpecifier?: string;
+    /** The name of the generated contract interface. Defaults to `Api`. */
+    apiName?: string;
+}
+/**
+ * Generates the contract module for an OpenAPI 3.x document given as a
+ * parsed object (JSON; convert YAML first). Schemas under
+ * `components.schemas` become exported types, every operation becomes an
+ * entry of the `Api` interface named by its `operationId` (or by its
+ * method and path), and `routes` carries the method and path of each.
+ * Header and cookie parameters, security, and non-local references are
+ * left out; the client sends headers through its options. A schema whose
+ * type name would clash is written under the first free name with a
+ * number added, as `Record2`, with a comment that says why, and every
+ * `$ref` to it uses that name: one that another schema takes first, as
+ * `note-item` and `note_item` both give `NoteItem`, one named like the
+ * interface of the operations or the `RouteTable` the module imports, and
+ * one named like a built-in type the module writes, such as `Record` for
+ * an object of free keys or `Blob` for a binary response. A schema named
+ * like a built-in the module does not write keeps its name.
+ */
+export declare function generateClient(document: OpenApiDocument, options?: GenerateOptions): string;
+//# sourceMappingURL=generate.d.ts.map

package/dist/generate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,sGAAsG;AACtG,MAAM,WAAW,YAAY;IAEzB,4OAA4O;IAC5O,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0MAA0M;IAC1M,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,wFAAwF;IACxF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sKAAsK;IACtK,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,iMAAiM;IACjM,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,6JAA6J;IAC7J,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C,qGAAqG;IACrG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,mNAAmN;IACnN,oBAAoB,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;IAC9C,kJAAkJ;IAClJ,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,yJAAyJ;IACzJ,WAAW,CAAC,EAAE,YAAY,EAAE,CAAC;IAC7B,2MAA2M;IAC3M,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,oLAAoL;IACpL,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,uLAAuL;IACvL,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;IACvB,4HAA4H;IAC5H,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6JAA6J;IAC7J,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAE5B,yIAAyI;IACzI,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0KAA0K;IAC1K,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2LAA2L;IAC3L,EAAE,CAAC,EAAE,OAAO,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC5D,4KAA4K;IAC5K,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2DAA2D;IAC3D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8GAA8G;IAC9G,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,8IAA8I;IAC9I,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,2BAA2B;AAC3B,MAAM,WAAW,eAAe;IAE5B,wJAAwJ;IACxJ,MAAM,CAAC,EAAE,YAAY,CAAC;CACzB;AAED,mDAAmD;AACnD,MAAM,WAAW,iBAAiB;IAE9B,4IAA4I;IAC5I,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wFAAwF;IACxF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+GAA+G;IAC/G,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2QAA2Q;IAC3Q,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,+CAA+C;AAC/C,MAAM,WAAW,cAAc;IAE3B,wIAAwI;IACxI,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sFAAsF;IACtF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2MAA2M;IAC3M,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC7C;AAED,2BAA2B;AAC3B,MAAM,WAAW,eAAe;IAE5B,wNAAwN;IACxN,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gFAAgF;IAChF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uIAAuI;IACvI,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,mGAAmG;IACnG,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,oKAAoK;IACpK,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC9C;AAED,0BAA0B;AAC1B,MAAM,WAAW,cAAc;IAE3B,sIAAsI;IACtI,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iIAAiI;IACjI,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,wCAAwC;IACxC,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,wCAAwC;IACxC,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,yCAAyC;IACzC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,yCAAyC;IACzC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,wGAAwG;IACxG,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,+KAA+K;IAC/K,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC1D;AAED,4DAA4D;AAC5D,MAAM,WAAW,eAAe;IAE5B,oGAAoG;IACpG,OAAO,EAAE,MAAM,CAAC;IAChB,kGAAkG;IAClG,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,+HAA+H;IAC/H,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACvC,iJAAiJ;IACjJ,UAAU,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACvC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QAC7C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAClD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QAC3C,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;KAC9C,CAAC;CACL;AAED,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAE5B,+FAA+F;IAC/F,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AA2eD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,GAAE,eAAoB,GAAG,MAAM,CAe/F"}