Add Nix flake for Zod-PocketBase dev environment and remove doc and

playground
This commit is contained in:
2025-10-05 14:51:00 +02:00
parent 41f083d69e
commit c15e42b967
69 changed files with 1190 additions and 16604 deletions

71
src/schemas.ts Normal file
View File

@@ -0,0 +1,71 @@
import { type AnyZodObject, type objectUtil, z, type ZodEffects, type ZodObject, ZodOptional, type ZodRawShape } from "zod";
import type { AnyZodRecord, HasRequiredKeys, ZodRecordKeys } from "./types.ts";
/**
* Records list schema.
*/
export const AnyRecordsList = z.object({
items: z.any().array(),
page: z.number().int().min(1),
perPage: z.number().int().min(1),
totalItems: z.number().int().min(-1),
totalPages: z.number().int().min(-1),
});
/**
* Extends the given schema with the given expansion.
* @param schema - The original schema
* @param shape - The shape of the expansion
* @returns A new schema extended with the given expansion
*/
export function expand<S extends AnyZodObject, E extends ZodRawShape>(schema: S, shape: E) {
const isExpandOptional = Object.entries(shape).every(([, value]) => value instanceof z.ZodOptional);
return z
.object({ ...schema.shape, expand: isExpandOptional ? z.object(shape).optional() : z.object(shape) })
.transform(({ expand, ...rest }) => ({ ...rest, ...(expand ?? {}) })) as ZodObjectExpand<S, E>;
}
/**
* Picks the given keys from the given schema.
* @param schema - The original schema
* @param keys - The keys to keep
* @returns A new schema with only the given keys
*/
export function pick<S extends AnyZodObject, K extends ZodRecordKeys<S>[]>(schema: S, keys: K) {
return schema.pick(Object.fromEntries(keys.map((key) => [key, true]))) as ZodObjectPick<S, K>;
}
/**
* Picks the given keys from the given schema and extends it with the given expansion.
* @param schema - The original schema
* @param keys - The keys to keep
* @param shape - The shape of the expansion
* @returns A new schema with only the given keys
*/
export function select<S extends AnyZodObject, K extends ZodRecordKeys<S>[], E extends ZodRawShape>(
schema: S,
keys: K,
shape: E,
): ZodObjectExpand<ZodObjectPick<S, K>, E>;
export function select<S extends AnyZodObject, K extends ZodRecordKeys<S>[]>(schema: S, keys: K): ZodObjectPick<S, K>;
export function select<S extends AnyZodObject, K extends ZodRecordKeys<S>[], E extends ZodRawShape | undefined>(
schema: S,
keys: K,
shape?: E,
) {
return shape ? expand(pick(schema, keys), shape) : pick(schema, keys);
}
export type ZodObjectExpand<S extends AnyZodObject, E extends ZodRawShape> =
S extends ZodObject<infer T, infer U, infer C>
? ZodEffects<
ZodObject<objectUtil.extendShape<T, { expand: HasRequiredKeys<E> extends true ? ZodObject<E> : ZodOptional<ZodObject<E>> }>, U, C>,
ZodObject<objectUtil.extendShape<T, E>, U, C>["_output"]
>
: never;
export type ZodObjectPick<S extends AnyZodObject, K extends ZodRecordKeys<S>[]> =
S extends ZodObject<infer T, infer U, infer C> ? ZodObject<Pick<T, K[number]>, U, C> : never;
export type AnyRecordsList = z.infer<typeof AnyRecordsList>;
export type RecordsList<S extends AnyZodRecord> = Omit<AnyRecordsList, "items"> & { items: S["_output"][] };