@jsonforms/core/src/store/store.ts

Core module of JSON Forms

/*
  The MIT License
  
  Copyright (c) 2017-2019 EclipseSource Munich
  https://github.com/eclipsesource/jsonforms
  
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
  
  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
*/

import type { Store } from './type';
import { RankedTester, UISchemaTester } from '../testers';
import { JsonSchema, UISchemaElement } from '../models';
import type Ajv from 'ajv';
import type { ErrorObject, ValidateFunction } from 'ajv';
import { JsonFormsI18nState } from './i18nTypes';

/**
 * JSONForms store.
 */
export interface JsonFormsStore extends Store<JsonFormsState> {}

/**
 * The state shape of JSONForms.
 */
export interface JsonFormsState {
  /**
   * Represents JSONForm's sub-state.
   */
  jsonforms: JsonFormsSubStates;
}

export interface JsonFormsSubStates {
  /**
   * Substate for storing mandatory sub-state.
   */
  core?: JsonFormsCore;
  /**
   * Global configuration options.
   */
  config?: any;
  /**
   * All available renderers.
   */
  renderers?: JsonFormsRendererRegistryEntry[];
  /**
   * All available cell renderers.
   */
  cells?: JsonFormsCellRendererRegistryEntry[];
  /**
   * I18n settings.
   */
  i18n?: JsonFormsI18nState;
  /**
   * The UI schema registry used in detail renderers.
   */
  uischemas?: JsonFormsUISchemaRegistryEntry[];
  /**
   * If true, sets all controls to read-only.
   */
  readonly?: boolean;
  // allow additional state
  [additionalState: string]: any;
}

export type ValidationMode =
  | 'ValidateAndShow'
  | 'ValidateAndHide'
  | 'NoValidation';

export interface JsonFormsCore {
  data: any;
  schema: JsonSchema;
  uischema: UISchemaElement;
  errors?: ErrorObject[];
  additionalErrors?: ErrorObject[];
  validator?: ValidateFunction;
  ajv?: Ajv;
  validationMode?: ValidationMode;
}

export interface JsonFormsRendererRegistryEntry {
  tester: RankedTester;
  renderer: any;
}

export interface JsonFormsUISchemaRegistryEntry {
  tester: UISchemaTester;
  uischema: UISchemaElement;
}

export interface JsonFormsCellRendererRegistryEntry {
  tester: RankedTester;
  cell: any;
}

export interface JsonFormsExtendedState<T> extends JsonFormsState {
  jsonforms: {
    [subState: string]: T;
  };
}