@lessly/sdk-app 49.1.0 → 50.0.0

package/dist/index.d.cts

@@ -1,6 +1,85 @@
-import { L as LesslyStreamOpener, b as LesslyAppOptions, W as WsBinding, a as LesslyStream } from './types-gTIUAUsP.cjs';
-export { B as Binding, c as BindingsMap, H as HttpMethod, P as ParamIn, d as ParamSpec, S as StreamCloseInfo, e as StreamData, f as WebSocketCtor, g as WebSocketLike, h as WsBindingsMap } from './types-gTIUAUsP.cjs';
-import { G as GeneratedClient } from './client.gen-C39RGAWI.cjs';
+import { G as GeneratedClient } from './client.gen-Dw0AIIZi.cjs';
+
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type ParamIn = 'path' | 'query' | 'body';
+interface ParamSpec {
+    name: string;
+    in: ParamIn;
+}
+interface Binding {
+    method: HttpMethod;
+    path: string;
+    readOnly: boolean;
+    params?: ParamSpec[];
+}
+/**
+ * The streaming counterpart of `Binding`: the upgrade route of a ws-bound tool. No method (an
+ * upgrade is always a GET) and no `readOnly` (a socket is neither a read nor a write — the tool's
+ * own description defines its framing).
+ */
+interface WsBinding {
+    path: string;
+    params?: ParamSpec[];
+}
+type ActionBindings = Record<string, Binding>;
+type ResourceBindings = Record<string, ActionBindings>;
+type BindingsMap = Record<string, ResourceBindings>;
+type WsActionBindings = Record<string, WsBinding>;
+type WsResourceBindings = Record<string, WsActionBindings>;
+type WsBindingsMap = Record<string, WsResourceBindings>;
+/** Close information, as delivered to every `onClose` subscriber. */
+interface StreamCloseInfo {
+    code: number;
+    reason: string;
+    wasClean: boolean;
+}
+/** Frame payload, exactly as the socket delivered it — never parsed by the SDK. */
+type StreamData = string | ArrayBufferLike | ArrayBufferView | Blob;
+/**
+ * The handle returned by `connectStream`. Deliberately small: no reconnection, no backoff, no
+ * heartbeat and no framing. A dropped connection surfaces once, through `onClose` with the close
+ * code; deciding whether and how to reconnect is the App's business, not the SDK's.
+ */
+interface LesslyStream {
+    /** Queued until the socket is OPEN, then flushed in order. Ignored once the stream is closed. */
+    send(data: StreamData): void;
+    close(code?: number, reason?: string): void;
+    /** Delivers `MessageEvent.data` as-is. Returns an unsubscribe function. */
+    onMessage(cb: (data: StreamData) => void): () => void;
+    /** Returns an unsubscribe function. */
+    onClose(cb: (info: StreamCloseInfo) => void): () => void;
+    /** The underlying socket's readyState (0 CONNECTING, 1 OPEN, 2 CLOSING, 3 CLOSED). */
+    readonly readyState: number;
+}
+/**
+ * What a generated `<tool>Connect` factory needs from the client: the ability to open a stream
+ * for a binding. `createLesslyApp`'s client implements it (see `LesslyClientBase`).
+ */
+interface LesslyStreamOpener {
+    openStream(binding: WsBinding, input?: Record<string, unknown>): LesslyStream;
+}
+/** The shape of `globalThis.WebSocket` this SDK relies on — injectable, like `fetch`. */
+type WebSocketCtor = new (url: string) => WebSocketLike;
+interface WebSocketLike {
+    readonly readyState: number;
+    send(data: StreamData): void;
+    close(code?: number, reason?: string): void;
+    addEventListener(type: string, cb: (ev: never) => void): void;
+    removeEventListener(type: string, cb: (ev: never) => void): void;
+}
+interface LesslyAppOptions {
+    /**
+     * Absolute origin ("https://api.lessly.dev") or a path relative to the page
+     * ("/api", ""), which is resolved against globalThis.location and therefore
+     * only works in a browser.
+     */
+    baseUrl: string;
+    productId: string;
+    getCsrfToken?: () => string | null | undefined;
+    fetch?: typeof fetch;
+    /** Injectable WebSocket constructor for `connectStream`; defaults to `globalThis.WebSocket`. */
+    WebSocket?: WebSocketCtor;
+}
 
 interface LesslyClientBase extends LesslyStreamOpener {
     call(toolName: string, input?: Record<string, unknown>): Promise<unknown>;
@@ -29,4 +108,4 @@ declare class LesslyApiError extends Error {
     constructor(status: number, code: string | null, message: string, body: unknown);
 }
 
-export { GeneratedClient, LesslyApiError, LesslyAppOptions, type LesslyClientBase, LesslyStream, LesslyStreamOpener, WsBinding, connectStream, createLesslyApp };
+export { type Binding, type BindingsMap, GeneratedClient, type HttpMethod, LesslyApiError, type LesslyAppOptions, type LesslyClientBase, type LesslyStream, type LesslyStreamOpener, type ParamIn, type ParamSpec, type StreamCloseInfo, type StreamData, type WebSocketCtor, type WebSocketLike, type WsBinding, type WsBindingsMap, connectStream, createLesslyApp };

package/dist/index.d.ts

@@ -1,6 +1,85 @@
-import { L as LesslyStreamOpener, b as LesslyAppOptions, W as WsBinding, a as LesslyStream } from './types-gTIUAUsP.js';
-export { B as Binding, c as BindingsMap, H as HttpMethod, P as ParamIn, d as ParamSpec, S as StreamCloseInfo, e as StreamData, f as WebSocketCtor, g as WebSocketLike, h as WsBindingsMap } from './types-gTIUAUsP.js';
-import { G as GeneratedClient } from './client.gen-C39RGAWI.js';
+import { G as GeneratedClient } from './client.gen-Dw0AIIZi.js';
+
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type ParamIn = 'path' | 'query' | 'body';
+interface ParamSpec {
+    name: string;
+    in: ParamIn;
+}
+interface Binding {
+    method: HttpMethod;
+    path: string;
+    readOnly: boolean;
+    params?: ParamSpec[];
+}
+/**
+ * The streaming counterpart of `Binding`: the upgrade route of a ws-bound tool. No method (an
+ * upgrade is always a GET) and no `readOnly` (a socket is neither a read nor a write — the tool's
+ * own description defines its framing).
+ */
+interface WsBinding {
+    path: string;
+    params?: ParamSpec[];
+}
+type ActionBindings = Record<string, Binding>;
+type ResourceBindings = Record<string, ActionBindings>;
+type BindingsMap = Record<string, ResourceBindings>;
+type WsActionBindings = Record<string, WsBinding>;
+type WsResourceBindings = Record<string, WsActionBindings>;
+type WsBindingsMap = Record<string, WsResourceBindings>;
+/** Close information, as delivered to every `onClose` subscriber. */
+interface StreamCloseInfo {
+    code: number;
+    reason: string;
+    wasClean: boolean;
+}
+/** Frame payload, exactly as the socket delivered it — never parsed by the SDK. */
+type StreamData = string | ArrayBufferLike | ArrayBufferView | Blob;
+/**
+ * The handle returned by `connectStream`. Deliberately small: no reconnection, no backoff, no
+ * heartbeat and no framing. A dropped connection surfaces once, through `onClose` with the close
+ * code; deciding whether and how to reconnect is the App's business, not the SDK's.
+ */
+interface LesslyStream {
+    /** Queued until the socket is OPEN, then flushed in order. Ignored once the stream is closed. */
+    send(data: StreamData): void;
+    close(code?: number, reason?: string): void;
+    /** Delivers `MessageEvent.data` as-is. Returns an unsubscribe function. */
+    onMessage(cb: (data: StreamData) => void): () => void;
+    /** Returns an unsubscribe function. */
+    onClose(cb: (info: StreamCloseInfo) => void): () => void;
+    /** The underlying socket's readyState (0 CONNECTING, 1 OPEN, 2 CLOSING, 3 CLOSED). */
+    readonly readyState: number;
+}
+/**
+ * What a generated `<tool>Connect` factory needs from the client: the ability to open a stream
+ * for a binding. `createLesslyApp`'s client implements it (see `LesslyClientBase`).
+ */
+interface LesslyStreamOpener {
+    openStream(binding: WsBinding, input?: Record<string, unknown>): LesslyStream;
+}
+/** The shape of `globalThis.WebSocket` this SDK relies on — injectable, like `fetch`. */
+type WebSocketCtor = new (url: string) => WebSocketLike;
+interface WebSocketLike {
+    readonly readyState: number;
+    send(data: StreamData): void;
+    close(code?: number, reason?: string): void;
+    addEventListener(type: string, cb: (ev: never) => void): void;
+    removeEventListener(type: string, cb: (ev: never) => void): void;
+}
+interface LesslyAppOptions {
+    /**
+     * Absolute origin ("https://api.lessly.dev") or a path relative to the page
+     * ("/api", ""), which is resolved against globalThis.location and therefore
+     * only works in a browser.
+     */
+    baseUrl: string;
+    productId: string;
+    getCsrfToken?: () => string | null | undefined;
+    fetch?: typeof fetch;
+    /** Injectable WebSocket constructor for `connectStream`; defaults to `globalThis.WebSocket`. */
+    WebSocket?: WebSocketCtor;
+}
 
 interface LesslyClientBase extends LesslyStreamOpener {
     call(toolName: string, input?: Record<string, unknown>): Promise<unknown>;
@@ -29,4 +108,4 @@ declare class LesslyApiError extends Error {
     constructor(status: number, code: string | null, message: string, body: unknown);
 }
 
-export { GeneratedClient, LesslyApiError, LesslyAppOptions, type LesslyClientBase, LesslyStream, LesslyStreamOpener, WsBinding, connectStream, createLesslyApp };
+export { type Binding, type BindingsMap, GeneratedClient, type HttpMethod, LesslyApiError, type LesslyAppOptions, type LesslyClientBase, type LesslyStream, type LesslyStreamOpener, type ParamIn, type ParamSpec, type StreamCloseInfo, type StreamData, type WebSocketCtor, type WebSocketLike, type WsBinding, type WsBindingsMap, connectStream, createLesslyApp };