@nakanoaas/notion-valibot-schema 0.0.3 → 0.0.5

package/dist/email.d.mts

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

package/dist/email.mjs

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

package/dist/email.mjs.map

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

package/dist/files.cjs

@@ -3,6 +3,45 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/files.ts
+/**
+* Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.
+*
+* **Input:**
+* ```
+* {
+*   files: Array<{
+*     type: "file";
+*     file: {
+*       url: string;
+*     };
+*   } | {
+*     type: "external";
+*     external: {
+*       url: string;
+*     };
+*   }>;
+* }
+* ```
+*
+* **Output:** `string[]`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FilesSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Files: FilesSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Files: string[]
+* ```
+*/
 const FilesSchema = valibot.pipe(valibot.object({ files: valibot.array(valibot.variant("type", [valibot.object({
 	type: valibot.literal("file"),
 	file: valibot.object({ url: valibot.string() })

package/dist/files.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"files.cjs","names":["v"],"sources":["../src/files.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const FilesSchema = v.pipe(\n\tv.object({\n\t\tfiles: v.array(\n\t\t\tv.variant(\"type\", [\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"file\"),\n\t\t\t\t\tfile: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"external\"),\n\t\t\t\t\texternal: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t]),\n\t\t),\n\t}),\n\tv.transform((v) =>\n\t\tv.files.map((v) => (v.type === \"file\" ? v.file.url : v.external.url)),\n\t),\n);\n"],"mappings":";;;;;AAEA,MAAa,cAAcA,QAAE,KAC5BA,QAAE,OAAO,EACR,OAAOA,QAAE,MACRA,QAAE,QAAQ,QAAQ,CACjBA,QAAE,OAAO;CACR,MAAMA,QAAE,QAAQ,OAAO;CACvB,MAAMA,QAAE,OAAO,EACd,KAAKA,QAAE,QAAQ,EACf,CAAC;CACF,CAAC,EACFA,QAAE,OAAO;CACR,MAAMA,QAAE,QAAQ,WAAW;CAC3B,UAAUA,QAAE,OAAO,EAClB,KAAKA,QAAE,QAAQ,EACf,CAAC;CACF,CAAC,CACF,CAAC,CACF,EACD,CAAC,EACFA,QAAE,WAAW,MACZ,EAAE,MAAM,KAAK,QAAOA,IAAE,SAAS,SAASA,IAAE,KAAK,MAAMA,IAAE,SAAS,IAAK,CACrE,CACD"}
+{"version":3,"file":"files.cjs","names":["v"],"sources":["../src/files.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.\n *\n * **Input:**\n * ```\n * {\n *   files: Array<{\n *     type: \"file\";\n *     file: {\n *       url: string;\n *     };\n *   } | {\n *     type: \"external\";\n *     external: {\n *       url: string;\n *     };\n *   }>;\n * }\n * ```\n *\n * **Output:** `string[]`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { FilesSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Files: FilesSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Files: string[]\n * ```\n */\nexport const FilesSchema = v.pipe(\n\tv.object({\n\t\tfiles: v.array(\n\t\t\tv.variant(\"type\", [\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"file\"),\n\t\t\t\t\tfile: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"external\"),\n\t\t\t\t\texternal: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t]),\n\t\t),\n\t}),\n\tv.transform((v) =>\n\t\tv.files.map((v) => (v.type === \"file\" ? v.file.url : v.external.url)),\n\t),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,MAAa,cAAcA,QAAE,KAC5BA,QAAE,OAAO,EACR,OAAOA,QAAE,MACRA,QAAE,QAAQ,QAAQ,CACjBA,QAAE,OAAO;CACR,MAAMA,QAAE,QAAQ,OAAO;CACvB,MAAMA,QAAE,OAAO,EACd,KAAKA,QAAE,QAAQ,EACf,CAAC;CACF,CAAC,EACFA,QAAE,OAAO;CACR,MAAMA,QAAE,QAAQ,WAAW;CAC3B,UAAUA,QAAE,OAAO,EAClB,KAAKA,QAAE,QAAQ,EACf,CAAC;CACF,CAAC,CACF,CAAC,CACF,EACD,CAAC,EACFA,QAAE,WAAW,MACZ,EAAE,MAAM,KAAK,QAAOA,IAAE,SAAS,SAASA,IAAE,KAAK,MAAMA,IAAE,SAAS,IAAK,CACrE,CACD"}

package/dist/files.d.cts

@@ -1,6 +1,46 @@
 import * as v from "valibot";
 
 //#region src/files.d.ts
+
+/**
+ * Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   files: Array<{
+ *     type: "file";
+ *     file: {
+ *       url: string;
+ *     };
+ *   } | {
+ *     type: "external";
+ *     external: {
+ *       url: string;
+ *     };
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string[]`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FilesSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Files: FilesSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Files: string[]
+ * ```
+ */
 declare const FilesSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly files: v.ArraySchema<v.VariantSchema<"type", [v.ObjectSchema<{
     readonly type: v.LiteralSchema<"file", undefined>;

package/dist/files.d.mts

@@ -1,6 +1,46 @@
 import * as v from "valibot";
 
 //#region src/files.d.ts
+
+/**
+ * Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   files: Array<{
+ *     type: "file";
+ *     file: {
+ *       url: string;
+ *     };
+ *   } | {
+ *     type: "external";
+ *     external: {
+ *       url: string;
+ *     };
+ *   }>;
+ * }
+ * ```
+ *
+ * **Output:** `string[]`
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FilesSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Files: FilesSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Files: string[]
+ * ```
+ */
 declare const FilesSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly files: v.ArraySchema<v.VariantSchema<"type", [v.ObjectSchema<{
     readonly type: v.LiteralSchema<"file", undefined>;

package/dist/files.mjs

@@ -1,6 +1,45 @@
 import * as v from "valibot";
 
 //#region src/files.ts
+/**
+* Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.
+*
+* **Input:**
+* ```
+* {
+*   files: Array<{
+*     type: "file";
+*     file: {
+*       url: string;
+*     };
+*   } | {
+*     type: "external";
+*     external: {
+*       url: string;
+*     };
+*   }>;
+* }
+* ```
+*
+* **Output:** `string[]`
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FilesSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Files: FilesSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Files: string[]
+* ```
+*/
 const FilesSchema = v.pipe(v.object({ files: v.array(v.variant("type", [v.object({
 	type: v.literal("file"),
 	file: v.object({ url: v.string() })

package/dist/files.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"files.mjs","names":["v"],"sources":["../src/files.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const FilesSchema = v.pipe(\n\tv.object({\n\t\tfiles: v.array(\n\t\t\tv.variant(\"type\", [\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"file\"),\n\t\t\t\t\tfile: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"external\"),\n\t\t\t\t\texternal: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t]),\n\t\t),\n\t}),\n\tv.transform((v) =>\n\t\tv.files.map((v) => (v.type === \"file\" ? v.file.url : v.external.url)),\n\t),\n);\n"],"mappings":";;;AAEA,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,EAAE,MACR,EAAE,QAAQ,QAAQ,CACjB,EAAE,OAAO;CACR,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM,EAAE,OAAO,EACd,KAAK,EAAE,QAAQ,EACf,CAAC;CACF,CAAC,EACF,EAAE,OAAO;CACR,MAAM,EAAE,QAAQ,WAAW;CAC3B,UAAU,EAAE,OAAO,EAClB,KAAK,EAAE,QAAQ,EACf,CAAC;CACF,CAAC,CACF,CAAC,CACF,EACD,CAAC,EACF,EAAE,WAAW,QACZA,IAAE,MAAM,KAAK,QAAOA,IAAE,SAAS,SAASA,IAAE,KAAK,MAAMA,IAAE,SAAS,IAAK,CACrE,CACD"}
+{"version":3,"file":"files.mjs","names":["v"],"sources":["../src/files.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `files` property from a Notion page property and transform it to an array of URLs.\n *\n * **Input:**\n * ```\n * {\n *   files: Array<{\n *     type: \"file\";\n *     file: {\n *       url: string;\n *     };\n *   } | {\n *     type: \"external\";\n *     external: {\n *       url: string;\n *     };\n *   }>;\n * }\n * ```\n *\n * **Output:** `string[]`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { FilesSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Files: FilesSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Files: string[]\n * ```\n */\nexport const FilesSchema = v.pipe(\n\tv.object({\n\t\tfiles: v.array(\n\t\t\tv.variant(\"type\", [\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"file\"),\n\t\t\t\t\tfile: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t\tv.object({\n\t\t\t\t\ttype: v.literal(\"external\"),\n\t\t\t\t\texternal: v.object({\n\t\t\t\t\t\turl: v.string(),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t]),\n\t\t),\n\t}),\n\tv.transform((v) =>\n\t\tv.files.map((v) => (v.type === \"file\" ? v.file.url : v.external.url)),\n\t),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,MAAa,cAAc,EAAE,KAC5B,EAAE,OAAO,EACR,OAAO,EAAE,MACR,EAAE,QAAQ,QAAQ,CACjB,EAAE,OAAO;CACR,MAAM,EAAE,QAAQ,OAAO;CACvB,MAAM,EAAE,OAAO,EACd,KAAK,EAAE,QAAQ,EACf,CAAC;CACF,CAAC,EACF,EAAE,OAAO;CACR,MAAM,EAAE,QAAQ,WAAW;CAC3B,UAAU,EAAE,OAAO,EAClB,KAAK,EAAE,QAAQ,EACf,CAAC;CACF,CAAC,CACF,CAAC,CACF,EACD,CAAC,EACF,EAAE,WAAW,QACZA,IAAE,MAAM,KAAK,QAAOA,IAAE,SAAS,SAASA,IAAE,KAAK,MAAMA,IAAE,SAAS,IAAK,CACrE,CACD"}

package/dist/formula.cjs

@@ -3,6 +3,78 @@ let valibot = require("valibot");
 valibot = require_rolldown_runtime.__toESM(valibot);
 
 //#region src/formula.ts
+/**
+* Schema factory to extract the `formula` property result 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 formula results. The formula property in Notion can return different
+* types of values (string, number, boolean, or date) depending on the formula
+* configuration.
+*
+* **Input:**
+* ```
+* {
+*   formula: {
+*     type: "string" | "number" | "boolean" | "date";
+*     string?: string | null;
+*     number?: number | null;
+*     boolean?: boolean | null;
+*     date?: {
+*       start: string;
+*       end: string | null;
+*       time_zone: string | null;
+*     } | null;
+*   }
+* }
+* ```
+*
+* **Output:** The output type depends on the schema passed as a parameter.
+* For example, if `RichTextSchema` is passed, the output will be `string`.
+*
+* @param schema - A schema that validates the formula result type.
+*                  Must accept one of: string, number, boolean, or date formula results.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FormulaSchema, RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     FormulaText: FormulaSchema(RichTextSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.FormulaText: string
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FormulaSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for number formula
+* const NumberFormulaSchema = v.object({
+*   type: v.literal("number"),
+*   number: v.nullable(v.number()),
+* });
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     FormulaNumber: FormulaSchema(NumberFormulaSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.FormulaNumber: { type: "number"; number: number | null }
+* ```
+*/
 function FormulaSchema(schema) {
 	return valibot.pipe(valibot.object({ formula: schema }), valibot.transform((v) => v.formula));
 }

package/dist/formula.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"formula.cjs","names":["v"],"sources":["../src/formula.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport function FormulaSchema<\n\tS extends v.GenericSchema<\n\t\t| { type: \"string\"; string: string | null }\n\t\t| { type: \"number\"; number: number | null }\n\t\t| { type: \"boolean\"; boolean: boolean | null }\n\t\t| {\n\t\t\t\ttype: \"date\";\n\t\t\t\tdate: {\n\t\t\t\t\tstart: string;\n\t\t\t\t\tend: string | null;\n\t\t\t\t\ttime_zone: string | null;\n\t\t\t\t} | null;\n\t\t  },\n\t\tunknown\n\t>,\n>(schema: S) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tformula: schema,\n\t\t}),\n\t\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.formula!),\n\t);\n}\n"],"mappings":";;;;;AAEA,SAAgB,cAed,QAAW;AACZ,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,SAAS,QACT,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,QAAS,CAC9B"}
+{"version":3,"file":"formula.cjs","names":["v"],"sources":["../src/formula.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema factory to extract the `formula` property result 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 formula results. The formula property in Notion can return different\n * types of values (string, number, boolean, or date) depending on the formula\n * configuration.\n *\n * **Input:**\n * ```\n * {\n *   formula: {\n *     type: \"string\" | \"number\" | \"boolean\" | \"date\";\n *     string?: string | null;\n *     number?: number | null;\n *     boolean?: boolean | null;\n *     date?: {\n *       start: string;\n *       end: string | null;\n *       time_zone: string | null;\n *     } | null;\n *   }\n * }\n * ```\n *\n * **Output:** The output type depends on the schema passed as a parameter.\n * For example, if `RichTextSchema` is passed, the output will be `string`.\n *\n * @param schema - A schema that validates the formula result type.\n *                  Must accept one of: string, number, boolean, or date formula results.\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { FormulaSchema, RichTextSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     FormulaText: FormulaSchema(RichTextSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.FormulaText: string\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { FormulaSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * // Custom schema for number formula\n * const NumberFormulaSchema = v.object({\n *   type: v.literal(\"number\"),\n *   number: v.nullable(v.number()),\n * });\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     FormulaNumber: FormulaSchema(NumberFormulaSchema),\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.FormulaNumber: { type: \"number\"; number: number | null }\n * ```\n */\nexport function FormulaSchema<\n\tS extends v.GenericSchema<\n\t\t| { type: \"string\"; string: string | null }\n\t\t| { type: \"number\"; number: number | null }\n\t\t| { type: \"boolean\"; boolean: boolean | null }\n\t\t| {\n\t\t\t\ttype: \"date\";\n\t\t\t\tdate: {\n\t\t\t\t\tstart: string;\n\t\t\t\t\tend: string | null;\n\t\t\t\t\ttime_zone: string | null;\n\t\t\t\t} | null;\n\t\t  },\n\t\tunknown\n\t>,\n>(schema: S) {\n\treturn v.pipe(\n\t\tv.object({\n\t\t\tformula: schema,\n\t\t}),\n\t\t// biome-ignore lint/style/noNonNullAssertion: valibot inference is not working correctly\n\t\tv.transform((v) => v.formula!),\n\t);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0EA,SAAgB,cAed,QAAW;AACZ,QAAOA,QAAE,KACRA,QAAE,OAAO,EACR,SAAS,QACT,CAAC,EAEFA,QAAE,WAAW,MAAM,EAAE,QAAS,CAC9B"}

package/dist/formula.d.cts

@@ -1,6 +1,79 @@
 import * as v from "valibot";
 
 //#region src/formula.d.ts
+
+/**
+ * Schema factory to extract the `formula` property result 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 formula results. The formula property in Notion can return different
+ * types of values (string, number, boolean, or date) depending on the formula
+ * configuration.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   formula: {
+ *     type: "string" | "number" | "boolean" | "date";
+ *     string?: string | null;
+ *     number?: number | null;
+ *     boolean?: boolean | null;
+ *     date?: {
+ *       start: string;
+ *       end: string | null;
+ *       time_zone: string | null;
+ *     } | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** The output type depends on the schema passed as a parameter.
+ * For example, if `RichTextSchema` is passed, the output will be `string`.
+ *
+ * @param schema - A schema that validates the formula result type.
+ *                  Must accept one of: string, number, boolean, or date formula results.
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FormulaSchema, RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     FormulaText: FormulaSchema(RichTextSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.FormulaText: string
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FormulaSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * // Custom schema for number formula
+ * const NumberFormulaSchema = v.object({
+ *   type: v.literal("number"),
+ *   number: v.nullable(v.number()),
+ * });
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     FormulaNumber: FormulaSchema(NumberFormulaSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.FormulaNumber: { type: "number"; number: number | null }
+ * ```
+ */
 declare function FormulaSchema<S extends v.GenericSchema<{
   type: "string";
   string: string | null;

package/dist/formula.d.mts

@@ -1,6 +1,79 @@
 import * as v from "valibot";
 
 //#region src/formula.d.ts
+
+/**
+ * Schema factory to extract the `formula` property result 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 formula results. The formula property in Notion can return different
+ * types of values (string, number, boolean, or date) depending on the formula
+ * configuration.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   formula: {
+ *     type: "string" | "number" | "boolean" | "date";
+ *     string?: string | null;
+ *     number?: number | null;
+ *     boolean?: boolean | null;
+ *     date?: {
+ *       start: string;
+ *       end: string | null;
+ *       time_zone: string | null;
+ *     } | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:** The output type depends on the schema passed as a parameter.
+ * For example, if `RichTextSchema` is passed, the output will be `string`.
+ *
+ * @param schema - A schema that validates the formula result type.
+ *                  Must accept one of: string, number, boolean, or date formula results.
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FormulaSchema, RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     FormulaText: FormulaSchema(RichTextSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.FormulaText: string
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { FormulaSchema } from "@nakanoaas/notion-valibot-utils";
+ *
+ * // Custom schema for number formula
+ * const NumberFormulaSchema = v.object({
+ *   type: v.literal("number"),
+ *   number: v.nullable(v.number()),
+ * });
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     FormulaNumber: FormulaSchema(NumberFormulaSchema),
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.FormulaNumber: { type: "number"; number: number | null }
+ * ```
+ */
 declare function FormulaSchema<S extends v.GenericSchema<{
   type: "string";
   string: string | null;

package/dist/formula.mjs

@@ -1,6 +1,78 @@
 import * as v from "valibot";
 
 //#region src/formula.ts
+/**
+* Schema factory to extract the `formula` property result 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 formula results. The formula property in Notion can return different
+* types of values (string, number, boolean, or date) depending on the formula
+* configuration.
+*
+* **Input:**
+* ```
+* {
+*   formula: {
+*     type: "string" | "number" | "boolean" | "date";
+*     string?: string | null;
+*     number?: number | null;
+*     boolean?: boolean | null;
+*     date?: {
+*       start: string;
+*       end: string | null;
+*       time_zone: string | null;
+*     } | null;
+*   }
+* }
+* ```
+*
+* **Output:** The output type depends on the schema passed as a parameter.
+* For example, if `RichTextSchema` is passed, the output will be `string`.
+*
+* @param schema - A schema that validates the formula result type.
+*                  Must accept one of: string, number, boolean, or date formula results.
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FormulaSchema, RichTextSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     FormulaText: FormulaSchema(RichTextSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.FormulaText: string
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { FormulaSchema } from "@nakanoaas/notion-valibot-utils";
+*
+* // Custom schema for number formula
+* const NumberFormulaSchema = v.object({
+*   type: v.literal("number"),
+*   number: v.nullable(v.number()),
+* });
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     FormulaNumber: FormulaSchema(NumberFormulaSchema),
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.FormulaNumber: { type: "number"; number: number | null }
+* ```
+*/
 function FormulaSchema(schema) {
 	return v.pipe(v.object({ formula: schema }), v.transform((v$1) => v$1.formula));
 }