@nakanoaas/notion-valibot-schema 0.0.3 → 0.0.5

package/dist/date.d.mts

@@ -1,52 +1,260 @@
 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>;
+    readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   }, undefined>;
 }, undefined>, v.TransformAction<{
   date: {
     start: string;
+    end: string | null;
+    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>;
+    readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   }, undefined>, undefined>;
 }, undefined>, v.TransformAction<{
   date: {
     start: string;
+    end: string | null;
+    time_zone: string | null;
   } | null;
 }, Date | null>]>;
-declare const FullDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+/**
+ * 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>;
-    readonly end: v.StringSchema<undefined>;
+    readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   }, undefined>;
 }, undefined>, v.TransformAction<{
   date: {
     start: string;
-    end: string;
+    end: string | null;
+    time_zone: string | null;
   };
 }, {
   start: Date;
-  end: Date;
+  end: Date | null;
+  time_zone: string | null;
 }>]>;
-declare const NullableFullDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
+/**
+ * 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>;
     readonly end: v.NullableSchema<v.StringSchema<undefined>, undefined>;
+    readonly time_zone: v.NullableSchema<v.StringSchema<undefined>, undefined>;
   }, undefined>, undefined>;
 }, undefined>, v.TransformAction<{
   date: {
     start: string;
     end: string | null;
+    time_zone: string | null;
   } | null;
 }, {
   start: Date;
   end: Date | null;
+  time_zone: string | null;
 } | null>]>;
 //#endregion
-export { DateSchema, FullDateSchema, NullableDateSchema, NullableFullDateSchema };
+export { DateObjectSchema, DateRangeSchema, DateSchema, NullableDateRangeSchema, NullableDateSchema };
 //# sourceMappingURL=date.d.mts.map

package/dist/date.mjs

@@ -1,23 +1,212 @@
 import * as v from "valibot";
 
 //#region src/date.ts
-const DateSchema = v.pipe(v.object({ date: v.object({ start: v.string() }) }), v.transform((v$1) => new Date(v$1.date.start)));
-const NullableDateSchema = v.pipe(v.object({ date: v.nullable(v.object({ start: v.string() })) }), v.transform((v$1) => v$1.date?.start ? new Date(v$1.date.start) : null));
-const FullDateSchema = v.pipe(v.object({ date: v.object({
+/**
+* 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 = v.object({
 	start: v.string(),
-	end: v.string()
-}) }), v.transform((v$1) => ({
+	end: v.nullable(v.string()),
+	time_zone: v.nullable(v.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 = v.pipe(v.object({ date: DateObjectSchema }), v.transform((v$1) => new Date(v$1.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 = v.pipe(v.object({ date: v.nullable(DateObjectSchema) }), v.transform((v$1) => v$1.date?.start ? new Date(v$1.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 = v.pipe(v.object({ date: DateObjectSchema }), v.transform((v$1) => ({
 	start: new Date(v$1.date.start),
-	end: new Date(v$1.date.end)
+	end: v$1.date.end ? new Date(v$1.date.end) : null,
+	time_zone: v$1.date.time_zone
 })));
-const NullableFullDateSchema = v.pipe(v.object({ date: v.nullable(v.object({
-	start: v.string(),
-	end: v.nullable(v.string())
-})) }), v.transform((v$1) => v$1.date ? {
+/**
+* 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 = v.pipe(v.object({ date: v.nullable(DateObjectSchema) }), v.transform((v$1) => v$1.date ? {
 	start: new Date(v$1.date.start),
-	end: v$1.date.end ? new Date(v$1.date.end) : null
+	end: v$1.date.end ? new Date(v$1.date.end) : null,
+	time_zone: v$1.date.time_zone
 } : null));
 
 //#endregion
-export { DateSchema, FullDateSchema, NullableDateSchema, NullableFullDateSchema };
+export { DateObjectSchema, DateRangeSchema, DateSchema, NullableDateRangeSchema, NullableDateSchema };
 //# sourceMappingURL=date.mjs.map

package/dist/date.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"date.mjs","names":["v"],"sources":["../src/date.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const DateSchema = v.pipe(\n\tv.object({\n\t\tdate: v.object({\n\t\t\tstart: v.string(),\n\t\t}),\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(\n\t\t\tv.object({\n\t\t\t\tstart: v.string(),\n\t\t\t}),\n\t\t),\n\t}),\n\tv.transform((v) => (v.date?.start ? new Date(v.date.start) : null)),\n);\n\nexport const FullDateSchema = v.pipe(\n\tv.object({\n\t\tdate: v.object({\n\t\t\tstart: v.string(),\n\t\t\tend: v.string(),\n\t\t}),\n\t}),\n\tv.transform((v) => ({\n\t\tstart: new Date(v.date.start),\n\t\tend: new Date(v.date.end),\n\t})),\n);\n\nexport const NullableFullDateSchema = v.pipe(\n\tv.object({\n\t\tdate: v.nullable(\n\t\t\tv.object({\n\t\t\t\tstart: v.string(),\n\t\t\t\tend: v.nullable(v.string()),\n\t\t\t}),\n\t\t),\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}\n\t\t\t: null,\n\t),\n);\n"],"mappings":";;;AAEA,MAAa,aAAa,EAAE,KAC3B,EAAE,OAAO,EACR,MAAM,EAAE,OAAO,EACd,OAAO,EAAE,QAAQ,EACjB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,KAAK,MAAM,CAAC,CAC1C;AAED,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,MAAM,EAAE,SACP,EAAE,OAAO,EACR,OAAO,EAAE,QAAQ,EACjB,CAAC,CACF,EACD,CAAC,EACF,EAAE,WAAW,QAAOA,IAAE,MAAM,QAAQ,IAAI,KAAKA,IAAE,KAAK,MAAM,GAAG,KAAM,CACnE;AAED,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,MAAM,EAAE,OAAO;CACd,OAAO,EAAE,QAAQ;CACjB,KAAK,EAAE,QAAQ;CACf,CAAC,EACF,CAAC,EACF,EAAE,WAAW,SAAO;CACnB,OAAO,IAAI,KAAKA,IAAE,KAAK,MAAM;CAC7B,KAAK,IAAI,KAAKA,IAAE,KAAK,IAAI;CACzB,EAAE,CACH;AAED,MAAa,yBAAyB,EAAE,KACvC,EAAE,OAAO,EACR,MAAM,EAAE,SACP,EAAE,OAAO;CACR,OAAO,EAAE,QAAQ;CACjB,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC3B,CAAC,CACF,EACD,CAAC,EACF,EAAE,WAAW,QACZA,IAAE,OACC;CACA,OAAO,IAAI,KAAKA,IAAE,KAAK,MAAM;CAC7B,KAAKA,IAAE,KAAK,MAAM,IAAI,KAAKA,IAAE,KAAK,IAAI,GAAG;CACzC,GACA,KACH,CACD"}
+{"version":3,"file":"date.mjs","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,mBAAmB,EAAE,OAAO;CACxC,OAAO,EAAE,QAAQ;CACjB,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC3B,WAAW,EAAE,SAAS,EAAE,QAAQ,CAAC;CACjC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCF,MAAa,aAAa,EAAE,KAC3B,EAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,KAAK,MAAM,CAAC,CAC1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCD,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,MAAM,EAAE,SAAS,iBAAiB,EAClC,CAAC,EACF,EAAE,WAAW,QAAOA,IAAE,MAAM,QAAQ,IAAI,KAAKA,IAAE,KAAK,MAAM,GAAG,KAAM,CACnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,kBAAkB,EAAE,KAChC,EAAE,OAAO,EACR,MAAM,kBACN,CAAC,EACF,EAAE,WAAW,SAAO;CACnB,OAAO,IAAI,KAAKA,IAAE,KAAK,MAAM;CAC7B,KAAKA,IAAE,KAAK,MAAM,IAAI,KAAKA,IAAE,KAAK,IAAI,GAAG;CACzC,WAAWA,IAAE,KAAK;CAClB,EAAE,CACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,0BAA0B,EAAE,KACxC,EAAE,OAAO,EACR,MAAM,EAAE,SAAS,iBAAiB,EAClC,CAAC,EACF,EAAE,WAAW,QACZA,IAAE,OACC;CACA,OAAO,IAAI,KAAKA,IAAE,KAAK,MAAM;CAC7B,KAAKA,IAAE,KAAK,MAAM,IAAI,KAAKA,IAAE,KAAK,IAAI,GAAG;CACzC,WAAWA,IAAE,KAAK;CAClB,GACA,KACH,CACD"}

package/dist/email.cjs

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

package/dist/email.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"email.cjs","names":["v"],"sources":["../src/email.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const EmailSchema = v.pipe(\n\tv.object({\n\t\temail: v.string(),\n\t}),\n\tv.transform((v) => v.email),\n);\n\nexport const NullableEmailSchema = v.pipe(\n\tv.object({\n\t\temail: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.email),\n);\n"],"mappings":";;;;;AAEA,MAAa,cAAcA,QAAE,KAC5BA,QAAE,OAAO,EACR,OAAOA,QAAE,QAAQ,EACjB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,MAAM,CAC3B;AAED,MAAa,sBAAsBA,QAAE,KACpCA,QAAE,OAAO,EACR,OAAOA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC7B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,MAAM,CAC3B"}
+{"version":3,"file":"email.cjs","names":["v"],"sources":["../src/email.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `email` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   email: string;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { EmailSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Email: EmailSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Email: string\n * ```\n */\nexport const EmailSchema = v.pipe(\n\tv.object({\n\t\temail: v.string(),\n\t}),\n\tv.transform((v) => v.email),\n);\n\n/**\n * Schema to extract the `email` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   email: string | null;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableEmailSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Email: NullableEmailSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Email: string | null\n * ```\n */\nexport const NullableEmailSchema = v.pipe(\n\tv.object({\n\t\temail: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.email),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,cAAcA,QAAE,KAC5BA,QAAE,OAAO,EACR,OAAOA,QAAE,QAAQ,EACjB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,MAAM,CAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,sBAAsBA,QAAE,KACpCA,QAAE,OAAO,EACR,OAAOA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC7B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,MAAM,CAC3B"}

package/dist/email.d.cts

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