@nakanoaas/notion-valibot-schema 0.0.4 → 0.0.6

package/dist/url.d.cts

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

package/dist/url.d.mts

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

package/dist/url.mjs

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

package/dist/url.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"url.mjs","names":["v"],"sources":["../src/url.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nexport const NullableUrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.url),\n);\n\nexport const UrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.string(),\n\t}),\n\tv.transform((v) => v.url),\n);\n"],"mappings":";;;AAEA,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC3B,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,IAAI,CACzB;AAED,MAAa,YAAY,EAAE,KAC1B,EAAE,OAAO,EACR,KAAK,EAAE,QAAQ,EACf,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,IAAI,CACzB"}
+{"version":3,"file":"url.mjs","names":["v"],"sources":["../src/url.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Schema to extract the `url` property from a Notion page property or `null`.\n *\n * **Input:**\n * ```\n * {\n *   url: string | null;\n * }\n * ```\n *\n * **Output:** `string | null`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableUrlSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Website: NullableUrlSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Website: string | null\n * ```\n */\nexport const NullableUrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.nullable(v.string()),\n\t}),\n\tv.transform((v) => v.url),\n);\n\n/**\n * Schema to extract the `url` property from a Notion page property.\n *\n * **Input:**\n * ```\n * {\n *   url: string;\n * }\n * ```\n *\n * **Output:** `string`\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { UrlSchema } from \"@nakanoaas/notion-valibot-utils\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Website: UrlSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Website: string\n * ```\n */\nexport const UrlSchema = v.pipe(\n\tv.object({\n\t\turl: v.string(),\n\t}),\n\tv.transform((v) => v.url),\n);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,oBAAoB,EAAE,KAClC,EAAE,OAAO,EACR,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,EAC3B,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,IAAI,CACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,MAAa,YAAY,EAAE,KAC1B,EAAE,OAAO,EACR,KAAK,EAAE,QAAQ,EACf,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,IAAI,CACzB"}

package/dist/verification.cjs

@@ -14,7 +14,87 @@ const InnerVerificationSchema = valibot.variant("state", [valibot.object({
 	date: valibot.nullable(require_date.DateObjectSchema),
 	verified_by: valibot.nullable(require_people.PersonSchema)
 })]);
+/**
+* Schema to extract the `verification` object from a Notion property.
+*
+* **Input:**
+* ```
+* {
+*   verification: {
+*     state: "unverified" | "verified" | "expired";
+*     date: DateObject | null;
+*     verified_by: Person | null;
+*   }
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   state: "unverified" | "verified" | "expired";
+*   date: DateObject | null;
+*   verified_by: Person | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { VerificationSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Verification: VerificationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null }
+* ```
+*/
 const VerificationSchema = valibot.pipe(valibot.object({ verification: InnerVerificationSchema }), valibot.transform((v) => v.verification));
+/**
+* Schema to extract the `verification` object from a Notion property (nullable).
+*
+* **Input:**
+* ```
+* {
+*   verification: {
+*     state: "unverified" | "verified" | "expired";
+*     date: DateObject | null;
+*     verified_by: Person | null;
+*   } | null
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   state: "unverified" | "verified" | "expired";
+*   date: DateObject | null;
+*   verified_by: Person | null;
+* } | null
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableVerificationSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Verification: NullableVerificationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null } | null
+* ```
+*/
 const NullableVerificationSchema = valibot.pipe(valibot.object({ verification: valibot.nullable(InnerVerificationSchema) }), valibot.transform((v) => v.verification));
 
 //#endregion

package/dist/verification.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"verification.cjs","names":["v","DateObjectSchema","PersonSchema"],"sources":["../src/verification.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\nimport { PersonSchema } from \"./people\";\n\nconst InnerVerificationSchema = v.variant(\"state\", [\n\tv.object({\n\t\tstate: v.literal(\"unverified\"),\n\t\tdate: v.null_(),\n\t\tverified_by: v.null_(),\n\t}),\n\tv.object({\n\t\tstate: v.union([v.literal(\"verified\"), v.literal(\"expired\")]),\n\t\tdate: v.nullable(DateObjectSchema),\n\t\tverified_by: v.nullable(PersonSchema),\n\t}),\n]);\n\nexport const VerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: InnerVerificationSchema,\n\t}),\n\tv.transform((v) => v.verification),\n);\n\nexport const NullableVerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: v.nullable(InnerVerificationSchema),\n\t}),\n\tv.transform((v) => v.verification),\n);\n"],"mappings":";;;;;;;AAKA,MAAM,0BAA0BA,QAAE,QAAQ,SAAS,CAClDA,QAAE,OAAO;CACR,OAAOA,QAAE,QAAQ,aAAa;CAC9B,MAAMA,QAAE,OAAO;CACf,aAAaA,QAAE,OAAO;CACtB,CAAC,EACFA,QAAE,OAAO;CACR,OAAOA,QAAE,MAAM,CAACA,QAAE,QAAQ,WAAW,EAAEA,QAAE,QAAQ,UAAU,CAAC,CAAC;CAC7D,MAAMA,QAAE,SAASC,8BAAiB;CAClC,aAAaD,QAAE,SAASE,4BAAa;CACrC,CAAC,CACF,CAAC;AAEF,MAAa,qBAAqBF,QAAE,KACnCA,QAAE,OAAO,EACR,cAAc,yBACd,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC;AAED,MAAa,6BAA6BA,QAAE,KAC3CA,QAAE,OAAO,EACR,cAAcA,QAAE,SAAS,wBAAwB,EACjD,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC"}
+{"version":3,"file":"verification.cjs","names":["v","DateObjectSchema","PersonSchema"],"sources":["../src/verification.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\nimport { PersonSchema } from \"./people\";\n\nconst InnerVerificationSchema = v.variant(\"state\", [\n\tv.object({\n\t\tstate: v.literal(\"unverified\"),\n\t\tdate: v.null_(),\n\t\tverified_by: v.null_(),\n\t}),\n\tv.object({\n\t\tstate: v.union([v.literal(\"verified\"), v.literal(\"expired\")]),\n\t\tdate: v.nullable(DateObjectSchema),\n\t\tverified_by: v.nullable(PersonSchema),\n\t}),\n]);\n\n/**\n * Schema to extract the `verification` object from a Notion property.\n *\n * **Input:**\n * ```\n * {\n *   verification: {\n *     state: \"unverified\" | \"verified\" | \"expired\";\n *     date: DateObject | null;\n *     verified_by: Person | null;\n *   }\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   state: \"unverified\" | \"verified\" | \"expired\";\n *   date: DateObject | null;\n *   verified_by: Person | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { VerificationSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Verification: VerificationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Verification: { state: \"unverified\" | \"verified\" | \"expired\"; date: DateObject | null; verified_by: Person | null }\n * ```\n */\nexport const VerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: InnerVerificationSchema,\n\t}),\n\tv.transform((v) => v.verification),\n);\n\n/**\n * Schema to extract the `verification` object from a Notion property (nullable).\n *\n * **Input:**\n * ```\n * {\n *   verification: {\n *     state: \"unverified\" | \"verified\" | \"expired\";\n *     date: DateObject | null;\n *     verified_by: Person | null;\n *   } | null\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   state: \"unverified\" | \"verified\" | \"expired\";\n *   date: DateObject | null;\n *   verified_by: Person | null;\n * } | null\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableVerificationSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Verification: NullableVerificationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Verification: { state: \"unverified\" | \"verified\" | \"expired\"; date: DateObject | null; verified_by: Person | null } | null\n * ```\n */\nexport const NullableVerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: v.nullable(InnerVerificationSchema),\n\t}),\n\tv.transform((v) => v.verification),\n);\n"],"mappings":";;;;;;;AAKA,MAAM,0BAA0BA,QAAE,QAAQ,SAAS,CAClDA,QAAE,OAAO;CACR,OAAOA,QAAE,QAAQ,aAAa;CAC9B,MAAMA,QAAE,OAAO;CACf,aAAaA,QAAE,OAAO;CACtB,CAAC,EACFA,QAAE,OAAO;CACR,OAAOA,QAAE,MAAM,CAACA,QAAE,QAAQ,WAAW,EAAEA,QAAE,QAAQ,UAAU,CAAC,CAAC;CAC7D,MAAMA,QAAE,SAASC,8BAAiB;CAClC,aAAaD,QAAE,SAASE,4BAAa;CACrC,CAAC,CACF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CF,MAAa,qBAAqBF,QAAE,KACnCA,QAAE,OAAO,EACR,cAAc,yBACd,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,6BAA6BA,QAAE,KAC3CA,QAAE,OAAO,EACR,cAAcA,QAAE,SAAS,wBAAwB,EACjD,CAAC,EACFA,QAAE,WAAW,MAAM,EAAE,aAAa,CAClC"}

package/dist/verification.d.cts

@@ -1,6 +1,47 @@
 import * as v from "valibot";
 
 //#region src/verification.d.ts
+
+/**
+ * Schema to extract the `verification` object from a Notion property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   verification: {
+ *     state: "unverified" | "verified" | "expired";
+ *     date: DateObject | null;
+ *     verified_by: Person | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   state: "unverified" | "verified" | "expired";
+ *   date: DateObject | null;
+ *   verified_by: Person | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { VerificationSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Verification: VerificationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null }
+ * ```
+ */
 declare const VerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly verification: v.VariantSchema<"state", [v.ObjectSchema<{
     readonly state: v.LiteralSchema<"unverified", undefined>;
@@ -54,6 +95,46 @@ declare const VerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     name: string | null;
   } | null;
 }>]>;
+/**
+ * Schema to extract the `verification` object from a Notion property (nullable).
+ *
+ * **Input:**
+ * ```
+ * {
+ *   verification: {
+ *     state: "unverified" | "verified" | "expired";
+ *     date: DateObject | null;
+ *     verified_by: Person | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   state: "unverified" | "verified" | "expired";
+ *   date: DateObject | null;
+ *   verified_by: Person | null;
+ * } | null
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableVerificationSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Verification: NullableVerificationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null } | null
+ * ```
+ */
 declare const NullableVerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly verification: v.NullableSchema<v.VariantSchema<"state", [v.ObjectSchema<{
     readonly state: v.LiteralSchema<"unverified", undefined>;

package/dist/verification.d.mts

@@ -1,6 +1,47 @@
 import * as v from "valibot";
 
 //#region src/verification.d.ts
+
+/**
+ * Schema to extract the `verification` object from a Notion property.
+ *
+ * **Input:**
+ * ```
+ * {
+ *   verification: {
+ *     state: "unverified" | "verified" | "expired";
+ *     date: DateObject | null;
+ *     verified_by: Person | null;
+ *   }
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   state: "unverified" | "verified" | "expired";
+ *   date: DateObject | null;
+ *   verified_by: Person | null;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { VerificationSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Verification: VerificationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null }
+ * ```
+ */
 declare const VerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly verification: v.VariantSchema<"state", [v.ObjectSchema<{
     readonly state: v.LiteralSchema<"unverified", undefined>;
@@ -54,6 +95,46 @@ declare const VerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
     name: string | null;
   } | null;
 }>]>;
+/**
+ * Schema to extract the `verification` object from a Notion property (nullable).
+ *
+ * **Input:**
+ * ```
+ * {
+ *   verification: {
+ *     state: "unverified" | "verified" | "expired";
+ *     date: DateObject | null;
+ *     verified_by: Person | null;
+ *   } | null
+ * }
+ * ```
+ *
+ * **Output:**
+ * ```
+ * {
+ *   state: "unverified" | "verified" | "expired";
+ *   date: DateObject | null;
+ *   verified_by: Person | null;
+ * } | null
+ * ```
+ *
+ * @example
+ * ```ts
+ * import * as v from "valibot";
+ * import { NullableVerificationSchema } from "@nakanoaas/notion-valibot-schema";
+ *
+ * const PageSchema = v.object({
+ *   id: v.string(),
+ *   properties: v.object({
+ *     Verification: NullableVerificationSchema,
+ *   }),
+ * });
+ *
+ * const page = await notion.pages.retrieve({ page_id: "..." });
+ * const parsed = v.parse(PageSchema, page);
+ * // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null } | null
+ * ```
+ */
 declare const NullableVerificationSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
   readonly verification: v.NullableSchema<v.VariantSchema<"state", [v.ObjectSchema<{
     readonly state: v.LiteralSchema<"unverified", undefined>;

package/dist/verification.mjs

@@ -12,7 +12,87 @@ const InnerVerificationSchema = v.variant("state", [v.object({
 	date: v.nullable(DateObjectSchema),
 	verified_by: v.nullable(PersonSchema)
 })]);
+/**
+* Schema to extract the `verification` object from a Notion property.
+*
+* **Input:**
+* ```
+* {
+*   verification: {
+*     state: "unverified" | "verified" | "expired";
+*     date: DateObject | null;
+*     verified_by: Person | null;
+*   }
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   state: "unverified" | "verified" | "expired";
+*   date: DateObject | null;
+*   verified_by: Person | null;
+* }
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { VerificationSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Verification: VerificationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null }
+* ```
+*/
 const VerificationSchema = v.pipe(v.object({ verification: InnerVerificationSchema }), v.transform((v$1) => v$1.verification));
+/**
+* Schema to extract the `verification` object from a Notion property (nullable).
+*
+* **Input:**
+* ```
+* {
+*   verification: {
+*     state: "unverified" | "verified" | "expired";
+*     date: DateObject | null;
+*     verified_by: Person | null;
+*   } | null
+* }
+* ```
+*
+* **Output:**
+* ```
+* {
+*   state: "unverified" | "verified" | "expired";
+*   date: DateObject | null;
+*   verified_by: Person | null;
+* } | null
+* ```
+*
+* @example
+* ```ts
+* import * as v from "valibot";
+* import { NullableVerificationSchema } from "@nakanoaas/notion-valibot-schema";
+*
+* const PageSchema = v.object({
+*   id: v.string(),
+*   properties: v.object({
+*     Verification: NullableVerificationSchema,
+*   }),
+* });
+*
+* const page = await notion.pages.retrieve({ page_id: "..." });
+* const parsed = v.parse(PageSchema, page);
+* // parsed.properties.Verification: { state: "unverified" | "verified" | "expired"; date: DateObject | null; verified_by: Person | null } | null
+* ```
+*/
 const NullableVerificationSchema = v.pipe(v.object({ verification: v.nullable(InnerVerificationSchema) }), v.transform((v$1) => v$1.verification));
 
 //#endregion

package/dist/verification.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"verification.mjs","names":["v"],"sources":["../src/verification.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\nimport { PersonSchema } from \"./people\";\n\nconst InnerVerificationSchema = v.variant(\"state\", [\n\tv.object({\n\t\tstate: v.literal(\"unverified\"),\n\t\tdate: v.null_(),\n\t\tverified_by: v.null_(),\n\t}),\n\tv.object({\n\t\tstate: v.union([v.literal(\"verified\"), v.literal(\"expired\")]),\n\t\tdate: v.nullable(DateObjectSchema),\n\t\tverified_by: v.nullable(PersonSchema),\n\t}),\n]);\n\nexport const VerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: InnerVerificationSchema,\n\t}),\n\tv.transform((v) => v.verification),\n);\n\nexport const NullableVerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: v.nullable(InnerVerificationSchema),\n\t}),\n\tv.transform((v) => v.verification),\n);\n"],"mappings":";;;;;AAKA,MAAM,0BAA0B,EAAE,QAAQ,SAAS,CAClD,EAAE,OAAO;CACR,OAAO,EAAE,QAAQ,aAAa;CAC9B,MAAM,EAAE,OAAO;CACf,aAAa,EAAE,OAAO;CACtB,CAAC,EACF,EAAE,OAAO;CACR,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,WAAW,EAAE,EAAE,QAAQ,UAAU,CAAC,CAAC;CAC7D,MAAM,EAAE,SAAS,iBAAiB;CAClC,aAAa,EAAE,SAAS,aAAa;CACrC,CAAC,CACF,CAAC;AAEF,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,cAAc,yBACd,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC;AAED,MAAa,6BAA6B,EAAE,KAC3C,EAAE,OAAO,EACR,cAAc,EAAE,SAAS,wBAAwB,EACjD,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC"}
+{"version":3,"file":"verification.mjs","names":["v"],"sources":["../src/verification.ts"],"sourcesContent":["import * as v from \"valibot\";\n\nimport { DateObjectSchema } from \"./date\";\nimport { PersonSchema } from \"./people\";\n\nconst InnerVerificationSchema = v.variant(\"state\", [\n\tv.object({\n\t\tstate: v.literal(\"unverified\"),\n\t\tdate: v.null_(),\n\t\tverified_by: v.null_(),\n\t}),\n\tv.object({\n\t\tstate: v.union([v.literal(\"verified\"), v.literal(\"expired\")]),\n\t\tdate: v.nullable(DateObjectSchema),\n\t\tverified_by: v.nullable(PersonSchema),\n\t}),\n]);\n\n/**\n * Schema to extract the `verification` object from a Notion property.\n *\n * **Input:**\n * ```\n * {\n *   verification: {\n *     state: \"unverified\" | \"verified\" | \"expired\";\n *     date: DateObject | null;\n *     verified_by: Person | null;\n *   }\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   state: \"unverified\" | \"verified\" | \"expired\";\n *   date: DateObject | null;\n *   verified_by: Person | null;\n * }\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { VerificationSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Verification: VerificationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Verification: { state: \"unverified\" | \"verified\" | \"expired\"; date: DateObject | null; verified_by: Person | null }\n * ```\n */\nexport const VerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: InnerVerificationSchema,\n\t}),\n\tv.transform((v) => v.verification),\n);\n\n/**\n * Schema to extract the `verification` object from a Notion property (nullable).\n *\n * **Input:**\n * ```\n * {\n *   verification: {\n *     state: \"unverified\" | \"verified\" | \"expired\";\n *     date: DateObject | null;\n *     verified_by: Person | null;\n *   } | null\n * }\n * ```\n *\n * **Output:**\n * ```\n * {\n *   state: \"unverified\" | \"verified\" | \"expired\";\n *   date: DateObject | null;\n *   verified_by: Person | null;\n * } | null\n * ```\n *\n * @example\n * ```ts\n * import * as v from \"valibot\";\n * import { NullableVerificationSchema } from \"@nakanoaas/notion-valibot-schema\";\n *\n * const PageSchema = v.object({\n *   id: v.string(),\n *   properties: v.object({\n *     Verification: NullableVerificationSchema,\n *   }),\n * });\n *\n * const page = await notion.pages.retrieve({ page_id: \"...\" });\n * const parsed = v.parse(PageSchema, page);\n * // parsed.properties.Verification: { state: \"unverified\" | \"verified\" | \"expired\"; date: DateObject | null; verified_by: Person | null } | null\n * ```\n */\nexport const NullableVerificationSchema = v.pipe(\n\tv.object({\n\t\tverification: v.nullable(InnerVerificationSchema),\n\t}),\n\tv.transform((v) => v.verification),\n);\n"],"mappings":";;;;;AAKA,MAAM,0BAA0B,EAAE,QAAQ,SAAS,CAClD,EAAE,OAAO;CACR,OAAO,EAAE,QAAQ,aAAa;CAC9B,MAAM,EAAE,OAAO;CACf,aAAa,EAAE,OAAO;CACtB,CAAC,EACF,EAAE,OAAO;CACR,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,WAAW,EAAE,EAAE,QAAQ,UAAU,CAAC,CAAC;CAC7D,MAAM,EAAE,SAAS,iBAAiB;CAClC,aAAa,EAAE,SAAS,aAAa;CACrC,CAAC,CACF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CF,MAAa,qBAAqB,EAAE,KACnC,EAAE,OAAO,EACR,cAAc,yBACd,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CD,MAAa,6BAA6B,EAAE,KAC3C,EAAE,OAAO,EACR,cAAc,EAAE,SAAS,wBAAwB,EACjD,CAAC,EACF,EAAE,WAAW,QAAMA,IAAE,aAAa,CAClC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nakanoaas/notion-valibot-schema",
-  "version": "0.0.4",
-  "description": "A collection of valibot schemas for Notion API",
+  "version": "0.0.6",
+  "description": "A small collection of Valibot schemas for the Notion API",
   "author": "Nakano as a Service",
   "license": "MIT",
   "type": "module",