@nymphjs/nymph 1.0.0-beta.5 → 1.0.0-beta.50

package/src/driver/NymphDriver.ts

@@ -28,7 +28,7 @@ export default abstract class NymphDriver {
   protected nymph: Nymph = new Proxy({} as Nymph, {
     get() {
       throw new Error(
-        'Attempted access of Nymph instance before driver initialization!'
+        'Attempted access of Nymph instance before driver initialization!',
       );
     },
   });
@@ -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>;
@@ -62,13 +73,18 @@ export default abstract class NymphDriver {
   abstract inTransaction(): Promise<boolean>;
   abstract deleteEntityByID(
     guid: string,
-    classConstructor: EntityConstructor
+    classConstructor: EntityConstructor,
   ): 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
+    writeLine: (line: string) => void,
   ): Promise<void>;
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'count' },
@@ -86,30 +102,6 @@ export default abstract class NymphDriver {
     options?: Options<T>,
     ...selectors: Selector[]
   ): Promise<ReturnType<T['factorySync']>[] | string[] | number>;
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options: Options<T> & { return: 'count' },
-    ...selectors: Selector[]
-  ): number;
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): string[];
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[];
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[] | string[] | number;
   abstract getUID(name: string): Promise<number | null>;
   abstract import(filename: string): Promise<boolean>;
   abstract newUID(name: string): Promise<number | null>;
@@ -131,7 +123,7 @@ export default abstract class NymphDriver {
   protected posixRegexMatch(
     pattern: string,
     subject: string,
-    caseInsensitive = false
+    caseInsensitive = false,
   ) {
     const posixClasses = [
       // '[[:<:]]',
@@ -211,11 +203,11 @@ export default abstract class NymphDriver {
       guid: string,
       tags: string[],
       sdata: SerializedEntityData,
-      etype: string
+      etype: string,
     ) => Promise<void>,
     saveUIDCallback: (name: string, value: number) => Promise<void>,
     startTransactionCallback: (() => Promise<void>) | null = null,
-    commitTransactionCallback: (() => Promise<void>) | null = null
+    commitTransactionCallback: (() => Promise<void>) | null = null,
   ) {
     let rl: ReadLines;
     try {
@@ -237,7 +229,7 @@ export default abstract class NymphDriver {
         continue;
       }
       const entityMatch = text.match(
-        /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/
+        /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/,
       );
       const propMatch = text.match(/^\s*([^=]+)\s*=\s*(.*\S)\s*$/);
       const uidMatch = text.match(/^\s*<([^>]+)>\[(\d+)\]\s*$/);
@@ -281,7 +273,7 @@ export default abstract class NymphDriver {
     sdata: SerializedEntityData,
     selectors: Selector[],
     guid: string | null = null,
-    tags: string[] | null = null
+    tags: string[] | null = null,
   ) {
     const formattedSelectors = this.formatSelectors(selectors).selectors;
 
@@ -298,186 +290,173 @@ export default abstract class NymphDriver {
           continue;
         }
 
-        const clauseNot = key.substr(0, 1) === '!';
+        const clauseNot = key.substring(0, 1) === '!';
         if (key === 'selector' || key === '!selector') {
           const tmpArr = (Array.isArray(value) ? value : [value]) as Selector[];
           pass = xor(
             this.checkData(data, sdata, tmpArr, guid, tags),
-            xor(typeIsNot, clauseNot)
+            xor(typeIsNot, clauseNot),
           );
         } else {
           if (key === 'qref' || key === '!qref') {
             throw new Error("Can't use checkData on qref clauses.");
           } else {
-            // Check if it doesn't pass any for &, check if it
-            // passes any for |.
+            // Check if it doesn't pass any for &, check if it passes any for |.
             for (const curValue of value) {
               if (curValue == null) {
                 continue;
               }
 
-              if (
-                ((key === 'guid' || key === '!guid') && guid == null) ||
-                ((key === 'tag' || key === '!tag') && tags == null)
-              ) {
-                // Skip because it has already been checked (by the query).
-                pass = true;
-              } else {
-                const propName = (curValue as string[])[0];
+              const propName = (curValue as string[])[0];
 
-                // Unserialize the data for this variable.
-                if (propName in sdata) {
-                  data[propName] = JSON.parse(sdata[propName]);
-                  delete sdata[propName];
-                }
+              // Unserialize the data for this variable.
+              if (propName in sdata) {
+                data[propName] = JSON.parse(sdata[propName]);
+                delete sdata[propName];
+              }
 
-                switch (key) {
-                  case 'guid':
-                  case '!guid':
-                    pass = xor(guid == propName, xor(typeIsNot, clauseNot));
-                    break;
-                  case 'tag':
-                  case '!tag':
-                    pass = xor(
-                      (tags ?? []).indexOf(propName) !== -1,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'defined':
-                  case '!defined':
-                    pass = xor(propName in data, xor(typeIsNot, clauseNot));
-                    break;
-                  case 'truthy':
-                  case '!truthy':
-                    pass = xor(
-                      propName in data && data[propName],
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'ref':
-                  case '!ref':
-                    const testRefValue = (curValue as [string, any])[1] as any;
-                    pass = xor(
-                      propName in data &&
-                        this.entityReferenceSearch(
-                          data[propName],
-                          testRefValue
-                        ),
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'equal':
-                  case '!equal':
-                    const testEqualValue = (
-                      curValue as [string, any]
-                    )[1] as any;
-                    pass = xor(
-                      propName in data &&
-                        JSON.stringify(data[propName]) ===
-                          JSON.stringify(testEqualValue),
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'contain':
-                  case '!contain':
-                    const testContainValue = (
-                      curValue as [string, any]
-                    )[1] as any;
-                    pass = xor(
-                      propName in data &&
-                        JSON.stringify(data[propName]).indexOf(
-                          JSON.stringify(testContainValue)
-                        ) !== -1,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'like':
-                  case '!like':
-                    const testLikeValue = (
-                      curValue as [string, string]
-                    )[1] as string;
-                    pass = xor(
-                      propName in data &&
-                        new RegExp(
-                          '^' +
-                            escapeRegExp(testLikeValue)
-                              .replace('%', () => '.*')
-                              .replace('_', () => '.') +
-                            '$'
-                        ).test(data[propName]),
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'match':
-                  case '!match':
-                    const testMatchValue = (
-                      curValue as [string, string]
-                    )[1] as string;
-                    // Convert a POSIX regex to a JS regex.
-                    pass = xor(
-                      propName in data &&
-                        this.posixRegexMatch(testMatchValue, data[propName]),
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'imatch':
-                  case '!imatch':
-                    const testIMatchValue = (
-                      curValue as [string, string]
-                    )[1] as string;
-                    // Convert a POSIX regex to a JS regex.
-                    pass = xor(
-                      propName in data &&
-                        this.posixRegexMatch(
-                          testIMatchValue,
-                          data[propName],
-                          true
-                        ),
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'gt':
-                  case '!gt':
-                    const testGTValue = (
-                      curValue as [string, number]
-                    )[1] as number;
-                    pass = xor(
-                      propName in data && data[propName] > testGTValue,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'gte':
-                  case '!gte':
-                    const testGTEValue = (
-                      curValue as [string, number]
-                    )[1] as number;
-                    pass = xor(
-                      propName in data && data[propName] >= testGTEValue,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'lt':
-                  case '!lt':
-                    const testLTValue = (
-                      curValue as [string, number]
-                    )[1] as number;
-                    pass = xor(
-                      propName in data && data[propName] < testLTValue,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                  case 'lte':
-                  case '!lte':
-                    const testLTEValue = (
-                      curValue as [string, number]
-                    )[1] as number;
-                    pass = xor(
-                      propName in data && data[propName] <= testLTEValue,
-                      xor(typeIsNot, clauseNot)
-                    );
-                    break;
-                }
+              switch (key) {
+                case 'guid':
+                case '!guid':
+                  pass = xor(guid == propName, xor(typeIsNot, clauseNot));
+                  break;
+                case 'tag':
+                case '!tag':
+                  pass = xor(
+                    (tags ?? []).indexOf(propName) !== -1,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'defined':
+                case '!defined':
+                  pass = xor(propName in data, xor(typeIsNot, clauseNot));
+                  break;
+                case 'truthy':
+                case '!truthy':
+                  pass = xor(
+                    propName in data && data[propName],
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'ref':
+                case '!ref':
+                  const testRefValue = (curValue as [string, any])[1] as any;
+                  pass = xor(
+                    propName in data &&
+                      this.entityReferenceSearch(data[propName], testRefValue),
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'equal':
+                case '!equal':
+                  const testEqualValue = (curValue as [string, any])[1] as any;
+                  pass = xor(
+                    propName in data &&
+                      JSON.stringify(data[propName]) ===
+                        JSON.stringify(testEqualValue),
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'contain':
+                case '!contain':
+                  const testContainValue = (
+                    curValue as [string, any]
+                  )[1] as any;
+                  pass = xor(
+                    propName in data &&
+                      JSON.stringify(data[propName]).indexOf(
+                        JSON.stringify(testContainValue),
+                      ) !== -1,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'like':
+                case '!like':
+                  const testLikeValue = (
+                    curValue as [string, string]
+                  )[1] as string;
+                  pass = xor(
+                    propName in data &&
+                      new RegExp(
+                        '^' +
+                          escapeRegExp(testLikeValue)
+                            .replace('%', () => '.*')
+                            .replace('_', () => '.') +
+                          '$',
+                      ).test(data[propName]),
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'match':
+                case '!match':
+                  const testMatchValue = (
+                    curValue as [string, string]
+                  )[1] as string;
+                  // Convert a POSIX regex to a JS regex.
+                  pass = xor(
+                    propName in data &&
+                      this.posixRegexMatch(testMatchValue, data[propName]),
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'imatch':
+                case '!imatch':
+                  const testIMatchValue = (
+                    curValue as [string, string]
+                  )[1] as string;
+                  // Convert a POSIX regex to a JS regex.
+                  pass = xor(
+                    propName in data &&
+                      this.posixRegexMatch(
+                        testIMatchValue,
+                        data[propName],
+                        true,
+                      ),
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'gt':
+                case '!gt':
+                  const testGTValue = (
+                    curValue as [string, number]
+                  )[1] as number;
+                  pass = xor(
+                    propName in data && data[propName] > testGTValue,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'gte':
+                case '!gte':
+                  const testGTEValue = (
+                    curValue as [string, number]
+                  )[1] as number;
+                  pass = xor(
+                    propName in data && data[propName] >= testGTEValue,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'lt':
+                case '!lt':
+                  const testLTValue = (
+                    curValue as [string, number]
+                  )[1] as number;
+                  pass = xor(
+                    propName in data && data[propName] < testLTValue,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
+                case 'lte':
+                case '!lte':
+                  const testLTEValue = (
+                    curValue as [string, number]
+                  )[1] as number;
+                  pass = xor(
+                    propName in data && data[propName] <= testLTEValue,
+                    xor(typeIsNot, clauseNot),
+                  );
+                  break;
               }
+
               if (!xor(typeIsOr, pass)) {
                 break;
               }
@@ -531,7 +510,7 @@ export default abstract class NymphDriver {
       | EntityInterface
       | EntityReference
       | string
-      | (EntityInterface | EntityReference | string)[]
+      | (EntityInterface | EntityReference | string)[],
   ) {
     // Get the GUID, if the passed $entity is an object.
     const guids: string[] = [];
@@ -574,7 +553,7 @@ export default abstract class NymphDriver {
 
   public formatSelectors(
     selectors: Selector[],
-    options: Options = {}
+    options: Options = {},
   ): {
     selectors: FormattedSelector[];
     qrefs: [Options, ...FormattedSelector[]][];
@@ -609,10 +588,9 @@ export default abstract class NymphDriver {
           for (let i = 0; i < tmpArr.length; i++) {
             const name = tmpArr[i][0];
             const [qrefOptions, ...qrefSelectors] = tmpArr[i][1];
-            const QrefEntityClass =
-              typeof qrefOptions.class === 'string'
-                ? this.nymph.getEntityClass(qrefOptions.class)
-                : qrefOptions.class ?? this.nymph.getEntityClass('Entity');
+            const QrefEntityClass = qrefOptions.class
+              ? this.nymph.getEntityClass(qrefOptions.class)
+              : this.nymph.getEntityClass('Entity');
             const newOptions = {
               ...qrefOptions,
               class: QrefEntityClass,
@@ -621,7 +599,7 @@ export default abstract class NymphDriver {
             const newSelectors = this.formatSelectors(qrefSelectors, options);
             qrefs.push(
               [newOptions, ...newSelectors.selectors],
-              ...newSelectors.qrefs
+              ...newSelectors.qrefs,
             );
             formatArr[i] = [name, [newOptions, ...newSelectors.selectors]];
           }
@@ -673,8 +651,8 @@ export default abstract class NymphDriver {
       key: string,
       value: any,
       typeIsOr: boolean,
-      typeIsNot: boolean
-    ) => string
+      typeIsNot: boolean,
+    ) => string,
   ) {
     const queryParts = [];
     for (const curSelector of selectors) {
@@ -703,70 +681,13 @@ export default abstract class NymphDriver {
     return queryParts;
   }
 
-  /**
-   * Get the first entity to match all options/selectors, synchronously.
-   *
-   * This should really only be used internally by the Entity class. It's a bad
-   * idea to get entities synchronously. The Entity class uses this to load
-   * sleeping references.
-   *
-   * @param options The options.
-   * @param selectors Unlimited optional selectors to search for, or a single GUID. If none are given, all entities are searched for the given options.
-   * @returns An entity, or null on failure or nothing found.
-   */
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'count' },
-    ...selectors: Selector[]
-  ): number;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): string | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']> | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'count' },
-    guid: string
-  ): number;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    guid: string
-  ): string | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T>,
-    guid: string
-  ): ReturnType<T['factorySync']> | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> = {},
-    ...selectors: Selector[] | string[]
-  ): ReturnType<T['factorySync']> | string | number | null {
-    // Set up options and selectors.
-    if (typeof selectors[0] === 'string') {
-      selectors = [{ type: '&', guid: selectors[0] }];
-    }
-    options.limit = 1;
-    const entities = this.getEntitiesSync(
-      options,
-      ...(selectors as Selector[])
-    );
-    if (options.return === 'count') {
-      return entities as unknown as number;
-    }
-    if (!entities || !entities.length) {
-      return null;
-    }
-    return entities[0];
-  }
-
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'count' },
     selectors: Selector[],
     performQueryCallback: (
       options: Options<T>,
       formattedSelectors: FormattedSelector[],
-      etype: string
+      etype: string,
     ) => {
       result: any;
     },
@@ -782,7 +703,7 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): { result: any; process: () => number | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
@@ -790,7 +711,7 @@ export default abstract class NymphDriver {
     performQueryCallback: (
       options: Options<T>,
       formattedSelectors: FormattedSelector[],
-      etype: string
+      etype: string,
     ) => {
       result: any;
     },
@@ -806,7 +727,7 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): { result: any; process: () => string[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
@@ -814,7 +735,7 @@ export default abstract class NymphDriver {
     performQueryCallback: (
       options: Options<T>,
       formattedSelectors: FormattedSelector[],
-      etype: string
+      etype: string,
     ) => {
       result: any;
     },
@@ -830,7 +751,7 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): { result: any; process: () => ReturnType<T['factorySync']>[] | Error };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
@@ -838,7 +759,7 @@ export default abstract class NymphDriver {
     performQueryCallback: (
       options: Options<T>,
       formattedSelectors: FormattedSelector[],
-      etype: string
+      etype: string,
     ) => {
       result: any;
     },
@@ -854,7 +775,7 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): {
     result: any;
     process: () => ReturnType<T['factorySync']>[] | string[] | number | Error;
@@ -870,7 +791,7 @@ export default abstract class NymphDriver {
         ['&', '!&', '|', '!|'].indexOf(selector.type) === -1
       ) {
         throw new InvalidParametersError(
-          'Invalid query selector passed: ' + JSON.stringify(selector)
+          'Invalid query selector passed: ' + JSON.stringify(selector),
         );
       }
     }
@@ -899,7 +820,7 @@ export default abstract class NymphDriver {
         const entity = this.pullCache<ReturnType<T['factorySync']>>(
           selectors[0]['guid'],
           EntityClass.class,
-          !!options.skipAc
+          !!options.skipAc,
         );
         if (
           entity != null &&
@@ -908,7 +829,7 @@ export default abstract class NymphDriver {
             entity.hasTag(
               ...(Array.isArray(selectors[0].tag)
                 ? selectors[0].tag
-                : [selectors[0].tag])
+                : [selectors[0].tag]),
             ))
         ) {
           const guid = entity.guid;
@@ -937,7 +858,7 @@ export default abstract class NymphDriver {
       const { result } = performQueryCallback(
         options,
         formattedSelectors.selectors,
-        etype
+        etype,
       );
 
       return {
@@ -1027,7 +948,7 @@ export default abstract class NymphDriver {
       data: EntityData,
       sdata: SerializedEntityData,
       cdate: number,
-      etype: string
+      etype: string,
     ) => Promise<boolean>,
     saveExistingEntityCallback: (
       entity: EntityInterface,
@@ -1036,12 +957,12 @@ export default abstract class NymphDriver {
       data: EntityData,
       sdata: SerializedEntityData,
       mdate: number,
-      etype: string
+      etype: string,
     ) => Promise<boolean>,
     startTransactionCallback: (() => Promise<void>) | null = null,
     commitTransactionCallback:
       | ((success: boolean) => Promise<boolean>)
-      | null = null
+      | null = null,
   ) {
     // Get a modified date.
     const mdate = Date.now();
@@ -1064,7 +985,7 @@ export default abstract class NymphDriver {
         data,
         sdata,
         cdate,
-        etype
+        etype,
       );
       if (success) {
         entity.guid = newId;
@@ -1083,7 +1004,7 @@ export default abstract class NymphDriver {
         data,
         sdata,
         mdate,
-        etype
+        etype,
       );
       if (success) {
         entity.mdate = mdate;
@@ -1100,7 +1021,7 @@ export default abstract class NymphDriver {
         entity.mdate as number,
         entity.tags,
         data,
-        sdata
+        sdata,
       );
     }
     return success;
@@ -1117,7 +1038,7 @@ export default abstract class NymphDriver {
   protected pullCache<T extends EntityInterface = EntityInterface>(
     guid: string,
     className: string,
-    useSkipAc = false
+    useSkipAc = false,
   ): T | null {
     // Increment the entity access count.
     if (!(guid in this.entityCount)) {
@@ -1135,7 +1056,7 @@ export default abstract class NymphDriver {
         entity.tags = this.entityCache[guid]['tags'];
         entity.$putData(
           this.entityCache[guid]['data'],
-          this.entityCache[guid]['sdata']
+          this.entityCache[guid]['sdata'],
         );
         return entity;
       }
@@ -1159,7 +1080,7 @@ export default abstract class NymphDriver {
     mdate: number,
     tags: string[],
     data: EntityData,
-    sdata: SerializedEntityData
+    sdata: SerializedEntityData,
   ) {
     if (guid == null) {
       return;