Rename serialization to migration.

Author: Viatorus

packages/common/types.ts

@@ -2,7 +2,7 @@
  * @hidden
  */
 import {Loki} from "../loki/src";
-import {Serialization} from "../loki/src/serialization/serialization";
+import {Serialization} from "../loki/src/serialization/migrate";
 
 export interface StorageAdapter {
   loadDatabase(dbname: string): Promise<string | Loki | Serialization.Serialized>;

packages/full-text-search/src/full_text_search.ts

@@ -5,7 +5,7 @@ import {PLUGINS} from "../../common/plugin";
 import {Query} from "./query_types";
 import {Scorer} from "./scorer";
 import {Analyzer} from "./analyzer/analyzer";
-import {Serialization} from "../../loki/src/serialization/serialization";
+import {Serialization} from "../../loki/src/serialization/migrate";
 
 export class FullTextSearch {
   /// The id field of each document.

packages/full-text-search/src/inverted_index.ts

@@ -1,5 +1,5 @@
 import {Analyzer, StandardAnalyzer, analyze} from "./analyzer/analyzer";
-import {Serialization} from "../../loki/src/serialization/serialization";
+import {Serialization} from "../../loki/src/serialization/migrate";
 
 /**
  * Converts a string into an array of code points.

…/loki/spec/generic/serialization.spec.ts …ages/loki/spec/generic/migration.spec.tspackages/loki/spec/generic/serialization.spec.ts renamed to packages/loki/spec/generic/migration.spec.ts packages/loki/spec/generic/serialization.spec.ts renamed to packages/loki/spec/generic/migration.spec.ts

@@ -1,5 +1,5 @@
 import {Loki} from "../../src/loki";
-import {Serialization, mergeRightBiasedWithProxy} from "../../src/serialization/serialization";
+import {Serialization, mergeRightBiasedWithProxy} from "../../src/serialization/migrate";
 
 declare var require: (moduleId: string) => any;
 const loki = require("../../../lokijs/lokijs.js");

packages/loki/spec/generic/typed.spec.ts

@@ -1,7 +1,7 @@
 /* global describe, it, expect */
 import {Loki} from "../../src/loki";
 import {Doc} from "../../../common/types";
-import {Serialization} from "../../src/serialization/serialization";
+import {Serialization} from "../../src/serialization/migrate";
 
 describe("typed", () => {
   it("works", () => {

packages/loki/src/collection.ts

@@ -8,7 +8,7 @@ import {Doc, Dict} from "../../common/types";
 import {FullTextSearch} from "../../full-text-search/src/full_text_search";
 import {PLUGINS} from "../../common/plugin";
 import {Analyzer} from "../../full-text-search/src/analyzer/analyzer";
-import {Serialization} from "./serialization/serialization";
+import {Serialization} from "./serialization/migrate";
 
 export {CloneMethod} from "./clone";
 

packages/loki/src/dynamic_view.ts

@@ -3,7 +3,7 @@ import {ResultSet} from "./result_set";
 import {Collection} from "./collection";
 import {Doc} from "../../common/types";
 import {Scorer} from "../../full-text-search/src/scorer";
-import {Serialization} from "./serialization/serialization";
+import {Serialization} from "./serialization/migrate";
 
 /**
  * DynamicView class is a versatile 'live' view class which can have filters and sorts applied.

packages/loki/src/loki.ts

@@ -4,7 +4,7 @@ import {Collection} from "./collection";
 import {clone} from "./clone";
 import {Doc, StorageAdapter} from "../../common/types";
 import {PLUGINS} from "../../common/plugin";
-import {Serialization, deserializeLegacyDB} from "./serialization/serialization";
+import {Serialization, migrateDatabase} from "./serialization/migrate";
 
 function getENV(): Loki.Environment {
   if (global !== undefined && (global["android"] || global["NSObject"])) {
@@ -49,7 +49,7 @@ export class Loki extends LokiEventEmitter {
   // currently keeping persistenceMethod and persistenceAdapter as loki level properties that
   // will not or cannot be deserialized  You are required to configure persistence every time
   // you instantiate a loki object (or use default environment detection) in order to load the database anyways.
-  private _serializationMethod: Loki.SerializedMethod;
+  private _serializationMethod: Loki.SerializationMethod;
   private _destructureDelimiter: string;
   // persistenceMethod could be 'fs', 'localStorage', or 'adapter'
   // this is optional option param, otherwise environment detection will be used
@@ -74,7 +74,7 @@ export class Loki extends LokiEventEmitter {
    * @param {string} filename - name of the file to be saved to
    * @param {object} [options={}] - options
    * @param {Loki.Environment} [options.env] - the javascript environment
-   * @param {Loki.SerializedMethod} [options.serializationMethod=NORMAL] - the serialization method
+   * @param {Loki.SerializationMethod} [options.serializationMethod=NORMAL] - the serialization method
    * @param {string} [options.destructureDelimiter="$<\n"] - string delimiter used for destructured serialization
    */
   constructor(filename = "loki.db", options: Loki.Options = {}) {
@@ -666,7 +666,7 @@ export class Loki extends LokiEventEmitter {
   public loadJSONObject(obj: Serialization.Serialized, options: Collection.DeserializeOptions = {}): void {
 
     const databaseVersion = obj.databaseVersion;
-    const dbObj = deserializeLegacyDB(obj);
+    const dbObj = migrateDatabase(obj);
 
     const len = dbObj.collections ? dbObj.collections.length : 0;
     this.filename = dbObj.filename;
@@ -1045,7 +1045,7 @@ export class Loki extends LokiEventEmitter {
 export namespace Loki {
   export interface Options {
     env?: Environment;
-    serializationMethod?: SerializedMethod;
+    serializationMethod?: SerializationMethod;
     destructureDelimiter?: string;
   }
 
@@ -1064,7 +1064,7 @@ export namespace Loki {
   }
 
   export interface SerializeOptions {
-    serializationMethod?: SerializedMethod;
+    serializationMethod?: SerializationMethod;
   }
 
   export interface SerializeDestructuredOptions {
@@ -1089,7 +1089,7 @@ export namespace Loki {
 
   export type LoadDatabaseOptions = Collection.DeserializeOptions & ThrottledDrainOptions;
 
-  export type SerializedMethod = "normal" | "pretty" | "destructured";
+  export type SerializationMethod = "normal" | "pretty" | "destructured";
 
   export type PersistenceMethod = "fs-storage" | "local-storage" | "indexed-storage" | "memory-storage" | "adapter";
 

packages/loki/src/result_set.ts

@@ -4,7 +4,7 @@ import {ltHelper, gtHelper, aeqHelper, sortHelper} from "./helper";
 import {Doc} from "../../common/types";
 import {Scorer} from "../../full-text-search/src/scorer";
 import {Query as FullTextSearchQuery} from "../../full-text-search/src/query_types";
-import {Serialization} from "./serialization/serialization";
+import {Serialization} from "./serialization/migrate";
 
 // used to recursively scan hierarchical transform step object for param substitution
 function resolveTransformObject<TData extends object, TNested extends object>(subObj: Collection.Transform<TData, TNested>, params: object, depth: number = 0): Collection.Transform<TData, TNested> {

…/loki/src/serialization/serialization.ts …ckages/loki/src/serialization/migrate.tspackages/loki/src/serialization/serialization.ts renamed to packages/loki/src/serialization/migrate.ts packages/loki/src/serialization/serialization.ts renamed to packages/loki/src/serialization/migrate.ts

@@ -57,9 +57,9 @@ export function mergeRightBiasedWithProxy<TLeft, TRight>(left: TLeft, right: TRi
   ) as any;
 }
 
-function convertV1_5toV2_0(obj: V1_5.Loki): V2_0.Loki {
+function migrateV1_5toV2_0(obj: V1_5.Loki): V2_0.Loki {
 
-  function convertCloneMethod(clone: V1_5.CloneMethod): V2_0.CloneMethod {
+  function migrateCloneMethod(clone: V1_5.CloneMethod): V2_0.CloneMethod {
     switch (clone) {
       case "jquery-extend-deep":
         return "deep";
@@ -89,7 +89,7 @@ function convertV1_5toV2_0(obj: V1_5.Loki): V2_0.Loki {
             field: dv.sortCriteriaSimple.propname
           },
         })),
-        cloneMethod: convertCloneMethod(coll.cloneMethod),
+        cloneMethod: migrateCloneMethod(coll.cloneMethod),
         transforms: coll.transforms as any as Dict<V2_0.Transform[]>, // TODO not accurate
         nestedProperties: [],
         ttl: undefined,
@@ -99,9 +99,9 @@ function convertV1_5toV2_0(obj: V1_5.Loki): V2_0.Loki {
     });
 }
 
-export function deserializeLegacyDB(obj: Serialization.Serialized): Serialization.Loki {
+export function migrateDatabase(obj: Serialization.Serialized): Serialization.Loki {
   if (obj.databaseVersion === 1.5) {
-    return deserializeLegacyDB(convertV1_5toV2_0(obj as V1_5.Loki));
+    return migrateDatabase(migrateV1_5toV2_0(obj as V1_5.Loki));
   }
   return obj as Serialization.Loki;
 }