@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.5

package/dist/date.cjs

@@ -3,18 +3,206 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/date.ts
+/**
+* Schema for a Notion date object structure.
+*
+* **Input:**
+* ```
+* {
+*   start: string;
+*   end: string | null;
+*   time_zone: string | null;
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   start: string;
+*   end: string | null;
+*   time_zone: string | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { DateObjectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Date: v.object({
+*       date: DateObjectSchema,
+*     }),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Date.date: { start: string; end: string | null; time_zone: string | null }
+* ```
+*
+* @internal
+*/
 const DateObjectSchema = valibot.object({
 	start: valibot.string(),
 	end: valibot.nullable(valibot.string()),
 	time_zone: valibot.nullable(valibot.string())
 });
+/**
+* Schema to extract the `date` property from a Notion page property and transform it to a `Date` object.
+*
+* **Input:**
+* ```
+* {
+*   date: {
+*     start: string;
+*     end: string | null;
+*     time_zone: string | null;
+*   }
+* }
+* ```
+*
+* **Output:** `Date`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { DateSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Date: DateSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Date: Date
+* ```
+*/
 const DateSchema = valibot.pipe(valibot.object({ date: DateObjectSchema }), valibot.transform((v) => new Date(v.date.start)));
+/**
+* Schema to extract the `date` property from a Notion page property and transform it to a `Date` object or `null`.
+*
+* **Input:**
+* ```
+* {
+*   date: {
+*     start: string;
+*     end: string | null;
+*     time_zone: string | null;
+*   } | null
+* }
+* ```
+*
+* **Output:** `Date | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableDateSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Date: NullableDateSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Date: Date | null
+* ```
+*/
 const NullableDateSchema = valibot.pipe(valibot.object({ date: valibot.nullable(DateObjectSchema) }), valibot.transform((v) => v.date?.start ? new Date(v.date.start) : null));
+/**
+* Schema to extract the `date` property from a Notion page property and transform it to a date range object.
+*
+* **Input:**
+* ```
+* {
+*   date: {
+*     start: string;
+*     end: string | null;
+*     time_zone: string | null;
+*   }
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   start: Date;
+*   end: Date | null;
+*   time_zone: string | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { DateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     DateRange: DateRangeSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null }
+* ```
+*/
 const DateRangeSchema = valibot.pipe(valibot.object({ date: DateObjectSchema }), valibot.transform((v) => ({
 	start: new Date(v.date.start),
 	end: v.date.end ? new Date(v.date.end) : null,
 	time_zone: v.date.time_zone
 })));
+/**
+* Schema to extract the `date` property from a Notion page property and transform it to a date range object or `null`.
+*
+* **Input:**
+* ```
+* {
+*   date: {
+*     start: string;
+*     end: string | null;
+*     time_zone: string | null;
+*   } | null
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   start: Date;
+*   end: Date | null;
+*   time_zone: string | null;
+* } | null
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableDateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     DateRange: NullableDateRangeSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null } | null
+* ```
+*/
 const NullableDateRangeSchema = valibot.pipe(valibot.object({ date: valibot.nullable(DateObjectSchema) }), valibot.transform((v) => v.date ? {
 	start: new Date(v.date.start),
 	end: v.date.end ? new Date(v.date.end) : null,

package/dist/date.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"date.cjs","names":["v"],"sources":["../src/date.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const DateObjectSchema = v.object({\n\tstart: v.string(),\n\tend: v.nullable(v.string()),\n\ttime_zone: v.nullable(v.string()),\n});\n\nexport const DateSchema = v.pipe(\n\tv.object({\n\t\tdate: DateObjectSchema,\n\t}),\n\tv.transform((v) => new Date(v.date.start)),\n);\n\nexport const NullableDateSchema = v.pipe(\n\tv.object({\n\t\tdate: v.nullable(DateObjectSchema),\n\t}),\n\tv.transform((v) => (v.date?.start ? new Date(v.date.start) : null)),\n);\n\nexport const DateRangeSchema = v.pipe(\n\tv.object({\n\t\tdate: DateObjectSchema,\n\t}),\n\tv.transform((v) => ({\n\t\tstart: new Date(v.date.start),\n\t\tend: v.date.end ? new Date(v.date.end) : null,\n\t\ttime_zone: v.date.time_zone,\n\t})),\n);\n\nexport const NullableDateRangeSchema = v.pipe(\n\tv.object({\n\t\tdate: v.nullable(DateObjectSchema),\n\t}),\n\tv.transform((v) =>\n\t\tv.date\n\t\t\t? {\n\t\t\t\t\tstart: new Date(v.date.start),\n\t\t\t\t\tend: v.date.end ? new Date(v.date.end) : null,\n\t\t\t\t\ttime_zone: v.date.time_zone,\n\t\t\t\t}\n\t\t\t: null,\n\t),\n);\n"],"mappings":";;;;;AAEA,MAAa,mBAAmBA,QAAE,OAAO;CACxC,OAAOA,QAAE,QAAQ;CACjB,KAAKA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC3B,WAAWA,QAAE,SAASA,QAAE,QAAQ,CAAC;CACjC,CAAC;AAEF,MAAa,aAAaA,QAAE,KAC3BA,QAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,KAAK,MAAM,CAAC,CAC1C;AAED,MAAa,qBAAqBA,QAAE,KACnCA,QAAE,OAAO,EACR,MAAMA,QAAE,SAAS,iBAAiB,EAClC,CAAC,EACFA,QAAE,WAAW,MAAO,EAAE,MAAM,QAAQ,IAAI,KAAK,EAAE,KAAK,MAAM,GAAG,KAAM,CACnE;AAED,MAAa,kBAAkBA,QAAE,KAChCA,QAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACFA,QAAE,WAAW,OAAO;CACnB,OAAO,IAAI,KAAK,EAAE,KAAK,MAAM;CAC7B,KAAK,EAAE,KAAK,MAAM,IAAI,KAAK,EAAE,KAAK,IAAI,GAAG;CACzC,WAAW,EAAE,KAAK;CAClB,EAAE,CACH;AAED,MAAa,0BAA0BA,QAAE,KACxCA,QAAE,OAAO,EACR,MAAMA,QAAE,SAAS,iBAAiB,EAClC,CAAC,EACFA,QAAE,WAAW,MACZ,EAAE,OACC;CACA,OAAO,IAAI,KAAK,EAAE,KAAK,MAAM;CAC7B,KAAK,EAAE,KAAK,MAAM,IAAI,KAAK,EAAE,KAAK,IAAI,GAAG;CACzC,WAAW,EAAE,KAAK;CAClB,GACA,KACH,CACD"}
+{"version":3,"file":"date.cjs","names":["v"],"sources":["../src/date.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion date object structure.\n *\n * **Input:**\n * ```\n * {\n *   start: string;\n *   end: string | null;\n *   time_zone: string | null;\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   start: string;\n *   end: string | null;\n *   time_zone: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { DateObjectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Date: v.object({\n *       date: DateObjectSchema,\n *     }),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Date.date: { start: string; end: string | null; time_zone: string | null }\n * ```\n *\n * @internal\n */\nexport const DateObjectSchema = v.object({\n\tstart: v.string(),\n\tend: v.nullable(v.string()),\n\ttime_zone: v.nullable(v.string()),\n});\n\n/**\n * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object.\n *\n * **Input:**\n * ```\n * {\n *   date: {\n *     start: string;\n *     end: string | null;\n *     time_zone: string | null;\n *   }\n * }\n * ```\n *\n * **Output:** `Date`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { DateSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Date: DateSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Date: Date\n * ```\n */\nexport const DateSchema = v.pipe(\n\tv.object({\n\t\tdate: DateObjectSchema,\n\t}),\n\tv.transform((v) => new Date(v.date.start)),\n);\n\n/**\n * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object or `null`.\n *\n * **Input:**\n * ```\n * {\n *   date: {\n *     start: string;\n *     end: string | null;\n *     time_zone: string | null;\n *   } | null\n * }\n * ```\n *\n * **Output:** `Date | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableDateSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Date: NullableDateSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Date: Date | null\n * ```\n */\nexport const NullableDateSchema = v.pipe(\n\tv.object({\n\t\tdate: v.nullable(DateObjectSchema),\n\t}),\n\tv.transform((v) => (v.date?.start ? new Date(v.date.start) : null)),\n);\n\n/**\n * Schema to extract the `date` property from a Notion page property and transform it to a date range object.\n *\n * **Input:**\n * ```\n * {\n *   date: {\n *     start: string;\n *     end: string | null;\n *     time_zone: string | null;\n *   }\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   start: Date;\n *   end: Date | null;\n *   time_zone: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { DateRangeSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     DateRange: DateRangeSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null }\n * ```\n */\nexport const DateRangeSchema = v.pipe(\n\tv.object({\n\t\tdate: DateObjectSchema,\n\t}),\n\tv.transform((v) => ({\n\t\tstart: new Date(v.date.start),\n\t\tend: v.date.end ? new Date(v.date.end) : null,\n\t\ttime_zone: v.date.time_zone,\n\t})),\n);\n\n/**\n * Schema to extract the `date` property from a Notion page property and transform it to a date range object or `null`.\n *\n * **Input:**\n * ```\n * {\n *   date: {\n *     start: string;\n *     end: string | null;\n *     time_zone: string | null;\n *   } | null\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   start: Date;\n *   end: Date | null;\n *   time_zone: string | null;\n * } | null\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableDateRangeSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     DateRange: NullableDateRangeSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null } | null\n * ```\n */\nexport const NullableDateRangeSchema = v.pipe(\n\tv.object({\n\t\tdate: v.nullable(DateObjectSchema),\n\t}),\n\tv.transform((v) =>\n\t\tv.date\n\t\t\t? {\n\t\t\t\t\tstart: new Date(v.date.start),\n\t\t\t\t\tend: v.date.end ? new Date(v.date.end) : null,\n\t\t\t\t\ttime_zone: v.date.time_zone,\n\t\t\t\t}\n\t\t\t: null,\n\t),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,MAAa,mBAAmBA,QAAE,OAAO;CACxC,OAAOA,QAAE,QAAQ;CACjB,KAAKA,QAAE,SAASA,QAAE,QAAQ,CAAC;CAC3B,WAAWA,QAAE,SAASA,QAAE,QAAQ,CAAC;CACjC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCF,MAAa,aAAaA,QAAE,KAC3BA,QAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,KAAK,MAAM,CAAC,CAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCD,MAAa,qBAAqBA,QAAE,KACnCA,QAAE,OAAO,EACR,MAAMA,QAAE,SAAS,iBAAiB,EAClC,CAAC,EACFA,QAAE,WAAW,MAAO,EAAE,MAAM,QAAQ,IAAI,KAAK,EAAE,KAAK,MAAM,GAAG,KAAM,CACnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,kBAAkBA,QAAE,KAChCA,QAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACFA,QAAE,WAAW,OAAO;CACnB,OAAO,IAAI,KAAK,EAAE,KAAK,MAAM;CAC7B,KAAK,EAAE,KAAK,MAAM,IAAI,KAAK,EAAE,KAAK,IAAI,GAAG;CACzC,WAAW,EAAE,KAAK;CAClB,EAAE,CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,0BAA0BA,QAAE,KACxCA,QAAE,OAAO,EACR,MAAMA,QAAE,SAAS,iBAAiB,EAClC,CAAC,EACFA,QAAE,WAAW,MACZ,EAAE,OACC;CACA,OAAO,IAAI,KAAK,EAAE,KAAK,MAAM;CAC7B,KAAK,EAAE,KAAK,MAAM,IAAI,KAAK,EAAE,KAAK,IAAI,GAAG;CACzC,WAAW,EAAE,KAAK;CAClB,GACA,KACH,CACD"}

package/dist/date.d.cts

@@ -1,11 +1,87 @@
 import * as v from "valibot";
 
 //#region src/date.d.ts
+
+/**
+ * Schema for a Notion date object structure.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   start: string;
+ *   end: string | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: string;
+ *   end: string | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateObjectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: v.object({
+ *       date: DateObjectSchema,
+ *     }),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date.date: { start: string; end: string | null; time_zone: string | null }
+ * ```
+ *
+ * @internal
+ */
 declare const DateObjectSchema: v.ObjectSchema<{
   readonly start: v.StringSchema<undefined>;
   readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: DateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date: Date
+ * ```
+ */
 declare const DateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -19,6 +95,39 @@ declare const DateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     time_zone: string | null;
   };
 }, Date>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:** `Date | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableDateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: NullableDateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date: Date | null
+ * ```
+ */
 declare const NullableDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.NullableSchema<v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -32,6 +141,46 @@ declare const NullableDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     time_zone: string | null;
   } | null;
 }, Date | null>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a date range object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: Date;
+ *   end: Date | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     DateRange: DateRangeSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null }
+ * ```
+ */
 declare const DateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -49,6 +198,46 @@ declare const DateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   end: Date | null;
   time_zone: string | null;
 }>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a date range object or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: Date;
+ *   end: Date | null;
+ *   time_zone: string | null;
+ * } | null
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableDateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     DateRange: NullableDateRangeSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null } | null
+ * ```
+ */
 declare const NullableDateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.NullableSchema<v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;

package/dist/date.d.mts

@@ -1,11 +1,87 @@
 import * as v from "valibot";
 
 //#region src/date.d.ts
+
+/**
+ * Schema for a Notion date object structure.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   start: string;
+ *   end: string | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: string;
+ *   end: string | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateObjectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: v.object({
+ *       date: DateObjectSchema,
+ *     }),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date.date: { start: string; end: string | null; time_zone: string | null }
+ * ```
+ *
+ * @internal
+ */
 declare const DateObjectSchema: v.ObjectSchema<{
   readonly start: v.StringSchema<undefined>;
   readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
 }, undefined>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: DateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date: Date
+ * ```
+ */
 declare const DateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -19,6 +95,39 @@ declare const DateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     time_zone: string | null;
   };
 }, Date>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a `Date` object or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:** `Date | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableDateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Date: NullableDateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Date: Date | null
+ * ```
+ */
 declare const NullableDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.NullableSchema<v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -32,6 +141,46 @@ declare const NullableDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     time_zone: string | null;
   } | null;
 }, Date | null>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a date range object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: Date;
+ *   end: Date | null;
+ *   time_zone: string | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { DateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     DateRange: DateRangeSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null }
+ * ```
+ */
 declare const DateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;
@@ -49,6 +198,46 @@ declare const DateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   end: Date | null;
   time_zone: string | null;
 }>]>;
+/**
+ * Schema to extract the `date` property from a Notion page property and transform it to a date range object or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   date: {
+ *     start: string;
+ *     end: string | null;
+ *     time_zone: string | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   start: Date;
+ *   end: Date | null;
+ *   time_zone: string | null;
+ * } | null
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableDateRangeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     DateRange: NullableDateRangeSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.DateRange: { start: Date; end: Date | null; time_zone: string | null } | null
+ * ```
+ */
 declare const NullableDateRangeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly date: v.NullableSchema<v.ObjectSchema<{
     readonly start: v.StringSchema<undefined>;