feat!: add graphql class decorators (#58)

* feat: add graphql class decorators

* fix: linting, prettier

* feat: add enum support

* fix: linting, prettier

* feat: new ts types

* fix: lint for naming convention

src/models/common/decorators/property/classGraphql.decorator.ts

@@ -0,0 +1,50 @@
+import 'reflect-metadata';
+import { getTsTypesMapping } from '../../../layerMetadata/decorators/property/tsTypes.decorator';
+import { IPropGraphQLMapping } from '../../interfaces/propGraphQLMapping.interface';
+import { getGraphQLMapping } from './graphql.decorator';
+
+const graphQLMetadataKey = Symbol('graphqlclassmapping');
+type KeyValueDict = Record<string, unknown>;
+const target = {};
+
+export interface IGraphQLClassMapping {
+  name: string;
+  fields: IPropGraphQLMapping[];
+}
+
+export function graphqlClass(): ClassDecorator {
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  return <TFunction extends Function>(graphqlmapping: TFunction) => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
+    const classInstance = new (graphqlmapping as any)();
+    const classData: IGraphQLClassMapping = {
+      fields: getGraphQLMappings(classInstance),
+      name: graphqlmapping.name,
+    };
+
+    const classDataList = getGraphQLClassMapping() ?? [];
+    classDataList.push(classData);
+    Reflect.defineMetadata(graphQLMetadataKey, classDataList, target);
+    return graphqlmapping;
+  };
+}
+
+export function getGraphQLClassMapping(): IGraphQLClassMapping[] | undefined {
+  return Reflect.getMetadata(graphQLMetadataKey, target) as IGraphQLClassMapping[];
+}
+
+export function getGraphQLMappings(object: KeyValueDict): IPropGraphQLMapping[] {
+  const ret = [];
+  for (const prop in object) {
+    const graphQLMap = getGraphQLMapping(object, prop);
+    const tsTypesMap = getTsTypesMapping(object, prop);
+    if (graphQLMap && tsTypesMap) {
+      ret.push({
+        prop: prop,
+        ...graphQLMap,
+        ...tsTypesMap,
+      });
+    }
+  }
+  return ret;
+}

src/models/common/decorators/property/graphql.decorator.ts

@@ -0,0 +1,16 @@
+import 'reflect-metadata';
+
+const graphQLMetadataKey = Symbol('graphqlmapping');
+
+export interface IGraphQLMapping {
+  nullable?: boolean;
+}
+
+export function graphql(graphqlmapping?: IGraphQLMapping): PropertyDecorator {
+  const defaultMapping: IGraphQLMapping = { nullable: false };
+  return Reflect.metadata(graphQLMetadataKey, graphqlmapping ?? defaultMapping);
+}
+
+export function getGraphQLMapping<T>(target: T, propertyKey: string): IGraphQLMapping | undefined {
+  return Reflect.getMetadata(graphQLMetadataKey, target, propertyKey) as IGraphQLMapping;
+}

src/models/common/index.ts

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

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

@@ -0,0 +1,6 @@
+import { IGraphQLMapping } from '../decorators/property/graphql.decorator';
+import { ITsTypesMapping } from '../../layerMetadata/decorators/property/tsTypes.decorator';
+
+export interface IPropGraphQLMapping extends IGraphQLMapping, ITsTypesMapping {
+  prop: string;
+}

src/models/index.ts

@@ -1,3 +1,4 @@
+export * from './common/index';
 export * from './layerMetadata/index';
 export * from './discreteIngestion/index';
 export * from './layerMetadata/pycswLayerCatalogRecord';

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

@@ -1,5 +1,5 @@
 import 'reflect-metadata';
-import { TsTypes } from './tsTypes.decorator';
+import { IDescribeTsType } from './tsTypes.decorator';
 
 const catalogDbMetadataKey = Symbol('catalogdbmapping');
 
@@ -15,7 +15,7 @@ export interface IColumnProps {
 }
 
 export interface IFieldProps {
-  overrideType?: TsTypes;
+  overrideType?: IDescribeTsType;
 }
 
 export interface ICatalogDBMapping {

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

@@ -2,18 +2,58 @@ import 'reflect-metadata';
 
 const tsTypesMetadataKey = Symbol('catalogdbmapping');
 
-export enum TsTypes {
-  STRING = 'string',
-  BOOLEAN = 'boolean',
-  DATE = 'Date',
-  NUMBER = 'number',
+export enum PropertiesTypes {
+  PRIMITIVE = 'primitive',
+  ENUM = 'enum',
+  CLASS = 'class',
+  ARRAY = 'array',
   OBJECT = 'object',
-  LINK = 'Link',
-  LINKS = 'Link[]',
+}
+export interface IDescribeTsType {
+  value: string;
+  type: PropertiesTypes;
+  importFromPackage?: string;
 }
 
+/* eslint-disable @typescript-eslint/naming-convention */
+export const TsTypes: Record<string, IDescribeTsType> = {
+  STRING: {
+    value: 'string',
+    type: PropertiesTypes.PRIMITIVE,
+  },
+  BOOLEAN: {
+    value: 'boolean',
+    type: PropertiesTypes.PRIMITIVE,
+  },
+  DATE: {
+    value: 'Date',
+    type: PropertiesTypes.PRIMITIVE,
+  },
+  NUMBER: {
+    value: 'number',
+    type: PropertiesTypes.PRIMITIVE,
+  },
+  OBJECT: {
+    value: 'object',
+    type: PropertiesTypes.OBJECT,
+  },
+  LINK: {
+    value: 'Link',
+    type: PropertiesTypes.CLASS,
+  },
+  LINKS: {
+    value: 'Link',
+    type: PropertiesTypes.ARRAY,
+  },
+  SENSORTYPE: {
+    value: 'SensorType',
+    type: PropertiesTypes.ENUM,
+    importFromPackage: '@map-colonies/mc-model-types',
+  },
+};
+/* eslint-enable @typescript-eslint/naming-convention */
 export interface ITsTypesMapping {
-  mappingType: TsTypes;
+  mappingType: IDescribeTsType;
 }
 
 export function tsTypes(tsTypesMapping: ITsTypesMapping): PropertyDecorator {

src/models/layerMetadata/index.ts

@@ -2,7 +2,7 @@ export * from './layerMetadata';
 export * from './layerMetadata-StatusFields';
 
 export { IShpMapping, ShapeFileType } from './decorators/property/shp.decorator';
-export { TsTypes } from './decorators/property/tsTypes.decorator';
+export { TsTypes, IDescribeTsType, PropertiesTypes } from './decorators/property/tsTypes.decorator';
 export { IPYCSWMapping } from './decorators/property/csw.decorator';
 export { IColumnProps } from './decorators/property/catalogDB.decorator';
 export { IOrmCatalog } from '../common/interfaces/ormCatalog.interface';

src/models/layerMetadata/layerMetadata.ts

@@ -1,5 +1,6 @@
 import { GeoJSON } from 'geojson';
 import { IPropCatalogDBMapping } from '../common/interfaces/propCatalogDBMapping.interface';
+import { graphql } from '../common/decorators/property/graphql.decorator';
 import { getPyCSWMapping, IPYCSWMapping, pycsw } from './decorators/property/csw.decorator';
 import { getShpMapping, IShpMapping, ShapeFileType, shpMapping } from './decorators/property/shp.decorator';
 import { getCatalogDBMapping, ICatalogDBMapping, catalogDB } from './decorators/property/catalogDB.decorator';
@@ -58,6 +59,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public source?: string = undefined;
 
   /**
@@ -82,6 +86,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public sourceName?: string = undefined;
 
   /**
@@ -106,6 +113,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.DATE,
   })
+  @graphql({
+    nullable: true,
+  })
   public updateDate?: Date = undefined;
 
   /**
@@ -130,6 +140,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.NUMBER,
   })
+  @graphql({
+    nullable: true,
+  })
   public resolution?: number = undefined;
 
   /**
@@ -155,6 +168,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.NUMBER,
   })
+  @graphql({
+    nullable: true,
+  })
   public ep90?: number = undefined;
 
   /**
@@ -177,7 +193,10 @@ export class LayerMetadata implements ILayerMetadata {
     valuePath: 'features[0].properties.SensorType',
   })
   @tsTypes({
-    mappingType: TsTypes.STRING,
+    mappingType: TsTypes.SENSORTYPE,
+  })
+  @graphql({
+    nullable: true,
   })
   public sensorType?: SensorType = undefined;
 
@@ -204,6 +223,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.NUMBER,
   })
+  @graphql({
+    nullable: true,
+  })
   public rms?: number = undefined;
 
   /**
@@ -229,6 +251,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public scale?: string = undefined;
 
   /**
@@ -254,6 +279,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public dsc?: string = undefined;
 
   /**
@@ -279,6 +307,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.OBJECT,
   })
+  @graphql({
+    nullable: true,
+  })
   public geometry?: GeoJSON = undefined;
 
   /**
@@ -300,6 +331,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public id?: string = undefined;
 
   /**
@@ -321,6 +355,9 @@ export class LayerMetadata implements ILayerMetadata {
   @tsTypes({
     mappingType: TsTypes.STRING,
   })
+  @graphql({
+    nullable: true,
+  })
   public version?: string = undefined;
 
   public static getPyCSWMapping(prop: string): IPYCSWMapping | undefined {

src/models/layerMetadata/link.ts

@@ -0,0 +1,34 @@
+import { graphqlClass } from '../common/decorators/property/classGraphql.decorator';
+import { graphql } from '../common/decorators/property/graphql.decorator';
+import { TsTypes, tsTypes } from './decorators/property/tsTypes.decorator';
+
+@graphqlClass()
+export class Link {
+  @tsTypes({
+    mappingType: TsTypes.STRING,
+  })
+  @graphql({
+    nullable: true,
+  })
+  public name?: string = undefined;
+
+  @tsTypes({
+    mappingType: TsTypes.STRING,
+  })
+  @graphql({
+    nullable: true,
+  })
+  public description?: string = undefined;
+
+  @tsTypes({
+    mappingType: TsTypes.STRING,
+  })
+  @graphql()
+  public protocol?: string = undefined;
+
+  @tsTypes({
+    mappingType: TsTypes.STRING,
+  })
+  @graphql()
+  public url?: string = undefined;
+}