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

package/dist/generated/kit.js

@@ -0,0 +1,148 @@
+// Code generated by cmd/internal/genwebtypes from sdk/plugin/webui/schema/v1/; DO NOT EDIT.
+// Regenerate with `make web-types` (ADR-162 D4 item 1).
+/**
+ * Every type this module declares, mapped to the repository path of the schema
+ * it was generated from.
+ */
+export const KIT_SCHEMAS = {
+    KitErrorCode: "sdk/plugin/webui/schema/v1/error-code.json",
+    KitError: "sdk/plugin/webui/schema/v1/error.json",
+    KitFeedEventReauthenticate: "sdk/plugin/webui/schema/v1/feed.event.reauthenticate.json",
+    KitInvokeResponse: "sdk/plugin/webui/schema/v1/invoke.response.json",
+    KitMeResponse: "sdk/plugin/webui/schema/v1/me.response.json",
+    KitUploadResponse: "sdk/plugin/webui/schema/v1/upload.response.json",
+};
+/** The prefix every kit route is served under (ADR-162 D3). */
+export const KIT_ROUTE_PREFIX = "/tera/v1/";
+/** tera's own sign-out path, which `GET /tera/v1/me` answers as signout_path. */
+export const KIT_SIGNOUT_PATH = "/_tera/signout";
+/** The kit's route table (ADR-162 D3), as sdk/plugin/webui declares it. */
+export const KIT_ROUTE_TABLE = {
+    prefix: "/tera/v1/",
+    signout_path: "/_tera/signout",
+    same_origin: "A route marked same_origin refuses a request unless it is same-origin: when the request carries Sec-Fetch-Site, that header must be same-origin; when it does not, its Origin must equal the request's own (scheme http or https, and the Host the request was sent to). The refusal is 403 cross_origin.",
+    public: "None. Every route under the prefix refuses a request with no verified caller, 401 unauthenticated, before anything else is decided. Only the app's assets, outside the prefix, are served to an anonymous request.",
+    error: {
+        media_type: "application/json",
+        schema: "https://kottera.dev/schemas/plugin/webui/error/v1",
+        description: "Every failure of every route: the kit's own refusal, under one of the error-code vocabulary, or a verb's refusal passed through as the verb gave it.",
+    },
+    routes: [
+        {
+            name: "me",
+            method: "GET",
+            path: "/tera/v1/me",
+            summary: "Who is signed in, and where to send them to sign out.",
+            same_origin: false,
+            response: {
+                media_type: "application/json",
+                schema: "https://kottera.dev/schemas/plugin/webui/me.response/v1",
+                description: "The signed-in person.",
+            },
+        },
+        {
+            name: "invoke",
+            method: "POST",
+            path: "/tera/v1/invoke/{capability}",
+            summary: "Invoke one capability as the person, with the request body as its params. tera decides it on the person's token; the kit vets nothing.",
+            same_origin: true,
+            path_params: [
+                {
+                    name: "capability",
+                    description: "The capability to invoke, e.g. work_order.get.",
+                    required: true,
+                },
+            ],
+            request: {
+                media_type: "application/json",
+                description: "The capability's params. For a work_order.* verb, valid against sdk/workorder/schema/v1/<verb>.params.json.",
+            },
+            response: {
+                media_type: "application/json",
+                schema: "https://kottera.dev/schemas/plugin/webui/invoke.response/v1",
+                description: "The verb's reply envelope, HTTP 200 whenever the verb ran, refusals included.",
+            },
+        },
+        {
+            name: "feed",
+            method: "GET",
+            path: "/tera/v1/feeds/{feed}",
+            summary: "Open a feed as the person: server-sent events carrying feed records and status frames verbatim.",
+            same_origin: false,
+            path_params: [
+                {
+                    name: "feed",
+                    description: "The feed's name.",
+                    required: true,
+                },
+            ],
+            query: [
+                {
+                    name: "topics",
+                    description: "Selects a subset of the topics the person may subscribe to; each occurrence may be a comma-separated list. Widening is refused.",
+                    repeated: true,
+                },
+                {
+                    name: "backfill",
+                    description: "Precede the live stream with the stored history of the run the connection selected.",
+                    values: [
+                        "all",
+                    ],
+                },
+            ],
+            response: {
+                media_type: "text/event-stream",
+                description: "A stream of the events below, until the person's token expires or either side closes it. Any other feed frame (a heartbeat, a batch, a type this kit does not know) is relayed verbatim as an unnamed event, read by its own type.",
+            },
+            events: [
+                {
+                    name: "record",
+                    schema: "https://kottera.dev/schemas/feed/frame.record/v1",
+                    description: "A feed record frame, verbatim.",
+                },
+                {
+                    name: "status",
+                    schema: "https://kottera.dev/schemas/feed/frame.status/v1",
+                    description: "A feed status frame, verbatim; loss is reported here and nowhere else.",
+                },
+                {
+                    name: "reauthenticate",
+                    schema: "https://kottera.dev/schemas/plugin/webui/feed.event.reauthenticate/v1",
+                    description: "The last event of a stream closed because the person's token expired. Reconnect at once.",
+                },
+            ],
+        },
+        {
+            name: "upload",
+            method: "POST",
+            path: "/tera/v1/uploads",
+            summary: "Upload one file as the person (ADR-123): the kit streams the body once, digesting it, then authorizes and stores it.",
+            same_origin: true,
+            headers: [
+                {
+                    name: "Content-Type",
+                    description: "The file's media type.",
+                    required: true,
+                },
+                {
+                    name: "Tera-Upload-Filename",
+                    description: "The file's name, percent-encoded UTF-8.",
+                    required: true,
+                },
+                {
+                    name: "Tera-Upload-Description",
+                    description: "A description of the file, percent-encoded UTF-8.",
+                },
+            ],
+            request: {
+                media_type: "application/octet-stream",
+                description: "The file's bytes, any media type. The body is read against its declared Content-Length, capped by the 33554432-byte (32 MiB) bound on an input artifact; a body with no declared length is held to the cap. A declaration over the cap is refused before the body is read, and a body is refused at the first byte past its bound, never after it is read whole.",
+            },
+            response: {
+                media_type: "application/json",
+                schema: "https://kottera.dev/schemas/plugin/webui/upload.response/v1",
+                description: "The staged artifact.",
+            },
+        },
+    ],
+};

package/dist/generated/workorder-events.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The vocabulary of the event types within the `workorder` payload.
+ *
+ * Every member the daemon writes. A later level adds members and removes none (ADR-143 D3); how a consumer reads an unknown member is ADR-143 D13's.
+ *
+ * Schema: sdk/workorder/schema/events/v1/event-kind.workorder.json
+ */
+export type WorkOrderEventKind = "cohort.set" | "off_tera.wake" | "relation.set" | "relation.removed" | "off_tera.taken" | "off_tera.progress" | "off_tera.reposted" | "off_tera.late_report" | "off_tera.checks_started" | "created" | "transitioned" | "acknowledged" | "retention_expired" | "edited" | "seat.reclaimed" | "claim.overdue" | "claim.unreadable" | "subject_claim.overridden" | "seat.cooling" | "seat.credential_held" | "member_credential.requested" | "member_credential.settled" | "seat.acquired" | "seat.runner_released" | "seat.meters_voided" | "step.binding" | "session.terminated" | "postcondition.verdict" | "parked_run.unreadable" | "parked_run.reclaimed" | "dispatch.settled_unobserved" | "parked_run.parked" | "parked_run.resumed" | "resume.refused" | "dispatch.salvaged" | "workspace.retired" | "dispatch.routed" | "session.lost" | "activity_partition.pinned" | "session.continuity" | "session.context_compacted" | "upstream.answer_forwarded" | "invocation.checkpoint" | "invocation.guidance" | "invocation.guidance.ack" | "invocation.reply" | "invocation.checkpoint.unreadable" | "invocation.guidance.unreadable" | "config_pin.unreadable" | "config_pin.repinned" | "type.followed" | "observation.scrubbed" | "observation.secret-shape-redacted" | "observation.promoted" | "observation.refuted" | "observation.purged" | "conversation.input_barrier" | "walk_resume.fell_back" | "store.ahead_of_binary" | "artifact.published" | "history.dropped" | "history.archived" | "seat.work_order_released" | "step.settled_late" | "step.reattached" | "relay.unrebuilt";
+/**
+ * `workorder` event payload (event/workorder).
+ *
+ * The payload published on every topic of the `workorder` family, generated from github.com/kottera/sdk/workorder.Envelope.
+ *
+ * Schema: sdk/workorder/schema/events/v1/payload.workorder.json
+ */
+export type WorkOrderEventPayload = {
+    /** The event row's primary key: monotonic across every Work Order, and the replay cursor (ADR-078 D3). */
+    id: number;
+    /** The owning Work Order's UUIDv7. */
+    work_order_id: string;
+    /** The owning Work Order's namespaced type key (<vault>/work-order-types/<stem>); absent only on an event with no Work Order row (ADR-142 D3). */
+    work_order_type?: string;
+    /** The event timestamp, RFC 3339 with nanosecond precision, UTC. */
+    ts: string;
+    /** Who caused the event, as stored. The shape written is an EventActor; a row written before a field existed lacks that key. */
+    actor?: unknown;
+    /** The event's type within the family; a member of the event-kind vocabulary, and a value this version does not know is kept verbatim (ADR-143 D13). */
+    kind: string;
+    /** The state before the transition; absent on created. */
+    from_state?: string;
+    /** The state after the transition. */
+    to_state?: string;
+    /** The optional human-readable reason for the transition. */
+    reason?: string;
+    /** The per-event payload as stored, whose shape the event kind decides. */
+    payload?: unknown;
+    /** The persisted-schema marker of the envelope. */
+    schema_version: string;
+};
+/**
+ * Every type this module declares, mapped to the repository path of the schema
+ * it was generated from.
+ */
+export declare const WORK_ORDER_EVENT_SCHEMAS: {
+    readonly WorkOrderEventKind: "sdk/workorder/schema/events/v1/event-kind.workorder.json";
+    readonly WorkOrderEventPayload: "sdk/workorder/schema/events/v1/payload.workorder.json";
+};

package/dist/generated/workorder-events.js

@@ -0,0 +1,10 @@
+// Code generated by cmd/internal/genwebtypes from sdk/workorder/schema/events/v1/; DO NOT EDIT.
+// Regenerate with `make web-types` (ADR-162 D4 item 1).
+/**
+ * Every type this module declares, mapped to the repository path of the schema
+ * it was generated from.
+ */
+export const WORK_ORDER_EVENT_SCHEMAS = {
+    WorkOrderEventKind: "sdk/workorder/schema/events/v1/event-kind.workorder.json",
+    WorkOrderEventPayload: "sdk/workorder/schema/events/v1/payload.workorder.json",
+};