ack_json_schema_builder 1.0.0-beta.4

JSON Schema Builder converter for ACK validation library

ack_json_schema_builder

JSON Schema Builder converter for the ACK validation library.

Overview

Converts ACK schemas to json_schema_builder format via .toJsonSchemaBuilder(). Assumes familiarity with ACK and json_schema_builder.

Installation

dependencies:
  ack: ^1.0.0
  ack_json_schema_builder: ^1.0.0
  json_schema_builder: ^0.1.3

Compatibility

Requires json_schema_builder: >=0.1.3 <1.0.0 as a peer dependency. Report compatibility issues.

Limitations ⚠️

Read this first - json_schema_builder schema conversion has important constraints:

1. Custom Refinements Not Supported

Custom validation logic cannot be expressed in JSON Schema format.

// Cannot convert
final schema = Ack.string().refine((s) => s.startsWith('ACK_'));

// Validate with ACK schema instead
final result = schema.safeParse(data);

2. Default Values Not Applied

Defaults are ACK-only. Apply after parsing.

final schema = Ack.string().withDefault('default');
schema.toJsonSchemaBuilder(); // Default not included in JSON Schema

3. TransformedSchema Limitations

Transformed schemas convert the underlying schema. Metadata overrides may not be fully preserved due to json_schema_builder's immutable Schema objects.

final dateSchema = Ack.date(); // TransformedSchema
final jsonSchema = dateSchema.toJsonSchemaBuilder(); // Converts underlying string schema

Usage

import 'package:ack/ack.dart';
import 'package:ack_json_schema_builder/ack_json_schema_builder.dart';

// 1. Define schema
final userSchema = Ack.object({
  'name': Ack.string().minLength(2).maxLength(50),
  'email': Ack.string().email(),
  'age': Ack.integer().min(0).max(120).optional(),
});

// 2. Convert to json_schema_builder
final jsonSchema = userSchema.toJsonSchemaBuilder();

// 3. Use with json_schema_builder for validation
final errors = await jsonSchema.validate(data);
if (errors.isEmpty) {
  print('Data is valid!');
} else {
  print('Validation errors: $errors');
}

Schema Mapping

Supported Types

ACK Type	json_schema_builder Type	Conversion details
Ack.string()	Schema.string()	Full support with minLength/maxLength
Ack.integer()	Schema.integer()	Full support
Ack.double()	Schema.number()	Full support
Ack.boolean()	Schema.boolean()	Full support
Ack.object({...})	Schema.object()	Full support
Ack.list(...)	Schema.list()	Full support
Ack.enumString([...])	Schema.string() with enumValues	Full support
Ack.anyOf([...])	Schema.combined(anyOf: ...)	Full support
Ack.any()	Schema.combined(anyOf: ...)	Expands to union of all types

Supported Constraints

ACK Constraint	json_schema_builder	Notes
.minLength() / .maxLength()	minLength / maxLength	String and array support
.min() / .max()	minimum / maximum	Numeric bounds
.email() / .uuid() / .url()	format	Format hints
.optional()	Excluded from required	Optional fields
.describe()	description	Descriptions
.unique()	uniqueItems	Array uniqueness

Testing

cd packages/ack_json_schema_builder
dart test

Contributing

For contribution guidelines, see CONTRIBUTING.md in the root repository.

License

This package is part of the ACK monorepo.

Related Packages

• ack - Core validation library
• ack_firebase_ai - Firebase AI converter
• json_schema_builder - JSON Schema builder