|
| 1 | +/** |
| 2 | + * The schematizer-effect module provides conversion utilities for Effect |
| 3 | + * Schema schemas. |
| 4 | + * @packageDocumentation |
| 5 | + * @module schematizer-effect |
| 6 | + * @since v7.1.0 |
| 7 | + */ |
| 8 | +/// schematizer-effect |
| 9 | + |
| 10 | +/** |
| 11 | + * The EffectSchematizer interface represents a schematizer specifically for |
| 12 | + * converting Effect Schema schemas into TinyBase schemas. |
| 13 | + * @category Schematizer |
| 14 | + * @since v7.1.0 |
| 15 | + */ |
| 16 | +/// EffectSchematizer |
| 17 | + |
| 18 | +/** |
| 19 | + * The toTablesSchema method converts a mapping of Effect Schema struct schemas |
| 20 | + * into a TinyBase TablesSchema. |
| 21 | + * |
| 22 | + * This method extracts basic type information (string, number, boolean), |
| 23 | + * nullable flags, and optional flags from Effect schemas. Default values are |
| 24 | + * not supported as they exist in Effect's runtime transformations, not in the |
| 25 | + * schema AST. Complex validation rules, transformations, and refinements are |
| 26 | + * ignored. |
| 27 | + * @param schemas - A mapping of table IDs to Effect Schema struct schemas. |
| 28 | + * @returns A TinyBase TablesSchema. |
| 29 | + * @example |
| 30 | + * This example converts Effect Schema schemas to TinyBase format. |
| 31 | + * |
| 32 | + * ```js |
| 33 | + * import {Boolean, Number, String, Struct} from 'effect/Schema'; |
| 34 | + * import {createStore} from 'tinybase'; |
| 35 | + * import {createEffectSchematizer} from 'tinybase/schematizers/schematizer-effect'; |
| 36 | + * |
| 37 | + * const schematizer = createEffectSchematizer(); |
| 38 | + * |
| 39 | + * const tablesSchema = schematizer.toTablesSchema({ |
| 40 | + * pets: Struct({ |
| 41 | + * species: String, |
| 42 | + * age: Number, |
| 43 | + * sold: Boolean, |
| 44 | + * }), |
| 45 | + * }); |
| 46 | + * |
| 47 | + * const store = createStore().setTablesSchema(tablesSchema); |
| 48 | + * store.setRow('pets', 'fido', {species: 'dog', age: 3, sold: false}); |
| 49 | + * console.log(store.getRow('pets', 'fido')); |
| 50 | + * // -> {species: 'dog', age: 3, sold: false} |
| 51 | + * ``` |
| 52 | + * @category Conversion |
| 53 | + * @since v7.1.0 |
| 54 | + */ |
| 55 | +/// EffectSchematizer.toTablesSchema |
| 56 | + |
| 57 | +/** |
| 58 | + * The toValuesSchema method converts a mapping of Effect Schema schemas into a |
| 59 | + * TinyBase ValuesSchema. |
| 60 | + * |
| 61 | + * This method extracts basic type information (string, number, boolean), |
| 62 | + * nullable flags, and optional flags from Effect schemas. Default values are |
| 63 | + * not supported as they exist in Effect's runtime transformations, not in the |
| 64 | + * schema AST. |
| 65 | + * @param schemas - A mapping of value IDs to Effect Schema schemas. |
| 66 | + * @returns A TinyBase ValuesSchema. |
| 67 | + * @example |
| 68 | + * This example converts Effect Schema schemas to TinyBase values. |
| 69 | + * |
| 70 | + * ```js |
| 71 | + * import {Boolean, Number} from 'effect/Schema'; |
| 72 | + * import {createStore} from 'tinybase'; |
| 73 | + * import {createEffectSchematizer} from 'tinybase/schematizers/schematizer-effect'; |
| 74 | + * |
| 75 | + * const schematizer = createEffectSchematizer(); |
| 76 | + * |
| 77 | + * const valuesSchema = schematizer.toValuesSchema({ |
| 78 | + * open: Boolean, |
| 79 | + * employees: Number, |
| 80 | + * }); |
| 81 | + * |
| 82 | + * const store = createStore().setValuesSchema(valuesSchema); |
| 83 | + * store.setValues({open: true, employees: 3}); |
| 84 | + * console.log(store.getValues()); |
| 85 | + * // -> {open: true, employees: 3} |
| 86 | + * ``` |
| 87 | + * @category Conversion |
| 88 | + * @since v7.1.0 |
| 89 | + */ |
| 90 | +/// EffectSchematizer.toValuesSchema |
| 91 | + |
| 92 | +/** |
| 93 | + * The createEffectSchematizer function creates an EffectSchematizer instance |
| 94 | + * for converting Effect Schema schemas to TinyBase schemas. |
| 95 | + * @returns A new EffectSchematizer instance. |
| 96 | + * @example |
| 97 | + * This example creates an Effect Schema schematizer. |
| 98 | + * |
| 99 | + * ```js |
| 100 | + * import {String, Struct} from 'effect/Schema'; |
| 101 | + * import {createEffectSchematizer} from 'tinybase/schematizers/schematizer-effect'; |
| 102 | + * |
| 103 | + * const schematizer = createEffectSchematizer(); |
| 104 | + * |
| 105 | + * const tablesSchema = schematizer.toTablesSchema({ |
| 106 | + * pets: Struct({ |
| 107 | + * species: String, |
| 108 | + * }), |
| 109 | + * }); |
| 110 | + * |
| 111 | + * console.log(tablesSchema); |
| 112 | + * // -> {pets: {species: {type: 'string'}}} |
| 113 | + * ``` |
| 114 | + * @category Creation |
| 115 | + * @since v7.1.0 |
| 116 | + */ |
| 117 | +/// createEffectSchematizer |
0 commit comments