@opentabs-dev/opentabs-plugin-microsoft-word 0.0.75 → 0.0.77

package/README.md

@@ -1,159 +1,87 @@
-# opentabs-plugin-microsoft-word
+# Microsoft Word
 
-OpenTabs plugin for Microsoft Word Online
+OpenTabs plugin for Microsoft Word Online — gives AI agents access to Microsoft Word through your authenticated browser session.
 
-## Project Structure
+## Install
 
+```bash
+opentabs plugin install microsoft-word
 ```
-microsoft-word/
-├── package.json          # Plugin metadata (name, opentabs field, dependencies)
-├── icon.svg              # Optional custom icon (square SVG, max 8KB)
-├── icon-inactive.svg     # Optional manual inactive icon override
-├── src/
-│   ├── index.ts          # Plugin class (extends OpenTabsPlugin)
-│   └── tools/            # One file per tool (using defineTool)
-│       └── example.ts
-└── dist/                 # Build output (generated)
-    ├── adapter.iife.js   # Bundled adapter injected into matching tabs
-    └── tools.json        # Tool schemas for MCP registration
-```
-
-## Configuration
-
-Plugin metadata is defined in `package.json` under the `opentabs` field:
-
-```json
-{
-  "name": "opentabs-plugin-microsoft-word",
-  "main": "dist/adapter.iife.js",
-  "opentabs": {
-    "displayName": "Microsoft Word",
-    "description": "OpenTabs plugin for Microsoft Word Online",
-    "urlPatterns": ["*://*.word.cloud.microsoft/*"]
-  }
-}
-```
-
-- **`main`** — entry point for the bundled adapter IIFE
-- **`opentabs.displayName`** — human-readable name shown in the side panel
-- **`opentabs.description`** — short description of what the plugin does
-- **`opentabs.urlPatterns`** — Chrome match patterns for tabs where the adapter is injected
-
-## Custom Icons
 
-By default, the side panel shows a colored letter avatar for your plugin. To use a custom icon, place an `icon.svg` file in the plugin root (next to `package.json`):
+Or install globally via npm:
 
-```
-microsoft-word/
-├── package.json
-├── icon.svg              ← custom icon (optional)
-├── icon-inactive.svg     ← manual inactive override (optional, requires icon.svg)
-├── src/
-│   └── ...
+```bash
+npm install -g @opentabs-dev/opentabs-plugin-microsoft-word
 ```
 
-**How it works:**
+## Setup
 
-- `opentabs-plugin build` reads `icon.svg`, validates it, auto-generates a grayscale inactive variant, and embeds both in `dist/tools.json`
-- To override the auto-generated inactive icon, provide `icon-inactive.svg` (must use only grayscale colors)
-- If no `icon.svg` is provided, the letter avatar is used automatically
+1. Open [word.cloud.microsoft](https://word.cloud.microsoft) in Chrome and log in
+2. Open the OpenTabs side panel — the Microsoft Word plugin should appear as **ready**
 
-**Icon requirements:**
+## Tools (27)
 
-- Square SVG with a `viewBox` attribute (e.g., `viewBox="0 0 32 32"`)
-- Maximum 8 KB file size
-- No embedded `<image>`, `<script>`, or event handler attributes (`onclick`, etc.)
-- Manual `icon-inactive.svg` must use only achromatic (grayscale) colors
+### Account (1)
 
-## Development
+| Tool | Description | Type |
+|---|---|---|
+| `get_current_user` | Get the current user profile | Read |
 
-```bash
-npm install
-npm run build       # tsc && opentabs-plugin build
-npm run dev         # watch mode (tsc --watch + opentabs-plugin build --watch)
-npm run type-check  # tsc --noEmit
-npm run lint        # biome
-```
-
-## Adding Tools
-
-Create a new file in `src/tools/` using `defineTool`:
-
-```ts
-import { z } from 'zod';
-import { defineTool } from '@opentabs-dev/plugin-sdk';
-
-export const myTool = defineTool({
-  name: 'my_tool',
-  displayName: 'My Tool',
-  description: 'What this tool does',
-  icon: 'wrench',
-  input: z.object({ /* ... */ }),
-  output: z.object({ /* ... */ }),
-  handle: async (params) => {
-    // Tool implementation runs in the browser tab context
-    return { /* ... */ };
-  },
-});
-```
-
-Then register it in `src/index.ts` by adding it to the `tools` array.
+### Drive (1)
 
-## Authentication
+| Tool | Description | Type |
+|---|---|---|
+| `get_drive` | Get OneDrive details | Read |
 
-Plugin tools run in the browser tab context, so they can read auth tokens directly from the page. The SDK provides utilities for the most common patterns:
+### Documents (6)
 
-```ts
-import { getLocalStorage, getCookie, getPageGlobal } from '@opentabs-dev/plugin-sdk';
+| Tool | Description | Type |
+|---|---|---|
+| `get_active_document` | Get the currently open document | Read |
+| `get_document_text` | Extract text from a Word document | Read |
+| `create_document` | Create a new Word document with text | Write |
+| `update_document` | Replace all text in a Word document | Write |
+| `append_to_document` | Append paragraphs to a Word document | Write |
+| `replace_text_in_document` | Find and replace text in a Word document | Write |
 
-// localStorage — most common
-const token = getLocalStorage('token');
+### Files (14)
 
-// Cookies — session tokens, JWTs
-const session = getCookie('session_id');
+| Tool | Description | Type |
+|---|---|---|
+| `get_file_content` | Read text content of a file | Read |
+| `list_recent_documents` | List recent documents | Read |
+| `list_children` | List files and folders | Read |
+| `get_item` | Get file or folder details | Read |
+| `search_files` | Search files and folders | Read |
+| `create_folder` | Create a folder | Write |
+| `upload_file` | Upload a text file to OneDrive | Write |
+| `update_file_content` | Update a file's content | Write |
+| `rename_item` | Rename a file or folder | Write |
+| `move_item` | Move a file or folder | Write |
+| `copy_item` | Copy a file or folder | Write |
+| `delete_item` | Delete a file or folder | Write |
+| `list_shared_with_me` | List files shared with me | Read |
+| `get_preview_url` | Get a document preview URL | Read |
 
-// Page globals — SPA boot data (e.g., window.__APP_STATE__)
-const appState = getPageGlobal('__APP_STATE__');
-```
-
-**Iframe fallback:** Some apps (e.g., Discord) delete `window.localStorage` after boot. `getLocalStorage` automatically tries a hidden same-origin iframe fallback before returning `null`, so you don't need to handle this case manually.
+### Sharing (3)
 
-**SPA hydration:** Auth tokens may not be available immediately on page load. Implement polling in `isReady()` to wait until the app has hydrated before your tools run. See the comments in `src/index.ts` for an example polling pattern.
+| Tool | Description | Type |
+|---|---|---|
+| `create_sharing_link` | Create a sharing link for a file or folder | Write |
+| `list_permissions` | List sharing permissions | Read |
+| `delete_permission` | Remove a sharing permission | Write |
 
-## Shared Schemas
+### Versions (2)
 
-When 3 or more tools share the same input or output shape, extract common Zod schemas into a shared file to avoid duplication:
+| Tool | Description | Type |
+|---|---|---|
+| `list_versions` | List file version history | Read |
+| `restore_version` | Restore a file version | Write |
 
-```ts
-// src/schemas/channel.ts
-import { z } from 'zod';
+## How It Works
 
-export const channelSchema = z.object({
-  id: z.string().describe('Channel ID'),
-  name: z.string().describe('Channel name'),
-});
+This plugin runs inside your Microsoft Word tab through the [OpenTabs](https://opentabs.dev) Chrome extension. It uses your existing browser session — no API tokens or OAuth apps required. All operations happen as you, with your permissions.
 
-export type Channel = z.infer<typeof channelSchema>;
-```
-
-Then import and reuse in your tools:
-
-```ts
-// src/tools/list-channels.ts
-import { channelSchema } from '../schemas/channel.js';
-
-export const listChannels = defineTool({
-  name: 'list_channels',
-  displayName: 'List Channels',
-  description: 'List all available channels',
-  icon: 'list',
-  input: z.object({}),
-  output: z.object({ channels: z.array(channelSchema) }),
-  handle: async () => {
-    // ...
-    return { channels: [] };
-  },
-});
-```
+## License
 
-This keeps your tool schemas DRY and makes it easy to evolve shared types in one place.
+MIT

package/dist/adapter.iife.js

@@ -248,18 +248,18 @@
 
   // node_modules/@opentabs-dev/plugin-sdk/dist/storage.js
   var getLocalStorage = (key) => {
-    try {
-      return localStorage.getItem(key);
-    } catch {
-    }
     let storage;
     try {
-      storage = localStorage;
+      storage = window.localStorage;
     } catch {
       return null;
     }
-    if (storage !== void 0) {
-      return null;
+    if (storage) {
+      try {
+        return storage.getItem(key);
+      } catch {
+        return null;
+      }
     }
     try {
       const iframe = document.createElement("iframe");
@@ -287,18 +287,19 @@
       }
       return null;
     };
-    try {
-      return search(localStorage);
-    } catch {
-    }
     let storage;
     try {
-      storage = localStorage;
+      storage = window.localStorage;
     } catch {
       return null;
     }
-    if (storage !== void 0)
-      return null;
+    if (storage) {
+      try {
+        return search(storage);
+      } catch {
+        return null;
+      }
+    }
     try {
       const iframe = document.createElement("iframe");
       iframe.style.display = "none";
@@ -364,6 +365,8 @@
      * (e.g., 'https://github.com'), not a match pattern.
      */
     homepage;
+    /** Typed configuration schema — declares settings that users provide via config.json or the side panel. */
+    configSchema;
   };
 
   // src/microsoft-word-api.ts
@@ -15653,21 +15656,21 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
   };
   var src_default = new MicrosoftWordPlugin();
 
-  // dist/_adapter_entry_c537bceb-a306-43a7-a859-aab859a56c7b.ts
+  // dist/_adapter_entry_0965f804-0cca-408d-832b-ab16d60163f1.ts
   if (!globalThis.__openTabs) {
     globalThis.__openTabs = {};
   } else {
     const desc = Object.getOwnPropertyDescriptor(globalThis.__openTabs, "adapters");
     if (desc && !desc.writable) {
-      const ot2 = globalThis.__openTabs;
+      const ot3 = globalThis.__openTabs;
       const newAdaptersObj = {};
-      if (ot2.adapters) {
-        for (const key of Object.keys(ot2.adapters)) {
-          const d = Object.getOwnPropertyDescriptor(ot2.adapters, key);
+      if (ot3.adapters) {
+        for (const key of Object.keys(ot3.adapters)) {
+          const d = Object.getOwnPropertyDescriptor(ot3.adapters, key);
           if (d) Object.defineProperty(newAdaptersObj, key, d);
         }
       }
-      globalThis.__openTabs = Object.assign({}, ot2, { adapters: newAdaptersObj });
+      globalThis.__openTabs = Object.assign({}, ot3, { adapters: newAdaptersObj });
     }
   }
   if (!globalThis.__openTabs.adapters) {
@@ -15705,6 +15708,16 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     }
   };
   var restoreTransport = setLogTransport ? setLogTransport(logTransport) : void 0;
+  var ot2 = globalThis.__openTabs;
+  ot2._notifyReadinessChanged = () => {
+    try {
+      const nonce = globalThis.__openTabs?._readinessNonce;
+      if (nonce) {
+        window.postMessage({ type: "opentabs:readiness-changed", plugin: "microsoft-word", nonce }, "*");
+      }
+    } catch {
+    }
+  };
   var existing = adapters["microsoft-word"];
   if (existing) {
     if (typeof existing.teardown === "function") {
@@ -15716,7 +15729,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     }
   }
   if (!Reflect.deleteProperty(adapters, "microsoft-word")) {
-    const ot2 = globalThis.__openTabs;
+    const ot3 = globalThis.__openTabs;
     const newAdapters = {};
     for (const key of Object.keys(adapters)) {
       if (key !== "microsoft-word") {
@@ -15724,7 +15737,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         if (desc) Object.defineProperty(newAdapters, key, desc);
       }
     }
-    globalThis.__openTabs = Object.assign({}, ot2, { adapters: newAdapters });
+    globalThis.__openTabs = Object.assign({}, ot3, { adapters: newAdapters });
   }
   var hasLifecycleHooks = typeof src_default.onToolInvocationStart === "function" || typeof src_default.onToolInvocationEnd === "function";
   for (const tool of src_default.tools) {
@@ -15785,12 +15798,12 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         }
       }
     };
-    const ot2 = globalThis.__openTabs;
-    if (!ot2._navigationInterceptor) {
+    const ot3 = globalThis.__openTabs;
+    if (!ot3._navigationInterceptor) {
       const origPushState = history.pushState.bind(history);
       const origReplaceState = history.replaceState.bind(history);
       const callbacks = /* @__PURE__ */ new Map();
-      ot2._navigationInterceptor = { callbacks, origPushState, origReplaceState };
+      ot3._navigationInterceptor = { callbacks, origPushState, origReplaceState };
       history.pushState = function(...args) {
         origPushState(...args);
         for (const cb of callbacks.values()) {
@@ -15804,7 +15817,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         }
       };
     }
-    const interceptor = ot2._navigationInterceptor;
+    const interceptor = ot3._navigationInterceptor;
     interceptor.callbacks.set("microsoft-word", checkUrl);
     window.addEventListener("popstate", checkUrl);
     window.addEventListener("hashchange", checkUrl);
@@ -15859,5 +15872,5 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     };
     delete src_default.onDeactivate;
   }
-})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["microsoft-word"]){var a=o.adapters["microsoft-word"];a.__adapterHash="c9582a6cf42e8e0f427d82c37d9589c50c4b4e2b0df5b6776c70dfff3f8b1b57";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"microsoft-word",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
+})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["microsoft-word"]){var a=o.adapters["microsoft-word"];a.__adapterHash="6fc1f6fc3b766ecb52568d6141d0a378c3ff666d5bc0255b8cc8be3f7887569d";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"microsoft-word",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
 //# sourceMappingURL=adapter.iife.js.map