@litert-lm/core 0.12.0

package/README.md

@@ -0,0 +1,145 @@
+# LiteRT-LM JS API
+
+The JavaScript API of LiteRT-LM for running LLMs in the browser. This is an
+early preview that supports text-in / text-out running in WebGPU. 
+[LiteRT-LM](https://www.google.com/url?sa=D&q=https%3A%2F%2Fai.google.dev%2Fedge%2Flitert-lm%2F)
+is a production-ready, open-source inference framework designed to deliver
+high-performance, cross-platform LLM deployments on edge devices.
+
+- **Documentation**: [https://ai.google.dev/edge/litert-lm/js](https://ai.google.dev/edge/litert-lm/js)
+- **GitHub**: [https://github.com/google-ai-edge/LiteRT-LM](https://github.com/google-ai-edge/LiteRT-LM)
+
+## Introduction
+
+Here is a sample REPL chat app built with the JavaScript API:
+
+```ts
+<div id="out" style="white-space: pre-wrap; font-family: monospace;"></div>
+<input id="in" onkeydown="if(event.key === 'Enter') repl(this)">
+
+<script type="module">
+  import { Engine } from 'https://cdn.jsdelivr.net/npm/@litert-lm/core/+esm';
+  const engine = await Engine.create({
+    model: 'https://huggingface.co/litert-community/gemma-4-E2B-it-litert-lm/resolve/main/gemma-4-E2B-it-web.litertlm'
+  });
+  const chat = await engine.createConversation();
+
+  window.repl = async (el) => {
+    const text = el.value;
+    el.value = ''; // Clear immediately
+    out.append(`\n>>> ${text}\nAI: `);
+
+    for await (const chunk of chat.sendMessageStreaming(text)) {
+      out.append(chunk.content[0].text);
+    }
+  };
+</script>
+```
+
+## Getting Started
+
+LiteRT-LM is available as an npm package. You can install the latest version
+from npm or directly import it from a CDN:
+
+```shell
+# From npm
+npm i --save @litert-lm/core
+
+# From a CDN (in your JavaScript file)
+import * as litertlm from 'https://cdn.jsdelivr.net/npm/@litert-lm/core/+esm';
+```
+
+### Initialize the Engine
+
+The `Engine` is the entry point to the API. It handles model loading, session
+creation, and resource management. Remember to `delete` the engine to release
+resources when the model is no longer needed.
+
+**Note:** Initializing the engine can take several seconds to load the model.
+
+```ts
+import {Engine, EngineSettings} from '@litert-lm/core';
+
+const engineSettings = {
+  model: 'url/path/to/model.litertlm', // or a ReadableStream, or a Blob
+} satisfies EngineSettings;
+
+const engine = await Engine.create(engineSettings);
+
+// ... Use the engine to create a conversation ...
+
+// Delete the engine when done.
+await engine.delete();
+```
+
+### Create a Conversation
+
+Once the engine is initialized, create a `Conversation` instance. You can
+provide a `ConversationConfig` to customize its behavior.
+
+```ts
+const conversation = await engine.createConversation({
+  preface: {
+    messages: [
+      {role: 'system', content: 'You are a helpful assistant'}
+    ]
+  }
+});
+
+conversation.sendMessage({
+  role: 'user',
+  content: 'Write a poem',
+});
+```
+
+### Send Messages
+
+You can send messages with or without streaming.
+
+#### Non-Streaming Example
+
+```ts
+// Simple string input
+let response = await conversation.sendMessage("What is the capital of France?");
+console.log(response.content[0].text);
+
+// Or with full message structure
+response = await conversation.sendMessage({role: 'user', content: '...'});
+```
+
+#### Streaming Example
+
+```ts
+// sendMessageStreaming returns a ReadableStream of response chunks
+const stream = conversation.sendMessageStreaming('Tell me a long story.');
+
+for await (const chunk of stream) {
+  // Chunks are Records containing pieces of the response
+  for (const item of chunk.content) {
+    if (item.type === 'text') {
+      console.log(item.text);
+    }
+  }
+}
+```
+
+#### Cancel Generation
+
+You can cancel an ongoing generation explicitly by calling `cancel()` on the
+`Conversation` instance:
+
+```ts
+// Cancel any ongoing generation
+conversation.cancel();
+```
+
+If you are streaming the response, exiting the `for await...of` loop early (such
+as with `break`) will also automatically cancel the ongoing generation:
+
+```ts
+for await (const chunk of stream) {
+  if (shouldStop()) {
+    break; // Cancels the stream and underlying generation
+  }
+}
+```

package/dist/cleanup.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * A utility class for managing a set of callbacks that can be called to clean
+ * up resources.
+ */
+export declare class Cleanup {
+    private readonly callbacks;
+    add(callback: () => void): () => void;
+    run(): void;
+}
+//# sourceMappingURL=cleanup.d.ts.map

package/dist/cleanup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanup.d.ts","sourceRoot":"","sources":["../src/cleanup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;GAGG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA8B;IAExD,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IASrC,GAAG,IAAI,IAAI;CAMZ"}

package/dist/cleanup.js

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * A utility class for managing a set of callbacks that can be called to clean
+ * up resources.
+ */
+export class Cleanup {
+    callbacks = new Set();
+    add(callback) {
+        this.callbacks.add(callback);
+        return () => {
+            this.callbacks.delete(callback);
+            callback();
+        };
+    }
+    run() {
+        for (const callback of this.callbacks) {
+            callback();
+        }
+        this.callbacks.clear();
+    }
+}
+//# sourceMappingURL=cleanup.js.map

package/dist/cleanup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanup.js","sourceRoot":"","sources":["../src/cleanup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;GAGG;AACH,MAAM,OAAO,OAAO;IACD,SAAS,GAAoB,IAAI,GAAG,EAAE,CAAC;IAExD,GAAG,CAAC,QAAoB;QACtB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC;IACJ,CAAC;IAGD,GAAG;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,QAAQ,EAAE,CAAC;QACb,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACF"}

package/dist/conversation.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Message, MessageLike } from './conversation_config';
+import { Mutex } from './mutex';
+import { Conversation as WasmConversation, Engine as WasmEngine } from './wasm_binding_types';
+/**
+ * LiteRT-LM Conversation
+ */
+export declare class Conversation {
+    private readonly conversation;
+    private readonly engine;
+    private readonly mutexes;
+    private isBusy;
+    constructor(conversation: WasmConversation, engine: WasmEngine, mutexes: {
+        executor: Mutex;
+    });
+    sendMessage(message: MessageLike | MessageLike[]): Promise<Message>;
+    /**
+     * Sends a message to the LLM and returns a ReadableStream that yields
+     * message chunks as they are generated.
+     */
+    sendMessageStreaming(message: MessageLike | MessageLike[]): ReadableStream<Message>;
+    /**
+     * Sends a signal to cancel any current generation.
+     */
+    cancel(): void;
+    getHistory(): Message[];
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=conversation.d.ts.map

package/dist/conversation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["../src/conversation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAC,OAAO,EAAE,WAAW,EAAC,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,YAAY,IAAI,gBAAgB,EAAE,MAAM,IAAI,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAK5F;;GAEG;AACH,qBAAa,YAAY;IAInB,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAL5B,OAAO,CAAC,MAAM,CAAS;gBAGF,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE;QAAC,QAAQ,EAAE,KAAK,CAAA;KAAC;IAEzC,WAAW,CAAC,OAAO,EAAE,WAAW,GAAC,WAAW,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBvE;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,WAAW,GAAC,WAAW,EAAE,GACnD,cAAc,CAAC,OAAO,CAAC;IAkE3B;;OAEG;IACH,MAAM;IAIN,UAAU,IAAI,OAAO,EAAE;IAQjB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAK9B"}

package/dist/conversation.js

@@ -0,0 +1,153 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const BUSY_MESSAGE = 'Conversation is busy. A generation is already in progress.';
+/**
+ * LiteRT-LM Conversation
+ */
+export class Conversation {
+    conversation;
+    engine;
+    mutexes;
+    isBusy = false;
+    constructor(conversation, engine, mutexes) {
+        this.conversation = conversation;
+        this.engine = engine;
+        this.mutexes = mutexes;
+    }
+    async sendMessage(message) {
+        if (this.isBusy) {
+            throw new Error(BUSY_MESSAGE);
+        }
+        this.isBusy = true;
+        try {
+            return await this.mutexes.executor.acquireAndRun(async () => {
+                const jsonStr = messageToJsonString(message);
+                const resultStr = await this.conversation.sendMessage(jsonStr);
+                return JSON.parse(resultStr);
+            });
+        }
+        finally {
+            this.isBusy = false;
+        }
+    }
+    /**
+     * Sends a message to the LLM and returns a ReadableStream that yields
+     * message chunks as they are generated.
+     */
+    sendMessageStreaming(message) {
+        if (this.isBusy) {
+            throw new Error(BUSY_MESSAGE);
+        }
+        this.isBusy = true;
+        let isCancelled = false;
+        const jsonStr = messageToJsonString(message);
+        return new ReadableStream({
+            start: (controller) => {
+                try {
+                    this.conversation
+                        .sendMessageAsync(jsonStr, (chunk, isDone, error) => {
+                        if (isCancelled)
+                            return;
+                        if (error) {
+                            this.isBusy = false;
+                            controller.error(new Error(error));
+                            return;
+                        }
+                        if (chunk) {
+                            try {
+                                controller.enqueue(JSON.parse(chunk));
+                            }
+                            catch (e) {
+                                this.isBusy = false;
+                                controller.error(e);
+                            }
+                        }
+                        if (isDone) {
+                            this.isBusy = false;
+                            controller.close();
+                        }
+                    })
+                        .catch((e) => {
+                        if (isCancelled)
+                            return;
+                        this.isBusy = false;
+                        controller.error(e);
+                    });
+                    // Since we're using the synchronus execution manager in C++, which
+                    // lazily executes tasks, we must call waitUntilDone to start the
+                    // execution.
+                    const runWait = async () => {
+                        await this.mutexes.executor.acquireAndRun(async () => {
+                            await this.engine.waitUntilDone();
+                        });
+                    };
+                    runWait().catch((e) => {
+                        if (isCancelled)
+                            return;
+                        this.isBusy = false;
+                        controller.error(e);
+                    });
+                }
+                catch (e) {
+                    if (isCancelled)
+                        return;
+                    this.isBusy = false;
+                    controller.error(e);
+                }
+            },
+            cancel: () => {
+                isCancelled = true;
+                this.isBusy = false;
+                this.cancel();
+            }
+        });
+    }
+    /**
+     * Sends a signal to cancel any current generation.
+     */
+    cancel() {
+        this.conversation.cancelProcess();
+    }
+    getHistory() {
+        if (this.isBusy) {
+            throw new Error(BUSY_MESSAGE);
+        }
+        const historyStr = this.conversation.getHistory();
+        return JSON.parse(historyStr);
+    }
+    async delete() {
+        await this.mutexes.executor.acquireAndRun(() => {
+            this.conversation.delete();
+        });
+    }
+}
+function messageToJsonString(messageLike) {
+    let message;
+    if (Array.isArray(messageLike)) {
+        message = messageLike.map(toMessage);
+    }
+    else {
+        message = toMessage(messageLike);
+    }
+    return JSON.stringify(message);
+}
+function toMessage(messageLike) {
+    if (typeof messageLike === 'string') {
+        return { role: 'user', content: messageLike };
+    }
+    return messageLike;
+}
+//# sourceMappingURL=conversation.js.map

package/dist/conversation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../src/conversation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH,MAAM,YAAY,GACd,4DAA4D,CAAC;AAEjE;;GAEG;AACH,MAAM,OAAO,YAAY;IAIF;IACA;IACA;IALb,MAAM,GAAG,KAAK,CAAC;IAEvB,YACqB,YAA8B,EAC9B,MAAkB,EAClB,OAA0B;QAF1B,iBAAY,GAAZ,YAAY,CAAkB;QAC9B,WAAM,GAAN,MAAM,CAAY;QAClB,YAAO,GAAP,OAAO,CAAmB;IAAG,CAAC;IAEnD,KAAK,CAAC,WAAW,CAAC,OAAkC;QAClD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE;gBAC1D,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAC/D,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAY,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,OAAkC;QAErD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC7C,OAAO,IAAI,cAAc,CAAU;YACjC,KAAK,EAAE,CAAC,UAAU,EAAE,EAAE;gBACpB,IAAI,CAAC;oBACH,IAAI,CAAC,YAAY;yBACZ,gBAAgB,CACb,OAAO,EACP,CAAC,KAAkB,EAAE,MAAe,EAAE,KAAkB,EAAE,EAAE;wBAC1D,IAAI,WAAW;4BAAE,OAAO;wBACxB,IAAI,KAAK,EAAE,CAAC;4BACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;4BACpB,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;4BACnC,OAAO;wBACT,CAAC;wBACD,IAAI,KAAK,EAAE,CAAC;4BACV,IAAI,CAAC;gCACH,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAY,CAAC,CAAC;4BACnD,CAAC;4BAAC,OAAO,CAAC,EAAE,CAAC;gCACX,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gCACpB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;4BACtB,CAAC;wBACH,CAAC;wBACD,IAAI,MAAM,EAAE,CAAC;4BACX,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;4BACpB,UAAU,CAAC,KAAK,EAAE,CAAC;wBACrB,CAAC;oBACH,CAAC,CAAC;yBACL,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACX,IAAI,WAAW;4BAAE,OAAO;wBACxB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;wBACpB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtB,CAAC,CAAC,CAAC;oBACP,mEAAmE;oBACnE,iEAAiE;oBACjE,aAAa;oBACb,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;wBACzB,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,IAAI,EAAE;4BACnD,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;wBACpC,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC;oBACF,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACpB,IAAI,WAAW;4BAAE,OAAO;wBACxB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;wBACpB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtB,CAAC,CAAC,CAAC;gBACL,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,WAAW;wBAAE,OAAO;oBACxB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;oBACpB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;YACD,MAAM,EAAE,GAAG,EAAE;gBACX,WAAW,GAAG,IAAI,CAAC;gBACnB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gBACpB,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;IACpC,CAAC;IAED,UAAU;QACR,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAc,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE;YAC7C,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,SAAS,mBAAmB,CAAC,WAAsC;IACjE,IAAI,OAA0B,CAAC;IAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,SAAS,CAAC,WAAwB;IACzC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAC,CAAC;IAC9C,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/conversation_config.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { SessionConfig } from './session_config';
+import { JsonValue } from './types';
+/**
+ * Parameters for a tool, following JSON Schema format.
+ */
+export declare interface ToolParameters {
+    type?: string;
+    properties?: Record<string, JsonValue>;
+    required?: string[];
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * A tool is a function that can be called by the LLM.
+ */
+export declare interface Tool {
+    name: string;
+    description?: string;
+    parameters?: ToolParameters;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * Value of a tool response.
+ */
+export declare interface ToolResponseValue {
+    name?: string;
+    tool_name?: string;
+    response?: Record<string, JsonValue>;
+    value?: JsonValue;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * Item in the content array of a Message.
+ */
+export declare interface MessageContentItem {
+    type: string;
+    text?: string;
+    path?: string;
+    tool_response?: ToolResponseValue;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * A function call predicted by the model.
+ */
+export declare interface ToolCallFunction {
+    name: string;
+    arguments: Record<string, JsonValue>;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * A tool call in the message.
+ */
+export declare interface ToolCall {
+    type: string;
+    function: ToolCallFunction;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * A message in the conversation.
+ */
+export declare interface Message {
+    role: string;
+    content?: string | MessageContentItem[];
+    channels?: Record<string, string>;
+    tool_calls?: ToolCall[];
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * Types that can be used as a Message in the conversation.
+ */
+export type MessageLike = string | Message;
+/**
+ * Preface is the initial messages, tools and extra context for the
+ * conversation to begin with. It provides the initial background for the
+ * conversation.
+ */
+export declare interface Preface {
+    messages?: Message[];
+    tools?: Tool[];
+    extra_context?: Record<string, JsonValue>;
+    [key: string]: JsonValue | undefined;
+}
+/**
+ * Configuration for the Conversation instance.
+ */
+export declare interface ConversationConfig {
+    sessionConfig?: SessionConfig;
+    preface?: Preface;
+    enableConstrainedDecoding?: boolean;
+    prefillPrefaceOnInit?: boolean;
+    filterChannelContentFromKvCache?: boolean;
+}
+//# sourceMappingURL=conversation_config.d.ts.map

package/dist/conversation_config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation_config.d.ts","sourceRoot":"","sources":["../src/conversation_config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,cAAc;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,IAAI;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,iBAAiB;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,kBAAkB;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,iBAAiB,CAAC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,gBAAgB;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,QAAQ;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,OAAO;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,GAAC,kBAAkB,EAAE,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAC,OAAO,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,OAAO;IAI9B,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAErB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IAIf,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAC,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,kBAAkB;IACzC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAE3C"}

package/dist/conversation_config.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};
+//# sourceMappingURL=conversation_config.js.map

package/dist/conversation_config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation_config.js","sourceRoot":"","sources":["../src/conversation_config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG"}

package/dist/engine.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2026 The ODML Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Conversation } from './conversation';
+import { ConversationConfig } from './conversation_config';
+import { EngineSettings } from './engine_settings';
+import { Session } from './session';
+import { RecursiveRequired } from './types';
+import { Deletable } from './wasm_binding_types';
+/**
+ * LiteRT-LM Engine
+ */
+export declare class Engine implements Deletable {
+    private readonly wasm;
+    private readonly engine;
+    private readonly deleteCallback;
+    readonly settings: RecursiveRequired<EngineSettings>;
+    private mutexes;
+    private constructor();
+    static create(engineSettings: EngineSettings, inputPromptAsHint?: string): Promise<Engine>;
+    createSession(sessionConfig?: {}): Promise<Session>;
+    createConversation(config?: ConversationConfig): Promise<Conversation>;
+    delete(): Promise<void>;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,kBAAkB,EAAC,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAC,cAAc,EAA+E,MAAM,mBAAmB,CAAC;AAK/H,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AAElC,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAwD,SAAS,EAAsF,MAAM,sBAAsB,CAAC;AAQ3L;;GAEG;AACH,qBAAa,MAAO,YAAW,SAAS;IAOlC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAEvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IATnC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACrD,OAAO,CAAC,OAAO,CAEb;IAEF,OAAO;WAgBM,MAAM,CAAC,cAAc,EAAE,cAAc,EAAE,iBAAiB,SAAK,GACtE,OAAO,CAAC,MAAM,CAAC;IAsFb,aAAa,CAAC,aAAa,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAWnD,kBAAkB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IA8BtE,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAK9B"}