@better-window-ai/types 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,170 @@
+# @better-window-ai/types
+
+TypeScript type definitions for the `window.ai` API.
+
+## Installation
+
+```bash
+npm install @better-window-ai/types
+```
+
+## Usage
+
+### In TypeScript Projects
+
+```typescript
+import type { WindowAI, AiModelInfo } from "@better-window-ai/types";
+
+// Check if AI is available
+const available = await window.ai.available();
+if (available) {
+  // Get current model
+  const model = await window.ai.getCurrentModel();
+  console.log(model?.name);
+}
+```
+
+### Global Types
+
+The package automatically extends the global `Window` interface, so you can use `window.ai` with full type support:
+
+```typescript
+// No import needed - types are global
+const available = await window.ai.available();
+const models = await window.ai.getModels();
+const current = await window.ai.getCurrentModel();
+```
+
+## API Reference
+
+### `window.ai.available()`
+
+Check if AI functionality is available.
+
+```typescript
+const isAvailable: boolean = await window.ai.available();
+```
+
+### `window.ai.getModels()`
+
+Get all available model configurations.
+
+```typescript
+const models: AiModelInfo[] = await window.ai.getModels();
+// [{ id: "...", name: "GPT-4", model: "gpt-4o" }]
+```
+
+### `window.ai.getCurrentModel()`
+
+Get the currently active model configuration.
+
+```typescript
+const model: AiModelInfo | null = await window.ai.getCurrentModel();
+// { id: "...", name: "GPT-4", model: "gpt-4o" } or null
+```
+
+### `window.ai.generateText(body)`
+
+Generate text using AI. Accepts OpenAI SDK compatible parameters (without `model` and `stream`) and returns OpenAI SDK compatible response.
+
+```typescript
+import type OpenAI from "openai";
+
+const response = await window.ai.generateText({
+  messages: [
+    { role: "system", content: "You are a helpful assistant" },
+    { role: "user", content: "Hello, AI!" },
+  ],
+  temperature: 0.7,
+  max_tokens: 1000,
+});
+
+console.log(response.choices[0].message.content);
+```
+
+**Note:** The `model` and `stream` parameters are omitted - the extension uses the configured model and non-streaming mode.
+
+See [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat/create) for full parameter documentation.
+
+## Type Definitions
+
+### `AiModelInfo`
+
+Model configuration information.
+
+```typescript
+interface AiModelInfo {
+  id: string;
+  name: string;
+  model: string;
+}
+```
+
+### `WindowAI`
+
+The main window.ai interface.
+
+```typescript
+interface WindowAI {
+  available(): Promise<boolean>;
+  getModels(): Promise<AiModelInfo[]>;
+  getCurrentModel(): Promise<AiModelInfo | null>;
+  generateText(
+    body: Omit<
+      OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming,
+      "stream" | "model"
+    >
+  ): Promise<OpenAI.Chat.Completions.ChatCompletion>;
+}
+```
+
+## Examples
+
+### Basic Text Generation
+
+```typescript
+const response = await window.ai.generateText({
+  messages: [{ role: "user", content: "Explain TypeScript" }],
+});
+console.log(response.choices[0].message.content);
+```
+
+### With System Prompt
+
+```typescript
+const response = await window.ai.generateText({
+  messages: [
+    { role: "system", content: "You are a poet" },
+    { role: "user", content: "Write a haiku about coding" },
+  ],
+  temperature: 0.8,
+});
+```
+
+### Checking Availability
+
+```typescript
+if (await window.ai.available()) {
+  const models = await window.ai.getModels();
+  console.log("Available models:", models);
+} else {
+  console.log("Please configure AI models in the extension first");
+}
+```
+
+### Get Current Model
+
+```typescript
+const current = await window.ai.getCurrentModel();
+if (current) {
+  console.log(`Using model: ${current.name} (${current.model})`);
+}
+```
+
+## Browser Extension Integration
+
+This package is designed for use with browser extensions that inject the `window.ai` API. Make sure the extension is installed and configured before using these APIs.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import type OpenAI from "openai";
+/**
+ * 模型信息
+ */
+export interface AiModelInfo {
+    id: string;
+    name: string;
+    model: string;
+}
+/**
+ * window.ai API 类型定义
+ */
+export interface WindowAI {
+    /**
+     * 检查 AI 功能是否可用
+     * @returns 如果有可用的激活配置则返回 true
+     */
+    available(): Promise<boolean>;
+    /**
+     * 获取所有可用的模型配置
+     * @returns 模型配置列表
+     */
+    getModels(): Promise<AiModelInfo[]>;
+    /**
+     * 获取当前激活的模型配置
+     * @returns 当前模型配置，如果没有则返回 null
+     */
+    getCurrentModel(): Promise<AiModelInfo | null>;
+    /**
+     * 调用 AI 生成文本
+     * @param prompt 用户输入的提示词
+     * @param options 可选配置
+     * @returns 生成的文本内容或 function call 结果
+     */
+    generateText(body: Omit<OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming, "stream" | "model">): Promise<OpenAI.Chat.Completions.ChatCompletion>;
+}
+declare global {
+    interface Window {
+        ai: WindowAI;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE9B;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEpC;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAE/C;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,IAAI,CACR,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAC9D,QAAQ,GAAG,OAAO,CACnB,GACA,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;CACpD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,EAAE,EAAE,QAAQ,CAAC;KACd;CACF"}

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@better-window-ai/types",
+  "version": "1.0.1",
+  "description": "TypeScript type definitions for window.ai API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "window.ai",
+    "ai",
+    "openai",
+    "typescript",
+    "types",
+    "browser-extension",
+    "function-calling"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kit-kack/better-window-ai.git",
+    "directory": "packages/window-ai-types"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}