chore: add interface and readme

README.md

@@ -7,5 +7,27 @@
 ## Usage
 
 ```typescript
-import { SQLConnector } from parch-connector-sql
+import { SQLConnector } from 'parch-connector-sql';
+
+const connector = new SQLConnector(models);
+
+connector.models
+connector.model('user');
+
+await connector.createRecord('user', {
+  email: 'foo@bar.com',
+  password: 'password'
+});
+
+await connector.destroyRecord('user', 1);
+
+await connector.findAll('user');
+
+await connector.findOne('user', 1);
+
+await connector.queryRecord('user', { email: { $like: 'foo' }});
+
+await connector.updateRecord('user', 1, {
+  firstName: 'foo'
+});
 ```

package.json

@@ -9,12 +9,12 @@
     "commitmsg": "validate-commit-msg",
     "compile": "tsc -p .",
     "cover": "NODE_ENV=test nyc yarn test",
-    "lint": "tslint src/**/*.ts -p tsconfig.json",
+    "lint": "tslint src/**/*.ts -p tsconfig.json -t stylish",
     "precommit": "lint-staged",
     "prepare-release": "curl -sL https://gist.githubusercontent.com/dylanfoster/35b06db9aaa9237da77eff4a8eec0a22/raw/83ec714ec64f7ec36c5004588aa259354fc87b51/prepare-release.sh | bash -s",
     "prepublish": "yarn test && yarn compile",
     "pretest": "yarn compile",
-    "test": "NODE_ENV=test mocha --compilers ts:ts-node/register --recursive",
+    "test": "NODE_ENV=test mocha --require ts-node/register --recursive test/**/*.ts",
     "watch:compile": "chokidar 'src/**/*.ts' 'test/**/*.ts' -c 'yarn compile' --initial",
     "watch:cover": "chokidar 'src/**/*.ts' 'test/**/*.ts' -c 'yarn cover' --initial",
     "watch:test": "chokidar 'src/**' 'test/**' -c 'npm test' --initial"

src/connector.ts

@@ -1,7 +1,41 @@
-// import { Connector } from 'parch-connector-base';
+export interface AnyModelInstance extends AnyObject {}
 
-export interface Connector {
+export interface AnyObject {
+  [key: string]: any;
 }
 
-export class SQLConnector implements Connector {
+export interface IDataTypes extends AnyObject {}
+
+export interface IModelDefinition extends AnyObject {}
+
+export interface IConnector {
+  createRecord(modelName: string, payload: AnyObject, options?: AnyObject): Promise<AnyModelInstance | any>;
+  define(DataTypes: IDataTypes): IModelDefinition | any;
+  defineClassMethods(): void;
+  defineInstanceMethods(): void;
+  destroyRecord(modelName: string, id: any, options?: AnyObject): Promise<void>;
+  findAll(modelName: string, query: AnyObject, options?: AnyObject): Promise<AnyModelInstance[] | any>;
+  findOne(modelName: string, id: any, options?: AnyObject): Promise<AnyModelInstance | any>;
+  queryRecord(modelName: string, query: AnyObject, options?: any): Promise<AnyModelInstance | any>;
+  updateRecord(modelName: string, id: any, updates: AnyObject, options?: AnyObject): Promise<AnyModelInstance | any>;
+}
+
+export class SQLConnector implements IConnector {
+  async createRecord(modelName, payload, options) {}
+
+  define(DataTypes) {}
+
+  defineClassMethods() {}
+
+  defineInstanceMethods() {}
+
+  async destroyRecord(modelName, id, options) {}
+
+  async findAll(modelName, query, options) {}
+
+  async findOne(modelName, id, options) {}
+
+  async queryRecord(modelName, query, options) {}
+
+  async updateRecord(modelName, id, updates, options) {}
 }

tslint.json

@@ -1,6 +1,17 @@
 {
   "extends": "tslint-config-airbnb",
   "rules": {
-    "trailing-comma": false
+    "max-line-length": {
+      "severity": "warning",
+      "options": 120
+    },
+    "trailing-comma": false,
+    "variable-name": [true,
+      "ban-keywords",
+      "check-format",
+      "allow-leading-underscore",
+      "allow-pascal-case",
+      "allow-trailing-underscore"
+    ]
   }
 }