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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/README.md +20 -87
  2. package/dist/api/asyncTasks.api.d.ts +72 -0
  3. package/dist/api/asyncTasks.api.js +70 -0
  4. package/dist/api/base.api.d.ts +15 -4
  5. package/dist/api/base.api.js +20 -8
  6. package/dist/api/blocks.api.d.ts +435 -73
  7. package/dist/api/blocks.api.js +43 -1
  8. package/dist/api/comments.api.d.ts +42 -5
  9. package/dist/api/comments.api.js +45 -1
  10. package/dist/api/customEmojis.api.d.ts +38 -0
  11. package/dist/api/customEmojis.api.js +38 -0
  12. package/dist/api/dataSources.api.d.ts +67 -14
  13. package/dist/api/dataSources.api.js +26 -1
  14. package/dist/api/databases.api.d.ts +47 -11
  15. package/dist/api/databases.api.js +4 -1
  16. package/dist/api/fileUploads.api.d.ts +8 -5
  17. package/dist/api/fileUploads.api.js +11 -7
  18. package/dist/api/index.d.ts +3 -0
  19. package/dist/api/index.js +7 -1
  20. package/dist/api/pages.api.d.ts +144 -10
  21. package/dist/api/pages.api.js +66 -0
  22. package/dist/api/search.api.d.ts +12 -2
  23. package/dist/api/search.api.js +5 -2
  24. package/dist/api/users.api.d.ts +3 -0
  25. package/dist/api/users.api.js +2 -0
  26. package/dist/api/views.api.d.ts +286 -0
  27. package/dist/api/views.api.js +172 -0
  28. package/dist/client.d.ts +17 -17
  29. package/dist/client.js +25 -30
  30. package/dist/errors.d.ts +19 -5
  31. package/dist/errors.js +16 -4
  32. package/dist/helpers/block.helpers.d.ts +49 -5
  33. package/dist/helpers/block.helpers.js +50 -6
  34. package/dist/helpers/file.helpers.d.ts +46 -5
  35. package/dist/helpers/file.helpers.js +36 -8
  36. package/dist/helpers/filter.helpers.d.ts +8 -6
  37. package/dist/helpers/filter.helpers.js +2 -0
  38. package/dist/helpers/index.d.ts +3 -2
  39. package/dist/helpers/index.js +5 -1
  40. package/dist/helpers/pagination.helpers.d.ts +85 -13
  41. package/dist/helpers/pagination.helpers.js +114 -8
  42. package/dist/helpers/parent.helpers.d.ts +5 -3
  43. package/dist/helpers/parent.helpers.js +5 -3
  44. package/dist/helpers/property.helpers.d.ts +31 -0
  45. package/dist/helpers/property.helpers.js +30 -1
  46. package/dist/helpers/richText.helpers.d.ts +10 -5
  47. package/dist/helpers/richText.helpers.js +11 -6
  48. package/dist/helpers/sort.helpers.d.ts +2 -0
  49. package/dist/helpers/sort.helpers.js +2 -0
  50. package/dist/helpers/webhook.helpers.d.ts +54 -0
  51. package/dist/helpers/webhook.helpers.js +83 -0
  52. package/dist/models/asyncTask.model.d.ts +61 -0
  53. package/dist/models/asyncTask.model.js +91 -0
  54. package/dist/models/base.model.d.ts +16 -4
  55. package/dist/models/base.model.js +17 -5
  56. package/dist/models/block.model.d.ts +6 -2
  57. package/dist/models/block.model.js +48 -33
  58. package/dist/models/comment.model.d.ts +4 -2
  59. package/dist/models/comment.model.js +4 -2
  60. package/dist/models/customEmoji.model.d.ts +30 -0
  61. package/dist/models/customEmoji.model.js +44 -0
  62. package/dist/models/dataSource.model.d.ts +7 -5
  63. package/dist/models/dataSource.model.js +5 -3
  64. package/dist/models/database.model.d.ts +13 -5
  65. package/dist/models/database.model.js +15 -5
  66. package/dist/models/fileUpload.model.d.ts +6 -4
  67. package/dist/models/fileUpload.model.js +6 -4
  68. package/dist/models/index.d.ts +3 -0
  69. package/dist/models/index.js +7 -1
  70. package/dist/models/page.model.d.ts +8 -2
  71. package/dist/models/page.model.js +14 -4
  72. package/dist/models/richText.model.d.ts +3 -1
  73. package/dist/models/richText.model.js +3 -1
  74. package/dist/models/user.model.d.ts +4 -2
  75. package/dist/models/user.model.js +4 -2
  76. package/dist/models/view.model.d.ts +81 -0
  77. package/dist/models/view.model.js +121 -0
  78. package/dist/notion.d.ts +32 -8
  79. package/dist/notion.js +25 -4
  80. package/dist/schemas/asyncTask.schema.d.ts +53 -0
  81. package/dist/schemas/asyncTask.schema.js +88 -0
  82. package/dist/schemas/block.schema.d.ts +390 -73
  83. package/dist/schemas/block.schema.js +39 -8
  84. package/dist/schemas/codeLanguages.d.ts +7 -1
  85. package/dist/schemas/codeLanguages.js +4 -1
  86. package/dist/schemas/colors.d.ts +7 -1
  87. package/dist/schemas/colors.js +4 -1
  88. package/dist/schemas/comment.schema.d.ts +28 -5
  89. package/dist/schemas/comment.schema.js +11 -2
  90. package/dist/schemas/customEmoji.schema.d.ts +18 -0
  91. package/dist/schemas/customEmoji.schema.js +50 -0
  92. package/dist/schemas/dataSource.schema.d.ts +84 -10
  93. package/dist/schemas/dataSource.schema.js +31 -6
  94. package/dist/schemas/database.schema.d.ts +51 -7
  95. package/dist/schemas/database.schema.js +10 -3
  96. package/dist/schemas/emoji.schema.d.ts +7 -2
  97. package/dist/schemas/emoji.schema.js +4 -2
  98. package/dist/schemas/file.schema.d.ts +18 -2
  99. package/dist/schemas/file.schema.js +6 -2
  100. package/dist/schemas/fileUpload.schema.d.ts +9 -3
  101. package/dist/schemas/fileUpload.schema.js +5 -2
  102. package/dist/schemas/icon.schema.d.ts +116 -0
  103. package/dist/schemas/icon.schema.js +100 -0
  104. package/dist/schemas/index.d.ts +6 -0
  105. package/dist/schemas/index.js +6 -0
  106. package/dist/schemas/meetingNotesQuery.schema.d.ts +4198 -0
  107. package/dist/schemas/meetingNotesQuery.schema.js +67 -0
  108. package/dist/schemas/page.schema.d.ts +51 -9
  109. package/dist/schemas/page.schema.js +6 -2
  110. package/dist/schemas/pageMarkdown.schema.d.ts +70 -0
  111. package/dist/schemas/pageMarkdown.schema.js +70 -0
  112. package/dist/schemas/pageProperties.schema.d.ts +105 -21
  113. package/dist/schemas/pageProperties.schema.js +8 -6
  114. package/dist/schemas/pagination.schema.d.ts +57 -7
  115. package/dist/schemas/pagination.schema.js +25 -1
  116. package/dist/schemas/parent.schema.d.ts +39 -3
  117. package/dist/schemas/parent.schema.js +17 -5
  118. package/dist/schemas/propertyObjects.schema.d.ts +93 -15
  119. package/dist/schemas/propertyObjects.schema.js +11 -5
  120. package/dist/schemas/richText.schema.d.ts +23 -6
  121. package/dist/schemas/richText.schema.js +7 -4
  122. package/dist/schemas/shared.schema.d.ts +6 -3
  123. package/dist/schemas/shared.schema.js +6 -3
  124. package/dist/schemas/user.schema.d.ts +17 -0
  125. package/dist/schemas/user.schema.js +7 -3
  126. package/dist/schemas/view.schema.d.ts +1111 -0
  127. package/dist/schemas/view.schema.js +134 -0
  128. package/dist/validation.d.ts +11 -4
  129. package/dist/validation.js +11 -4
  130. package/package.json +6 -3
@@ -0,0 +1,67 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.meetingNotesQueryResponseSchema = exports.MEETING_NOTES_QUERY_PROPERTIES = void 0;
37
+ const z = __importStar(require("zod"));
38
+ const block_schema_1 = require("./block.schema");
39
+ const pagination_schema_1 = require("./pagination.schema");
40
+ /**
41
+ * `POST /v1/blocks/meeting_notes/query` request/response schemas.
42
+ *
43
+ * Notion API reference:
44
+ * https://developers.notion.com/reference/query-meeting-notes
45
+ *
46
+ * @category Pages
47
+ */
48
+ exports.MEETING_NOTES_QUERY_PROPERTIES = [
49
+ 'title',
50
+ 'attendees',
51
+ 'created_time',
52
+ 'created_by',
53
+ 'last_edited_time',
54
+ 'last_edited_by',
55
+ ];
56
+ /**
57
+ * This response shape is non-standard. It has no `object` field and no `next_cursor`
58
+ * field. The `limit` parameter alone controls pagination, up to 50 results per request,
59
+ * with no cursor.
60
+ *
61
+ * @category Pages
62
+ */
63
+ exports.meetingNotesQueryResponseSchema = z.object({
64
+ results: z.array(block_schema_1.blockSchema),
65
+ has_more: z.boolean(),
66
+ request_status: pagination_schema_1.requestStatusSchema.optional(),
67
+ });
@@ -7,6 +7,8 @@ import * as z from 'zod';
7
7
  *
8
8
  * Notion API reference:
9
9
  * https://developers.notion.com/reference/page
10
+ *
11
+ * @category Pages
10
12
  */
11
13
  export declare const pageSchema: z.ZodObject<{
12
14
  object: z.ZodLiteral<"page">;
@@ -20,6 +22,7 @@ export declare const pageSchema: z.ZodObject<{
20
22
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
21
23
  person: z.ZodObject<{
22
24
  email: z.ZodEmail;
25
+ email_verified: z.ZodOptional<z.ZodBoolean>;
23
26
  }, z.core.$strip>;
24
27
  }, z.core.$strip>, z.ZodObject<{
25
28
  object: z.ZodLiteral<"user">;
@@ -53,6 +56,7 @@ export declare const pageSchema: z.ZodObject<{
53
56
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
54
57
  person: z.ZodObject<{
55
58
  email: z.ZodEmail;
59
+ email_verified: z.ZodOptional<z.ZodBoolean>;
56
60
  }, z.core.$strip>;
57
61
  }, z.core.$strip>, z.ZodObject<{
58
62
  object: z.ZodLiteral<"user">;
@@ -78,6 +82,8 @@ export declare const pageSchema: z.ZodObject<{
78
82
  id: z.ZodUUID;
79
83
  }, z.core.$strip>]>;
80
84
  in_trash: z.ZodBoolean;
85
+ is_archived: z.ZodOptional<z.ZodBoolean>;
86
+ is_locked: z.ZodOptional<z.ZodBoolean>;
81
87
  icon: z.ZodNullable<z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
82
88
  type: z.ZodLiteral<"file">;
83
89
  file: z.ZodObject<{
@@ -97,6 +103,30 @@ export declare const pageSchema: z.ZodObject<{
97
103
  }, z.core.$strip>], "type">, z.ZodObject<{
98
104
  type: z.ZodLiteral<"emoji">;
99
105
  emoji: z.ZodString;
106
+ }, z.core.$strip>, z.ZodObject<{
107
+ type: z.ZodLiteral<"icon">;
108
+ icon: z.ZodObject<{
109
+ name: z.ZodString;
110
+ color: z.ZodOptional<z.ZodEnum<{
111
+ blue: "blue";
112
+ brown: "brown";
113
+ gray: "gray";
114
+ green: "green";
115
+ orange: "orange";
116
+ pink: "pink";
117
+ purple: "purple";
118
+ red: "red";
119
+ yellow: "yellow";
120
+ lightgray: "lightgray";
121
+ }>>;
122
+ }, z.core.$strip>;
123
+ }, z.core.$strip>, z.ZodObject<{
124
+ type: z.ZodLiteral<"custom_emoji">;
125
+ custom_emoji: z.ZodObject<{
126
+ id: z.ZodUUID;
127
+ name: z.ZodOptional<z.ZodString>;
128
+ url: z.ZodOptional<z.ZodURL>;
129
+ }, z.core.$strip>;
100
130
  }, z.core.$strip>]>>;
101
131
  cover: z.ZodNullable<z.ZodDiscriminatedUnion<[z.ZodObject<{
102
132
  type: z.ZodLiteral<"file">;
@@ -130,6 +160,7 @@ export declare const pageSchema: z.ZodObject<{
130
160
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
131
161
  person: z.ZodObject<{
132
162
  email: z.ZodEmail;
163
+ email_verified: z.ZodOptional<z.ZodBoolean>;
133
164
  }, z.core.$strip>;
134
165
  }, z.core.$strip>, z.ZodObject<{
135
166
  object: z.ZodLiteral<"user">;
@@ -222,6 +253,7 @@ export declare const pageSchema: z.ZodObject<{
222
253
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
223
254
  person: z.ZodObject<{
224
255
  email: z.ZodEmail;
256
+ email_verified: z.ZodOptional<z.ZodBoolean>;
225
257
  }, z.core.$strip>;
226
258
  }, z.core.$strip>, z.ZodObject<{
227
259
  object: z.ZodLiteral<"user">;
@@ -257,11 +289,11 @@ export declare const pageSchema: z.ZodObject<{
257
289
  id: z.ZodString;
258
290
  name: z.ZodString;
259
291
  color: z.ZodEnum<{
292
+ default: "default";
260
293
  blue: "blue";
261
294
  blue_background: "blue_background";
262
295
  brown: "brown";
263
296
  brown_background: "brown_background";
264
- default: "default";
265
297
  gray: "gray";
266
298
  gray_background: "gray_background";
267
299
  green: "green";
@@ -293,6 +325,7 @@ export declare const pageSchema: z.ZodObject<{
293
325
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
294
326
  person: z.ZodObject<{
295
327
  email: z.ZodEmail;
328
+ email_verified: z.ZodOptional<z.ZodBoolean>;
296
329
  }, z.core.$strip>;
297
330
  }, z.core.$strip>, z.ZodObject<{
298
331
  object: z.ZodLiteral<"user">;
@@ -346,11 +379,11 @@ export declare const pageSchema: z.ZodObject<{
346
379
  underline: z.ZodBoolean;
347
380
  code: z.ZodBoolean;
348
381
  color: z.ZodEnum<{
382
+ default: "default";
349
383
  blue: "blue";
350
384
  blue_background: "blue_background";
351
385
  brown: "brown";
352
386
  brown_background: "brown_background";
353
- default: "default";
354
387
  gray: "gray";
355
388
  gray_background: "gray_background";
356
389
  green: "green";
@@ -415,6 +448,7 @@ export declare const pageSchema: z.ZodObject<{
415
448
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
416
449
  person: z.ZodObject<{
417
450
  email: z.ZodEmail;
451
+ email_verified: z.ZodOptional<z.ZodBoolean>;
418
452
  }, z.core.$strip>;
419
453
  }, z.core.$strip>, z.ZodObject<{
420
454
  object: z.ZodLiteral<"user">;
@@ -447,11 +481,11 @@ export declare const pageSchema: z.ZodObject<{
447
481
  underline: z.ZodBoolean;
448
482
  code: z.ZodBoolean;
449
483
  color: z.ZodEnum<{
484
+ default: "default";
450
485
  blue: "blue";
451
486
  blue_background: "blue_background";
452
487
  brown: "brown";
453
488
  brown_background: "brown_background";
454
- default: "default";
455
489
  gray: "gray";
456
490
  gray_background: "gray_background";
457
491
  green: "green";
@@ -482,11 +516,11 @@ export declare const pageSchema: z.ZodObject<{
482
516
  underline: z.ZodBoolean;
483
517
  code: z.ZodBoolean;
484
518
  color: z.ZodEnum<{
519
+ default: "default";
485
520
  blue: "blue";
486
521
  blue_background: "blue_background";
487
522
  brown: "brown";
488
523
  brown_background: "brown_background";
489
- default: "default";
490
524
  gray: "gray";
491
525
  gray_background: "gray_background";
492
526
  green: "green";
@@ -558,11 +592,11 @@ export declare const pageSchema: z.ZodObject<{
558
592
  id: z.ZodString;
559
593
  name: z.ZodString;
560
594
  color: z.ZodEnum<{
595
+ default: "default";
561
596
  blue: "blue";
562
597
  blue_background: "blue_background";
563
598
  brown: "brown";
564
599
  brown_background: "brown_background";
565
- default: "default";
566
600
  gray: "gray";
567
601
  gray_background: "gray_background";
568
602
  green: "green";
@@ -586,11 +620,11 @@ export declare const pageSchema: z.ZodObject<{
586
620
  id: z.ZodString;
587
621
  name: z.ZodString;
588
622
  color: z.ZodEnum<{
623
+ default: "default";
589
624
  blue: "blue";
590
625
  blue_background: "blue_background";
591
626
  brown: "brown";
592
627
  brown_background: "brown_background";
593
- default: "default";
594
628
  gray: "gray";
595
629
  gray_background: "gray_background";
596
630
  green: "green";
@@ -625,11 +659,11 @@ export declare const pageSchema: z.ZodObject<{
625
659
  underline: z.ZodBoolean;
626
660
  code: z.ZodBoolean;
627
661
  color: z.ZodEnum<{
662
+ default: "default";
628
663
  blue: "blue";
629
664
  blue_background: "blue_background";
630
665
  brown: "brown";
631
666
  brown_background: "brown_background";
632
- default: "default";
633
667
  gray: "gray";
634
668
  gray_background: "gray_background";
635
669
  green: "green";
@@ -694,6 +728,7 @@ export declare const pageSchema: z.ZodObject<{
694
728
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
695
729
  person: z.ZodObject<{
696
730
  email: z.ZodEmail;
731
+ email_verified: z.ZodOptional<z.ZodBoolean>;
697
732
  }, z.core.$strip>;
698
733
  }, z.core.$strip>, z.ZodObject<{
699
734
  object: z.ZodLiteral<"user">;
@@ -726,11 +761,11 @@ export declare const pageSchema: z.ZodObject<{
726
761
  underline: z.ZodBoolean;
727
762
  code: z.ZodBoolean;
728
763
  color: z.ZodEnum<{
764
+ default: "default";
729
765
  blue: "blue";
730
766
  blue_background: "blue_background";
731
767
  brown: "brown";
732
768
  brown_background: "brown_background";
733
- default: "default";
734
769
  gray: "gray";
735
770
  gray_background: "gray_background";
736
771
  green: "green";
@@ -761,11 +796,11 @@ export declare const pageSchema: z.ZodObject<{
761
796
  underline: z.ZodBoolean;
762
797
  code: z.ZodBoolean;
763
798
  color: z.ZodEnum<{
799
+ default: "default";
764
800
  blue: "blue";
765
801
  blue_background: "blue_background";
766
802
  brown: "brown";
767
803
  brown_background: "brown_background";
768
- default: "default";
769
804
  gray: "gray";
770
805
  gray_background: "gray_background";
771
806
  green: "green";
@@ -812,6 +847,7 @@ export declare const pageSchema: z.ZodObject<{
812
847
  avatar_url: z.ZodOptional<z.ZodUnion<readonly [z.ZodURL, z.ZodNull]>>;
813
848
  person: z.ZodObject<{
814
849
  email: z.ZodEmail;
850
+ email_verified: z.ZodOptional<z.ZodBoolean>;
815
851
  }, z.core.$strip>;
816
852
  }, z.core.$strip>, z.ZodObject<{
817
853
  object: z.ZodLiteral<"user">;
@@ -859,8 +895,14 @@ export declare const pageSchema: z.ZodObject<{
859
895
  }, z.core.$strip>, z.ZodObject<{
860
896
  type: z.ZodLiteral<"block_id">;
861
897
  block_id: z.ZodUUID;
898
+ }, z.core.$strip>, z.ZodObject<{
899
+ type: z.ZodLiteral<"agent_id">;
900
+ agent_id: z.ZodUUID;
862
901
  }, z.core.$strip>], "type">;
863
902
  url: z.ZodURL;
864
903
  public_url: z.ZodNullable<z.ZodURL>;
865
904
  }, z.core.$strip>;
905
+ /**
906
+ * @category Pages
907
+ */
866
908
  export type NotionPage = z.infer<typeof pageSchema>;
@@ -35,8 +35,8 @@ var __importStar = (this && this.__importStar) || (function () {
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.pageSchema = void 0;
37
37
  const z = __importStar(require("zod"));
38
- const emoji_schema_1 = require("./emoji.schema");
39
38
  const file_schema_1 = require("./file.schema");
39
+ const icon_schema_1 = require("./icon.schema");
40
40
  const pageProperties_schema_1 = require("./pageProperties.schema");
41
41
  const parent_schema_1 = require("./parent.schema");
42
42
  const shared_schema_1 = require("./shared.schema");
@@ -49,6 +49,8 @@ const user_schema_1 = require("./user.schema");
49
49
  *
50
50
  * Notion API reference:
51
51
  * https://developers.notion.com/reference/page
52
+ *
53
+ * @category Pages
52
54
  */
53
55
  exports.pageSchema = z.object({
54
56
  object: z.literal('page'),
@@ -58,7 +60,9 @@ exports.pageSchema = z.object({
58
60
  last_edited_time: shared_schema_1.notionDateStringSchema,
59
61
  last_edited_by: user_schema_1.userSchema,
60
62
  in_trash: z.boolean(),
61
- icon: z.nullable(z.union([file_schema_1.fileSchema, emoji_schema_1.emojiSchema])),
63
+ is_archived: z.boolean().optional(),
64
+ is_locked: z.boolean().optional(),
65
+ icon: z.nullable(icon_schema_1.iconSchema),
62
66
  cover: z.nullable(file_schema_1.fileSchema),
63
67
  properties: z.record(z.string().trim(), pageProperties_schema_1.pagePropertiesSchema),
64
68
  parent: parent_schema_1.parentSchema,
@@ -0,0 +1,70 @@
1
+ import * as z from 'zod';
2
+ /**
3
+ * Page markdown content schemas.
4
+ *
5
+ * `GET`/`PATCH /v1/pages/{page_id}/markdown` read and write a page's content as
6
+ * markdown directly, as an alternative to the block-tree `children` representation.
7
+ *
8
+ * Notion API reference:
9
+ * https://developers.notion.com/guides/data-apis/working-with-markdown-content
10
+ *
11
+ * @category Pages
12
+ */
13
+ export declare const pageMarkdownSchema: z.ZodObject<{
14
+ object: z.ZodLiteral<"page_markdown">;
15
+ id: z.ZodUUID;
16
+ markdown: z.ZodString;
17
+ truncated: z.ZodBoolean;
18
+ unknown_block_ids: z.ZodArray<z.ZodUUID>;
19
+ }, z.core.$strip>;
20
+ /**
21
+ * @category Pages
22
+ */
23
+ export type PageMarkdown = z.infer<typeof pageMarkdownSchema>;
24
+ /**
25
+ * `PATCH /v1/pages/{page_id}/markdown` returns `pageMarkdownSchema` synchronously. If
26
+ * `allow_async: true` triggers async processing, it returns an `async_task` handle
27
+ * instead. Poll the handle through {@link AsyncTasksAPI}. Both response bodies carry a
28
+ * literal `object` field, so you can discriminate between them without checking the
29
+ * HTTP status code.
30
+ *
31
+ * @category Pages
32
+ */
33
+ export declare const markdownContentResponseSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
34
+ object: z.ZodLiteral<"page_markdown">;
35
+ id: z.ZodUUID;
36
+ markdown: z.ZodString;
37
+ truncated: z.ZodBoolean;
38
+ unknown_block_ids: z.ZodArray<z.ZodUUID>;
39
+ }, z.core.$strip>, z.ZodObject<{
40
+ object: z.ZodLiteral<"async_task">;
41
+ id: z.ZodUUID;
42
+ status: z.ZodEnum<{
43
+ queued: "queued";
44
+ running: "running";
45
+ retrying: "retrying";
46
+ succeeded: "succeeded";
47
+ failed: "failed";
48
+ }>;
49
+ status_url: z.ZodURL;
50
+ created_time: z.ZodUnion<readonly [z.ZodISODateTime, z.ZodISODate]>;
51
+ operation: z.ZodObject<{
52
+ surface: z.ZodEnum<{
53
+ rest: "rest";
54
+ mcp: "mcp";
55
+ }>;
56
+ name: z.ZodString;
57
+ }, z.core.$strip>;
58
+ poll_after_seconds: z.ZodOptional<z.ZodNumber>;
59
+ result: z.ZodOptional<z.ZodUnknown>;
60
+ error: z.ZodOptional<z.ZodObject<{
61
+ object: z.ZodLiteral<"error">;
62
+ status: z.ZodNumber;
63
+ code: z.ZodString;
64
+ message: z.ZodString;
65
+ }, z.core.$strip>>;
66
+ }, z.core.$strip>], "object">;
67
+ /**
68
+ * @category Pages
69
+ */
70
+ export type MarkdownContentResponse = z.infer<typeof markdownContentResponseSchema>;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
35
+ Object.defineProperty(exports, "__esModule", { value: true });
36
+ exports.markdownContentResponseSchema = exports.pageMarkdownSchema = void 0;
37
+ const z = __importStar(require("zod"));
38
+ const asyncTask_schema_1 = require("./asyncTask.schema");
39
+ /**
40
+ * Page markdown content schemas.
41
+ *
42
+ * `GET`/`PATCH /v1/pages/{page_id}/markdown` read and write a page's content as
43
+ * markdown directly, as an alternative to the block-tree `children` representation.
44
+ *
45
+ * Notion API reference:
46
+ * https://developers.notion.com/guides/data-apis/working-with-markdown-content
47
+ *
48
+ * @category Pages
49
+ */
50
+ exports.pageMarkdownSchema = z.object({
51
+ object: z.literal('page_markdown'),
52
+ id: z.uuid(),
53
+ // eslint-disable-next-line zod/prefer-string-schema-with-trim -- markdown content must preserve leading/trailing whitespace and newlines
54
+ markdown: z.string(),
55
+ truncated: z.boolean(),
56
+ unknown_block_ids: z.array(z.uuid()).max(100),
57
+ });
58
+ /**
59
+ * `PATCH /v1/pages/{page_id}/markdown` returns `pageMarkdownSchema` synchronously. If
60
+ * `allow_async: true` triggers async processing, it returns an `async_task` handle
61
+ * instead. Poll the handle through {@link AsyncTasksAPI}. Both response bodies carry a
62
+ * literal `object` field, so you can discriminate between them without checking the
63
+ * HTTP status code.
64
+ *
65
+ * @category Pages
66
+ */
67
+ exports.markdownContentResponseSchema = z.discriminatedUnion('object', [
68
+ exports.pageMarkdownSchema,
69
+ asyncTask_schema_1.asyncTaskSchema,
70
+ ]);