feat: improve typings (#62)

* refactor type system
* remove enum and use strings instead
* add transform types
* fixing return types to this
* add better return type to query builder arrays
* remove double inline callback functions
* use keyof with specialization for nested properties
* update filter type in dynamic view
* improve typings of full-text query
* rename some properties of dynamic view
* add return and use ++ instead of += 1
* rename resultset to ResultSet
* remove ANY type
* rename Collection.data to Collection._data
* improve typings for adapter and storage package as well
* improve package export with typings

Author: Viatorus

config/karma.config.js

@@ -38,14 +38,14 @@ module.exports = function (config) {
             exclude: /node_modules/,
             options: {
               failOnHint: false,
-              configFile: path.join("config", "tslint.json"),
+              configFile: path.join(__dirname, "tslint.json"),
             }
           },
           {
             test: /\.ts$/,
             loader: "ts-loader",
             options: {
-              configFile: path.join("config", "tsconfig.webpack.json")
+              configFile: path.join(__dirname, "tsconfig.webpack.json")
             }
           },
           {

packages/common/types.ts

@@ -1,6 +1,7 @@
-import {Loki} from "../loki/src/loki";
-
-export type ANY = any;
+/**
+ * @hidden
+ */
+import {Loki} from "../loki/src";
 
 export interface StorageAdapter {
   loadDatabase(dbname: string): Promise<any>;
@@ -11,7 +12,7 @@ export interface StorageAdapter {
 
   mode?: string;
 
-  exportDatabase?(dbname: string, dbref: ANY): Promise<void>;
+  exportDatabase?(dbname: string, dbref: Loki): Promise<void>;
 }
 
 export type Doc<T extends object = object> = T & { $loki: number; meta: any; };
@@ -23,13 +24,5 @@ export interface Dict<T> {
 }
 
 
-export interface Query {
 
-}
 
-export interface Filter<E> {
-  type: string;
-  /*'find', 'where'*/
-  val: Query | ((obj: E, index: number, array: E[]) => boolean);
-  uid: number | string;
-}

packages/fs-storage/package.json

@@ -8,6 +8,7 @@
     "url": "https://github.com/LokiJS-Forge/LokiJS2.git"
   },
   "main": "lokijs.fs-storage.js",
+  "types": "./types/fs-storage/src/index.d.ts",
   "dependencies": {
     "@lokijs/loki": "0"
   }

packages/fs-storage/spec/node/fs_storage.spec.ts

@@ -1,6 +1,6 @@
 /* global describe, it, expect */
 import {Loki} from "../../../loki/src/loki";
-import {LokiFSStorage} from "../../src/fs_storage";
+import {FSStorage} from "../../src/fs_storage";
 
 describe("testing fs storage", function () {
 
@@ -9,16 +9,16 @@ describe("testing fs storage", function () {
   }
 
   beforeAll(() => {
-    LokiFSStorage.register();
+    FSStorage.register();
   });
 
   afterAll(() => {
-    LokiFSStorage.deregister();
+    FSStorage.deregister();
   });
 
   it("LokiFSStorage", function (done) {
     const db = new Loki("myTestApp");
-    const adapter = {adapter: new LokiFSStorage()};
+    const adapter = {adapter: new FSStorage()};
     db.initializePersistence(adapter)
       .then(() => {
         db.addCollection<Name>("myColl").insert({name: "Hello World"});
@@ -35,7 +35,7 @@ describe("testing fs storage", function () {
       })
       .then(() => {
         const db2 = new Loki("myTestApp");
-        return db2.initializePersistence({persistenceMethod: Loki.PersistenceMethod.FS_STORAGE})
+        return db2.initializePersistence({persistenceMethod: "fs-storage"})
           .then(() => {
             return db2.loadDatabase();
           }).then(() => {

packages/fs-storage/src/fs_storage.ts

@@ -5,19 +5,19 @@ import * as fs from "fs";
 /**
  * A loki persistence adapter which persists using node fs module.
  */
-export class LokiFSStorage implements StorageAdapter {
+export class FSStorage implements StorageAdapter {
   /**
    * Registers the fs storage as plugin.
    */
   static register(): void {
-    PLUGINS["LokiFSStorage"] = LokiFSStorage;
+    PLUGINS["FSStorage"] = FSStorage;
   }
 
   /**
    * Deregisters the fs storage as plugin.
    */
   static deregister(): void {
-    delete PLUGINS["LokiFSStorage"];
+    delete PLUGINS["FSStorage"];
   }
 
   /**
@@ -88,5 +88,3 @@ export class LokiFSStorage implements StorageAdapter {
     });
   }
 }
-
-export default LokiFSStorage;

packages/fs-storage/src/index.ts

@@ -0,0 +1,4 @@
+import {FSStorage} from "./fs_storage";
+
+export {FSStorage};
+export default FSStorage;

packages/full-text-search-language-de/package.json

@@ -8,6 +8,7 @@
     "url": "https://github.com/LokiJS-Forge/LokiJS2.git"
   },
   "main": "lokijs.full-text-search-language-de.js",
+  "types": "./types/full-text-search-language-de/src/index.d.ts",
   "dependencies": {
     "@lokijs/full-text-search": "0",
     "@lokijs/full-text-search-language": "0"

packages/full-text-search-language-de/src/index.ts

@@ -0,0 +1,3 @@
+import {DE} from "./de";
+export {DE};
+export default DE;

packages/full-text-search-language-de/webpack.config.js

@@ -3,7 +3,7 @@ const path = require("path");
 const webpackConigCreator = require('../../config/webpack-config-creator.js');
 
 module.exports = webpackConigCreator({
-  entry: path.join(__dirname, "src", "de.ts"),
+  entry: path.join(__dirname, "src", "index.ts"),
   filename: "lokijs.full-text-search-language-de.js",
   library: "@lokijs/full-text-search-language-de",
   externals: {

packages/full-text-search-language-en/package.json

@@ -8,6 +8,7 @@
     "url": "https://github.com/LokiJS-Forge/LokiJS2.git"
   },
   "main": "lokijs.full-text-search-language-en.js",
+  "types": "./types/full-text-search-language-en/src/index.d.ts",
   "dependencies": {
     "@lokijs/full-text-search": "0",
     "@lokijs/full-text-search-language": "0"