@opentabs-dev/opentabs-plugin-netflix 0.0.76 → 0.0.78

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,159 +1,69 @@
1
- # opentabs-plugin-netflix
1
+ # Netflix
2
2
 
3
- OpenTabs plugin for Netflix
3
+ OpenTabs plugin for Netflix — gives AI agents access to Netflix through your authenticated browser session.
4
4
 
5
- ## Project Structure
5
+ ## Install
6
6
 
7
+ ```bash
8
+ opentabs plugin install netflix
7
9
  ```
8
- netflix/
9
- ├── package.json # Plugin metadata (name, opentabs field, dependencies)
10
- ├── icon.svg # Optional custom icon (square SVG, max 8KB)
11
- ├── icon-inactive.svg # Optional manual inactive icon override
12
- ├── src/
13
- │ ├── index.ts # Plugin class (extends OpenTabsPlugin)
14
- │ └── tools/ # One file per tool (using defineTool)
15
- │ └── example.ts
16
- └── dist/ # Build output (generated)
17
- ├── adapter.iife.js # Bundled adapter injected into matching tabs
18
- └── tools.json # Tool schemas for MCP registration
19
- ```
20
-
21
- ## Configuration
22
-
23
- Plugin metadata is defined in `package.json` under the `opentabs` field:
24
-
25
- ```json
26
- {
27
- "name": "opentabs-plugin-netflix",
28
- "main": "dist/adapter.iife.js",
29
- "opentabs": {
30
- "displayName": "Netflix",
31
- "description": "OpenTabs plugin for Netflix",
32
- "urlPatterns": ["*://*.netflix.com/*"]
33
- }
34
- }
35
- ```
36
-
37
- - **`main`** — entry point for the bundled adapter IIFE
38
- - **`opentabs.displayName`** — human-readable name shown in the side panel
39
- - **`opentabs.description`** — short description of what the plugin does
40
- - **`opentabs.urlPatterns`** — Chrome match patterns for tabs where the adapter is injected
41
-
42
- ## Custom Icons
43
-
44
- 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`):
45
-
46
- ```
47
- netflix/
48
- ├── package.json
49
- ├── icon.svg ← custom icon (optional)
50
- ├── icon-inactive.svg ← manual inactive override (optional, requires icon.svg)
51
- ├── src/
52
- │ └── ...
53
- ```
54
-
55
- **How it works:**
56
-
57
- - `opentabs-plugin build` reads `icon.svg`, validates it, auto-generates a grayscale inactive variant, and embeds both in `dist/tools.json`
58
- - To override the auto-generated inactive icon, provide `icon-inactive.svg` (must use only grayscale colors)
59
- - If no `icon.svg` is provided, the letter avatar is used automatically
60
10
 
61
- **Icon requirements:**
62
-
63
- - Square SVG with a `viewBox` attribute (e.g., `viewBox="0 0 32 32"`)
64
- - Maximum 8 KB file size
65
- - No embedded `<image>`, `<script>`, or event handler attributes (`onclick`, etc.)
66
- - Manual `icon-inactive.svg` must use only achromatic (grayscale) colors
67
-
68
- ## Development
11
+ Or install globally via npm:
69
12
 
70
13
  ```bash
71
- npm install
72
- npm run build # tsc && opentabs-plugin build
73
- npm run dev # watch mode (tsc --watch + opentabs-plugin build --watch)
74
- npm run type-check # tsc --noEmit
75
- npm run lint # biome
14
+ npm install -g @opentabs-dev/opentabs-plugin-netflix
76
15
  ```
77
16
 
78
- ## Adding Tools
79
-
80
- Create a new file in `src/tools/` using `defineTool`:
81
-
82
- ```ts
83
- import { z } from 'zod';
84
- import { defineTool } from '@opentabs-dev/plugin-sdk';
85
-
86
- export const myTool = defineTool({
87
- name: 'my_tool',
88
- displayName: 'My Tool',
89
- description: 'What this tool does',
90
- icon: 'wrench',
91
- input: z.object({ /* ... */ }),
92
- output: z.object({ /* ... */ }),
93
- handle: async (params) => {
94
- // Tool implementation runs in the browser tab context
95
- return { /* ... */ };
96
- },
97
- });
98
- ```
17
+ ## Setup
99
18
 
100
- Then register it in `src/index.ts` by adding it to the `tools` array.
19
+ 1. Open [netflix.com](https://www.netflix.com/browse) in Chrome and log in
20
+ 2. Open the OpenTabs side panel — the Netflix plugin should appear as **ready**
101
21
 
102
- ## Authentication
22
+ ## Tools (19)
103
23
 
104
- 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:
24
+ ### Account (3)
105
25
 
106
- ```ts
107
- import { getLocalStorage, getCookie, getPageGlobal } from '@opentabs-dev/plugin-sdk';
26
+ | Tool | Description | Type |
27
+ |---|---|---|
28
+ | `get_current_user` | Get current Netflix user info | Read |
29
+ | `list_profiles` | List all Netflix profiles | Read |
30
+ | `get_notifications` | Get Netflix notifications | Read |
108
31
 
109
- // localStorage — most common
110
- const token = getLocalStorage('token');
32
+ ### Browse (9)
111
33
 
112
- // Cookies session tokens, JWTs
113
- const session = getCookie('session_id');
34
+ | Tool | Description | Type |
35
+ |---|---|---|
36
+ | `search_titles` | Search Netflix movies and shows | Read |
37
+ | `get_title` | Get details for a movie or show | Read |
38
+ | `get_title_details` | Get full details including cast and crew | Read |
39
+ | `get_seasons` | Get seasons and episodes for a show | Read |
40
+ | `list_trending` | Get trending titles on Netflix | Read |
41
+ | `list_top_10` | Get Netflix Top 10 titles | Read |
42
+ | `list_genre_titles` | Browse titles in a genre category | Read |
43
+ | `navigate_to_title` | Open a title page in the browser | Write |
44
+ | `navigate_to_genre` | Open a genre page in the browser | Write |
114
45
 
115
- // Page globals — SPA boot data (e.g., window.__APP_STATE__)
116
- const appState = getPageGlobal('__APP_STATE__');
117
- ```
118
-
119
- **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.
46
+ ### Library (6)
120
47
 
121
- **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.
48
+ | Tool | Description | Type |
49
+ |---|---|---|
50
+ | `list_my_list` | Get titles in My List | Read |
51
+ | `add_to_my_list` | Save a title to My List | Write |
52
+ | `remove_from_my_list` | Remove a title from My List | Write |
53
+ | `list_continue_watching` | Get in-progress titles | Read |
54
+ | `get_watch_history` | Get recent viewing history | Read |
55
+ | `rate_title` | Rate a movie or show | Write |
122
56
 
123
- ## Shared Schemas
57
+ ### Playback (1)
124
58
 
125
- When 3 or more tools share the same input or output shape, extract common Zod schemas into a shared file to avoid duplication:
59
+ | Tool | Description | Type |
60
+ |---|---|---|
61
+ | `play_title` | Start playing a title | Write |
126
62
 
127
- ```ts
128
- // src/schemas/channel.ts
129
- import { z } from 'zod';
63
+ ## How It Works
130
64
 
131
- export const channelSchema = z.object({
132
- id: z.string().describe('Channel ID'),
133
- name: z.string().describe('Channel name'),
134
- });
65
+ This plugin runs inside your Netflix 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.
135
66
 
136
- export type Channel = z.infer<typeof channelSchema>;
137
- ```
138
-
139
- Then import and reuse in your tools:
140
-
141
- ```ts
142
- // src/tools/list-channels.ts
143
- import { channelSchema } from '../schemas/channel.js';
144
-
145
- export const listChannels = defineTool({
146
- name: 'list_channels',
147
- displayName: 'List Channels',
148
- description: 'List all available channels',
149
- icon: 'list',
150
- input: z.object({}),
151
- output: z.object({ channels: z.array(channelSchema) }),
152
- handle: async () => {
153
- // ...
154
- return { channels: [] };
155
- },
156
- });
157
- ```
67
+ ## License
158
68
 
159
- This keeps your tool schemas DRY and makes it easy to evolve shared types in one place.
69
+ MIT
@@ -289,6 +289,8 @@
289
289
  * (e.g., 'https://github.com'), not a match pattern.
290
290
  */
291
291
  homepage;
292
+ /** Typed configuration schema — declares settings that users provide via config.json or the side panel. */
293
+ configSchema;
292
294
  };
293
295
 
294
296
  // src/netflix-api.ts
@@ -15108,7 +15110,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
15108
15110
  };
15109
15111
  var src_default = new NetflixPlugin();
15110
15112
 
15111
- // dist/_adapter_entry_5e4fd15b-5a10-4e09-b9a2-a3c14da89915.ts
15113
+ // dist/_adapter_entry_031a77e5-f2a4-43e1-bdc9-e2f61e82b876.ts
15112
15114
  if (!globalThis.__openTabs) {
15113
15115
  globalThis.__openTabs = {};
15114
15116
  } else {
@@ -15324,5 +15326,5 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
15324
15326
  };
15325
15327
  delete src_default.onDeactivate;
15326
15328
  }
15327
- })();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["netflix"]){var a=o.adapters["netflix"];a.__adapterHash="cfcae97783804c1cbb8966b837a50a69b7734666a0761aa1c540a7c5fc544d56";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,"netflix",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
15329
+ })();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["netflix"]){var a=o.adapters["netflix"];a.__adapterHash="8b88b12d81be9e8a1e739dea699941c60d605f01fc812f3f1cf349300769985a";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,"netflix",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
15328
15330
  //# sourceMappingURL=adapter.iife.js.map