@fleetless/contracts 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to `@fleetless/contracts` are recorded here. The format
+follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the
+project uses [semantic versioning](https://semver.org/spec/v2.0.0.html) over
+the wire shapes.
+
+## [1.0.0] — 2026-09-07
+
+The first published version. Nothing about the shapes changes with it: they are
+exactly the shapes the Fleetless cloud serves at release 0.17.0, and they have
+been the contract between the cloud, the console, the SDK and the robot-side
+bridge for as long as those have existed. What changes is who can read them —
+until now this package was resolvable only from a private git URL, so nobody
+outside the project could build a Fleetless client from source.
+
+Consumers should pin an exact version. A range cannot express "compatible with
+the server you are talking to", and that is the only compatibility question
+these schemas answer. Any change that makes a previously valid message invalid
+— a new required field, a narrowed bound, a removed enum member, a renamed
+error code — is a **major** version, without exception and regardless of how
+small it looks from inside the repository.
+
+Published under Apache-2.0. The JSON Schema and OpenAPI artifacts ship in the
+package under `artifacts/` and are importable by path, which is what a consumer
+in another language needs.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/NOTICE

@@ -0,0 +1,17 @@
+Fleetless Contracts
+Copyright 2026 Dehne Robotik GmbH
+
+This product includes software developed at Dehne Robotik GmbH
+(https://dehne-robotik.de).
+
+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 in the LICENSE file next to this one, or 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,88 @@
+# `@fleetless/contracts`
+
+The wire contracts for [Fleetless](https://fleetless.dev): every shape the
+Fleetless API accepts or returns, and every message a robot's bridge exchanges
+with the cloud, written once as [zod](https://zod.dev) schemas and exported as
+JSON Schema and OpenAPI.
+
+Fleetless turns a ROS 2 robot into a REST and realtime API. A developer
+configures which topics, services, actions and cameras a robot exposes; client
+apps consume those over HTTP and WebSocket. This package is the definition of
+what goes over that wire — it is the same file the server validates with, so a
+client built against it cannot disagree with the server about a field name, a
+bound or an error code.
+
+```sh
+npm i @fleetless/contracts
+```
+
+## TypeScript
+
+Import the schemas and the types inferred from them:
+
+```ts
+import { robotListResponse, ERROR_CODES } from '@fleetless/contracts'
+import type { RobotListResponse, ErrorCode } from '@fleetless/contracts'
+
+const robots: RobotListResponse = robotListResponse.parse(await res.json())
+```
+
+Everything is exported from the package root. There is no deep import for the
+TypeScript surface.
+
+Most application developers do not need this package directly:
+[`@fleetless/sdk`](https://www.npmjs.com/package/@fleetless/sdk) is the client
+library, and it already speaks these shapes. Reach for `@fleetless/contracts`
+when you are writing something the SDK does not cover — a server-side
+integration, your own client, or a validator in another language.
+
+## JSON Schema and OpenAPI
+
+Consumers that are not TypeScript read the generated documents under
+`artifacts/`, which ship inside the published package and are importable by
+path:
+
+```ts
+import routes from '@fleetless/contracts/artifacts/routes.json' with { type: 'json' }
+import openapi from '@fleetless/contracts/artifacts/openapi.json' with { type: 'json' }
+```
+
+| Path | What it is |
+|---|---|
+| `artifacts/openapi.json` | The OpenAPI description of the REST API. |
+| `artifacts/routes.json` | Every route with its request and response schema names. |
+| `artifacts/schema/*.json` | One JSON Schema per wire shape, named after the shape. |
+| `artifacts/schema-outgoing/*.json` | The messages the cloud sends to a bridge. |
+
+The robot-side bridge validates against `artifacts/schema/` with Python's
+`jsonschema`, which is why the artifacts are generated and committed rather
+than produced at install time: a consumer in another language needs them
+without running a TypeScript build.
+
+## Versioning
+
+Semantic versioning over the wire shapes. A change that makes a previously
+valid message invalid — a new required field, a narrowed bound, a removed
+enum member — is a **major**. Adding an optional field, a new enum member a
+client may ignore, or a description is a minor or a patch.
+
+Pin an exact version. These shapes describe a running server, and "compatible
+with the server you are talking to" is not something a range can express.
+
+## Documentation
+
+The API reference at
+[docs.fleetless.dev/reference/api](https://docs.fleetless.dev/reference/api) is
+generated from these artifacts and is the place to read what a field means.
+This package is the place to read what it *is*.
+
+## Contributing and security
+
+[CONTRIBUTING.md](CONTRIBUTING.md) has the setup, the checks and the pull
+request process. [SECURITY.md](SECURITY.md) has the reporting address and what
+counts as a security report here — a schema that lets a bad value through is
+one, even though nothing in this package executes it.
+
+## Licence
+
+[Apache-2.0](LICENSE). Copyright 2026 Dehne Robotik GmbH.

package/artifacts/constants.json

@@ -0,0 +1,24 @@
+{
+  "AUDIT_RETENTION_DAYS": 90,
+  "ASSET_UPLOAD_HEADERS": {
+    "kind": "x-fleetless-asset-kind",
+    "name": "x-fleetless-asset-name",
+    "nameEncoded": "x-fleetless-asset-name-encoded",
+    "syncId": "x-fleetless-sync-id",
+    "size": "x-fleetless-asset-size"
+  },
+  "ASSET_UPLOAD_MAX_BYTES": 67108864,
+  "SNAPSHOT_HEADERS": {
+    "ageMs": "x-fleetless-age-ms",
+    "timestampMs": "x-fleetless-timestamp-ms",
+    "width": "x-fleetless-width",
+    "height": "x-fleetless-height"
+  },
+  "URDF_ASSET_NAME": "robot_description",
+  "ASSET_KINDS": [
+    "urdf",
+    "mesh",
+    "texture",
+    "other"
+  ]
+}