-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
notionapi.ts
471 lines (415 loc) Β· 14.2 KB
/
notionapi.ts
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
import {
APIResponseError,
Client,
isFullBlock,
isFullPage,
iteratePaginatedAPI,
APIErrorCode,
isNotionClientError,
isFullDatabase,
} from "@notionhq/client";
import { NotionToMarkdown } from "notion-to-md";
import { getBlockChildren } from "notion-to-md/build/utils/notion.js";
import type {
ListBlockChildrenResponseResults,
MdBlock,
} from "notion-to-md/build/types";
import yaml from "js-yaml";
import { Document } from "@langchain/core/documents";
import { AsyncCaller } from "@langchain/core/utils/async_caller";
import { BaseDocumentLoader } from "@langchain/core/document_loaders/base";
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type GuardType<T> = T extends (x: any, ...rest: any) => x is infer U
? U
: never;
export type GetBlockResponse = Parameters<typeof isFullBlock>[0];
export type GetPageResponse = Parameters<typeof isFullPage>[0];
export type GetDatabaseResponse = Parameters<typeof isFullDatabase>[0];
export type BlockObjectResponse = GuardType<typeof isFullBlock>;
export type PageObjectResponse = GuardType<typeof isFullPage>;
export type DatabaseObjectResponse = GuardType<typeof isFullDatabase>;
export type GetResponse =
| GetBlockResponse
| GetPageResponse
| GetDatabaseResponse
| APIResponseError;
export type PagePropertiesType = PageObjectResponse["properties"];
export type PagePropertiesValue = PagePropertiesType[keyof PagePropertiesType];
export const isPageResponse = (res: GetResponse): res is GetPageResponse =>
!isNotionClientError(res) && res.object === "page";
export const isDatabaseResponse = (
res: GetResponse
): res is GetDatabaseResponse =>
!isNotionClientError(res) && res.object === "database";
export const isErrorResponse = (res: GetResponse): res is APIResponseError =>
isNotionClientError(res);
export const isPage = (res: GetResponse): res is PageObjectResponse =>
isPageResponse(res) && isFullPage(res);
export const isDatabase = (res: GetResponse): res is DatabaseObjectResponse =>
isDatabaseResponse(res) && isFullDatabase(res);
/**
* Represents the type of Notion API to load documents from. The options
* are "database" or "page".
*/
// @deprecated `type` property is now automatically determined.
export type NotionAPIType = "database" | "page";
export type OnDocumentLoadedCallback = (
current: number,
total: number,
currentTitle?: string,
rootTitle?: string
) => void;
export type NotionAPILoaderOptions = {
clientOptions: ConstructorParameters<typeof Client>[0];
id: string;
type?: NotionAPIType; // @deprecated `type` property is now automatically determined.
callerOptions?: ConstructorParameters<typeof AsyncCaller>[0];
onDocumentLoaded?: OnDocumentLoadedCallback;
propertiesAsHeader?: boolean;
};
/**
* A class that extends the BaseDocumentLoader class. It represents a
* document loader for loading documents from Notion using the Notion API.
* @example
* ```typescript
* const pageLoader = new NotionAPILoader({
* clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
* id: "<PAGE_ID>",
* type: "page",
* });
* const pageDocs = await pageLoader.loadAndSplit();
* const dbLoader = new NotionAPILoader({
* clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
* id: "<DATABASE_ID>",
* type: "database",
* propertiesAsHeader: true,
* });
* const dbDocs = await dbLoader.load();
* ```
*/
export class NotionAPILoader extends BaseDocumentLoader {
private caller: AsyncCaller;
private notionClient: Client;
private n2mClient: NotionToMarkdown;
private id: string;
private pageQueue: string[];
private pageCompleted: string[];
public pageQueueTotal: number;
private documents: Document[];
private rootTitle: string;
private onDocumentLoaded: OnDocumentLoadedCallback;
private propertiesAsHeader: boolean;
constructor(options: NotionAPILoaderOptions) {
super();
this.caller = new AsyncCaller({
maxConcurrency: 64,
...options.callerOptions,
});
this.notionClient = new Client({
logger: () => {}, // Suppress Notion SDK logger
...options.clientOptions,
});
this.n2mClient = new NotionToMarkdown({
notionClient: this.notionClient,
config: { parseChildPages: false, convertImagesToBase64: false },
});
this.id = options.id;
this.pageQueue = [];
this.pageCompleted = [];
this.pageQueueTotal = 0;
this.documents = [];
this.rootTitle = "";
this.onDocumentLoaded = options.onDocumentLoaded ?? ((_ti, _cu) => {});
this.propertiesAsHeader = options.propertiesAsHeader || false;
}
/**
* Adds a selection of page ids to the pageQueue and removes duplicates.
* @param items An array of string ids
*/
private addToQueue(...items: string[]) {
const deDuped = items.filter(
(item) => !this.pageCompleted.concat(this.pageQueue).includes(item)
);
this.pageQueue.push(...deDuped);
this.pageQueueTotal += deDuped.length;
}
/**
* Parses a Notion GetResponse object (page or database) and returns a string of the title.
* @param obj The Notion GetResponse object to parse.
* @returns The string of the title.
*/
private getTitle(obj: GetResponse) {
if (isPage(obj)) {
const titleProp = Object.values(obj.properties).find(
(prop) => prop.type === "title"
);
if (titleProp) return this.getPropValue(titleProp);
}
if (isDatabase(obj))
return obj.title
.map((v) =>
this.n2mClient.annotatePlainText(v.plain_text, v.annotations)
)
.join("");
return null;
}
/**
* Parses the property type and returns a string
* @param page The Notion page property to parse.
* @returns A string of parsed property.
*/
private getPropValue(prop: PagePropertiesValue) {
switch (prop.type) {
case "number": {
const propNumber = prop[prop.type];
return propNumber !== null ? propNumber.toString() : "";
}
case "url":
return prop[prop.type] || "";
case "select":
return prop[prop.type]?.name ?? "";
case "multi_select":
return `[${prop[prop.type].map((v) => `"${v.name}"`).join(", ")}]`;
case "status":
return prop[prop.type]?.name ?? "";
case "date":
return `${prop[prop.type]?.start ?? ""}${
prop[prop.type]?.end ? ` - ${prop[prop.type]?.end}` : ""
}`;
case "email":
return prop[prop.type] || "";
case "phone_number":
return prop[prop.type] || "";
case "checkbox":
return prop[prop.type].toString();
case "files":
return `[${prop[prop.type].map((v) => `"${v.name}"`).join(", ")}]`;
case "created_by":
return `["${prop[prop.type].object}", "${prop[prop.type].id}"]`;
case "created_time":
return prop[prop.type];
case "last_edited_by":
return `["${prop[prop.type].object}", "${prop[prop.type].id}"]`;
case "last_edited_time":
return prop[prop.type];
case "title":
return prop[prop.type]
.map((v) =>
this.n2mClient.annotatePlainText(v.plain_text, v.annotations)
)
.join("");
case "rich_text":
return prop[prop.type]
.map((v) =>
this.n2mClient.annotatePlainText(v.plain_text, v.annotations)
)
.join("");
case "people":
return `[${prop[prop.type]
.map((v) => `["${v.object}", "${v.id}"]`)
.join(", ")}]`;
case "unique_id":
return `${prop[prop.type].prefix || ""}${prop[prop.type].number}`;
case "relation":
return `[${prop[prop.type].map((v) => `"${v.id}"`).join(", ")}]`;
default:
return `Unsupported type: ${prop.type}`;
}
}
/**
* Parses the properties of a Notion page and returns them as key-value
* pairs.
* @param page The Notion page to parse.
* @returns An object containing the parsed properties as key-value pairs.
*/
private parsePageProperties(page: PageObjectResponse) {
return Object.entries(page.properties).reduce((accum, [propName, prop]) => {
const value = this.getPropValue(prop);
const props = { ...accum, [propName]: value };
return prop.type === "title" ? { ...props, _title: value } : props;
}, {} as { [key: string]: string });
}
/**
* Parses the details of a Notion page and returns them as an object.
* @param page The Notion page to parse.
* @returns An object containing the parsed details of the page.
*/
private parsePageDetails(page: PageObjectResponse) {
const { id, ...rest } = page;
return {
...rest,
notionId: id,
properties: this.parsePageProperties(page),
};
}
/**
* Loads a Notion block and returns it as an MdBlock object.
* @param block The Notion block to load.
* @returns A Promise that resolves to an MdBlock object.
*/
private async loadBlock(block: BlockObjectResponse): Promise<MdBlock> {
const mdBlock: MdBlock = {
type: block.type,
blockId: block.id,
parent: await this.caller.call(() =>
this.n2mClient.blockToMarkdown(block)
),
children: [],
};
if (block.has_children) {
const block_id =
block.type === "synced_block" &&
block.synced_block?.synced_from?.block_id
? block.synced_block.synced_from.block_id
: block.id;
const childBlocks = await this.loadBlocks(
await this.caller.call(() =>
getBlockChildren(this.notionClient, block_id, null)
)
);
mdBlock.children = childBlocks;
}
return mdBlock;
}
/**
* Loads Notion blocks and their children recursively.
* @param blocksResponse The response from the Notion API containing the blocks to load.
* @returns A Promise that resolves to an array containing the loaded MdBlocks.
*/
private async loadBlocks(
blocksResponse: ListBlockChildrenResponseResults
): Promise<MdBlock[]> {
const blocks = blocksResponse.filter(isFullBlock);
// Add child pages to queue
const childPages = blocks
.filter((block) => block.type.includes("child_page"))
.map((block) => block.id);
if (childPages.length > 0) this.addToQueue(...childPages);
// Add child database pages to queue
const childDatabases = blocks
.filter((block) => block.type.includes("child_database"))
.map((block) => this.caller.call(() => this.loadDatabase(block.id)));
// Load this block and child blocks
const loadingMdBlocks = blocks
.filter((block) => !["child_page", "child_database"].includes(block.type))
.map((block) => this.loadBlock(block));
const [mdBlocks] = await Promise.all([
Promise.all(loadingMdBlocks),
Promise.all(childDatabases),
]);
return mdBlocks;
}
/**
* Loads a Notion page and its child documents, then adds it to the completed documents array.
* @param page The Notion page or page ID to load.
*/
private async loadPage(page: string | PageObjectResponse) {
// Check page is a page ID or a PageObjectResponse
const [pageData, pageId] =
typeof page === "string"
? [
this.caller.call(() =>
this.notionClient.pages.retrieve({ page_id: page })
),
page,
]
: [page, page.id];
const [pageDetails, pageBlocks] = await Promise.all([
pageData,
this.caller.call(() => getBlockChildren(this.notionClient, pageId, null)),
]);
if (!isFullPage(pageDetails)) {
this.pageCompleted.push(pageId);
return;
}
const mdBlocks = await this.loadBlocks(pageBlocks);
const mdStringObject = this.n2mClient.toMarkdownString(mdBlocks);
let pageContent = mdStringObject.parent;
const metadata = this.parsePageDetails(pageDetails);
if (this.propertiesAsHeader) {
pageContent =
`---\n` +
`${yaml.dump(metadata.properties)}` +
`---\n\n` +
`${pageContent ?? ""}`;
}
if (!pageContent) {
this.pageCompleted.push(pageId);
return;
}
const pageDocument = new Document({ pageContent, metadata });
this.documents.push(pageDocument);
this.pageCompleted.push(pageId);
this.onDocumentLoaded(
this.documents.length,
this.pageQueueTotal,
this.getTitle(pageDetails) || undefined,
this.rootTitle
);
}
/**
* Loads a Notion database and adds it's pages to the queue.
* @param id The ID of the Notion database to load.
*/
private async loadDatabase(id: string) {
try {
for await (const page of iteratePaginatedAPI(
this.notionClient.databases.query,
{
database_id: id,
page_size: 50,
}
)) {
this.addToQueue(page.id);
}
} catch (e) {
console.log(e);
// TODO: Catch and report api request errors
}
}
/**
* Loads the documents from Notion based on the specified options.
* @returns A Promise that resolves to an array of Documents.
*/
async load(): Promise<Document[]> {
const resPagePromise = this.notionClient.pages
.retrieve({ page_id: this.id })
.then((res) => {
this.addToQueue(this.id);
return res;
})
.catch((error: APIResponseError) => error);
const resDatabasePromise = this.notionClient.databases
.retrieve({ database_id: this.id })
.then(async (res) => {
await this.loadDatabase(this.id);
return res;
})
.catch((error: APIResponseError) => error);
const [resPage, resDatabase] = await Promise.all([
resPagePromise,
resDatabasePromise,
]);
// Check if both resPage and resDatabase resulted in error responses
const errors = [resPage, resDatabase].filter(isErrorResponse);
if (errors.length === 2) {
if (errors.every((e) => e.code === APIErrorCode.ObjectNotFound)) {
throw new AggregateError([
Error(
`Could not find object with ID: ${this.id}. Make sure the relevant pages and databases are shared with your integration.`
),
...errors,
]);
}
throw new AggregateError(errors);
}
this.rootTitle =
this.getTitle(resPage) || this.getTitle(resDatabase) || this.id;
let pageId = this.pageQueue.shift();
while (pageId) {
await this.loadPage(pageId);
pageId = this.pageQueue.shift();
}
return this.documents;
}
}