convert to Typescript grapqlProtocol files ; fix /add engine types

chriskalmar · Apr 3, 2020 · 2195720 · 2195720
1 parent fe28172
commit 2195720
Show file tree

Hide file tree

Showing 37 changed files with 383 additions and 269 deletions.
diff --git a/src/engine/attribute/Attribute.ts b/src/engine/attribute/Attribute.ts
@@ -115,7 +115,8 @@ export type Attribute = AttributeBase & {
   /**
    * name of the attribute
    */
-  name: string;
+  // name: string;
+  name?: string;
 
   /**
    * map of target attributes when referencing another entity

diff --git a/src/engine/configuration/Configuration.ts b/src/engine/configuration/Configuration.ts
@@ -49,7 +49,7 @@ export class Configuration {
     }
   }
 
-  setLanguages(languages): void {
+  setLanguages(languages: string[]): void {
     passOrThrow(
       isArray(languages, true),
       () => 'Configuration.setLanguages() expects a list of language iso codes',
@@ -79,7 +79,7 @@ export class Configuration {
     return this.getLanguages()[0];
   }
 
-  setSchema(schema): void {
+  setSchema(schema: Schema): void {
     passOrThrow(isSchema(schema), () => 'Configuration expects a valid schema');
 
     this.schema = schema;
@@ -91,7 +91,7 @@ export class Configuration {
     return this.schema;
   }
 
-  setProtocolConfiguration(protocolConfiguration): void {
+  setProtocolConfiguration(protocolConfiguration: ProtocolConfiguration): void {
     passOrThrow(
       isProtocolConfiguration(protocolConfiguration),
       () => 'Configuration expects a valid protocolConfiguration',
@@ -111,7 +111,7 @@ export class Configuration {
     return this.protocolConfiguration;
   }
 
-  setStorageConfiguration(storageConfiguration): void {
+  setStorageConfiguration(storageConfiguration: StorageConfiguration): void {
     passOrThrow(
       isStorageConfiguration(storageConfiguration),
       () => 'Configuration expects a valid storageConfiguration',

diff --git a/src/engine/cursor.spec.ts b/src/engine/cursor.spec.ts
@@ -35,15 +35,15 @@ describe('cursor', () => {
       indexes: [
         new Index({
           type: INDEX_UNIQUE,
-          attributes: [ 'loginName' ],
+          attributes: ['loginName'],
         }),
         new Index({
           type: INDEX_UNIQUE,
-          attributes: [ 'firstName', 'lastName' ],
+          attributes: ['firstName', 'lastName'],
         }),
         new Index({
           type: INDEX_UNIQUE,
-          attributes: [ 'email' ],
+          attributes: ['email'],
         }),
       ],
     });
@@ -58,23 +58,23 @@ describe('cursor', () => {
 
     it('should throw if incompatible cursor provided', () => {
       function fn() {
-        processCursor(<Entity>{}, { a: <any>'b' });
+        processCursor({} as Entity, { a: 'b' as any });
       }
 
       expect(fn).toThrowErrorMatchingSnapshot();
     });
 
     it('should throw if cursor is malformed', () => {
       function fn1() {
-        processCursor(SomeEntity, { SomeEntity: [ <any>'b' ] }, []);
+        processCursor(SomeEntity, { SomeEntity: ['b' as any] }, []);
       }
 
       function fn2() {
-        processCursor(SomeEntity, { SomeEntity: [ <any>[ {}, {}, {} ] ] }, []);
+        processCursor(SomeEntity, { SomeEntity: [[{}, {}, {}] as any] }, []);
       }
 
       function fn3() {
-        processCursor(SomeEntity, { SomeEntity: [ <any>{} ] }, []);
+        processCursor(SomeEntity, { SomeEntity: [{} as any] }, []);
       }
 
       expect(fn1).toThrowErrorMatchingSnapshot();
@@ -87,7 +87,7 @@ describe('cursor', () => {
         processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'iDontKnow', 123 ] ],
+            SomeEntity: [['iDontKnow', 123]],
           },
           [],
         );
@@ -99,15 +99,15 @@ describe('cursor', () => {
     it('should throw if an attribute is used which the data set is not sorted by', () => {
       function fn1() {
         processCursor(SomeEntity, {
-          SomeEntity: [ [ 'loginName', 123 ] ],
+          SomeEntity: [['loginName', 123]],
         });
       }
 
       function fn2() {
         processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'loginName', 123 ] ],
+            SomeEntity: [['loginName', 123]],
           },
           [
             {
@@ -122,7 +122,10 @@ describe('cursor', () => {
         processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'loginName', 123 ], [ 'email', 123 ] ],
+            SomeEntity: [
+              ['loginName', 123],
+              ['email', 123],
+            ],
           },
           [
             {
@@ -143,7 +146,7 @@ describe('cursor', () => {
         processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'firstName', 'John' ] ],
+            SomeEntity: [['firstName', 'John']],
           },
           [
             {
@@ -158,7 +161,10 @@ describe('cursor', () => {
         processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'firstName', 'John' ], [ 'lastName', 'Snow' ] ],
+            SomeEntity: [
+              ['firstName', 'John'],
+              ['lastName', 'Snow'],
+            ],
           },
           [
             {
@@ -182,7 +188,7 @@ describe('cursor', () => {
         const cursor1 = processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'loginName', 'user1' ] ],
+            SomeEntity: [['loginName', 'user1']],
           },
           [
             {
@@ -201,7 +207,7 @@ describe('cursor', () => {
         const cursor2 = processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'loginName', 123 ] ],
+            SomeEntity: [['loginName', 123]],
           },
           [
             {
@@ -221,8 +227,8 @@ describe('cursor', () => {
           SomeEntity,
           {
             SomeEntity: [
-              [ 'loginName', 'user1' ],
-              [ 'email', 'user1@example.com' ],
+              ['loginName', 'user1'],
+              ['email', 'user1@example.com'],
             ],
           },
           [
@@ -250,7 +256,10 @@ describe('cursor', () => {
 
       it('when using attributes that are not all defined as unique', () => {
         const row1: CursorType = {
-          SomeEntity: [ [ 'firstName', 'John' ], [ 'id', 1123 ] ],
+          SomeEntity: [
+            ['firstName', 'John'],
+            ['id', 1123],
+          ],
         };
 
         const cursor1 = processCursor(SomeEntity, row1, [
@@ -347,9 +356,9 @@ describe('cursor', () => {
 
         const row2: CursorType = {
           SomeEntity: [
-            [ 'firstName', 'John' ],
-            [ 'lastName', 'Snow' ],
-            [ 'id', 1123 ],
+            ['firstName', 'John'],
+            ['lastName', 'Snow'],
+            ['id', 1123],
           ],
         };
 
@@ -409,10 +418,10 @@ describe('cursor', () => {
 
         const row3: CursorType = {
           SomeEntity: [
-            [ 'firstName', 'John' ],
-            [ 'email', 'john@example.com' ],
-            [ 'lastName', 'Snow' ],
-            [ 'id', 1123 ],
+            ['firstName', 'John'],
+            ['email', 'john@example.com'],
+            ['lastName', 'Snow'],
+            ['id', 1123],
           ],
         };
 
@@ -460,7 +469,7 @@ describe('cursor', () => {
         const cursor0 = processCursor(
           SomeEntity,
           {
-            SomeEntity: [ [ 'loginName', 123 ] ],
+            SomeEntity: [['loginName', 123]],
           },
           [
             {
@@ -478,7 +487,10 @@ describe('cursor', () => {
         };
 
         const row1: CursorType = {
-          SomeEntity: [ [ 'firstName', 'John' ], [ 'id', 1123 ] ],
+          SomeEntity: [
+            ['firstName', 'John'],
+            ['id', 1123],
+          ],
         };
 
         const cursor1 = processCursor(
@@ -595,9 +607,9 @@ describe('cursor', () => {
 
         const row2: CursorType = {
           SomeEntity: [
-            [ 'firstName', 'John' ],
-            [ 'lastName', 'Snow' ],
-            [ 'id', 1123 ],
+            ['firstName', 'John'],
+            ['lastName', 'Snow'],
+            ['id', 1123],
           ],
         };
 
@@ -667,10 +679,10 @@ describe('cursor', () => {
 
         const row3: CursorType = {
           SomeEntity: [
-            [ 'firstName', 'John' ],
-            [ 'email', 'john@example.com' ],
-            [ 'lastName', 'Snow' ],
-            [ 'id', 1123 ],
+            ['firstName', 'John'],
+            ['email', 'john@example.com'],
+            ['lastName', 'Snow'],
+            ['id', 1123],
           ],
         };
 

diff --git a/src/engine/datatype/DataType.spec.ts b/src/engine/datatype/DataType.spec.ts
@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-empty-function */
+
 import { DataType, DataTypeSetup, isDataType } from './DataType';
 
 import { passOrThrow } from '../util';
@@ -16,9 +18,9 @@ describe('DataType', () => {
   it('should have a description', () => {
     function fn() {
       // eslint-disable-next-line no-new
-      new DataType(<DataTypeSetup>{
+      new DataType({
         name: 'example',
-      });
+      } as DataTypeSetup);
     }
 
     expect(fn).toThrowErrorMatchingSnapshot();

diff --git a/src/engine/datatype/DataType.ts b/src/engine/datatype/DataType.ts
@@ -2,8 +2,8 @@ import { passOrThrow, isFunction } from '../util';
 import { ComplexDataType } from './ComplexDataType';
 
 export type DataTypeSetup = {
-  name: string;
-  description: string;
+  name?: string;
+  description?: string;
   mock?: () => any;
   validate?: () => any;
   enforceRequired?: boolean;