@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.5

package/dist/last-edited-by.mjs

@@ -2,7 +2,75 @@ import { PersonSchema } from "./people.mjs";
 import * as v from "valibot";
 
 //#region src/last-edited-by.ts
+/**
+* Schema to extract the `last_edited_by` person name from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   last_edited_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:** `string | null`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableLastEditedByNameSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     LastEditedByName: NullableLastEditedByNameSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.LastEditedByName: string | null
+* ```
+*/
 const NullableLastEditedByNameSchema = v.pipe(v.object({ last_edited_by: PersonSchema }), v.transform((v$1) => v$1.last_edited_by.name));
+/**
+* Schema to extract the `last_edited_by` person ID from a Notion page.
+*
+* **Input:**
+* ```
+* {
+*   last_edited_by: {
+*     id: string;
+*     object: "user" | "bot" | "group";
+*     name: string | null;
+*     ...
+*   }
+* }
+* ```
+*
+* **Output:** `string`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { LastEditedByIdSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     LastEditedById: LastEditedByIdSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.LastEditedById: string
+* ```
+*/
 const LastEditedByIdSchema = v.pipe(v.object({ last_edited_by: PersonSchema }), v.transform((v$1) => v$1.last_edited_by.id));
 
 //#endregion

package/dist/last-edited-by.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"last-edited-by.mjs","names":["v"],"sources":["../src/last-edited-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\nexport const NullableLastEditedByNameSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.last_edited_by.name),\n);\n\nexport const LastEditedByIdSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.last_edited_by.id),\n);\n"],"mappings":";;;;AAIA,MAAa,iCAAiC,EAAE,KAC/C,EAAE,OAAO,EACR,gBAAgB,cAChB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,eAAe,KAAK,CACzC;AAED,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,gBAAgB,cAChB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,eAAe,GAAG,CACvC"}
+{"version":3,"file":"last-edited-by.mjs","names":["v"],"sources":["../src/last-edited-by.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { PersonSchema } from \"./people\";\n\n/**\n * Schema to extract the `last_edited_by` person name from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   last_edited_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableLastEditedByNameSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     LastEditedByName: NullableLastEditedByNameSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.LastEditedByName: string | null\n * ```\n */\nexport const NullableLastEditedByNameSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.last_edited_by.name),\n);\n\n/**\n * Schema to extract the `last_edited_by` person ID from a Notion page.\n *\n * **Input:**\n * ```\n * {\n *   last_edited_by: {\n *     id: string;\n *     object: \"user\" | \"bot\" | \"group\";\n *     name: string | null;\n *     ...\n *   }\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { LastEditedByIdSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     LastEditedById: LastEditedByIdSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.LastEditedById: string\n * ```\n */\nexport const LastEditedByIdSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_by: PersonSchema,\n\t}),\n\tv.transform((v) => v.last_edited_by.id),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCA,MAAa,iCAAiC,EAAE,KAC/C,EAAE,OAAO,EACR,gBAAgB,cAChB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,eAAe,KAAK,CACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCD,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,gBAAgB,cAChB,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,eAAe,GAAG,CACvC"}

package/dist/last-edited-time.cjs

@@ -3,6 +3,33 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/last-edited-time.ts
+/**
+* Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.
+*
+* **Input:**
+* ```
+* {
+*   last_edited_time: string;
+* }
+* ```
+*
+* **Output:** `Date`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { LastEditedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   last_edited_time: LastEditedTimeSchema,
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.last_edited_time: Date
+* ```
+*/
 const LastEditedTimeSchema = valibot.pipe(valibot.object({ last_edited_time: valibot.string() }), valibot.transform((v) => new Date(v.last_edited_time)));
 
 //#endregion

package/dist/last-edited-time.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"last-edited-time.cjs","names":["v"],"sources":["../src/last-edited-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const LastEditedTimeSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.last_edited_time)),\n);\n"],"mappings":";;;;;AAEA,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,kBAAkBA,QAAE,QAAQ,EAC5B,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,iBAAiB,CAAC,CAChD"}
+{"version":3,"file":"last-edited-time.cjs","names":["v"],"sources":["../src/last-edited-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.\n *\n * **Input:**\n * ```\n * {\n *   last_edited_time: string;\n * }\n * ```\n *\n * **Output:** `Date`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { LastEditedTimeSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   last_edited_time: LastEditedTimeSchema,\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.last_edited_time: Date\n * ```\n */\nexport const LastEditedTimeSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.last_edited_time)),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,kBAAkBA,QAAE,QAAQ,EAC5B,CAAC,EACFA,QAAE,WAAW,MAAM,IAAI,KAAK,EAAE,iBAAiB,CAAC,CAChD"}

package/dist/last-edited-time.d.cts

@@ -1,6 +1,34 @@
 import * as v from "valibot";
 
 //#region src/last-edited-time.d.ts
+
+/**
+ * Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   last_edited_time: string;
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { LastEditedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   last_edited_time: LastEditedTimeSchema,
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.last_edited_time: Date
+ * ```
+ */
 declare const LastEditedTimeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly last_edited_time: v.StringSchema<undefined>;
 }, undefined>, v.TransformAction<{

package/dist/last-edited-time.d.mts

@@ -1,6 +1,34 @@
 import * as v from "valibot";
 
 //#region src/last-edited-time.d.ts
+
+/**
+ * Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   last_edited_time: string;
+ * }
+ * ```
+ *
+ * **Output:** `Date`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { LastEditedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   last_edited_time: LastEditedTimeSchema,
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.last_edited_time: Date
+ * ```
+ */
 declare const LastEditedTimeSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly last_edited_time: v.StringSchema<undefined>;
 }, undefined>, v.TransformAction<{

package/dist/last-edited-time.mjs

@@ -1,6 +1,33 @@
 import * as v from "valibot";
 
 //#region src/last-edited-time.ts
+/**
+* Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.
+*
+* **Input:**
+* ```
+* {
+*   last_edited_time: string;
+* }
+* ```
+*
+* **Output:** `Date`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { LastEditedTimeSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   last_edited_time: LastEditedTimeSchema,
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.last_edited_time: Date
+* ```
+*/
 const LastEditedTimeSchema = v.pipe(v.object({ last_edited_time: v.string() }), v.transform((v$1) => new Date(v$1.last_edited_time)));
 
 //#endregion

package/dist/last-edited-time.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"last-edited-time.mjs","names":["v"],"sources":["../src/last-edited-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const LastEditedTimeSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.last_edited_time)),\n);\n"],"mappings":";;;AAEA,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,kBAAkB,EAAE,QAAQ,EAC5B,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,iBAAiB,CAAC,CAChD"}
+{"version":3,"file":"last-edited-time.mjs","names":["v"],"sources":["../src/last-edited-time.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `last_edited_time` property from a Notion page and transform it to a `Date` object.\n *\n * **Input:**\n * ```\n * {\n *   last_edited_time: string;\n * }\n * ```\n *\n * **Output:** `Date`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { LastEditedTimeSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   last_edited_time: LastEditedTimeSchema,\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.last_edited_time: Date\n * ```\n */\nexport const LastEditedTimeSchema = v.pipe(\n\tv.object({\n\t\tlast_edited_time: v.string(),\n\t}),\n\tv.transform((v) => new Date(v.last_edited_time)),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,MAAa,uBAAuB,EAAE,KACrC,EAAE,OAAO,EACR,kBAAkB,EAAE,QAAQ,EAC5B,CAAC,EACF,EAAE,WAAW,QAAM,IAAI,KAAKA,IAAE,iBAAiB,CAAC,CAChD"}

package/dist/multi-select.cjs

@@ -3,6 +3,66 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/multi-select.ts
+/**
+* Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an
+* array of objects with a `name` field that can be validated using the provided schema.
+*
+* **Input:**
+* ```
+* {
+*   multi_select: Array<{
+*     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 multi-select option name.
+*                  Must accept a string value.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Tags: MultiSelectSchema(v.string()),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Tags: string[]
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for enum values
+* const TagSchema = v.picklist(["urgent", "important", "normal"]);
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Tags: MultiSelectSchema(TagSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Tags: ("urgent" | "important" | "normal")[]
+* ```
+*/
 function MultiSelectSchema(schema) {
 	return valibot.pipe(valibot.object({ multi_select: valibot.array(valibot.object({ name: schema })) }), valibot.transform((v) => v.multi_select.map((v$1) => v$1.name)));
 }

package/dist/multi-select.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"multi-select.cjs","names":["v"],"sources":["../src/multi-select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport function MultiSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tmulti_select: v.array(\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\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.multi_select.map((v) => v.name!)),\n\t);\n}\n"],"mappings":";;;;;AAEA,SAAgB,kBACf,QACC;AACD,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,cAAcA,QAAE,MACfA,QAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,aAAa,KAAK,QAAMA,IAAE,KAAM,CAAC,CACtD"}
+{"version":3,"file":"multi-select.cjs","names":["v"],"sources":["../src/multi-select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an\n * array of objects with a `name` field that can be validated using the provided schema.\n *\n * **Input:**\n * ```\n * {\n *   multi_select: Array<{\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 multi-select option name.\n *                  Must accept a string value.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { MultiSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Tags: MultiSelectSchema(v.string()),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Tags: string[]\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { MultiSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for enum values\n * const TagSchema = v.picklist([\"urgent\", \"important\", \"normal\"]);\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Tags: MultiSelectSchema(TagSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Tags: (\"urgent\" | \"important\" | \"normal\")[]\n * ```\n */\nexport function MultiSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tmulti_select: v.array(\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\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.multi_select.map((v) => v.name!)),\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgB,kBACf,QACC;AACD,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,cAAcA,QAAE,MACfA,QAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,aAAa,KAAK,QAAMA,IAAE,KAAM,CAAC,CACtD"}

package/dist/multi-select.d.cts

@@ -1,6 +1,67 @@
 import * as v from "valibot";
 
 //#region src/multi-select.d.ts
+
+/**
+ * Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an
+ * array of objects with a `name` field that can be validated using the provided schema.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   multi_select: Array<{
+ *     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 multi-select option name.
+ *                  Must accept a string value.
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Tags: MultiSelectSchema(v.string()),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Tags: string[]
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * // Custom schema for enum values
+ * const TagSchema = v.picklist(["urgent", "important", "normal"]);
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Tags: MultiSelectSchema(TagSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Tags: ("urgent" | "important" | "normal")[]
+ * ```
+ */
 declare function MultiSelectSchema<T extends v.GenericSchema<string>>(schema: T): v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly multi_select: v.ArraySchema<v.ObjectSchema<{
     readonly name: T;

package/dist/multi-select.d.mts

@@ -1,6 +1,67 @@
 import * as v from "valibot";
 
 //#region src/multi-select.d.ts
+
+/**
+ * Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an
+ * array of objects with a `name` field that can be validated using the provided schema.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   multi_select: Array<{
+ *     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 multi-select option name.
+ *                  Must accept a string value.
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Tags: MultiSelectSchema(v.string()),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Tags: string[]
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * // Custom schema for enum values
+ * const TagSchema = v.picklist(["urgent", "important", "normal"]);
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Tags: MultiSelectSchema(TagSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Tags: ("urgent" | "important" | "normal")[]
+ * ```
+ */
 declare function MultiSelectSchema<T extends v.GenericSchema<string>>(schema: T): v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly multi_select: v.ArraySchema<v.ObjectSchema<{
     readonly name: T;

package/dist/multi-select.mjs

@@ -1,6 +1,66 @@
 import * as v from "valibot";
 
 //#region src/multi-select.ts
+/**
+* Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an
+* array of objects with a `name` field that can be validated using the provided schema.
+*
+* **Input:**
+* ```
+* {
+*   multi_select: Array<{
+*     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 multi-select option name.
+*                  Must accept a string value.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Tags: MultiSelectSchema(v.string()),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Tags: string[]
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { MultiSelectSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for enum values
+* const TagSchema = v.picklist(["urgent", "important", "normal"]);
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Tags: MultiSelectSchema(TagSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Tags: ("urgent" | "important" | "normal")[]
+* ```
+*/
 function MultiSelectSchema(schema) {
 	return v.pipe(v.object({ multi_select: v.array(v.object({ name: schema })) }), v.transform((v$1) => v$1.multi_select.map((v$2) => v$2.name)));
 }

package/dist/multi-select.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"multi-select.mjs","names":["v"],"sources":["../src/multi-select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport function MultiSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tmulti_select: v.array(\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\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.multi_select.map((v) => v.name!)),\n\t);\n}\n"],"mappings":";;;AAEA,SAAgB,kBACf,QACC;AACD,QAAO,EAAE,KACR,EAAE,OAAO,EACR,cAAc,EAAE,MACf,EAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EAEF,EAAE,WAAW,QAAMA,IAAE,aAAa,KAAK,QAAMA,IAAE,KAAM,CAAC,CACtD"}
+{"version":3,"file":"multi-select.mjs","names":["v"],"sources":["../src/multi-select.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema factory to extract the `multi_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 multi-select values. The multi-select property in Notion contains an\n * array of objects with a `name` field that can be validated using the provided schema.\n *\n * **Input:**\n * ```\n * {\n *   multi_select: Array<{\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 multi-select option name.\n *                  Must accept a string value.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { MultiSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Tags: MultiSelectSchema(v.string()),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Tags: string[]\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { MultiSelectSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for enum values\n * const TagSchema = v.picklist([\"urgent\", \"important\", \"normal\"]);\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Tags: MultiSelectSchema(TagSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Tags: (\"urgent\" | \"important\" | \"normal\")[]\n * ```\n */\nexport function MultiSelectSchema<T extends v.GenericSchema<string>>(\n\tschema: T,\n) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tmulti_select: v.array(\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\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.multi_select.map((v) => v.name!)),\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8DA,SAAgB,kBACf,QACC;AACD,QAAO,EAAE,KACR,EAAE,OAAO,EACR,cAAc,EAAE,MACf,EAAE,OAAO,EACR,MAAM,QACN,CAAC,CACF,EACD,CAAC,EAEF,EAAE,WAAW,QAAMA,IAAE,aAAa,KAAK,QAAMA,IAAE,KAAM,CAAC,CACtD"}

package/dist/number.cjs

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

package/dist/number.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"number.cjs","names":["v"],"sources":["../src/number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const NumberSchema = v.pipe(\n\tv.object({\n\t\tnumber: v.number(),\n\t}),\n\tv.transform((v) => v.number),\n);\n\nexport const NullableNumberSchema = v.pipe(\n\tv.object({\n\t\tnumber: v.nullable(v.number()),\n\t}),\n\tv.transform((v) => v.number),\n);\n"],"mappings":";;;;;AAEA,MAAa,eAAeA,QAAE,KAC7BA,QAAE,OAAO,EACR,QAAQA,QAAE,QAAQ,EAClB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B;AAED,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC9B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B"}
+{"version":3,"file":"number.cjs","names":["v"],"sources":["../src/number.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `number` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   number: number;\n * }\n * ```\n *\n * **Output:** `number`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Number: NumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Number: number\n * ```\n */\nexport const NumberSchema = v.pipe(\n\tv.object({\n\t\tnumber: v.number(),\n\t}),\n\tv.transform((v) => v.number),\n);\n\n/**\n * Schema to extract the `number` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   number: number | null;\n * }\n * ```\n *\n * **Output:** `number | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableNumberSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Number: NullableNumberSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Number: number | null\n * ```\n */\nexport const NullableNumberSchema = v.pipe(\n\tv.object({\n\t\tnumber: v.nullable(v.number()),\n\t}),\n\tv.transform((v) => v.number),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,eAAeA,QAAE,KAC7BA,QAAE,OAAO,EACR,QAAQA,QAAE,QAAQ,EAClB,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,uBAAuBA,QAAE,KACrCA,QAAE,OAAO,EACR,QAAQA,QAAE,SAASA,QAAE,QAAQ,CAAC,EAC9B,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,OAAO,CAC5B"}

package/dist/number.d.cts

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