@jsonforms/angular/src/library/jsonforms-root.component.ts

Angular module of JSON Forms

/*
  The MIT License

  Copyright (c) 2017-2020 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 {
  Component,
  DoCheck,
  EventEmitter,
  Input,
  OnChanges,
  OnDestroy,
  OnInit,
  Output,
  SimpleChanges,
} from '@angular/core';
import {
  Actions,
  JsonFormsI18nState,
  JsonFormsRendererRegistryEntry,
  JsonSchema,
  Middleware,
  UISchemaElement,
  UISchemaTester,
  ValidationMode,
  defaultMiddleware,
} from '@jsonforms/core';
import type Ajv from 'ajv';
import type { ErrorObject } from 'ajv';
import { JsonFormsAngularService, USE_STATE_VALUE } from './jsonforms.service';
import { Subscription } from 'rxjs';
import { JsonFormsOutlet } from './jsonforms.component';

// TODO Can this be rewritten to not use DoCheck and OnChanges?
/* eslint-disable @angular-eslint/no-conflicting-lifecycle */
@Component({
  selector: 'jsonforms',
  template: '<jsonforms-outlet></jsonforms-outlet>',
  providers: [JsonFormsAngularService],
  imports: [JsonFormsOutlet],
})
export class JsonForms implements DoCheck, OnChanges, OnInit, OnDestroy {
  @Input() uischema: UISchemaElement;
  @Input() schema: JsonSchema;
  @Input() data: any;
  @Input() renderers: JsonFormsRendererRegistryEntry[];
  @Input() uischemas: { tester: UISchemaTester; uischema: UISchemaElement }[];
  @Output() dataChange = new EventEmitter<any>();
  @Input() readonly: boolean;
  @Input() validationMode: ValidationMode;
  @Input() ajv: Ajv;
  @Input() config: any;
  @Input() i18n: JsonFormsI18nState;
  @Input() additionalErrors: ErrorObject[];
  @Input() middleware: Middleware = defaultMiddleware;
  @Output() errors = new EventEmitter<ErrorObject[]>();

  private previousData: any;
  private previousErrors: ErrorObject[];
  subscription: Subscription;

  private initialized = false;
  oldI18N: JsonFormsI18nState;

  constructor(private jsonformsService: JsonFormsAngularService) {}

  ngOnInit(): void {
    this.jsonformsService.init(
      {
        core: {
          data: this.data,
          uischema: this.uischema,
          schema: this.schema,
          ajv: this.ajv,
          validationMode: this.validationMode,
          additionalErrors: this.additionalErrors,
        },
        uischemas: this.uischemas,
        i18n: this.i18n,
        renderers: this.renderers,
        config: this.config,
        readonly: this.readonly,
      },
      this.middleware
    );
    this.subscription = this.jsonformsService.$state.subscribe((state) => {
      const data = state?.jsonforms?.core?.data;
      const errors = state?.jsonforms?.core?.errors;
      if (this.previousData !== data) {
        this.previousData = data;
        this.dataChange.emit(data);
      }
      if (this.previousErrors !== errors) {
        this.previousErrors = errors;
        this.errors.emit(errors);
      }
    });
    this.oldI18N = this.i18n;
    this.initialized = true;
  }

  ngDoCheck(): void {
    // we can't use ngOnChanges as then nested i18n changes will not be detected
    // the update will result in a no-op when the parameters did not change
    if (
      this.oldI18N?.locale !== this.i18n?.locale ||
      this.oldI18N?.translate !== this.i18n?.translate ||
      this.oldI18N?.translateError !== this.i18n?.translateError
    ) {
      this.jsonformsService.updateI18n(
        Actions.updateI18n(
          this.oldI18N?.locale === this.i18n?.locale
            ? this.jsonformsService.getState().jsonforms.i18n.locale
            : this.i18n?.locale,
          this.oldI18N?.translate === this.i18n?.translate
            ? this.jsonformsService.getState().jsonforms.i18n.translate
            : this.i18n?.translate,
          this.oldI18N?.translateError === this.i18n?.translateError
            ? this.jsonformsService.getState().jsonforms.i18n.translateError
            : this.i18n?.translateError
        )
      );
      this.oldI18N = this.i18n;
    }
  }

  ngOnChanges(changes: SimpleChanges): void {
    if (!this.initialized) {
      return;
    }
    const newData = changes.data;
    const newSchema = changes.schema;
    const newUiSchema = changes.uischema;
    const newRenderers = changes.renderers;
    const newUischemas = changes.uischemas;
    const newI18n = changes.i18n;
    const newReadonly = changes.readonly;
    const newValidationMode = changes.validationMode;
    const newAjv = changes.ajv;
    const newConfig = changes.config;
    const newAdditionalErrors = changes.additionalErrors;

    if (
      newData ||
      newSchema ||
      newUiSchema ||
      newValidationMode ||
      newAjv ||
      newAdditionalErrors
    ) {
      this.jsonformsService.updateCoreState(
        newData ? newData.currentValue : USE_STATE_VALUE,
        newSchema ? newSchema.currentValue : USE_STATE_VALUE,
        newUiSchema ? newUiSchema.currentValue : USE_STATE_VALUE,
        newAjv ? newAjv.currentValue : USE_STATE_VALUE,
        newValidationMode ? newValidationMode.currentValue : USE_STATE_VALUE,
        newAdditionalErrors ? newAdditionalErrors.currentValue : USE_STATE_VALUE
      );
    }

    if (newRenderers && !newRenderers.isFirstChange()) {
      this.jsonformsService.setRenderers(newRenderers.currentValue);
    }

    if (newUischemas && !newUischemas.isFirstChange()) {
      this.jsonformsService.setUiSchemas(newUischemas.currentValue);
    }

    if (newI18n && !newI18n.isFirstChange()) {
      this.jsonformsService.updateI18n(
        Actions.updateI18n(
          newI18n.currentValue?.locale,
          newI18n.currentValue?.translate,
          newI18n.currentValue?.translateError
        )
      );
    }

    if (newReadonly && !newReadonly.isFirstChange()) {
      this.jsonformsService.setReadonly(newReadonly.currentValue);
    }

    if (newConfig && !newConfig.isFirstChange()) {
      this.jsonformsService.updateConfig(
        Actions.setConfig(newConfig.currentValue)
      );
    }
  }

  ngOnDestroy(): void {
    this.subscription.unsubscribe();
  }
}