Measurementplan

src/__tests__/elbwalker.test.ts

@@ -1,5 +1,5 @@
 import Elbwalker from '../elbwalker';
-import { Hooks, IElbwalker, WebDestination, elb } from '../';
+import { Data, Hooks, IElbwalker, WebDestination, elb } from '../';
 import fs from 'fs';
 
 describe('Elbwalker', () => {
@@ -443,4 +443,21 @@ describe('Elbwalker', () => {
       }),
     );
   });
+
+  test('Contract', () => {
+    const contract: Data.Contract = {
+      version: '',
+      globals: {
+        pagegroup: {
+          type: 'string',
+          values: [2, '2', []],
+        },
+        pagetype: {},
+      },
+      context: {},
+      entities: {},
+    };
+
+    expect(contract).toBeDefined();
+  });
 });

src/types/data.d.ts

@@ -0,0 +1,58 @@
+import { Walker } from './walker';
+
+export namespace Data {
+  export interface Contract {
+    version: string;
+    globals: Globals;
+    context: Contexts;
+    entities: Entities;
+    // @TODO data as ref
+  }
+
+  interface Globals {
+    [name: string]: Global;
+  }
+
+  interface Contexts {
+    [name: string]: Context;
+  }
+
+  interface Entities {
+    [name: string]: Entity;
+  }
+
+  interface Properties {
+    [name: string]: Property;
+  }
+
+  interface Global extends Property {}
+
+  interface Context extends Property {}
+
+  interface Entity {
+    data: Properties;
+    actions: Actions;
+  }
+
+  interface Actions {
+    [name: string]: Action;
+  }
+
+  interface Action {
+    trigger?: Trigger;
+  }
+
+  type Trigger = string; // @TODO change to Walker.Trigger once updated
+
+  interface Property {
+    type?: PropertyType; // @TODO support multiple
+    required?: boolean;
+    values?: PropertyValues;
+  }
+
+  type PropertyType = 'boolean' | 'string' | 'number';
+
+  type PropertyValues = Array<Walker.Property>;
+
+  interface PropertyValue {}
+}

src/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './data';
 export * from './destinations';
 export * from './elbwalker';
 export * from './globals';