@trymirai/uzu 0.1.2

package/README.md

@@ -0,0 +1,38 @@
+# TS Example (N-API)
+
+This folder shows the *minimal* way to call the Rust crate **uzu_plus** from Node via the [`napi-rs`](https://github.com/napi-rs/napi-rs) tool-chain.
+
+---
+## Prerequisites
+
+1. **Rust** tool-chain (stable)
+   ```bash
+   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+   ```
+2. **Node.js**
+   ```bash
+   brew install node
+   ```
+3. **pnpm** package manager –
+   ```bash
+   brew install pnpm
+   ```
+
+> On macOS you may also need Xcode Command-Line Tools (`xcode-select --install`) because `cargo` builds a native library.
+
+---
+## Getting started
+
+```bash
+# 1 /  Install TS dependencies (installs @napi-rs/cli locally)
+cd bindings/ts
+pnpm install
+
+# 2 /  Build the native addon in release mode
+pnpm run build
+
+# 3 /  Set your API key in `examples/api_key.ts`, then run the examples
+pnpm run chat
+pnpm run summarize
+pnpm run classify
+```

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@trymirai/uzu",
+  "version": "0.1.2",
+  "private": false,
+  "main": "uzu.node",
+  "types": "uzu.d.ts",
+  "packageManager": "pnpm@10.14.0",
+  "scripts": {
+    "build": "./build.sh",
+    "chat": "ts-node examples/chat_example.ts",
+    "summarize": "ts-node examples/summarization_example.ts",
+    "classify": "ts-node examples/classification_example.ts"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "3.1.2",
+    "@types/node": "24.2.0",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.2",
+    "@types/progress": "2.0.7"
+  },
+  "dependencies": {
+    "progress": "2.0.3"
+  },
+  "napi": {
+    "binaryName": "uzu"
+  },
+  "os": [
+    "darwin"
+  ],
+  "cpu": [
+    "arm64"
+  ],
+  "files": [
+    "uzu.node",
+    "uzu.d.ts",
+    "package.json",
+    "README.md"
+  ]
+}

package/uzu.d.ts

@@ -0,0 +1,205 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class DownloadHandle {
+  start(): void
+  pause(): void
+  resume(): void
+  stop(): void
+  delete(): void
+  state(): ModelDownloadState
+  identifier(): string
+  progress(): AsyncIterable<ProgressUpdate>
+}
+
+/** Thin FFI wrapper around `ModelStorage`. */
+export declare class Engine {
+  /** Returns a `DownloadHandle` for the given model identifier. */
+  downloadHandle(identifier: string): DownloadHandle
+  getModels(): Array<Model>
+  getState(identifier: string): ModelDownloadState
+  download(identifier: string): void
+  pause(identifier: string): void
+  resume(identifier: string): void
+  stop(identifier: string): void
+  delete(identifier: string): void
+  updateRegistry(): Promise<Array<Model>>
+  activate(apiKey: string): Promise<LicenseStatus>
+  constructor()
+  createSession(modelId: string): Session
+}
+
+export declare class ProgressStream {
+
+}
+
+export declare class ProgressUpdate {
+  /** Bytes downloaded so far. */
+  completedBytes: number
+  /** Total bytes expected for the download; `None` while unknown. */
+  totalBytes?: number
+  /** Normalised progress between 0.0 and 1.0. */
+  progress: number
+}
+
+export declare class Session {
+  constructor(modelDir: string)
+  /** Loads the model configuration. Must be called before `run`. */
+  load(config: SessionConfig): void
+  run(input: SessionInput, runConfig: SessionRunConfig, progressCallback?: (arg: SessionOutput) => boolean | undefined | null): SessionOutput
+}
+
+export type ContextLength =
+  | { type: 'Default' }
+  | { type: 'Custom', length: number }
+
+export interface DecoderTestResult {
+  placementLog: string
+  iterations: number
+  timePerToken: number
+  tokensPerSecond: number
+  success: boolean
+  error?: string
+}
+
+export type DownloaderError =
+  | { type: 'Http', message: string }
+  | { type: 'Io', message: string }
+  | { type: 'AlreadyExists', path: string }
+  | { type: 'Generic', message: string }
+
+export type LicenseStatus =
+  | { type: 'NotActivated' }
+  | { type: 'PaymentRequired' }
+  | { type: 'GracePeriodActive' }
+  | { type: 'Activated' }
+  | { type: 'NetworkError' }
+  | { type: 'InvalidApiKey' }
+  | { type: 'SignatureMismatch' }
+  | { type: 'Timeout' }
+  | { type: 'HttpError', code: number }
+
+export interface Model {
+  /** Unique identifier of the model in the form `<vendor>-<name>-<precision>`. */
+  readonly identifier: string
+  /** Vendor/author of the model (e.g. "Llama"). */
+  readonly vendor: string
+  /** Human-readable model name without vendor/precision (e.g. "3B-Instruct"). */
+  readonly name: string
+  /** Numerical precision of the weights (e.g. "float16"). */
+  readonly precision: string
+  /** Quantization type if the model is quantized (e.g. "uint4"). */
+  readonly quantization?: string
+  /** Current download/installation state. */
+  readonly state: ModelDownloadState
+}
+
+export interface ModelDownloadState {
+  /** Total size of all model files in kilobytes. */
+  readonly totalKbytes: number
+  /** Bytes already downloaded (meaningful in Downloading / Paused). */
+  readonly downloadedKbytes: number
+  /** Current phase of the download. */
+  readonly phase: Phase
+  /** Stringified error when `phase == Phase::Error`. */
+  readonly error?: string
+}
+
+export declare const enum Phase {
+  NotDownloaded = 0,
+  Downloading = 1,
+  Paused = 2,
+  Downloaded = 3,
+  Error = 4
+}
+
+export type SamplingConfig =
+  | { type: 'Argmax' }
+  | { type: 'TopP', topP: number }
+  | { type: 'Categorical', temperature: number }
+
+export type SamplingSeed =
+  | { type: 'Default' }
+  | { type: 'Custom', seed: number }
+
+export interface SessionClassificationFeature {
+  name: string
+  values: Array<string>
+}
+
+export interface SessionConfig {
+  preset: SessionPreset
+  samplingSeed: SamplingSeed
+  contextLength: ContextLength
+}
+
+export type SessionInput =
+  | { type: 'Text', text: string }
+  | { type: 'Messages', messages: Array<SessionMessage> }
+
+export interface SessionMessage {
+  role: SessionMessageRole
+  content: string
+}
+
+export declare const enum SessionMessageRole {
+  System = 0,
+  User = 1,
+  Assistant = 2
+}
+
+export interface SessionOutput {
+  text: string
+  stats: SessionOutputStats
+  finishReason?: SessionOutputFinishReason
+}
+
+export declare const enum SessionOutputFinishReason {
+  Stop = 0,
+  Length = 1,
+  Cancelled = 2
+}
+
+export interface SessionOutputRunStats {
+  count: bigint
+  averageDuration: number
+}
+
+export interface SessionOutputStats {
+  prefillStats: SessionOutputStepStats
+  generateStats?: SessionOutputStepStats
+  totalStats: SessionOutputTotalStats
+}
+
+export interface SessionOutputStepStats {
+  duration: number
+  suffixLength: bigint
+  tokensCount: bigint
+  tokensPerSecond: number
+  modelRun: SessionOutputRunStats
+  run?: SessionOutputRunStats
+}
+
+export interface SessionOutputTotalStats {
+  duration: number
+  tokensCountInput: bigint
+  tokensCountOutput: bigint
+}
+
+export type SessionPreset =
+  | { type: 'General' }
+  | { type: 'Classification', field0: SessionClassificationFeature }
+  | { type: 'Summarization' }
+
+export interface SessionRunConfig {
+  tokensLimit: number
+  samplingConfig?: SamplingConfig
+}
+
+export type StorageError =
+  | { type: 'ModelNotDownloaded' }
+  | { type: 'UnknownModel', identifier: string }
+  | { type: 'Storage', message: string }
+  | { type: 'MutexPoisoned', message: string }
+  | { type: 'LicenseNotActivated' }
+
+export declare function version(): string