@visus-io/notion-sdk-ts 3.1.1 → 3.2.1

package/dist/schemas/block.schema.js

@@ -37,7 +37,6 @@ exports.blockSchema = exports.blockPositionSchema = void 0;
 const z = __importStar(require("zod"));
 const codeLanguages_1 = require("./codeLanguages");
 const colors_1 = require("./colors");
-const file_schema_1 = require("./file.schema");
 const icon_schema_1 = require("./icon.schema");
 const parent_schema_1 = require("./parent.schema");
 const richText_schema_1 = require("./richText.schema");
@@ -47,7 +46,7 @@ const user_schema_1 = require("./user.schema");
  * Notion block object schema.
  *
  * Blocks are the individual pieces of content that make up pages. Notion supports
- * 31 different block types including paragraphs, headings, lists, media, and more.
+ * many block types, including paragraphs, headings, lists, media, and more.
  *
  * Notion API reference:
  * https://developers.notion.com/reference/block
@@ -75,6 +74,26 @@ const headingsObjectSchema = z.object({
         return getChildrenSchema();
     },
 });
+/**
+ * Content of a media block (`audio`, `image`, `video`, `file`, `pdf`). The file-object
+ * body is inlined, so `external` is `{ url }`, not a full nested file object.
+ *
+ * The `type` field names which body object is present. The schema rejects a value
+ * whose `type` has no matching `file`, `external`, or `file_upload` object.
+ */
+const mediaBlockContentSchema = z
+    .object({
+    caption: richText_schema_1.richTextSchema.default([]),
+    type: z.enum(['file', 'file_upload', 'external']),
+    file: z.object({ url: z.url(), expiry_time: shared_schema_1.notionDateStringSchema }).optional(),
+    external: z.object({ url: z.url() }).optional(),
+    file_upload: z.object({ id: z.uuid() }).optional(),
+    name: z.string().trim().optional(),
+})
+    .refine((value) => value[value.type] !== undefined, {
+    error: 'A media block must include the file object that matches its `type`.',
+    path: ['type'],
+});
 /**
  * @category Blocks
  */
@@ -103,6 +122,7 @@ exports.blockSchema = z.object({
         'heading_4',
         'image',
         'link_preview',
+        'link_to_page',
         'numbered_list_item',
         'paragraph',
         'pdf',
@@ -126,7 +146,7 @@ exports.blockSchema = z.object({
     in_trash: z.boolean(),
     has_children: z.boolean(),
     // Block-specific properties
-    audio: file_schema_1.fileSchema.optional(),
+    audio: mediaBlockContentSchema.optional(),
     bookmark: z
         .object({
         caption: richText_schema_1.richTextSchema,
@@ -197,22 +217,26 @@ exports.blockSchema = z.object({
         expression: z.string(),
     })
         .optional(),
-    file: z
-        .object({
-        caption: richText_schema_1.richTextSchema,
-        type: z.enum(['file', 'file_upload', 'external']),
-        file: file_schema_1.fileSchema.optional(),
-        external: file_schema_1.fileSchema.optional(),
-        file_upload: file_schema_1.fileSchema.optional(),
-        name: z.string().trim().optional(),
-    })
-        .optional(),
+    file: mediaBlockContentSchema.optional(),
     heading_1: headingsObjectSchema.optional(),
     heading_2: headingsObjectSchema.optional(),
     heading_3: headingsObjectSchema.optional(),
     heading_4: headingsObjectSchema.optional(),
-    image: file_schema_1.fileSchema.optional(),
+    image: mediaBlockContentSchema.optional(),
     link_preview: z.object({ url: z.url() }).optional(),
+    link_to_page: z
+        .object({
+        type: z.enum(['page_id', 'data_source_id', 'database_id', 'comment_id']),
+        page_id: z.uuid().optional(),
+        data_source_id: z.uuid().optional(),
+        database_id: z.uuid().optional(),
+        comment_id: z.uuid().optional(),
+    })
+        .refine((value) => value[value.type] !== undefined, {
+        error: 'A link_to_page block must include the ID field that matches its `type`.',
+        path: ['type'],
+    })
+        .optional(),
     numbered_list_item: z
         .object({
         rich_text: richText_schema_1.richTextSchema,
@@ -234,16 +258,7 @@ exports.blockSchema = z.object({
         },
     })
         .optional(),
-    pdf: z
-        .object({
-        caption: richText_schema_1.richTextSchema,
-        type: z.enum(['file', 'file_upload', 'external']),
-        file: file_schema_1.fileSchema.optional(),
-        external: file_schema_1.fileSchema.optional(),
-        file_upload: file_schema_1.fileSchema.optional(),
-        name: z.string().trim().optional(),
-    })
-        .optional(),
+    pdf: mediaBlockContentSchema.optional(),
     quote: z
         .object({
         rich_text: richText_schema_1.richTextSchema,
@@ -335,5 +350,5 @@ exports.blockSchema = z.object({
     })
         .optional(),
     unsupported: z.object({}).optional(),
-    video: file_schema_1.fileSchema.optional(),
+    video: mediaBlockContentSchema.optional(),
 });

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

@@ -138,10 +138,23 @@ export declare const commentSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"mention">;
         mention: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"custom_emoji">;
+            custom_emoji: z.ZodObject<{
+                id: z.ZodUUID;
+                name: z.ZodString;
+                url: z.ZodURL;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"database">;
             database: z.ZodObject<{
                 id: z.ZodUUID;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"data_source">;
+            data_source: z.ZodObject<{
+                id: z.ZodUUID;
+                database_id: z.ZodOptional<z.ZodUUID>;
+            }, z.core.$strip>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"date">;
             date: z.ZodObject<{
@@ -149,6 +162,11 @@ export declare const commentSchema: z.ZodObject<{
                 end: z.ZodNullable<z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>>;
                 time_zone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"link_mention">;
+            link_mention: z.ZodObject<{
+                href: z.ZodString;
+            }, z.core.$loose>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"link_preview">;
             link_preview: z.ZodObject<{

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

@@ -446,10 +446,23 @@ export declare const dataSourceSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"mention">;
         mention: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"custom_emoji">;
+            custom_emoji: z.ZodObject<{
+                id: z.ZodUUID;
+                name: z.ZodString;
+                url: z.ZodURL;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"database">;
             database: z.ZodObject<{
                 id: z.ZodUUID;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"data_source">;
+            data_source: z.ZodObject<{
+                id: z.ZodUUID;
+                database_id: z.ZodOptional<z.ZodUUID>;
+            }, z.core.$strip>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"date">;
             date: z.ZodObject<{
@@ -457,6 +470,11 @@ export declare const dataSourceSchema: z.ZodObject<{
                 end: z.ZodNullable<z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>>;
                 time_zone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"link_mention">;
+            link_mention: z.ZodObject<{
+                href: z.ZodString;
+            }, z.core.$loose>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"link_preview">;
             link_preview: z.ZodObject<{
@@ -622,10 +640,23 @@ export declare const dataSourceSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"mention">;
         mention: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"custom_emoji">;
+            custom_emoji: z.ZodObject<{
+                id: z.ZodUUID;
+                name: z.ZodString;
+                url: z.ZodURL;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"database">;
             database: z.ZodObject<{
                 id: z.ZodUUID;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"data_source">;
+            data_source: z.ZodObject<{
+                id: z.ZodUUID;
+                database_id: z.ZodOptional<z.ZodUUID>;
+            }, z.core.$strip>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"date">;
             date: z.ZodObject<{
@@ -633,6 +664,11 @@ export declare const dataSourceSchema: z.ZodObject<{
                 end: z.ZodNullable<z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>>;
                 time_zone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"link_mention">;
+            link_mention: z.ZodObject<{
+                href: z.ZodString;
+            }, z.core.$loose>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"link_preview">;
             link_preview: z.ZodObject<{
@@ -822,6 +858,11 @@ export declare const dataSourceSchema: z.ZodObject<{
     public_url: z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>;
     is_inline: z.ZodBoolean;
     in_trash: z.ZodBoolean;
+    database_type: z.ZodOptional<z.ZodEnum<{
+        tasks: "tasks";
+        projects: "projects";
+        skills: "skills";
+    }>>;
 }, z.core.$strip>;
 /**
  * @category Databases & Data Sources

package/dist/schemas/dataSource.schema.js

@@ -42,6 +42,7 @@ const richText_schema_1 = require("./richText.schema");
 const shared_schema_1 = require("./shared.schema");
 const user_schema_1 = require("./user.schema");
 const propertyObjects_schema_1 = require("./propertyObjects.schema");
+const database_schema_1 = require("./database.schema");
 /**
  * Notion data source object schema.
  *
@@ -88,6 +89,8 @@ exports.dataSourceSchema = z.object({
     is_inline: z.boolean(),
     /** Whether the data source is in the trash */
     in_trash: z.boolean(),
+    /** Canonical database type this data source's parent database was built from, if any */
+    database_type: z.enum(database_schema_1.DATABASE_TYPES).optional(),
 });
 /**
  * A single data source template reference. The List data source templates endpoint

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

@@ -20,6 +20,19 @@ export declare const dataSourceRefSchema: z.ZodObject<{
  * @category Databases & Data Sources
  */
 export type DataSourceRef = z.infer<typeof dataSourceRefSchema>;
+/**
+ * A canonical database type.
+ *
+ * Pass one of these values as `database_type` when you create a database. Notion builds the
+ * database from its schema for that type, not a custom schema.
+ *
+ * @category Databases & Data Sources
+ */
+export declare const DATABASE_TYPES: readonly ["tasks", "projects", "skills"];
+/**
+ * @category Databases & Data Sources
+ */
+export type DatabaseType = (typeof DATABASE_TYPES)[number];
 /**
  * @category Databases & Data Sources
  */
@@ -139,10 +152,23 @@ export declare const databaseSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"mention">;
         mention: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"custom_emoji">;
+            custom_emoji: z.ZodObject<{
+                id: z.ZodUUID;
+                name: z.ZodString;
+                url: z.ZodURL;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"database">;
             database: z.ZodObject<{
                 id: z.ZodUUID;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"data_source">;
+            data_source: z.ZodObject<{
+                id: z.ZodUUID;
+                database_id: z.ZodOptional<z.ZodUUID>;
+            }, z.core.$strip>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"date">;
             date: z.ZodObject<{
@@ -150,6 +176,11 @@ export declare const databaseSchema: z.ZodObject<{
                 end: z.ZodNullable<z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>>;
                 time_zone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"link_mention">;
+            link_mention: z.ZodObject<{
+                href: z.ZodString;
+            }, z.core.$loose>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"link_preview">;
             link_preview: z.ZodObject<{
@@ -315,10 +346,23 @@ export declare const databaseSchema: z.ZodObject<{
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"mention">;
         mention: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"custom_emoji">;
+            custom_emoji: z.ZodObject<{
+                id: z.ZodUUID;
+                name: z.ZodString;
+                url: z.ZodURL;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"database">;
             database: z.ZodObject<{
                 id: z.ZodUUID;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"data_source">;
+            data_source: z.ZodObject<{
+                id: z.ZodUUID;
+                database_id: z.ZodOptional<z.ZodUUID>;
+            }, z.core.$strip>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"date">;
             date: z.ZodObject<{
@@ -326,6 +370,11 @@ export declare const databaseSchema: z.ZodObject<{
                 end: z.ZodNullable<z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>>;
                 time_zone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"link_mention">;
+            link_mention: z.ZodObject<{
+                href: z.ZodString;
+            }, z.core.$loose>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"link_preview">;
             link_preview: z.ZodObject<{
@@ -536,6 +585,11 @@ export declare const databaseSchema: z.ZodObject<{
     is_inline: z.ZodBoolean;
     is_locked: z.ZodOptional<z.ZodBoolean>;
     public_url: z.ZodNullable<z.ZodURL>;
+    database_type: z.ZodOptional<z.ZodEnum<{
+        tasks: "tasks";
+        projects: "projects";
+        skills: "skills";
+    }>>;
 }, z.core.$strip>;
 /**
  * @category Databases & Data Sources

package/dist/schemas/database.schema.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.databaseSchema = exports.dataSourceRefSchema = void 0;
+exports.databaseSchema = exports.DATABASE_TYPES = exports.dataSourceRefSchema = void 0;
 const z = __importStar(require("zod"));
 const file_schema_1 = require("./file.schema");
 const icon_schema_1 = require("./icon.schema");
@@ -58,6 +58,15 @@ exports.dataSourceRefSchema = z.object({
     id: z.uuid(),
     name: z.string().trim(),
 });
+/**
+ * A canonical database type.
+ *
+ * Pass one of these values as `database_type` when you create a database. Notion builds the
+ * database from its schema for that type, not a custom schema.
+ *
+ * @category Databases & Data Sources
+ */
+exports.DATABASE_TYPES = ['tasks', 'projects', 'skills'];
 /**
  * @category Databases & Data Sources
  */
@@ -79,4 +88,5 @@ exports.databaseSchema = z.object({
     is_inline: z.boolean(),
     is_locked: z.boolean().optional(),
     public_url: z.nullable(z.url()),
+    database_type: z.enum(exports.DATABASE_TYPES).optional(),
 });