@nakanoaas/notion-valibot-schema 0.0.3 → 0.0.5

package/README.md

@@ -1,5 +1,7 @@
 # Notion Valibot Schema
 
+[![npm](https://img.shields.io/npm/v/%40nakanoaas%2Fnotion-valibot-schema)](https://www.npmjs.com/package/@nakanoaas/notion-valibot-schema) [![JSR](https://jsr.io/badges/@nakanoaas/notion-valibot-schema)](https://jsr.io/@nakanoaas/notion-valibot-schema)
+
 A small collection of **[Valibot](https://github.com/fabian-hiller/valibot)** schemas for the Notion API.
 
 It helps you **validate and transform** Notion `properties` into plain JavaScript values (e.g. `string`, `number`, `Date`, `string[]`) so you can work with the results without dealing with Notion’s nested property shapes.
@@ -30,38 +32,38 @@ deno add @nakanoaas/notion-valibot-schema @valibot/valibot
 
 ### Parse a Notion database page (common pattern)
 
-This example shows how to parse a page returned by `notion.pages.retrieve()` (or an item from `notion.databases.query().results`) and turn its `properties` into plain values.
+This example shows how to parse a page returned by `notion.pages.retrieve()` (or an item from `notion.dataSources.query().results`) and turn its `properties` into plain values.
 
 ```ts
 import * as v from "valibot";
 import {
-	CheckboxSchema,
-	FilesSchema,
-	MultiSelectSchema,
-	NullableDateSchema,
-	NullableNumberSchema,
-	NullableStatusSchema,
-	NullableUrlSchema,
-	RelationSchema,
-	RichTextSchema,
-	TitleSchema,
+  CheckboxSchema,
+  FilesSchema,
+  MultiSelectSchema,
+  NullableDateSchema,
+  NullableNumberSchema,
+  NullableUrlSchema,
+  RelationSchema,
+  RichTextSchema,
+  StatusSchema,
+  TitleSchema,
 } from "@nakanoaas/notion-valibot-schema";
 
 // Property keys must match your database property names exactly.
 const NotionTaskPageSchema = v.object({
-	id: v.string(),
-	properties: v.object({
-		Name: TitleSchema, // -> string
-		Notes: RichTextSchema, // -> string
-		Status: NullableStatusSchema(v.string()), // -> string | null
-		Tags: MultiSelectSchema(v.string()), // -> string[]
-		Due: NullableDateSchema, // -> Date | null
-		Points: NullableNumberSchema, // -> number | null
-		Done: CheckboxSchema, // -> boolean
-		Website: NullableUrlSchema, // -> string | null
-		Attachments: FilesSchema, // -> string[] (URLs)
-		Related: RelationSchema, // -> string[] (page IDs)
-	}),
+  id: v.string(),
+  properties: v.object({
+    Name: TitleSchema, // -> string
+    Notes: RichTextSchema, // -> string
+    Status: StatusSchema(v.picklist(["ToDo", "In Progress", "Done"])), // -> "ToDo" | "In Progress" | "Done"
+    Tags: MultiSelectSchema(v.string()), // -> string[]
+    Due: NullableDateSchema, // -> Date | null
+    Points: NullableNumberSchema, // -> number | null
+    Done: CheckboxSchema, // -> boolean
+    Website: NullableUrlSchema, // -> string | null
+    Attachments: FilesSchema, // -> string[] (URLs)
+    Related: RelationSchema, // -> string[] (page IDs)
+  }),
 });
 
 // Fetch a page with the Notion SDK

package/dist/checkbox.cjs

@@ -3,6 +3,35 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/checkbox.ts
+/**
+* Schema to extract the `checkbox` property from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   checkbox: boolean;
+* }
+* ```
+*
+* **Output:** `boolean`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CheckboxSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Checkbox: CheckboxSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Checkbox: boolean
+* ```
+*/
 const CheckboxSchema = valibot.pipe(valibot.object({ checkbox: valibot.boolean() }), valibot.transform((v) => v.checkbox));
 
 //#endregion

package/dist/checkbox.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkbox.cjs","names":["v"],"sources":["../src/checkbox.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const CheckboxSchema = v.pipe(\n\tv.object({\n\t\tcheckbox: v.boolean(),\n\t}),\n\tv.transform((v) => v.checkbox),\n);\n"],"mappings":";;;;;AAEA,MAAa,iBAAiBA,QAAE,KAC/BA,QAAE,OAAO,EACR,UAAUA,QAAE,SAAS,EACrB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,CAC9B"}
+{"version":3,"file":"checkbox.cjs","names":["v"],"sources":["../src/checkbox.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `checkbox` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   checkbox: boolean;\n * }\n * ```\n *\n * **Output:** `boolean`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CheckboxSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Checkbox: CheckboxSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Checkbox: boolean\n * ```\n */\nexport const CheckboxSchema = v.pipe(\n\tv.object({\n\t\tcheckbox: v.boolean(),\n\t}),\n\tv.transform((v) => v.checkbox),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,iBAAiBA,QAAE,KAC/BA,QAAE,OAAO,EACR,UAAUA,QAAE,SAAS,EACrB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,CAC9B"}

package/dist/checkbox.d.cts

@@ -1,6 +1,36 @@
 import * as v from "valibot";
 
 //#region src/checkbox.d.ts
+
+/**
+ * Schema to extract the `checkbox` property from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   checkbox: boolean;
+ * }
+ * ```
+ *
+ * **Output:** `boolean`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CheckboxSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Checkbox: CheckboxSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Checkbox: boolean
+ * ```
+ */
 declare const CheckboxSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly checkbox: v.BooleanSchema<undefined>;
 }, undefined>, v.TransformAction<{

package/dist/checkbox.d.mts

@@ -1,6 +1,36 @@
 import * as v from "valibot";
 
 //#region src/checkbox.d.ts
+
+/**
+ * Schema to extract the `checkbox` property from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   checkbox: boolean;
+ * }
+ * ```
+ *
+ * **Output:** `boolean`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CheckboxSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Checkbox: CheckboxSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Checkbox: boolean
+ * ```
+ */
 declare const CheckboxSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly checkbox: v.BooleanSchema<undefined>;
 }, undefined>, v.TransformAction<{

package/dist/checkbox.mjs

@@ -1,6 +1,35 @@
 import * as v from "valibot";
 
 //#region src/checkbox.ts
+/**
+* Schema to extract the `checkbox` property from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   checkbox: boolean;
+* }
+* ```
+*
+* **Output:** `boolean`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CheckboxSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Checkbox: CheckboxSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Checkbox: boolean
+* ```
+*/
 const CheckboxSchema = v.pipe(v.object({ checkbox: v.boolean() }), v.transform((v$1) => v$1.checkbox));
 
 //#endregion

package/dist/checkbox.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkbox.mjs","names":["v"],"sources":["../src/checkbox.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const CheckboxSchema = v.pipe(\n\tv.object({\n\t\tcheckbox: v.boolean(),\n\t}),\n\tv.transform((v) => v.checkbox),\n);\n"],"mappings":";;;AAEA,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,UAAU,EAAE,SAAS,EACrB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,CAC9B"}
+{"version":3,"file":"checkbox.mjs","names":["v"],"sources":["../src/checkbox.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `checkbox` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   checkbox: boolean;\n * }\n * ```\n *\n * **Output:** `boolean`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CheckboxSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Checkbox: CheckboxSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Checkbox: boolean\n * ```\n */\nexport const CheckboxSchema = v.pipe(\n\tv.object({\n\t\tcheckbox: v.boolean(),\n\t}),\n\tv.transform((v) => v.checkbox),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,UAAU,EAAE,SAAS,EACrB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,CAC9B"}

package/dist/created-by.cjs

@@ -4,7 +4,82 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/created-by.ts
+/**
+* Schema to extract the `created_by` person object from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   created_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   id: string;
+*   object: "user" | "bot" | "group";
+*   name: string | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CreatedBySchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     CreatedBy: CreatedBySchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.CreatedBy: { id: string; object: "user" | "bot" | "group"; name: string | null }
+* ```
+*/
 const CreatedBySchema = valibot.pipe(valibot.object({ created_by: require_people.PersonSchema }), valibot.transform((v) => v.created_by));
+/**
+* Schema to extract the `created_by` person ID from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   created_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CreatedByIdSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     CreatedById: CreatedByIdSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.CreatedById: string
+* ```
+*/
 const CreatedByIdSchema = valibot.pipe(valibot.object({ created_by: require_people.PersonSchema }), valibot.transform((v) => v.created_by.id));
 
 //#endregion

package/dist/created-by.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"created-by.cjs","names":["v","PersonSchema"],"sources":["../src/created-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\nexport const CreatedBySchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by),\n);\n\nexport const CreatedByIdSchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by.id),\n);\n"],"mappings":";;;;;;AAIA,MAAa,kBAAkBA,QAAE,KAChCA,QAAE,OAAO,EACR,YAAYC,6BACZ,CAAC,EACFD,QAAE,WAAW,MAAM,EAAE,WAAW,CAChC;AAED,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,YAAYC,6BACZ,CAAC,EACFD,QAAE,WAAW,MAAM,EAAE,WAAW,GAAG,CACnC"}
+{"version":3,"file":"created-by.cjs","names":["v","PersonSchema"],"sources":["../src/created-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\n/**\n * Schema to extract the `created_by` person object from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   created_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   id: string;\n *   object: \"user\" | \"bot\" | \"group\";\n *   name: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CreatedBySchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     CreatedBy: CreatedBySchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.CreatedBy: { id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }\n * ```\n */\nexport const CreatedBySchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by),\n);\n\n/**\n * Schema to extract the `created_by` person ID from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   created_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CreatedByIdSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     CreatedById: CreatedByIdSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.CreatedById: string\n * ```\n */\nexport const CreatedByIdSchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by.id),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAa,kBAAkBA,QAAE,KAChCA,QAAE,OAAO,EACR,YAAYC,6BACZ,CAAC,EACFD,QAAE,WAAW,MAAM,EAAE,WAAW,CAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCD,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,YAAYC,6BACZ,CAAC,EACFD,QAAE,WAAW,MAAM,EAAE,WAAW,GAAG,CACnC"}

package/dist/created-by.d.cts

@@ -1,6 +1,48 @@
 import * as v from "valibot";
 
 //#region src/created-by.d.ts
+
+/**
+ * Schema to extract the `created_by` person object from a Notion page.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   created_by: {
+ *     id: string;
+ *     object: "user" | "bot" | "group";
+ *     name: string | null;
+ *     ...
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   id: string;
+ *   object: "user" | "bot" | "group";
+ *   name: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CreatedBySchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     CreatedBy: CreatedBySchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.CreatedBy: { id: string; object: "user" | "bot" | "group"; name: string | null }
+ * ```
+ */
 declare const CreatedBySchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly created_by: v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -18,6 +60,40 @@ declare const CreatedBySchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   object: "user" | "bot" | "group";
   name: string | null;
 }>]>;
+/**
+ * Schema to extract the `created_by` person ID from a Notion page.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   created_by: {
+ *     id: string;
+ *     object: "user" | "bot" | "group";
+ *     name: string | null;
+ *     ...
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CreatedByIdSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     CreatedById: CreatedByIdSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.CreatedById: string
+ * ```
+ */
 declare const CreatedByIdSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly created_by: v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/created-by.d.mts

@@ -1,6 +1,48 @@
 import * as v from "valibot";
 
 //#region src/created-by.d.ts
+
+/**
+ * Schema to extract the `created_by` person object from a Notion page.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   created_by: {
+ *     id: string;
+ *     object: "user" | "bot" | "group";
+ *     name: string | null;
+ *     ...
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   id: string;
+ *   object: "user" | "bot" | "group";
+ *   name: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CreatedBySchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     CreatedBy: CreatedBySchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.CreatedBy: { id: string; object: "user" | "bot" | "group"; name: string | null }
+ * ```
+ */
 declare const CreatedBySchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly created_by: v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -18,6 +60,40 @@ declare const CreatedBySchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   object: "user" | "bot" | "group";
   name: string | null;
 }>]>;
+/**
+ * Schema to extract the `created_by` person ID from a Notion page.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   created_by: {
+ *     id: string;
+ *     object: "user" | "bot" | "group";
+ *     name: string | null;
+ *     ...
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CreatedByIdSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     CreatedById: CreatedByIdSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.CreatedById: string
+ * ```
+ */
 declare const CreatedByIdSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly created_by: v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/created-by.mjs

@@ -2,7 +2,82 @@ import { PersonSchema } from "./people.mjs";
 import * as v from "valibot";
 
 //#region src/created-by.ts
+/**
+* Schema to extract the `created_by` person object from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   created_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   id: string;
+*   object: "user" | "bot" | "group";
+*   name: string | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CreatedBySchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     CreatedBy: CreatedBySchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.CreatedBy: { id: string; object: "user" | "bot" | "group"; name: string | null }
+* ```
+*/
 const CreatedBySchema = v.pipe(v.object({ created_by: PersonSchema }), v.transform((v$1) => v$1.created_by));
+/**
+* Schema to extract the `created_by` person ID from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   created_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CreatedByIdSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     CreatedById: CreatedByIdSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.CreatedById: string
+* ```
+*/
 const CreatedByIdSchema = v.pipe(v.object({ created_by: PersonSchema }), v.transform((v$1) => v$1.created_by.id));
 
 //#endregion

package/dist/created-by.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"created-by.mjs","names":["v"],"sources":["../src/created-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\nexport const CreatedBySchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by),\n);\n\nexport const CreatedByIdSchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by.id),\n);\n"],"mappings":";;;;AAIA,MAAa,kBAAkB,EAAE,KAChC,EAAE,OAAO,EACR,YAAY,cACZ,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,WAAW,CAChC;AAED,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,YAAY,cACZ,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,WAAW,GAAG,CACnC"}
+{"version":3,"file":"created-by.mjs","names":["v"],"sources":["../src/created-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\n/**\n * Schema to extract the `created_by` person object from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   created_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   id: string;\n *   object: \"user\" | \"bot\" | \"group\";\n *   name: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CreatedBySchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     CreatedBy: CreatedBySchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.CreatedBy: { id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }\n * ```\n */\nexport const CreatedBySchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by),\n);\n\n/**\n * Schema to extract the `created_by` person ID from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   created_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CreatedByIdSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     CreatedById: CreatedByIdSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.CreatedById: string\n * ```\n */\nexport const CreatedByIdSchema = v.pipe(\n\tv.object({\n\t\tcreated_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.created_by.id),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6CA,MAAa,kBAAkB,EAAE,KAChC,EAAE,OAAO,EACR,YAAY,cACZ,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,WAAW,CAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCD,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,YAAY,cACZ,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,WAAW,GAAG,CACnC"}

package/dist/created-time.cjs

@@ -3,6 +3,33 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/created-time.ts
+/**
+* Schema to extract the `created_time` property from a Notion page and transform it to a `Date` object.
+*
+* **Input:**
+* ```
+* {
+*   created_time: string;
+* }
+* ```
+*
+* **Output:** `Date`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { CreatedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   created_time: CreatedTimeSchema,
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.created_time: Date
+* ```
+*/
 const CreatedTimeSchema = valibot.pipe(valibot.object({ created_time: valibot.string() }), valibot.transform((v) => new Date(v.created_time)));
 
 //#endregion

package/dist/created-time.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"created-time.cjs","names":["v"],"sources":["../src/created-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const CreatedTimeSchema = v.pipe(\n\tv.object({\n\t\tcreated_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.created_time)),\n);\n"],"mappings":";;;;;AAEA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,cAAcA,QAAE,QAAQ,EACxB,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,aAAa,CAAC,CAC5C"}
+{"version":3,"file":"created-time.cjs","names":["v"],"sources":["../src/created-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `created_time` property from a Notion page and transform it to a `Date` object.\n *\n * **Input:**\n * ```\n * {\n *   created_time: string;\n * }\n * ```\n *\n * **Output:** `Date`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { CreatedTimeSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   created_time: CreatedTimeSchema,\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.created_time: Date\n * ```\n */\nexport const CreatedTimeSchema = v.pipe(\n\tv.object({\n\t\tcreated_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.created_time)),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,cAAcA,QAAE,QAAQ,EACxB,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,aAAa,CAAC,CAC5C"}

package/dist/created-time.d.cts

@@ -1,6 +1,34 @@
 import * as v from "valibot";
 
 //#region src/created-time.d.ts
+
+/**
+ * Schema to extract the `created_time` property from a Notion page and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   created_time: string;
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { CreatedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   created_time: CreatedTimeSchema,
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.created_time: Date
+ * ```
+ */
 declare const CreatedTimeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly created_time: v.StringSchema<undefined>;
 }, undefined>, v.TransformAction<{