@loopbacktools/protocol 0.0.0-stage → 0.4.1

package/dist/src/generated/document.gen.js

@@ -0,0 +1,25 @@
+// GENERATED by typespec-openapi-document from the TypeSpec service definition. DO NOT EDIT.
+// Recompile the spec that produced it; edits here are overwritten on the next run.
+/**
+ * The OpenAPI document `@typespec/openapi3` produced from this spec, as a value.
+ *
+ * Imported rather than read from disk, so it is part of your bundle: it cannot go stale relative to
+ * the build, and a missing document fails the build rather than a request.
+ */
+import document0 from "../../openapi/openapi.1.json" with { type: "json" };
+/** The document for the version this service currently serves. */
+export const openApiDocument = document0;
+/**
+ * Every version this service declares, keyed by version name.
+ *
+ * **`openApiDocument` is the LAST DECLARED version, not the last alphabetically.** A version name
+ * sorts however its author spelled it (`v1, v2preview, v2` sorts as `v1, v2, v2preview`) so only
+ * the declaration order says which one is current.
+ */
+export const openApiDocumentsByVersion = {
+    "1": document0,
+};
+/** The versions this service declares, oldest first. */
+export const OPENAPI_VERSIONS = ["1"];
+/** The path this document is conventionally served at. Yours to change; nothing here depends on it. */
+export const OPENAPI_DOCUMENT_PATH = "/openapi.json";

package/dist/src/generated/requests.gen.d.ts

@@ -0,0 +1,480 @@
+/**
+ * Flattens an intersection into a single object type.
+ *
+ * Without it, `Body & { id: string }` and the equivalent flat object are structurally the
+ * same but are NOT equal under the `Equals<>` conditional-type trick - so the assertions that pair
+ * this file with the emitted Zod would fail on correct code.
+ */
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * The same shape, tolerant of `readonly`.
+ *
+ * A producer's result is asserted assignable to its published shape, and a codebase commonly declares
+ * views with `readonly` properties and `readonly T[]` arrays - neither of which is assignable to a
+ * mutable one. Mutability is not a fact about a wire shape: it says nothing about what a caller
+ * receives. Making the TARGET readonly accepts both, which is the permissive direction; the reverse
+ * would reject every view a producer actually returns.
+ *
+ * No branch for functions, deliberately: the wire vocabulary is primitives, objects and arrays, so
+ * a call signature cannot appear here. Mapping one would yield `{}`, so the day something does
+ * carry a method - a narrowed multipart file part is the near miss - this needs one.
+ *
+ * **Exported, so a NAMED type can be written against it.** A codebase whose layers hand back
+ * `readonly T[]` needs the producer view of its own types, not only of `WireOutputs`, and
+ * declared locally it could not be named.
+ */
+export type Produced<T> = T extends readonly unknown[] ? {
+    readonly [K in keyof T]: Produced<T[K]>;
+} : T extends object ? {
+    readonly [K in keyof T]: Produced<T[K]>;
+} : T;
+/**
+ * A stream of bytes, as every platform's `ReadableStream<Uint8Array>` satisfies it - spelled
+ * structurally so this file needs no DOM or runtime library to name it.
+ */
+export interface ByteStream {
+    getReader(): {
+        read(): globalThis.Promise<{
+            readonly done: boolean;
+            readonly value?: Uint8Array | undefined;
+        }>;
+        releaseLock(): void;
+        cancel?(reason?: unknown): globalThis.Promise<void>;
+    };
+}
+export interface Answered {
+    outcome: "answered";
+    selected: string[];
+    text?: string;
+}
+export interface Approved {
+    outcome: "approved";
+    note?: string;
+}
+export interface ChangesRequested {
+    outcome: "changes_requested";
+    feedback: string;
+}
+export interface FollowUp {
+    outcome: "follow_up";
+    question: string;
+}
+export interface Dismissed {
+    outcome: "dismissed";
+}
+export interface PointReply {
+    point: string;
+    text?: string;
+    resolved?: boolean;
+}
+export interface Responded {
+    outcome: "responded";
+    points: PointReply[];
+}
+export type Reply = Answered | Approved | ChangesRequested | FollowUp | Dismissed | Responded;
+export interface Actor {
+    id: string;
+    name?: string;
+}
+export interface Whoami {
+    space: string;
+    actor: Actor;
+}
+export interface Problem {
+    code: string;
+    message: string;
+}
+export interface EventTicket {
+    ticket: string;
+    expiresAt: string;
+}
+export interface Choice {
+    label: string;
+    description?: string;
+}
+export interface QuestionPrompt {
+    question: string;
+    options: Choice[];
+    multiple: boolean;
+    context?: string;
+}
+export type AskStatus = "awaiting_human" | "awaiting_agent" | "closed";
+export interface HumanEntry {
+    author: "human";
+    reply: Reply;
+    by?: Actor;
+    at: string;
+}
+export interface MarkdownBlock {
+    type: "markdown";
+    text: string;
+}
+export interface CodeBlock {
+    type: "code";
+    code: string;
+    language?: string;
+    filename?: string;
+}
+export interface DiffBlock {
+    type: "diff";
+    diff: string;
+    filename?: string;
+}
+export interface ImageBlock {
+    type: "image";
+    uploadId: string;
+    caption?: string;
+}
+export type Block = MarkdownBlock | CodeBlock | DiffBlock | ImageBlock;
+export interface Point {
+    id: string;
+    title: string;
+    detail?: string;
+    content?: Block[];
+}
+export interface AgentEntry {
+    author: "agent";
+    answer: string;
+    content?: Block[];
+    point?: string;
+    points?: Point[];
+    at: string;
+}
+export type Entry = HumanEntry | AgentEntry;
+export interface QuestionAsk {
+    kind: "question";
+    prompt: QuestionPrompt;
+    id: string;
+    status: AskStatus;
+    waiting: boolean;
+    project?: string;
+    client?: string;
+    raisedBy?: Actor;
+    thread: Entry[];
+    createdAt: string;
+    updatedAt: string;
+    closedAt?: string;
+}
+export interface ReviewPrompt {
+    title: string;
+    content: Block[];
+    summary?: string;
+}
+export interface ReviewAsk {
+    kind: "review";
+    prompt: ReviewPrompt;
+    revises?: string;
+    id: string;
+    status: AskStatus;
+    waiting: boolean;
+    project?: string;
+    client?: string;
+    raisedBy?: Actor;
+    thread: Entry[];
+    createdAt: string;
+    updatedAt: string;
+    closedAt?: string;
+}
+export interface BriefingPromptSection {
+    title?: string;
+    points: Point[];
+}
+export interface BriefingPrompt {
+    title: string;
+    summary?: string;
+    sections: BriefingPromptSection[];
+}
+export interface BriefingAsk {
+    kind: "briefing";
+    prompt: BriefingPrompt;
+    id: string;
+    status: AskStatus;
+    waiting: boolean;
+    project?: string;
+    client?: string;
+    raisedBy?: Actor;
+    thread: Entry[];
+    createdAt: string;
+    updatedAt: string;
+    closedAt?: string;
+}
+export type Ask = QuestionAsk | ReviewAsk | BriefingAsk;
+export interface Snapshot {
+    open: Ask[];
+    recent: Ask[];
+}
+export interface AskPage {
+    items: Ask[];
+    nextBefore?: string;
+}
+export type ImageType = "image/png" | "image/jpeg" | "image/webp" | "image/gif";
+export interface UploadReceipt {
+    uploadId: string;
+    contentType: ImageType;
+    size: number;
+}
+export type Revisions = "1";
+export type AskKind = "question" | "review" | "briefing";
+export interface BriefingPoint {
+    title: string;
+    detail?: string;
+    content?: Block[];
+}
+export interface BriefingSection {
+    title?: string;
+    points: BriefingPoint[];
+}
+export interface QuestionInput {
+    question: string;
+    options?: Choice[];
+    multiple?: boolean;
+    context?: string;
+    project: string;
+}
+export interface ReviewInput {
+    title: string;
+    content: Block[];
+    summary?: string;
+    revises?: string;
+    project: string;
+}
+export interface BriefingInput {
+    title: string;
+    summary?: string;
+    sections: BriefingSection[];
+    project: string;
+}
+export interface PointAnswer {
+    point: string;
+    answer: string;
+    content?: Block[];
+    points?: BriefingPoint[];
+}
+export interface BriefingAnswerInput {
+    askId: string;
+    answers: PointAnswer[];
+}
+export interface FollowUpInput {
+    askId: string;
+    answer: string;
+    content?: Block[];
+}
+export interface UploadRequest {
+    contentType: ImageType;
+}
+export interface UploadTicket {
+    uploadId: string;
+    uploadUrl: string;
+    expiresAt: string;
+    maxBytes: number;
+    command: string;
+}
+export interface InboxRequest {
+    askId?: string;
+}
+export interface InboxLink {
+    url: string;
+}
+export interface AskCommon {
+    id: string;
+    status: AskStatus;
+    waiting: boolean;
+    project?: string;
+    client?: string;
+    raisedBy?: Actor;
+    thread: Entry[];
+    createdAt: string;
+    updatedAt: string;
+    closedAt?: string;
+}
+export interface ToolReply {
+    askId: string;
+    reply: Reply;
+}
+export interface SnapshotEvent {
+    type: "snapshot";
+    snapshot: Snapshot;
+}
+export interface AskEvent {
+    type: "ask.opened" | "ask.updated";
+    ask: Ask;
+}
+export type ServerEvent = SnapshotEvent | AskEvent;
+/**
+ * Every operation's input, keyed by operation id: what its handler receives, and what a caller of a
+ * backend typed by it hands over. An operation that takes nothing is `Record<string, never>`.
+ */
+export interface WireInputs {
+    /** The input for `Session_whoami`, as its handler receives it. */
+    Session_whoami: globalThis.Record<string, never>;
+    /** The input for `EventTickets_issue`, as its handler receives it. */
+    EventTickets_issue: globalThis.Record<string, never>;
+    /** The input for `Snapshots_read`, as its handler receives it. */
+    Snapshots_read: globalThis.Record<string, never>;
+    /** The input for `Asks_list`, as its handler receives it. */
+    Asks_list: Simplify<{
+        before?: string;
+        limit?: number;
+    }>;
+    /** The input for `Asks_read`, as its handler receives it. */
+    Asks_read: Simplify<{
+        id: string;
+    }>;
+    /** The input for `Asks_reply`, as its handler receives it. */
+    Asks_reply: Simplify<{
+        reply: Reply;
+    } & {
+        id: string;
+    }>;
+    /** The input for `Files_read`, as its handler receives it. */
+    Files_read: Simplify<{
+        uploadId: string;
+    }>;
+    /** The input for `Uploads_store`, as its handler receives it. */
+    Uploads_store: Simplify<{
+        body: ByteStream | null;
+    } & {
+        spaceId: string;
+        token: string;
+        "Content-Type": string;
+    }>;
+}
+/**
+ * Every operation's success bodies, keyed by operation id: the body of each `2xx` and `3xx` response it
+ * declares, `undefined` for one with no body, and `never` where it declares no success at all. Which
+ * status goes with which body is `WireResults`.
+ *
+ * **A floor, not an equality.** These shapes are permissive: a caller pins the fields it depends
+ * on and lets a richer view through, so a producer's result must CONTAIN what the document promises
+ * and may contain more. This is what makes a published response checkable at all: without it, a
+ * route can advertise a field it never returns and nothing anywhere can see it.
+ */
+export interface WireOutputs {
+    /** Every success body `Session_whoami` declares. */
+    Session_whoami: Produced<Whoami>;
+    /** Every success body `EventTickets_issue` declares. */
+    EventTickets_issue: Produced<EventTicket>;
+    /** Every success body `Snapshots_read` declares. */
+    Snapshots_read: Produced<Snapshot>;
+    /** Every success body `Asks_list` declares. */
+    Asks_list: Produced<AskPage>;
+    /** Every success body `Asks_read` declares. */
+    Asks_read: Produced<Ask>;
+    /** Every success body `Asks_reply` declares. */
+    Asks_reply: Produced<Ask>;
+    /** Every success body `Files_read` declares. */
+    Files_read: ByteStream | Uint8Array<ArrayBuffer> | ArrayBuffer;
+    /** Every success body `Uploads_store` declares. */
+    Uploads_store: Produced<UploadReceipt>;
+}
+/**
+ * Every operation's result, keyed by operation id: one member per response it declares, each pairing
+ * a status with that status's body and headers. A status no response declares does not compile, and
+ * a `4XX` or `default` response is the codes it stands for, written out.
+ */
+export interface WireResults {
+    /** Every response `Session_whoami` declares. */
+    Session_whoami: {
+        readonly status: 200;
+        readonly body: Produced<Whoami>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `EventTickets_issue` declares. */
+    EventTickets_issue: {
+        readonly status: 201;
+        readonly body: Produced<EventTicket>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Snapshots_read` declares. */
+    Snapshots_read: {
+        readonly status: 200;
+        readonly body: Produced<Snapshot>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Asks_list` declares. */
+    Asks_list: {
+        readonly status: 200;
+        readonly body: Produced<AskPage>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Asks_read` declares. */
+    Asks_read: {
+        readonly status: 200;
+        readonly body: Produced<Ask>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 404;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Asks_reply` declares. */
+    Asks_reply: {
+        readonly status: 200;
+        readonly body: Produced<Ask>;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 404;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 409;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 422;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Files_read` declares. */
+    Files_read: {
+        readonly status: 200;
+        readonly contentType: "image/png";
+        readonly body: ByteStream | Uint8Array<ArrayBuffer> | ArrayBuffer;
+    } | {
+        readonly status: 200;
+        readonly contentType: "image/jpeg";
+        readonly body: ByteStream | Uint8Array<ArrayBuffer> | ArrayBuffer;
+    } | {
+        readonly status: 200;
+        readonly contentType: "image/webp";
+        readonly body: ByteStream | Uint8Array<ArrayBuffer> | ArrayBuffer;
+    } | {
+        readonly status: 200;
+        readonly contentType: "image/gif";
+        readonly body: ByteStream | Uint8Array<ArrayBuffer> | ArrayBuffer;
+    } | {
+        readonly status: 401;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 404;
+        readonly body: Produced<Problem>;
+    };
+    /** Every response `Uploads_store` declares. */
+    Uploads_store: {
+        readonly status: 201;
+        readonly body: Produced<UploadReceipt>;
+    } | {
+        readonly status: 404;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 410;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 413;
+        readonly body: Produced<Problem>;
+    } | {
+        readonly status: 422;
+        readonly body: Produced<Problem>;
+    };
+}
+export {};

package/dist/src/generated/requests.gen.js

@@ -0,0 +1 @@
+export {};

package/dist/src/generated/schemas.gen.d.ts

@@ -0,0 +1,5 @@
+/** The contract's latest revision: the one this release writes. */
+export declare const REVISION = 1;
+/** Every revision of the contract, oldest first. */
+export declare const REVISIONS: readonly [1];
+export * from "./schemas.r1.gen.ts";

package/dist/src/generated/schemas.gen.js

@@ -0,0 +1,6 @@
+// GENERATED by scripts/schemas.ts. DO NOT EDIT. Regenerate with: pnpm generate
+/** The contract's latest revision: the one this release writes. */
+export const REVISION = 1;
+/** Every revision of the contract, oldest first. */
+export const REVISIONS = [1];
+export * from "./schemas.r1.gen.js";