@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.5

package/dist/text.d.mts

@@ -1,6 +1,38 @@
 import * as v from "valibot";
 
 //#region src/text.d.ts
+
+/**
+ * Schema to extract the `title` property from a Notion page property and transform it to a string.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   title: Array<{
+ *     plain_text: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { TitleSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Title: TitleSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Title: string
+ * ```
+ */
 declare const TitleSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly title: v.ArraySchema<v.ObjectSchema<{
     readonly plain_text: v.StringSchema<undefined>;
@@ -10,6 +42,37 @@ declare const TitleSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     plain_text: string;
   }[];
 }, string>]>;
+/**
+ * Schema to extract the `rich_text` property from a Notion page property and transform it to a string.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rich_text: Array<{
+ *     plain_text: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Description: RichTextSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Description: string
+ * ```
+ */
 declare const RichTextSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly rich_text: v.ArraySchema<v.ObjectSchema<{
     readonly plain_text: v.StringSchema<undefined>;

package/dist/text.mjs

@@ -1,8 +1,108 @@
 import * as v from "valibot";
 
 //#region src/text.ts
+/**
+* Schema for a Notion rich text array structure.
+*
+* **Input:**
+* ```
+* Array<{
+*   plain_text: string;
+* }>
+* ```
+*
+* **Output:**
+* ```
+* Array<{
+*   plain_text: string;
+* }>
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RichTextArraySchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Text: v.object({
+*       rich_text: RichTextArraySchema,
+*     }),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Text.rich_text: Array<{ plain_text: string }>
+* ```
+*
+* @internal
+*/
 const RichTextArraySchema = v.array(v.object({ plain_text: v.string() }));
+/**
+* Schema to extract the `title` property from a Notion page property and transform it to a string.
+*
+* **Input:**
+* ```
+* {
+*   title: Array<{
+*     plain_text: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { TitleSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Title: TitleSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Title: string
+* ```
+*/
 const TitleSchema = v.pipe(v.object({ title: RichTextArraySchema }), v.transform((v$1) => v$1.title.map((v$2) => v$2.plain_text).join("")));
+/**
+* Schema to extract the `rich_text` property from a Notion page property and transform it to a string.
+*
+* **Input:**
+* ```
+* {
+*   rich_text: Array<{
+*     plain_text: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Description: RichTextSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Description: string
+* ```
+*/
 const RichTextSchema = v.pipe(v.object({ rich_text: RichTextArraySchema }), v.transform((v$1) => v$1.rich_text.map((v$2) => v$2.plain_text).join("")));
 
 //#endregion

package/dist/text.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"text.mjs","names":["v"],"sources":["../src/text.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nconst RichTextArraySchema = v.array(\n\tv.object({\n\t\tplain_text: v.string(),\n\t}),\n);\n\nexport const TitleSchema = v.pipe(\n\tv.object({\n\t\ttitle: RichTextArraySchema,\n\t}),\n\tv.transform((v) => v.title.map((v) => v.plain_text).join(\"\")),\n);\n\nexport const RichTextSchema = v.pipe(\n\tv.object({\n\t\trich_text: RichTextArraySchema,\n\t}),\n\tv.transform((v) => v.rich_text.map((v) => v.plain_text).join(\"\")),\n);\n"],"mappings":";;;AAEA,MAAM,sBAAsB,EAAE,MAC7B,EAAE,OAAO,EACR,YAAY,EAAE,QAAQ,EACtB,CAAC,CACF;AAED,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,qBACP,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,KAAK,QAAMA,IAAE,WAAW,CAAC,KAAK,GAAG,CAAC,CAC7D;AAED,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,WAAW,qBACX,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,KAAK,QAAMA,IAAE,WAAW,CAAC,KAAK,GAAG,CAAC,CACjE"}
+{"version":3,"file":"text.mjs","names":["v"],"sources":["../src/text.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion rich text array structure.\n *\n * **Input:**\n * ```\n * Array<{\n *   plain_text: string;\n * }>\n * ```\n *\n * **Output:**\n * ```\n * Array<{\n *   plain_text: string;\n * }>\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RichTextArraySchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Text: v.object({\n *       rich_text: RichTextArraySchema,\n *     }),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Text.rich_text: Array<{ plain_text: string }>\n * ```\n *\n * @internal\n */\nconst RichTextArraySchema = v.array(\n\tv.object({\n\t\tplain_text: v.string(),\n\t}),\n);\n\n/**\n * Schema to extract the `title` property from a Notion page property and transform it to a string.\n *\n * **Input:**\n * ```\n * {\n *   title: Array<{\n *     plain_text: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { TitleSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Title: TitleSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Title: string\n * ```\n */\nexport const TitleSchema = v.pipe(\n\tv.object({\n\t\ttitle: RichTextArraySchema,\n\t}),\n\tv.transform((v) => v.title.map((v) => v.plain_text).join(\"\")),\n);\n\n/**\n * Schema to extract the `rich_text` property from a Notion page property and transform it to a string.\n *\n * **Input:**\n * ```\n * {\n *   rich_text: Array<{\n *     plain_text: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RichTextSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Description: RichTextSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Description: string\n * ```\n */\nexport const RichTextSchema = v.pipe(\n\tv.object({\n\t\trich_text: RichTextArraySchema,\n\t}),\n\tv.transform((v) => v.rich_text.map((v) => v.plain_text).join(\"\")),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAM,sBAAsB,EAAE,MAC7B,EAAE,OAAO,EACR,YAAY,EAAE,QAAQ,EACtB,CAAC,CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,qBACP,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,KAAK,QAAMA,IAAE,WAAW,CAAC,KAAK,GAAG,CAAC,CAC7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,WAAW,qBACX,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,KAAK,QAAMA,IAAE,WAAW,CAAC,KAAK,GAAG,CAAC,CACjE"}

package/dist/unique-id.cjs

@@ -3,7 +3,76 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/unique-id.ts
+/**
+* Schema to extract the `unique_id` property number from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   unique_id: {
+*     number: number;
+*   };
+* }
+* ```
+*
+* **Output:** `number`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { UniqueIdNumberSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ID: UniqueIdNumberSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ID: number
+* ```
+*/
 const UniqueIdNumberSchema = valibot.pipe(valibot.object({ unique_id: valibot.object({ number: valibot.number() }) }), valibot.transform((v) => v.unique_id.number));
+/**
+* Schema to extract the `unique_id` property from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   unique_id: {
+*     prefix: string | null;
+*     number: number | null;
+*   };
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   prefix: string | null;
+*   number: number | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableUniqueIdSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ID: NullableUniqueIdSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ID: { prefix: string | null; number: number | null }
+* ```
+*/
 const NullableUniqueIdSchema = valibot.pipe(valibot.object({ unique_id: valibot.object({
 	prefix: valibot.nullable(valibot.string()),
 	number: valibot.nullable(valibot.number())

package/dist/unique-id.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"unique-id.cjs","names":["v"],"sources":["../src/unique-id.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const UniqueIdNumberSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id.number),\n);\n\nexport const NullableUniqueIdSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tprefix: v.nullable(v.string()),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id),\n);\n"],"mappings":";;;;;AAEA,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,WAAWA,QAAE,OAAO,EACnB,QAAQA,QAAE,QAAQ,EAClB,CAAC,EACF,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,UAAU,OAAO,CACtC;AAED,MAAa,yBAAyBA,QAAE,KACvCA,QAAE,OAAO,EACR,WAAWA,QAAE,OAAO;CACnB,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC9B,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,UAAU,CAC/B"}
+{"version":3,"file":"unique-id.cjs","names":["v"],"sources":["../src/unique-id.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `unique_id` property number from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   unique_id: {\n *     number: number;\n *   };\n * }\n * ```\n *\n * **Output:** `number`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { UniqueIdNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ID: UniqueIdNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ID: number\n * ```\n */\nexport const UniqueIdNumberSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id.number),\n);\n\n/**\n * Schema to extract the `unique_id` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   unique_id: {\n *     prefix: string | null;\n *     number: number | null;\n *   };\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   prefix: string | null;\n *   number: number | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableUniqueIdSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ID: NullableUniqueIdSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ID: { prefix: string | null; number: number | null }\n * ```\n */\nexport const NullableUniqueIdSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tprefix: v.nullable(v.string()),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,WAAWA,QAAE,OAAO,EACnB,QAAQA,QAAE,QAAQ,EAClB,CAAC,EACF,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,UAAU,OAAO,CACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCD,MAAa,yBAAyBA,QAAE,KACvCA,QAAE,OAAO,EACR,WAAWA,QAAE,OAAO;CACnB,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC9B,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,UAAU,CAC/B"}

package/dist/unique-id.d.cts

@@ -1,6 +1,38 @@
 import * as v from "valibot";
 
 //#region src/unique-id.d.ts
+
+/**
+ * Schema to extract the `unique_id` property number from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   unique_id: {
+ *     number: number;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `number`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { UniqueIdNumberSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ID: UniqueIdNumberSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ID: number
+ * ```
+ */
 declare const UniqueIdNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly unique_id: v.ObjectSchema<{
     readonly number: v.NumberSchema<undefined>;
@@ -10,6 +42,44 @@ declare const UniqueIdNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     number: number;
   };
 }, number>]>;
+/**
+ * Schema to extract the `unique_id` property from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   unique_id: {
+ *     prefix: string | null;
+ *     number: number | null;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   prefix: string | null;
+ *   number: number | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableUniqueIdSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ID: NullableUniqueIdSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ID: { prefix: string | null; number: number | null }
+ * ```
+ */
 declare const NullableUniqueIdSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly unique_id: v.ObjectSchema<{
     readonly prefix: v.NullableSchema<v.StringSchema<undefined>, undefined>;

package/dist/unique-id.d.mts

@@ -1,6 +1,38 @@
 import * as v from "valibot";
 
 //#region src/unique-id.d.ts
+
+/**
+ * Schema to extract the `unique_id` property number from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   unique_id: {
+ *     number: number;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `number`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { UniqueIdNumberSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ID: UniqueIdNumberSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ID: number
+ * ```
+ */
 declare const UniqueIdNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly unique_id: v.ObjectSchema<{
     readonly number: v.NumberSchema<undefined>;
@@ -10,6 +42,44 @@ declare const UniqueIdNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     number: number;
   };
 }, number>]>;
+/**
+ * Schema to extract the `unique_id` property from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   unique_id: {
+ *     prefix: string | null;
+ *     number: number | null;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   prefix: string | null;
+ *   number: number | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableUniqueIdSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ID: NullableUniqueIdSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ID: { prefix: string | null; number: number | null }
+ * ```
+ */
 declare const NullableUniqueIdSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly unique_id: v.ObjectSchema<{
     readonly prefix: v.NullableSchema<v.StringSchema<undefined>, undefined>;

package/dist/unique-id.mjs

@@ -1,7 +1,76 @@
 import * as v from "valibot";
 
 //#region src/unique-id.ts
+/**
+* Schema to extract the `unique_id` property number from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   unique_id: {
+*     number: number;
+*   };
+* }
+* ```
+*
+* **Output:** `number`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { UniqueIdNumberSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ID: UniqueIdNumberSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ID: number
+* ```
+*/
 const UniqueIdNumberSchema = v.pipe(v.object({ unique_id: v.object({ number: v.number() }) }), v.transform((v$1) => v$1.unique_id.number));
+/**
+* Schema to extract the `unique_id` property from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   unique_id: {
+*     prefix: string | null;
+*     number: number | null;
+*   };
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   prefix: string | null;
+*   number: number | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableUniqueIdSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ID: NullableUniqueIdSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ID: { prefix: string | null; number: number | null }
+* ```
+*/
 const NullableUniqueIdSchema = v.pipe(v.object({ unique_id: v.object({
 	prefix: v.nullable(v.string()),
 	number: v.nullable(v.number())

package/dist/unique-id.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"unique-id.mjs","names":["v"],"sources":["../src/unique-id.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const UniqueIdNumberSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id.number),\n);\n\nexport const NullableUniqueIdSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tprefix: v.nullable(v.string()),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id),\n);\n"],"mappings":";;;AAEA,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,WAAW,EAAE,OAAO,EACnB,QAAQ,EAAE,QAAQ,EAClB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,OAAO,CACtC;AAED,MAAa,yBAAyB,EAAE,KACvC,EAAE,OAAO,EACR,WAAW,EAAE,OAAO;CACnB,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,CAC/B"}
+{"version":3,"file":"unique-id.mjs","names":["v"],"sources":["../src/unique-id.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `unique_id` property number from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   unique_id: {\n *     number: number;\n *   };\n * }\n * ```\n *\n * **Output:** `number`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { UniqueIdNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ID: UniqueIdNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ID: number\n * ```\n */\nexport const UniqueIdNumberSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id.number),\n);\n\n/**\n * Schema to extract the `unique_id` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   unique_id: {\n *     prefix: string | null;\n *     number: number | null;\n *   };\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   prefix: string | null;\n *   number: number | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableUniqueIdSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ID: NullableUniqueIdSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ID: { prefix: string | null; number: number | null }\n * ```\n */\nexport const NullableUniqueIdSchema = v.pipe(\n\tv.object({\n\t\tunique_id: v.object({\n\t\t\tprefix: v.nullable(v.string()),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.unique_id),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,WAAW,EAAE,OAAO,EACnB,QAAQ,EAAE,QAAQ,EAClB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,OAAO,CACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCD,MAAa,yBAAyB,EAAE,KACvC,EAAE,OAAO,EACR,WAAW,EAAE,OAAO;CACnB,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,UAAU,CAC/B"}

package/dist/url.cjs

@@ -3,7 +3,65 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/url.ts
+/**
+* Schema to extract the `url` property from a Notion page property or `null`.
+*
+* **Input:**
+* ```
+* {
+*   url: string | null;
+* }
+* ```
+*
+* **Output:** `string | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableUrlSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Website: NullableUrlSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Website: string | null
+* ```
+*/
 const NullableUrlSchema = valibot.pipe(valibot.object({ url: valibot.nullable(valibot.string()) }), valibot.transform((v) => v.url));
+/**
+* Schema to extract the `url` property from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   url: string;
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { UrlSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Website: UrlSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Website: string
+* ```
+*/
 const UrlSchema = valibot.pipe(valibot.object({ url: valibot.string() }), valibot.transform((v) => v.url));
 
 //#endregion

package/dist/url.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"url.cjs","names":["v"],"sources":["../src/url.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const NullableUrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.url),\n);\n\nexport const UrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.string(),\n\t}),\n\tv.transform((v) => v.url),\n);\n"],"mappings":";;;;;AAEA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,KAAKA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC3B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,IAAI,CACzB;AAED,MAAa,YAAYA,QAAE,KAC1BA,QAAE,OAAO,EACR,KAAKA,QAAE,QAAQ,EACf,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,IAAI,CACzB"}
+{"version":3,"file":"url.cjs","names":["v"],"sources":["../src/url.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `url` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   url: string | null;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableUrlSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Website: NullableUrlSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Website: string | null\n * ```\n */\nexport const NullableUrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.url),\n);\n\n/**\n * Schema to extract the `url` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   url: string;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { UrlSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Website: UrlSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Website: string\n * ```\n */\nexport const UrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.string(),\n\t}),\n\tv.transform((v) => v.url),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,KAAKA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC3B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,IAAI,CACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,YAAYA,QAAE,KAC1BA,QAAE,OAAO,EACR,KAAKA,QAAE,QAAQ,EACf,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,IAAI,CACzB"}

package/dist/url.d.cts

@@ -1,11 +1,70 @@
 import * as v from "valibot";
 
 //#region src/url.d.ts
+
+/**
+ * Schema to extract the `url` property from a Notion page property or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   url: string | null;
+ * }
+ * ```
+ *
+ * **Output:** `string | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableUrlSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Website: NullableUrlSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Website: string | null
+ * ```
+ */
 declare const NullableUrlSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly url: v.NullableSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>, v.TransformAction<{
   url: string | null;
 }, string | null>]>;
+/**
+ * Schema to extract the `url` property from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   url: string;
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { UrlSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Website: UrlSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Website: string
+ * ```
+ */
 declare const UrlSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly url: v.StringSchema<undefined>;
 }, undefined>, v.TransformAction<{