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

package/dist/api/pages.api.js

@@ -4,12 +4,19 @@ exports.PagesAPI = void 0;
 const schemas_1 = require("../schemas");
 const models_1 = require("../models");
 const validation_1 = require("../validation");
+const base_api_1 = require("./base.api");
 /**
  * Pages API client for working with Notion pages.
  */
-class PagesAPI {
+class PagesAPI extends base_api_1.BaseAPI {
     constructor(client) {
+        super(client);
         this.client = client;
+        this.config = {
+            schema: schemas_1.pageSchema,
+            ModelClass: models_1.Page,
+            listType: 'page',
+        };
     }
     /**
      * Retrieve a page by ID.
@@ -21,18 +28,10 @@ class PagesAPI {
      * @see https://developers.notion.com/reference/retrieve-a-page
      */
     async retrieve(pageId, options) {
-        const query = {};
-        if (options?.filter_properties) {
-            (0, validation_1.validateArrayLength)(options.filter_properties, validation_1.LIMITS.ARRAY_ELEMENTS, 'filter_properties');
-            query.filter_properties = options.filter_properties.join(',');
-        }
-        const response = await this.client.request({
-            method: 'GET',
-            path: `/pages/${pageId}`,
-            query: Object.keys(query).length > 0 ? query : undefined,
-        });
-        const parsed = schemas_1.pageSchema.parse(response);
-        return new models_1.Page(parsed);
+        const query = {
+            ...this.buildFilterPropertiesQuery(options?.filter_properties),
+        };
+        return this.retrieveResource(`/pages/${pageId}`, query);
     }
     /**
      * Create a new page.
@@ -46,13 +45,7 @@ class PagesAPI {
         if (options.children) {
             (0, validation_1.validateArrayLength)(options.children, validation_1.LIMITS.ARRAY_ELEMENTS, 'children');
         }
-        const response = await this.client.request({
-            method: 'POST',
-            path: '/pages',
-            body: options,
-        });
-        const parsed = schemas_1.pageSchema.parse(response);
-        return new models_1.Page(parsed);
+        return this.createResource('/pages', options);
     }
     /**
      * Update a page's properties, icon, cover, or archived status.
@@ -64,13 +57,7 @@ class PagesAPI {
      * @see https://developers.notion.com/reference/patch-page
      */
     async update(pageId, options) {
-        const response = await this.client.request({
-            method: 'PATCH',
-            path: `/pages/${pageId}`,
-            body: options,
-        });
-        const parsed = schemas_1.pageSchema.parse(response);
-        return new models_1.Page(parsed);
+        return this.updateResource(`/pages/${pageId}`, options);
     }
     /**
      * Archive a page (convenience method).
@@ -92,4 +79,3 @@ class PagesAPI {
     }
 }
 exports.PagesAPI = PagesAPI;
-//# sourceMappingURL=pages.api.js.map

package/dist/api/search.api.d.ts

@@ -57,4 +57,3 @@ export declare class SearchAPI {
      */
     query(options?: SearchOptions): Promise<PaginatedList<SearchResult>>;
 }
-//# sourceMappingURL=search.api.d.ts.map

package/dist/api/search.api.js

@@ -20,16 +20,11 @@ class SearchAPI {
      * @see https://developers.notion.com/reference/post-search
      */
     async query(options) {
-        const body = {};
-        if (options?.query) {
-            body.query = options.query;
-        }
-        if (options?.filter) {
-            body.filter = options.filter;
-        }
-        if (options?.sort) {
-            body.sort = options.sort;
-        }
+        const body = {
+            ...(options?.query ? { query: options.query } : {}),
+            ...(options?.filter ? { filter: options.filter } : {}),
+            ...(options?.sort ? { sort: options.sort } : {}),
+        };
         if (options?.page_size) {
             body.page_size = options.page_size;
         }
@@ -63,4 +58,3 @@ class SearchAPI {
     }
 }
 exports.SearchAPI = SearchAPI;
-//# sourceMappingURL=search.api.js.map

package/dist/api/users.api.d.ts

@@ -1,11 +1,48 @@
 import type { NotionClient } from '../client';
-import { type PaginatedList, type PaginationParameters } from '../schemas';
+import { type NotionUser, type PaginatedList, type PaginationParameters } from '../schemas';
 import { User } from '../models';
+import { BaseAPI } from './base.api';
 /**
  * Users API client for working with Notion users.
  */
-export declare class UsersAPI {
-    private readonly client;
+export declare class UsersAPI extends BaseAPI<NotionUser, User> {
+    protected readonly client: NotionClient;
+    protected config: {
+        schema: 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>]>;
+        ModelClass: typeof User;
+        listType: "user";
+    };
     constructor(client: NotionClient);
     /**
      * Retrieve a user by ID.
@@ -34,4 +71,3 @@ export declare class UsersAPI {
      */
     me(): Promise<User>;
 }
-//# sourceMappingURL=users.api.d.ts.map

package/dist/api/users.api.js

@@ -3,12 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UsersAPI = void 0;
 const schemas_1 = require("../schemas");
 const models_1 = require("../models");
+const base_api_1 = require("./base.api");
 /**
  * Users API client for working with Notion users.
  */
-class UsersAPI {
+class UsersAPI extends base_api_1.BaseAPI {
     constructor(client) {
+        super(client);
         this.client = client;
+        this.config = {
+            schema: schemas_1.userSchema,
+            ModelClass: models_1.User,
+            listType: 'user',
+        };
     }
     /**
      * Retrieve a user by ID.
@@ -19,12 +26,7 @@ class UsersAPI {
      * @see https://developers.notion.com/reference/get-user
      */
     async retrieve(userId) {
-        const response = await this.client.request({
-            method: 'GET',
-            path: `/users/${userId}`,
-        });
-        const parsed = schemas_1.userSchema.parse(response);
-        return new models_1.User(parsed);
+        return this.retrieveResource(`/users/${userId}`);
     }
     /**
      * List all users in the workspace (paginated).
@@ -35,27 +37,8 @@ class UsersAPI {
      * @see https://developers.notion.com/reference/get-users
      */
     async list(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: '/users',
-            query: Object.keys(query).length > 0 ? query : undefined,
-        });
-        const listSchema = (0, schemas_1.paginatedListSchema)(schemas_1.userSchema);
-        const parsed = listSchema.parse(response);
-        return {
-            object: 'list',
-            results: parsed.results.map((user) => new models_1.User(user)),
-            next_cursor: parsed.next_cursor,
-            has_more: parsed.has_more,
-            type: 'user',
-        };
+        const query = this.buildPaginationQuery(params);
+        return this.listResources('/users', query);
     }
     /**
      * Retrieve the bot user associated with the API token.
@@ -65,13 +48,7 @@ class UsersAPI {
      * @see https://developers.notion.com/reference/get-self
      */
     async me() {
-        const response = await this.client.request({
-            method: 'GET',
-            path: '/users/me',
-        });
-        const parsed = schemas_1.userSchema.parse(response);
-        return new models_1.User(parsed);
+        return this.retrieveResource('/users/me');
     }
 }
 exports.UsersAPI = UsersAPI;
-//# sourceMappingURL=users.api.js.map

package/dist/client.d.ts

@@ -75,4 +75,3 @@ export declare class NotionClient {
      */
     private handleErrorResponse;
 }
-//# sourceMappingURL=client.d.ts.map

package/dist/client.js

@@ -161,4 +161,3 @@ class NotionClient {
     }
 }
 exports.NotionClient = NotionClient;
-//# sourceMappingURL=client.js.map

package/dist/errors.d.ts

@@ -58,4 +58,3 @@ export declare class NotionNetworkError extends Error {
     readonly cause?: Error;
     constructor(message: string, cause?: Error);
 }
-//# sourceMappingURL=errors.d.ts.map

package/dist/errors.js

@@ -82,4 +82,3 @@ class NotionNetworkError extends Error {
     }
 }
 exports.NotionNetworkError = NotionNetworkError;
-//# sourceMappingURL=errors.js.map

package/dist/helpers/block.helpers.d.ts

@@ -65,6 +65,9 @@ declare function callout(text: RichTextInput, options?: CalloutOptions): BlockOb
 declare function template(text: RichTextInput, options?: {
     children?: unknown[];
 }): BlockObject;
+declare function transcription(text: RichTextInput, options?: {
+    children?: unknown[];
+}): BlockObject;
 /** Options for code blocks. */
 interface CodeOptions {
     caption?: RichTextInput;
@@ -164,6 +167,7 @@ export declare const block: {
     quote: typeof quote;
     callout: typeof callout;
     template: typeof template;
+    transcription: typeof transcription;
     code: typeof code;
     equation: typeof equation;
     image: typeof image;
@@ -184,4 +188,3 @@ export declare const block: {
     syncedBlock: typeof syncedBlock;
 };
 export {};
-//# sourceMappingURL=block.helpers.d.ts.map

package/dist/helpers/block.helpers.js

@@ -170,6 +170,16 @@ function template(text, options) {
         },
     };
 }
+function transcription(text, options) {
+    return {
+        object: 'block',
+        type: 'transcription',
+        transcription: {
+            rich_text: resolveRichText(text),
+            ...(options?.children ? { children: options.children } : {}),
+        },
+    };
+}
 function code(content, language, options) {
     return {
         object: 'block',
@@ -403,6 +413,7 @@ exports.block = {
     quote,
     callout,
     template,
+    transcription,
     // Code & equation
     code,
     equation,
@@ -427,4 +438,3 @@ exports.block = {
     // Synced
     syncedBlock,
 };
-//# sourceMappingURL=block.helpers.js.map

package/dist/helpers/file.helpers.d.ts

@@ -133,4 +133,3 @@ export declare const notionFile: {
     upload: typeof uploadFile;
 };
 export {};
-//# sourceMappingURL=file.helpers.d.ts.map

package/dist/helpers/file.helpers.js

@@ -145,4 +145,3 @@ exports.notionFile = {
     external: externalFile,
     upload: uploadFile,
 };
-//# sourceMappingURL=file.helpers.js.map

package/dist/helpers/filter.helpers.d.ts

@@ -180,4 +180,3 @@ export declare const filter: {
     or: typeof or;
 };
 export {};
-//# sourceMappingURL=filter.helpers.d.ts.map

package/dist/helpers/filter.helpers.js

@@ -330,4 +330,3 @@ exports.filter = {
     and,
     or,
 };
-//# sourceMappingURL=filter.helpers.js.map

package/dist/helpers/index.d.ts

@@ -8,4 +8,3 @@ export { parent } from './parent.helpers';
 export { prop } from './property.helpers';
 export { RichTextBuilder, richText } from './richText.helpers';
 export { sort } from './sort.helpers';
-//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.js

@@ -22,4 +22,3 @@ Object.defineProperty(exports, "RichTextBuilder", { enumerable: true, get: funct
 Object.defineProperty(exports, "richText", { enumerable: true, get: function () { return richText_helpers_1.richText; } });
 var sort_helpers_1 = require("./sort.helpers");
 Object.defineProperty(exports, "sort", { enumerable: true, get: function () { return sort_helpers_1.sort; } });
-//# sourceMappingURL=index.js.map

package/dist/helpers/pagination.helpers.d.ts

@@ -149,4 +149,3 @@ export declare function paginateWithMetadata<T>(fetchPage: PaginatedFetchFunctio
     pageCount: number;
     totalCount: number;
 }>;
-//# sourceMappingURL=pagination.helpers.d.ts.map

package/dist/helpers/pagination.helpers.js

@@ -143,4 +143,3 @@ async function paginateWithMetadata(fetchPage) {
         totalCount: items.length,
     };
 }
-//# sourceMappingURL=pagination.helpers.js.map

package/dist/helpers/parent.helpers.d.ts

@@ -95,4 +95,3 @@ export declare const parent: {
     block: typeof blockParent;
 };
 export {};
-//# sourceMappingURL=parent.helpers.d.ts.map

package/dist/helpers/parent.helpers.js

@@ -102,4 +102,3 @@ exports.parent = {
     workspace,
     block: blockParent,
 };
-//# sourceMappingURL=parent.helpers.js.map

package/dist/helpers/property.helpers.d.ts

@@ -245,4 +245,3 @@ export declare const prop: {
     files: typeof files;
 };
 export {};
-//# sourceMappingURL=property.helpers.d.ts.map

package/dist/helpers/property.helpers.js

@@ -269,4 +269,3 @@ exports.prop = {
     people,
     files,
 };
-//# sourceMappingURL=property.helpers.js.map

package/dist/helpers/richText.helpers.d.ts

@@ -147,4 +147,3 @@ export declare const richText: typeof createRichText & {
     join: typeof join;
 };
 export {};
-//# sourceMappingURL=richText.helpers.d.ts.map

package/dist/helpers/richText.helpers.js

@@ -279,4 +279,3 @@ exports.richText = Object.assign(createRichText, {
     equation,
     join,
 });
-//# sourceMappingURL=richText.helpers.js.map

package/dist/helpers/sort.helpers.d.ts

@@ -66,4 +66,3 @@ export declare const sort: {
     lastEditedTime: () => TimestampSortBuilder;
 };
 export {};
-//# sourceMappingURL=sort.helpers.d.ts.map

package/dist/helpers/sort.helpers.js

@@ -77,4 +77,3 @@ exports.sort = {
      */
     lastEditedTime: () => new TimestampSortBuilder('last_edited_time'),
 };
-//# sourceMappingURL=sort.helpers.js.map

package/dist/index.d.ts

@@ -6,4 +6,3 @@ export * from './validation';
 export * from './schemas';
 export * from './models';
 export * from './helpers';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -30,4 +30,3 @@ __exportStar(require("./schemas"), exports);
 __exportStar(require("./models"), exports);
 // Export helpers
 __exportStar(require("./helpers"), exports);
-//# sourceMappingURL=index.js.map

package/dist/models/base.model.d.ts

@@ -1,11 +1,11 @@
-import type { ZodType } from 'zod';
+import type * as z from 'zod';
 /**
  * Base model class providing common functionality for all Notion models.
  * Models wrap validated data from schemas with methods and business logic.
  */
 export declare abstract class BaseModel<T> {
     protected readonly data: T;
-    protected constructor(data: T, schema: ZodType<T>);
+    protected constructor(data: T, schema: z.ZodType<T>);
     /**
      * Returns the raw validated data as a plain object.
      */
@@ -19,4 +19,3 @@ export declare abstract class BaseModel<T> {
      */
     abstract get id(): string;
 }
-//# sourceMappingURL=base.model.d.ts.map

package/dist/models/base.model.js

@@ -17,4 +17,3 @@ class BaseModel {
     }
 }
 exports.BaseModel = BaseModel;
-//# sourceMappingURL=base.model.js.map

package/dist/models/block.model.d.ts

@@ -30,4 +30,3 @@ export declare class Block extends BaseModel<NotionBlock> {
      */
     getPlainText(): string | null;
 }
-//# sourceMappingURL=block.model.d.ts.map

package/dist/models/block.model.js

@@ -93,4 +93,3 @@ class Block extends base_model_1.BaseModel {
     }
 }
 exports.Block = Block;
-//# sourceMappingURL=block.model.js.map

package/dist/models/comment.model.d.ts

@@ -70,4 +70,3 @@ export declare class Comment extends BaseModel<NotionComment> {
      */
     hasBlockParent(): boolean;
 }
-//# sourceMappingURL=comment.model.d.ts.map

package/dist/models/comment.model.js

@@ -108,4 +108,3 @@ class Comment extends base_model_1.BaseModel {
     }
 }
 exports.Comment = Comment;
-//# sourceMappingURL=comment.model.js.map

package/dist/models/dataSource.model.d.ts

@@ -104,4 +104,3 @@ export declare class DataSource extends BaseModel<NotionDataSource> {
      */
     hasProperty(name: string): boolean;
 }
-//# sourceMappingURL=dataSource.model.d.ts.map

package/dist/models/dataSource.model.js

@@ -161,4 +161,3 @@ class DataSource extends base_model_1.BaseModel {
     }
 }
 exports.DataSource = DataSource;
-//# sourceMappingURL=dataSource.model.js.map

package/dist/models/database.model.d.ts

@@ -94,4 +94,3 @@ export declare class Database extends BaseModel<NotionDatabase> {
      */
     hasWorkspaceParent(): boolean;
 }
-//# sourceMappingURL=database.model.d.ts.map

package/dist/models/database.model.js

@@ -144,4 +144,3 @@ class Database extends base_model_1.BaseModel {
     }
 }
 exports.Database = Database;
-//# sourceMappingURL=database.model.js.map

package/dist/models/fileUpload.model.d.ts

@@ -66,4 +66,3 @@ export declare class FileUpload extends BaseModel<NotionFileUpload> {
      */
     isFailed(): boolean;
 }
-//# sourceMappingURL=fileUpload.model.d.ts.map

package/dist/models/fileUpload.model.js

@@ -102,4 +102,3 @@ class FileUpload extends base_model_1.BaseModel {
     }
 }
 exports.FileUpload = FileUpload;
-//# sourceMappingURL=fileUpload.model.js.map

package/dist/models/index.d.ts

@@ -7,4 +7,3 @@ export { FileUpload } from './fileUpload.model';
 export { Page } from './page.model';
 export { RichText } from './richText.model';
 export { User } from './user.model';
-//# sourceMappingURL=index.d.ts.map

package/dist/models/index.js

@@ -19,4 +19,3 @@ var richText_model_1 = require("./richText.model");
 Object.defineProperty(exports, "RichText", { enumerable: true, get: function () { return richText_model_1.RichText; } });
 var user_model_1 = require("./user.model");
 Object.defineProperty(exports, "User", { enumerable: true, get: function () { return user_model_1.User; } });
-//# sourceMappingURL=index.js.map

package/dist/models/page.model.d.ts

@@ -31,4 +31,3 @@ export declare class Page extends BaseModel<NotionPage> {
      */
     isSubpage(): boolean;
 }
-//# sourceMappingURL=page.model.d.ts.map

package/dist/models/page.model.js

@@ -68,4 +68,3 @@ class Page extends base_model_1.BaseModel {
     }
 }
 exports.Page = Page;
-//# sourceMappingURL=page.model.js.map

package/dist/models/richText.model.d.ts

@@ -31,4 +31,3 @@ export declare class RichText {
     toJSON(): NotionRichText;
     private escapeHTML;
 }
-//# sourceMappingURL=richText.model.d.ts.map

package/dist/models/richText.model.js

@@ -111,4 +111,3 @@ class RichText {
     }
 }
 exports.RichText = RichText;
-//# sourceMappingURL=richText.model.js.map

package/dist/models/user.model.d.ts

@@ -43,4 +43,3 @@ export declare class User extends BaseModel<NotionUser> {
         };
     } | undefined;
 }
-//# sourceMappingURL=user.model.d.ts.map

package/dist/models/user.model.js

@@ -57,4 +57,3 @@ class User extends base_model_1.BaseModel {
     }
 }
 exports.User = User;
-//# sourceMappingURL=user.model.js.map

package/dist/notion.d.ts

@@ -54,4 +54,3 @@ export declare class Notion {
     readonly fileUploads: FileUploadsAPI;
     constructor(options: NotionClientOptions);
 }
-//# sourceMappingURL=notion.d.ts.map

package/dist/notion.js

@@ -51,4 +51,3 @@ class Notion {
     }
 }
 exports.Notion = Notion;
-//# sourceMappingURL=notion.js.map