@opentabs-dev/opentabs-plugin-pinterest 0.0.76 → 0.0.77

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,79 @@
1
- # opentabs-plugin-pinterest
1
+ # Pinterest
2
2
 
3
- OpenTabs plugin for Pinterest
3
+ OpenTabs plugin for Pinterest — gives AI agents access to Pinterest through your authenticated browser session.
4
4
 
5
- ## Project Structure
5
+ ## Install
6
6
 
7
+ ```bash
8
+ opentabs plugin install pinterest
7
9
  ```
8
- pinterest/
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-pinterest",
28
- "main": "dist/adapter.iife.js",
29
- "opentabs": {
30
- "displayName": "Pinterest",
31
- "description": "OpenTabs plugin for Pinterest",
32
- "urlPatterns": ["*://*.pinterest.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
- pinterest/
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
-
61
- **Icon requirements:**
62
10
 
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-pinterest
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 [pinterest.com](https://www.pinterest.com) in Chrome and log in
20
+ 2. Open the OpenTabs side panel — the Pinterest plugin should appear as **ready**
101
21
 
102
- ## Authentication
22
+ ## Tools (24)
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 (2)
105
25
 
106
- ```ts
107
- import { getLocalStorage, getCookie, getPageGlobal } from '@opentabs-dev/plugin-sdk';
26
+ | Tool | Description | Type |
27
+ |---|---|---|
28
+ | `get_current_user` | Get the authenticated user profile | Read |
29
+ | `get_notification_counts` | Get notification badge counts | Read |
108
30
 
109
- // localStorage — most common
110
- const token = getLocalStorage('token');
31
+ ### Users (1)
111
32
 
112
- // Cookies session tokens, JWTs
113
- const session = getCookie('session_id');
33
+ | Tool | Description | Type |
34
+ |---|---|---|
35
+ | `get_user_profile` | Get a user profile by username | Read |
114
36
 
115
- // Page globals — SPA boot data (e.g., window.__APP_STATE__)
116
- const appState = getPageGlobal('__APP_STATE__');
117
- ```
37
+ ### Boards (9)
118
38
 
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.
39
+ | Tool | Description | Type |
40
+ |---|---|---|
41
+ | `list_boards` | List boards for a user | Read |
42
+ | `get_board_pins` | Get pins from a board | Read |
43
+ | `get_board_sections` | Get sections for a board | Read |
44
+ | `create_board` | Create a new board | Write |
45
+ | `update_board` | Update a board | Write |
46
+ | `delete_board` | Delete a board | Write |
47
+ | `create_board_section` | Create a section in a board | Write |
48
+ | `delete_board_section` | Delete a board section | Write |
49
+ | `search_boards` | Search for boards by keyword | Read |
120
50
 
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.
51
+ ### Pins (8)
122
52
 
123
- ## Shared Schemas
53
+ | Tool | Description | Type |
54
+ |---|---|---|
55
+ | `get_pin` | Get pin details by ID | Read |
56
+ | `create_pin` | Create a new pin on a board | Write |
57
+ | `save_pin` | Save an existing pin to a board | Write |
58
+ | `delete_pin` | Delete a pin | Write |
59
+ | `get_home_feed` | Get the personalized home feed | Read |
60
+ | `get_related_pins` | Get pins related to a specific pin | Read |
61
+ | `search_pins` | Search for pins by keyword | Read |
62
+ | `get_user_pins` | Get pins created by a user | Read |
124
63
 
125
- When 3 or more tools share the same input or output shape, extract common Zod schemas into a shared file to avoid duplication:
64
+ ### Social (4)
126
65
 
127
- ```ts
128
- // src/schemas/channel.ts
129
- import { z } from 'zod';
66
+ | Tool | Description | Type |
67
+ |---|---|---|
68
+ | `follow_user` | Follow a Pinterest user | Write |
69
+ | `unfollow_user` | Unfollow a Pinterest user | Write |
70
+ | `list_followers` | List followers of a user | Read |
71
+ | `list_following` | List users a user is following | Read |
130
72
 
131
- export const channelSchema = z.object({
132
- id: z.string().describe('Channel ID'),
133
- name: z.string().describe('Channel name'),
134
- });
73
+ ## How It Works
135
74
 
136
- export type Channel = z.infer<typeof channelSchema>;
137
- ```
75
+ This plugin runs inside your Pinterest 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.
138
76
 
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
- ```
77
+ ## License
158
78
 
159
- This keeps your tool schemas DRY and makes it easy to evolve shared types in one place.
79
+ MIT
@@ -343,6 +343,8 @@
343
343
  * (e.g., 'https://github.com'), not a match pattern.
344
344
  */
345
345
  homepage;
346
+ /** Typed configuration schema — declares settings that users provide via config.json or the side panel. */
347
+ configSchema;
346
348
  };
347
349
 
348
350
  // src/pinterest-api.ts
@@ -15070,7 +15072,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
15070
15072
  };
15071
15073
  var src_default = new PinterestPlugin();
15072
15074
 
15073
- // dist/_adapter_entry_92ec7be6-8d7c-4850-8e67-90e0347f920d.ts
15075
+ // dist/_adapter_entry_5d1679a7-ac1c-4fc8-af93-14820a376a82.ts
15074
15076
  if (!globalThis.__openTabs) {
15075
15077
  globalThis.__openTabs = {};
15076
15078
  } else {
@@ -15286,5 +15288,5 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
15286
15288
  };
15287
15289
  delete src_default.onDeactivate;
15288
15290
  }
15289
- })();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["pinterest"]){var a=o.adapters["pinterest"];a.__adapterHash="4c3bc209fda02063d118a7097fce34a762ea05a9946c02b1804e6a4dfd6eb754";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,"pinterest",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
15291
+ })();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["pinterest"]){var a=o.adapters["pinterest"];a.__adapterHash="a9a0bdbba43135d4b8c3b93533c1f32b4165d8ba9f1144f3721703c5be495c62";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,"pinterest",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
15290
15292
  //# sourceMappingURL=adapter.iife.js.map