@nymphjs/nymph 1.0.0-beta.0 → 1.0.0-beta.10

package/src/driver/NymphDriver.ts

@@ -54,7 +54,18 @@ export default abstract class NymphDriver {
    */
   private putDataCounter = 0;
 
+  /**
+   * This is used internally by Nymph. Don't call it yourself.
+   *
+   * @returns A clone of this instance.
+   */
+  abstract clone(): NymphDriver;
+
+  /**
+   * Connect to the data store.
+   */
   abstract connect(): Promise<boolean>;
+
   abstract isConnected(): boolean;
   abstract startTransaction(name: string): Promise<Nymph>;
   abstract commit(name: string): Promise<boolean>;
@@ -66,7 +77,12 @@ export default abstract class NymphDriver {
   ): Promise<boolean>;
   abstract deleteEntityByID(guid: string, className?: string): Promise<boolean>;
   abstract deleteUID(name: string): Promise<boolean>;
+
+  /**
+   * Disconnect from the data store.
+   */
   abstract disconnect(): Promise<boolean>;
+
   protected abstract exportEntities(
     writeLine: (line: string) => void
   ): Promise<void>;
@@ -283,7 +299,7 @@ export default abstract class NymphDriver {
     guid: string | null = null,
     tags: string[] | null = null
   ) {
-    const formattedSelectors = this.formatSelectors(selectors);
+    const formattedSelectors = this.formatSelectors(selectors).selectors;
 
     for (const curSelector of formattedSelectors) {
       const type = curSelector.type;
@@ -575,8 +591,12 @@ export default abstract class NymphDriver {
   public formatSelectors(
     selectors: Selector[],
     options: Options = {}
-  ): FormattedSelector[] {
+  ): {
+    selectors: FormattedSelector[];
+    qrefs: [Options, ...FormattedSelector[]][];
+  } {
     const newSelectors: FormattedSelector[] = [];
+    const qrefs: [Options, ...FormattedSelector[]][] = [];
 
     for (const curSelector of selectors) {
       const newSelector: FormattedSelector = {
@@ -615,13 +635,18 @@ export default abstract class NymphDriver {
               source: options.source,
             };
             const newSelectors = this.formatSelectors(qrefSelectors, options);
-            this.nymph.runQueryCallbacks(newOptions, newSelectors);
-            formatArr[i] = [name, [newOptions, ...newSelectors]];
+            qrefs.push(
+              [newOptions, ...newSelectors.selectors],
+              ...newSelectors.qrefs
+            );
+            formatArr[i] = [name, [newOptions, ...newSelectors.selectors]];
           }
           newSelector[key] = formatArr;
         } else if (key === 'selector' || key === '!selector') {
           const tmpArr = (Array.isArray(value) ? value : [value]) as Selector[];
-          newSelector[key] = this.formatSelectors(tmpArr, options);
+          const newSelectors = this.formatSelectors(tmpArr, options);
+          newSelector[key] = newSelectors.selectors;
+          qrefs.push(...newSelectors.qrefs);
         } else if (!Array.isArray(value)) {
           // @ts-ignore: ts doesn't know what value is here.
           newSelector[key] = [[value]];
@@ -655,7 +680,7 @@ export default abstract class NymphDriver {
       newSelectors.push(newSelector);
     }
 
-    return newSelectors;
+    return { selectors: newSelectors, qrefs };
   }
 
   protected iterateSelectorsForQuery(
@@ -774,7 +799,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => number };
+  ): { result: any; process: () => number | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     selectors: Selector[],
@@ -798,7 +823,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => string[] };
+  ): { result: any; process: () => string[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
@@ -822,7 +847,7 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => ReturnType<T['factorySync']>[] };
+  ): { result: any; process: () => ReturnType<T['factorySync']>[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
@@ -848,7 +873,7 @@ export default abstract class NymphDriver {
     }
   ): {
     result: any;
-    process: () => ReturnType<T['factorySync']>[] | string[] | number;
+    process: () => ReturnType<T['factorySync']>[] | string[] | number | Error;
   } {
     if (!this.isConnected()) {
       throw new UnableToConnectError('not connected to DB');
@@ -918,78 +943,95 @@ export default abstract class NymphDriver {
       }
     }
 
-    const formattedSelectors = this.formatSelectors(selectors, options);
-    this.nymph.runQueryCallbacks(options, formattedSelectors);
-    const { result } = performQueryCallback(options, formattedSelectors, etype);
+    try {
+      const formattedSelectors = this.formatSelectors(selectors, options);
+      this.nymph.runQueryCallbacks(options, formattedSelectors.selectors);
+      for (let qref of formattedSelectors.qrefs) {
+        const [options, ...selectors] = qref;
+        this.nymph.runQueryCallbacks(options, selectors);
+      }
+      const { result } = performQueryCallback(
+        options,
+        formattedSelectors.selectors,
+        etype
+      );
 
-    return {
-      result,
-      process: () => {
-        let row = rowFetchCallback();
-        if (options.return === 'count') {
-          while (row != null) {
-            count += getCountCallback(row);
-            row = rowFetchCallback();
-          }
-        } else if (options.return === 'guid') {
-          while (row != null) {
-            (entities as string[]).push(getGUIDCallback(row));
-            row = rowFetchCallback();
-          }
-        } else {
-          while (row != null) {
-            const guid = getGUIDCallback(row);
-            const tagsAndDates = getTagsAndDatesCallback(row);
-            const tags = tagsAndDates.tags;
-            const cdate = tagsAndDates.cdate;
-            const mdate = tagsAndDates.mdate;
-            let dataNameAndSValue = getDataNameAndSValueCallback(row);
-            // Data.
-            const data: EntityData = {};
-            // Serialized data.
-            const sdata: SerializedEntityData = {};
-            if (dataNameAndSValue.name !== '') {
-              // This do will keep going and adding the data until the
-              // next entity is reached. $row will end on the next entity.
-              do {
-                dataNameAndSValue = getDataNameAndSValueCallback(row);
-                sdata[dataNameAndSValue.name] = dataNameAndSValue.svalue;
-                row = rowFetchCallback();
-              } while (row != null && getGUIDCallback(row) === guid);
-            } else {
-              // Make sure that $row is incremented :)
+      return {
+        result,
+        process: () => {
+          let row = rowFetchCallback();
+          if (options.return === 'count') {
+            while (row != null) {
+              count += getCountCallback(row);
               row = rowFetchCallback();
             }
-            const entity = EntityClass.factorySync() as ReturnType<
-              T['factorySync']
-            >;
-            entity.$nymph = this.nymph;
-            if (options.skipAc != null) {
-              entity.$useSkipAc(!!options.skipAc);
-            }
-            entity.guid = guid;
-            entity.cdate = cdate;
-            entity.mdate = mdate;
-            entity.tags = tags;
-            this.putDataCounter++;
-            if (this.putDataCounter == 100) {
-              throw new Error('Infinite loop detected in Entity loading.');
+          } else if (options.return === 'guid') {
+            while (row != null) {
+              (entities as string[]).push(getGUIDCallback(row));
+              row = rowFetchCallback();
             }
-            entity.$putData(data, sdata);
-            this.putDataCounter--;
-            if (this.nymph.config.cache) {
-              this.pushCache(guid, cdate, mdate, tags, data, sdata);
+          } else {
+            while (row != null) {
+              const guid = getGUIDCallback(row);
+              const tagsAndDates = getTagsAndDatesCallback(row);
+              const tags = tagsAndDates.tags;
+              const cdate = tagsAndDates.cdate;
+              const mdate = tagsAndDates.mdate;
+              let dataNameAndSValue = getDataNameAndSValueCallback(row);
+              // Data.
+              const data: EntityData = {};
+              // Serialized data.
+              const sdata: SerializedEntityData = {};
+              if (dataNameAndSValue.name !== '') {
+                // This do will keep going and adding the data until the
+                // next entity is reached. $row will end on the next entity.
+                do {
+                  dataNameAndSValue = getDataNameAndSValueCallback(row);
+                  sdata[dataNameAndSValue.name] = dataNameAndSValue.svalue;
+                  row = rowFetchCallback();
+                } while (row != null && getGUIDCallback(row) === guid);
+              } else {
+                // Make sure that $row is incremented :)
+                row = rowFetchCallback();
+              }
+              const entity = EntityClass.factorySync() as ReturnType<
+                T['factorySync']
+              >;
+              entity.$nymph = this.nymph;
+              if (options.skipAc != null) {
+                entity.$useSkipAc(!!options.skipAc);
+              }
+              entity.guid = guid;
+              entity.cdate = cdate;
+              entity.mdate = mdate;
+              entity.tags = tags;
+              this.putDataCounter++;
+              if (this.putDataCounter == 100) {
+                throw new Error('Infinite loop detected in Entity loading.');
+              }
+              entity.$putData(data, sdata);
+              this.putDataCounter--;
+              if (this.nymph.config.cache) {
+                this.pushCache(guid, cdate, mdate, tags, data, sdata);
+              }
+              // @ts-ignore: ts doesn't know the return type here.
+              entities.push(entity);
             }
-            // @ts-ignore: ts doesn't know the return type here.
-            entities.push(entity);
           }
-        }
 
-        freeResultCallback();
+          freeResultCallback();
 
-        return options.return === 'count' ? count : entities;
-      },
-    };
+          return options.return === 'count' ? count : entities;
+        },
+      };
+    } catch (e: any) {
+      return {
+        result: Promise.resolve(e),
+        process: () => {
+          return e;
+        },
+      };
+    }
   }
 
   protected async saveEntityRowLike(

package/src/driver/testArtifacts.ts

@@ -3,16 +3,20 @@ import strtotime from 'locutus/php/datetime/strtotime';
 import { guid } from '@nymphjs/guid';
 
 import type Nymph from '../Nymph';
-import { TestBModel, TestModel, TestModelData } from '../testArtifacts';
+import {
+  TestBModel as TestBModelClass,
+  TestModel as TestModelClass,
+  TestModelData,
+} from '../testArtifacts';
 
 export function QueriesTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.addEntityClass(TestModel);
-  nymph.addEntityClass(TestBModel);
+  const TestModel = nymph.addEntityClass(TestModelClass);
+  const TestBModel = nymph.addEntityClass(TestBModelClass);
 
-  let testEntity: TestModel & TestModelData;
+  let testEntity: TestModelClass & TestModelData;
   let testGuid: string;
   let refGuid: string;
   let createdMultiple = false;
@@ -43,7 +47,7 @@ This one's zip code is 92064.`;
     expect(testEntity.guid).not.toBeNull();
     testGuid = testEntity.guid as string;
 
-    const entityReferenceTest: TestModel & TestModelData = new TestModel();
+    const entityReferenceTest: TestModelClass & TestModelData = new TestModel();
     entityReferenceTest.string = 'wrong';
     entityReferenceTest.timestamp = strtotime('-2 days') * 1000;
     expect(await entityReferenceTest.$save()).toEqual(true);
@@ -59,7 +63,7 @@ This one's zip code is 92064.`;
     testEntity = nymph.driver.getEntitySync(
       { class: TestModel },
       testGuid
-    ) as TestModel & TestModelData;
+    ) as TestModelClass & TestModelData;
     expect(testEntity).toBeInstanceOf(TestModel);
     expect(testEntity.guid).toEqual(testGuid);
 
@@ -67,7 +71,7 @@ This one's zip code is 92064.`;
     testEntity = (await nymph.getEntity(
       { class: TestModel },
       testGuid
-    )) as TestModel & TestModelData;
+    )) as TestModelClass & TestModelData;
     expect(testEntity).toBeInstanceOf(TestModel);
     expect(testEntity.guid).toEqual(testGuid);
   }
@@ -191,7 +195,7 @@ This one's zip code is 92064.`;
     testEntity = (await transaction.getEntity(
       { class: TestModel },
       testGuid
-    )) as TestModel & TestModelData;
+    )) as TestModelClass & TestModelData;
 
     expect(testEntity.guid).toEqual(testGuid);
 
@@ -1728,9 +1732,6 @@ export function UIDTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.addEntityClass(TestModel);
-  nymph.addEntityClass(TestBModel);
-
   it('delete old test data', async () => {
     expect(await nymph.deleteUID('TestUID')).toEqual(true);
     expect(await nymph.deleteUID('NewUID')).toEqual(true);
@@ -1772,8 +1773,8 @@ export function ExportImportTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.addEntityClass(TestModel);
-  nymph.addEntityClass(TestBModel);
+  const TestModel = nymph.addEntityClass(TestModelClass);
+  const TestBModel = nymph.addEntityClass(TestBModelClass);
 
   async function deleteTestData() {
     let all = await nymph.getEntities({ class: TestModel });

package/src/testMocks.ts

@@ -59,24 +59,31 @@ export class MockNymph {
   private entityClasses: { [k: string]: EntityConstructor } = {};
   public driver: MockNymphDriver;
   public Tilmeld: any = undefined;
+  public Entity: typeof Entity;
 
   public constructor() {
     this.driver = new MockNymphDriver(this);
 
     // class NymphEntity extends Entity {}
-    this.addEntityClass(Entity);
+    this.Entity = this.addEntityClass(Entity);
   }
 
-  public addEntityClass(entityClass: EntityConstructor) {
-    this.entityClasses[entityClass.class] = entityClass;
-    entityClass.nymph = this as unknown as Nymph;
+  public addEntityClass<T extends EntityConstructor>(entityClass: T): T {
+    const nymph = this;
+    class NymphEntity extends entityClass {
+      static nymph: Nymph = nymph as unknown as Nymph;
+
+      constructor(...args: any[]) {
+        super(...args);
+      }
+    }
+    this.entityClasses[entityClass.class] = NymphEntity;
+    return NymphEntity;
   }
 
   public getEntityClass(className: string): EntityConstructor {
     if (className in this.entityClasses) {
-      const EntityClass = this.entityClasses[className];
-      EntityClass.nymph = this as unknown as Nymph;
-      return EntityClass;
+      return this.entityClasses[className];
     }
     throw new ClassNotAvailableError('Tried to use class: ' + className);
   }

package/tsconfig.json

@@ -2,6 +2,8 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
+    "lib": ["ES2021"],
+    "target": "ES2021",
     "noImplicitAny": true,
     "removeComments": true,
     "sourceMap": true,