@visus-io/notion-sdk-ts 2.0.0 → 2.1.0

package/dist/api/blocks.api.js

@@ -4,12 +4,19 @@ exports.BlocksAPI = void 0;
 const schemas_1 = require("../schemas");
 const models_1 = require("../models");
 const validation_1 = require("../validation");
+const base_api_1 = require("./base.api");
 /**
  * Blocks API client for working with Notion blocks.
  */
-class BlocksAPI {
+class BlocksAPI extends base_api_1.BaseAPI {
     constructor(client) {
+        super(client);
         this.client = client;
+        this.config = {
+            schema: schemas_1.blockSchema,
+            ModelClass: models_1.Block,
+            listType: 'block',
+        };
         /**
          * Block children operations.
          */
@@ -24,27 +31,8 @@ class BlocksAPI {
              * @see https://developers.notion.com/reference/get-block-children
              */
             list: async (blockId, params) => {
-                const query = {};
-                if (params?.page_size) {
-                    query.page_size = String(params.page_size);
-                }
-                if (params?.start_cursor) {
-                    query.start_cursor = params.start_cursor;
-                }
-                const response = await this.client.request({
-                    method: 'GET',
-                    path: `/blocks/${blockId}/children`,
-                    query: Object.keys(query).length > 0 ? query : undefined,
-                });
-                const listSchema = (0, schemas_1.paginatedListSchema)(schemas_1.blockSchema);
-                const parsed = listSchema.parse(response);
-                return {
-                    object: 'list',
-                    results: parsed.results.map((block) => new models_1.Block(block)),
-                    next_cursor: parsed.next_cursor,
-                    has_more: parsed.has_more,
-                    type: 'block',
-                };
+                const query = this.buildPaginationQuery(params);
+                return this.listResources(`/blocks/${blockId}/children`, query);
             },
             /**
              * Append children blocks to a parent block.
@@ -82,17 +70,10 @@ class BlocksAPI {
      * @see https://developers.notion.com/reference/retrieve-a-block
      */
     async retrieve(blockId, options) {
-        const query = {};
-        if (options?.filter_properties) {
-            query.filter_properties = options.filter_properties.join(',');
-        }
-        const response = await this.client.request({
-            method: 'GET',
-            path: `/blocks/${blockId}`,
-            query: Object.keys(query).length > 0 ? query : undefined,
-        });
-        const parsed = schemas_1.blockSchema.parse(response);
-        return new models_1.Block(parsed);
+        const query = {
+            ...this.buildFilterPropertiesQuery(options?.filter_properties),
+        };
+        return this.retrieveResource(`/blocks/${blockId}`, query);
     }
     /**
      * Delete (archive) a block.
@@ -103,12 +84,7 @@ class BlocksAPI {
      * @see https://developers.notion.com/reference/delete-a-block
      */
     async delete(blockId) {
-        const response = await this.client.request({
-            method: 'DELETE',
-            path: `/blocks/${blockId}`,
-        });
-        const parsed = schemas_1.blockSchema.parse(response);
-        return new models_1.Block(parsed);
+        return this.deleteResource(`/blocks/${blockId}`);
     }
     /**
      * Update a block's properties.
@@ -120,14 +96,7 @@ class BlocksAPI {
      * @see https://developers.notion.com/reference/update-a-block
      */
     async update(blockId, options) {
-        const response = await this.client.request({
-            method: 'PATCH',
-            path: `/blocks/${blockId}`,
-            body: options,
-        });
-        const parsed = schemas_1.blockSchema.parse(response);
-        return new models_1.Block(parsed);
+        return this.updateResource(`/blocks/${blockId}`, options);
     }
 }
 exports.BlocksAPI = BlocksAPI;
-//# sourceMappingURL=blocks.api.js.map

package/dist/api/comments.api.d.ts

@@ -1,6 +1,7 @@
 import type { NotionClient } from '../client';
-import { type PaginatedList, type PaginationParameters } from '../schemas';
+import { type NotionComment, type PaginatedList, type PaginationParameters } from '../schemas';
 import { Comment } from '../models';
+import { BaseAPI } from './base.api';
 /**
  * Display name for a comment.
  */
@@ -45,8 +46,263 @@ export interface CreateCommentOptions {
 /**
  * Comments API client for working with Notion comments.
  */
-export declare class CommentsAPI {
-    private readonly client;
+export declare class CommentsAPI extends BaseAPI<NotionComment, Comment> {
+    protected readonly client: NotionClient;
+    protected config: {
+        schema: import("zod").ZodObject<{
+            object: import("zod").ZodLiteral<"comment">;
+            id: import("zod").ZodUUID;
+            parent: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"database_id">;
+                database_id: import("zod").ZodUUID;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"data_source_id">;
+                data_source_id: import("zod").ZodUUID;
+                database_id: import("zod").ZodUUID;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"page_id">;
+                page_id: import("zod").ZodUUID;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"workspace">;
+                workspace: import("zod").ZodLiteral<true>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"block_id">;
+                block_id: import("zod").ZodUUID;
+            }, import("zod/v4/core").$strip>], "type">;
+            discussion_id: import("zod").ZodUUID;
+            created_time: import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>;
+            created_by: import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                object: import("zod").ZodLiteral<"user">;
+                id: import("zod").ZodUUID;
+                type: import("zod").ZodLiteral<"person">;
+                name: import("zod").ZodOptional<import("zod").ZodString>;
+                avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
+                person: import("zod").ZodObject<{
+                    email: import("zod").ZodEmail;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                object: import("zod").ZodLiteral<"user">;
+                id: import("zod").ZodUUID;
+                type: import("zod").ZodLiteral<"bot">;
+                name: import("zod").ZodOptional<import("zod").ZodString>;
+                avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
+                bot: import("zod").ZodObject<{
+                    owner: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"workspace">;
+                        workspace: import("zod").ZodLiteral<true>;
+                    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"user">;
+                    }, import("zod/v4/core").$strip>], "type">;
+                    workspace_name: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    workspace_id: import("zod").ZodOptional<import("zod").ZodString>;
+                    workspace_limits: import("zod").ZodOptional<import("zod").ZodObject<{
+                        max_file_upload_size_in_bytes: import("zod").ZodInt;
+                    }, import("zod/v4/core").$strip>>;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                object: import("zod").ZodLiteral<"user">;
+                id: import("zod").ZodUUID;
+            }, import("zod/v4/core").$strip>]>;
+            last_edited_time: import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>;
+            rich_text: import("zod").ZodArray<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"text">;
+                text: import("zod").ZodObject<{
+                    content: import("zod").ZodString;
+                    link: import("zod").ZodNullable<import("zod").ZodObject<{
+                        url: import("zod").ZodURL;
+                    }, import("zod/v4/core").$strip>>;
+                }, import("zod/v4/core").$strip>;
+                annotations: import("zod").ZodObject<{
+                    bold: import("zod").ZodBoolean;
+                    italic: import("zod").ZodBoolean;
+                    strikethrough: import("zod").ZodBoolean;
+                    underline: import("zod").ZodBoolean;
+                    code: import("zod").ZodBoolean;
+                    color: import("zod").ZodEnum<{
+                        blue: "blue";
+                        blue_background: "blue_background";
+                        brown: "brown";
+                        brown_background: "brown_background";
+                        default: "default";
+                        gray: "gray";
+                        gray_background: "gray_background";
+                        green: "green";
+                        green_background: "green_background";
+                        orange: "orange";
+                        orange_background: "orange_background";
+                        pink: "pink";
+                        pink_background: "pink_background";
+                        purple: "purple";
+                        purple_background: "purple_background";
+                        red: "red";
+                        red_background: "red_background";
+                        yellow: "yellow";
+                        yellow_background: "yellow_background";
+                    }>;
+                }, import("zod/v4/core").$strip>;
+                plain_text: import("zod").ZodString;
+                href: import("zod").ZodNullable<import("zod").ZodURL>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"mention">;
+                mention: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"database">;
+                    database: import("zod").ZodObject<{
+                        id: import("zod").ZodUUID;
+                    }, import("zod/v4/core").$strip>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"date">;
+                    date: import("zod").ZodObject<{
+                        start: import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>;
+                        end: import("zod").ZodNullable<import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>>;
+                        time_zone: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    }, import("zod/v4/core").$strip>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"link_preview">;
+                    link_preview: import("zod").ZodObject<{
+                        url: import("zod").ZodURL;
+                    }, import("zod/v4/core").$strip>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"page">;
+                    page: import("zod").ZodObject<{
+                        id: import("zod").ZodUUID;
+                    }, import("zod/v4/core").$strip>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"template_mention">;
+                    template_mention: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"template_mention_date">;
+                        template_mention_date: import("zod").ZodEnum<{
+                            today: "today";
+                            now: "now";
+                        }>;
+                    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"template_mention_user">;
+                        template_mention_user: import("zod").ZodLiteral<"me">;
+                    }, import("zod/v4/core").$strip>], "type">;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"user">;
+                    user: import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                        object: import("zod").ZodLiteral<"user">;
+                        id: import("zod").ZodUUID;
+                        type: import("zod").ZodLiteral<"person">;
+                        name: import("zod").ZodOptional<import("zod").ZodString>;
+                        avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
+                        person: import("zod").ZodObject<{
+                            email: import("zod").ZodEmail;
+                        }, import("zod/v4/core").$strip>;
+                    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                        object: import("zod").ZodLiteral<"user">;
+                        id: import("zod").ZodUUID;
+                        type: import("zod").ZodLiteral<"bot">;
+                        name: import("zod").ZodOptional<import("zod").ZodString>;
+                        avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
+                        bot: import("zod").ZodObject<{
+                            owner: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
+                                type: import("zod").ZodLiteral<"workspace">;
+                                workspace: import("zod").ZodLiteral<true>;
+                            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                                type: import("zod").ZodLiteral<"user">;
+                            }, import("zod/v4/core").$strip>], "type">;
+                            workspace_name: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                            workspace_id: import("zod").ZodOptional<import("zod").ZodString>;
+                            workspace_limits: import("zod").ZodOptional<import("zod").ZodObject<{
+                                max_file_upload_size_in_bytes: import("zod").ZodInt;
+                            }, import("zod/v4/core").$strip>>;
+                        }, import("zod/v4/core").$strip>;
+                    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                        object: import("zod").ZodLiteral<"user">;
+                        id: import("zod").ZodUUID;
+                    }, import("zod/v4/core").$strip>]>;
+                }, import("zod/v4/core").$strip>], "type">;
+                annotations: import("zod").ZodObject<{
+                    bold: import("zod").ZodBoolean;
+                    italic: import("zod").ZodBoolean;
+                    strikethrough: import("zod").ZodBoolean;
+                    underline: import("zod").ZodBoolean;
+                    code: import("zod").ZodBoolean;
+                    color: import("zod").ZodEnum<{
+                        blue: "blue";
+                        blue_background: "blue_background";
+                        brown: "brown";
+                        brown_background: "brown_background";
+                        default: "default";
+                        gray: "gray";
+                        gray_background: "gray_background";
+                        green: "green";
+                        green_background: "green_background";
+                        orange: "orange";
+                        orange_background: "orange_background";
+                        pink: "pink";
+                        pink_background: "pink_background";
+                        purple: "purple";
+                        purple_background: "purple_background";
+                        red: "red";
+                        red_background: "red_background";
+                        yellow: "yellow";
+                        yellow_background: "yellow_background";
+                    }>;
+                }, import("zod/v4/core").$strip>;
+                plain_text: import("zod").ZodString;
+                href: import("zod").ZodNullable<import("zod").ZodURL>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"equation">;
+                equation: import("zod").ZodObject<{
+                    expression: import("zod").ZodString;
+                }, import("zod/v4/core").$strip>;
+                annotations: import("zod").ZodObject<{
+                    bold: import("zod").ZodBoolean;
+                    italic: import("zod").ZodBoolean;
+                    strikethrough: import("zod").ZodBoolean;
+                    underline: import("zod").ZodBoolean;
+                    code: import("zod").ZodBoolean;
+                    color: import("zod").ZodEnum<{
+                        blue: "blue";
+                        blue_background: "blue_background";
+                        brown: "brown";
+                        brown_background: "brown_background";
+                        default: "default";
+                        gray: "gray";
+                        gray_background: "gray_background";
+                        green: "green";
+                        green_background: "green_background";
+                        orange: "orange";
+                        orange_background: "orange_background";
+                        pink: "pink";
+                        pink_background: "pink_background";
+                        purple: "purple";
+                        purple_background: "purple_background";
+                        red: "red";
+                        red_background: "red_background";
+                        yellow: "yellow";
+                        yellow_background: "yellow_background";
+                    }>;
+                }, import("zod/v4/core").$strip>;
+                plain_text: import("zod").ZodString;
+                href: import("zod").ZodNullable<import("zod").ZodURL>;
+            }, import("zod/v4/core").$strip>], "type">>;
+            attachments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                category: import("zod").ZodEnum<{
+                    file: "file";
+                    audio: "audio";
+                    image: "image";
+                    pdf: "pdf";
+                    video: "video";
+                }>;
+                file: import("zod").ZodObject<{
+                    url: import("zod").ZodURL;
+                    expiry_time: import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>>>;
+            display_name: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"user">;
+                resolved_name: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"custom">;
+                resolved_name: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>]>>;
+        }, import("zod/v4/core").$strip>;
+        ModelClass: typeof Comment;
+        listType: "comment";
+    };
     constructor(client: NotionClient);
     /**
      * Retrieve all comments from a page or block (paginated).
@@ -68,4 +324,3 @@ export declare class CommentsAPI {
      */
     create(options: CreateCommentOptions): Promise<Comment>;
 }
-//# sourceMappingURL=comments.api.d.ts.map

package/dist/api/comments.api.js

@@ -4,12 +4,19 @@ exports.CommentsAPI = void 0;
 const schemas_1 = require("../schemas");
 const models_1 = require("../models");
 const validation_1 = require("../validation");
+const base_api_1 = require("./base.api");
 /**
  * Comments API client for working with Notion comments.
  */
-class CommentsAPI {
+class CommentsAPI extends base_api_1.BaseAPI {
     constructor(client) {
+        super(client);
         this.client = client;
+        this.config = {
+            schema: schemas_1.commentSchema,
+            ModelClass: models_1.Comment,
+            listType: 'comment',
+        };
     }
     /**
      * Retrieve all comments from a page or block (paginated).
@@ -23,27 +30,9 @@ class CommentsAPI {
     async list(parentId, params) {
         const query = {
             block_id: parentId, // Can be page_id, block_id, or database_id
+            ...this.buildPaginationQuery(params),
         };
-        if (params?.page_size) {
-            query.page_size = String(params.page_size);
-        }
-        if (params?.start_cursor) {
-            query.start_cursor = params.start_cursor;
-        }
-        const response = await this.client.request({
-            method: 'GET',
-            path: '/comments',
-            query,
-        });
-        const listSchema = (0, schemas_1.paginatedListSchema)(schemas_1.commentSchema);
-        const parsed = listSchema.parse(response);
-        return {
-            object: 'list',
-            results: parsed.results.map((comment) => new models_1.Comment(comment)),
-            next_cursor: parsed.next_cursor,
-            has_more: parsed.has_more,
-            type: 'comment',
-        };
+        return this.listResources('/comments', query);
     }
     /**
      * Create a new comment on a page or block.
@@ -58,14 +47,7 @@ class CommentsAPI {
         if (options.attachments) {
             (0, validation_1.validateArrayLength)(options.attachments, validation_1.LIMITS.COMMENT_ATTACHMENTS, 'attachments');
         }
-        const response = await this.client.request({
-            method: 'POST',
-            path: '/comments',
-            body: options,
-        });
-        const parsed = schemas_1.commentSchema.parse(response);
-        return new models_1.Comment(parsed);
+        return this.createResource('/comments', options);
     }
 }
 exports.CommentsAPI = CommentsAPI;
-//# sourceMappingURL=comments.api.js.map