@kottera/tera-web 0.0.0-stage → 0.1.0-rc.2

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 2026 Kottera
+
+   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,28 @@
+Kottera SDK
+Copyright 2026 Kottera
+
+This product includes software developed by Kottera.
+
+The Kottera SDK (github.com/kottera/sdk) is the public, stable surface of the
+Kottera platform: the capability contract and schema, the tool SDK, the connector
+SDK contract and the standalone connector-authoring SDK, credential specifications
+and keychain resolution, the KPP provider-protocol handshake and its env/conn
+dialect frame schemas, and the sandbox/telemetry OTLP-JSON frame schemas
+(ADR-059 Part 1, surfaces 1-4). It is licensed under the Apache License, Version
+2.0; see the LICENSE file in this directory.
+
+This SDK module MUST NOT import any github.com/kottera/kottera/... package. The
+Kottera daemon (`tera`) is a separate, private-source work and is NOT licensed
+under this Apache License; it is distributed as a free-to-use binary governed by
+the Kottera End User License Agreement that accompanies each release.
+
+----------------------------------------------------------------------------------
+Third-party components
+----------------------------------------------------------------------------------
+
+This module depends on third-party Go packages resolved via go.mod / go.sum. Their
+copyrights and licenses are held by their respective authors and are reproduced in
+the third-party license inventory bundled with each release (the `licenses/`
+directory produced by the release SBOM tooling). No third-party dependency of this
+module is licensed under a copyleft license (GPL/LGPL/AGPL); all are permissive
+(Apache-2.0, MIT, BSD-2-Clause, or BSD-3-Clause).

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @kottera/tera-web
 
-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.
+The browser half of a UI over tera ([ADR-162](../../docs/adr/ADR-162-a-ui-over-tera.md)
+D4): a framework-free TypeScript client for the `/tera/v1/` routes a plugin's
+webui kit serves (D3). It carries no UI component — the framework is the
+author's — and has no runtime dependencies. It is not yet published.
+
+## Layout
+
+| Path | What it holds |
+|------|---------------|
+| `src/index.ts` | The package's one entry point. Everything public is re-exported here. |
+| `src/routes.ts` | The route prefix and `routePath`. |
+| `src/client.ts` | `TeraClient`, the typed client over D3's routes (D4 items 1, 3 and 4): `me()`, `invoke(capability, params)`, `feed(options)` (a `FeedConnection` read with the client's fetch), `upload(file, options)` with progress, and `signOut()`. A kit refusal throws `KitRequestError`; a verb's refusal answers as its verdict. |
+| `src/generated/` | The contract, generated from the committed schemas under `sdk/plugin/webui/schema/`, `sdk/workorder/schema/` and `sdk/feed/schema/` (D4 item 1): one type per schema, the kit's route table as `KIT_ROUTE_TABLE`, and the maps from a route or a feed event to the type it carries. Never hand-edited, and never hand-write a type it declares: `make web-types` regenerates it, and `TestWebTypes_MatchCommitted` (`cmd/internal/genwebtypes`) fails on a hand edit or a stale generation. |
+| `src/feed/` | The stream connection (D4 item 2). |
+| `src/**/*.test.ts` | The suite, beside what it tests. |
+
+## Tests
+
+```
+make test-web-sdk
+```
+
+runs `node --test` inside this directory on the host's `node`, at or above
+`package.json`'s `engines.node`. Nothing is installed: the tests use only
+`node:test` and `node:assert`, and node strips the sources' types itself, so
+write only erasable TypeScript (no `enum`, no `namespace`, no parameter
+properties) and import siblings by their `.ts` name. The gate runs the same
+suite for any diff under `sdk/web/`
+([`docs/testing-infrastructure.md`](../../docs/testing-infrastructure.md),
+"The browser package").
+
+The gate does not type-check: `tsc` would have to be fetched. `tsconfig.json`
+is here for an author with one, `tsc -p sdk/web`. What the gate does run over
+the generated types is `src/contract.test.ts`: every committed schema has a
+generated type, the route table is the committed one, and a fixture of each
+D3 shape, annotated with its generated type, is valid against its schema.

package/dist/client.d.ts

@@ -0,0 +1,138 @@
+import { FeedConnection, type FeedConnectionOptions } from "./feed/connection.ts";
+import type { KitError, KitInvokeResponse, KitMeResponse, KitUploadResponse } from "./generated/kit.ts";
+/** The body of a kit failure: the envelope's `error` member. */
+export type KitErrorBody = KitError["error"];
+/** A verb's refusal, as the kit passed it through: the reply envelope's `error` member. */
+export type VerbRefusal = NonNullable<KitInvokeResponse["error"]>;
+/**
+ * What {@link TeraClient.invoke} answers when the verb ran: its result, or its
+ * refusal. `Result` is the verb's result type — for a Work Order verb, the
+ * generated `WorkOrder<Verb>Result`.
+ */
+export type InvokeVerdict<Result = unknown> = {
+    readonly status: "success";
+    readonly result: Result;
+} | {
+    readonly status: "error";
+    readonly error: VerbRefusal;
+};
+/**
+ * The `code` of a {@link KitRequestError} whose answer was not the kit's
+ * envelope — a proxy's page, a dropped body, a success that is not the
+ * route's JSON. It is this package's, never one the kit sends.
+ */
+export declare const UNRECOGNIZED_RESPONSE = "unrecognized_response";
+/**
+ * A kit route that did not answer as the route: the kit's own refusal, or
+ * something that was not the route's answer at all.
+ */
+export declare class KitRequestError extends Error {
+    /** The HTTP status the route answered with. */
+    readonly status: number;
+    /**
+     * The envelope's code, as it arrived — one of the kit's `KitErrorCode`s, or
+     * a code this package does not know, kept as it is — or
+     * {@link UNRECOGNIZED_RESPONSE} when there was no envelope.
+     */
+    readonly code: string;
+    /** Whether the identical request may succeed if sent again later. Branch on this, never on a list of codes. */
+    readonly retryable: boolean;
+    /** How long to wait before retrying, when the envelope said. */
+    readonly retryAfterMs: number | undefined;
+    /** The envelope's structured detail, when it carried any. */
+    readonly data: unknown;
+    /** The envelope as it arrived, or null when the answer carried none. */
+    readonly envelope: KitErrorBody | null;
+    constructor(status: number, envelope: KitErrorBody | null, fallback: string);
+}
+/** The progress of one upload's body. */
+export interface UploadProgress {
+    /** Bytes sent so far. */
+    readonly loaded: number;
+    /** Bytes to send: the file's size. */
+    readonly total: number;
+}
+export interface UploadOptions {
+    /** The file's name; the `File`'s own name when absent. Required by the route: an upload with neither is refused before it is sent. */
+    filename?: string;
+    /** The file's media type; the `Blob`'s own type, or `application/octet-stream`, when absent. */
+    contentType?: string;
+    /** A description of the file, carried to the artifact. */
+    description?: string;
+    /** Called as the body is sent. */
+    onProgress?: (progress: UploadProgress) => void;
+    /** Aborting it cancels the upload, which then rejects with an `AbortError`. */
+    signal?: AbortSignal;
+}
+/**
+ * The part of `XMLHttpRequest` the upload helper uses. Upload progress is the
+ * reason it is not `fetch`: a fetch reports nothing while its body is sent.
+ */
+export interface UploadRequest {
+    open(method: string, url: string): void;
+    setRequestHeader(name: string, value: string): void;
+    send(body: Blob): void;
+    abort(): void;
+    readonly status: number;
+    readonly responseText: string;
+    getResponseHeader(name: string): string | null;
+    withCredentials: boolean;
+    onload: ((ev: unknown) => void) | null;
+    onerror: ((ev: unknown) => void) | null;
+    onabort: ((ev: unknown) => void) | null;
+    readonly upload: {
+        onprogress: ((ev: {
+            loaded: number;
+            total: number;
+            lengthComputable: boolean;
+        }) => void) | null;
+    };
+}
+export interface TeraClientOptions {
+    /** The fetch every route but the upload is read with; the page's own when absent. */
+    fetch?: typeof fetch;
+    /** Makes the upload's request; `new XMLHttpRequest()` when absent. */
+    uploadRequest?: () => UploadRequest;
+    /** Sends the page to a path; `location.assign` when absent. */
+    navigate?: (path: string) => void;
+}
+/** The options of {@link TeraClient.feed}: a {@link FeedConnection}'s, with the opener the client's own. */
+export type FeedOptions = Omit<FeedConnectionOptions, "open">;
+export declare class TeraClient {
+    private readonly fetchFn;
+    private readonly uploadRequest;
+    private readonly navigate;
+    constructor(options?: TeraClientOptions);
+    /** `GET /tera/v1/me`: who is signed in, and where to send them to sign out. */
+    me(): Promise<KitMeResponse>;
+    /**
+     * `POST /tera/v1/invoke/{capability}`: invokes one capability as the
+     * signed-in person, with `params` as its params, and answers the verb's
+     * verdict. A refusal by the verb answers `{ status: "error" }`; only the
+     * kit's own refusal, or an answer that is not the route's, throws.
+     *
+     *     const got = await client.invoke<WorkOrderGetResult, WorkOrderGetParams>("work_order.get", { id });
+     *     if (got.status === "success") show(got.result);
+     */
+    invoke<Result = unknown, Params = unknown>(capability: string, params?: Params): Promise<InvokeVerdict<Result>>;
+    /**
+     * A {@link FeedConnection} over `GET /tera/v1/feeds/{feed}`, read with this
+     * client's fetch. It is not started: call `start()` on it, and `stop()` when
+     * the page no longer wants it.
+     */
+    feed(options: FeedOptions): FeedConnection;
+    /**
+     * `POST /tera/v1/uploads`: sends one file as the signed-in person and
+     * answers the staged artifact, whose `handle` a Work Order's attachments
+     * name. Its name and description travel percent-encoded (UTF-8) in the
+     * route's headers, and `onProgress` reports the body as it is sent.
+     */
+    upload(file: Blob, options?: UploadOptions): Promise<KitUploadResponse>;
+    /**
+     * Signs the person out: navigates to the `signout_path` `me()` answers,
+     * tera's own path, which ends their session for every plugin. A path that
+     * is not one on this origin is refused rather than followed.
+     */
+    signOut(): Promise<void>;
+    private json;
+}

package/dist/client.js

@@ -0,0 +1,250 @@
+/**
+ * The typed client over D3's routes (ADR-162 D4 items 1, 3 and 4): who is
+ * signed in, invoking a capability as them, opening a feed, uploading a file
+ * with progress, and signing out.
+ *
+ * Every type here for what the contract declares — a route's answer, the
+ * error envelope, the upload's answer — is the one generated into
+ * `./generated/` from the committed schemas; none is written by hand. A
+ * Work Order verb's params and result are generated there too
+ * (`WorkOrderGetParams`, `WorkOrderGetResult`, …), and a caller names them as
+ * {@link TeraClient.invoke}'s type arguments.
+ *
+ * # Two kinds of failure, kept apart
+ *
+ * - **The kit's refusal** — no verified caller, a cross-origin write, an
+ *   unknown or unserved route — and anything else that is not the route's
+ *   answer, is thrown as a {@link KitRequestError}, carrying the kit's
+ *   envelope (`code`, `message`, `retryable`) as it arrived.
+ * - **A verb's refusal** is not a failure of the route. The verb ran and said
+ *   no; the kit passes its verdict through with HTTP 200 (D3), and
+ *   {@link TeraClient.invoke} answers it as that verdict, `{ status: "error",
+ *   error }`, beside `{ status: "success", result }`.
+ *
+ * # Same origin
+ *
+ * Every request is to a path under the kit's prefix on the page's own origin,
+ * with `credentials: "same-origin"`; a fetch is also `mode: "same-origin"`, so
+ * a page that somehow aimed one elsewhere is refused by the browser rather
+ * than sent. The browser then marks it `Sec-Fetch-Site: same-origin`, which is
+ * what the kit's same-origin rule for writes admits (D3). No header here
+ * claims it: a page cannot set `Sec-Fetch-*` or `Origin`, and the rule rests
+ * on that.
+ *
+ * It is a plain class with an injected fetch, request factory and navigation,
+ * so its tests drive it against a fake and no network.
+ */
+import { routePath } from "./routes.js";
+import { FeedConnection } from "./feed/connection.js";
+import { fetchOpener } from "./feed/sse.js";
+/**
+ * The `code` of a {@link KitRequestError} whose answer was not the kit's
+ * envelope — a proxy's page, a dropped body, a success that is not the
+ * route's JSON. It is this package's, never one the kit sends.
+ */
+export const UNRECOGNIZED_RESPONSE = "unrecognized_response";
+/**
+ * A kit route that did not answer as the route: the kit's own refusal, or
+ * something that was not the route's answer at all.
+ */
+export class KitRequestError extends Error {
+    /** The HTTP status the route answered with. */
+    status;
+    /**
+     * The envelope's code, as it arrived — one of the kit's `KitErrorCode`s, or
+     * a code this package does not know, kept as it is — or
+     * {@link UNRECOGNIZED_RESPONSE} when there was no envelope.
+     */
+    code;
+    /** Whether the identical request may succeed if sent again later. Branch on this, never on a list of codes. */
+    retryable;
+    /** How long to wait before retrying, when the envelope said. */
+    retryAfterMs;
+    /** The envelope's structured detail, when it carried any. */
+    data;
+    /** The envelope as it arrived, or null when the answer carried none. */
+    envelope;
+    constructor(status, envelope, fallback) {
+        super(envelope?.message ?? fallback);
+        this.name = "KitRequestError";
+        this.status = status;
+        this.envelope = envelope;
+        this.code = envelope?.code ?? UNRECOGNIZED_RESPONSE;
+        // Without an envelope only the status speaks: a 5xx, a 408 or a 429 says "later".
+        this.retryable = envelope?.retryable ?? (status >= 500 || status === 408 || status === 429);
+        this.retryAfterMs = envelope?.retry_after_ms;
+        this.data = envelope?.data;
+    }
+}
+const JSON_TYPE = "application/json";
+export class TeraClient {
+    fetchFn;
+    uploadRequest;
+    navigate;
+    constructor(options = {}) {
+        this.fetchFn = options.fetch ?? ((...args) => globalThis.fetch(...args));
+        this.uploadRequest = options.uploadRequest ?? (() => new XMLHttpRequest());
+        this.navigate = options.navigate ?? ((path) => globalThis.location.assign(path));
+    }
+    /** `GET /tera/v1/me`: who is signed in, and where to send them to sign out. */
+    async me() {
+        return this.json(routePath("me"), { method: "GET" });
+    }
+    /**
+     * `POST /tera/v1/invoke/{capability}`: invokes one capability as the
+     * signed-in person, with `params` as its params, and answers the verb's
+     * verdict. A refusal by the verb answers `{ status: "error" }`; only the
+     * kit's own refusal, or an answer that is not the route's, throws.
+     *
+     *     const got = await client.invoke<WorkOrderGetResult, WorkOrderGetParams>("work_order.get", { id });
+     *     if (got.status === "success") show(got.result);
+     */
+    async invoke(capability, params) {
+        const url = routePath("invoke", capability);
+        const reply = await this.json(url, {
+            method: "POST",
+            headers: { "Content-Type": JSON_TYPE },
+            body: JSON.stringify(params ?? {}),
+        });
+        if (reply.status === "success" && reply.result !== undefined) {
+            return { status: "success", result: reply.result.structured };
+        }
+        if (reply.status === "error" && reply.error !== undefined) {
+            return { status: "error", error: reply.error };
+        }
+        throw new KitRequestError(200, null, `${url} answered a reply envelope with no ${reply.status === "error" ? "error" : "result"}`);
+    }
+    /**
+     * A {@link FeedConnection} over `GET /tera/v1/feeds/{feed}`, read with this
+     * client's fetch. It is not started: call `start()` on it, and `stop()` when
+     * the page no longer wants it.
+     */
+    feed(options) {
+        return new FeedConnection({ ...options, open: fetchOpener(this.fetchFn) });
+    }
+    /**
+     * `POST /tera/v1/uploads`: sends one file as the signed-in person and
+     * answers the staged artifact, whose `handle` a Work Order's attachments
+     * name. Its name and description travel percent-encoded (UTF-8) in the
+     * route's headers, and `onProgress` reports the body as it is sent.
+     */
+    upload(file, options = {}) {
+        const filename = options.filename ?? file.name ?? "";
+        if (filename === "") {
+            return Promise.reject(new TypeError("upload: a filename is required: pass a File, or options.filename"));
+        }
+        const contentType = options.contentType || file.type || "application/octet-stream";
+        const url = routePath("uploads");
+        const { signal, onProgress } = options;
+        if (signal?.aborted)
+            return Promise.reject(abortError());
+        return new Promise((resolve, reject) => {
+            const xhr = this.uploadRequest();
+            const onAbort = () => xhr.abort();
+            const settle = () => signal?.removeEventListener("abort", onAbort);
+            xhr.open("POST", url);
+            // Same origin sends the page's cookies; it never needs withCredentials.
+            xhr.withCredentials = false;
+            xhr.setRequestHeader("Content-Type", contentType);
+            xhr.setRequestHeader("Tera-Upload-Filename", encodeURIComponent(filename));
+            if (options.description !== undefined && options.description !== "") {
+                xhr.setRequestHeader("Tera-Upload-Description", encodeURIComponent(options.description));
+            }
+            xhr.setRequestHeader("Accept", JSON_TYPE);
+            if (onProgress !== undefined) {
+                xhr.upload.onprogress = (ev) => onProgress({ loaded: ev.loaded, total: ev.lengthComputable ? ev.total : file.size });
+            }
+            xhr.onload = () => {
+                settle();
+                try {
+                    resolve(answer(url, xhr.status, xhr.getResponseHeader("content-type") ?? "", xhr.responseText));
+                }
+                catch (err) {
+                    reject(err);
+                }
+            };
+            xhr.onerror = () => {
+                settle();
+                reject(new TypeError(`${url}: the upload failed with no answer`));
+            };
+            xhr.onabort = () => {
+                settle();
+                reject(abortError());
+            };
+            signal?.addEventListener("abort", onAbort, { once: true });
+            try {
+                xhr.send(file);
+            }
+            catch (err) {
+                settle();
+                reject(err);
+            }
+        });
+    }
+    /**
+     * Signs the person out: navigates to the `signout_path` `me()` answers,
+     * tera's own path, which ends their session for every plugin. A path that
+     * is not one on this origin is refused rather than followed.
+     */
+    async signOut() {
+        const { signout_path: path } = await this.me();
+        if (typeof path !== "string" || !path.startsWith("/") || path.startsWith("//") || path.startsWith("/\\")) {
+            throw new KitRequestError(200, null, `${routePath("me")} answered a signout_path that is not a path on this origin: ${JSON.stringify(path)}`);
+        }
+        this.navigate(path);
+    }
+    async json(url, init) {
+        const response = await this.fetchFn(url, {
+            ...init,
+            headers: { Accept: JSON_TYPE, ...init.headers },
+            credentials: "same-origin",
+            mode: "same-origin",
+            cache: "no-store",
+        });
+        let text = "";
+        try {
+            text = await response.text();
+        }
+        catch {
+            // An unread body is read as no envelope: the status decides.
+        }
+        return answer(url, response.status, response.headers.get("content-type") ?? "", text);
+    }
+}
+/**
+ * Reads a route's answer: on a 2xx, the JSON body the route declares; on
+ * anything else, the kit's envelope as a thrown {@link KitRequestError}.
+ */
+function answer(url, status, contentType, text) {
+    const isJSON = contentType.toLowerCase().split(";")[0].trim() === JSON_TYPE;
+    let body;
+    if (isJSON) {
+        try {
+            body = JSON.parse(text);
+        }
+        catch {
+            body = undefined;
+        }
+    }
+    if (status >= 200 && status < 300) {
+        if (typeof body === "object" && body !== null)
+            return body;
+        throw new KitRequestError(status, null, `${url} answered HTTP ${status} with a body that is not its JSON (${contentType || "no content type"})`);
+    }
+    throw new KitRequestError(status, envelopeOf(body), `${url} answered HTTP ${status} (${contentType || "no content type"})`);
+}
+/** The envelope's `error` member, when `body` is a kit envelope; null otherwise. */
+function envelopeOf(body) {
+    if (typeof body !== "object" || body === null)
+        return null;
+    const error = body.error;
+    if (typeof error !== "object" || error === null)
+        return null;
+    const e = error;
+    if (typeof e.code !== "string" || typeof e.message !== "string" || typeof e.retryable !== "boolean")
+        return null;
+    return e;
+}
+function abortError() {
+    return new DOMException("the upload was aborted", "AbortError");
+}