@travetto/schema/src/decorator/field.ts

Data type registry for runtime validation, reflection and binding.

import { type Any, type ClassInstance, getClass } from '@travetto/runtime';

import type { SchemaFieldConfig } from '../service/types.ts';
import { SchemaRegistryIndex } from '../service/registry-index.ts';

type PropType<V> = (<T extends Partial<Record<K, V | Function>>, K extends string>(
  instance: T, property: K, idx?: TypedPropertyDescriptor<Any> | number
) => void);

function field<V>(...configs: Partial<SchemaFieldConfig>[]): PropType<V> {
  return (instance: ClassInstance, property: string): void => {
    SchemaRegistryIndex.getForRegister(getClass(instance)).registerField(property, ...configs);
  };
}

/**
 * Registering a field
 * @param type The type for the field
 * @param configs The field configuration
 * @augments `@travetto/schema:Input`
 * @augments `@travetto/schema:Field`
 * @kind decorator
 */
export function Field(type?: Pick<SchemaFieldConfig, 'type' | 'array'>, ...configs: Partial<SchemaFieldConfig>[]): PropType<unknown> {
  return field(type!, ...configs);
}

/**
 * Mark a field as writeonly
 * @augments `@travetto/schema:Input`
 * @kind decorator
 */
export function Writeonly(): PropType<unknown> { return field({ access: 'writeonly' }); }

/**
 * Mark a field as readonly
 * @augments `@travetto/schema:Input`
 * @kind decorator
 */
export function Readonly(): PropType<unknown> { return field({ access: 'readonly' }); }

/**
 * Mark a field as sensitive
 * @param active This determines if this field is sensitive or not.
 * @augments `@travetto/schema:Input`
 * @kind decorator
 */
export function Secret(active = true): PropType<unknown> { return field({ secret: active }); }