@rippledb/zod 0.2.0 → 0.2.1
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/README.md +20 -19
- package/dist/index.d.ts +16 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Zod schemas for runtime validation of RippleDB types.
|
|
4
4
|
|
|
5
|
-
📚 **Documentation:**
|
|
5
|
+
📚 **Documentation:**
|
|
6
|
+
[rippledb.dev/docs/reference/zod](https://rippledb.dev/docs/reference/zod)
|
|
6
7
|
|
|
7
8
|
## Installation
|
|
8
9
|
|
|
@@ -13,25 +14,25 @@ npm install @rippledb/zod zod
|
|
|
13
14
|
## Usage
|
|
14
15
|
|
|
15
16
|
```typescript
|
|
16
|
-
import {
|
|
17
|
-
pullRequestSchema,
|
|
17
|
+
import {
|
|
18
18
|
appendRequestSchema,
|
|
19
19
|
changeSchema,
|
|
20
|
-
createChangeSchema
|
|
21
|
-
|
|
22
|
-
|
|
20
|
+
createChangeSchema,
|
|
21
|
+
pullRequestSchema,
|
|
22
|
+
} from "@rippledb/zod";
|
|
23
|
+
import { z } from "zod";
|
|
23
24
|
|
|
24
25
|
// Validate a pull request
|
|
25
26
|
const result = pullRequestSchema.safeParse({
|
|
26
|
-
stream:
|
|
27
|
+
stream: "my-stream",
|
|
27
28
|
cursor: null,
|
|
28
29
|
limit: 100,
|
|
29
30
|
});
|
|
30
31
|
|
|
31
32
|
if (result.success) {
|
|
32
|
-
console.log(
|
|
33
|
+
console.log("Valid:", result.data);
|
|
33
34
|
} else {
|
|
34
|
-
console.error(
|
|
35
|
+
console.error("Invalid:", result.error);
|
|
35
36
|
}
|
|
36
37
|
|
|
37
38
|
// Create a typed change schema for your entities
|
|
@@ -46,16 +47,16 @@ const todoChangeSchema = createChangeSchema(todoSchema);
|
|
|
46
47
|
|
|
47
48
|
## Available Schemas
|
|
48
49
|
|
|
49
|
-
| Schema
|
|
50
|
-
|
|
51
|
-
| `hlcSchema`
|
|
52
|
-
| `changeKindSchema`
|
|
53
|
-
| `changeSchema`
|
|
54
|
-
| `createChangeSchema(schema)` | Create typed change schema
|
|
55
|
-
| `pullRequestSchema`
|
|
56
|
-
| `pullResponseSchema`
|
|
57
|
-
| `appendRequestSchema`
|
|
58
|
-
| `appendResultSchema`
|
|
50
|
+
| Schema | Description |
|
|
51
|
+
| ---------------------------- | ---------------------------------- |
|
|
52
|
+
| `hlcSchema` | HLC timestamp format validation |
|
|
53
|
+
| `changeKindSchema` | Change kind ('upsert' \| 'delete') |
|
|
54
|
+
| `changeSchema` | Generic change object |
|
|
55
|
+
| `createChangeSchema(schema)` | Create typed change schema |
|
|
56
|
+
| `pullRequestSchema` | Pull request validation |
|
|
57
|
+
| `pullResponseSchema` | Pull response validation |
|
|
58
|
+
| `appendRequestSchema` | Append request validation |
|
|
59
|
+
| `appendResultSchema` | Append result validation |
|
|
59
60
|
|
|
60
61
|
## License
|
|
61
62
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,14 +1,19 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import
|
|
1
|
+
import type { DescriptorSchema, SchemaDescriptor } from "@rippledb/core";
|
|
2
|
+
import { z } from "zod";
|
|
3
3
|
/**
|
|
4
4
|
* Helper type to validate that overrides only contain valid entities and fields.
|
|
5
5
|
* When used with `as const`, this helps catch extra properties even when assigned to variables.
|
|
6
|
+
*
|
|
7
|
+
* Optimized version: breaks down validation into helper types to reduce conditional depth.
|
|
6
8
|
*/
|
|
9
|
+
type ValidateEntityFields<S extends DescriptorSchema, E extends keyof S, Fields> = keyof Fields extends keyof S[E] ? Fields : never;
|
|
10
|
+
type ValidateEntityOverride<S extends DescriptorSchema, E extends keyof S, Override> = E extends keyof S ? ValidateEntityFields<S, E, Override> : never;
|
|
11
|
+
type ValidateEntities<S extends DescriptorSchema, O> = {
|
|
12
|
+
[E in keyof O]: E extends keyof S ? ValidateEntityOverride<S, E, O[E]> : never;
|
|
13
|
+
};
|
|
7
14
|
type ValidateOverrides<S extends DescriptorSchema, O> = [
|
|
8
15
|
keyof O
|
|
9
|
-
] extends [never] ? O : keyof O extends keyof S ?
|
|
10
|
-
[E in keyof O]: E extends keyof S ? keyof O[E] extends keyof S[E] ? unknown : never : never;
|
|
11
|
-
}[keyof O] extends never ? never : O : never;
|
|
16
|
+
] extends [never] ? O : keyof O extends keyof S ? ValidateEntities<S, O>[keyof O] extends never ? never : O : never;
|
|
12
17
|
/**
|
|
13
18
|
* Typed overrides for Zod schemas - constrained to valid entities and fields.
|
|
14
19
|
*/
|
|
@@ -28,13 +33,17 @@ export type ZodSchemas<S extends DescriptorSchema> = {
|
|
|
28
33
|
/**
|
|
29
34
|
* Schema descriptor with typed Zod schema access.
|
|
30
35
|
*/
|
|
31
|
-
|
|
36
|
+
/**
|
|
37
|
+
* Schema descriptor with typed Zod schema access.
|
|
38
|
+
* Uses interface extends instead of intersection for better type checking performance.
|
|
39
|
+
*/
|
|
40
|
+
export interface SchemaDescriptorWithZod<S extends DescriptorSchema> extends SchemaDescriptor<S> {
|
|
32
41
|
/**
|
|
33
42
|
* Auto-generated Zod schemas for each entity.
|
|
34
43
|
* Access via `schema.zod.entityName.parse(data)`.
|
|
35
44
|
*/
|
|
36
45
|
readonly zod: ZodSchemas<S>;
|
|
37
|
-
}
|
|
46
|
+
}
|
|
38
47
|
/**
|
|
39
48
|
* Wraps a SchemaDescriptor with auto-generated Zod schemas.
|
|
40
49
|
*
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAEhB,gBAAgB,EACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB;;;;;GAKG;AAEH,KAAK,oBAAoB,CACvB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,MAAM,CAAC,EACjB,MAAM,IACJ,MAAM,MAAM,SAAS,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AAGrD,KAAK,sBAAsB,CACzB,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,MAAM,CAAC,EACjB,QAAQ,IACN,CAAC,SAAS,MAAM,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,GACxD,KAAK,CAAC;AAGV,KAAK,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,IAAI;KACpD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,sBAAsB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAClE,KAAK;CACV,CAAC;AAGF,KAAK,iBAAiB,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,IAElD;IAAC,MAAM,CAAC;CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,GAEzB,MAAM,CAAC,SAAS,MAAM,CAAC,GACrB,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GACrD,CAAC,GACH,KAAK,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,IAAI;KACpD,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE;SACd,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU;KACjC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,gBAAgB,IAAI;KAClD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,CACzB;SACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU;KAChC,CACF;CACF,CAAC;AAEF;;GAEG;AACH;;;GAGG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC,SAAS,gBAAgB,CACjE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CAC7B;AAyCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAC3E,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,SAAS,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACtC,uBAAuB,CAAC,CAAC,CAAC,CA8B5B;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,CAAC,SAAS,gBAAgB,EAC1B,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAEzB,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAC3B,SAAS,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,GACtC,UAAU,CAAC,CAAC,CAAC,CAuBf;AAMD;;;GAGG;AACH,eAAO,MAAM,SAAS,aAAyD,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,gBAAgB,iCAA+B,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,EACrE,WAAW,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAWf;AAED;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;EAQvB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;EAI5B,CAAC;AAEH;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAC7D,YAAY,EAAE,CAAC;;;;;;;;;GAMhB;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyC,CAAC;AAEzE;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAC9D,YAAY,EAAE,CAAC;;;;;;;;;;;;GAOhB;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA0C,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAC;AAGH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC/D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACvD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AACjE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACrE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { z } from 'zod';\nimport type {\n SchemaDescriptor,\n DescriptorSchema,\n FieldDescriptorLike,\n} from '@rippledb/core';\n\n// ============================================================================\n// withZod - Auto-generate Zod schemas from field descriptors\n// ============================================================================\n\n/**\n * Helper type to validate that overrides only contain valid entities and fields.\n * When used with `as const`, this helps catch extra properties even when assigned to variables.\n */\ntype ValidateOverrides<S extends DescriptorSchema, O> =\n // Special case: empty overrides object is always valid\n [keyof O] extends [never]\n ? O\n : // Check that all entity keys in O are valid entities in S\n keyof O extends keyof S\n ? // For each entity, check that all field keys are valid\n {\n [E in keyof O]: E extends keyof S\n ? keyof O[E] extends keyof S[E]\n ? unknown // Valid\n : never // Invalid - has extra fields\n : never; // Invalid - entity doesn't exist\n }[keyof O] extends never\n ? never // At least one entity has invalid fields\n : O // All valid\n : never; // Has extra entities\n\n/**\n * Typed overrides for Zod schemas - constrained to valid entities and fields.\n */\nexport type ZodOverrides<S extends DescriptorSchema> = {\n [E in keyof S]?: {\n [F in keyof S[E]]?: z.ZodTypeAny;\n };\n};\n\n/**\n * Generated Zod schemas for each entity.\n */\nexport type ZodSchemas<S extends DescriptorSchema> = {\n [E in keyof S]: z.ZodObject<{\n [F in keyof S[E]]: z.ZodTypeAny;\n }>;\n};\n\n/**\n * Schema descriptor with typed Zod schema access.\n */\nexport type SchemaDescriptorWithZod<S extends DescriptorSchema> = SchemaDescriptor<S> & {\n /**\n * Auto-generated Zod schemas for each entity.\n * Access via `schema.zod.entityName.parse(data)`.\n */\n readonly zod: ZodSchemas<S>;\n};\n\n/**\n * Converts a field descriptor to a Zod schema.\n */\nfunction fieldDescriptorToZod(field: FieldDescriptorLike): z.ZodTypeAny {\n let schema: z.ZodTypeAny;\n\n switch (field._type) {\n case 'string':\n schema = z.string();\n break;\n case 'number':\n schema = z.number();\n break;\n case 'boolean':\n schema = z.boolean();\n break;\n case 'enum': {\n // Cast to access the values property on enum fields\n const enumField = field as unknown as { values: readonly string[] };\n if (!enumField.values || enumField.values.length === 0) {\n schema = z.never();\n } else if (enumField.values.length === 1) {\n schema = z.literal(enumField.values[0]);\n } else {\n schema = z.enum(enumField.values as [string, ...string[]]);\n }\n break;\n }\n default:\n schema = z.unknown();\n }\n\n if (field._optional) {\n schema = schema.optional();\n }\n\n return schema;\n}\n\n/**\n * Wraps a SchemaDescriptor with auto-generated Zod schemas.\n * \n * The Zod schemas are generated from the field descriptors in the schema.\n * You can optionally provide overrides to customize individual field schemas\n * (e.g., to add refinements like `.min()`, `.max()`, `.email()`, etc.).\n * \n * @param schema - The schema descriptor to wrap\n * @param overrides - Optional Zod schema overrides for specific fields\n * @returns A schema descriptor with typed `.zod` access\n * \n * @example\n * ```ts\n * import { defineSchema, s } from '@rippledb/core';\n * import { withZod } from '@rippledb/zod';\n * import { z } from 'zod';\n * \n * const schema = defineSchema({\n * todos: {\n * id: s.string(),\n * title: s.string(),\n * done: s.boolean(),\n * },\n * users: {\n * id: s.string(),\n * name: s.string(),\n * email: s.string(),\n * },\n * });\n * \n * // Basic usage - auto-generate all Zod schemas\n * const schemaWithZod = withZod(schema);\n * \n * // Validate data\n * const todo = schemaWithZod.zod.todos.parse({ id: '1', title: 'Test', done: false });\n * \n * // With overrides - add refinements\n * const schemaWithRefinements = withZod(schema, {\n * todos: {\n * title: z.string().min(1).max(100),\n * },\n * users: {\n * email: z.string().email(),\n * },\n * });\n * ```\n */\nexport function withZod<S extends DescriptorSchema, O extends ZodOverrides<S>>(\n schema: SchemaDescriptor<S>,\n overrides?: O & ValidateOverrides<S, O>,\n): SchemaDescriptorWithZod<S> {\n const zodSchemas = {} as Record<string, z.ZodObject<Record<string, z.ZodTypeAny>>>;\n\n for (const entityName of schema.entities) {\n const entityDescriptor = schema.schema[entityName];\n const entityOverridesObj = overrides?.[entityName as keyof S] as Record<string, z.ZodTypeAny> | undefined;\n const shape: Record<string, z.ZodTypeAny> = {};\n\n for (const fieldName of Object.keys(entityDescriptor)) {\n const fieldDescriptor = entityDescriptor[fieldName];\n // Use override if provided, otherwise generate from descriptor\n shape[fieldName] = entityOverridesObj?.[fieldName] ?? fieldDescriptorToZod(fieldDescriptor);\n }\n\n zodSchemas[entityName] = z.object(shape);\n }\n\n // Extend the schema with the zod extension\n const extendedSchema = schema.extend('zod', zodSchemas);\n\n return {\n ...extendedSchema,\n zod: zodSchemas as ZodSchemas<S>,\n };\n}\n\n/**\n * Generates Zod schemas from a schema descriptor without wrapping it.\n * Use this if you only need the Zod schemas without the extended descriptor.\n * \n * @param schema - The schema descriptor\n * @param overrides - Optional Zod schema overrides\n * @returns Generated Zod schemas for each entity\n */\nexport function generateZodSchemas<S extends DescriptorSchema, O extends ZodOverrides<S>>(\n schema: SchemaDescriptor<S>,\n overrides?: O & ValidateOverrides<S, O>,\n): ZodSchemas<S> {\n const zodSchemas = {} as Record<string, z.ZodObject<Record<string, z.ZodTypeAny>>>;\n\n for (const entityName of schema.entities) {\n const entityDescriptor = schema.schema[entityName];\n const entityOverridesObj = overrides?.[entityName as keyof S] as Record<string, z.ZodTypeAny> | undefined;\n const shape: Record<string, z.ZodTypeAny> = {};\n\n for (const fieldName of Object.keys(entityDescriptor)) {\n const fieldDescriptor = entityDescriptor[fieldName];\n shape[fieldName] = entityOverridesObj?.[fieldName] ?? fieldDescriptorToZod(fieldDescriptor);\n }\n\n zodSchemas[entityName] = z.object(shape);\n }\n\n return zodSchemas as ZodSchemas<S>;\n}\n\n// ============================================================================\n// Existing schemas for RippleDB protocol types\n// ============================================================================\n\n/**\n * Zod schema for HLC (Hybrid Logical Clock) timestamps.\n * Format: \"{wallTimeMs}:{counter}:{nodeId}\"\n */\nexport const hlcSchema = z.string().regex(/^\\d+:\\d+:.+$/, 'Invalid HLC format');\n\n/**\n * Zod schema for change kind (upsert or delete).\n */\nexport const changeKindSchema = z.enum(['upsert', 'delete']);\n\n/**\n * Creates a Zod schema for a Change object.\n * \n * @example\n * ```ts\n * const todoChangeSchema = createChangeSchema(z.object({\n * id: z.string(),\n * title: z.string(),\n * done: z.boolean().optional(),\n * }));\n * ```\n */\nexport function createChangeSchema<T extends z.ZodObject<z.ZodRawShape>>(patchSchema: T) {\n return z.object({\n stream: z.string(),\n entity: z.string(),\n entityId: z.string(),\n kind: changeKindSchema,\n patch: patchSchema.partial(),\n tags: z.record(z.string(), hlcSchema),\n hlc: hlcSchema,\n });\n}\n\n/**\n * Generic change schema when patch structure is unknown.\n */\nexport const changeSchema = z.object({\n stream: z.string(),\n entity: z.string(),\n entityId: z.string(),\n kind: changeKindSchema,\n patch: z.record(z.string(), z.unknown()),\n tags: z.record(z.string(), hlcSchema),\n hlc: hlcSchema,\n});\n\n/**\n * Zod schema for PullRequest.\n */\nexport const pullRequestSchema = z.object({\n stream: z.string(),\n cursor: z.string().nullable(),\n limit: z.number().int().positive().optional(),\n});\n\n/**\n * Creates a Zod schema for PullResponse with typed changes.\n */\nexport function createPullResponseSchema<T extends z.ZodTypeAny>(changeSchema: T) {\n return z.object({\n changes: z.array(changeSchema),\n nextCursor: z.string().nullable(),\n });\n}\n\n/**\n * Generic pull response schema.\n */\nexport const pullResponseSchema = createPullResponseSchema(changeSchema);\n\n/**\n * Creates a Zod schema for AppendRequest with typed changes.\n */\nexport function createAppendRequestSchema<T extends z.ZodTypeAny>(changeSchema: T) {\n return z.object({\n stream: z.string(),\n idempotencyKey: z.string().optional(),\n changes: z.array(changeSchema),\n });\n}\n\n/**\n * Generic append request schema.\n */\nexport const appendRequestSchema = createAppendRequestSchema(changeSchema);\n\n/**\n * Zod schema for AppendResult.\n */\nexport const appendResultSchema = z.object({\n accepted: z.number().int().nonnegative(),\n hlc: hlcSchema.optional(),\n});\n\n// Re-export zod types for convenience\nexport type HlcInput = z.infer<typeof hlcSchema>;\nexport type ChangeKindInput = z.infer<typeof changeKindSchema>;\nexport type ChangeInput = z.infer<typeof changeSchema>;\nexport type PullRequestInput = z.infer<typeof pullRequestSchema>;\nexport type PullResponseInput = z.infer<typeof pullResponseSchema>;\nexport type AppendRequestInput = z.infer<typeof appendRequestSchema>;\nexport type AppendResultInput = z.infer<typeof appendResultSchema>;\n"],"mappings":";AAAA,SAAS,SAAS;AAiElB,SAAS,qBAAqB,OAA0C;AACtE,MAAI;AAEJ,UAAQ,MAAM,OAAO;AAAA,IACnB,KAAK;AACH,eAAS,EAAE,OAAO;AAClB;AAAA,IACF,KAAK;AACH,eAAS,EAAE,OAAO;AAClB;AAAA,IACF,KAAK;AACH,eAAS,EAAE,QAAQ;AACnB;AAAA,IACF,KAAK,QAAQ;AAEX,YAAM,YAAY;AAClB,UAAI,CAAC,UAAU,UAAU,UAAU,OAAO,WAAW,GAAG;AACtD,iBAAS,EAAE,MAAM;AAAA,MACnB,WAAW,UAAU,OAAO,WAAW,GAAG;AACxC,iBAAS,EAAE,QAAQ,UAAU,OAAO,CAAC,CAAC;AAAA,MACxC,OAAO;AACL,iBAAS,EAAE,KAAK,UAAU,MAA+B;AAAA,MAC3D;AACA;AAAA,IACF;AAAA,IACA;AACE,eAAS,EAAE,QAAQ;AAAA,EACvB;AAEA,MAAI,MAAM,WAAW;AACnB,aAAS,OAAO,SAAS;AAAA,EAC3B;AAEA,SAAO;AACT;AAiDO,SAAS,QACd,QACA,WAC4B;AAC5B,QAAM,aAAa,CAAC;AAEpB,aAAW,cAAc,OAAO,UAAU;AACxC,UAAM,mBAAmB,OAAO,OAAO,UAAU;AACjD,UAAM,qBAAqB,YAAY,UAAqB;AAC5D,UAAM,QAAsC,CAAC;AAE7C,eAAW,aAAa,OAAO,KAAK,gBAAgB,GAAG;AACrD,YAAM,kBAAkB,iBAAiB,SAAS;AAElD,YAAM,SAAS,IAAI,qBAAqB,SAAS,KAAK,qBAAqB,eAAe;AAAA,IAC5F;AAEA,eAAW,UAAU,IAAI,EAAE,OAAO,KAAK;AAAA,EACzC;AAGA,QAAM,iBAAiB,OAAO,OAAO,OAAO,UAAU;AAEtD,SAAO;AAAA,IACL,GAAG;AAAA,IACH,KAAK;AAAA,EACP;AACF;AAUO,SAAS,mBACd,QACA,WACe;AACf,QAAM,aAAa,CAAC;AAEpB,aAAW,cAAc,OAAO,UAAU;AACxC,UAAM,mBAAmB,OAAO,OAAO,UAAU;AACjD,UAAM,qBAAqB,YAAY,UAAqB;AAC5D,UAAM,QAAsC,CAAC;AAE7C,eAAW,aAAa,OAAO,KAAK,gBAAgB,GAAG;AACrD,YAAM,kBAAkB,iBAAiB,SAAS;AAClD,YAAM,SAAS,IAAI,qBAAqB,SAAS,KAAK,qBAAqB,eAAe;AAAA,IAC5F;AAEA,eAAW,UAAU,IAAI,EAAE,OAAO,KAAK;AAAA,EACzC;AAEA,SAAO;AACT;AAUO,IAAM,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,oBAAoB;AAKvE,IAAM,mBAAmB,EAAE,KAAK,CAAC,UAAU,QAAQ,CAAC;AAcpD,SAAS,mBAAyD,aAAgB;AACvF,SAAO,EAAE,OAAO;AAAA,IACd,QAAQ,EAAE,OAAO;AAAA,IACjB,QAAQ,EAAE,OAAO;AAAA,IACjB,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM;AAAA,IACN,OAAO,YAAY,QAAQ;AAAA,IAC3B,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;AAAA,IACpC,KAAK;AAAA,EACP,CAAC;AACH;AAKO,IAAM,eAAe,EAAE,OAAO;AAAA,EACnC,QAAQ,EAAE,OAAO;AAAA,EACjB,QAAQ,EAAE,OAAO;AAAA,EACjB,UAAU,EAAE,OAAO;AAAA,EACnB,MAAM;AAAA,EACN,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;AAAA,EACvC,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;AAAA,EACpC,KAAK;AACP,CAAC;AAKM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,QAAQ,EAAE,OAAO;AAAA,EACjB,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS;AAC9C,CAAC;AAKM,SAAS,yBAAiDA,eAAiB;AAChF,SAAO,EAAE,OAAO;AAAA,IACd,SAAS,EAAE,MAAMA,aAAY;AAAA,IAC7B,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,EAClC,CAAC;AACH;AAKO,IAAM,qBAAqB,yBAAyB,YAAY;AAKhE,SAAS,0BAAkDA,eAAiB;AACjF,SAAO,EAAE,OAAO;AAAA,IACd,QAAQ,EAAE,OAAO;AAAA,IACjB,gBAAgB,EAAE,OAAO,EAAE,SAAS;AAAA,IACpC,SAAS,EAAE,MAAMA,aAAY;AAAA,EAC/B,CAAC;AACH;AAKO,IAAM,sBAAsB,0BAA0B,YAAY;AAKlE,IAAM,qBAAqB,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,EACvC,KAAK,UAAU,SAAS;AAC1B,CAAC;","names":["changeSchema"]}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n DescriptorSchema,\n FieldDescriptorLike,\n SchemaDescriptor,\n} from \"@rippledb/core\";\nimport { z } from \"zod\";\n\n// ============================================================================\n// withZod - Auto-generate Zod schemas from field descriptors\n// ============================================================================\n\n/**\n * Helper type to validate that overrides only contain valid entities and fields.\n * When used with `as const`, this helps catch extra properties even when assigned to variables.\n *\n * Optimized version: breaks down validation into helper types to reduce conditional depth.\n */\n// Check if entity fields are valid\ntype ValidateEntityFields<\n S extends DescriptorSchema,\n E extends keyof S,\n Fields,\n> = keyof Fields extends keyof S[E] ? Fields : never;\n\n// Check if an entity override is valid\ntype ValidateEntityOverride<\n S extends DescriptorSchema,\n E extends keyof S,\n Override,\n> = E extends keyof S ? ValidateEntityFields<S, E, Override>\n : never;\n\n// Validate all entities in overrides\ntype ValidateEntities<S extends DescriptorSchema, O> = {\n [E in keyof O]: E extends keyof S ? ValidateEntityOverride<S, E, O[E]>\n : never;\n};\n\n// Main validation type - optimized to reduce conditional depth\ntype ValidateOverrides<S extends DescriptorSchema, O> =\n // Special case: empty overrides object is always valid\n [keyof O] extends [never] ? O\n // Check that all entity keys in O are valid entities in S\n : keyof O extends keyof S\n ? ValidateEntities<S, O>[keyof O] extends never ? never // At least one entity has invalid fields\n : O // All valid\n : never; // Has extra entities\n\n/**\n * Typed overrides for Zod schemas - constrained to valid entities and fields.\n */\nexport type ZodOverrides<S extends DescriptorSchema> = {\n [E in keyof S]?: {\n [F in keyof S[E]]?: z.ZodTypeAny;\n };\n};\n\n/**\n * Generated Zod schemas for each entity.\n */\nexport type ZodSchemas<S extends DescriptorSchema> = {\n [E in keyof S]: z.ZodObject<\n {\n [F in keyof S[E]]: z.ZodTypeAny;\n }\n >;\n};\n\n/**\n * Schema descriptor with typed Zod schema access.\n */\n/**\n * Schema descriptor with typed Zod schema access.\n * Uses interface extends instead of intersection for better type checking performance.\n */\nexport interface SchemaDescriptorWithZod<S extends DescriptorSchema>\n extends SchemaDescriptor<S>\n{\n /**\n * Auto-generated Zod schemas for each entity.\n * Access via `schema.zod.entityName.parse(data)`.\n */\n readonly zod: ZodSchemas<S>;\n}\n\n/**\n * Converts a field descriptor to a Zod schema.\n */\nfunction fieldDescriptorToZod(field: FieldDescriptorLike): z.ZodTypeAny {\n let schema: z.ZodTypeAny;\n\n switch (field._type) {\n case \"string\":\n schema = z.string();\n break;\n case \"number\":\n schema = z.number();\n break;\n case \"boolean\":\n schema = z.boolean();\n break;\n case \"enum\": {\n // Cast to access the values property on enum fields\n const enumField = field as unknown as { values: readonly string[]; };\n if (!enumField.values || enumField.values.length === 0) {\n schema = z.never();\n } else if (enumField.values.length === 1) {\n schema = z.literal(enumField.values[0]);\n } else {\n schema = z.enum(enumField.values as [string, ...string[]]);\n }\n break;\n }\n default:\n schema = z.unknown();\n }\n\n if (field._optional) {\n schema = schema.optional();\n }\n\n return schema;\n}\n\n/**\n * Wraps a SchemaDescriptor with auto-generated Zod schemas.\n *\n * The Zod schemas are generated from the field descriptors in the schema.\n * You can optionally provide overrides to customize individual field schemas\n * (e.g., to add refinements like `.min()`, `.max()`, `.email()`, etc.).\n *\n * @param schema - The schema descriptor to wrap\n * @param overrides - Optional Zod schema overrides for specific fields\n * @returns A schema descriptor with typed `.zod` access\n *\n * @example\n * ```ts\n * import { defineSchema, s } from '@rippledb/core';\n * import { withZod } from '@rippledb/zod';\n * import { z } from 'zod';\n *\n * const schema = defineSchema({\n * todos: {\n * id: s.string(),\n * title: s.string(),\n * done: s.boolean(),\n * },\n * users: {\n * id: s.string(),\n * name: s.string(),\n * email: s.string(),\n * },\n * });\n *\n * // Basic usage - auto-generate all Zod schemas\n * const schemaWithZod = withZod(schema);\n *\n * // Validate data\n * const todo = schemaWithZod.zod.todos.parse({ id: '1', title: 'Test', done: false });\n *\n * // With overrides - add refinements\n * const schemaWithRefinements = withZod(schema, {\n * todos: {\n * title: z.string().min(1).max(100),\n * },\n * users: {\n * email: z.string().email(),\n * },\n * });\n * ```\n */\nexport function withZod<S extends DescriptorSchema, O extends ZodOverrides<S>>(\n schema: SchemaDescriptor<S>,\n overrides?: O & ValidateOverrides<S, O>,\n): SchemaDescriptorWithZod<S> {\n const zodSchemas = {} as Record<\n string,\n z.ZodObject<Record<string, z.ZodTypeAny>>\n >;\n\n for (const entityName of schema.entities) {\n const entityDescriptor = schema.schema[entityName];\n const entityOverridesObj = overrides?.[entityName as keyof S] as\n | Record<string, z.ZodTypeAny>\n | undefined;\n const shape: Record<string, z.ZodTypeAny> = {};\n\n for (const fieldName of Object.keys(entityDescriptor)) {\n const fieldDescriptor = entityDescriptor[fieldName];\n // Use override if provided, otherwise generate from descriptor\n shape[fieldName] = entityOverridesObj?.[fieldName]\n ?? fieldDescriptorToZod(fieldDescriptor);\n }\n\n zodSchemas[entityName] = z.object(shape);\n }\n\n // Extend the schema with the zod extension\n const extendedSchema = schema.extend(\"zod\", zodSchemas);\n\n return {\n ...extendedSchema,\n zod: zodSchemas as ZodSchemas<S>,\n };\n}\n\n/**\n * Generates Zod schemas from a schema descriptor without wrapping it.\n * Use this if you only need the Zod schemas without the extended descriptor.\n *\n * @param schema - The schema descriptor\n * @param overrides - Optional Zod schema overrides\n * @returns Generated Zod schemas for each entity\n */\nexport function generateZodSchemas<\n S extends DescriptorSchema,\n O extends ZodOverrides<S>,\n>(\n schema: SchemaDescriptor<S>,\n overrides?: O & ValidateOverrides<S, O>,\n): ZodSchemas<S> {\n const zodSchemas = {} as Record<\n string,\n z.ZodObject<Record<string, z.ZodTypeAny>>\n >;\n\n for (const entityName of schema.entities) {\n const entityDescriptor = schema.schema[entityName];\n const entityOverridesObj = overrides?.[entityName as keyof S] as\n | Record<string, z.ZodTypeAny>\n | undefined;\n const shape: Record<string, z.ZodTypeAny> = {};\n\n for (const fieldName of Object.keys(entityDescriptor)) {\n const fieldDescriptor = entityDescriptor[fieldName];\n shape[fieldName] = entityOverridesObj?.[fieldName]\n ?? fieldDescriptorToZod(fieldDescriptor);\n }\n\n zodSchemas[entityName] = z.object(shape);\n }\n\n return zodSchemas as ZodSchemas<S>;\n}\n\n// ============================================================================\n// Existing schemas for RippleDB protocol types\n// ============================================================================\n\n/**\n * Zod schema for HLC (Hybrid Logical Clock) timestamps.\n * Format: \"{wallTimeMs}:{counter}:{nodeId}\"\n */\nexport const hlcSchema = z.string().regex(/^\\d+:\\d+:.+$/, \"Invalid HLC format\");\n\n/**\n * Zod schema for change kind (upsert or delete).\n */\nexport const changeKindSchema = z.enum([\"upsert\", \"delete\"]);\n\n/**\n * Creates a Zod schema for a Change object.\n *\n * @example\n * ```ts\n * const todoChangeSchema = createChangeSchema(z.object({\n * id: z.string(),\n * title: z.string(),\n * done: z.boolean().optional(),\n * }));\n * ```\n */\nexport function createChangeSchema<T extends z.ZodObject<z.ZodRawShape>>(\n patchSchema: T,\n) {\n return z.object({\n stream: z.string(),\n entity: z.string(),\n entityId: z.string(),\n kind: changeKindSchema,\n patch: patchSchema.partial(),\n tags: z.record(z.string(), hlcSchema),\n hlc: hlcSchema,\n });\n}\n\n/**\n * Generic change schema when patch structure is unknown.\n */\nexport const changeSchema = z.object({\n stream: z.string(),\n entity: z.string(),\n entityId: z.string(),\n kind: changeKindSchema,\n patch: z.record(z.string(), z.unknown()),\n tags: z.record(z.string(), hlcSchema),\n hlc: hlcSchema,\n});\n\n/**\n * Zod schema for PullRequest.\n */\nexport const pullRequestSchema = z.object({\n stream: z.string(),\n cursor: z.string().nullable(),\n limit: z.number().int().positive().optional(),\n});\n\n/**\n * Creates a Zod schema for PullResponse with typed changes.\n */\nexport function createPullResponseSchema<T extends z.ZodTypeAny>(\n changeSchema: T,\n) {\n return z.object({\n changes: z.array(changeSchema),\n nextCursor: z.string().nullable(),\n });\n}\n\n/**\n * Generic pull response schema.\n */\nexport const pullResponseSchema = createPullResponseSchema(changeSchema);\n\n/**\n * Creates a Zod schema for AppendRequest with typed changes.\n */\nexport function createAppendRequestSchema<T extends z.ZodTypeAny>(\n changeSchema: T,\n) {\n return z.object({\n stream: z.string(),\n idempotencyKey: z.string().optional(),\n changes: z.array(changeSchema),\n });\n}\n\n/**\n * Generic append request schema.\n */\nexport const appendRequestSchema = createAppendRequestSchema(changeSchema);\n\n/**\n * Zod schema for AppendResult.\n */\nexport const appendResultSchema = z.object({\n accepted: z.number().int().nonnegative(),\n hlc: hlcSchema.optional(),\n});\n\n// Re-export zod types for convenience\nexport type HlcInput = z.infer<typeof hlcSchema>;\nexport type ChangeKindInput = z.infer<typeof changeKindSchema>;\nexport type ChangeInput = z.infer<typeof changeSchema>;\nexport type PullRequestInput = z.infer<typeof pullRequestSchema>;\nexport type PullResponseInput = z.infer<typeof pullResponseSchema>;\nexport type AppendRequestInput = z.infer<typeof appendRequestSchema>;\nexport type AppendResultInput = z.infer<typeof appendResultSchema>;\n"],"mappings":";AAKA,SAAS,SAAS;AAmFlB,SAAS,qBAAqB,OAA0C;AACtE,MAAI;AAEJ,UAAQ,MAAM,OAAO;AAAA,IACnB,KAAK;AACH,eAAS,EAAE,OAAO;AAClB;AAAA,IACF,KAAK;AACH,eAAS,EAAE,OAAO;AAClB;AAAA,IACF,KAAK;AACH,eAAS,EAAE,QAAQ;AACnB;AAAA,IACF,KAAK,QAAQ;AAEX,YAAM,YAAY;AAClB,UAAI,CAAC,UAAU,UAAU,UAAU,OAAO,WAAW,GAAG;AACtD,iBAAS,EAAE,MAAM;AAAA,MACnB,WAAW,UAAU,OAAO,WAAW,GAAG;AACxC,iBAAS,EAAE,QAAQ,UAAU,OAAO,CAAC,CAAC;AAAA,MACxC,OAAO;AACL,iBAAS,EAAE,KAAK,UAAU,MAA+B;AAAA,MAC3D;AACA;AAAA,IACF;AAAA,IACA;AACE,eAAS,EAAE,QAAQ;AAAA,EACvB;AAEA,MAAI,MAAM,WAAW;AACnB,aAAS,OAAO,SAAS;AAAA,EAC3B;AAEA,SAAO;AACT;AAiDO,SAAS,QACd,QACA,WAC4B;AAC5B,QAAM,aAAa,CAAC;AAKpB,aAAW,cAAc,OAAO,UAAU;AACxC,UAAM,mBAAmB,OAAO,OAAO,UAAU;AACjD,UAAM,qBAAqB,YAAY,UAAqB;AAG5D,UAAM,QAAsC,CAAC;AAE7C,eAAW,aAAa,OAAO,KAAK,gBAAgB,GAAG;AACrD,YAAM,kBAAkB,iBAAiB,SAAS;AAElD,YAAM,SAAS,IAAI,qBAAqB,SAAS,KAC5C,qBAAqB,eAAe;AAAA,IAC3C;AAEA,eAAW,UAAU,IAAI,EAAE,OAAO,KAAK;AAAA,EACzC;AAGA,QAAM,iBAAiB,OAAO,OAAO,OAAO,UAAU;AAEtD,SAAO;AAAA,IACL,GAAG;AAAA,IACH,KAAK;AAAA,EACP;AACF;AAUO,SAAS,mBAId,QACA,WACe;AACf,QAAM,aAAa,CAAC;AAKpB,aAAW,cAAc,OAAO,UAAU;AACxC,UAAM,mBAAmB,OAAO,OAAO,UAAU;AACjD,UAAM,qBAAqB,YAAY,UAAqB;AAG5D,UAAM,QAAsC,CAAC;AAE7C,eAAW,aAAa,OAAO,KAAK,gBAAgB,GAAG;AACrD,YAAM,kBAAkB,iBAAiB,SAAS;AAClD,YAAM,SAAS,IAAI,qBAAqB,SAAS,KAC5C,qBAAqB,eAAe;AAAA,IAC3C;AAEA,eAAW,UAAU,IAAI,EAAE,OAAO,KAAK;AAAA,EACzC;AAEA,SAAO;AACT;AAUO,IAAM,YAAY,EAAE,OAAO,EAAE,MAAM,gBAAgB,oBAAoB;AAKvE,IAAM,mBAAmB,EAAE,KAAK,CAAC,UAAU,QAAQ,CAAC;AAcpD,SAAS,mBACd,aACA;AACA,SAAO,EAAE,OAAO;AAAA,IACd,QAAQ,EAAE,OAAO;AAAA,IACjB,QAAQ,EAAE,OAAO;AAAA,IACjB,UAAU,EAAE,OAAO;AAAA,IACnB,MAAM;AAAA,IACN,OAAO,YAAY,QAAQ;AAAA,IAC3B,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;AAAA,IACpC,KAAK;AAAA,EACP,CAAC;AACH;AAKO,IAAM,eAAe,EAAE,OAAO;AAAA,EACnC,QAAQ,EAAE,OAAO;AAAA,EACjB,QAAQ,EAAE,OAAO;AAAA,EACjB,UAAU,EAAE,OAAO;AAAA,EACnB,MAAM;AAAA,EACN,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;AAAA,EACvC,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;AAAA,EACpC,KAAK;AACP,CAAC;AAKM,IAAM,oBAAoB,EAAE,OAAO;AAAA,EACxC,QAAQ,EAAE,OAAO;AAAA,EACjB,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS;AAC9C,CAAC;AAKM,SAAS,yBACdA,eACA;AACA,SAAO,EAAE,OAAO;AAAA,IACd,SAAS,EAAE,MAAMA,aAAY;AAAA,IAC7B,YAAY,EAAE,OAAO,EAAE,SAAS;AAAA,EAClC,CAAC;AACH;AAKO,IAAM,qBAAqB,yBAAyB,YAAY;AAKhE,SAAS,0BACdA,eACA;AACA,SAAO,EAAE,OAAO;AAAA,IACd,QAAQ,EAAE,OAAO;AAAA,IACjB,gBAAgB,EAAE,OAAO,EAAE,SAAS;AAAA,IACpC,SAAS,EAAE,MAAMA,aAAY;AAAA,EAC/B,CAAC;AACH;AAKO,IAAM,sBAAsB,0BAA0B,YAAY;AAKlE,IAAM,qBAAqB,EAAE,OAAO;AAAA,EACzC,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AAAA,EACvC,KAAK,UAAU,SAAS;AAC1B,CAAC;","names":["changeSchema"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rippledb/zod",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Zod schemas for runtime validation of RippleDB types",
|
|
6
6
|
"private": false,
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"README.md"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@rippledb/core": "0.
|
|
35
|
+
"@rippledb/core": "0.3.0"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
38
|
"zod": "^3.0.0"
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"typescript": "^5.9.3",
|
|
44
44
|
"vitest": "^3.2.4",
|
|
45
45
|
"zod": "^3.24.0",
|
|
46
|
-
"@rippledb/server": "0.1.
|
|
46
|
+
"@rippledb/server": "0.1.3"
|
|
47
47
|
},
|
|
48
48
|
"tsup": {
|
|
49
49
|
"entry": [
|