@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.5

package/dist/rollup.d.mts

@@ -1,6 +1,39 @@
 import * as v from "valibot";
 
 //#region src/rollup.d.ts
+
+/**
+ * Schema to extract the `rollup` property with number type from a Notion page property or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rollup: {
+ *     type: "number";
+ *     number: number | null;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `number | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableRollupNumberSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Sum: NullableRollupNumberSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Sum: number | null
+ * ```
+ */
 declare const NullableRollupNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly rollup: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"number", undefined>;
@@ -12,6 +45,38 @@ declare const NullableRollupNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSch
     number: number | null;
   };
 }, number | null>]>;
+/**
+ * Schema to extract the `rollup` property with number type from a Notion page property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rollup: {
+ *     type: "number";
+ *     number: number;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `number`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RollupNumberSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Sum: RollupNumberSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Sum: number
+ * ```
+ */
 declare const RollupNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly rollup: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"number", undefined>;
@@ -23,6 +88,42 @@ declare const RollupNumberSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     number: number;
   };
 }, number>]>;
+/**
+ * Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object or `null`.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rollup: {
+ *     type: "date";
+ *     date: {
+ *       start: string;
+ *       end: string | null;
+ *       time_zone: string | null;
+ *     } | null;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `Date | null`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableRollupDateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     LatestDate: NullableRollupDateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.LatestDate: Date | null
+ * ```
+ */
 declare const NullableRollupDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly rollup: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"date", undefined>;
@@ -42,6 +143,42 @@ declare const NullableRollupDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchem
     } | null;
   };
 }, Date | null>]>;
+/**
+ * Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rollup: {
+ *     type: "date";
+ *     date: {
+ *       start: string;
+ *       end: string | null;
+ *       time_zone: string | null;
+ *     };
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RollupDateSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     LatestDate: RollupDateSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.LatestDate: Date
+ * ```
+ */
 declare const RollupDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly rollup: v.ObjectSchema<{
     readonly type: v.LiteralSchema<"date", undefined>;
@@ -61,6 +198,70 @@ declare const RollupDateSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     };
   };
 }, Date>]>;
+/**
+ * Schema factory to extract the `rollup` property with array type from a Notion page property.
+ *
+ * This is a generic schema factory that accepts another schema as a parameter,
+ * allowing you to combine it with other schemas in this library to extract
+ * typed rollup array results. The rollup property in Notion can return an
+ * array of different types of values depending on the rollup configuration.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   rollup: {
+ *     type: "array";
+ *     array: Array<{ type: string; ... }>;
+ *   };
+ * }
+ * ```
+ *
+ * **Output:** The output type depends on the schema passed as a parameter.
+ * For example, if a schema for number properties is passed, the output will be `Array<number>`.
+ *
+ * @param schema - A schema that validates each element in the rollup array.
+ *                  Must accept an object with a `type` field.
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RollupArraySchema, NumberSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     RollupNumbers: RollupArraySchema(NumberSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.RollupNumbers: number[]
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { RollupArraySchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * // Custom schema for relation rollup
+ * const RelationItemSchema = v.object({
+ *   type: v.literal("relation"),
+ *   relation: v.array(v.object({ id: v.string() })),
+ * });
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     RollupRelations: RollupArraySchema(RelationItemSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.RollupRelations: Array<{ type: "relation"; relation: Array<{ id: string }> }>
+ * ```
+ */
 declare function RollupArraySchema<S extends v.GenericSchema<{
   type: string;
 }, unknown>>(schema: S): v.SchemaWithPipe<readonly [v.ObjectSchema<{

package/dist/rollup.mjs

@@ -2,22 +2,222 @@ import { DateObjectSchema } from "./date.mjs";
 import * as v from "valibot";
 
 //#region src/rollup.ts
+/**
+* Schema to extract the `rollup` property with number type from a Notion page property or `null`.
+*
+* **Input:**
+* ```
+* {
+*   rollup: {
+*     type: "number";
+*     number: number | null;
+*   };
+* }
+* ```
+*
+* **Output:** `number | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableRollupNumberSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Sum: NullableRollupNumberSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Sum: number | null
+* ```
+*/
 const NullableRollupNumberSchema = v.pipe(v.object({ rollup: v.object({
 	type: v.literal("number"),
 	number: v.nullable(v.number())
 }) }), v.transform((v$1) => v$1.rollup.number));
+/**
+* Schema to extract the `rollup` property with number type from a Notion page property.
+*
+* **Input:**
+* ```
+* {
+*   rollup: {
+*     type: "number";
+*     number: number;
+*   };
+* }
+* ```
+*
+* **Output:** `number`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RollupNumberSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Sum: RollupNumberSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Sum: number
+* ```
+*/
 const RollupNumberSchema = v.pipe(v.object({ rollup: v.object({
 	type: v.literal("number"),
 	number: v.number()
 }) }), v.transform((v$1) => v$1.rollup.number));
+/**
+* Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object or `null`.
+*
+* **Input:**
+* ```
+* {
+*   rollup: {
+*     type: "date";
+*     date: {
+*       start: string;
+*       end: string | null;
+*       time_zone: string | null;
+*     } | null;
+*   };
+* }
+* ```
+*
+* **Output:** `Date | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableRollupDateSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     LatestDate: NullableRollupDateSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.LatestDate: Date | null
+* ```
+*/
 const NullableRollupDateSchema = v.pipe(v.object({ rollup: v.object({
 	type: v.literal("date"),
 	date: v.nullable(DateObjectSchema)
 }) }), v.transform((v$1) => v$1.rollup.date ? new Date(v$1.rollup.date.start) : null));
+/**
+* Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object.
+*
+* **Input:**
+* ```
+* {
+*   rollup: {
+*     type: "date";
+*     date: {
+*       start: string;
+*       end: string | null;
+*       time_zone: string | null;
+*     };
+*   };
+* }
+* ```
+*
+* **Output:** `Date`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RollupDateSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     LatestDate: RollupDateSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.LatestDate: Date
+* ```
+*/
 const RollupDateSchema = v.pipe(v.object({ rollup: v.object({
 	type: v.literal("date"),
 	date: DateObjectSchema
 }) }), v.transform((v$1) => new Date(v$1.rollup.date.start)));
+/**
+* Schema factory to extract the `rollup` property with array type from a Notion page property.
+*
+* This is a generic schema factory that accepts another schema as a parameter,
+* allowing you to combine it with other schemas in this library to extract
+* typed rollup array results. The rollup property in Notion can return an
+* array of different types of values depending on the rollup configuration.
+*
+* **Input:**
+* ```
+* {
+*   rollup: {
+*     type: "array";
+*     array: Array<{ type: string; ... }>;
+*   };
+* }
+* ```
+*
+* **Output:** The output type depends on the schema passed as a parameter.
+* For example, if a schema for number properties is passed, the output will be `Array<number>`.
+*
+* @param schema - A schema that validates each element in the rollup array.
+*                  Must accept an object with a `type` field.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RollupArraySchema, NumberSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     RollupNumbers: RollupArraySchema(NumberSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.RollupNumbers: number[]
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { RollupArraySchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for relation rollup
+* const RelationItemSchema = v.object({
+*   type: v.literal("relation"),
+*   relation: v.array(v.object({ id: v.string() })),
+* });
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     RollupRelations: RollupArraySchema(RelationItemSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.RollupRelations: Array<{ type: "relation"; relation: Array<{ id: string }> }>
+* ```
+*/
 function RollupArraySchema(schema) {
 	return v.pipe(v.object({ rollup: v.object({
 		type: v.literal("array"),

package/dist/rollup.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"rollup.mjs","names":["v"],"sources":["../src/rollup.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\n\nexport const NullableRollupNumberSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"number\"),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.rollup.number),\n);\n\nexport const RollupNumberSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"number\"),\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.rollup.number),\n);\n\nexport const NullableRollupDateSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"date\"),\n\t\t\tdate: v.nullable(DateObjectSchema),\n\t\t}),\n\t}),\n\tv.transform((v) => (v.rollup.date ? new Date(v.rollup.date.start) : null)),\n);\n\nexport const RollupDateSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"date\"),\n\t\t\tdate: DateObjectSchema,\n\t\t}),\n\t}),\n\tv.transform((v) => new Date(v.rollup.date.start)),\n);\n\nexport function RollupArraySchema<\n\tS extends v.GenericSchema<{ type: string }, unknown>,\n>(schema: S) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\trollup: v.object({\n\t\t\t\ttype: v.literal(\"array\"),\n\t\t\t\tarray: v.array(schema),\n\t\t\t}),\n\t\t}),\n\t\tv.transform((v) => v.rollup.array),\n\t);\n}\n"],"mappings":";;;;AAIA,MAAa,6BAA6B,EAAE,KAC3C,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,SAAS;CACzB,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,OAAO,CACnC;AAED,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,SAAS;CACzB,QAAQ,EAAE,QAAQ;CAClB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,OAAO,CACnC;AAED,MAAa,2BAA2B,EAAE,KACzC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM,EAAE,SAAS,iBAAiB;CAClC,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAOA,IAAE,OAAO,OAAO,IAAI,KAAKA,IAAE,OAAO,KAAK,MAAM,GAAG,KAAM,CAC1E;AAED,MAAa,mBAAmB,EAAE,KACjC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM;CACN,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,OAAO,KAAK,MAAM,CAAC,CACjD;AAED,SAAgB,kBAEd,QAAW;AACZ,QAAO,EAAE,KACR,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;EAChB,MAAM,EAAE,QAAQ,QAAQ;EACxB,OAAO,EAAE,MAAM,OAAO;EACtB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,MAAM,CAClC"}
+{"version":3,"file":"rollup.mjs","names":["v"],"sources":["../src/rollup.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\n\n/**\n * Schema to extract the `rollup` property with number type from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   rollup: {\n *     type: \"number\";\n *     number: number | null;\n *   };\n * }\n * ```\n *\n * **Output:** `number | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableRollupNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Sum: NullableRollupNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Sum: number | null\n * ```\n */\nexport const NullableRollupNumberSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"number\"),\n\t\t\tnumber: v.nullable(v.number()),\n\t\t}),\n\t}),\n\tv.transform((v) => v.rollup.number),\n);\n\n/**\n * Schema to extract the `rollup` property with number type from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   rollup: {\n *     type: \"number\";\n *     number: number;\n *   };\n * }\n * ```\n *\n * **Output:** `number`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RollupNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Sum: RollupNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Sum: number\n * ```\n */\nexport const RollupNumberSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"number\"),\n\t\t\tnumber: v.number(),\n\t\t}),\n\t}),\n\tv.transform((v) => v.rollup.number),\n);\n\n/**\n * Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object or `null`.\n *\n * **Input:**\n * ```\n * {\n *   rollup: {\n *     type: \"date\";\n *     date: {\n *       start: string;\n *       end: string | null;\n *       time_zone: string | null;\n *     } | null;\n *   };\n * }\n * ```\n *\n * **Output:** `Date | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableRollupDateSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     LatestDate: NullableRollupDateSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.LatestDate: Date | null\n * ```\n */\nexport const NullableRollupDateSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"date\"),\n\t\t\tdate: v.nullable(DateObjectSchema),\n\t\t}),\n\t}),\n\tv.transform((v) => (v.rollup.date ? new Date(v.rollup.date.start) : null)),\n);\n\n/**\n * Schema to extract the `rollup` property with date type from a Notion page property and transform it to a `Date` object.\n *\n * **Input:**\n * ```\n * {\n *   rollup: {\n *     type: \"date\";\n *     date: {\n *       start: string;\n *       end: string | null;\n *       time_zone: string | null;\n *     };\n *   };\n * }\n * ```\n *\n * **Output:** `Date`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RollupDateSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     LatestDate: RollupDateSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.LatestDate: Date\n * ```\n */\nexport const RollupDateSchema = v.pipe(\n\tv.object({\n\t\trollup: v.object({\n\t\t\ttype: v.literal(\"date\"),\n\t\t\tdate: DateObjectSchema,\n\t\t}),\n\t}),\n\tv.transform((v) => new Date(v.rollup.date.start)),\n);\n\n/**\n * Schema factory to extract the `rollup` property with array type from a Notion page property.\n *\n * This is a generic schema factory that accepts another schema as a parameter,\n * allowing you to combine it with other schemas in this library to extract\n * typed rollup array results. The rollup property in Notion can return an\n * array of different types of values depending on the rollup configuration.\n *\n * **Input:**\n * ```\n * {\n *   rollup: {\n *     type: \"array\";\n *     array: Array<{ type: string; ... }>;\n *   };\n * }\n * ```\n *\n * **Output:** The output type depends on the schema passed as a parameter.\n * For example, if a schema for number properties is passed, the output will be `Array<number>`.\n *\n * @param schema - A schema that validates each element in the rollup array.\n *                  Must accept an object with a `type` field.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RollupArraySchema, NumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     RollupNumbers: RollupArraySchema(NumberSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.RollupNumbers: number[]\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { RollupArraySchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for relation rollup\n * const RelationItemSchema = v.object({\n *   type: v.literal(\"relation\"),\n *   relation: v.array(v.object({ id: v.string() })),\n * });\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     RollupRelations: RollupArraySchema(RelationItemSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.RollupRelations: Array<{ type: \"relation\"; relation: Array<{ id: string }> }>\n * ```\n */\nexport function RollupArraySchema<\n\tS extends v.GenericSchema<{ type: string }, unknown>,\n>(schema: S) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\trollup: v.object({\n\t\t\t\ttype: v.literal(\"array\"),\n\t\t\t\tarray: v.array(schema),\n\t\t\t}),\n\t\t}),\n\t\tv.transform((v) => v.rollup.array),\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCA,MAAa,6BAA6B,EAAE,KAC3C,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,SAAS;CACzB,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAC9B,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,OAAO,CACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCD,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,SAAS;CACzB,QAAQ,EAAE,QAAQ;CAClB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,OAAO,CACnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCD,MAAa,2BAA2B,EAAE,KACzC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM,EAAE,SAAS,iBAAiB;CAClC,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAOA,IAAE,OAAO,OAAO,IAAI,KAAKA,IAAE,OAAO,KAAK,MAAM,GAAG,KAAM,CAC1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCD,MAAa,mBAAmB,EAAE,KACjC,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;CAChB,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM;CACN,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,OAAO,KAAK,MAAM,CAAC,CACjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkED,SAAgB,kBAEd,QAAW;AACZ,QAAO,EAAE,KACR,EAAE,OAAO,EACR,QAAQ,EAAE,OAAO;EAChB,MAAM,EAAE,QAAQ,QAAQ;EACxB,OAAO,EAAE,MAAM,OAAO;EACtB,CAAC,EACF,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,OAAO,MAAM,CAClC"}

package/dist/select.cjs

@@ -3,9 +3,129 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/select.ts
+/**
+* Schema factory to extract the `select` property from a Notion page property.
+*
+* This is a generic schema factory that accepts another schema as a parameter,
+* allowing you to combine it with other schemas in this library to extract
+* typed select values. The select property in Notion contains an object with
+* a `name` field that can be validated using the provided schema.
+*
+* **Input:**
+* ```
+* {
+*   select: {
+*     name: string;
+*   };
+* }
+* ```
+*
+* **Output:** The output type depends on the schema passed as a parameter.
+* For example, if `v.string()` is passed, the output will be `string`.
+*
+* @param schema - A schema that validates the select option name.
+*                  Must accept a string value.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { SelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Status: SelectSchema(v.string()),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Status: string
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { SelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for enum values
+* const StatusSchema = v.picklist(["todo", "in-progress", "done"]);
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Status: SelectSchema(StatusSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Status: "todo" | "in-progress" | "done"
+* ```
+*/
 function SelectSchema(schema) {
 	return valibot.pipe(valibot.object({ select: valibot.object({ name: schema }) }), valibot.transform((v) => v.select.name));
 }
+/**
+* Schema factory to extract the `select` property from a Notion page property or `null`.
+*
+* This is a generic schema factory that accepts another schema as a parameter,
+* allowing you to combine it with other schemas in this library to extract
+* typed select values. The select property in Notion contains an object with
+* a `name` field that can be validated using the provided schema, or `null` if not set.
+*
+* **Input:**
+* ```
+* {
+*   select: {
+*     name: string;
+*   } | null;
+* }
+* ```
+*
+* **Output:** The output type depends on the schema passed as a parameter, or `null`.
+* For example, if `v.string()` is passed, the output will be `string | null`.
+*
+* @param schema - A schema that validates the select option name.
+*                  Must accept a string value.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Status: NullableSelectSchema(v.string()),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Status: string | null
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for enum values
+* const StatusSchema = v.picklist(["todo", "in-progress", "done"]);
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Status: NullableSelectSchema(StatusSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Status: "todo" | "in-progress" | "done" | null
+* ```
+*/
 function NullableSelectSchema(schema) {
 	return valibot.pipe(valibot.object({ select: valibot.nullable(valibot.object({ name: schema })) }), valibot.transform((v) => v.select?.name ?? null));
 }

package/dist/select.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"select.cjs","names":["v"],"sources":["../src/select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport function SelectSchema<T extends v.GenericSchema<string>>(schema: T) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tselect: v.object({\n\t\t\t\tname: schema,\n\t\t\t}),\n\t\t}),\n\t\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.select.name!),\n\t);\n}\n\nexport function NullableSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tselect: v.nullable(\n\t\t\t\tv.object({\n\t\t\t\t\tname: schema,\n\t\t\t\t}),\n\t\t\t),\n\t\t}),\n\t\tv.transform((v) => v.select?.name ?? null),\n\t);\n}\n"],"mappings":";;;;;AAEA,SAAgB,aAAgD,QAAW;AAC1E,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,QAAQA,QAAE,OAAO,EAChB,MAAM,QACN,CAAC,EACF,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,OAAO,KAAM,CAClC;;AAGF,SAAgB,qBACf,QACC;AACD,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,QAAQA,QAAE,SACTA,QAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,QAAQ,QAAQ,KAAK,CAC1C"}
+{"version":3,"file":"select.cjs","names":["v"],"sources":["../src/select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema factory to extract the `select` property from a Notion page property.\n *\n * This is a generic schema factory that accepts another schema as a parameter,\n * allowing you to combine it with other schemas in this library to extract\n * typed select values. The select property in Notion contains an object with\n * a `name` field that can be validated using the provided schema.\n *\n * **Input:**\n * ```\n * {\n *   select: {\n *     name: string;\n *   };\n * }\n * ```\n *\n * **Output:** The output type depends on the schema passed as a parameter.\n * For example, if `v.string()` is passed, the output will be `string`.\n *\n * @param schema - A schema that validates the select option name.\n *                  Must accept a string value.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { SelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Status: SelectSchema(v.string()),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Status: string\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { SelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for enum values\n * const StatusSchema = v.picklist([\"todo\", \"in-progress\", \"done\"]);\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Status: SelectSchema(StatusSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Status: \"todo\" | \"in-progress\" | \"done\"\n * ```\n */\nexport function SelectSchema<T extends v.GenericSchema<string>>(schema: T) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tselect: v.object({\n\t\t\t\tname: schema,\n\t\t\t}),\n\t\t}),\n\t\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.select.name!),\n\t);\n}\n\n/**\n * Schema factory to extract the `select` property from a Notion page property or `null`.\n *\n * This is a generic schema factory that accepts another schema as a parameter,\n * allowing you to combine it with other schemas in this library to extract\n * typed select values. The select property in Notion contains an object with\n * a `name` field that can be validated using the provided schema, or `null` if not set.\n *\n * **Input:**\n * ```\n * {\n *   select: {\n *     name: string;\n *   } | null;\n * }\n * ```\n *\n * **Output:** The output type depends on the schema passed as a parameter, or `null`.\n * For example, if `v.string()` is passed, the output will be `string | null`.\n *\n * @param schema - A schema that validates the select option name.\n *                  Must accept a string value.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Status: NullableSelectSchema(v.string()),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Status: string | null\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for enum values\n * const StatusSchema = v.picklist([\"todo\", \"in-progress\", \"done\"]);\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Status: NullableSelectSchema(StatusSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Status: \"todo\" | \"in-progress\" | \"done\" | null\n * ```\n */\nexport function NullableSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tselect: v.nullable(\n\t\t\t\tv.object({\n\t\t\t\t\tname: schema,\n\t\t\t\t}),\n\t\t\t),\n\t\t}),\n\t\tv.transform((v) => v.select?.name ?? null),\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgB,aAAgD,QAAW;AAC1E,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,QAAQA,QAAE,OAAO,EAChB,MAAM,QACN,CAAC,EACF,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,OAAO,KAAM,CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DF,SAAgB,qBACf,QACC;AACD,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,QAAQA,QAAE,SACTA,QAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,QAAQ,QAAQ,KAAK,CAC1C"}