@convosite/client 0.0.0-stage → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,224 @@
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+interface SiteMetaValue<T = unknown> {
+    type: string;
+    key: string;
+    value: T;
+}
+interface Site {
+    name: string;
+    global: Record<string, SiteMetaValue>;
+}
+interface Media {
+    id: string;
+    url: string;
+    alt?: string | null;
+    caption?: string | null;
+    width?: number | null;
+    height?: number | null;
+    mime?: string | null;
+    bytes?: number | null;
+    metadata?: Record<string, unknown> | null;
+    [key: string]: unknown;
+}
+interface PageBlock<TData extends Record<string, unknown> = Record<string, unknown>> {
+    key: string;
+    name: string;
+    data: TData;
+}
+interface PageMetaValue<T = unknown> {
+    type: string;
+    key: string;
+    value: T;
+}
+interface Page {
+    id: string;
+    name: string;
+    slug: string;
+    active: boolean;
+    is_home: boolean;
+    path: string;
+    seo: {
+        title: string | null;
+        description: string | null;
+    };
+    blocks: PageBlock[];
+    meta: Record<string, PageMetaValue>;
+    score?: number;
+    [key: string]: unknown;
+}
+interface PageResponse {
+    site: Site;
+    page: Page;
+}
+interface Pagination {
+    current_page: number;
+    per_page: number;
+    total: number;
+    last_page: number;
+    from: number | null;
+    to: number | null;
+}
+type PageSort = 'name' | 'slug' | 'title' | 'created_at' | 'updated_at';
+type SortDirection = 'asc' | 'desc';
+interface PageListOptions extends RequestOptions {
+    parentId?: string | null;
+    sort?: PageSort;
+    direction?: SortDirection;
+    page?: number;
+    perPage?: number;
+}
+interface PageListResponse {
+    site: Site;
+    pages: Page[];
+    pagination: Pagination;
+}
+interface MenuItem {
+    id: string;
+    parent_id: string | null;
+    name: string;
+    description: string | null;
+    classes: string | null;
+    type: string;
+    position: number;
+    href: string | null;
+}
+interface StructuredMenuItem extends MenuItem {
+    children: StructuredMenuItem[];
+}
+interface Menu {
+    name: string;
+    active: boolean;
+    items: MenuItem[];
+    structured: StructuredMenuItem[];
+}
+interface MenuResponse {
+    site: Site;
+    menu: Menu;
+}
+interface SearchOptions extends RequestOptions {
+    limit?: number;
+}
+interface SearchResponse {
+    site: Site;
+    pages: Page[];
+}
+interface ActionResponse {
+    message: string;
+}
+interface RequestOptions {
+    signal?: AbortSignal;
+}
+interface RawRequestOptions extends RequestInit {
+    /** Parse successful responses as JSON by default. */
+    parseAs?: 'json' | 'text' | 'response';
+}
+interface ConversationSendOptions extends RequestOptions {
+    sessionId?: string;
+}
+type ConversationFieldEvent = {
+    type: 'field_delta';
+    path: string;
+    delta: string;
+    value?: unknown;
+    [key: string]: unknown;
+} | {
+    type: 'field_complete';
+    path: string;
+    value: unknown;
+    [key: string]: unknown;
+} | {
+    type: 'field';
+    path: string;
+    value?: unknown;
+    delta?: string;
+    [key: string]: unknown;
+};
+interface ConversationUsageEvent {
+    type: 'conversation_usage';
+    user_turns: number;
+    max_user_turns: number;
+    reached_limit: boolean;
+    [key: string]: unknown;
+}
+interface ConversationCompleteEvent {
+    type: 'complete';
+    [key: string]: unknown;
+}
+interface ConversationErrorEvent {
+    type: 'error';
+    message: string;
+    request_id?: string;
+    [key: string]: unknown;
+}
+type ConversationEvent = ConversationFieldEvent | ConversationUsageEvent | ConversationCompleteEvent | ConversationErrorEvent | ({
+    type: string;
+} & Record<string, unknown>);
+interface ConversationEndResponse {
+    ended: boolean;
+}
+interface Conversation {
+    readonly sessionId: string | null;
+    send(query: string, options?: RequestOptions): AsyncIterable<ConversationEvent>;
+    end(options?: RequestOptions): Promise<ConversationEndResponse>;
+    reset(): void;
+}
+type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+interface ConvositeConfig {
+    /** Site ULID used by the Convosite runtime API. */
+    site: string;
+    /** Laravel runtime API base. Defaults to https://app.convosite.io/api. */
+    baseUrl?: string;
+    /** Conversations Worker base. Defaults to baseUrl (the production Worker is routed through app.convosite.io). */
+    conversationUrl?: string;
+    /** Custom fetch implementation for SSR runtimes, tests, proxies, etc. */
+    fetch?: Fetch;
+    /** Headers applied to Laravel API requests. */
+    headers?: HeadersInit;
+    /** Timeout for non-streaming requests in milliseconds. Defaults to 30000. Set 0 to disable. */
+    timeout?: number;
+}
+interface ConvositeClient {
+    readonly site: {
+        get(options?: RequestOptions): Promise<Site>;
+    };
+    readonly pages: {
+        get(path: string, options?: RequestOptions): Promise<PageResponse>;
+        find(id: string, options?: RequestOptions): Promise<PageResponse>;
+        list(options?: PageListOptions): Promise<PageListResponse>;
+    };
+    readonly menus: {
+        get(id: string, options?: RequestOptions): Promise<MenuResponse>;
+    };
+    search(query: string, options?: SearchOptions): Promise<SearchResponse>;
+    readonly actions: {
+        run<TInput extends Record<string, unknown> = Record<string, unknown>>(endpointId: string, input: TInput, options?: RequestOptions): Promise<ActionResponse>;
+    };
+    readonly conversations: {
+        create(sessionId?: string): Conversation;
+        send(query: string, options?: ConversationSendOptions): AsyncIterable<ConversationEvent>;
+        end(sessionId: string, options?: RequestOptions): Promise<ConversationEndResponse>;
+    };
+    request<T = unknown>(path: string, options?: RawRequestOptions): Promise<T>;
+}
+
+declare function createConvosite(config: ConvositeConfig): ConvositeClient;
+
+declare class ConvositeError extends Error {
+    readonly status: number;
+    readonly code: string | null;
+    readonly details: unknown;
+    readonly requestId: string | null;
+    constructor(options: {
+        message: string;
+        status?: number;
+        code?: string | null;
+        details?: unknown;
+        requestId?: string | null;
+        cause?: unknown;
+    });
+}
+
+export { type ActionResponse, type Conversation, type ConversationCompleteEvent, type ConversationEndResponse, type ConversationErrorEvent, type ConversationEvent, type ConversationFieldEvent, type ConversationSendOptions, type ConversationUsageEvent, type ConvositeClient, type ConvositeConfig, ConvositeError, type Fetch, type JsonPrimitive, type JsonValue, type Media, type Menu, type MenuItem, type MenuResponse, type Page, type PageBlock, type PageListOptions, type PageListResponse, type PageMetaValue, type PageResponse, type PageSort, type Pagination, type RawRequestOptions, type RequestOptions, type SearchOptions, type SearchResponse, type Site, type SiteMetaValue, type SortDirection, type StructuredMenuItem, createConvosite };

package/dist/index.d.ts

@@ -0,0 +1,224 @@
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+interface SiteMetaValue<T = unknown> {
+    type: string;
+    key: string;
+    value: T;
+}
+interface Site {
+    name: string;
+    global: Record<string, SiteMetaValue>;
+}
+interface Media {
+    id: string;
+    url: string;
+    alt?: string | null;
+    caption?: string | null;
+    width?: number | null;
+    height?: number | null;
+    mime?: string | null;
+    bytes?: number | null;
+    metadata?: Record<string, unknown> | null;
+    [key: string]: unknown;
+}
+interface PageBlock<TData extends Record<string, unknown> = Record<string, unknown>> {
+    key: string;
+    name: string;
+    data: TData;
+}
+interface PageMetaValue<T = unknown> {
+    type: string;
+    key: string;
+    value: T;
+}
+interface Page {
+    id: string;
+    name: string;
+    slug: string;
+    active: boolean;
+    is_home: boolean;
+    path: string;
+    seo: {
+        title: string | null;
+        description: string | null;
+    };
+    blocks: PageBlock[];
+    meta: Record<string, PageMetaValue>;
+    score?: number;
+    [key: string]: unknown;
+}
+interface PageResponse {
+    site: Site;
+    page: Page;
+}
+interface Pagination {
+    current_page: number;
+    per_page: number;
+    total: number;
+    last_page: number;
+    from: number | null;
+    to: number | null;
+}
+type PageSort = 'name' | 'slug' | 'title' | 'created_at' | 'updated_at';
+type SortDirection = 'asc' | 'desc';
+interface PageListOptions extends RequestOptions {
+    parentId?: string | null;
+    sort?: PageSort;
+    direction?: SortDirection;
+    page?: number;
+    perPage?: number;
+}
+interface PageListResponse {
+    site: Site;
+    pages: Page[];
+    pagination: Pagination;
+}
+interface MenuItem {
+    id: string;
+    parent_id: string | null;
+    name: string;
+    description: string | null;
+    classes: string | null;
+    type: string;
+    position: number;
+    href: string | null;
+}
+interface StructuredMenuItem extends MenuItem {
+    children: StructuredMenuItem[];
+}
+interface Menu {
+    name: string;
+    active: boolean;
+    items: MenuItem[];
+    structured: StructuredMenuItem[];
+}
+interface MenuResponse {
+    site: Site;
+    menu: Menu;
+}
+interface SearchOptions extends RequestOptions {
+    limit?: number;
+}
+interface SearchResponse {
+    site: Site;
+    pages: Page[];
+}
+interface ActionResponse {
+    message: string;
+}
+interface RequestOptions {
+    signal?: AbortSignal;
+}
+interface RawRequestOptions extends RequestInit {
+    /** Parse successful responses as JSON by default. */
+    parseAs?: 'json' | 'text' | 'response';
+}
+interface ConversationSendOptions extends RequestOptions {
+    sessionId?: string;
+}
+type ConversationFieldEvent = {
+    type: 'field_delta';
+    path: string;
+    delta: string;
+    value?: unknown;
+    [key: string]: unknown;
+} | {
+    type: 'field_complete';
+    path: string;
+    value: unknown;
+    [key: string]: unknown;
+} | {
+    type: 'field';
+    path: string;
+    value?: unknown;
+    delta?: string;
+    [key: string]: unknown;
+};
+interface ConversationUsageEvent {
+    type: 'conversation_usage';
+    user_turns: number;
+    max_user_turns: number;
+    reached_limit: boolean;
+    [key: string]: unknown;
+}
+interface ConversationCompleteEvent {
+    type: 'complete';
+    [key: string]: unknown;
+}
+interface ConversationErrorEvent {
+    type: 'error';
+    message: string;
+    request_id?: string;
+    [key: string]: unknown;
+}
+type ConversationEvent = ConversationFieldEvent | ConversationUsageEvent | ConversationCompleteEvent | ConversationErrorEvent | ({
+    type: string;
+} & Record<string, unknown>);
+interface ConversationEndResponse {
+    ended: boolean;
+}
+interface Conversation {
+    readonly sessionId: string | null;
+    send(query: string, options?: RequestOptions): AsyncIterable<ConversationEvent>;
+    end(options?: RequestOptions): Promise<ConversationEndResponse>;
+    reset(): void;
+}
+type Fetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+interface ConvositeConfig {
+    /** Site ULID used by the Convosite runtime API. */
+    site: string;
+    /** Laravel runtime API base. Defaults to https://app.convosite.io/api. */
+    baseUrl?: string;
+    /** Conversations Worker base. Defaults to baseUrl (the production Worker is routed through app.convosite.io). */
+    conversationUrl?: string;
+    /** Custom fetch implementation for SSR runtimes, tests, proxies, etc. */
+    fetch?: Fetch;
+    /** Headers applied to Laravel API requests. */
+    headers?: HeadersInit;
+    /** Timeout for non-streaming requests in milliseconds. Defaults to 30000. Set 0 to disable. */
+    timeout?: number;
+}
+interface ConvositeClient {
+    readonly site: {
+        get(options?: RequestOptions): Promise<Site>;
+    };
+    readonly pages: {
+        get(path: string, options?: RequestOptions): Promise<PageResponse>;
+        find(id: string, options?: RequestOptions): Promise<PageResponse>;
+        list(options?: PageListOptions): Promise<PageListResponse>;
+    };
+    readonly menus: {
+        get(id: string, options?: RequestOptions): Promise<MenuResponse>;
+    };
+    search(query: string, options?: SearchOptions): Promise<SearchResponse>;
+    readonly actions: {
+        run<TInput extends Record<string, unknown> = Record<string, unknown>>(endpointId: string, input: TInput, options?: RequestOptions): Promise<ActionResponse>;
+    };
+    readonly conversations: {
+        create(sessionId?: string): Conversation;
+        send(query: string, options?: ConversationSendOptions): AsyncIterable<ConversationEvent>;
+        end(sessionId: string, options?: RequestOptions): Promise<ConversationEndResponse>;
+    };
+    request<T = unknown>(path: string, options?: RawRequestOptions): Promise<T>;
+}
+
+declare function createConvosite(config: ConvositeConfig): ConvositeClient;
+
+declare class ConvositeError extends Error {
+    readonly status: number;
+    readonly code: string | null;
+    readonly details: unknown;
+    readonly requestId: string | null;
+    constructor(options: {
+        message: string;
+        status?: number;
+        code?: string | null;
+        details?: unknown;
+        requestId?: string | null;
+        cause?: unknown;
+    });
+}
+
+export { type ActionResponse, type Conversation, type ConversationCompleteEvent, type ConversationEndResponse, type ConversationErrorEvent, type ConversationEvent, type ConversationFieldEvent, type ConversationSendOptions, type ConversationUsageEvent, type ConvositeClient, type ConvositeConfig, ConvositeError, type Fetch, type JsonPrimitive, type JsonValue, type Media, type Menu, type MenuItem, type MenuResponse, type Page, type PageBlock, type PageListOptions, type PageListResponse, type PageMetaValue, type PageResponse, type PageSort, type Pagination, type RawRequestOptions, type RequestOptions, type SearchOptions, type SearchResponse, type Site, type SiteMetaValue, type SortDirection, type StructuredMenuItem, createConvosite };