@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.6

package/dist/place.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"place.mjs","names":["v"],"sources":["../src/place.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nconst PlaceObjectSchema = v.object({\n\tlat: v.number(),\n\tlon: v.number(),\n\tname: v.nullish(v.string()),\n\taddress: v.nullish(v.string()),\n});\n\nexport const PlaceSchema = v.pipe(\n\tv.object({\n\t\tplace: PlaceObjectSchema,\n\t}),\n\tv.transform((v) => v.place),\n);\n\nexport const NullablePlaceSchema = v.pipe(\n\tv.object({\n\t\tplace: v.nullable(PlaceObjectSchema),\n\t}),\n\tv.transform((v) => v.place),\n);\n"],"mappings":";;;AAEA,MAAM,oBAAoB,EAAE,OAAO;CAClC,KAAK,EAAE,QAAQ;CACf,KAAK,EAAE,QAAQ;CACf,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;CAC3B,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC;CAC9B,CAAC;AAEF,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,mBACP,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,CAC3B;AAED,MAAa,sBAAsB,EAAE,KACpC,EAAE,OAAO,EACR,OAAO,EAAE,SAAS,kBAAkB,EACpC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,CAC3B"}
+{"version":3,"file":"place.mjs","names":["v"],"sources":["../src/place.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion place object structure.\n *\n * **Input:**\n * ```\n * {\n *   lat: number;\n *   lon: number;\n *   name?: string | null;\n *   address?: string | null;\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   lat: number;\n *   lon: number;\n *   name?: string | null;\n *   address?: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PlaceObjectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Location: v.object({\n *       place: PlaceObjectSchema,\n *     }),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Location.place: { lat: number; lon: number; name?: string | null; address?: string | null }\n * ```\n *\n * @internal\n */\nconst PlaceObjectSchema = v.object({\n\tlat: v.number(),\n\tlon: v.number(),\n\tname: v.nullish(v.string()),\n\taddress: v.nullish(v.string()),\n});\n\n/**\n * Schema to extract the `place` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   place: {\n *     lat: number;\n *     lon: number;\n *     name?: string | null;\n *     address?: string | null;\n *   };\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   lat: number;\n *   lon: number;\n *   name?: string | null;\n *   address?: string | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { PlaceSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Location: PlaceSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Location: { lat: number; lon: number; name?: string | null; address?: string | null }\n * ```\n */\nexport const PlaceSchema = v.pipe(\n\tv.object({\n\t\tplace: PlaceObjectSchema,\n\t}),\n\tv.transform((v) => v.place),\n);\n\n/**\n * Schema to extract the `place` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   place: {\n *     lat: number;\n *     lon: number;\n *     name?: string | null;\n *     address?: string | null;\n *   } | null;\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   lat: number;\n *   lon: number;\n *   name?: string | null;\n *   address?: string | null;\n * } | null\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullablePlaceSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Location: NullablePlaceSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Location: { lat: number; lon: number; name?: string | null; address?: string | null } | null\n * ```\n */\nexport const NullablePlaceSchema = v.pipe(\n\tv.object({\n\t\tplace: v.nullable(PlaceObjectSchema),\n\t}),\n\tv.transform((v) => v.place),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8CA,MAAM,oBAAoB,EAAE,OAAO;CAClC,KAAK,EAAE,QAAQ;CACf,KAAK,EAAE,QAAQ;CACf,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC;CAC3B,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC;CAC9B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CF,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,mBACP,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,CAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CD,MAAa,sBAAsB,EAAE,KACpC,EAAE,OAAO,EACR,OAAO,EAAE,SAAS,kBAAkB,EACpC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,MAAM,CAC3B"}

package/dist/relation.cjs

@@ -3,9 +3,140 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/relation.ts
+/**
+* Schema for a Notion relation object structure.
+*
+* **Input:**
+* ```
+* {
+*   id: string;
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   id: string;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { InnerRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Relation: v.object({
+*       relation: v.array(InnerRelationSchema),
+*     }),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Relation.relation: Array<{ id: string }>
+* ```
+*
+* @internal
+*/
 const InnerRelationSchema = valibot.object({ id: valibot.string() });
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.
+*
+* **Input:**
+* ```
+* {
+*   relation: Array<{
+*     id: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string[]`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     RelatedPages: RelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.RelatedPages: string[]
+* ```
+*/
 const RelationSchema = valibot.pipe(valibot.object({ relation: valibot.array(InnerRelationSchema) }), valibot.transform((v) => v.relation.map((r) => r.id)));
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.
+*
+* **Input:**
+* ```
+* {
+*   relation: [{
+*     id: string;
+*   }];
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { SingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ParentPage: SingleRelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ParentPage: string
+* ```
+*/
 const SingleRelationSchema = valibot.pipe(valibot.object({ relation: valibot.tuple([InnerRelationSchema]) }), valibot.transform((v) => v.relation[0].id));
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.
+*
+* **Input:**
+* ```
+* {
+*   relation: Array<{
+*     id: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableSingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ParentPage: NullableSingleRelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ParentPage: string | null
+* ```
+*/
 const NullableSingleRelationSchema = valibot.pipe(valibot.object({ relation: valibot.array(InnerRelationSchema) }), valibot.transform((v) => v.relation[0]?.id ?? null));
 
 //#endregion

package/dist/relation.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"relation.cjs","names":["v"],"sources":["../src/relation.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nconst InnerRelationSchema = v.object({ id: v.string() });\n\nexport const RelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation.map((r) => r.id)),\n);\n\nexport const SingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.tuple([InnerRelationSchema]),\n\t}),\n\tv.transform((v) => v.relation[0].id),\n);\n\nexport const NullableSingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation[0]?.id ?? null),\n);\n"],"mappings":";;;;;AAEA,MAAM,sBAAsBA,QAAE,OAAO,EAAE,IAAIA,QAAE,QAAQ,EAAE,CAAC;AAExD,MAAa,iBAAiBA,QAAE,KAC/BA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,oBAAoB,EACtC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,KAAK,MAAM,EAAE,GAAG,CAAC,CAC/C;AAED,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,CAAC,oBAAoB,CAAC,EACxC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,GAAG,GAAG,CACpC;AAED,MAAa,+BAA+BA,QAAE,KAC7CA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,oBAAoB,EACtC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,IAAI,MAAM,KAAK,CAC7C"}
+{"version":3,"file":"relation.cjs","names":["v"],"sources":["../src/relation.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion relation object structure.\n *\n * **Input:**\n * ```\n * {\n *   id: string;\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   id: string;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { InnerRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Relation: v.object({\n *       relation: v.array(InnerRelationSchema),\n *     }),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Relation.relation: Array<{ id: string }>\n * ```\n *\n * @internal\n */\nconst InnerRelationSchema = v.object({ id: v.string() });\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.\n *\n * **Input:**\n * ```\n * {\n *   relation: Array<{\n *     id: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string[]`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     RelatedPages: RelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.RelatedPages: string[]\n * ```\n */\nexport const RelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation.map((r) => r.id)),\n);\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.\n *\n * **Input:**\n * ```\n * {\n *   relation: [{\n *     id: string;\n *   }];\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { SingleRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ParentPage: SingleRelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ParentPage: string\n * ```\n */\nexport const SingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.tuple([InnerRelationSchema]),\n\t}),\n\tv.transform((v) => v.relation[0].id),\n);\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.\n *\n * **Input:**\n * ```\n * {\n *   relation: Array<{\n *     id: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableSingleRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ParentPage: NullableSingleRelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ParentPage: string | null\n * ```\n */\nexport const NullableSingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation[0]?.id ?? null),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAM,sBAAsBA,QAAE,OAAO,EAAE,IAAIA,QAAE,QAAQ,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCxD,MAAa,iBAAiBA,QAAE,KAC/BA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,oBAAoB,EACtC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,KAAK,MAAM,EAAE,GAAG,CAAC,CAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,CAAC,oBAAoB,CAAC,EACxC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,GAAG,GAAG,CACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,+BAA+BA,QAAE,KAC7CA,QAAE,OAAO,EACR,UAAUA,QAAE,MAAM,oBAAoB,EACtC,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,SAAS,IAAI,MAAM,KAAK,CAC7C"}

package/dist/relation.d.cts

@@ -1,6 +1,38 @@
 import * as v from "valibot";
 
 //#region src/relation.d.ts
+
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: Array<{
+ *     id: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string[]`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     RelatedPages: RelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.RelatedPages: string[]
+ * ```
+ */
 declare const RelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -10,6 +42,37 @@ declare const RelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     id: string;
   }[];
 }, string[]>]>;
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: [{
+ *     id: string;
+ *   }];
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { SingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ParentPage: SingleRelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ParentPage: string
+ * ```
+ */
 declare const SingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.TupleSchema<[v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -19,6 +82,37 @@ declare const SingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     id: string;
   }];
 }, string>]>;
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: Array<{
+ *     id: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableSingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ParentPage: NullableSingleRelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ParentPage: string | null
+ * ```
+ */
 declare const NullableSingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/relation.d.mts

@@ -1,6 +1,38 @@
 import * as v from "valibot";
 
 //#region src/relation.d.ts
+
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: Array<{
+ *     id: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string[]`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     RelatedPages: RelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.RelatedPages: string[]
+ * ```
+ */
 declare const RelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -10,6 +42,37 @@ declare const RelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     id: string;
   }[];
 }, string[]>]>;
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: [{
+ *     id: string;
+ *   }];
+ * }
+ * ```
+ *
+ * **Output:** `string`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { SingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ParentPage: SingleRelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ParentPage: string
+ * ```
+ */
 declare const SingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.TupleSchema<[v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;
@@ -19,6 +82,37 @@ declare const SingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     id: string;
   }];
 }, string>]>;
+/**
+ * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   relation: Array<{
+ *     id: string;
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableSingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     ParentPage: NullableSingleRelationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.ParentPage: string | null
+ * ```
+ */
 declare const NullableSingleRelationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly relation: v.ArraySchema<v.ObjectSchema<{
     readonly id: v.StringSchema<undefined>;

package/dist/relation.mjs

@@ -1,9 +1,140 @@
 import * as v from "valibot";
 
 //#region src/relation.ts
+/**
+* Schema for a Notion relation object structure.
+*
+* **Input:**
+* ```
+* {
+*   id: string;
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   id: string;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { InnerRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Relation: v.object({
+*       relation: v.array(InnerRelationSchema),
+*     }),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Relation.relation: Array<{ id: string }>
+* ```
+*
+* @internal
+*/
 const InnerRelationSchema = v.object({ id: v.string() });
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.
+*
+* **Input:**
+* ```
+* {
+*   relation: Array<{
+*     id: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string[]`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     RelatedPages: RelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.RelatedPages: string[]
+* ```
+*/
 const RelationSchema = v.pipe(v.object({ relation: v.array(InnerRelationSchema) }), v.transform((v$1) => v$1.relation.map((r) => r.id)));
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.
+*
+* **Input:**
+* ```
+* {
+*   relation: [{
+*     id: string;
+*   }];
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { SingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ParentPage: SingleRelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ParentPage: string
+* ```
+*/
 const SingleRelationSchema = v.pipe(v.object({ relation: v.tuple([InnerRelationSchema]) }), v.transform((v$1) => v$1.relation[0].id));
+/**
+* Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.
+*
+* **Input:**
+* ```
+* {
+*   relation: Array<{
+*     id: string;
+*   }>;
+* }
+* ```
+*
+* **Output:** `string | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableSingleRelationSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     ParentPage: NullableSingleRelationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.ParentPage: string | null
+* ```
+*/
 const NullableSingleRelationSchema = v.pipe(v.object({ relation: v.array(InnerRelationSchema) }), v.transform((v$1) => v$1.relation[0]?.id ?? null));
 
 //#endregion

package/dist/relation.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"relation.mjs","names":["v"],"sources":["../src/relation.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nconst InnerRelationSchema = v.object({ id: v.string() });\n\nexport const RelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation.map((r) => r.id)),\n);\n\nexport const SingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.tuple([InnerRelationSchema]),\n\t}),\n\tv.transform((v) => v.relation[0].id),\n);\n\nexport const NullableSingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation[0]?.id ?? null),\n);\n"],"mappings":";;;AAEA,MAAM,sBAAsB,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAExD,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,oBAAoB,EACtC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,KAAK,MAAM,EAAE,GAAG,CAAC,CAC/C;AAED,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,CAAC,oBAAoB,CAAC,EACxC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,GAAG,GAAG,CACpC;AAED,MAAa,+BAA+B,EAAE,KAC7C,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,oBAAoB,EACtC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,IAAI,MAAM,KAAK,CAC7C"}
+{"version":3,"file":"relation.mjs","names":["v"],"sources":["../src/relation.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema for a Notion relation object structure.\n *\n * **Input:**\n * ```\n * {\n *   id: string;\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   id: string;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { InnerRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Relation: v.object({\n *       relation: v.array(InnerRelationSchema),\n *     }),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Relation.relation: Array<{ id: string }>\n * ```\n *\n * @internal\n */\nconst InnerRelationSchema = v.object({ id: v.string() });\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to an array of page IDs.\n *\n * **Input:**\n * ```\n * {\n *   relation: Array<{\n *     id: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string[]`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     RelatedPages: RelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.RelatedPages: string[]\n * ```\n */\nexport const RelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation.map((r) => r.id)),\n);\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID.\n *\n * **Input:**\n * ```\n * {\n *   relation: [{\n *     id: string;\n *   }];\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { SingleRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ParentPage: SingleRelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ParentPage: string\n * ```\n */\nexport const SingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.tuple([InnerRelationSchema]),\n\t}),\n\tv.transform((v) => v.relation[0].id),\n);\n\n/**\n * Schema to extract the `relation` property from a Notion page property and transform it to a single page ID or `null`.\n *\n * **Input:**\n * ```\n * {\n *   relation: Array<{\n *     id: string;\n *   }>;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableSingleRelationSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     ParentPage: NullableSingleRelationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.ParentPage: string | null\n * ```\n */\nexport const NullableSingleRelationSchema = v.pipe(\n\tv.object({\n\t\trelation: v.array(InnerRelationSchema),\n\t}),\n\tv.transform((v) => v.relation[0]?.id ?? null),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAM,sBAAsB,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCxD,MAAa,iBAAiB,EAAE,KAC/B,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,oBAAoB,EACtC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,KAAK,MAAM,EAAE,GAAG,CAAC,CAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,CAAC,oBAAoB,CAAC,EACxC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,GAAG,GAAG,CACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCD,MAAa,+BAA+B,EAAE,KAC7C,EAAE,OAAO,EACR,UAAU,EAAE,MAAM,oBAAoB,EACtC,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,SAAS,IAAI,MAAM,KAAK,CAC7C"}