feat(fieldconfig): decorator is added

src/models/common/decorators/fieldConfig/classFieldConfig.decorator.ts

@@ -0,0 +1,51 @@
+import 'reflect-metadata';
+import { getFieldConfig, IPropFieldConfigInfo } from './fieldConfig.decorator';
+
+const fieldConfigMetadataKey = Symbol('fieldconfigclass');
+type KeyValueDict = Record<string, unknown>;
+const target = {};
+
+function getFieldConfigs(object: KeyValueDict): IPropFieldConfigInfo[] {
+  const ret = [];
+  for (const prop in object) {
+    const fieldConfigMap = getFieldConfig(object, prop);
+    if (fieldConfigMap) {
+      ret.push({
+        prop: prop,
+        ...fieldConfigMap,
+      });
+    }
+  }
+  return ret;
+}
+
+function getFieldConfigClassesInfo(): IFieldConfigClassInfo[] | undefined {
+  return Reflect.getMetadata(fieldConfigMetadataKey, target) as IFieldConfigClassInfo[];
+}
+
+export interface IFieldConfigClassInfo {
+  name: string;
+  fields: IPropFieldConfigInfo[];
+}
+
+export function fieldConfigClass(): ClassDecorator {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  return <TFunction extends Function>(classCtr: TFunction): TFunction => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
+    const classInstance = new (classCtr as any)();
+    const classData: IFieldConfigClassInfo = {
+      fields: getFieldConfigs(classInstance),
+      name: classCtr.name,
+    };
+
+    const classDataList = getFieldConfigClassesInfo() ?? [];
+    classDataList.push(classData);
+    Reflect.defineMetadata(fieldConfigMetadataKey, classDataList, target);
+    return classCtr;
+  };
+}
+
+export function getFieldConfigClassInfo(className: string): IFieldConfigClassInfo {
+  const classInfos = Reflect.getMetadata(fieldConfigMetadataKey, target) as IFieldConfigClassInfo[];
+  return classInfos.find((classInfo) => classInfo.name === className) as IFieldConfigClassInfo;
+}

src/models/common/decorators/fieldConfig/fieldConfig.decorator.ts

@@ -0,0 +1,32 @@
+import 'reflect-metadata';
+import { IDescribeTsType } from '../../../layerMetadata';
+import { IFieldConfigClassInfo } from './classFieldConfig.decorator';
+
+const fieldConfigMetadataKey = Symbol('fieldconfig');
+
+export enum FieldCategory {
+  MAIN = 'MAIN',
+  GENERAL = 'GENERAL',
+  GEO_INFO = 'GEO_INFO',
+}
+
+export interface IFieldConfigInfo {
+  category: FieldCategory; // field category
+  complexType?: IDescribeTsType; // complex type subfields
+  subFields?: IFieldConfigClassInfo; // complex type subfields
+  isManuallyEditable?: boolean; // is field might be edited after creation
+  isFilterable?: boolean; // is field might participate in filter/search params
+  isSortable?: boolean; // is field might participate in sorting
+}
+
+export interface IPropFieldConfigInfo extends IFieldConfigInfo {
+  prop: string;
+}
+
+export function fieldConfig(fieldConfigInfo: IFieldConfigInfo): PropertyDecorator {
+  return Reflect.metadata(fieldConfigMetadataKey, fieldConfigInfo);
+}
+
+export function getFieldConfig<T>(target: T, propertyKey: string): IFieldConfigInfo | undefined {
+  return Reflect.getMetadata(fieldConfigMetadataKey, target, propertyKey) as IFieldConfigInfo;
+}

src/models/common/index.ts

@@ -1,6 +1,7 @@
-export * from './decorators/property/graphql.decorator';
-export * from './decorators/property/classGraphql.decorator';
+export * from '../layerMetadata/link';
+export * from './decorators/graphQL/graphql.decorator';
+export * from './decorators/graphQL/classGraphql.decorator';
 export * from './interfaces/ormCatalog.interface';
 export * from './interfaces/propCatalogDBMapping.interface';
 export * from './interfaces/propGraphQLMapping.interface';
-export * from '../layerMetadata/link';
+export * from './decorators/fieldConfig/fieldConfig.decorator';

src/models/common/interfaces/propGraphQLMapping.interface.ts

@@ -1,4 +1,4 @@
-import { IGraphQLMapping } from '../decorators/property/graphql.decorator';
+import { IGraphQLMapping } from '../decorators/graphQL/graphql.decorator';
 import { ITsTypesMapping } from '../../layerMetadata/decorators/property/tsTypes.decorator';
 
 export interface IPropGraphQLMapping extends IGraphQLMapping, ITsTypesMapping {

src/models/layerMetadata/decorators/property/tsTypes.decorator.ts

@@ -61,6 +61,11 @@ export const TsTypes: Record<string, IDescribeTsType> = {
     type: PropertiesTypes.ENUM,
     importFromPackage: '@map-colonies/mc-model-types',
   },
+  FIELDCATEGORY: {
+    value: 'FieldCategory',
+    type: PropertiesTypes.ENUM,
+    importFromPackage: '@map-colonies/mc-model-types',
+  },
 };
 /* eslint-enable @typescript-eslint/naming-convention */
 export interface ITsTypesMapping {

src/models/layerMetadata/layer3DMetadata.ts

@@ -1,5 +1,12 @@
 import { GeoJSON } from 'geojson';
-import { graphql } from '../common/decorators/property/graphql.decorator';
+import { graphql } from '../common/decorators/graphQL/graphql.decorator';
+import {
+  FieldCategory,
+  fieldConfig,
+  getFieldConfig,
+  IFieldConfigInfo,
+  IPropFieldConfigInfo,
+} from '../common/decorators/fieldConfig/fieldConfig.decorator';
 import { RecordType } from '../pycsw/coreEnums';
 import { getPyCSWMapping, IPYCSWMapping, pycsw } from './decorators/property/csw.decorator';
 import { tsTypes, TsTypes } from './decorators/property/tsTypes.decorator';
@@ -44,6 +51,9 @@ export class Layer3DMetadata implements ILayer3DMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public type: RecordType | undefined = RecordType.RECORD_3D;
 
@@ -651,6 +661,10 @@ export class Layer3DMetadata implements ILayer3DMetadata, IMetadataCommonModel {
     return getPyCSWMapping<Layer3DMetadata>(new Layer3DMetadata(), prop);
   }
 
+  public static getFieldConfig(prop: string): IFieldConfigInfo | undefined {
+    return getFieldConfig<Layer3DMetadata>(new Layer3DMetadata(), prop);
+  }
+
   public static getPyCSWMappings(): IPropPYCSWMapping[] {
     const ret = [];
     const layer = new Layer3DMetadata();
@@ -665,4 +679,19 @@ export class Layer3DMetadata implements ILayer3DMetadata, IMetadataCommonModel {
     }
     return ret;
   }
+
+  public static getFieldConfigs(): IPropFieldConfigInfo[] {
+    const ret = [];
+    const layer = new Layer3DMetadata();
+    for (const prop in layer) {
+      const fieldConfigMap = getFieldConfig<Layer3DMetadata>(layer, prop);
+      if (fieldConfigMap) {
+        ret.push({
+          prop: prop,
+          ...fieldConfigMap,
+        });
+      }
+    }
+    return ret;
+  }
 }

src/models/layerMetadata/layerMetadata.ts

@@ -1,6 +1,13 @@
 import { GeoJSON } from 'geojson';
 import { IPropCatalogDBMapping } from '../common/interfaces/propCatalogDBMapping.interface';
-import { graphql } from '../common/decorators/property/graphql.decorator';
+import { graphql } from '../common/decorators/graphQL/graphql.decorator';
+import {
+  FieldCategory,
+  fieldConfig,
+  getFieldConfig,
+  IFieldConfigInfo,
+  IPropFieldConfigInfo,
+} from '../common/decorators/fieldConfig/fieldConfig.decorator';
 import { RecordType } from '../pycsw/coreEnums';
 import { IMetadataCommonModel } from './interfaces/metadataCommonModel';
 import { getPyCSWMapping, IPYCSWMapping, pycsw } from './decorators/property/csw.decorator';
@@ -43,6 +50,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public type: RecordType | undefined = RecordType.RECORD_RASTER;
 
@@ -65,6 +75,10 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+    isManuallyEditable: true,
+  })
   //#endregion
   public classification: string | undefined = undefined;
 
@@ -86,6 +100,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
     mappingType: TsTypes.STRING,
   })
   @graphql()
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public productId: string | undefined = 'UNKNOWN';
 
@@ -107,6 +124,10 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
     mappingType: TsTypes.STRING,
   })
   @graphql()
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+    isManuallyEditable: true,
+  })
   //#endregion
   public productName: string | undefined = undefined;
 
@@ -130,6 +151,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public productVersion: string | undefined = undefined;
 
@@ -151,6 +175,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
     mappingType: TsTypes.STRING,
   })
   @graphql()
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public productType: string | undefined = undefined;
 
@@ -178,6 +205,10 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+    isManuallyEditable: true,
+  })
   //#endregion
   public description: string | undefined = undefined;
 
@@ -201,6 +232,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GEO_INFO,
+  })
   //#endregion
   public srsId: string | undefined = undefined;
 
@@ -224,6 +258,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GEO_INFO,
+  })
   //#endregion
   public srsName: string | undefined = undefined;
 
@@ -270,6 +307,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+  })
   //#endregion
   public creationDate: Date | undefined = undefined;
 
@@ -292,6 +332,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+  })
   //#endregion
   public ingestionDate: Date | undefined = undefined;
 
@@ -318,6 +361,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public updateDate: Date | undefined = undefined;
 
@@ -340,6 +386,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+  })
   //#endregion
   public sourceDateStart: Date | undefined = undefined;
 
@@ -362,6 +411,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+  })
   //#endregion
   public sourceDateEnd: Date | undefined = undefined;
 
@@ -388,6 +440,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.MAIN,
+  })
   //#endregion
   public resolution: number | undefined = undefined;
 
@@ -414,6 +469,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GEO_INFO,
+  })
   //#endregion
   public accuracyCE90: number | undefined = undefined;
 
@@ -443,6 +501,10 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+    isManuallyEditable: true,
+  })
   //#endregion
   public sensorType: SensorType[] | undefined = undefined;
 
@@ -466,6 +528,9 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
   @graphql({
     nullable: true,
   })
+  @fieldConfig({
+    category: FieldCategory.GENERAL,
+  })
   //#endregion
   public region: string | undefined = undefined;
   //#endregion
@@ -588,6 +653,10 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
     return getCatalogDBMapping<LayerMetadata>(new LayerMetadata(), prop);
   }
 
+  public static getFieldConfig(prop: string): IFieldConfigInfo | undefined {
+    return getFieldConfig<LayerMetadata>(new LayerMetadata(), prop);
+  }
+
   public static getPyCSWMappings(): IPropPYCSWMapping[] {
     const ret = [];
     const layer = new LayerMetadata();
@@ -636,4 +705,19 @@ export class LayerMetadata implements ILayerMetadata, IMetadataCommonModel {
     }
     return ret;
   }
+
+  public static getFieldConfigs(): IPropFieldConfigInfo[] {
+    const ret = [];
+    const layer = new LayerMetadata();
+    for (const prop in layer) {
+      const fieldConfigMap = getFieldConfig<LayerMetadata>(layer, prop);
+      if (fieldConfigMap) {
+        ret.push({
+          prop: prop,
+          ...fieldConfigMap,
+        });
+      }
+    }
+    return ret;
+  }
 }