@cadenya/widgets 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,461 @@
+/**
+ * Approve tool call request. Responds to a toolApprovalRequested event.
+ */
+export interface ApproveToolCallRequest {
+    /**
+     * Conversation ID.
+     */
+    id?: string;
+    /**
+     * The tool call awaiting a decision, from the toolApprovalRequested event.
+     */
+    toolCallId?: string;
+}
+/**
+ * Continue conversation request.
+ */
+export interface ContinueConversationRequest {
+    /**
+     * Conversation ID.
+     */
+    id?: string;
+    /**
+     * The visitor's next message.
+     */
+    message: string;
+}
+/**
+ * Create conversation request. The session, tenant, subject, secrets, labels,
+ *  and pinned parameters all come from the presenting token's session — the
+ *  browser asserts nothing.
+ */
+export interface CreateConversationRequest {
+    /**
+     * The visitor's opening message.
+     */
+    message: string;
+}
+/**
+ * Deny tool call request. Responds to a toolApprovalRequested event.
+ */
+export interface DenyToolCallRequest {
+    /**
+     * Conversation ID.
+     */
+    id?: string;
+    /**
+     * The tool call awaiting a decision, from the toolApprovalRequested event.
+     */
+    toolCallId?: string;
+}
+/**
+ * Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
+ */
+export interface GoogleProtobufAny {
+    /**
+     * The type of the serialized message.
+     */
+    '@type'?: string;
+}
+/**
+ * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
+ */
+export type GoogleProtobufValue = unknown;
+/**
+ * List conversation events response. Ordered oldest first.
+ */
+export interface ListConversationEventsResponse {
+    items?: Array<WidgetEvent>;
+    pagination?: Page;
+}
+/**
+ * List conversations response. Ordered by last activity, newest first.
+ */
+export interface ListConversationsResponse {
+    items?: Array<WidgetConversation>;
+    pagination?: Page;
+}
+/**
+ * Page carries pagination data for list responses. A deliberate local
+ *  duplicate of the api module's Page — this package imports nothing from
+ *  cadenya.api.v1 (see the workspace README).
+ */
+export interface Page {
+    /**
+     * Cursor for the next page. Empty when there are no further results.
+     */
+    nextCursor?: string;
+    /**
+     * Total number of items matching the request.
+     */
+    total?: number;
+}
+/**
+ * Set tool call content request. Lets the embedding page supply the result
+ *  of a bare tool call (one whose tool set has no execution adapter) — the
+ *  widget-session flavor of the reverse-harness pattern, where client-side
+ *  logic executes the tool and reports the result back. The result then
+ *  reaches the conversation as a toolResult event.
+ */
+export interface SetToolCallContentRequest {
+    /**
+     * Conversation ID.
+     */
+    id?: string;
+    /**
+     * The bare tool call to supply content for.
+     */
+    toolCallId?: string;
+    /**
+     * The tool call's result content.
+     */
+    content: string;
+}
+/**
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+ */
+export interface Status {
+    /**
+     * The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+     */
+    code?: number;
+    /**
+     * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
+     */
+    message?: string;
+    /**
+     * A list of messages that carry the error details.  There is a common set of message types for APIs to use.
+     */
+    details?: Array<GoogleProtobufAny>;
+}
+/**
+ * Submit conversation feedback request — the visitor's rating of a
+ *  conversation, mirroring internal objective feedback in slimmed form. Flows
+ *  into the same feedback machinery that scores agent variations.
+ */
+export interface SubmitConversationFeedbackRequest {
+    /**
+     * Conversation ID.
+     */
+    id?: string;
+    /**
+     * A score between -1.0 and 1.0. -1.0 is the worst, 0.0 neutral, 1.0 the
+     *  best — a thumbs-down/up UI maps to -1.0/1.0.
+     */
+    score: number;
+    /**
+     * Optional comment explaining the feedback.
+     */
+    comment?: string;
+}
+/**
+ * WidgetAssistantMessageEvent is a message from the agent. Content may
+ *  arrive incrementally: later events for the same turn replace earlier
+ *  partial content.
+ */
+export interface WidgetAssistantMessageEvent {
+    content: string;
+}
+/**
+ * WidgetCancelledEvent: the conversation was cancelled. Terminal.
+ */
+export interface WidgetCancelledEvent {
+}
+/**
+ * WidgetConfig is the widget's presentation configuration, served to the
+ *  browser before any session exists. Contains nothing sensitive: the widget
+ *  is identified by the hostname, and the edge has already enforced the
+ *  origin allowlist by the time this is served.
+ */
+export interface WidgetConfig {
+    /**
+     * Display name shown in the widget header.
+     */
+    displayName: string;
+}
+export type WidgetConversationState = 'STATE_UNSPECIFIED' | 'STATE_RESPONDING' | 'STATE_OPEN' | 'STATE_CLOSED';
+/**
+ * WidgetConversation is one conversation between the session's visitor and
+ *  the widget's agent. Conversations are scoped by the presenting token to the
+ *  VISITOR: a session with a subject sees that subject's conversations on this
+ *  widget; a session without one sees only the conversations it created
+ *  itself. A conversation id from outside that scope is indistinguishable from
+ *  one that does not exist. Tenant is a management-side grouping only — it is
+ *  never a read scope on this surface.
+ */
+export interface WidgetConversation {
+    id: string;
+    state: WidgetConversationState;
+    /**
+     * Server-derived display title (e.g. from the opening message).
+     */
+    title?: string;
+    createdAt: string;
+    /**
+     * When the conversation last saw a message or event.
+     */
+    lastActiveAt?: string;
+}
+/**
+ * WidgetErrorEvent reports a visitor-safe conversation error. The message is
+ *  sanitized; internal error detail never reaches the widget.
+ */
+export interface WidgetErrorEvent {
+    message: string;
+}
+/**
+ * WidgetEvent is the visitor-facing event vocabulary. It MIRRORS the internal
+ *  conversation event variants — same granularity, same discriminator names —
+ *  with slimmed messages holding exactly what a widget UI needs. Internal
+ *  events map to these through an explicit, exhaustive server-side projection;
+ *  internal-only types (context compaction, memory reads, sub-agent
+ *  bookkeeping) have no widget variant and are dropped. Nothing here carries
+ *  tool configuration, tool arguments, server identities, operator details,
+ *  or internal error strings.
+ */
+export type WidgetEvent = WidgetEvent_UserMessage | WidgetEvent_AssistantMessage | WidgetEvent_ToolApprovalRequested | WidgetEvent_ToolApproved | WidgetEvent_ToolDenied | WidgetEvent_ToolCalled | WidgetEvent_ToolResult | WidgetEvent_ToolError | WidgetEvent_Error | WidgetEvent_Cancelled | WidgetEvent_TimedOut;
+/**
+ * WidgetTimedOutEvent: the conversation timed out after inactivity. Terminal.
+ *  (There is no finalized variant: agents with structured output — the only
+ *  path to finalization — cannot be bound to widgets.)
+ */
+export interface WidgetTimedOutEvent {
+}
+/**
+ * WidgetToolApprovalRequestedEvent asks the visitor to approve or deny a
+ *  tool call before it runs. The tool reference lets the embedding UI render
+ *  a custom approval experience per tool; the visitor responds via the
+ *  approve/deny endpoints.
+ */
+export interface WidgetToolApprovalRequestedEvent {
+    /**
+     * The tool call awaiting a decision; pass it to the approve/deny endpoint.
+     */
+    toolCallId: string;
+    tool: WidgetToolReference;
+}
+/**
+ * WidgetToolApprovedEvent records that the pending tool call was approved.
+ */
+export interface WidgetToolApprovedEvent {
+    toolCallId: string;
+}
+/**
+ * WidgetToolCalledEvent reports that the agent invoked a tool. Arguments are
+ *  never included.
+ */
+export interface WidgetToolCalledEvent {
+    toolCallId: string;
+    tool: WidgetToolReference;
+}
+/**
+ * WidgetToolDeniedEvent records that the pending tool call was denied.
+ */
+export interface WidgetToolDeniedEvent {
+    toolCallId: string;
+}
+/**
+ * WidgetToolErrorEvent reports that a tool call failed. Internal error
+ *  detail never reaches the widget.
+ */
+export interface WidgetToolErrorEvent {
+    toolCallId: string;
+    tool: WidgetToolReference;
+}
+/**
+ * WidgetToolReference identifies the tool involved in a tool event — enough
+ *  for the embedding UI to label the activity and to register custom
+ *  renderers keyed by the tool's id or the customer's own external id.
+ *  Deliberately omitted: tool configuration, adapter details, and any server
+ *  identity.
+ */
+export interface WidgetToolReference {
+    /**
+     * Cadenya's canonical tool id.
+     */
+    id: string;
+    /**
+     * The tool's external id in the customer's namespace, when set.
+     */
+    externalId?: string;
+    /**
+     * The tool's name as the workspace configured it (e.g. "FetchOrderDetails").
+     */
+    name: string;
+}
+/**
+ * WidgetToolResultEvent reports that a tool call finished. Result content is
+ *  omitted by default and included only for tools the workspace has opted in
+ *  to sharing content with widget sessions.
+ */
+export interface WidgetToolResultEvent {
+    toolCallId: string;
+    tool: WidgetToolReference;
+    /**
+     * The tool's result, present only for tools opted in to sharing content
+     *  with widget sessions (a per-tool setting; default off). Arbitrary JSON
+     *  the embedding UI may render — chart data, cards, structured results.
+     */
+    content?: GoogleProtobufValue;
+}
+/**
+ * WidgetUserMessageEvent is a message from the visitor.
+ */
+export interface WidgetUserMessageEvent {
+    content: string;
+}
+export interface WidgetEvent_UserMessage {
+    type: 'userMessage';
+    userMessage: WidgetUserMessageEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_AssistantMessage {
+    type: 'assistantMessage';
+    assistantMessage: WidgetAssistantMessageEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolApprovalRequested {
+    type: 'toolApprovalRequested';
+    toolApprovalRequested: WidgetToolApprovalRequestedEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolApproved {
+    type: 'toolApproved';
+    toolApproved: WidgetToolApprovedEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolDenied {
+    type: 'toolDenied';
+    toolDenied: WidgetToolDeniedEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolCalled {
+    type: 'toolCalled';
+    toolCalled: WidgetToolCalledEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolResult {
+    type: 'toolResult';
+    toolResult: WidgetToolResultEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_ToolError {
+    type: 'toolError';
+    toolError: WidgetToolErrorEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_Error {
+    type: 'error';
+    error: WidgetErrorEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_Cancelled {
+    type: 'cancelled';
+    cancelled: WidgetCancelledEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+export interface WidgetEvent_TimedOut {
+    type: 'timedOut';
+    timedOut: WidgetTimedOutEvent;
+    /**
+     * Unique event id (ULID). Doubles as the SSE `id:` — replay it as
+     *  `Last-Event-ID` on reconnect to resume without duplication.
+     */
+    id: string;
+    /**
+     * The conversation this event belongs to.
+     */
+    conversationId: string;
+    createdAt: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3B,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAClC,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;CACpC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,YAAY,GAAG,cAAc,CAAC;AAE/G;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,uBAAuB,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,WAAW,GACnB,uBAAuB,GACvB,4BAA4B,GAC5B,iCAAiC,GACjC,wBAAwB,GACxB,sBAAsB,GACtB,sBAAsB,GACtB,sBAAsB,GACtB,qBAAqB,GACrB,iBAAiB,GACjB,qBAAqB,GACrB,oBAAoB,CAAC;AAEzB;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,mBAAmB,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,sBAAsB,CAAC;IACpC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,kBAAkB,CAAC;IACzB,gBAAgB,EAAE,2BAA2B,CAAC;IAC9C;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,uBAAuB,CAAC;IAC9B,qBAAqB,EAAE,gCAAgC,CAAC;IACxD;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,cAAc,CAAC;IACrB,YAAY,EAAE,uBAAuB,CAAC;IACtC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,qBAAqB,CAAC;IAClC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,qBAAqB,CAAC;IAClC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,qBAAqB,CAAC;IAClC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,oBAAoB,CAAC;IAChC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,gBAAgB,CAAC;IACxB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,oBAAoB,CAAC;IAChC;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,mBAAmB,CAAC;IAC9B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/types.js

@@ -0,0 +1,3 @@
+// Generated by redwood. Do not edit by hand.
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,6CAA6C","sourcesContent":["// Generated by redwood. Do not edit by hand.\n\n/**\n * Approve tool call request. Responds to a toolApprovalRequested event.\n */\nexport interface ApproveToolCallRequest {\n  /**\n   * Conversation ID.\n   */\n  id?: string;\n  /**\n   * The tool call awaiting a decision, from the toolApprovalRequested event.\n   */\n  toolCallId?: string;\n}\n\n/**\n * Continue conversation request.\n */\nexport interface ContinueConversationRequest {\n  /**\n   * Conversation ID.\n   */\n  id?: string;\n  /**\n   * The visitor's next message.\n   */\n  message: string;\n}\n\n/**\n * Create conversation request. The session, tenant, subject, secrets, labels,\n *  and pinned parameters all come from the presenting token's session — the\n *  browser asserts nothing.\n */\nexport interface CreateConversationRequest {\n  /**\n   * The visitor's opening message.\n   */\n  message: string;\n}\n\n/**\n * Deny tool call request. Responds to a toolApprovalRequested event.\n */\nexport interface DenyToolCallRequest {\n  /**\n   * Conversation ID.\n   */\n  id?: string;\n  /**\n   * The tool call awaiting a decision, from the toolApprovalRequested event.\n   */\n  toolCallId?: string;\n}\n\n/**\n * Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.\n */\nexport interface GoogleProtobufAny {\n  /**\n   * The type of the serialized message.\n   */\n  '@type'?: string;\n}\n\n/**\n * Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.\n */\nexport type GoogleProtobufValue = unknown;\n\n/**\n * List conversation events response. Ordered oldest first.\n */\nexport interface ListConversationEventsResponse {\n  items?: Array<WidgetEvent>;\n  pagination?: Page;\n}\n\n/**\n * List conversations response. Ordered by last activity, newest first.\n */\nexport interface ListConversationsResponse {\n  items?: Array<WidgetConversation>;\n  pagination?: Page;\n}\n\n/**\n * Page carries pagination data for list responses. A deliberate local\n *  duplicate of the api module's Page — this package imports nothing from\n *  cadenya.api.v1 (see the workspace README).\n */\nexport interface Page {\n  /**\n   * Cursor for the next page. Empty when there are no further results.\n   */\n  nextCursor?: string;\n  /**\n   * Total number of items matching the request.\n   */\n  total?: number;\n}\n\n/**\n * Set tool call content request. Lets the embedding page supply the result\n *  of a bare tool call (one whose tool set has no execution adapter) — the\n *  widget-session flavor of the reverse-harness pattern, where client-side\n *  logic executes the tool and reports the result back. The result then\n *  reaches the conversation as a toolResult event.\n */\nexport interface SetToolCallContentRequest {\n  /**\n   * Conversation ID.\n   */\n  id?: string;\n  /**\n   * The bare tool call to supply content for.\n   */\n  toolCallId?: string;\n  /**\n   * The tool call's result content.\n   */\n  content: string;\n}\n\n/**\n * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).\n */\nexport interface Status {\n  /**\n   * The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].\n   */\n  code?: number;\n  /**\n   * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.\n   */\n  message?: string;\n  /**\n   * A list of messages that carry the error details.  There is a common set of message types for APIs to use.\n   */\n  details?: Array<GoogleProtobufAny>;\n}\n\n/**\n * Submit conversation feedback request — the visitor's rating of a\n *  conversation, mirroring internal objective feedback in slimmed form. Flows\n *  into the same feedback machinery that scores agent variations.\n */\nexport interface SubmitConversationFeedbackRequest {\n  /**\n   * Conversation ID.\n   */\n  id?: string;\n  /**\n   * A score between -1.0 and 1.0. -1.0 is the worst, 0.0 neutral, 1.0 the\n   *  best — a thumbs-down/up UI maps to -1.0/1.0.\n   */\n  score: number;\n  /**\n   * Optional comment explaining the feedback.\n   */\n  comment?: string;\n}\n\n/**\n * WidgetAssistantMessageEvent is a message from the agent. Content may\n *  arrive incrementally: later events for the same turn replace earlier\n *  partial content.\n */\nexport interface WidgetAssistantMessageEvent {\n  content: string;\n}\n\n/**\n * WidgetCancelledEvent: the conversation was cancelled. Terminal.\n */\nexport interface WidgetCancelledEvent {\n}\n\n/**\n * WidgetConfig is the widget's presentation configuration, served to the\n *  browser before any session exists. Contains nothing sensitive: the widget\n *  is identified by the hostname, and the edge has already enforced the\n *  origin allowlist by the time this is served.\n */\nexport interface WidgetConfig {\n  /**\n   * Display name shown in the widget header.\n   */\n  displayName: string;\n}\n\nexport type WidgetConversationState = 'STATE_UNSPECIFIED' | 'STATE_RESPONDING' | 'STATE_OPEN' | 'STATE_CLOSED';\n\n/**\n * WidgetConversation is one conversation between the session's visitor and\n *  the widget's agent. Conversations are scoped by the presenting token to the\n *  VISITOR: a session with a subject sees that subject's conversations on this\n *  widget; a session without one sees only the conversations it created\n *  itself. A conversation id from outside that scope is indistinguishable from\n *  one that does not exist. Tenant is a management-side grouping only — it is\n *  never a read scope on this surface.\n */\nexport interface WidgetConversation {\n  id: string;\n  state: WidgetConversationState;\n  /**\n   * Server-derived display title (e.g. from the opening message).\n   */\n  title?: string;\n  createdAt: string;\n  /**\n   * When the conversation last saw a message or event.\n   */\n  lastActiveAt?: string;\n}\n\n/**\n * WidgetErrorEvent reports a visitor-safe conversation error. The message is\n *  sanitized; internal error detail never reaches the widget.\n */\nexport interface WidgetErrorEvent {\n  message: string;\n}\n\n/**\n * WidgetEvent is the visitor-facing event vocabulary. It MIRRORS the internal\n *  conversation event variants — same granularity, same discriminator names —\n *  with slimmed messages holding exactly what a widget UI needs. Internal\n *  events map to these through an explicit, exhaustive server-side projection;\n *  internal-only types (context compaction, memory reads, sub-agent\n *  bookkeeping) have no widget variant and are dropped. Nothing here carries\n *  tool configuration, tool arguments, server identities, operator details,\n *  or internal error strings.\n */\nexport type WidgetEvent =\n  | WidgetEvent_UserMessage\n  | WidgetEvent_AssistantMessage\n  | WidgetEvent_ToolApprovalRequested\n  | WidgetEvent_ToolApproved\n  | WidgetEvent_ToolDenied\n  | WidgetEvent_ToolCalled\n  | WidgetEvent_ToolResult\n  | WidgetEvent_ToolError\n  | WidgetEvent_Error\n  | WidgetEvent_Cancelled\n  | WidgetEvent_TimedOut;\n\n/**\n * WidgetTimedOutEvent: the conversation timed out after inactivity. Terminal.\n *  (There is no finalized variant: agents with structured output — the only\n *  path to finalization — cannot be bound to widgets.)\n */\nexport interface WidgetTimedOutEvent {\n}\n\n/**\n * WidgetToolApprovalRequestedEvent asks the visitor to approve or deny a\n *  tool call before it runs. The tool reference lets the embedding UI render\n *  a custom approval experience per tool; the visitor responds via the\n *  approve/deny endpoints.\n */\nexport interface WidgetToolApprovalRequestedEvent {\n  /**\n   * The tool call awaiting a decision; pass it to the approve/deny endpoint.\n   */\n  toolCallId: string;\n  tool: WidgetToolReference;\n}\n\n/**\n * WidgetToolApprovedEvent records that the pending tool call was approved.\n */\nexport interface WidgetToolApprovedEvent {\n  toolCallId: string;\n}\n\n/**\n * WidgetToolCalledEvent reports that the agent invoked a tool. Arguments are\n *  never included.\n */\nexport interface WidgetToolCalledEvent {\n  toolCallId: string;\n  tool: WidgetToolReference;\n}\n\n/**\n * WidgetToolDeniedEvent records that the pending tool call was denied.\n */\nexport interface WidgetToolDeniedEvent {\n  toolCallId: string;\n}\n\n/**\n * WidgetToolErrorEvent reports that a tool call failed. Internal error\n *  detail never reaches the widget.\n */\nexport interface WidgetToolErrorEvent {\n  toolCallId: string;\n  tool: WidgetToolReference;\n}\n\n/**\n * WidgetToolReference identifies the tool involved in a tool event — enough\n *  for the embedding UI to label the activity and to register custom\n *  renderers keyed by the tool's id or the customer's own external id.\n *  Deliberately omitted: tool configuration, adapter details, and any server\n *  identity.\n */\nexport interface WidgetToolReference {\n  /**\n   * Cadenya's canonical tool id.\n   */\n  id: string;\n  /**\n   * The tool's external id in the customer's namespace, when set.\n   */\n  externalId?: string;\n  /**\n   * The tool's name as the workspace configured it (e.g. \"FetchOrderDetails\").\n   */\n  name: string;\n}\n\n/**\n * WidgetToolResultEvent reports that a tool call finished. Result content is\n *  omitted by default and included only for tools the workspace has opted in\n *  to sharing content with widget sessions.\n */\nexport interface WidgetToolResultEvent {\n  toolCallId: string;\n  tool: WidgetToolReference;\n  /**\n   * The tool's result, present only for tools opted in to sharing content\n   *  with widget sessions (a per-tool setting; default off). Arbitrary JSON\n   *  the embedding UI may render — chart data, cards, structured results.\n   */\n  content?: GoogleProtobufValue;\n}\n\n/**\n * WidgetUserMessageEvent is a message from the visitor.\n */\nexport interface WidgetUserMessageEvent {\n  content: string;\n}\n\nexport interface WidgetEvent_UserMessage {\n  type: 'userMessage';\n  userMessage: WidgetUserMessageEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_AssistantMessage {\n  type: 'assistantMessage';\n  assistantMessage: WidgetAssistantMessageEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolApprovalRequested {\n  type: 'toolApprovalRequested';\n  toolApprovalRequested: WidgetToolApprovalRequestedEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolApproved {\n  type: 'toolApproved';\n  toolApproved: WidgetToolApprovedEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolDenied {\n  type: 'toolDenied';\n  toolDenied: WidgetToolDeniedEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolCalled {\n  type: 'toolCalled';\n  toolCalled: WidgetToolCalledEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolResult {\n  type: 'toolResult';\n  toolResult: WidgetToolResultEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_ToolError {\n  type: 'toolError';\n  toolError: WidgetToolErrorEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_Error {\n  type: 'error';\n  error: WidgetErrorEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_Cancelled {\n  type: 'cancelled';\n  cancelled: WidgetCancelledEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\nexport interface WidgetEvent_TimedOut {\n  type: 'timedOut';\n  timedOut: WidgetTimedOutEvent;\n  /**\n   * Unique event id (ULID). Doubles as the SSE `id:` — replay it as\n   *  `Last-Event-ID` on reconnect to resume without duplication.\n   */\n  id: string;\n  /**\n   * The conversation this event belongs to.\n   */\n  conversationId: string;\n  createdAt: string;\n}\n\n"]}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@cadenya/widgets",
+  "version": "1.0.0",
+  "description": "The official TypeScript SDK for the CadenyaWidgets API",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "publishConfig": { "access": "public" },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": ["dist", "src", "api.md"],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.5.0"
+  }
+}

package/src/client.ts

@@ -0,0 +1,87 @@
+// Generated by redwood. Do not edit by hand.
+
+import { HttpClient } from './core/http.js';
+import type { Logger, LogLevel } from './core/http.js';
+import { Config } from './resources/config.js';
+import { Conversations } from './resources/conversations.js';
+
+export interface ClientOptions {
+  /** API key. Defaults to the CADENYAWIDGETS_API_KEY environment variable. */
+  apiKey?: string;
+  /** Override the API base URL. Defaults to . */
+  baseURL?: string;
+  /** Max automatic retries for retryable failures. Defaults to 0. */
+  maxRetries?: number;
+  /**
+   * Deadline for ordinary (non-streaming) requests in milliseconds; override
+   * per request with `options.timeout`. Streams bound only response-header
+   * acquisition — body lifetime stays under the caller's AbortSignal.
+   * Defaults to 60000; a non-finite or <= 0 value disables the deadline.
+   */
+  timeout?: number;
+  /** Headers sent with every request. */
+  defaultHeaders?: Record<string, string>;
+  /** Custom fetch implementation. */
+  fetch?: typeof fetch;
+  /** Destination for SDK logs. Defaults to `console`. */
+  logger?: Logger;
+  /** 'debug' | 'warn' (default) | 'off'. Never logs headers or bodies. */
+  logLevel?: LogLevel;
+}
+
+export class CadenyaWidgets {
+  readonly config: Config;
+  readonly conversations: Conversations;
+
+  private readonly _client: HttpClient;
+
+  constructor(options: ClientOptions = {}) {
+    // Presence is not validity: empty strings from options or environment
+    // are configuration mistakes, not credentials.
+    const apiKey = resolveOption('apiKey', options.apiKey, readEnv('CADENYAWIDGETS_API_KEY'));
+    if (!apiKey) {
+      throw new Error(
+        "Missing API key. Pass it with `new CadenyaWidgets({ apiKey })` or set the CADENYAWIDGETS_API_KEY environment variable.",
+      );
+    }
+    this._client = new HttpClient({
+      baseURL: resolveOption('baseURL', options.baseURL, readEnv('CADENYAWIDGETS_BASE_URL')) ?? '',
+      authHeader: () => ({ Authorization: `Bearer ${apiKey}` }),
+      maxRetries: options.maxRetries ?? 0,
+      timeout: options.timeout,
+      defaultHeaders: { 'User-Agent': 'cadenyawidgets-typescript/1.0.0 (api 1.0)', ...options.defaultHeaders },
+      fetch: options.fetch,
+      logger: options.logger,
+      logLevel: options.logLevel,
+      defaults: {  },
+    });
+    this.config = new Config(this._client);
+    this.conversations = new Conversations(this._client);
+  }
+}
+
+function readEnv(name: string): string | undefined {
+  const env = (globalThis as { process?: { env?: Record<string, string | undefined> } })
+    .process?.env;
+  return env?.[name];
+}
+
+// Presence is not validity: an explicitly provided option must be usable —
+// a blank value is a configuration mistake and never silently falls back to
+// the environment or a default. Only an OMITTED option reads the env.
+function resolveOption(
+  label: string,
+  explicit: string | undefined,
+  env: string | undefined,
+): string | undefined {
+  if (explicit !== undefined) {
+    const value = explicit.trim();
+    if (!value) {
+      throw new Error(
+        `${label} must not be blank when provided explicitly; omit it to use the environment instead.`,
+      );
+    }
+    return value;
+  }
+  return env?.trim() || undefined;
+}