@nymphjs/nymph 1.0.0-beta.61 → 1.0.0-beta.63

package/src/driver/NymphDriver.ts

@@ -68,6 +68,7 @@ export default abstract class NymphDriver {
   abstract connect(): Promise<boolean>;
 
   abstract isConnected(): boolean;
+  protected abstract internalTransaction(name: string): Promise<any>;
   abstract startTransaction(name: string): Promise<Nymph>;
   abstract commit(name: string): Promise<boolean>;
   abstract rollback(name: string): Promise<boolean>;
@@ -84,9 +85,11 @@ export default abstract class NymphDriver {
    */
   abstract disconnect(): Promise<boolean>;
 
-  protected abstract exportEntities(
-    writeLine: (line: string) => void,
-  ): Promise<void>;
+  abstract exportDataIterator(): AsyncGenerator<
+    { type: 'comment' | 'uid' | 'entity'; content: string },
+    void,
+    undefined | false
+  >;
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'count' },
     ...selectors: Selector[]
@@ -104,7 +107,15 @@ export default abstract class NymphDriver {
     ...selectors: Selector[]
   ): Promise<EntityInstanceType<T>[] | string[] | number>;
   abstract getUID(name: string): Promise<number | null>;
-  abstract import(filename: string, transaction?: boolean): Promise<boolean>;
+  abstract importEntity(entity: {
+    guid: string;
+    cdate: number;
+    mdate: number;
+    tags: string[];
+    sdata: SerializedEntityData;
+    etype: string;
+  }): Promise<void>;
+  abstract importUID(uid: { name: string; value: number }): Promise<void>;
   abstract newUID(name: string): Promise<number | null>;
   abstract renameUID(oldName: string, newName: string): Promise<boolean>;
   abstract saveEntity(entity: EntityInterface): Promise<boolean>;
@@ -181,9 +192,9 @@ export default abstract class NymphDriver {
       if (!fhandle) {
         throw new InvalidParametersError('Provided filename is not writeable.');
       }
-      await this.exportEntities((line: string) => {
-        fs.writeSync(fhandle, `${line}\n`);
-      });
+      for await (let entry of this.exportDataIterator()) {
+        fs.writeSync(fhandle, entry.content);
+      }
       fs.closeSync(fhandle);
     } catch (e: any) {
       return false;
@@ -192,83 +203,113 @@ export default abstract class NymphDriver {
   }
 
   public async exportPrint() {
-    await this.exportEntities((line: string) => {
-      console.log(line);
-    });
+    for await (let entry of this.exportDataIterator()) {
+      console.log(entry.content);
+    }
     return true;
   }
 
-  protected async importFromFile(
-    filename: string,
-    saveEntityCallback: (
-      guid: string,
-      tags: string[],
-      sdata: SerializedEntityData,
-      etype: string,
-    ) => Promise<void>,
-    saveUIDCallback: (name: string, value: number) => Promise<void>,
-    startTransactionCallback: (() => Promise<void>) | null = null,
-    commitTransactionCallback: (() => Promise<void>) | null = null,
+  public async importDataIterator(
+    lines: Iterable<string>,
+    transaction?: boolean,
   ) {
-    let rl: ReadLines;
-    try {
-      rl = new ReadLines(filename);
-    } catch (e: any) {
-      throw new InvalidParametersError('Provided filename is unreadable.');
+    const first = lines[Symbol.iterator]().next();
+
+    if (first.done || first.value !== '#nex2') {
+      throw new Error('Tried to import a file that is not a NEX v2 file.');
     }
-    let guid: string | null = null;
-    let line: Buffer | false = false;
-    let sdata: SerializedEntityData = {};
-    let tags: string[] = [];
-    let etype = '__undefined';
-    if (startTransactionCallback) {
-      await startTransactionCallback();
+
+    if (transaction) {
+      await this.internalTransaction('nymph-import');
     }
-    while ((line = rl.next())) {
-      const text = line.toString('utf8');
-      if (text.match(/^\s*#/)) {
-        continue;
-      }
-      const entityMatch = text.match(
-        /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/,
-      );
-      const propMatch = text.match(/^\s*([^=]+)\s*=\s*(.*\S)\s*$/);
-      const uidMatch = text.match(/^\s*<([^>]+)>\[(\d+)\]\s*$/);
-      if (uidMatch) {
-        // Add the UID.
-        await saveUIDCallback(uidMatch[1], Number(uidMatch[2]));
-      } else if (entityMatch) {
-        // Save the current entity.
-        if (guid) {
-          await saveEntityCallback(guid, tags, sdata, etype);
-          guid = null;
-          tags = [];
-          sdata = {};
-          etype = '__undefined';
+    try {
+      let guid: string | null = null;
+      let sdata: SerializedEntityData = {};
+      let tags: string[] = [];
+      let etype = '__undefined';
+      for (let line of lines) {
+        if (line.match(/^\s*#/)) {
+          continue;
         }
-        // Record the new entity's info.
-        guid = entityMatch[1];
-        etype = entityMatch[2];
-        tags = entityMatch[3].split(',');
-      } else if (propMatch) {
-        // Add the variable to the new entity.
-        if (guid) {
-          sdata[propMatch[1]] = propMatch[2];
+        const entityMatch = line.match(
+          /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/,
+        );
+        const propMatch = line.match(/^\s*([^=]+)\s*=\s*(.*\S)\s*$/);
+        const uidMatch = line.match(/^\s*<([^>]+)>\[(\d+)\]\s*$/);
+        if (uidMatch) {
+          // Add the UID.
+          await this.importUID({
+            name: uidMatch[1],
+            value: Number(uidMatch[2]),
+          });
+        } else if (entityMatch) {
+          // Save the current entity.
+          if (guid) {
+            const cdate = Number(JSON.parse(sdata.cdate));
+            delete sdata.cdate;
+            const mdate = Number(JSON.parse(sdata.mdate));
+            delete sdata.mdate;
+            await this.importEntity({ guid, cdate, mdate, tags, sdata, etype });
+            guid = null;
+            tags = [];
+            sdata = {};
+            etype = '__undefined';
+          }
+          // Record the new entity's info.
+          guid = entityMatch[1];
+          etype = entityMatch[2];
+          tags = entityMatch[3].split(',');
+        } else if (propMatch) {
+          // Add the variable to the new entity.
+          if (guid) {
+            sdata[propMatch[1]] = propMatch[2];
+          }
         }
+        // Clear the entity cache.
+        this.entityCache = {};
       }
-      // Clear the entity cache.
-      this.entityCache = {};
-    }
-    // Save the last entity.
-    if (guid) {
-      await saveEntityCallback(guid, tags, sdata, etype);
-    }
-    if (commitTransactionCallback) {
-      await commitTransactionCallback();
+      // Save the last entity.
+      if (guid) {
+        const cdate = Number(JSON.parse(sdata.cdate));
+        delete sdata.cdate;
+        const mdate = Number(JSON.parse(sdata.mdate));
+        delete sdata.mdate;
+        await this.importEntity({ guid, cdate, mdate, tags, sdata, etype });
+      }
+      if (transaction) {
+        await this.commit('nymph-import');
+      }
+    } catch (e: any) {
+      await this.rollback('nymph-import');
+      throw e;
     }
     return true;
   }
 
+  public async importData(text: string, transaction?: boolean) {
+    return await this.importDataIterator(text.split('/n'), transaction);
+  }
+
+  public async import(filename: string, transaction?: boolean) {
+    let rl: ReadLines;
+    try {
+      rl = new ReadLines(filename);
+    } catch (e: any) {
+      throw new InvalidParametersError('Provided filename is unreadable.');
+    }
+
+    const lines = {
+      *[Symbol.iterator]() {
+        let line: false | Buffer;
+        while ((line = rl.next())) {
+          yield line.toString('utf8');
+        }
+      },
+    };
+
+    return await this.importDataIterator(lines, transaction);
+  }
+
   public checkData(
     data: EntityData,
     sdata: SerializedEntityData,

package/src/driver/testArtifacts.ts

@@ -94,14 +94,23 @@ These hats are absolutely fantastic.`;
   }
 
   it('delete old test data', async () => {
-    let all = await nymph.getEntities({ class: TestModel });
-    expect(Array.isArray(all)).toEqual(true);
-    for (const cur of all) {
+    let amodels = await nymph.getEntities({ class: TestModel });
+    expect(Array.isArray(amodels)).toEqual(true);
+    for (const cur of amodels) {
       expect(await cur.$delete()).toEqual(true);
     }
 
-    all = await nymph.getEntities({ class: TestModel });
-    expect(all.length).toEqual(0);
+    amodels = await nymph.getEntities({ class: TestModel });
+    expect(amodels.length).toEqual(0);
+
+    let bmodels = await nymph.getEntities({ class: TestBModel });
+    expect(Array.isArray(bmodels)).toEqual(true);
+    for (const cur of bmodels) {
+      expect(await cur.$delete()).toEqual(true);
+    }
+
+    bmodels = await nymph.getEntities({ class: TestBModel });
+    expect(bmodels.length).toEqual(0);
   });
 
   it('create entity', async () => {
@@ -1986,25 +1995,39 @@ export function ExportImportTest(
     const bmodels = await nymph.getEntities({ class: TestBModel });
 
     expect(models.length).toEqual(30);
-    expect(bmodels.length).toEqual(10);
-
-    const all = [...models, ...bmodels];
-    for (const model of all) {
-      if (model.index?.match(/^\d+a$/)) {
-        expect(model.null).toBeNull();
-        expect(model.string).toEqual('test');
-        expect(model.array).toEqual(['full', 'of', 'values', 500]);
-        expect(model.number).toEqual(30);
-        expect(model.timestamp).toBeGreaterThanOrEqual(strtotime('-2 minutes'));
-
-        await model.reference?.$wake();
-        expect(model.reference?.guid).not.toBeNull();
-        expect(model.reference?.string).toEqual('another');
-        expect(model.reference?.index?.match(/^\d+b$/)).toBeTruthy();
-        await Promise.all(model.refArray?.map((e) => e.$wake()) || []);
-        expect(model.refArray?.[0].guid).not.toBeNull();
-        expect(model.refArray?.[0].guid).toEqual(model.reference?.guid);
-      }
+    expect(bmodels.length).toEqual(30);
+
+    for (const model of models) {
+      expect(model.name).toMatch(/^Entity Test /);
+      expect(model.null).toBeDefined();
+      expect(model.null).toBeNull();
+      expect(model.string).toEqual('test');
+      expect(model.array).toEqual(['full', 'of', 'values', 500]);
+      expect(model.match)
+        .toEqual(`Hello, my name is Edward McCheese. It is a pleasure to meet you. As you can see, I have several hats of the most pleasant nature.
+
+This one's email address is nice_hat-wednesday+newyork@im-a-hat.hat.
+This one's phone number is (555) 555-1818.
+This one's zip code is 92064.
+This one's favorite emojis are 🔥❤️😊😂⭐🤔
+
+These hats are absolutely fantastic.`);
+      expect(model.number).toEqual(30);
+      expect(model.numberString).toEqual('30');
+      expect(model.timestamp).toBeGreaterThanOrEqual(strtotime('-2 minutes'));
+      expect(model.index).toMatch(/^\d+a$/);
+
+      await model.reference?.$wake();
+      expect(model.reference?.guid).not.toBeNull();
+      expect(model.reference?.string).toEqual('another');
+      expect(model.reference?.index).toMatch(/^\d+b$/);
+      expect(model.index?.substring(0, -1)).toEqual(
+        model.reference?.index?.substring(0, -1),
+      );
+      expect(model.reference?.$inArray(bmodels)).toEqual(true);
+      await Promise.all(model.refArray?.map((e) => e.$wake()) || []);
+      expect(model.refArray?.[0].guid).not.toBeNull();
+      expect(model.refArray?.[0].guid).toEqual(model.reference?.guid);
     }
   }
 
@@ -2017,22 +2040,29 @@ export function ExportImportTest(
     expect(await nymph.newUID('TestUID')).toEqual(2);
     expect(await nymph.newUID('TestUID2')).toEqual(1);
 
-    for (let i = 0; i < 20; i++) {
-      const EntityClass = i < 15 ? TestModel : TestBModel;
-
+    for (let i = 0; i < 30; i++) {
       // Creating entity...
-      const testEntity = await EntityClass.factory();
+      const testEntity = await TestModel.factory();
 
       // Saving entity...
       testEntity.name = 'Entity Test ' + new Date().toLocaleString();
       testEntity.null = null;
       testEntity.string = 'test';
       testEntity.array = ['full', 'of', 'values', 500];
+      testEntity.match = `Hello, my name is Edward McCheese. It is a pleasure to meet you. As you can see, I have several hats of the most pleasant nature.
+
+This one's email address is nice_hat-wednesday+newyork@im-a-hat.hat.
+This one's phone number is (555) 555-1818.
+This one's zip code is 92064.
+This one's favorite emojis are 🔥❤️😊😂⭐🤔
+
+These hats are absolutely fantastic.`;
       testEntity.number = 30;
+      testEntity.numberString = '30';
       testEntity.timestamp = Date.now();
       testEntity.index = i + 'a';
 
-      const entityReferenceTest = await EntityClass.factory();
+      const entityReferenceTest = await TestBModel.factory();
       entityReferenceTest.string = 'another';
       entityReferenceTest.index = i + 'b';
 

package/tsconfig.json

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