@flop-labs/contracts 0.0.0-stage → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to `@flop-labs/contracts` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.2] - 2026-11-08
+
+### Added
+
+- Generated exact-ID credential receipt, request ID and lookup error contracts,
+  preserving unknown values and exact terminal allocations in raw FLOP units.
+
+## [0.1.1] - 2026-10-26
+
+### Added
+
+- Optional bounded waiting through chat completions' `max_wait_ms`, paired with
+  the existing `max_cost_flop` authorization.
+
+### Changed
+
+- Licensed under `MIT OR Apache-2.0`, at your option (previously Apache-2.0 only). `LICENSE` carries both texts.
+
+## [0.1.0] - 2026-10-16
+
+### Added
+
+- Generated chat-completion streaming chunks, tool-call fragments, usage and in-band
+  errors, with dependency-free frame validators and schema drift coverage.
+
+- Initial 0.1.0 public API contracts for model lists, model details, and chat
+  completion requests and JSON responses, derived from the gateway OpenAPI.
+- Dependency-free structural validators, JSON Schema exports, and deterministic
+  regeneration and drift checks.
+
+### Fixed
+
+- Canonical OpenAPI response parity: list-model responses can omit description,
+  tokenizer, and instruct type; tool-only assistant messages can contain null
+  content. Generated contracts reflect these existing server behaviors.
+- Required nested completion fields and nonempty request messages reflect the
+  gateway's existing emitted response and accepted request structures.
+- Completion finish reasons retain provider strings, including `tool_calls`,
+  instead of an incomplete enum.

package/LICENSE

@@ -0,0 +1,238 @@
+Copyright (c) 2025-2026 The FLOP Network Contributors
+
+This package is licensed under either of
+
+  * the MIT license (first text below), or
+  * the Apache License, Version 2.0 (second text below)
+
+at your option.
+
+SPDX-License-Identifier: MIT OR Apache-2.0
+
+================================================================================
+
+MIT License
+
+Copyright (c) 2025-2026 The FLOP Network Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+================================================================================
+
+                                 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

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# @flop-labs/contracts
 
-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.
+Structural types, JSON Schema exports, and assertion validators for the FLOP
+public HTTP API. Version 0.1.0 covers `listModels`, `getModel`, and JSON
+`createChatCompletion` payloads and streaming frames from `services/rest-gateway/openapi.yaml`.
+The unreleased surface also includes exact-ID credential receipt lookup.
+
+```sh
+npm install @flop-labs/contracts
+```
+
+```ts
+import { assertModelList, type ModelList } from "@flop-labs/contracts";
+
+const response = await fetch("https://api.flop.network/v1/models");
+const value: unknown = await response.json();
+assertModelList(value);
+const models: ModelList = value;
+```
+
+Exports: `Model`, `ModelList` (also `ModelListResponse`), `ModelResponse`,
+`ChatCompletionRequest`, `ChatCompletionResponse`, `ChatCompletionChunk`, and
+`ChatCompletionStreamError`; their `assert*` functions
+and `*Schema` objects. Invalid data throws `ContractValidationError`; its message
+contains the contract name, never the submitted values.
+
+`CredentialReceipt`, `CredentialReceiptError` and `CredentialReceiptRequestId` also
+export `assert*` functions and `*Schema` objects, generated from
+`GET /keys/me/receipts/{request_id}`. A receipt is a current scoped ledger observation;
+it does not rewrite the original completion checkpoint. Exact terminal allocations
+use `settled_spend_raw` decimal strings in raw FLOP units (10^18 raw = 1 FLOP).
+Unavailable values remain null. A pooled channel event is not a separate payment
+or burn transaction for each request. See the client's recovery example for authority,
+state, retention and manual replay rules.
+
+Validation checks structure without coercion, default insertion, or removal of
+fields. Responses allow extensions, including receipt evidence, exactly as the
+source schemas allow. Validating an envelope does not authenticate its evidence,
+verify a receipt, or establish settlement/finality. Request validation follows
+the API schema. `ChatCompletionStreamUsage` and `ChatCompletionToolCallFragment`
+also have types, `assert*` functions and `*Schema` objects. `assertChatCompletionStreamError` covers in-band
+broker errors (including estimated usage and retry hints), session expiry, and
+receipt reconciliation failures; it does not validate arbitrary HTTP error bodies.
+
+OpenAPI 3.1 models the SSE wire body as a string and references decoded data schemas
+through `x-sse-data-schema`. The literal `[DONE]` is a framing sentinel rather than
+a JSON chunk. Structural assertions validate individual frames; `@flop-labs/client`
+additionally enforces ordering, identity consistency, complete tool-call assembly,
+and terminal behavior.
+Estimated error usage does not become receipt evidence by passing validation.
+
+The published ESM package has no runtime dependencies. Types are generated with
+`json-schema-to-typescript`; AJV generates standalone JSON Schema 2020-12
+validators. Generation fails if validators start requiring runtime helpers,
+so a schema change cannot silently introduce a dependency.
+
+From the repository root:
+
+```sh
+pnpm --filter @flop-labs/contracts generate
+pnpm --filter @flop-labs/contracts check:generated
+pnpm --filter @flop-labs/contracts build
+pnpm --filter @flop-labs/contracts test
+```
+
+Generated files are checked in. Edit the canonical OpenAPI schemas, regenerate,
+and review their consumer impact together. Schema identities and package
+versions describe this contract artifact; they do not assert server or runtime
+compatibility.