@prairielearn/zod 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @prairielearn/zod
2
2
 
3
+ ## 1.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - abd760d: Forbid calling `.optional()` on `BooleanFromCheckboxSchema`
8
+
3
9
  ## 1.2.1
4
10
 
5
11
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -1,11 +1,21 @@
1
- import { z } from 'zod';
1
+ import { type ZodTypeAny, z } from 'zod';
2
+ /**
3
+ * A schema type on which `.optional()` cannot be called.
4
+ */
5
+ type NoOptional<S extends ZodTypeAny> = S & {
6
+ optional: never;
7
+ };
2
8
  /**
3
9
  * A Zod schema for a boolean from a single checkbox input in the body
4
10
  * parameters from a form. This will return a boolean with a value of `true` if
5
11
  * the checkbox is checked (the input is present) and `false` if it is not
6
12
  * checked.
13
+ *
14
+ * Note that this will not behave sensibly if `.optional()` is called on the schema,
15
+ * as it will turn a missing checkbox into `undefined` instead of `false`. We use
16
+ * some TypeScript magic to ensure that `.optional()` cannot be called on this schema.
7
17
  */
8
- export declare const BooleanFromCheckboxSchema: z.ZodEffects<z.ZodOptional<z.ZodString>, boolean, string | undefined>;
18
+ export declare const BooleanFromCheckboxSchema: NoOptional<z.ZodEffects<z.ZodOptional<z.ZodString>, boolean, string | undefined>>;
9
19
  /**
10
20
  * A Zod schema for a PostgreSQL ID.
11
21
  *
@@ -39,7 +49,7 @@ export declare const IntervalSchema: z.ZodEffects<z.ZodUnion<[z.ZodString, z.Zod
39
49
  minutes: z.ZodDefault<z.ZodNumber>;
40
50
  seconds: z.ZodDefault<z.ZodNumber>;
41
51
  milliseconds: z.ZodDefault<z.ZodNumber>;
42
- }, "strip", z.ZodTypeAny, {
52
+ }, "strip", ZodTypeAny, {
43
53
  years: number;
44
54
  months: number;
45
55
  days: number;
@@ -84,3 +94,4 @@ export declare const IntegerFromStringOrEmptySchema: z.ZodEffects<z.ZodUnion<[z.
84
94
  * strings.
85
95
  */
86
96
  export declare const ArrayFromStringOrArraySchema: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>;
97
+ export {};
package/dist/index.js CHANGED
@@ -6,16 +6,27 @@ const INTERVAL_MS_PER_HOUR = 60 * INTERVAL_MS_PER_MINUTE;
6
6
  const INTERVAL_MS_PER_DAY = 24 * INTERVAL_MS_PER_HOUR;
7
7
  const INTERVAL_MS_PER_MONTH = 30 * INTERVAL_MS_PER_DAY;
8
8
  const INTERVAL_MS_PER_YEAR = 365.25 * INTERVAL_MS_PER_DAY;
9
+ /**
10
+ * Wrap any Zod schema so that calling `.optional()` is illegal in TypeScript.
11
+ * Runtime behavior is untouched.
12
+ */
13
+ function required(schema) {
14
+ return schema;
15
+ }
9
16
  /**
10
17
  * A Zod schema for a boolean from a single checkbox input in the body
11
18
  * parameters from a form. This will return a boolean with a value of `true` if
12
19
  * the checkbox is checked (the input is present) and `false` if it is not
13
20
  * checked.
21
+ *
22
+ * Note that this will not behave sensibly if `.optional()` is called on the schema,
23
+ * as it will turn a missing checkbox into `undefined` instead of `false`. We use
24
+ * some TypeScript magic to ensure that `.optional()` cannot be called on this schema.
14
25
  */
15
- export const BooleanFromCheckboxSchema = z
26
+ export const BooleanFromCheckboxSchema = required(z
16
27
  .string()
17
28
  .optional()
18
- .transform((s) => !!s);
29
+ .transform((s) => !!s));
19
30
  /**
20
31
  * A Zod schema for a PostgreSQL ID.
21
32
  *
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,sBAAsB,GAAG,IAAI,CAAC;AACpC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAC3D,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AACzD,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AACtD,MAAM,qBAAqB,GAAG,EAAE,GAAG,mBAAmB,CAAC;AACvD,MAAM,oBAAoB,GAAG,MAAM,GAAG,mBAAmB,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzB;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACtB,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KACxB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC;KAC3C,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;IACtB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,4EAA4E;IAC5E,iFAAiF;IACjF,4EAA4E;IAC5E,qBAAqB;IACrB,OAAO,CACL,QAAQ,CAAC,KAAK,GAAG,oBAAoB;QACrC,QAAQ,CAAC,MAAM,GAAG,qBAAqB;QACvC,QAAQ,CAAC,IAAI,GAAG,mBAAmB;QACnC,QAAQ,CAAC,KAAK,GAAG,oBAAoB;QACrC,QAAQ,CAAC,OAAO,GAAG,sBAAsB;QACzC,QAAQ,CAAC,OAAO,GAAG,sBAAsB;QACzC,QAAQ,CAAC,YAAY,CACtB,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KAC7B,MAAM,CACL,CAAC,CAAC,EAAE,EAAE;IACJ,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACvC,CAAC,EACD;IACE,OAAO,EAAE,iCAAiC;CAC3C,CACF;KACA,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjC;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,UAAU,CACxD,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EACxC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;KACxC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC,CAAC","sourcesContent":["import parsePostgresInterval from 'postgres-interval';\nimport { z } from 'zod';\n\nconst INTERVAL_MS_PER_SECOND = 1000;\nconst INTERVAL_MS_PER_MINUTE = 60 * INTERVAL_MS_PER_SECOND;\nconst INTERVAL_MS_PER_HOUR = 60 * INTERVAL_MS_PER_MINUTE;\nconst INTERVAL_MS_PER_DAY = 24 * INTERVAL_MS_PER_HOUR;\nconst INTERVAL_MS_PER_MONTH = 30 * INTERVAL_MS_PER_DAY;\nconst INTERVAL_MS_PER_YEAR = 365.25 * INTERVAL_MS_PER_DAY;\n\n/**\n * A Zod schema for a boolean from a single checkbox input in the body\n * parameters from a form. This will return a boolean with a value of `true` if\n * the checkbox is checked (the input is present) and `false` if it is not\n * checked.\n */\nexport const BooleanFromCheckboxSchema = z\n .string()\n .optional()\n .transform((s) => !!s);\n\n/**\n * A Zod schema for a PostgreSQL ID.\n *\n * We store IDs as BIGINT in PostgreSQL, which are passed to JavaScript as\n * either strings (if the ID is fetched directly) or numbers (if passed via\n * `to_jsonb()`). This schema coerces the ID to a string to ensure consistent\n * handling.\n *\n * The `refine` step is important to ensure that the thing we've coerced to a\n * string is actually a number. If it's not, we want to fail quickly.\n */\nexport const IdSchema = z\n .string({ coerce: true })\n .refine((val) => /^\\d+$/.test(val), { message: 'ID is not a non-negative integer' });\n\n/**\n * A Zod schema for the objects produced by the `postgres-interval` library.\n */\nconst PostgresIntervalSchema = z.object({\n years: z.number().default(0),\n months: z.number().default(0),\n days: z.number().default(0),\n hours: z.number().default(0),\n minutes: z.number().default(0),\n seconds: z.number().default(0),\n milliseconds: z.number().default(0),\n});\n\n/**\n * A Zod schema for a PostgreSQL interval.\n *\n * This handles two representations of an interval:\n *\n * - A string like \"1 year 2 days\", which is how intervals will be represented\n * if they go through `to_jsonb` in a query.\n * - A {@link PostgresIntervalSchema} object, which is what we'll get if a\n * query directly returns an interval column. The interval will already be\n * parsed by `postgres-interval` by way of `pg-types`.\n *\n * In either case, we convert the interval to a number of milliseconds.\n */\nexport const IntervalSchema = z\n .union([z.string(), PostgresIntervalSchema])\n .transform((interval) => {\n if (typeof interval === 'string') {\n interval = parsePostgresInterval(interval);\n }\n\n // This calculation matches Postgres's behavior when computing the number of\n // milliseconds in an interval with `EXTRACT(epoch from '...'::interval) * 1000`.\n // The noteworthy parts of this conversion are that 1 year = 365.25 days and\n // 1 month = 30 days.\n return (\n interval.years * INTERVAL_MS_PER_YEAR +\n interval.months * INTERVAL_MS_PER_MONTH +\n interval.days * INTERVAL_MS_PER_DAY +\n interval.hours * INTERVAL_MS_PER_HOUR +\n interval.minutes * INTERVAL_MS_PER_MINUTE +\n interval.seconds * INTERVAL_MS_PER_SECOND +\n interval.milliseconds\n );\n });\n\n/**\n * A Zod schema for a date string in ISO format.\n *\n * Accepts either a string or a Date object. If a string is passed, it is\n * validated and parsed as an ISO date string.\n *\n * Useful for parsing dates from JSON, which are always strings.\n */\nexport const DateFromISOString = z\n .union([z.string(), z.date()])\n .refine(\n (s) => {\n const date = new Date(s);\n return !Number.isNaN(date.getTime());\n },\n {\n message: 'must be a valid ISO date string',\n },\n )\n .transform((s) => new Date(s));\n\n/**\n * A Zod schema that coerces a non-empty string to an integer or an empty string to null.\n * This is useful for form number inputs that are not required but we do not want to\n * use an empty string to compute values.\n */\nexport const IntegerFromStringOrEmptySchema = z.preprocess(\n (value) => (value === '' ? null : value),\n z.union([z.null(), z.coerce.number().int()]),\n);\n\n/**\n * A Zod schema for an arrray of string values from either a string or an array of\n * strings.\n */\nexport const ArrayFromStringOrArraySchema = z\n .union([z.string(), z.array(z.string())])\n .transform((s) => {\n if (s === null) {\n return [];\n } else if (Array.isArray(s)) {\n return s;\n } else {\n return [s];\n }\n });\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAmB,CAAC,EAAE,MAAM,KAAK,CAAC;AAEzC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AACpC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAC3D,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AACzD,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AACtD,MAAM,qBAAqB,GAAG,EAAE,GAAG,mBAAmB,CAAC;AACvD,MAAM,oBAAoB,GAAG,MAAM,GAAG,mBAAmB,CAAC;AAS1D;;;GAGG;AACH,SAAS,QAAQ,CAAuB,MAAS;IAC/C,OAAO,MAAkC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,QAAQ,CAC/C,CAAC;KACE,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CACzB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACtB,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KACxB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,kCAAkC,EAAE,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAAC;KAC3C,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE;IACtB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED,4EAA4E;IAC5E,iFAAiF;IACjF,4EAA4E;IAC5E,qBAAqB;IACrB,OAAO,CACL,QAAQ,CAAC,KAAK,GAAG,oBAAoB;QACrC,QAAQ,CAAC,MAAM,GAAG,qBAAqB;QACvC,QAAQ,CAAC,IAAI,GAAG,mBAAmB;QACnC,QAAQ,CAAC,KAAK,GAAG,oBAAoB;QACrC,QAAQ,CAAC,OAAO,GAAG,sBAAsB;QACzC,QAAQ,CAAC,OAAO,GAAG,sBAAsB;QACzC,QAAQ,CAAC,YAAY,CACtB,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KAC7B,MAAM,CACL,CAAC,CAAC,EAAE,EAAE;IACJ,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACvC,CAAC,EACD;IACE,OAAO,EAAE,iCAAiC;CAC3C,CACF;KACA,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjC;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,UAAU,CACxD,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EACxC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC1C,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;KACxC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACf,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC,CAAC,CAAC;IACb,CAAC;AACH,CAAC,CAAC,CAAC","sourcesContent":["import parsePostgresInterval from 'postgres-interval';\nimport { type ZodTypeAny, z } from 'zod';\n\nconst INTERVAL_MS_PER_SECOND = 1000;\nconst INTERVAL_MS_PER_MINUTE = 60 * INTERVAL_MS_PER_SECOND;\nconst INTERVAL_MS_PER_HOUR = 60 * INTERVAL_MS_PER_MINUTE;\nconst INTERVAL_MS_PER_DAY = 24 * INTERVAL_MS_PER_HOUR;\nconst INTERVAL_MS_PER_MONTH = 30 * INTERVAL_MS_PER_DAY;\nconst INTERVAL_MS_PER_YEAR = 365.25 * INTERVAL_MS_PER_DAY;\n\n/**\n * A schema type on which `.optional()` cannot be called.\n */\ntype NoOptional<S extends ZodTypeAny> = S & {\n optional: never;\n};\n\n/**\n * Wrap any Zod schema so that calling `.optional()` is illegal in TypeScript.\n * Runtime behavior is untouched.\n */\nfunction required<S extends ZodTypeAny>(schema: S): NoOptional<S> {\n return schema as unknown as NoOptional<S>;\n}\n\n/**\n * A Zod schema for a boolean from a single checkbox input in the body\n * parameters from a form. This will return a boolean with a value of `true` if\n * the checkbox is checked (the input is present) and `false` if it is not\n * checked.\n *\n * Note that this will not behave sensibly if `.optional()` is called on the schema,\n * as it will turn a missing checkbox into `undefined` instead of `false`. We use\n * some TypeScript magic to ensure that `.optional()` cannot be called on this schema.\n */\nexport const BooleanFromCheckboxSchema = required(\n z\n .string()\n .optional()\n .transform((s) => !!s),\n);\n\n/**\n * A Zod schema for a PostgreSQL ID.\n *\n * We store IDs as BIGINT in PostgreSQL, which are passed to JavaScript as\n * either strings (if the ID is fetched directly) or numbers (if passed via\n * `to_jsonb()`). This schema coerces the ID to a string to ensure consistent\n * handling.\n *\n * The `refine` step is important to ensure that the thing we've coerced to a\n * string is actually a number. If it's not, we want to fail quickly.\n */\nexport const IdSchema = z\n .string({ coerce: true })\n .refine((val) => /^\\d+$/.test(val), { message: 'ID is not a non-negative integer' });\n\n/**\n * A Zod schema for the objects produced by the `postgres-interval` library.\n */\nconst PostgresIntervalSchema = z.object({\n years: z.number().default(0),\n months: z.number().default(0),\n days: z.number().default(0),\n hours: z.number().default(0),\n minutes: z.number().default(0),\n seconds: z.number().default(0),\n milliseconds: z.number().default(0),\n});\n\n/**\n * A Zod schema for a PostgreSQL interval.\n *\n * This handles two representations of an interval:\n *\n * - A string like \"1 year 2 days\", which is how intervals will be represented\n * if they go through `to_jsonb` in a query.\n * - A {@link PostgresIntervalSchema} object, which is what we'll get if a\n * query directly returns an interval column. The interval will already be\n * parsed by `postgres-interval` by way of `pg-types`.\n *\n * In either case, we convert the interval to a number of milliseconds.\n */\nexport const IntervalSchema = z\n .union([z.string(), PostgresIntervalSchema])\n .transform((interval) => {\n if (typeof interval === 'string') {\n interval = parsePostgresInterval(interval);\n }\n\n // This calculation matches Postgres's behavior when computing the number of\n // milliseconds in an interval with `EXTRACT(epoch from '...'::interval) * 1000`.\n // The noteworthy parts of this conversion are that 1 year = 365.25 days and\n // 1 month = 30 days.\n return (\n interval.years * INTERVAL_MS_PER_YEAR +\n interval.months * INTERVAL_MS_PER_MONTH +\n interval.days * INTERVAL_MS_PER_DAY +\n interval.hours * INTERVAL_MS_PER_HOUR +\n interval.minutes * INTERVAL_MS_PER_MINUTE +\n interval.seconds * INTERVAL_MS_PER_SECOND +\n interval.milliseconds\n );\n });\n\n/**\n * A Zod schema for a date string in ISO format.\n *\n * Accepts either a string or a Date object. If a string is passed, it is\n * validated and parsed as an ISO date string.\n *\n * Useful for parsing dates from JSON, which are always strings.\n */\nexport const DateFromISOString = z\n .union([z.string(), z.date()])\n .refine(\n (s) => {\n const date = new Date(s);\n return !Number.isNaN(date.getTime());\n },\n {\n message: 'must be a valid ISO date string',\n },\n )\n .transform((s) => new Date(s));\n\n/**\n * A Zod schema that coerces a non-empty string to an integer or an empty string to null.\n * This is useful for form number inputs that are not required but we do not want to\n * use an empty string to compute values.\n */\nexport const IntegerFromStringOrEmptySchema = z.preprocess(\n (value) => (value === '' ? null : value),\n z.union([z.null(), z.coerce.number().int()]),\n);\n\n/**\n * A Zod schema for an arrray of string values from either a string or an array of\n * strings.\n */\nexport const ArrayFromStringOrArraySchema = z\n .union([z.string(), z.array(z.string())])\n .transform((s) => {\n if (s === null) {\n return [];\n } else if (Array.isArray(s)) {\n return s;\n } else {\n return [s];\n }\n });\n"]}
@@ -1,6 +1,24 @@
1
1
  import parsePostgresInterval from 'postgres-interval';
2
2
  import { assert, describe, it } from 'vitest';
3
- import { ArrayFromStringOrArraySchema, IdSchema, IntegerFromStringOrEmptySchema, IntervalSchema, } from './index.js';
3
+ import { ArrayFromStringOrArraySchema, BooleanFromCheckboxSchema, IdSchema, IntegerFromStringOrEmptySchema, IntervalSchema, } from './index.js';
4
+ describe('BooleanFromCheckboxSchema', () => {
5
+ it('parses a checked checkbox', () => {
6
+ const result = BooleanFromCheckboxSchema.parse('on');
7
+ assert.isTrue(result);
8
+ });
9
+ it('parses an unchecked checkbox', () => {
10
+ const result = BooleanFromCheckboxSchema.parse(undefined);
11
+ assert.isFalse(result);
12
+ });
13
+ it('parses a checkbox with an empty string', () => {
14
+ const result = BooleanFromCheckboxSchema.parse('');
15
+ assert.isFalse(result);
16
+ });
17
+ it('parses a checkbox with a non-empty string', () => {
18
+ const result = BooleanFromCheckboxSchema.parse('checked');
19
+ assert.isTrue(result);
20
+ });
21
+ });
4
22
  describe('IdSchema', () => {
5
23
  it('parses a valid id', () => {
6
24
  const id = IdSchema.parse('123');
@@ -1 +1 @@
1
- {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EACL,4BAA4B,EAC5B,QAAQ,EACR,8BAA8B,EAC9B,cAAc,GACf,MAAM,YAAY,CAAC;AAEpB,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC;QACvF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAChF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACjF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAClF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,MAAM,GAAG,4BAA4B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,4BAA4B,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import parsePostgresInterval from 'postgres-interval';\nimport { assert, describe, it } from 'vitest';\n\nimport {\n ArrayFromStringOrArraySchema,\n IdSchema,\n IntegerFromStringOrEmptySchema,\n IntervalSchema,\n} from './index.js';\n\ndescribe('IdSchema', () => {\n it('parses a valid id', () => {\n const id = IdSchema.parse('123');\n assert.equal(id, '123');\n });\n\n it('parses a nullable id', () => {\n const id = IdSchema.nullable().parse(null);\n assert.equal(id, null);\n });\n\n it('parses an optional id', () => {\n const id = IdSchema.optional().parse(undefined);\n assert.equal(id, undefined);\n });\n\n it('rejects a negative ID', () => {\n const result = IdSchema.safeParse('-1');\n assert.isFalse(result.success);\n });\n\n it('rejects a non-numeric ID', () => {\n const result = IdSchema.safeParse('abc');\n assert.isFalse(result.success);\n });\n});\n\ndescribe('IntervalSchema', () => {\n it('handles a PostgresInterval object', () => {\n const interval = IntervalSchema.parse(parsePostgresInterval('1 year 2 months 3 days'));\n assert.equal(interval, 37000800000);\n });\n\n it('parses an interval with date', () => {\n const interval = IntervalSchema.parse('1 year 2 months 3 days');\n assert.equal(interval, 37000800000);\n });\n\n it('parses an interval with time', () => {\n const interval = IntervalSchema.parse('04:05:06.7');\n assert.equal(interval, 14706700);\n });\n\n it('parses an interval with microsecond-precision time', () => {\n const interval = IntervalSchema.parse('01:02:03.456789');\n assert.equal(interval, 3723456.789);\n });\n\n it('parses a complex interval', () => {\n const interval = IntervalSchema.parse('1 years 2 mons 3 days 04:05:06.789');\n assert.equal(interval, 37015506789);\n });\n\n it('parses interval with negative months', () => {\n const interval = IntervalSchema.parse('-10 mons 3 days 04:05:06.789');\n assert.equal(interval, -25646093211);\n });\n\n it('parses interval with negative years and months', () => {\n const interval = IntervalSchema.parse('-1 years -2 months 3 days 04:05:06.789');\n assert.equal(interval, -36467693211);\n });\n\n it('parses interval with negative years, months, and days', () => {\n const interval = IntervalSchema.parse('-1 years -2 months -3 days 04:05:06.789');\n assert.equal(interval, -36986093211);\n });\n\n it('parses a negative interval', () => {\n const interval = IntervalSchema.parse('-1 years -2 months -3 days -04:05:06.789');\n assert.equal(interval, -37015506789);\n });\n});\n\ndescribe('IntegerFromStringOrEmptySchema', () => {\n it('parses a valid integer string', () => {\n const result = IntegerFromStringOrEmptySchema.parse('123');\n assert.equal(result, 123);\n });\n\n it('parses an empty string as null', () => {\n const result = IntegerFromStringOrEmptySchema.parse('');\n assert.equal(result, null);\n });\n\n it('rejects a non-integer string', () => {\n const result = IntegerFromStringOrEmptySchema.safeParse('abc');\n assert.isFalse(result.success);\n });\n\n it('rejects a decimal string', () => {\n const result = IntegerFromStringOrEmptySchema.safeParse('123.45');\n assert.isFalse(result.success);\n });\n});\n\ndescribe('ArrayFromStringOrArraySchema', () => {\n it('parses a string to an array', () => {\n const result = ArrayFromStringOrArraySchema.parse('a');\n assert.deepEqual(result, ['a']);\n });\n\n it('parses an array to itself', () => {\n const result = ArrayFromStringOrArraySchema.parse(['a', 'b', 'c']);\n assert.deepEqual(result, ['a', 'b', 'c']);\n });\n\n it('rejects an integer', () => {\n const result = ArrayFromStringOrArraySchema.safeParse(123);\n assert.isFalse(result.success);\n });\n\n it('rejects an object', () => {\n const result = ArrayFromStringOrArraySchema.safeParse({ a: 1 });\n assert.isFalse(result.success);\n });\n});\n"]}
1
+ {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EACL,4BAA4B,EAC5B,yBAAyB,EACzB,QAAQ,EACR,8BAA8B,EAC9B,cAAc,GACf,MAAM,YAAY,CAAC;AAEpB,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC;QACvF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAChE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QACtE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAChF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAC;QACjF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAClF,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,MAAM,GAAG,8BAA8B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxD,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,MAAM,GAAG,4BAA4B,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,MAAM,GAAG,4BAA4B,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACnE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAC3B,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import parsePostgresInterval from 'postgres-interval';\nimport { assert, describe, it } from 'vitest';\n\nimport {\n ArrayFromStringOrArraySchema,\n BooleanFromCheckboxSchema,\n IdSchema,\n IntegerFromStringOrEmptySchema,\n IntervalSchema,\n} from './index.js';\n\ndescribe('BooleanFromCheckboxSchema', () => {\n it('parses a checked checkbox', () => {\n const result = BooleanFromCheckboxSchema.parse('on');\n assert.isTrue(result);\n });\n it('parses an unchecked checkbox', () => {\n const result = BooleanFromCheckboxSchema.parse(undefined);\n assert.isFalse(result);\n });\n it('parses a checkbox with an empty string', () => {\n const result = BooleanFromCheckboxSchema.parse('');\n assert.isFalse(result);\n });\n it('parses a checkbox with a non-empty string', () => {\n const result = BooleanFromCheckboxSchema.parse('checked');\n assert.isTrue(result);\n });\n});\n\ndescribe('IdSchema', () => {\n it('parses a valid id', () => {\n const id = IdSchema.parse('123');\n assert.equal(id, '123');\n });\n\n it('parses a nullable id', () => {\n const id = IdSchema.nullable().parse(null);\n assert.equal(id, null);\n });\n\n it('parses an optional id', () => {\n const id = IdSchema.optional().parse(undefined);\n assert.equal(id, undefined);\n });\n\n it('rejects a negative ID', () => {\n const result = IdSchema.safeParse('-1');\n assert.isFalse(result.success);\n });\n\n it('rejects a non-numeric ID', () => {\n const result = IdSchema.safeParse('abc');\n assert.isFalse(result.success);\n });\n});\n\ndescribe('IntervalSchema', () => {\n it('handles a PostgresInterval object', () => {\n const interval = IntervalSchema.parse(parsePostgresInterval('1 year 2 months 3 days'));\n assert.equal(interval, 37000800000);\n });\n\n it('parses an interval with date', () => {\n const interval = IntervalSchema.parse('1 year 2 months 3 days');\n assert.equal(interval, 37000800000);\n });\n\n it('parses an interval with time', () => {\n const interval = IntervalSchema.parse('04:05:06.7');\n assert.equal(interval, 14706700);\n });\n\n it('parses an interval with microsecond-precision time', () => {\n const interval = IntervalSchema.parse('01:02:03.456789');\n assert.equal(interval, 3723456.789);\n });\n\n it('parses a complex interval', () => {\n const interval = IntervalSchema.parse('1 years 2 mons 3 days 04:05:06.789');\n assert.equal(interval, 37015506789);\n });\n\n it('parses interval with negative months', () => {\n const interval = IntervalSchema.parse('-10 mons 3 days 04:05:06.789');\n assert.equal(interval, -25646093211);\n });\n\n it('parses interval with negative years and months', () => {\n const interval = IntervalSchema.parse('-1 years -2 months 3 days 04:05:06.789');\n assert.equal(interval, -36467693211);\n });\n\n it('parses interval with negative years, months, and days', () => {\n const interval = IntervalSchema.parse('-1 years -2 months -3 days 04:05:06.789');\n assert.equal(interval, -36986093211);\n });\n\n it('parses a negative interval', () => {\n const interval = IntervalSchema.parse('-1 years -2 months -3 days -04:05:06.789');\n assert.equal(interval, -37015506789);\n });\n});\n\ndescribe('IntegerFromStringOrEmptySchema', () => {\n it('parses a valid integer string', () => {\n const result = IntegerFromStringOrEmptySchema.parse('123');\n assert.equal(result, 123);\n });\n\n it('parses an empty string as null', () => {\n const result = IntegerFromStringOrEmptySchema.parse('');\n assert.equal(result, null);\n });\n\n it('rejects a non-integer string', () => {\n const result = IntegerFromStringOrEmptySchema.safeParse('abc');\n assert.isFalse(result.success);\n });\n\n it('rejects a decimal string', () => {\n const result = IntegerFromStringOrEmptySchema.safeParse('123.45');\n assert.isFalse(result.success);\n });\n});\n\ndescribe('ArrayFromStringOrArraySchema', () => {\n it('parses a string to an array', () => {\n const result = ArrayFromStringOrArraySchema.parse('a');\n assert.deepEqual(result, ['a']);\n });\n\n it('parses an array to itself', () => {\n const result = ArrayFromStringOrArraySchema.parse(['a', 'b', 'c']);\n assert.deepEqual(result, ['a', 'b', 'c']);\n });\n\n it('rejects an integer', () => {\n const result = ArrayFromStringOrArraySchema.safeParse(123);\n assert.isFalse(result.success);\n });\n\n it('rejects an object', () => {\n const result = ArrayFromStringOrArraySchema.safeParse({ a: 1 });\n assert.isFalse(result.success);\n });\n});\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prairielearn/zod",
3
- "version": "1.2.1",
3
+ "version": "1.3.0",
4
4
  "type": "module",
5
5
  "repository": {
6
6
  "type": "git",
package/src/index.test.ts CHANGED
@@ -3,11 +3,31 @@ import { assert, describe, it } from 'vitest';
3
3
 
4
4
  import {
5
5
  ArrayFromStringOrArraySchema,
6
+ BooleanFromCheckboxSchema,
6
7
  IdSchema,
7
8
  IntegerFromStringOrEmptySchema,
8
9
  IntervalSchema,
9
10
  } from './index.js';
10
11
 
12
+ describe('BooleanFromCheckboxSchema', () => {
13
+ it('parses a checked checkbox', () => {
14
+ const result = BooleanFromCheckboxSchema.parse('on');
15
+ assert.isTrue(result);
16
+ });
17
+ it('parses an unchecked checkbox', () => {
18
+ const result = BooleanFromCheckboxSchema.parse(undefined);
19
+ assert.isFalse(result);
20
+ });
21
+ it('parses a checkbox with an empty string', () => {
22
+ const result = BooleanFromCheckboxSchema.parse('');
23
+ assert.isFalse(result);
24
+ });
25
+ it('parses a checkbox with a non-empty string', () => {
26
+ const result = BooleanFromCheckboxSchema.parse('checked');
27
+ assert.isTrue(result);
28
+ });
29
+ });
30
+
11
31
  describe('IdSchema', () => {
12
32
  it('parses a valid id', () => {
13
33
  const id = IdSchema.parse('123');
package/src/index.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import parsePostgresInterval from 'postgres-interval';
2
- import { z } from 'zod';
2
+ import { type ZodTypeAny, z } from 'zod';
3
3
 
4
4
  const INTERVAL_MS_PER_SECOND = 1000;
5
5
  const INTERVAL_MS_PER_MINUTE = 60 * INTERVAL_MS_PER_SECOND;
@@ -8,16 +8,37 @@ const INTERVAL_MS_PER_DAY = 24 * INTERVAL_MS_PER_HOUR;
8
8
  const INTERVAL_MS_PER_MONTH = 30 * INTERVAL_MS_PER_DAY;
9
9
  const INTERVAL_MS_PER_YEAR = 365.25 * INTERVAL_MS_PER_DAY;
10
10
 
11
+ /**
12
+ * A schema type on which `.optional()` cannot be called.
13
+ */
14
+ type NoOptional<S extends ZodTypeAny> = S & {
15
+ optional: never;
16
+ };
17
+
18
+ /**
19
+ * Wrap any Zod schema so that calling `.optional()` is illegal in TypeScript.
20
+ * Runtime behavior is untouched.
21
+ */
22
+ function required<S extends ZodTypeAny>(schema: S): NoOptional<S> {
23
+ return schema as unknown as NoOptional<S>;
24
+ }
25
+
11
26
  /**
12
27
  * A Zod schema for a boolean from a single checkbox input in the body
13
28
  * parameters from a form. This will return a boolean with a value of `true` if
14
29
  * the checkbox is checked (the input is present) and `false` if it is not
15
30
  * checked.
31
+ *
32
+ * Note that this will not behave sensibly if `.optional()` is called on the schema,
33
+ * as it will turn a missing checkbox into `undefined` instead of `false`. We use
34
+ * some TypeScript magic to ensure that `.optional()` cannot be called on this schema.
16
35
  */
17
- export const BooleanFromCheckboxSchema = z
18
- .string()
19
- .optional()
20
- .transform((s) => !!s);
36
+ export const BooleanFromCheckboxSchema = required(
37
+ z
38
+ .string()
39
+ .optional()
40
+ .transform((s) => !!s),
41
+ );
21
42
 
22
43
  /**
23
44
  * A Zod schema for a PostgreSQL ID.