From b1cbfacafd0a71fb78903857b800b3ec54e63d08 Mon Sep 17 00:00:00 2001 From: Volodymyr Zakhovaiko Date: Fri, 25 Oct 2024 15:43:18 +0200 Subject: [PATCH] Fixed error with missing component --- packages/docs/astro.config.mjs | 2 +- .../under-the-hood/uth-bridge-concept.mdx | 159 +++++++++++++++++- 2 files changed, 153 insertions(+), 8 deletions(-) diff --git a/packages/docs/astro.config.mjs b/packages/docs/astro.config.mjs index 7a730a04c..0412db8d6 100644 --- a/packages/docs/astro.config.mjs +++ b/packages/docs/astro.config.mjs @@ -42,7 +42,7 @@ export default defineConfig({ }, { label: 'Compare matrix', - autogenerate: { directory: 'compare-matrix' }, + link: '/compare-matrix-landing', }, ], }), diff --git a/packages/docs/src/content/docs/under-the-hood/uth-bridge-concept.mdx b/packages/docs/src/content/docs/under-the-hood/uth-bridge-concept.mdx index f1f121328..428839563 100644 --- a/packages/docs/src/content/docs/under-the-hood/uth-bridge-concept.mdx +++ b/packages/docs/src/content/docs/under-the-hood/uth-bridge-concept.mdx @@ -3,12 +3,157 @@ id: 'uth-bridge-concept' title: 'Bridge concept' --- -import { CodeSection } from '../website/components/CodeSection'; - To make use of any schema, uniforms have to create a _bridge_ of it - a unified schema mapper. The `Bridge` class is an abstract class, which should be extended to create custom bridges. It implements all of the required methods and throws an error with meaningful "method not implemented" error. - +```tsx +export abstract class Bridge { + // Each bridge can have a different set of parameters. + constructor(...args: any[]) { + invariant( + this.constructor !== Bridge, + 'Bridge cannot be instantiated (args=%o).', + { args }, + ); + } + + /** + * Get an error for field `name` out of `error`. There is no standarized + * format, but fields treat truthy values as a sign of being invalid. Fields + * receive this as a `error` guaranteed prop. + */ + getError(name: string, error: unknown): unknown { + return invariant( + false, + '%s have not implemented `getError` method (args=%o).', + this.constructor.name, + { name, error }, + ); + } + + /** + * Get an error message for field `name` out of `error`. If there is no error, + * return an empty string. Fields receive this as a `errorMessage` guaranteed + * prop. + */ + getErrorMessage(name: string, error: unknown): string { + return invariant( + false, + '%s have not implemented `getErrorMessage` method (args=%o).', + this.constructor.name, + { name, error }, + ); + } + + /** + * Get all error messages from `error`. Only `ErrorsField` make use of that + * (in builtin themes). + */ + getErrorMessages(error: unknown): string[] { + return invariant( + false, + '%s have not implemented `getErrorMessages` method (args=%o).', + this.constructor.name, + { error }, + ); + } + + /** + * Get internal field definition for field `name`. Fields receive this as a + * `field` guaranteed prop. There is no standarized field format. Most bridges + * use it as a common object, used in calculation of initial values, props, + * and types. + */ + getField(name: string): unknown { + return invariant( + false, + '%s have not implemented `getField` method (args=%o).', + this.constructor.name, + { name }, + ); + } + + /** + * Get initial value of field `name`. It is used as a default when no value is + * set (e.g. the form is rendered with an empty `model`). Additionally, + * `props` are this field instance props. If a field is rendered multiple + * times, this function will be called multiple times, possibly with different + * `props`. + */ + getInitialValue(name: string): unknown { + return invariant( + false, + '%s have not implemented `getInitialValue` method (args=%o).', + this.constructor.name, + { name }, + ); + } + + /** + * Get initial model value recursively. + */ + getInitialModel(): UnknownObject { + const initialModel: UnknownObject = {}; + const subFields = this.getSubfields(); + for (const fieldName of subFields) { + const initialValue = this.getInitialValue(fieldName); + set(initialModel, fieldName, initialValue); + } + return initialModel; + } + + /** + * Get props defined in schema for a field `name`. There are no required nor + * banned fields, however properties like `required` are often available. + */ + getProps(name: string): UnknownObject { + return invariant( + false, + '%s have not implemented `getProps` method (args=%o).', + this.constructor.name, + { name }, + ); + } + + /** + * Get a list of subfields of field `name` or top-level fields, if no `name` + * is passed. + */ + getSubfields(name?: string): string[] { + return invariant( + false, + '%s have not implemented `getSubfields` method (args=%o).', + this.constructor.name, + { name }, + ); + } + + /** + * There is no standarized field type format. However, `AutoField` component + * will work correctly only with standard JavaScript constructors, like + * `String` or `Number`. + */ + getType(name: string): unknown { + return invariant( + false, + '%s have not implemented `getType` method (args=%o).', + this.constructor.name, + { name }, + ); + } + + /** + * Get a validator function. The `options` here are from the `validator` prop + * of the form. A validator function receives a model and returns an error or + * a promise that will resolve (not reject!) with an error. If there is no + * error, return (or resolve with) a `null` value instead. + */ + getValidator(options?: unknown): (model: UnknownObject) => unknown { + return invariant( + false, + '%s have not implemented `getValidator` method (args=%o).', + this.constructor.name, + { options }, + ); + } +} +```