@betterview/integration-toolkit 0.1.0

package/src/TestHarness/index.ts

@@ -0,0 +1,48 @@
+import { IEnrichmentIntegration, IEnrichmentIntegrationRequestData } from '../Types';
+import { jsonLog } from '../utils';
+
+export default class TestHarness {
+  public integration: IEnrichmentIntegration;
+  public requestData: IEnrichmentIntegrationRequestData | undefined;
+
+  constructor(integration: IEnrichmentIntegration, requestData?: IEnrichmentIntegrationRequestData) {
+    this.integration = integration;
+    this.requestData = requestData;
+  }
+
+  public async runGetData(): Promise<Record<string, any>> {
+    if (!this.requestData) {
+      this.setMockRequestData();
+    }
+    console.log('URL: ', this.integration.getUrl());
+    console.log('Request data set to: ', jsonLog(this.requestData));
+    const result = await this.integration.getData(this.requestData!);
+    console.log(
+      `Result from ${this.integration.registration.partner}_${this.integration.registration.offering}:`,
+      jsonLog(result)
+    );
+    return result;
+  }
+
+  public runGetUrl() {
+    this.integration.getUrl();
+  }
+
+  public setMockRequestData() {
+    this.requestData = {
+      propertyId: 12345,
+      address: '100 Pringle Ave. Walnut Creek, CA 94596',
+      street: '100 Pringle Ave.',
+      city: 'Walnut Creek',
+      zip: '94596',
+      state: 'CA',
+      // fill this w/the true credentials from the offering
+      partnerhubCredentials: { username: 'test', password: 'test' },
+      externalId: 'external1',
+      secondaryExternalId: 'external2',
+      insuredName: 'Jane Doe',
+      latitude: 37.90820797421544,
+      longitude: -122.067761097756
+    };
+  }
+}

package/src/dummy.test.ts

@@ -0,0 +1 @@
+test('Remove me when real tests are in place!', () => expect(true).not.toBe(false));

package/src/types/IEnrichmentIntegration.ts

@@ -0,0 +1,73 @@
+export interface IEnrichmentIntegration {
+  version: string;
+
+  /**
+   * The integration name registred with the database
+   */
+  registration: EnrichmentIntegrationRegistration;
+
+  /**
+   * Where in the workflow the integration should be run: Pre - normal location - before detections,
+   * Post - after detections, Adhoc, out of band, no need to run in a normal way.
+   */
+  workflowLocation: EnrichmentIntegrationWorkflowLocation;
+
+  /**
+   * Should be used for the integration into the UI.  If one integration is needed for another
+   * this is where we would reference that.
+   */
+  dependencies?: EnrichmentIntegrationRegistration[];
+
+  /**
+   * Data requirements is a defintion of what data is needed to send to the vendor to get data back.
+   */
+  dataRequirements?: EnrichmentIntegrationDataRequirement[];
+
+  /**
+   * Pulls data from the vendor and returns the data graph in JSON format.
+   */
+  getData(requestData: IEnrichmentIntegrationRequestData): Promise<Record<string, any>>;
+
+  /**
+   * retrieves the base URL for the integration.
+   */
+  getUrl(): string;
+}
+
+export type EnrichmentIntegrationRegistration = {
+  id?: number;
+  billing_id?: number;
+  partner: string;
+  offering: string;
+};
+
+export type EnrichmentIntegrationWorkflowLocation = 'Pre' | 'Post' | 'Adhoc';
+
+export type EnrichmentIntegrationDataRequirement =
+  | 'partnerHubCredentials'
+  | 'propertyId'
+  | 'address'
+  | 'street'
+  | 'city'
+  | 'zip'
+  | 'state'
+  | 'externalId'
+  | 'secondaryExternalId'
+  | 'latitude'
+  | 'longitude'
+  | 'insuredName';
+
+export interface IEnrichmentIntegrationRequestData {
+  partnerhubCredentials: Record<any, string>;
+  propertyId?: number | null;
+  address: string;
+  street: string;
+  city: string;
+  state: string;
+  zip: string;
+  externalId?: string | null;
+  secondaryExternalId?: string | null;
+  latitude: number;
+  longitude: number;
+  insuredName?: string | null;
+}

package/src/types/IPartnerDataSchema.ts

@@ -0,0 +1,39 @@
+export interface IDataSchemaField {
+  description: string;
+  formatter?: Formatters;
+  jsonPath: string;
+  required?: boolean;
+  sample?: string | number | boolean;
+  title: string;
+  data_type:
+    | 'string'
+    | 'number'
+    | 'date'
+    | 'stringArray'
+    | 'objectArray'
+    | 'boolean'
+    | 'wkt'
+    | 'geojson'
+    | 'imgSrc'
+    | 'downloadSrc'
+    | 'coordinates' // an object keys named latitude longitude OR lat lng OR lat lon
+    | 'coordinatesLatLngCSV' // a coordinate string type like "32, -117"
+    | 'coordinatesLngLatCSV'; // a coordinate string type like "-117, 32"
+  fields?: IDataSchemaField[];
+}
+
+export interface IPartnerDataSchema {
+  fields: IDataSchemaField[];
+}
+export interface IPartnerDataSchemas {
+  [name: string]: IPartnerDataSchema;
+}
+
+export enum Formatters {
+  numberWithCommas = 'numberWithCommas',
+  currencyWithCommas = 'currencyWithCommas',
+  scoreLetterToLowMedHigh = 'scoreLetterToLowMedHigh',
+  roundTwoDecimalPlaces = 'roundTwoDecimalPlaces',
+  decimalToPercentage = 'decimalToPercentage',
+  roundAndFormatWithCommas = 'roundAndFormatWithCommasFn'
+}

package/src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './IEnrichmentIntegration';
+export * from './IPartnerDataSchema';

package/src/utils/index.ts

@@ -0,0 +1,5 @@
+import colorize from 'json-colorizer';
+
+export function jsonLog(obj: Record<string, any> | undefined) {
+  return colorize(JSON.stringify(obj, null, 2));
+}

package/tsconfig.build.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*.js", "src/**/*.ts"],
+  "exclude": [
+    "node_modules",
+    ".vscode",
+    "src/**/*.test.?s",
+    "src/**/*testData.?s",
+    "src/**/*.exclude.?s",
+    "src/__tests__/**/*.?s",
+    "src/__jest__/**/*.?s",
+    "src/__mocks__/**/*.?s"
+  ]
+}

package/tsconfig.eslint.json

@@ -0,0 +1,20 @@
+/**
+This config is necessary because ESlint needs to be able to transpile all TS files
+that we want to lint, even if the real build excludes them (e.g. test files).
+See: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#parseroptionsproject
+*/
+{
+  "extends": "./tsconfig.json",
+  "include": [
+    "src/**/*.js",
+    "src/**/*.ts",
+    ".eslintrc.js",
+    "*.js",
+    "*.ts",
+    "test/**/*.*"
+  ],
+  "exclude": [
+    "node_modules",
+    ".vscode"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compileOnSave": true,
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "ES2017",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir": "tmp",
+    "rootDir": "src",
+    "sourceMap": true,
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "strictNullChecks": true,
+    "noImplicitReturns": true,
+    "baseUrl": "./src",
+  }
+}