@nymphjs/nymph 1.0.0-alpha.8 → 1.0.0-beta.0

package/src/Entity.ts

@@ -132,11 +132,11 @@ export default class Entity<T extends EntityData = EntityData>
   /**
    * Whether this instance is a sleeping reference.
    */
-  private $isASleepingReference = false;
+  protected $isASleepingReference = false;
   /**
    * The reference to use to wake.
    */
-  private $sleepingReference: EntityReference | null = null;
+  protected $sleepingReference: EntityReference | null = null;
   /**
    * Properties that will not be serialized into JSON with toJSON(). This
    * can be considered a denylist, because these properties will not be set
@@ -208,7 +208,7 @@ export default class Entity<T extends EntityData = EntityData>
       has: (data: EntityData, name: string) => {
         this.$referenceWake();
 
-        return data.hasOwnProperty(name) || this.$sdata.hasOwnProperty(name);
+        return name in data || name in this.$sdata;
       },
 
       get: (data: EntityData, name: string) => {
@@ -249,6 +249,42 @@ export default class Entity<T extends EntityData = EntityData>
         }
         return true;
       },
+
+      defineProperty: (
+        data: EntityData,
+        name: string,
+        descriptor: PropertyDescriptor
+      ) => {
+        this.$referenceWake();
+
+        if (this.$sdata.hasOwnProperty(name)) {
+          delete this.$sdata[name];
+        }
+        Object.defineProperty(data, name, descriptor);
+        return true;
+      },
+
+      getOwnPropertyDescriptor: (data: EntityData, name: string) => {
+        this.$referenceWake();
+
+        if (this.$sdata.hasOwnProperty(name)) {
+          data[name] = referencesToEntities(
+            JSON.parse(this.$sdata[name]),
+            this.$nymph,
+            this.$skipAc
+          );
+          delete this.$sdata[name];
+        }
+        return Object.getOwnPropertyDescriptor(data, name);
+      },
+
+      ownKeys: (data: EntityData) => {
+        this.$referenceWake();
+
+        return Object.getOwnPropertyNames(data).concat(
+          Object.getOwnPropertyNames(this.$sdata)
+        );
+      },
     };
     this.$dataStore = {} as T;
     this.$sdata = {};
@@ -332,6 +368,50 @@ export default class Entity<T extends EntityData = EntityData>
       getPrototypeOf: (entity: Entity) => {
         return entity.constructor.prototype;
       },
+
+      defineProperty: (
+        entity: Entity,
+        name: string,
+        descriptor: PropertyDescriptor
+      ) => {
+        if (
+          typeof name !== 'string' ||
+          name in entity ||
+          name.substring(0, 1) === '$'
+        ) {
+          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+            this.$referenceWake();
+          }
+          Object.defineProperty(entity, name, descriptor);
+        } else {
+          this.$referenceWake();
+          Object.defineProperty(entity.$data, name, descriptor);
+        }
+        return true;
+      },
+
+      getOwnPropertyDescriptor: (entity: Entity, name: string) => {
+        if (
+          typeof name !== 'string' ||
+          name in entity ||
+          name.substring(0, 1) === '$'
+        ) {
+          if (name === 'tags' || name === 'cdate' || name === 'mdate') {
+            this.$referenceWake();
+          }
+          return Object.getOwnPropertyDescriptor(entity, name);
+        } else {
+          this.$referenceWake();
+          return Object.getOwnPropertyDescriptor(entity.$data, name);
+        }
+      },
+
+      ownKeys: (entity: Entity) => {
+        this.$referenceWake();
+        return Object.getOwnPropertyNames(entity).concat(
+          Object.getOwnPropertyNames(entity.$data)
+        );
+      },
     }) as Entity<T>;
   }
 
@@ -453,7 +533,7 @@ export default class Entity<T extends EntityData = EntityData>
     if (includeSData) {
       // Access all the serialized properties to initialize them.
       for (const key in this.$sdata) {
-        const unused: any = (this as any)[key];
+        const _unused: any = (this as any)[key];
       }
     }
     return entitiesToReferences({ ...this.$dataStore });
@@ -487,7 +567,7 @@ export default class Entity<T extends EntityData = EntityData>
 
     // Access all the serialized properties to initialize them.
     for (const key in this.$sdata) {
-      const unused: any = (this as any)[key];
+      const _unused: any = (this as any)[key];
     }
     return {
       guid: this.guid,

package/src/Nymph.ts

@@ -416,7 +416,8 @@ export default class Nymph {
    *   Therefore, offset will be from the newest entity.
    * - sort - How to sort the entities. Accepts "cdate" or "mdate". Defaults to
    *   "cdate".
-   * - return - What to return. "entity" or "guid". Defaults to "entity".
+   * - return - What to return. "entity", "guid", or "count". Defaults to
+   *   "entity".
    * - source - Will be 'client' if the query came from a REST call.
    * - skipCache - If true, Nymph will skip the cache and retrieve the entity
    *   from the DB.
@@ -559,10 +560,13 @@ export default class Nymph {
    *
    * @param options The options.
    * @param selectors Unlimited optional selectors to search for. If none are given, all entities are retrieved for the given options.
-   * @returns An array of entities.
-   * @todo An option to place a total count in a var.
+   * @returns An array of entities or guids, or a count.
    * @todo Use an asterisk to specify any variable.
    */
+  public async getEntities<T extends EntityConstructor = EntityConstructor>(
+    options: Options<T> & { return: 'count' },
+    ...selectors: Selector[]
+  ): Promise<number>;
   public async getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     ...selectors: Selector[]
@@ -574,7 +578,7 @@ export default class Nymph {
   public async getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> = {},
     ...selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[] | string[]> {
+  ): Promise<ReturnType<T['factorySync']>[] | string[] | number> {
     for (let callback of this.beforeGetEntitiesCallbacks) {
       if (callback) {
         callback(this, options, selectors);
@@ -594,8 +598,12 @@ export default class Nymph {
    *
    * @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.
+   * @returns An entity or guid, or null on failure or nothing found, or a number.
    */
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
+    options: Options<T> & { return: 'count' },
+    ...selectors: Selector[]
+  ): Promise<number>;
   public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     ...selectors: Selector[]
@@ -615,7 +623,7 @@ export default class Nymph {
   public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> = {},
     ...selectors: Selector[] | string[]
-  ): Promise<ReturnType<T['factorySync']> | string | null> {
+  ): Promise<ReturnType<T['factorySync']> | string | number | null> {
     // Set up options and selectors.
     if (typeof selectors[0] === 'string') {
       selectors = [{ type: '&', guid: selectors[0] }];
@@ -630,6 +638,9 @@ export default class Nymph {
       options,
       ...(selectors as Selector[])
     );
+    if (options.return === 'count') {
+      return entities as unknown as number;
+    }
     if (!entities || !entities.length) {
       return null;
     }
@@ -822,7 +833,7 @@ export default class Nymph {
       : T extends 'afterDeleteUID'
       ? 'afterDeleteUIDCallbacks'
       : never;
-    if (!this.hasOwnProperty(prop)) {
+    if (!(prop in this)) {
       throw new Error('Invalid event type.');
     }
     // @ts-ignore: The callback should be the right type here.
@@ -911,7 +922,7 @@ export default class Nymph {
       : T extends 'afterDeleteUID'
       ? 'afterDeleteUIDCallbacks'
       : never;
-    if (!this.hasOwnProperty(prop)) {
+    if (!(prop in this)) {
       return false;
     }
     // @ts-ignore: The callback should always be the right type here.

package/src/Nymph.types.ts

@@ -105,13 +105,13 @@ export type Options<T extends EntityConstructor = EntityConstructor> = {
   offset?: number;
   reverse?: boolean;
   sort?: 'cdate' | 'mdate';
-  return?: 'entity' | 'guid';
+  return?: 'entity' | 'guid' | 'count';
   source?: string;
   skipCache?: boolean;
   skipAc?: boolean;
 };
 
-export type Clause<C> = C | C[];
+export type Clause<C> = C | Exclude<C, undefined>[];
 
 export type OrWithTime<T> = T | [string, null, string];
 
@@ -226,17 +226,17 @@ export type Selector = {
 export type FormattedSelector = {
   type: '&' | '|' | '!&' | '!|';
 
-  guid?: PrimitiveSelector['guid'][];
-  '!guid'?: PrimitiveSelector['guid'][];
+  guid?: PrimitiveSelector['guid'][][];
+  '!guid'?: PrimitiveSelector['guid'][][];
 
-  tag?: PrimitiveSelector['tag'][];
-  '!tag'?: PrimitiveSelector['tag'][];
+  tag?: PrimitiveSelector['tag'][][];
+  '!tag'?: PrimitiveSelector['tag'][][];
 
-  defined?: PrimitiveSelector['defined'][];
-  '!defined'?: PrimitiveSelector['defined'][];
+  defined?: PrimitiveSelector['defined'][][];
+  '!defined'?: PrimitiveSelector['defined'][][];
 
-  truthy?: PrimitiveSelector['truthy'][];
-  '!truthy'?: PrimitiveSelector['truthy'][];
+  truthy?: PrimitiveSelector['truthy'][][];
+  '!truthy'?: PrimitiveSelector['truthy'][][];
 
   equal?: PrimitiveSelector['equal'][];
   '!equal'?: PrimitiveSelector['equal'][];
@@ -295,7 +295,7 @@ export interface TilmeldInterface {
   gatekeeper(ability?: string): boolean;
   authenticate(): void;
   clearSession(): void;
-  extractToken(token: string): any;
+  extractToken(token: string): Promise<any>;
   fillSession(user: any): void;
   checkClientUIDPermissions(name: string, type?: TilmeldAccessLevels): boolean;
 }

package/src/driver/NymphDriver.ts

@@ -2,13 +2,14 @@ import fs from 'fs';
 import { difference } from 'lodash';
 import ReadLines from 'n-readlines';
 import strtotime from 'locutus/php/datetime/strtotime';
+import { guid } from '@nymphjs/guid';
 
 import type Nymph from '../Nymph';
-import newGUID from '../newGUID';
 import {
   EntityConstructor,
   EntityData,
   EntityInterface,
+  EntityReference,
   SerializedEntityData,
 } from '../Entity.types';
 import { InvalidParametersError, UnableToConnectError } from '../errors';
@@ -69,6 +70,10 @@ export default abstract class NymphDriver {
   protected abstract exportEntities(
     writeLine: (line: string) => void
   ): Promise<void>;
+  abstract getEntities<T extends EntityConstructor = EntityConstructor>(
+    options: Options<T> & { return: 'count' },
+    ...selectors: Selector[]
+  ): Promise<number>;
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     ...selectors: Selector[]
@@ -80,7 +85,13 @@ export default abstract class NymphDriver {
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options?: Options<T>,
     ...selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[] | string[]>;
+  ): 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
   >(
@@ -98,7 +109,7 @@ export default abstract class NymphDriver {
   >(
     options?: Options<T>,
     ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[] | string[];
+  ): 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>;
@@ -516,16 +527,26 @@ export default abstract class NymphDriver {
    */
   protected entityReferenceSearch(
     value: any,
-    entity: EntityInterface | string | (EntityInterface | string)[]
+    entity:
+      | EntityInterface
+      | EntityReference
+      | string
+      | (EntityInterface | EntityReference | string)[]
   ) {
     // Get the GUID, if the passed $entity is an object.
     const guids: string[] = [];
     if (Array.isArray(entity)) {
-      for (const curEntity of entity) {
-        if (typeof curEntity === 'string') {
-          guids.push(curEntity);
-        } else if (typeof curEntity.guid === 'string') {
-          guids.push(curEntity.guid);
+      if (entity[0] === 'nymph_entity_reference') {
+        guids.push(value[1]);
+      } else {
+        for (const curEntity of entity) {
+          if (typeof curEntity === 'string') {
+            guids.push(curEntity);
+          } else if (Array.isArray(curEntity)) {
+            guids.push(curEntity[1]);
+          } else if (typeof curEntity.guid === 'string') {
+            guids.push(curEntity.guid);
+          }
         }
       }
     } else if (typeof entity === 'string') {
@@ -684,6 +705,10 @@ export default abstract class NymphDriver {
    * @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[]
@@ -692,6 +717,10 @@ export default abstract class NymphDriver {
     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
@@ -703,7 +732,7 @@ export default abstract class NymphDriver {
   public getEntitySync<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> = {},
     ...selectors: Selector[] | string[]
-  ): ReturnType<T['factorySync']> | string | null {
+  ): ReturnType<T['factorySync']> | string | number | null {
     // Set up options and selectors.
     if (typeof selectors[0] === 'string') {
       selectors = [{ type: '&', guid: selectors[0] }];
@@ -713,12 +742,39 @@ export default abstract class NymphDriver {
       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
+    ) => {
+      result: any;
+    },
+    rowFetchCallback: () => any,
+    freeResultCallback: () => void,
+    getCountCallback: (row: any) => number,
+    getGUIDCallback: (row: any) => string,
+    getTagsAndDatesCallback: (row: any) => {
+      tags: string[];
+      cdate: number;
+      mdate: number;
+    },
+    getDataNameAndSValueCallback: (row: any) => {
+      name: string;
+      svalue: string;
+    }
+  ): { result: any; process: () => number };
   protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     selectors: Selector[],
@@ -731,6 +787,7 @@ export default abstract class NymphDriver {
     },
     rowFetchCallback: () => any,
     freeResultCallback: () => void,
+    getCountCallback: (row: any) => number,
     getGUIDCallback: (row: any) => string,
     getTagsAndDatesCallback: (row: any) => {
       tags: string[];
@@ -754,6 +811,7 @@ export default abstract class NymphDriver {
     },
     rowFetchCallback: () => any,
     freeResultCallback: () => void,
+    getCountCallback: (row: any) => number,
     getGUIDCallback: (row: any) => string,
     getTagsAndDatesCallback: (row: any) => {
       tags: string[];
@@ -777,6 +835,7 @@ export default abstract class NymphDriver {
     },
     rowFetchCallback: () => any,
     freeResultCallback: () => void,
+    getCountCallback: (row: any) => number,
     getGUIDCallback: (row: any) => string,
     getTagsAndDatesCallback: (row: any) => {
       tags: string[];
@@ -787,7 +846,10 @@ export default abstract class NymphDriver {
       name: string;
       svalue: string;
     }
-  ): { result: any; process: () => ReturnType<T['factorySync']>[] | string[] } {
+  ): {
+    result: any;
+    process: () => ReturnType<T['factorySync']>[] | string[] | number;
+  } {
     if (!this.isConnected()) {
       throw new UnableToConnectError('not connected to DB');
     }
@@ -805,6 +867,7 @@ export default abstract class NymphDriver {
     }
 
     let entities: ReturnType<T['factorySync']>[] | string[] = [];
+    let count = 0;
     const EntityClass =
       options.class ?? (this.nymph.getEntityClass('Entity') as T);
     const etype = EntityClass.ETYPE;
@@ -842,7 +905,14 @@ export default abstract class NymphDriver {
           const guid = entity.guid;
           return {
             result: Promise.resolve(null),
-            process: () => (options.return === 'guid' ? [guid] : [entity]),
+            process: () =>
+              options.return === 'count'
+                ? guid
+                  ? 1
+                  : 0
+                : options.return === 'guid'
+                ? [guid]
+                : [entity],
           };
         }
       }
@@ -856,7 +926,12 @@ export default abstract class NymphDriver {
       result,
       process: () => {
         let row = rowFetchCallback();
-        if (options.return === 'guid') {
+        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();
@@ -912,7 +987,7 @@ export default abstract class NymphDriver {
 
         freeResultCallback();
 
-        return entities;
+        return options.return === 'count' ? count : entities;
       },
     };
   }
@@ -955,7 +1030,7 @@ export default abstract class NymphDriver {
     let success = false;
     if (entity.guid == null) {
       const cdate = mdate;
-      const newId = newGUID();
+      const newId = guid();
       success = await saveNewEntityCallback(
         entity,
         newId,