Vizzuality/landgriffon

import {
  BaseEntity,
  Column,
  Entity,
  Index,
  JoinColumn,
  ManyToOne,
  OneToMany,
  PrimaryGeneratedColumn,
} from 'typeorm';
import { Indicator } from 'modules/indicators/indicator.entity';
import { MaterialToH3 } from 'modules/materials/material-to-h3.entity';
import { IndicatorRecord } from 'modules/indicator-records/indicator-record.entity';
import { ContextualLayer } from 'modules/contextual-layers/contextual-layer.entity';
import { MaterialIndicatorToH3 } from 'modules/materials/material-indicator-to-h3.entity';

/**
 * @note: Interface props are marked as 'h' and 'v' because that is what the DB returns when querying a h3 maps
 * So we avoid doing transformations within the API and let the DB handle the heavy job. This also minimizes the
 * response size sent to the frontend
 */

export interface H3IndexValueData {
  // H3 index
  h: string;
  // Values for an h3 index
  v: number;
}

export enum H3_DATA_TYPES {
  HARVEST = 'harvest_area',
  PRODUCTION = 'production',
  YIELD = 'yield',
  INDICATOR = 'indicator',
}

export enum LAYER_TYPES {
  RISK = 'risk',
  IMPACT = 'impact',
  MATERIAL = 'material',
}

@Entity('h3_data')
@Index(['h3tableName', 'h3columnName'], { unique: true })
export class H3Data extends BaseEntity {
  @PrimaryGeneratedColumn('uuid')
  id!: string;

  @Column({ type: 'varchar' })
  h3tableName!: string;

  @Column({ type: 'varchar' })
  h3columnName!: string;

  @Column({ type: 'int' })
  year!: number;

  @Column({ type: 'int' })
  h3resolution: number;

  @ManyToOne(() => Indicator, (indicator: Indicator) => indicator.id, {
    cascade: true,
    onDelete: 'CASCADE',
  })
  @JoinColumn({ name: 'indicatorId' })
  indicators: Indicator[];

  @Column({ nullable: true })
  indicatorId: string;

  @Column({ type: 'json', nullable: true })
  metadata?: JSON;

  @OneToMany(
    () => MaterialToH3,
    (materialToH3: MaterialToH3) => materialToH3.h3Data,
  )
  materialToH3s: MaterialToH3[];

  @OneToMany(() => IndicatorRecord, (ir: IndicatorRecord) => ir.materialH3Data)
  indicatorRecords: IndicatorRecord[];

  @ManyToOne(() => ContextualLayer, (cl: ContextualLayer) => cl.h3Data)
  @JoinColumn({ name: 'contextualLayerId' })
  contextualLayer: ContextualLayer;

  @Column({ nullable: true })
  contextualLayerId: string;

  @OneToMany(
    () => MaterialIndicatorToH3,
    (miToH3: MaterialIndicatorToH3) => miToH3.h3Data,
  )
  materialIndicatorToH3: MaterialIndicatorToH3[];
}