@callimacus/thamyr 4.3.4

package/dist/types/index.d.ts

@@ -0,0 +1,203 @@
+/*!
+ * Copyright © 2025–2026 Solomei AI SRL. All rights reserved.
+ *
+ * Proprietary software, licensed for use by Callimacus customers only.
+ * See LICENSE.md for the full terms.
+ *
+ */
+import { ThamyrResponse, ErrorMessage, ClientInfo, UiObserverConfig, UserInteractionType, InteractionPayloadMap, CallimacusApi } from '@callimacus/thamyr-core';
+export * from '@callimacus/thamyr-core';
+
+/**
+ Configuration options for WebsocketManager
+ */
+type CallimacusManagerOptions = {
+    /**
+     Whether to automatically connect to the server when initialized
+     @default true
+     */
+    autoConnect?: boolean;
+    /**
+     URL to connect to the Callimacus server
+     @default wss://localhost:4000
+     */
+    url?: string;
+    /**
+     Authentication token for connecting to the server
+     */
+    token?: string;
+    /**
+     Callbacks for different events
+     */
+    callbacks?: {
+        /**
+         Called when the connection status changes
+         */
+        onConnectionStatusChange?: (isConnected: boolean) => void;
+        /**
+         Called when a response is received from the server
+         */
+        onResponse?: (response: ThamyrResponse) => void;
+        /**
+         Called when an error is received from the server
+         */
+        onError?: (error: ErrorMessage) => void;
+        /**
+         Called when client information is gathered
+         */
+        onClientInfo?: (clientInfo: ClientInfo) => void;
+    };
+    /**
+     Optional autonomous UI observer configuration.
+     When enabled, context snapshots are attached automatically on `sendUserInteraction`.
+     */
+    uiObserver?: UiObserverConfig;
+};
+/**
+ Manages Callimacus service interactions for vanilla JavaScript applications.
+
+ Provides a lightweight wrapper around the core Callimacus service with
+ a more convenient API for vanilla JS usage.
+
+ @example
+ ```js
+ // Initialize (connects automatically by default)
+ const manager = new WebsocketManager({
+   url: "wss://my-callimacus-server.example.com",
+   token: "your-auth-token",
+   callbacks: {
+     onConnectionStatusChange: (isConnected) => {
+       console.log(`Connection status: ${isConnected ? 'connected' : 'disconnected'}`);
+     },
+     onResponse: (response) => {
+       console.log('Received response:', response);
+     }
+   }
+ });
+
+ // Or connect manually (pass autoConnect: false above)
+ manager.connect("wss://server.example.com", "your-auth-token");
+
+ // Send an interaction: (type, payload)
+ manager.sendUserInteraction("create-round", { inputEvent });
+
+ // Disconnect when done
+ manager.disconnect();
+ ```
+ */
+declare class WebsocketManager {
+    private onConnectionStatusChangeCallback?;
+    private onResponseCallback?;
+    private onErrorCallback?;
+    private readonly onClientInfoCallback?;
+    /**
+     Creates a new WebsocketManager instance
+
+     @param options - Configuration options
+     */
+    constructor(options?: CallimacusManagerOptions);
+    /**
+     Sets up event listeners for the Callimacus service
+     */
+    private setupEventListeners;
+    /**
+     Connects to the Callimacus server
+
+     @param url - The URL of the server to connect to
+     @param token - Authentication token to pass with the connection
+     */
+    connect(url?: string, token?: string): void;
+    /**
+     Disconnects from the Callimacus server
+     */
+    disconnect(): void;
+    /**
+     Sends a typed user interaction to the server with full type assistance.
+
+     @template T - The specific interaction type
+     @param type - Which user interaction to send (e.g. `CREATE_ROUND`)
+     @param payload - The properly typed payload for this interaction type
+     */
+    sendUserInteraction<T extends UserInteractionType>(type: T, payload: InteractionPayloadMap[T]): void;
+    /**
+     Gathers client information
+     */
+    gatherClientInfo(): void;
+    /**
+     Sets a callback to be called when the connection status changes
+
+     @param callback - Function to call when connection status changes
+     @returns A function to remove the callback
+     */
+    onConnectionStatusChange(callback: (isConnected: boolean) => void): () => void;
+    /**
+     Sets a callback to be called when a response is received
+
+     @param callback - Function to call when a response is received
+     @returns A function to remove the callback
+     */
+    onResponse(callback: (response: ThamyrResponse) => void): () => void;
+    /**
+     Sets a callback to be called when an error is received
+
+     @param callback - Function to call when an error is received
+     @returns A function to remove the callback
+     */
+    onError(callback: (error: ErrorMessage) => void): () => void;
+}
+
+/**
+ The one read outside the generated contract: `sitemap.xml` is a token-less,
+ domain-resolved route the public document cannot describe. Same fetch client as
+ every other namespace; the classic direct-value promise is kept.
+ */
+declare class SitemapAPI {
+    readonly config: {
+        accessToken: string;
+        endpoint: string;
+    };
+    private readonly client;
+    constructor(config: {
+        accessToken: string;
+        endpoint: string;
+    });
+    /**
+     The site map as XML text (an empty body resolves `''`). Rejects with an `Error`
+     carrying `status` (the HTTP status, or `undefined` when no response arrived) on
+     anything but a 2xx.
+     */
+    getSitemap(): Promise<string>;
+}
+
+/**
+ Extends the generated {@link CallimacusApi}: the contracted namespaces (content,
+ stories, products, whisper, analytics, cart, skesis) live on the instance and
+ grow with the contract. Their methods resolve `{data, error, response}` by default.
+ */
+declare class Thamyr extends CallimacusApi {
+    readonly config: {
+        endpoint?: string;
+        /**
+        Your Callimacus public client ID (`cal-pk-…`).
+        */
+        clientId?: string;
+        uiObserver?: UiObserverConfig;
+    };
+    private readonly websocketManager;
+    readonly sitemap: SitemapAPI;
+    constructor(config: {
+        endpoint?: string;
+        /**
+        Your Callimacus public client ID (`cal-pk-…`).
+        */
+        clientId?: string;
+        uiObserver?: UiObserverConfig;
+    });
+    sendAudio(audio: Blob, query?: string): void;
+    sendUserInteraction<T extends UserInteractionType>(type: T, payload: InteractionPayloadMap[T]): void;
+    onResponse(callback: (response: ThamyrResponse) => void): void;
+    onError(callback: (error: ErrorMessage) => void): void;
+}
+
+export { SitemapAPI, Thamyr, WebsocketManager };
+export type { CallimacusManagerOptions };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@callimacus/thamyr",
+  "version": "4.3.4",
+  "private": false,
+  "description": "JavaScript package for Thamyr",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://docs.callimacus.ai/thamyr-sdk/typescript/1-overview",
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "CHANGELOG.core.md",
+    "MIGRATION.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org",
+    "@callimacus:registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "prepack": "cp ../../MIGRATION.md ./MIGRATION.md && cp ../core/CHANGELOG.md ./CHANGELOG.core.md",
+    "build": "rollup -c",
+    "dev": "rollup -c -w",
+    "clean": "rm -rf dist",
+    "lint": "eslint src",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@callimacus/thamyr-core": "^4.3.4"
+  },
+  "gitHead": "fafba2c8ca0586f95b1d03c5eede356a53b00886",
+  "devDependencies": {
+    "eslint-config-xo": "^4.0.1",
+    "vitest": "^5.0.2"
+  }
+}