Merge 3b1d2f2 into e2482b7

.eslintrc

@@ -9,7 +9,15 @@
     "curly": 2,
     "linebreak-style": [2, "unix"],
     "no-console": 0,
-    "no-unused-vars": [2, { "vars": "all", "args": "none" }],
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "vars": "all",
+        "args": "none",
+        "ignoreRestSiblings": false
+      }
+    ],
     "no-var": 2,
     "prefer-const": 1,
     "semi": [2, "always"]
@@ -20,5 +28,6 @@
     "node": true
   },
   "extends": ["prettier/@typescript-eslint"],
-  "root": true
+  "root": true,
+  "plugins": ["@typescript-eslint/eslint-plugin"]
 }

.gitattributes

@@ -1 +1,2 @@
 * text eol=lf
+*.png -text

package.json

@@ -17,7 +17,7 @@
     "dist": "cross-env NODE_ENV=production rollup -c && npm run dist:fx",
     "dist:dev": "rollup -c && npm run dist:fx",
     "dist:fx": "ts-node --skip-project bin/dist-fx.ts",
-    "lint": "eslint src test",
+    "lint": "eslint \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\"",
     "publish-demo": "npm run dist-prod && cp dist/kinto.js demo/kinto.js && gh-pages -d demo",
     "publish-to-npm": "npm run dist && npm run build && npm publish",
     "report-coverage": "npm run test-cover && ./node_modules/coveralls/bin/coveralls.js < ./coverage/lcov.info",
@@ -135,13 +135,20 @@
   },
   "dependencies": {
     "btoa": "^1.1.2",
-    "kinto-http": "^5.0.0-alpha.2",
+    "kinto-http": "^5.0.0-alpha.3",
     "uuid": "^7.0.0"
   },
   "devDependencies": {
+    "@types/btoa": "^1.2.3",
+    "@types/chai": "^4.2.7",
+    "@types/chai-as-promised": "^7.1.2",
+    "@types/mocha": "^5.2.7",
     "@types/shelljs": "^0.8.6",
+    "@types/sinon": "^7.5.1",
+    "@types/uuid": "^3.4.6",
     "@typescript-eslint/eslint-plugin": "^2.2.0",
     "@typescript-eslint/parser": "^2.2.0",
+    "atob": "^2.1.2",
     "chai": "^4.0.1",
     "chai-as-promised": "^7.0.0",
     "co-task": "^1.0.0",

rollup.config.js

@@ -16,7 +16,7 @@ function ignoreInput(list) {
 }
 
 const geckoBuild = {
-  input: "./src/index.fx.js",
+  input: "./src/index.fx.ts",
   output: [
     {
       file: "dist/temp.js",
@@ -36,7 +36,7 @@ const geckoBuild = {
 };
 
 const browserBuild = {
-  input: "./src/index.js",
+  input: "./src/index.ts",
   output: [
     {
       file: "dist/kinto.min.js",

src/KintoBase.js → src/KintoBase.ts

@@ -1,16 +1,33 @@
-"use strict";
-
+import { EventEmitter } from "events";
+import Api from "kinto-http";
 import Collection from "./collection";
 import BaseAdapter from "./adapters/base";
+import IDB from "./adapters/IDB";
+import { IdSchema, RemoteTransformer, Hooks } from "./types";
 
 const DEFAULT_BUCKET_NAME = "default";
 const DEFAULT_REMOTE = "http://localhost:8888/v1";
 const DEFAULT_RETRY = 1;
 
+export interface KintoBaseOptions {
+  remote?: string;
+  bucket?: string;
+  events?: EventEmitter;
+  adapter?: typeof IDB;
+  adapterOptions?: object;
+  headers?: Record<string, string>;
+  retry?: number;
+  requestMode?: RequestMode;
+  timeout?: number;
+}
+
 /**
  * KintoBase class.
  */
 export default class KintoBase {
+  private _options: KintoBaseOptions;
+  private _api: Api | null;
+  public events?: EventEmitter;
   /**
    * Provides a public access to the base adapter class. Users can create a
    * custom DB adapter by extending {@link BaseAdapter}.
@@ -52,7 +69,7 @@ export default class KintoBase {
    *
    * @param  {Object} options The options object.
    */
-  constructor(options = {}) {
+  constructor(options: KintoBaseOptions = {}) {
     const defaults = {
       bucket: DEFAULT_BUCKET_NAME,
       remote: DEFAULT_REMOTE,
@@ -71,6 +88,10 @@ export default class KintoBase {
     this.events = this._options.events;
   }
 
+  get ApiClass(): typeof Api {
+    throw new Error("ApiClass() must be implemented by subclasses.");
+  }
+
   /**
    * The kinto HTTP client instance.
    * @type {KintoClient}
@@ -86,7 +107,7 @@ export default class KintoBase {
     } = this._options;
 
     if (!this._api) {
-      this._api = new this.ApiClass(remote, {
+      this._api = new this.ApiClass(remote!, {
         events,
         headers,
         requestMode,
@@ -110,7 +131,16 @@ export default class KintoBase {
    * @param  {Object} [options.localFields]        Array<Field> (default: `[]`])
    * @return {Collection}
    */
-  collection(collName, options = {}) {
+  collection<T extends { id: string } = any>(
+    collName: string,
+    options: {
+      adapter?: typeof IDB;
+      idSchema?: IdSchema;
+      remoteTransformers?: RemoteTransformer[];
+      hooks?: Hooks<T>;
+      localFields?: string[];
+    } = {}
+  ) {
     if (!collName) {
       throw new Error("missing collection name");
     }
@@ -120,7 +150,7 @@ export default class KintoBase {
     };
     const { idSchema, remoteTransformers, hooks, localFields } = options;
 
-    return new Collection(bucket, collName, this, {
+    return new Collection<T>(bucket!, collName, this, {
       events,
       adapter,
       adapterOptions,