@visus-io/notion-sdk-ts 3.1.0 → 3.2.0

package/dist/schemas/pageMarkdown.schema.js

@@ -44,6 +44,8 @@ const asyncTask_schema_1 = require("./asyncTask.schema");
  *
  * Notion API reference:
  * https://developers.notion.com/guides/data-apis/working-with-markdown-content
+ *
+ * @category Pages
  */
 exports.pageMarkdownSchema = z.object({
     object: z.literal('page_markdown'),
@@ -54,10 +56,13 @@ exports.pageMarkdownSchema = z.object({
     unknown_block_ids: z.array(z.uuid()).max(100),
 });
 /**
- * `PATCH /v1/pages/{page_id}/markdown` returns `pageMarkdownSchema` synchronously, or
- * (when `allow_async: true` triggers async processing) an `async_task` handle to poll
- * via {@link AsyncTasksAPI}. Both response bodies carry a literal `object` field, so
- * they discriminate cleanly without needing the HTTP status code.
+ * `PATCH /v1/pages/{page_id}/markdown` returns `pageMarkdownSchema` synchronously. If
+ * `allow_async: true` triggers async processing, it returns an `async_task` handle
+ * instead. Poll the handle through {@link AsyncTasksAPI}. Both response bodies carry a
+ * literal `object` field, so you can discriminate between them without checking the
+ * HTTP status code.
+ *
+ * @category Pages
  */
 exports.markdownContentResponseSchema = z.discriminatedUnion('object', [
     exports.pageMarkdownSchema,

package/dist/schemas/pageProperties.schema.d.ts

@@ -2,9 +2,9 @@ import * as z from 'zod';
 /**
  * Page property value schemas.
  *
- * These define the actual data values stored in page properties (database columns).
- * Different from property objects which define the schema/configuration.
- * Supports 23 property types including title, rich text, number, select, etc.
+ * These schemas define the data values in page properties (database columns).
+ * Property objects define the schema and configuration instead.
+ * This file supports 22 property types, including title, rich text, number, and select.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/page-property-values
@@ -118,6 +118,9 @@ declare const formulaPropertySchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"string">;
         string: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"unsupported">;
+        unsupported: z.ZodObject<{}, z.core.$strip>;
     }, z.core.$strip>], "type">;
 }, z.core.$strip>;
 /** Last edited by property. */
@@ -786,6 +789,9 @@ declare const verificationPropertySchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * @category Page Properties
+ */
 export declare const pagePropertiesSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     id: z.ZodString;
     type: z.ZodLiteral<"checkbox">;
@@ -882,6 +888,9 @@ export declare const pagePropertiesSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"string">;
         string: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"unsupported">;
+        unsupported: z.ZodObject<{}, z.core.$strip>;
     }, z.core.$strip>], "type">;
 }, z.core.$strip>, z.ZodObject<{
     id: z.ZodString;
@@ -1520,27 +1529,96 @@ export declare const pagePropertiesSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>], "type">;
+/**
+ * @category Page Properties
+ */
 export type NotionPageProperties = z.infer<typeof pagePropertiesSchema>;
+/**
+ * @category Page Properties
+ */
 export type CheckboxProperty = z.infer<typeof checkboxPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type CreatedByProperty = z.infer<typeof createdByPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type CreatedTimeProperty = z.infer<typeof createdTimePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type DateProperty = z.infer<typeof datePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type EmailProperty = z.infer<typeof emailPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type FilesProperty = z.infer<typeof filesPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type FormulaProperty = z.infer<typeof formulaPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type LastEditedByProperty = z.infer<typeof lastEditedByPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type LastEditedTimeProperty = z.infer<typeof lastEditedTimePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type MultiSelectProperty = z.infer<typeof multiSelectPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type NumberProperty = z.infer<typeof numberPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type PeopleProperty = z.infer<typeof peoplePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type PhoneNumberProperty = z.infer<typeof phoneNumberPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RelationProperty = z.infer<typeof relationPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RichTextProperty = z.infer<typeof richTextPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RollupProperty = z.infer<typeof rollupPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type SelectProperty = z.infer<typeof selectPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type StatusProperty = z.infer<typeof statusPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type TitleProperty = z.infer<typeof titlePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type UrlProperty = z.infer<typeof urlPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type UniqueIdProperty = z.infer<typeof uniqueIdPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type VerificationProperty = z.infer<typeof verificationPropertySchema>;
 export {};

package/dist/schemas/pageProperties.schema.js

@@ -42,9 +42,9 @@ const user_schema_1 = require("./user.schema");
 /**
  * Page property value schemas.
  *
- * These define the actual data values stored in page properties (database columns).
- * Different from property objects which define the schema/configuration.
- * Supports 23 property types including title, rich text, number, select, etc.
+ * These schemas define the data values in page properties (database columns).
+ * Property objects define the schema and configuration instead.
+ * This file supports 22 property types, including title, rich text, number, and select.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/page-property-values
@@ -113,6 +113,7 @@ const formulaPropertySchema = z.object({
         }),
         z.object({ type: z.literal('number'), number: z.number().nullable() }),
         z.object({ type: z.literal('string'), string: z.string().trim().nullable() }),
+        z.object({ type: z.literal('unsupported'), unsupported: z.object({}) }),
     ]),
 });
 /** Last edited by property. */
@@ -274,6 +275,9 @@ const verificationPropertySchema = z.object({
     })
         .nullable(),
 });
+/**
+ * @category Page Properties
+ */
 exports.pagePropertiesSchema = z.discriminatedUnion('type', [
     checkboxPropertySchema,
     createdByPropertySchema,

package/dist/schemas/pagination.schema.d.ts

@@ -3,28 +3,38 @@ import * as z from 'zod';
  * Pagination schemas and utilities.
  *
  * The Notion API uses cursor-based pagination for list endpoints. Responses include
- * results, a next_cursor, and has_more flag. This file provides reusable schemas
- * and types for working with paginated responses.
+ * results, a next_cursor, and a has_more flag. This file provides reusable schemas
+ * and types to work with paginated responses.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/intro#pagination
  */
 /**
  * Paginated list response type.
- * As of API version 2025-09-03, 'data_source' and 'page_or_data_source' are used
- * instead of 'database' and 'page_or_database' in search results.
+ * As of API version 2025-09-03, search results use 'data_source' and
+ * 'page_or_data_source' instead of 'database' and 'page_or_database'.
+ *
+ * @category Pagination
  */
 export type PaginatedListType = 'block' | 'comment' | 'custom_emoji' | 'database' | 'data_source' | 'page' | 'page_or_database' | 'page_or_data_source' | 'property_item' | 'user' | 'view';
 /**
- * Reasons a query can be reported as incomplete despite `has_more` being `false`.
- * Currently only emitted when a query hits the 10,000-result pagination depth cap.
+ * Reasons why a query result can be incomplete even when `has_more` is `false`.
+ * This happens only when a query hits the 10,000-result pagination depth cap.
+ *
+ * @category Pagination
  */
 export declare const REQUEST_STATUS_INCOMPLETE_REASONS: readonly ["query_result_limit_reached"];
+/**
+ * @category Pagination
+ */
 export type RequestStatusIncompleteReason = (typeof REQUEST_STATUS_INCOMPLETE_REASONS)[number];
 /**
- * Signals that a query was truncated even though `has_more` is `false` -- e.g. data source,
- * view, and meeting-notes queries cap at 10,000 results. Callers that need every row must
- * detect this and re-query with a narrower filter (see the pagination helpers).
+ * This schema flags a truncated query even though `has_more` is `false`. For example,
+ * data source, view, and meeting-notes queries cap at 10,000 results. Callers that need
+ * every row must detect this. Then they must re-query with a narrower filter (see the
+ * pagination helpers).
+ *
+ * @category Pagination
  */
 export declare const requestStatusSchema: z.ZodObject<{
     type: z.ZodLiteral<"incomplete">;
@@ -32,9 +42,14 @@ export declare const requestStatusSchema: z.ZodObject<{
         query_result_limit_reached: "query_result_limit_reached";
     }>;
 }, z.core.$strip>;
+/**
+ * @category Pagination
+ */
 export type RequestStatus = z.infer<typeof requestStatusSchema>;
 /**
  * Base paginated list response schema.
+ *
+ * @category Pagination
  */
 export declare const paginatedListSchema: <T extends z.ZodTypeAny>(resultSchema: T) => z.ZodObject<{
     object: z.ZodLiteral<"list">;
@@ -63,15 +78,23 @@ export declare const paginatedListSchema: <T extends z.ZodTypeAny>(resultSchema:
 }, z.core.$strip>;
 /**
  * Pagination parameters for requests.
+ *
+ * @category Pagination
  */
 export interface PaginationParameters {
     /** The number of items to return (default: 100, max: 100) */
     page_size?: number;
-    /** The cursor value from a previous response to continue pagination (`null` is treated the same as omitted) */
+    /**
+     * The cursor value from a previous response.
+     * Pass it to continue pagination.
+     * The SDK treats `null` the same as omitted.
+     */
     start_cursor?: string | null;
 }
 /**
  * Helper to create paginated response type.
+ *
+ * @category Pagination
  */
 export type PaginatedList<T> = {
     object: 'list';

package/dist/schemas/pagination.schema.js

@@ -36,14 +36,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.paginatedListSchema = exports.requestStatusSchema = exports.REQUEST_STATUS_INCOMPLETE_REASONS = void 0;
 const z = __importStar(require("zod"));
 /**
- * Reasons a query can be reported as incomplete despite `has_more` being `false`.
- * Currently only emitted when a query hits the 10,000-result pagination depth cap.
+ * Reasons why a query result can be incomplete even when `has_more` is `false`.
+ * This happens only when a query hits the 10,000-result pagination depth cap.
+ *
+ * @category Pagination
  */
 exports.REQUEST_STATUS_INCOMPLETE_REASONS = ['query_result_limit_reached'];
 /**
- * Signals that a query was truncated even though `has_more` is `false` -- e.g. data source,
- * view, and meeting-notes queries cap at 10,000 results. Callers that need every row must
- * detect this and re-query with a narrower filter (see the pagination helpers).
+ * This schema flags a truncated query even though `has_more` is `false`. For example,
+ * data source, view, and meeting-notes queries cap at 10,000 results. Callers that need
+ * every row must detect this. Then they must re-query with a narrower filter (see the
+ * pagination helpers).
+ *
+ * @category Pagination
  */
 exports.requestStatusSchema = z.object({
     type: z.literal('incomplete'),
@@ -51,6 +56,8 @@ exports.requestStatusSchema = z.object({
 });
 /**
  * Base paginated list response schema.
+ *
+ * @category Pagination
  */
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 const paginatedListSchema = (resultSchema) => {

package/dist/schemas/parent.schema.d.ts

@@ -2,13 +2,16 @@ import * as z from 'zod';
 /**
  * Notion parent object schemas.
  *
- * Parent objects define the location/container of pages and blocks within Notion.
+ * Parent objects identify the container of a page or block within Notion.
  * A parent can be a database, data source, page, workspace, or block.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/parent-object
  */
-/** Database parent. */
+/** Database parent.
+ *
+ * @category Shared Types
+ */
 export declare const databaseParentSchema: z.ZodObject<{
     type: z.ZodLiteral<"database_id">;
     database_id: z.ZodUUID;
@@ -39,6 +42,9 @@ declare const agentParentSchema: z.ZodObject<{
     type: z.ZodLiteral<"agent_id">;
     agent_id: z.ZodUUID;
 }, z.core.$strip>;
+/**
+ * @category Shared Types
+ */
 export declare const parentSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"database_id">;
     database_id: z.ZodUUID;
@@ -59,11 +65,32 @@ export declare const parentSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"agent_id">;
     agent_id: z.ZodUUID;
 }, z.core.$strip>], "type">;
+/**
+ * @category Shared Types
+ */
 export type NotionParent = z.infer<typeof parentSchema>;
+/**
+ * @category Shared Types
+ */
 export type DatabaseParent = z.infer<typeof databaseParentSchema>;
+/**
+ * @category Shared Types
+ */
 export type DataSourceParent = z.infer<typeof dataSourceParentSchema>;
+/**
+ * @category Shared Types
+ */
 export type PageParent = z.infer<typeof pageParentSchema>;
+/**
+ * @category Shared Types
+ */
 export type WorkspaceParent = z.infer<typeof workspaceParentSchema>;
+/**
+ * @category Shared Types
+ */
 export type BlockParent = z.infer<typeof blockParentSchema>;
+/**
+ * @category Shared Types
+ */
 export type AgentParent = z.infer<typeof agentParentSchema>;
 export {};

package/dist/schemas/parent.schema.js

@@ -38,13 +38,16 @@ const z = __importStar(require("zod"));
 /**
  * Notion parent object schemas.
  *
- * Parent objects define the location/container of pages and blocks within Notion.
+ * Parent objects identify the container of a page or block within Notion.
  * A parent can be a database, data source, page, workspace, or block.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/parent-object
  */
-/** Database parent. */
+/** Database parent.
+ *
+ * @category Shared Types
+ */
 exports.databaseParentSchema = z.object({
     type: z.literal('database_id'),
     database_id: z.uuid(),
@@ -75,6 +78,9 @@ const agentParentSchema = z.object({
     type: z.literal('agent_id'),
     agent_id: z.uuid(),
 });
+/**
+ * @category Shared Types
+ */
 exports.parentSchema = z.discriminatedUnion('type', [
     exports.databaseParentSchema,
     dataSourceParentSchema,

package/dist/schemas/propertyObjects.schema.d.ts

@@ -300,7 +300,7 @@ declare const statusPropertySchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
-/** Title property configuration (empty object) - all data sources require exactly one */
+/** Title property configuration (empty object). Every data source requires exactly one. */
 declare const titlePropertySchema: z.ZodObject<{
     type: z.ZodLiteral<"title">;
     id: z.ZodString;
@@ -328,7 +328,9 @@ declare const uniqueIdPropertySchema: z.ZodObject<{
 }, z.core.$strip>;
 /**
  * Discriminated union of all data source property object types.
- * These define the schema/configuration for a data source (not the values).
+ * Together they define the configuration for a data source, not the values.
+ *
+ * @category Page Properties
  */
 export declare const propertyObjectSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"checkbox">;
@@ -614,7 +616,11 @@ export declare const propertyObjectSchema: z.ZodDiscriminatedUnion<[z.ZodObject<
         prefix: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>], "type">;
-/** Record of property objects keyed by property name */
+/**
+ * Record of property objects keyed by property name.
+ *
+ * @category Page Properties
+ */
 export declare const propertiesObjectSchema: z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"checkbox">;
     id: z.ZodString;
@@ -899,28 +905,100 @@ export declare const propertiesObjectSchema: z.ZodRecord<z.ZodString, z.ZodDiscr
         prefix: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>], "type">>;
+/**
+ * @category Page Properties
+ */
 export type NotionPropertyObject = z.infer<typeof propertyObjectSchema>;
+/**
+ * @category Page Properties
+ */
 export type NotionPropertiesObject = z.infer<typeof propertiesObjectSchema>;
+/**
+ * @category Page Properties
+ */
 export type CheckboxPropertyObject = z.infer<typeof checkboxPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type CreatedByPropertyObject = z.infer<typeof createdByPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type CreatedTimePropertyObject = z.infer<typeof createdTimePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type DatePropertyObject = z.infer<typeof datePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type EmailPropertyObject = z.infer<typeof emailPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type FilesPropertyObject = z.infer<typeof filesPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type FormulaPropertyObject = z.infer<typeof formulaPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type LastEditedByPropertyObject = z.infer<typeof lastEditedByPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type LastEditedTimePropertyObject = z.infer<typeof lastEditedTimePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type MultiSelectPropertyObject = z.infer<typeof multiSelectPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type NumberPropertyObject = z.infer<typeof numberPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type PeoplePropertyObject = z.infer<typeof peoplePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type PhoneNumberPropertyObject = z.infer<typeof phoneNumberPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type PlacePropertyObject = z.infer<typeof placePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RelationPropertyObject = z.infer<typeof relationPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RichTextPropertyObject = z.infer<typeof richTextPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type RollupPropertyObject = z.infer<typeof rollupPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type SelectPropertyObject = z.infer<typeof selectPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type StatusPropertyObject = z.infer<typeof statusPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type TitlePropertyObject = z.infer<typeof titlePropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type UrlPropertyObject = z.infer<typeof urlPropertySchema>;
+/**
+ * @category Page Properties
+ */
 export type UniqueIdPropertyObject = z.infer<typeof uniqueIdPropertySchema>;
 export {};

package/dist/schemas/propertyObjects.schema.js

@@ -36,8 +36,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.propertiesObjectSchema = exports.propertyObjectSchema = void 0;
 const z = __importStar(require("zod"));
 /**
- * Data source property objects define the schema/configuration for a data source.
- * These are different from page property values (which contain the actual data).
+ * Data source property objects define the schema and configuration for a data source.
+ * Page property values contain the actual data instead.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/property-object
@@ -318,7 +318,7 @@ const statusPropertySchema = z.object({
         groups: z.array(statusGroupSchema),
     }),
 });
-/** Title property configuration (empty object) - all data sources require exactly one */
+/** Title property configuration (empty object). Every data source requires exactly one. */
 const titlePropertySchema = z.object({
     type: z.literal('title'),
     id: z.string().trim(),
@@ -346,7 +346,9 @@ const uniqueIdPropertySchema = z.object({
 });
 /**
  * Discriminated union of all data source property object types.
- * These define the schema/configuration for a data source (not the values).
+ * Together they define the configuration for a data source, not the values.
+ *
+ * @category Page Properties
  */
 exports.propertyObjectSchema = z.discriminatedUnion('type', [
     checkboxPropertySchema,
@@ -372,5 +374,9 @@ exports.propertyObjectSchema = z.discriminatedUnion('type', [
     urlPropertySchema,
     uniqueIdPropertySchema,
 ]);
-/** Record of property objects keyed by property name */
+/**
+ * Record of property objects keyed by property name.
+ *
+ * @category Page Properties
+ */
 exports.propertiesObjectSchema = z.record(z.string().trim(), exports.propertyObjectSchema);

package/dist/schemas/richText.schema.d.ts

@@ -180,6 +180,9 @@ declare const equationRichTextSchema: z.ZodObject<{
     plain_text: z.ZodString;
     href: z.ZodNullable<z.ZodURL>;
 }, z.core.$strip>;
+/**
+ * @category Rich Text
+ */
 export declare const richTextSchema: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
     type: z.ZodLiteral<"text">;
     text: z.ZodObject<{
@@ -356,8 +359,20 @@ export declare const richTextSchema: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodOb
     plain_text: z.ZodString;
     href: z.ZodNullable<z.ZodURL>;
 }, z.core.$strip>], "type">>;
+/**
+ * @category Rich Text
+ */
 export type NotionRichText = z.infer<typeof richTextSchema>;
+/**
+ * @category Rich Text
+ */
 export type TextRichText = z.infer<typeof textRichTextSchema>;
+/**
+ * @category Rich Text
+ */
 export type MentionRichText = z.infer<typeof mentionRichTextSchema>;
+/**
+ * @category Rich Text
+ */
 export type EquationRichText = z.infer<typeof equationRichTextSchema>;
 export {};

package/dist/schemas/richText.schema.js

@@ -41,9 +41,9 @@ const user_schema_1 = require("./user.schema");
 /**
  * Notion rich text object schema.
  *
- * Rich text is used throughout the API for formatted text content. It supports
- * three types: text (with optional links), mentions (users, pages, dates, etc.),
- * and equations (LaTeX). All types support styling via annotations.
+ * Notion uses rich text throughout the API for formatted text content. It supports
+ * three types: text with optional links, mentions of users, pages, dates, and other
+ * objects, and equations in LaTeX. You can style all types with annotations.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/rich-text
@@ -147,4 +147,7 @@ const equationRichTextSchema = z.object({
     plain_text: z.string(),
     href: z.url().nullable(),
 });
+/**
+ * @category Rich Text
+ */
 exports.richTextSchema = z.array(z.discriminatedUnion('type', [textRichTextSchema, mentionRichTextSchema, equationRichTextSchema]));

package/dist/schemas/shared.schema.d.ts

@@ -7,9 +7,12 @@ import * as z from 'zod';
 /**
  * Notion date string schema.
  *
- * Validates ISO 8601 date strings as returned by the Notion API.
- * Accepts both date-only format ("2023-02-23") and full datetime format ("2023-02-23T00:00:00.000Z").
+ * This schema validates ISO 8601 date strings from the Notion API.
+ * It accepts a date-only format ("2023-02-23") and a full date-time format
+ * ("2023-02-23T00:00:00.000Z").
  *
- * According to Notion API docs, date fields contain "A date, with an optional time".
+ * The Notion API docs describe date fields as "A date, with an optional time".
+ *
+ * @category Shared Types
  */
 export declare const notionDateStringSchema: z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>;

package/dist/schemas/shared.schema.js

@@ -43,10 +43,13 @@ const z = __importStar(require("zod"));
 /**
  * Notion date string schema.
  *
- * Validates ISO 8601 date strings as returned by the Notion API.
- * Accepts both date-only format ("2023-02-23") and full datetime format ("2023-02-23T00:00:00.000Z").
+ * This schema validates ISO 8601 date strings from the Notion API.
+ * It accepts a date-only format ("2023-02-23") and a full date-time format
+ * ("2023-02-23T00:00:00.000Z").
  *
- * According to Notion API docs, date fields contain "A date, with an optional time".
+ * The Notion API docs describe date fields as "A date, with an optional time".
+ *
+ * @category Shared Types
  */
 exports.notionDateStringSchema = z.union([
     z.iso.datetime(), // Full ISO 8601 datetime: "2023-02-23T00:00:00.000Z"