-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugin.json
311 lines (311 loc) · 19 KB
/
plugin.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
{
"uuid": "7e35d737-64b3-4055-bfbf-9dabc1b52252",
"id": "create_notion_database",
"emoji": "🧩",
"title": "Notion Database Maker",
"overviewMarkdown": "# **Notion Database Maker**\nThis plugin allows users to create a Notion database with detailed properties and settings.\n\n### 📝 **User Setting Notes:**\n#### 🔧 **Set Up the Plugin Server:**\n- A plugin server must be set up to use this feature. Follow the detailed guide to set up a plugin server on Render: [How to Deploy the Plugin Server on Render](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render)\n\n#### 🔑 **Set Up Your Notion API Key:**\n- Go to the [Notion Integration Page](https://www.notion.so/profile/integrations) and create a new integration.\n- Copy the key from the Integration Detail Page.\n- Paste the key into the plugin's user settings:\n **Notion API Key:** `ntn_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`\n\nFor detailed instructions, visit the [Notion Integration API Documentation](https://developers.notion.com/docs/create-a-notion-integration)\n\n#### 🔗 **Share Your Database with the Integration:**\n- Open your database in Notion.\n- Click the **“Share”** button in the top right.\n- Select **“Invite”**, search for your integration name, and click **“Invite”** to grant access.\n\nFor detailed instructions, visit the [Notion API Connections Documentation](https://www.notion.com/help/add-and-manage-connections-with-the-api)\n\n### 📌 **Important Notes:**\n\n#### ⚠️ **Limitations:**\n- The plugin does **not support** the following property types: Relation, Rollup, Verification, and Unique ID.\n- The order of properties is not preserved based on user input, and you will need to manually drag-and-drop the properties to adjust their order.\n\n#### 👉 **Rate Limits:**\n- There are rate limits for Notion API requests. Learn more at [Notion API Rate Limits](https://developers.notion.com/reference/request-limits#rate-limits).\n- There are size limits on certain parameters, as well as the depth of children in requests. Learn more at [Notion API Size Limits](https://developers.notion.com/reference/request-limits#size-limits)\n\n\n### 💡 **Example Usage** \n> Create an Inline Database named “TypingMind Employee Directory” under my Notion Page URL https://www.notion.so/TypingMind-18a6a66d6ac98006ad95f8f7d8130dad\n>\n> Description: The TypingMind Employee Directory is a simple tool to quickly find and connect with colleagues. It lets you search and filter employees by role, \ndepartment, and more.\n> Icon: 📇\n> Cover Image: https://t4.ftcdn.net/jpg/09/77/83/07/240_F_977830794_XM1TKUBF0rO6bnOHZTGWASrr73Yt8Lng.jpg\n>\n> Database Structure:\n> 1. Name (Title)\n> 2. Attachments (Files)\n> 3. Department (Select) - Options: Engineering, Marketing, Sales, HR, Finance, Operations, Customer Support, Design\n> 4. Email (Email)\n> 5. LinkedIn Profile (URL)\n> 6. Location (Select) - Options: HQ - New York, Office - London, Office - Singapore, Remote - Domestic, Remote - International, Hybrid, Office - New York\n> 7. Notes (Rich Text)\n> 8. Performance Review Status (Status) - Options: Not started, In progress, Done\n> 9. Phone (Phone Number)\n> 10. Probation Passed (Checkbox)\n> 11. Role (Select) - Options: Engineer, Manager, Designer, Analyst, Developer, Director, Coordinator, Specialist\n> 12. Skills (Multi-select) - Options: Project Management, Programming, Data Analysis, Communication, Leadership, Design, Marketing, Sales, MLOps, FullStack\n> 13. Start Date (Date)\n> 14. Title by Years of Experience: Calculate the \"Title by Years of Experience\" based on the following conditions using a Notion formula:\n> - If \"Years of Experience\" is exactly 0, the title should be \"Fresher.\"\n> - If \"Years of Experience\" is less than 3 but not 0, the title should be \"Junior.\"\n> - If \"Years of Experience\" is 3 or more, the title should be \"Senior.\"\n> 15. Years of Experience (Number)",
"openaiSpec": {
"name": "create_notion_database",
"description": "Creates a database in Notion with detailed properties and settings.",
"parameters": {
"type": "object",
"properties": {
"parent": {
"type": "object",
"description": "Defines the parent where the database will be created.",
"properties": {
"type": {
"type": "string",
"enum": [
"page_id"
],
"description": "The type of the parent object. Supports 'page_id' for databases created under a specific page"
},
"pageId": {
"type": "string",
"description": "The Page ID or Page URL of the parent object in Notion. For example, in the URL https://www.notion.so/{PAGE_TITLE}-{PAGE_ID}, the page ID is the string after dash separator (-), which is {PAGE_ID}."
}
},
"required": [
"type"
]
},
"icon": {
"type": "string",
"description": "The icon of the database can currently only be an emoji, which must be specified."
},
"cover": {
"type": "string",
"format": "uri",
"description": "Defines the cover image for the database, which can only use an external URL."
},
"isInline": {
"type": "boolean",
"description": "Specifies whether the database is created inline. The default value is false."
},
"title": {
"type": "array",
"description": "Defines the title of the page. Following rich_text property schema definition.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "text",
"description": "Type of the content, should always be 'text'."
},
"text": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content of the text block."
}
},
"required": [
"content"
]
},
"annotations": {
"type": "object",
"properties": {
"italic": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is italicized. Default is false."
},
"bold": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is bolded. Default is false."
},
"color": {
"type": "string",
"default": "default",
"description": "The color of the text. Default is 'default'."
},
"strikethrough": {
"type": "boolean",
"default": false,
"description": "Indicates if the text has a strikethrough. Default is false."
},
"underline": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is underlined. Default is false."
}
},
"default": {
"italic": false,
"bold": false,
"color": "default",
"strikethrough": false,
"underline": false
}
}
},
"required": [
"type",
"text"
]
}
},
"description": {
"type": "array",
"description": "Defines the description of the page. Following rich_text property schema definition.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "text",
"description": "Type of the content, should always be 'text'."
},
"text": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content of the text block."
}
},
"required": [
"content"
]
},
"annotations": {
"type": "object",
"properties": {
"italic": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is italicized. Default is false."
},
"bold": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is bolded. Default is false."
},
"color": {
"type": "string",
"default": "default",
"description": "The color of the text. Default is 'default'."
},
"strikethrough": {
"type": "boolean",
"default": false,
"description": "Indicates if the text has a strikethrough. Default is false."
},
"underline": {
"type": "boolean",
"default": false,
"description": "Indicates if the text is underlined. Default is false."
}
},
"default": {
"italic": false,
"bold": false,
"color": "default",
"strikethrough": false,
"underline": false
}
}
},
"required": [
"type",
"text"
]
}
},
"notionProperties": {
"type": "array",
"description": "An array of property objects to define the page's properties following Notion's property schema. This field is required when operation is 'create' or 'update'. Otherwise, it should be an empty array.",
"items": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"description": "The name of the property."
},
"propertyType": {
"type": "string",
"description": "The type of the property (title, rich_text, number, select, status, multi_select, date, url, email, phone_number, checkbox, files, formula)."
},
"options": {
"type": "array",
"description": "The available options for select or multi_select properties.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The option name."
},
"color": {
"type": "string",
"enum": [
"default",
"gray",
"brown",
"orange",
"yellow",
"green",
"blue",
"purple",
"pink",
"red"
],
"description": "The color of the option. If not specified, randomly assign colors to the options from the supported Notion colors."
}
},
"required": [
"name"
]
}
},
"format": {
"type": "string",
"enum": [
"number",
"number_with_commas",
"percent",
"dollar",
"australian_dollar",
"canadian_dollar",
"singapore_dollar",
"euro",
"pound",
"yen",
"ruble",
"rupee",
"won",
"yuan",
"real",
"lira",
"rupiah",
"franc",
"hong_kong_dollar",
"new_zealand_dollar",
"krona",
"norwegian_krone",
"mexican_peso",
"rand",
"new_taiwan_dollar",
"danish_krone",
"zloty",
"baht",
"forint",
"koruna",
"shekel",
"chilean_peso",
"philippine_peso",
"dirham",
"colombian_peso",
"riyal",
"ringgit",
"leu",
"argentine_peso",
"uruguayan_peso",
"peruvian_sol"
],
"description": "The format for the number property (if applicable)."
},
"formula": {
"type": "string",
"description": "The formula for a Notion formula-based property."
},
"dateFormat": {
"type": "string",
"description": "The date format for date properties, typically 'YYYY-MM-DD'."
}
}
}
}
},
"required": [
"parent",
"notionProperties"
]
}
},
"userSettings": [
{
"name": "pluginServer",
"label": "Plugin Server",
"required": true,
"description": "The URL of the plugin server. For more details, refer to the documentation: https://docs.typingmind.com/plugins/plugins-server",
"placeholder": "https://...."
},
{
"name": "notionApiKey",
"label": "Notion API Key",
"description": "Enter your Notion Secret Key. You can create an integration from Notion at https://www.notion.so/profile/integrations",
"required": true
}
],
"iconURL": "https://registry.npmmirror.com/@lobehub/icons-static-png/latest/files/light/notion.png",
"authenticationType": "AUTH_TYPE_NONE",
"implementationType": "javascript",
"oauthConfig": null,
"outputType": "respond_to_ai"
}