Add types for the dom apis

axonzeta · Nov 14, 2024 · 5eac0a1 · 5eac0a1
1 parent 7543c27
commit 5eac0a1
Show file tree

Hide file tree

Showing 10 changed files with 489 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -71,6 +71,20 @@ if (window.aibrow) {
 }
 ```
 
+#### Typescript types
+
+Types for `window.aibrow` can be added to your project by using the `npm install --save-dev @aibrow/dom-types` package. Then to expose them, place the following either in your `global.d.ts` or the entry point to your code
+
+```ts
+import type AI from "@aibrow/dom-types"
+
+declare global {
+  interface Window {
+    readonly aibrow: typeof AI;
+  }
+}
+```
+
 ### Extension
 
 Install the library using `npm install @aibrow/extension`

diff --git a/config.json b/config.json
@@ -21,6 +21,9 @@
   "extensionLibrary": {
     "name": "@aibrow/extension"
   },
+  "typesLibrary": {
+    "name": "@aibrow/dom-types"
+  },
 
   "defaultModels": {
     "text": "smollm2-1-7b-instruct-q4-k-m",

diff --git a/examples/package-lock.json b/examples/package-lock.json