@nakanoaas/notion-valibot-schema 0.0.3 → 0.0.5

package/dist/people.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"people.cjs","names":["v"],"sources":["../src/people.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const PersonSchema = v.object({\n\tid: v.string(),\n\tobject: v.picklist([\"user\", \"bot\", \"group\"]),\n\tname: v.nullish(v.string(), null),\n});\n\nexport const PeopleSchema = v.pipe(\n\tv.object({\n\t\tpeople: v.array(PersonSchema),\n\t}),\n\tv.transform((v) => v.people),\n);\n"],"mappings":";;;;;AAEA,MAAa,eAAeA,QAAE,OAAO;CACpC,IAAIA,QAAE,QAAQ;CACd,QAAQA,QAAE,SAAS;EAAC;EAAQ;EAAO;EAAQ,CAAC;CAC5C,MAAMA,QAAE,QAAQA,QAAE,QAAQ,EAAE,KAAK;CACjC,CAAC;AAEF,MAAa,eAAeA,QAAE,KAC7BA,QAAE,OAAO,EACR,QAAQA,QAAE,MAAM,aAAa,EAC7B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B"}
+{"version":3,"file":"people.cjs","names":["v"],"sources":["../src/people.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion person object (user, bot, or group).\n *\n * **Input:**\n * ```\n * {\n *   id: string;\n *   object: \"user\" | \"bot\" | \"group\";\n *   name: string | null;\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 { PersonSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   created_by: PersonSchema,\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.created_by: { id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }\n * ```\n *\n * @internal\n */\nexport const PersonSchema = v.object({\n\tid: v.string(),\n\tobject: v.picklist([\"user\", \"bot\", \"group\"]),\n\tname: v.nullish(v.string(), null),\n});\n\n/**\n * Schema to extract the `people` array from a Notion property.\n *\n * **Input:**\n * ```\n * {\n *   people: [\n *     {\n *       id: string;\n *       object: \"user\" | \"bot\" | \"group\";\n *       name: string | null;\n *       ...\n *     }\n *   ]\n * }\n * ```\n *\n * **Output:**\n * ```\n * [\n *   {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *   }\n * ]\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PeopleSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     People: PeopleSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.People: Array<{ id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }>\n * ```\n */\nexport const PeopleSchema = v.pipe(\n\tv.object({\n\t\tpeople: v.array(PersonSchema),\n\t}),\n\tv.transform((v) => v.people),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,MAAa,eAAeA,QAAE,OAAO;CACpC,IAAIA,QAAE,QAAQ;CACd,QAAQA,QAAE,SAAS;EAAC;EAAQ;EAAO;EAAQ,CAAC;CAC5C,MAAMA,QAAE,QAAQA,QAAE,QAAQ,EAAE,KAAK;CACjC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CF,MAAa,eAAeA,QAAE,KAC7BA,QAAE,OAAO,EACR,QAAQA,QAAE,MAAM,aAAa,EAC7B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B"}

package/dist/people.d.cts

@@ -1,11 +1,96 @@
 import * as v from "valibot";
 
 //#region src/people.d.ts
+
+/**
+ * Schema for a Notion person object (user, bot, or group).
+ *
+ * **Input:**
+ * ```
+ * {
+ *   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 { PersonSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   created_by: PersonSchema,
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.created_by: { id: string; object: "user" | "bot" | "group"; name: string | null }
+ * ```
+ *
+ * @internal
+ */
 declare const PersonSchema: v.ObjectSchema<{
   readonly id: v.StringSchema<undefined>;
   readonly object: v.PicklistSchema<["user", "bot", "group"], undefined>;
   readonly name: v.NullishSchema<v.StringSchema<undefined>, null>;
 }, undefined>;
+/**
+ * Schema to extract the `people` array from a Notion property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   people: [
+ *     {
+ *       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 { PeopleSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     People: PeopleSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.People: Array<{ id: string; object: "user" | "bot" | "group"; name: string | null }>
+ * ```
+ */
 declare const PeopleSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly people: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/people.d.mts

@@ -1,11 +1,96 @@
 import * as v from "valibot";
 
 //#region src/people.d.ts
+
+/**
+ * Schema for a Notion person object (user, bot, or group).
+ *
+ * **Input:**
+ * ```
+ * {
+ *   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 { PersonSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   created_by: PersonSchema,
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.created_by: { id: string; object: "user" | "bot" | "group"; name: string | null }
+ * ```
+ *
+ * @internal
+ */
 declare const PersonSchema: v.ObjectSchema<{
   readonly id: v.StringSchema<undefined>;
   readonly object: v.PicklistSchema<["user", "bot", "group"], undefined>;
   readonly name: v.NullishSchema<v.StringSchema<undefined>, null>;
 }, undefined>;
+/**
+ * Schema to extract the `people` array from a Notion property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   people: [
+ *     {
+ *       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 { PeopleSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     People: PeopleSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.People: Array<{ id: string; object: "user" | "bot" | "group"; name: string | null }>
+ * ```
+ */
 declare const PeopleSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly people: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/people.mjs

@@ -1,6 +1,45 @@
 import * as v from "valibot";
 
 //#region src/people.ts
+/**
+* Schema for a Notion person object (user, bot, or group).
+*
+* **Input:**
+* ```
+* {
+*   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 { PersonSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   created_by: PersonSchema,
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.created_by: { id: string; object: "user" | "bot" | "group"; name: string | null }
+* ```
+*
+* @internal
+*/
 const PersonSchema = v.object({
 	id: v.string(),
 	object: v.picklist([
@@ -10,6 +49,51 @@ const PersonSchema = v.object({
 	]),
 	name: v.nullish(v.string(), null)
 });
+/**
+* Schema to extract the `people` array from a Notion property.
+*
+* **Input:**
+* ```
+* {
+*   people: [
+*     {
+*       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 { PeopleSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     People: PeopleSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.People: Array<{ id: string; object: "user" | "bot" | "group"; name: string | null }>
+* ```
+*/
 const PeopleSchema = v.pipe(v.object({ people: v.array(PersonSchema) }), v.transform((v$1) => v$1.people));
 
 //#endregion

package/dist/people.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"people.mjs","names":["v"],"sources":["../src/people.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const PersonSchema = v.object({\n\tid: v.string(),\n\tobject: v.picklist([\"user\", \"bot\", \"group\"]),\n\tname: v.nullish(v.string(), null),\n});\n\nexport const PeopleSchema = v.pipe(\n\tv.object({\n\t\tpeople: v.array(PersonSchema),\n\t}),\n\tv.transform((v) => v.people),\n);\n"],"mappings":";;;AAEA,MAAa,eAAe,EAAE,OAAO;CACpC,IAAI,EAAE,QAAQ;CACd,QAAQ,EAAE,SAAS;EAAC;EAAQ;EAAO;EAAQ,CAAC;CAC5C,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK;CACjC,CAAC;AAEF,MAAa,eAAe,EAAE,KAC7B,EAAE,OAAO,EACR,QAAQ,EAAE,MAAM,aAAa,EAC7B,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,CAC5B"}
+{"version":3,"file":"people.mjs","names":["v"],"sources":["../src/people.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion person object (user, bot, or group).\n *\n * **Input:**\n * ```\n * {\n *   id: string;\n *   object: \"user\" | \"bot\" | \"group\";\n *   name: string | null;\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 { PersonSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   created_by: PersonSchema,\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.created_by: { id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }\n * ```\n *\n * @internal\n */\nexport const PersonSchema = v.object({\n\tid: v.string(),\n\tobject: v.picklist([\"user\", \"bot\", \"group\"]),\n\tname: v.nullish(v.string(), null),\n});\n\n/**\n * Schema to extract the `people` array from a Notion property.\n *\n * **Input:**\n * ```\n * {\n *   people: [\n *     {\n *       id: string;\n *       object: \"user\" | \"bot\" | \"group\";\n *       name: string | null;\n *       ...\n *     }\n *   ]\n * }\n * ```\n *\n * **Output:**\n * ```\n * [\n *   {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *   }\n * ]\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PeopleSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     People: PeopleSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.People: Array<{ id: string; object: \"user\" | \"bot\" | \"group\"; name: string | null }>\n * ```\n */\nexport const PeopleSchema = v.pipe(\n\tv.object({\n\t\tpeople: v.array(PersonSchema),\n\t}),\n\tv.transform((v) => v.people),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,MAAa,eAAe,EAAE,OAAO;CACpC,IAAI,EAAE,QAAQ;CACd,QAAQ,EAAE,SAAS;EAAC;EAAQ;EAAO;EAAQ,CAAC;CAC5C,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK;CACjC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CF,MAAa,eAAe,EAAE,KAC7B,EAAE,OAAO,EACR,QAAQ,EAAE,MAAM,aAAa,EAC7B,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,CAC5B"}

package/dist/phone-number.cjs

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

package/dist/phone-number.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"phone-number.cjs","names":["v"],"sources":["../src/phone-number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const PhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.string(),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n\nexport const NullablePhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n"],"mappings":";;;;;AAEA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,cAAcA,QAAE,QAAQ,EACxB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC;AAED,MAAa,4BAA4BA,QAAE,KAC1CA,QAAE,OAAO,EACR,cAAcA,QAAE,SAASA,QAAE,QAAQ,CAAC,EACpC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC"}
+{"version":3,"file":"phone-number.cjs","names":["v"],"sources":["../src/phone-number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `phone_number` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   phone_number: string;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PhoneNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Phone: PhoneNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Phone: string\n * ```\n */\nexport const PhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.string(),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n\n/**\n * Schema to extract the `phone_number` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   phone_number: string | null;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullablePhoneNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Phone: NullablePhoneNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Phone: string | null\n * ```\n */\nexport const NullablePhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,oBAAoBA,QAAE,KAClCA,QAAE,OAAO,EACR,cAAcA,QAAE,QAAQ,EACxB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,4BAA4BA,QAAE,KAC1CA,QAAE,OAAO,EACR,cAAcA,QAAE,SAASA,QAAE,QAAQ,CAAC,EACpC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC"}

package/dist/phone-number.d.cts

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

package/dist/phone-number.d.mts

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

package/dist/phone-number.mjs

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

package/dist/phone-number.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"phone-number.mjs","names":["v"],"sources":["../src/phone-number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const PhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.string(),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n\nexport const NullablePhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n"],"mappings":";;;AAEA,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,cAAc,EAAE,QAAQ,EACxB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC;AAED,MAAa,4BAA4B,EAAE,KAC1C,EAAE,OAAO,EACR,cAAc,EAAE,SAAS,EAAE,QAAQ,CAAC,EACpC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC"}
+{"version":3,"file":"phone-number.mjs","names":["v"],"sources":["../src/phone-number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `phone_number` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   phone_number: string;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PhoneNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Phone: PhoneNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Phone: string\n * ```\n */\nexport const PhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.string(),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n\n/**\n * Schema to extract the `phone_number` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   phone_number: string | null;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullablePhoneNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Phone: NullablePhoneNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Phone: string | null\n * ```\n */\nexport const NullablePhoneNumberSchema = v.pipe(\n\tv.object({\n\t\tphone_number: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.phone_number),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,cAAc,EAAE,QAAQ,EACxB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,4BAA4B,EAAE,KAC1C,EAAE,OAAO,EACR,cAAc,EAAE,SAAS,EAAE,QAAQ,CAAC,EACpC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC"}