@fleetless/sdk 2.1.0 → 3.0.1

package/CHANGELOG.md

@@ -4,6 +4,157 @@ All notable changes to `@fleetless/sdk`. The format follows Keep a Changelog; th
 
 ## [Unreleased]
 
+## [3.0.1] — 2026-09-07
+
+No API change. This release exists because **3.0.0 published internal material
+to the registry**, and the only way to withdraw it is to publish a version
+without it.
+
+### Fixed
+
+- **The published bundle no longer carries internal text.** `tsup` inlines
+  `@fleetless/contracts` into `dist/index.js` and `dist/index.cjs` with its doc
+  comments intact, and it writes the path each inlined module came from as a
+  comment beside it. In 3.0.0 those paths encoded a `git+ssh://` dependency
+  specifier, so an internal hostname appeared **48 times** across the two
+  bundles; the inlined comments carried German paragraphs and internal defect
+  ids with them. Measured over the published tarballs, the same seventeen
+  detectors over `dist/`:
+
+  | | 3.0.0 | 3.0.1 |
+  |---|---|---|
+  | internal host or workspace name | 49 | 0 |
+  | German prose | 58 | 0 |
+  | internal wave labels | 134 | 0 |
+  | internal decision labels | 42 | 0 |
+  | internal defect ids | 14 | 0 |
+  | every other class | 62 | 0 |
+
+  None of it appeared in this repository's own source, which is why no sweep of
+  the source had found it. The fix is the contracts pin — `@fleetless/contracts`
+  is a public npm package at an exact version now — plus a sweep of this
+  repository's own comments.
+
+- **`publishers.publish`, `commands.cancel`, `cameras.live` and the error
+  re-exports pointed at README sections that did not exist.** One of them
+  (`cancel`'s upgrade message) is a **runtime error** telling a developer to
+  read "the README's Actions section" of a README whose sections were named
+  something else. The README now has *Actions*, *Errors*, and *Publishers, and
+  no teleop helpers*, and every pointer resolves.
+
+### Added
+
+- **`SECURITY.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`**, and all three
+  ship inside the tarball, so the README's links resolve from `node_modules` and
+  from the npm page. `SECURITY.md` says what is in scope here — how this package
+  handles tokens, the PKCE verifier and the `state` value — and that the cloud
+  is not in this repository. Security reports go to **security@fleetless.dev**,
+  which the README now states literally rather than only by link.
+- **`repository` and `bugs.url`** in `package.json`, pointing at
+  <https://github.com/fleetless/sdk>.
+- **An `Errors` section in the README**, documenting the `FleetlessError` `code`
+  you branch on, that `rate_limited` is surfaced with its `retry_after_ms` and
+  never retried, and that `token_expired` is the one retry the SDK performs.
+- **The SPDX header `// SPDX-License-Identifier: MIT`** on every source file and
+  on all four published `dist/` files. `test/license-headers.test.ts` asserts it
+  over the repository; `pnpm run test:pack` asserts it over the tarball's own
+  bytes, which is the only place that can tell a stamped build from a stamped
+  publish.
+- **`test/published-prose.test.ts`**, which is what stops the top item here from
+  happening again: fifteen detector classes over `dist/`, `src/`, `test/`,
+  `scripts/` and the shipped markdown, with fixtures in both directions.
+
+## [3.0.0] — 2026-09-06
+
+Fleetless shows an app user **no page**. The developer's own UI owns every
+screen — login, registration, verification, invitation acceptance, password
+reset, the provider buttons, the MCP consent — and this release replaces the
+SDK's auth surface with the JSON API those screens call. The hosted,
+app-branded login and consent pages are gone from the platform, so they are
+gone from here.
+
+### Removed
+
+- **`auth.beginHostedLogin` and `auth.completeHostedLogin`**, with
+  `BeginHostedLoginOptions`, `HostedLoginRequest` and
+  `CompleteHostedLoginOptions`. The `/oauth/authorize` + `/oauth/token` flow
+  they drove no longer runs for app users. Use `auth.beginOidcLogin` and
+  `auth.completeOidcLogin` for federated sign-in, or `auth.login` for a
+  password.
+- **`client.grants`** (`GrantsApi`, `grants.list`, `grants.revoke`), with the
+  `ConsentGrantSummary` and `ConsentRevokeResponse` re-exports. The routes
+  behind it are gone. The MCP consents an app user can withdraw are now
+  `auth.listMcpGrants()` and `auth.revokeMcpGrant(clientId)`.
+- **`auth.passwordResetUrl()`**. It pointed at a Fleetless-served page that is
+  now the developer console's own, for Fleetless users rather than app users.
+  An app user's reset is `auth.requestPasswordReset` and
+  `auth.confirmPasswordReset`, in your own UI.
+- **`LogoutResult`**, and with it everything `logout()` used to report about
+  the identity provider behind a session. That apparatus belonged to the
+  hosted login, where Fleetless owned the browser; an app that wants to end a
+  provider session redirects there itself, knowing its own provider.
+- **`no_hosted_login_attempt`** from `SDK_ERROR_CODES`. The case it named —
+  nothing persisted for this attempt — still throws, as `state_mismatch`, and
+  the message still says which of the two happened.
+- `HttpClient.requestOAuth`, the SDK's only form-urlencoded call. Nothing
+  reaches `/oauth/token` from here any more.
+
+### Added
+
+- **Registration and verification**: `auth.register({ email, password,
+  displayName? })`, `auth.verifyEmail(token)`,
+  `auth.resendVerification(email)`.
+- **Recovery and invitations**: `auth.requestPasswordReset(email)`,
+  `auth.confirmPasswordReset(token, newPassword)`,
+  `auth.acceptInvitation({ token, password, displayName? })`. Every one of
+  these that spends a mailed token stores the session it answers with, so a
+  person is not asked to sign in again immediately after proving they can read
+  the mail.
+- **Federated sign-in, per app**: `auth.listProviders()` for the buttons,
+  `auth.beginOidcLogin({ slug, redirectUri })` to build the start URL with
+  PKCE, `auth.completeOidcLogin({ code, state, expectedState, codeVerifier })`
+  to trade the one-time code for a session, and
+  `auth.oidcErrorFromCallback(params)` to read a failed sign-in off the
+  redirect back as a `FleetlessError`. The SDK builds the URL and **never
+  navigates**; the app does.
+- **The MCP consent screen**: `auth.mcpInteraction(id)`,
+  `auth.approveMcpInteraction(id)`, `auth.denyMcpInteraction(id)`. Both
+  decisions answer where to send the browser, a denial included.
+- **The app user's own standing consents**: `auth.listMcpGrants()` and
+  `auth.revokeMcpGrant(clientId)`.
+- New option and result types: `RegisterOptions`, `AcceptInvitationOptions`,
+  `ProviderButton`, `BeginOidcLoginOptions`, `OidcLoginRequest`,
+  `CompleteOidcLoginOptions`, `McpInteractionDecision`. New wire re-exports:
+  `ClientMcpInteraction`, `McpConsentGrant`, `ClientOidcErrorCode`.
+
+### Changed
+
+- **`ClientIdentity` renamed two fields**: `kind: 'end_user'` is now
+  `'app_user'`, and `end_user_id` is now `app_user_id`. A rename rather than a
+  kept key, deliberately — the old subject was a member of the org's one pool,
+  the new one is a row belonging to exactly one app, and a consumer reading
+  `.end_user_id` would have typechecked while meaning something subtly
+  different.
+- **`logout()` resolves with `void`**, not a `LogoutResult`. It still never
+  rejects and still always clears the local store.
+- **A `serverKey` client refuses session methods with a `FleetlessError` whose
+  code is `invalid_option`**, where it used to throw a bare `Error` a caller
+  could only catch by message. `me()`, `listProviders()`, `mcpInteraction()`
+  and `oidcErrorFromCallback()` still work on one: the first is what a server
+  key is for, the next two are reads the cloud answers without a credential,
+  and the last touches no network.
+- `state_mismatch` is now thrown by `completeOidcLogin`, before any request.
+- Pinned to `@fleetless/contracts` `48acd56`.
+
+### Verification
+
+- The `auth` and OIDC suites now drive the SDK's **default** `fetch` against a
+  real `node:http` server (`test/local-api.ts`) rather than a `vi.fn()`. Every
+  assertion about a path, a method, a header or a body is made against bytes
+  that actually left the process — which is what shows, for instance, that the
+  two MCP decisions send no `content-type` on their bodyless `POST`, a header
+  a fake `fetch` records as absent exactly as convincingly when it is wrong.
+
 ## [2.1.0] — 2026-09-04
 
 ### Added

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@fleetless.dev. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -0,0 +1,130 @@
+# Contributing to `@fleetless/sdk`
+
+This package is the TypeScript client for the Fleetless API. It is what a
+developer's own application calls, so a change here reaches every app built on
+it, and a change to what a method *sends* reaches the platform as well.
+
+## Setup
+
+Node 22 and pnpm (through corepack):
+
+```sh
+nvm use 22
+corepack enable
+pnpm install
+```
+
+There are no private dependencies. `pnpm install` works from a clean checkout
+with nothing but a network connection to the npm registry — the wire schemas
+come from `@fleetless/contracts`, which is a public package.
+
+`pnpm install` runs `prepare`, which builds `dist/`. Some of the checks below
+read the built bundle, so a fresh checkout is ready for them.
+
+## The checks
+
+| Command | What it does |
+|---|---|
+| `pnpm typecheck` | `tsc --noEmit` over the whole project. |
+| `pnpm test` | The vitest suite. No network beyond loopback. |
+| `pnpm build` | `tsup` into `dist/` — ESM, CJS, and a declaration file for each. |
+| `pnpm run test:pack` | Packs the tarball, asserts what is and is not inside it, then installs it into a scratch project and both typechecks and runs real code against it. |
+
+To run one test file, use `pnpm vitest run test/<name>.test.ts`.
+
+## The rule this repository is most serious about: a real server, not a mocked `fetch`
+
+**The auth suites drive the SDK's own default `fetch` against a real
+`node:http` server** (`test/local-api.ts`), and no `fetch` option is passed to
+`createClient` in them.
+
+That is not ceremony. A suite that passes its own `fetch` never enters the code
+that actually ships: `client.ts` resolves `globalThis.fetch.bind(globalThis)`,
+and every assertion about "what the SDK sends" becomes an assertion about what
+a `vi.fn()` was asked to pretend to send. The two most expensive defects this
+package has had were both invisible to a mocked `fetch` and both obvious to a
+socket:
+
+- `createClient` defaulted to a **detached** `globalThis.fetch`. A real
+  browser's `fetch` is a Web IDL method that throws "Illegal invocation" unless
+  its receiver is the global object. Node's undici does not enforce that check,
+  so every test passed and every browser failed on the first call.
+- A path segment shaped like `../../../admin` reached a real server as a
+  traversal, because the encoding was asserted against a double that never
+  parsed the URL.
+
+So: **if your change is about what leaves the process, test it against
+`test/local-api.ts`.** A double is fine for testing branching, refcounting,
+timers and error mapping, and most of the suite uses one for exactly that.
+
+`test/client.test.ts` carries a test named for this property on its own, so
+that removing it is visible in a diff rather than silent.
+
+## Licence headers
+
+Every source file carries the SPDX header `// SPDX-License-Identifier: MIT` as
+its first line — a `#!` shebang is the only thing allowed above it.
+`test/license-headers.test.ts` asserts this over the whole set, and it takes
+that set from `git ls-files` rather than from a list of directories, so a file
+added anywhere in the repository is swept the day it exists.
+
+## Nothing internal reaches the published bytes
+
+`tsup` bundles `@fleetless/contracts` **into** `dist/index.js` and
+`dist/index.cjs`, doc comments and all, and it writes the path each inlined
+module came from as a comment beside it. A comment written for the people who
+build this is therefore a comment an editor shows to somebody who installed it —
+and for four published versions that included German paragraphs, internal
+defect ids and an internal hostname, none of which appeared anywhere in this
+repository's source.
+
+Write a comment as what the code does for a caller. Never as how the behaviour
+was found, on which machine, under which internal ticket, or in which language
+the team happened to be thinking that day.
+
+`test/published-prose.test.ts` enforces it over `dist/`, `src/`, `test/`,
+`scripts/` and the shipped markdown, and it will tell you which class of thing
+came back and on which line.
+
+## Pull requests
+
+**Pull requests are welcome on GitHub**, at
+<https://github.com/fleetless/sdk>. Open an issue first for anything that
+changes an existing method signature or what a method sends, so we can say what
+else has to move with it.
+
+**CI runs on GitLab.** This repository is mirrored from an internal GitLab
+instance, which is where the pipeline that verifies and publishes it lives. You
+will not see a check run on your GitHub pull request; a maintainer runs the
+same checks, and the result comes back as a review comment. Run
+`pnpm typecheck && pnpm test && pnpm run test:pack` yourself before you open the
+pull request and you will have seen everything CI would tell you.
+
+## The CLA
+
+The first pull request you open will ask you to sign a Contributor Licence
+Agreement. It grants Dehne Robotik GmbH the right to license your contribution
+under terms other than MIT in future — that is the whole of what it is for, and
+it is why the project can relicense its own code later without having to find
+every past contributor. It does not take your copyright away and it does not
+stop you from using your own contribution however you like.
+
+## Commit messages
+
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/):
+`feat:`, `fix:`, `docs:`, `chore:`, `ci:`, `refactor:`, `test:`. A change that
+alters an existing method's signature or what it sends is a breaking change;
+say so with a `!` and a `BREAKING CHANGE:` footer, because it decides the next
+version number.
+
+Everything in this repository is written in **English** — code, comments,
+commit messages, documentation.
+
+## Code of conduct
+
+By participating you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Releasing (maintainers)
+
+See [RELEASING.md](RELEASING.md). The pipeline publishes; `npm publish` from a
+working tree is not how a version gets to the registry.