fix: shared types, duplicated types

ydennisy · ydennisy · commit 2436e42c5091 · 2020-06-22T19:12:27.000+01:00
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ydennisy
+Copyright (c) 2020 AirGrid LTD
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@
 EdgeKit.org -> https://projects.invisionapp.com/share/2NXLNZYG64X#/screens/421377757
 
 ## Features:
+
 > (this needs some sections....)
 
 - Packaged with a taxonomy of [IAB Data Transparency Framework](https://iabtechlab.com/standards/data-transparency/) audiences.
@@ -23,18 +24,21 @@ EdgeKit.org -> https://projects.invisionapp.com/share/2NXLNZYG64X#/screens/42137
 ### Install
 
 First we install EdgeKit into our project.
+
 ```shell
 $ npm i -S @AirGrid/EdgeKit
 ```
 
 We can now import the API into our script.
+
 ```javascript
 import edkt from '@AirGrid/EdgeKit';
 ```
 
 Alternatively to get started quickly, we can use unpkg to load the `edkt` object into the `window`.
+
 ```html
-<Todo>
+<Todo></Todo>
 ```
 
 ### Page Features
@@ -47,10 +51,10 @@ A simple example would be to collect the keywords often present in the meta tags
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta http-equiv="X-UA-Compatible" content="ie=edge">
-    <meta name="keywords" content="sport,news,football,stadium">
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
+    <meta name="keywords" content="sport,news,football,stadium" />
     <title>Article about sports, news and football!</title>
   </head>
   <body>
@@ -69,28 +73,32 @@ const getPageKeywords = {
     const keywordString = tag.getAttribute('content');
     const keywords = keywordString.toLowerCase().split(',');
     return Promise.resolve(keywords);
-  }
-}
+  },
+};
 ```
 
 ### Init
 
 Now we can initialise and run the library passing in `pageFeatureGetters`, which will:
+
 1. Collect and store all the features which correspond to this page view event (current page).
 2. Evaluate all the audience model definitions, to see if the user can be added into any new `elegibleAudiences`.
 3. Pass this information to Prebid, for any subsequent ad calls on the same page.
 
 ```javascript
 edkt.init({
-  pageFeatureGetters: pageFeatureGetters
+  pageFeatureGetters: pageFeatureGetters,
 });
 ```
 
 ### Prebid
+
 > this makes sense to be last in the readme, but it must occur first in the actual page code.
 
 Now we can use EdgeKit to grab and pass audience IDs, from the device into Prebid for downstream targeting. This must happen early in the execution of the page before Prebid makes bid requests to adapters.
 
+> todo: we need to add links to the prebid docs here to explain the below object.
+
 ```javascript
 const edktAudienceIds = edkt.getElegibleAudienceIds();
 
@@ -104,10 +112,10 @@ pbjs.que.push(() => {
         user: {
           data: {
             user: edktAudienceIds,
-          }
-        }
-      }
-    }
+          },
+        },
+      },
+    },
   });
 });
 ```
diff --git a/package.json b/package.json
@@ -3,6 +3,7 @@
   "private": true,
   "scripts": {
     "build": "tsc -b packages",
+    "watch": "tsc -w packages",
     "lint": "eslint packages/**/src packages/**/__test__ --ext js,ts",
     "lint:fix": "eslint packages/**/src packages/**/__test__ --ext js,ts --fix"
   },
diff --git a/packages/audiences/package.json b/packages/audiences/package.json
@@ -9,6 +9,9 @@
   },
   "author": "ydennisy",
   "license": "MIT",
+  "dependencies": {
+    "@edgekit/types": "^0.0.1"
+  },
   "devDependencies": {
     "typescript": "^3.9.5"
   }
diff --git a/packages/audiences/src/definitions/interest/sport.ts b/packages/audiences/src/definitions/interest/sport.ts
@@ -1,4 +1,6 @@
-const condition = {
+import { ICondition } from '@edgekit/types';
+
+const condition: ICondition = {
   filter: {
     queries: [
       {
@@ -10,10 +12,10 @@ const condition = {
   rules: [
     {
       reducer: {
-        name: 'count' as const,
+        name: 'count',
       },
       matcher: {
-        name: 'gt' as const,
+        name: 'gt',
         args: 1,
       },
     },
diff --git a/packages/audiences/src/definitions/interest/travel.ts b/packages/audiences/src/definitions/interest/travel.ts
@@ -1,4 +1,6 @@
-const condition = {
+import { ICondition } from '@edgekit/types';
+
+const condition: ICondition = {
   filter: {
     queries: [
       {
@@ -10,10 +12,10 @@ const condition = {
   rules: [
     {
       reducer: {
-        name: 'count' as const,
+        name: 'count',
       },
       matcher: {
-        name: 'gt' as const,
+        name: 'gt',
         args: 2,
       },
     },
diff --git a/packages/core/src/features/index.ts b/packages/core/src/features/index.ts
@@ -1,8 +1,4 @@
-// TODO: this is duplicated - move into types.
-interface IPageFeatureGetter {
-  name: string;
-  func: () => Promise<string[]>;
-}
+import { IPageFeatureGetter } from '../types';
 
 const wrapPageFeatureGetters = (pageFeatureGetters: IPageFeatureGetter[]) => {
   return pageFeatureGetters.map((getter) => {
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -3,16 +3,12 @@ import audiences from '@edgekit/audiences';
 import { getPageFeatures } from './features';
 import { viewStore, audienceStore } from './store';
 import { timeStampInSecs } from './utils';
+import { IPageFeatureGetter } from './types';
 
 interface IConfig {
   pageFeatureGetters: IPageFeatureGetter[];
 }
 
-interface IPageFeatureGetter {
-  name: string;
-  func: () => Promise<string[]>;
-}
-
 // TODO: we need to give a way to consumers to ensure this does not
 // run multiple times on a single page load.
 const run = async (config: IConfig): Promise<void> => {
diff --git a/packages/core/src/store/audience.ts b/packages/core/src/store/audience.ts
@@ -1,10 +1,5 @@
 import { storage, timeStampInSecs } from '../utils';
-
-enum StorageKeys {
-  PAGE_VIEWS = 'edkt_page_views',
-  MATCHED_AUDIENCES = 'edkt_matched_audiences',
-  MATCHED_AUDIENCE_IDS = 'edkt_matched_audience_ids',
-}
+import { StorageKeys } from '../types';
 
 interface IMatchedAudience {
   id: string;
@@ -13,7 +8,6 @@ interface IMatchedAudience {
   matchedOnCurrentPageView: boolean;
 }
 
-// TODO: share the types.
 class AudienceStore {
   matchedAudiences: IMatchedAudience[];
   matchedAudienceIds: string[];
diff --git a/packages/core/src/store/pageview.ts b/packages/core/src/store/pageview.ts
@@ -1,11 +1,6 @@
 import { IPageView } from '@edgekit/types';
 import { storage, timeStampInSecs } from '../utils';
-
-enum StorageKeys {
-  PAGE_VIEWS = 'edkt_page_views',
-  MATCHED_AUDIENCES = 'edkt_matched_audiences',
-  MATCHED_AUDIENCE_IDS = 'edkt_matched_audience_ids',
-}
+import { StorageKeys } from '../types';
 
 interface IPageFeature {
   name: string;
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -0,0 +1,10 @@
+export interface IPageFeatureGetter {
+  name: string;
+  func: () => Promise<string[]>;
+}
+
+export enum StorageKeys {
+  PAGE_VIEWS = 'edkt_page_views',
+  MATCHED_AUDIENCES = 'edkt_matched_audiences',
+  MATCHED_AUDIENCE_IDS = 'edkt_matched_audience_ids',
+}
diff --git a/packages/engine/src/condition.ts b/packages/engine/src/condition.ts
@@ -1,7 +1,6 @@
-import { IPageView } from '@edgekit/types';
+import { IPageView, ICondition } from '@edgekit/types';
 import * as reducers from './reducers';
 import * as matchers from './matchers';
-import { ICondition } from './types';
 
 const createCondition = (condition: ICondition) => (pageViews: IPageView[]) => {
   const { filter, rules } = condition;
diff --git a/packages/engine/src/index.ts b/packages/engine/src/index.ts
@@ -1,5 +1,5 @@
+import { IPageView, ICondition } from '@edgekit/types';
 import createCondition from './condition';
-import { IPageView, ICondition } from './types';
 
 export const check = (
   conditions: ICondition[],
diff --git a/packages/engine/src/reducers.ts b/packages/engine/src/reducers.ts
@@ -1,4 +1,4 @@
-import { IPageView } from './types';
+import { IPageView } from '@edgekit/types';
 
 export const count = () => (pageViews: IPageView[]): number => pageViews.length;
 
diff --git a/packages/engine/src/types.ts b/packages/engine/src/types.ts
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -4,3 +4,28 @@ export interface IPageView {
     [name: string]: string[];
   };
 }
+
+export interface IConditionQuery {
+  property: string;
+  value: string[] | number[];
+}
+
+export interface IConditionRule {
+  reducer: {
+    name: 'count';
+    // args?: string;
+  };
+  matcher: {
+    name: 'eq' | 'gt' | 'lt' | 'ge' | 'le';
+    args: number;
+  };
+}
+
+export interface ICondition {
+  filter: {
+    // TODO: return support for any?
+    // any: boolean;
+    queries: IConditionQuery[];
+  };
+  rules: IConditionRule[];
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { IPageView } from './types';`
	`1`	`+import { IPageView } from '@edgekit/types';`
`2`	`2`
`3`	`3`	`export const count = () => (pageViews: IPageView[]): number => pageViews.length;`
`4`	`4`