@nymphjs/nymph 1.0.0-alpha.2 → 1.0.0-alpha.20

package/src/Entity.test.ts

@@ -1,13 +1,16 @@
 import { MockNymph } from './testMocks';
-import Nymph from './Nymph';
+import { TestBModel, TestModel, TestModelData } from './testArtifacts';
+import { cloneDeep } from 'lodash';
+
+const nymph = new MockNymph();
 
 jest.mock('./Nymph', () => ({
   __esModule: true,
-  default: MockNymph,
+  default: nymph,
 }));
 
-import { TestModel, TestModelData } from './testArtifacts';
-import { cloneDeep } from 'lodash';
+nymph.addEntityClass(TestModel);
+nymph.addEntityClass(TestBModel);
 
 let testEntity = TestModel.factorySync();
 let entityReferenceTest: TestModel & TestModelData;

package/src/Entity.ts

@@ -1,5 +1,6 @@
 import { difference, intersection, isEqual } from 'lodash';
 
+import type Nymph from './Nymph';
 import {
   ACProperties,
   EntityConstructor,
@@ -11,7 +12,6 @@ import {
   SerializedEntityData,
 } from './Entity.types';
 import { EntityConflictError, InvalidParametersError } from './errors';
-import nymph, { Nymph } from './Nymph';
 import {
   entitiesToReferences,
   referencesToEntities,
@@ -94,7 +94,7 @@ export default class Entity<T extends EntityData = EntityData>
   /**
    * The instance of Nymph to use for queries.
    */
-  public static nymph = nymph;
+  public static nymph = {} as Nymph;
   /**
    * A unique name for this type of entity used to separate its data from other
    * types of entities in the database.
@@ -108,7 +108,7 @@ export default class Entity<T extends EntityData = EntityData>
    */
   public static class = 'Entity';
 
-  public $nymph: Nymph = Entity.nymph;
+  public $nymph: Nymph;
   public guid: string | null = null;
   public cdate: number | null = null;
   public mdate: number | null = null;
@@ -203,6 +203,7 @@ export default class Entity<T extends EntityData = EntityData>
    * @param guid The ID of the entity to load, undefined for a new entity.
    */
   public constructor(guid?: string) {
+    this.$nymph = (this.constructor as EntityConstructor).nymph;
     this.$dataHandler = {
       has: (data: EntityData, name: string) => {
         this.$referenceWake();
@@ -375,7 +376,7 @@ export default class Entity<T extends EntityData = EntityData>
     const data = this.$getData(true);
     for (const key in data) {
       if (this.$privateData.indexOf(key) === -1) {
-        obj.data[key] = entitiesToReferences(data[key], this.$nymph);
+        obj.data[key] = entitiesToReferences(data[key]);
       }
     }
     return obj;
@@ -455,7 +456,7 @@ export default class Entity<T extends EntityData = EntityData>
         const unused: any = (this as any)[key];
       }
     }
-    return entitiesToReferences({ ...this.$dataStore }, this.$nymph);
+    return entitiesToReferences({ ...this.$dataStore });
   }
 
   public $getSData() {
@@ -825,5 +826,3 @@ export default class Entity<T extends EntityData = EntityData>
     this.$skipAc = !!skipAc;
   }
 }
-
-Entity.nymph.setEntityClass(Entity.class, Entity);

package/src/Entity.types.ts

@@ -1,5 +1,5 @@
-import { Nymph } from './Nymph';
-import { Options } from './Nymph.types';
+import type Nymph from './Nymph';
+import type { Options } from './Nymph.types';
 
 export type ACProperties = {
   user: any;

package/src/Nymph.ts

@@ -1,7 +1,7 @@
 import { Config, ConfigDefaults as defaults } from './conf';
 import { NymphDriver } from './driver';
-import PreInitializedDriver from './driver/PreInitializedDriver';
-import { EntityConstructor, EntityInterface } from './Entity.types';
+import Entity from './Entity';
+import { EntityConstructor, EntityData, EntityInterface } from './Entity.types';
 import { ClassNotAvailableError } from './errors';
 import type {
   Selector,
@@ -39,7 +39,7 @@ import type {
  * @copyright SciActive Inc
  * @see http://nymph.io/
  */
-export class Nymph {
+export default class Nymph {
   /**
    * The PubSub config.
    */
@@ -58,7 +58,12 @@ export class Nymph {
   /**
    * A simple map of names to Entity classes.
    */
-  public entityClasses: { [k: string]: EntityConstructor } = {};
+  private entityClasses: { [k: string]: EntityConstructor } = {};
+
+  /**
+   * The entity class for this instance of Nymph.
+   */
+  public Entity: typeof Entity = Entity;
 
   private connectCallbacks: NymphConnectCallback[] = [];
   private disconnectCallbacks: NymphDisconnectCallback[] = [];
@@ -82,8 +87,9 @@ export class Nymph {
   private beforeDeleteUIDCallbacks: NymphBeforeDeleteUIDCallback[] = [];
   private afterDeleteUIDCallbacks: NymphAfterDeleteUIDCallback[] = [];
 
-  public setEntityClass(className: string, entityClass: EntityConstructor) {
-    this.entityClasses[className] = entityClass;
+  public addEntityClass(entityClass: EntityConstructor) {
+    this.entityClasses[entityClass.class] = entityClass;
+    entityClass.nymph = this;
   }
 
   public getEntityClass(className: string): EntityConstructor {
@@ -95,19 +101,47 @@ export class Nymph {
     throw new ClassNotAvailableError('Tried to use class: ' + className);
   }
 
-  public constructor() {
-    this.config = { ...defaults };
-    this.driver = new PreInitializedDriver();
+  /**
+   * Initialize Nymph.
+   *
+   * @param config The Nymph configuration.
+   * @param driver The Nymph database driver.
+   * @param tilmeld The Tilmeld user/group manager instance, if you want to use it.
+   */
+  public constructor(
+    config: Partial<Config>,
+    driver: NymphDriver,
+    tilmeld?: TilmeldInterface
+  ) {
+    this.config = { ...defaults, ...config };
+    this.driver = driver;
+    if (typeof tilmeld !== 'undefined') {
+      this.tilmeld = tilmeld;
+    }
+
+    class NymphEntity<T extends EntityData = EntityData> extends Entity<T> {}
+    NymphEntity.nymph = this;
+    this.Entity = NymphEntity;
+    this.addEntityClass(NymphEntity);
+
+    this.driver.init(this);
+    if (this.tilmeld) {
+      this.tilmeld.init(this);
+    }
   }
 
+  /**
+   * Get a clone of this instance with duplicate classes and event listeners.
+   *
+   * @returns A clone of this instance.
+   */
   public clone() {
-    const nymph = new Nymph();
-    nymph.config = this.config;
-    nymph.driver = this.driver;
-    nymph.tilmeld = this.tilmeld;
-    nymph.entityClasses = this.entityClasses;
-    if (nymph.tilmeld) {
-      nymph.tilmeld.nymph = nymph;
+    const nymph = new Nymph(this.config, this.driver, this.tilmeld?.clone());
+    for (const name in this.entityClasses) {
+      if (name === 'Entity' || (this.entityClasses[name] as any).skipOnClone) {
+        continue;
+      }
+      nymph.addEntityClass(this.entityClasses[name]);
     }
 
     const events = [
@@ -137,6 +171,9 @@ export class Nymph {
       // @ts-ignore: The callback should be the right type here.
       const callbacks = this[prop];
       for (let callback of callbacks) {
+        if (callback.skipOnClone) {
+          continue;
+        }
         nymph.on(event as NymphEventType, callback);
       }
     }
@@ -144,29 +181,6 @@ export class Nymph {
     return nymph;
   }
 
-  /**
-   * Initialize Nymph.
-   *
-   * @param config The Nymph configuration.
-   * @param driver The Nymph database driver.
-   * @param tilmeld The Tilmeld user/group manager instance, if you want to use it.
-   */
-  public init(
-    config: Partial<Config>,
-    driver: NymphDriver,
-    tilmeld?: TilmeldInterface
-  ) {
-    this.config = { ...defaults, ...config };
-    this.driver = driver;
-    if (typeof tilmeld !== 'undefined') {
-      this.tilmeld = tilmeld;
-    }
-    this.driver.init(this);
-    if (this.tilmeld) {
-      this.tilmeld.init(this);
-    }
-  }
-
   /**
    * Connect to the database.
    *
@@ -176,7 +190,7 @@ export class Nymph {
     const result = this.driver.connect();
     for (let callback of this.connectCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -191,7 +205,7 @@ export class Nymph {
     const result = this.driver.disconnect();
     for (let callback of this.disconnectCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -206,7 +220,7 @@ export class Nymph {
   ) {
     for (let callback of this.queryCallbacks) {
       if (callback) {
-        callback(options, selectors);
+        callback(this, options, selectors);
       }
     }
   }
@@ -278,13 +292,13 @@ export class Nymph {
   public async newUID(name: string): Promise<number | null> {
     for (let callback of this.beforeNewUIDCallbacks) {
       if (callback) {
-        callback(name);
+        callback(this, name);
       }
     }
     const result = this.driver.newUID(name);
     for (let callback of this.afterNewUIDCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -309,13 +323,13 @@ export class Nymph {
   public async setUID(name: string, value: number): Promise<boolean> {
     for (let callback of this.beforeSetUIDCallbacks) {
       if (callback) {
-        callback(name, value);
+        callback(this, name, value);
       }
     }
     const result = this.driver.setUID(name, value);
     for (let callback of this.afterSetUIDCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -330,13 +344,13 @@ export class Nymph {
   public async deleteUID(name: string): Promise<boolean> {
     for (let callback of this.beforeDeleteUIDCallbacks) {
       if (callback) {
-        callback(name);
+        callback(this, name);
       }
     }
     const result = this.driver.deleteUID(name);
     for (let callback of this.afterDeleteUIDCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -352,13 +366,13 @@ export class Nymph {
   public async renameUID(oldName: string, newName: string): Promise<boolean> {
     for (let callback of this.beforeRenameUIDCallbacks) {
       if (callback) {
-        callback(oldName, newName);
+        callback(this, oldName, newName);
       }
     }
     const result = this.driver.renameUID(oldName, newName);
     for (let callback of this.afterRenameUIDCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -378,13 +392,13 @@ export class Nymph {
   public async saveEntity(entity: EntityInterface): Promise<boolean> {
     for (let callback of this.beforeSaveEntityCallbacks) {
       if (callback) {
-        callback(entity);
+        callback(this, entity);
       }
     }
     const result = this.driver.saveEntity(entity);
     for (let callback of this.afterSaveEntityCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -473,10 +487,10 @@ export class Nymph {
    * entities that were created in the last day:
    *
    * ```
-   * [
-   *   '&',
-   *   'gte' => ['cdate', null, '-1 day']
-   * ]
+   * {
+   *   type: '&',
+   *   gte: ['cdate', null, '-1 day']
+   * }
    * ```
    *
    * Locutus' implementation: https://locutus.io/php/datetime/strtotime/
@@ -563,7 +577,7 @@ export class Nymph {
   ): Promise<ReturnType<T['factorySync']>[] | string[]> {
     for (let callback of this.beforeGetEntitiesCallbacks) {
       if (callback) {
-        callback(options, selectors);
+        callback(this, options, selectors);
       }
     }
     return await this.driver.getEntities(options, ...selectors);
@@ -609,7 +623,7 @@ export class Nymph {
     options.limit = 1;
     for (let callback of this.beforeGetEntityCallbacks) {
       if (callback) {
-        callback(options, selectors as Selector[]);
+        callback(this, options, selectors as Selector[]);
       }
     }
     const entities = await this.driver.getEntities(
@@ -631,13 +645,13 @@ export class Nymph {
   public async deleteEntity(entity: EntityInterface): Promise<boolean> {
     for (let callback of this.beforeDeleteEntityCallbacks) {
       if (callback) {
-        callback(entity);
+        callback(this, entity);
       }
     }
     const result = this.driver.deleteEntity(entity);
     for (let callback of this.afterDeleteEntityCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -656,13 +670,13 @@ export class Nymph {
   ): Promise<boolean> {
     for (let callback of this.beforeDeleteEntityByIDCallbacks) {
       if (callback) {
-        callback(guid, className);
+        callback(this, guid, className);
       }
     }
     const result = this.driver.deleteEntityByID(guid, className);
     for (let callback of this.afterDeleteEntityByIDCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -909,5 +923,3 @@ export class Nymph {
     return true;
   }
 }
-
-export default new Nymph();

package/src/Nymph.types.ts

@@ -1,5 +1,5 @@
 import { EntityConstructor, EntityInterface } from './Entity.types';
-import { Nymph } from './Nymph';
+import Nymph from './Nymph';
 
 export type NymphEventType =
   | 'connect'
@@ -21,43 +21,83 @@ export type NymphEventType =
   | 'afterRenameUID'
   | 'beforeDeleteUID'
   | 'afterDeleteUID';
-export type NymphConnectCallback = (result: Promise<boolean>) => void;
-export type NymphDisconnectCallback = (result: Promise<boolean>) => void;
+export type NymphConnectCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
+export type NymphDisconnectCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
 /** The NymphQueryCallback will be called on both top level and qref queries. */
 export type NymphQueryCallback = (
+  nymph: Nymph,
   options: Options,
   selectors: FormattedSelector[]
 ) => void;
 export type NymphBeforeGetEntityCallback = (
+  nymph: Nymph,
   options: Options,
   selectors: Selector[]
 ) => void;
 export type NymphBeforeGetEntitiesCallback = (
+  nymph: Nymph,
   options: Options,
   selectors: Selector[]
 ) => void;
-export type NymphBeforeSaveEntityCallback = (entity: EntityInterface) => void;
-export type NymphAfterSaveEntityCallback = (result: Promise<boolean>) => void;
-export type NymphBeforeDeleteEntityCallback = (entity: EntityInterface) => void;
-export type NymphAfterDeleteEntityCallback = (result: Promise<boolean>) => void;
+export type NymphBeforeSaveEntityCallback = (
+  nymph: Nymph,
+  entity: EntityInterface
+) => void;
+export type NymphAfterSaveEntityCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
+export type NymphBeforeDeleteEntityCallback = (
+  nymph: Nymph,
+  entity: EntityInterface
+) => void;
+export type NymphAfterDeleteEntityCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
 export type NymphBeforeDeleteEntityByIDCallback = (
+  nymph: Nymph,
   guid: string,
   className?: string
 ) => void;
 export type NymphAfterDeleteEntityByIDCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
+export type NymphBeforeNewUIDCallback = (nymph: Nymph, name: string) => void;
+export type NymphAfterNewUIDCallback = (
+  nymph: Nymph,
+  result: Promise<number | null>
+) => void;
+export type NymphBeforeSetUIDCallback = (
+  nymph: Nymph,
+  name: string,
+  value: number
+) => void;
+export type NymphAfterSetUIDCallback = (
+  nymph: Nymph,
   result: Promise<boolean>
 ) => void;
-export type NymphBeforeNewUIDCallback = (name: string) => void;
-export type NymphAfterNewUIDCallback = (result: Promise<number | null>) => void;
-export type NymphBeforeSetUIDCallback = (name: string, value: number) => void;
-export type NymphAfterSetUIDCallback = (result: Promise<boolean>) => void;
 export type NymphBeforeRenameUIDCallback = (
+  nymph: Nymph,
   oldName: string,
   newName: string
 ) => void;
-export type NymphAfterRenameUIDCallback = (result: Promise<boolean>) => void;
-export type NymphBeforeDeleteUIDCallback = (name: string) => void;
-export type NymphAfterDeleteUIDCallback = (result: Promise<boolean>) => void;
+export type NymphAfterRenameUIDCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
+export type NymphBeforeDeleteUIDCallback = (nymph: Nymph, name: string) => void;
+export type NymphAfterDeleteUIDCallback = (
+  nymph: Nymph,
+  result: Promise<boolean>
+) => void;
 
 export type Options<T extends EntityConstructor = EntityConstructor> = {
   class?: T;
@@ -186,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'][];
@@ -238,14 +278,24 @@ export type FormattedSelector = {
   '!selector'?: FormattedSelector['selector'];
 };
 
+export enum TilmeldAccessLevels {
+  NO_ACCESS = 0,
+  READ_ACCESS = 1,
+  WRITE_ACCESS = 2,
+  // Keeping 3 open in case we ever need one between write and full.
+  FULL_ACCESS = 4,
+}
+
 export interface TilmeldInterface {
   nymph: Nymph;
   request: any;
   response: any;
   init(nymph: Nymph): void;
+  clone(): 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

@@ -3,7 +3,7 @@ import { difference } from 'lodash';
 import ReadLines from 'n-readlines';
 import strtotime from 'locutus/php/datetime/strtotime';
 
-import type { Nymph } from '../Nymph';
+import type Nymph from '../Nymph';
 import newGUID from '../newGUID';
 import {
   EntityConstructor,

package/src/driver/index.ts

@@ -1,7 +1,4 @@
 import NymphDriver from './NymphDriver';
 export { NymphDriver };
 
-import PreInitializedDriver from './PreInitializedDriver';
-export { PreInitializedDriver };
-
 export * from './testArtifacts';

package/src/driver/testArtifacts.ts

@@ -1,11 +1,17 @@
 import fs from 'fs';
 import strtotime from 'locutus/php/datetime/strtotime';
 
+import type Nymph from '../Nymph';
 import newGUID from '../newGUID';
-import nymph from '../Nymph';
 import { TestBModel, TestModel, TestModelData } from '../testArtifacts';
 
-export function QueriesTest(it: (name: string, fn: () => void) => void) {
+export function QueriesTest(
+  nymph: Nymph,
+  it: (name: string, fn: () => void) => void
+) {
+  nymph.addEntityClass(TestModel);
+  nymph.addEntityClass(TestBModel);
+
   let testEntity: TestModel & TestModelData;
   let testGuid: string;
   let refGuid: string;
@@ -1669,7 +1675,13 @@ This one's zip code is 92064.`;
   });
 }
 
-export function UIDTest(it: (name: string, fn: () => void) => void) {
+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);
@@ -1707,7 +1719,13 @@ export function UIDTest(it: (name: string, fn: () => void) => void) {
   });
 }
 
-export function ExportImportTest(it: (name: string, fn: () => void) => void) {
+export function ExportImportTest(
+  nymph: Nymph,
+  it: (name: string, fn: () => void) => void
+) {
+  nymph.addEntityClass(TestModel);
+  nymph.addEntityClass(TestBModel);
+
   async function deleteTestData() {
     let all = await nymph.getEntities({ class: TestModel });
     expect(Array.isArray(all)).toEqual(true);

package/src/index.ts

@@ -14,7 +14,10 @@ export { newGUID };
 export * from './Nymph.types';
 
 export * from './Nymph';
-import nymph from './Nymph';
-export default nymph;
+import Nymph from './Nymph';
+export { Nymph };
+
+import nymphJoiProps from './nymphJoiProps';
+export { nymphJoiProps };
 
 export * from './utils';

package/src/nymphJoiProps.ts

@@ -0,0 +1,24 @@
+import Joi from 'joi';
+
+export default {
+  guid: Joi.alternatives()
+    .try(
+      Joi.any().only().allow(null),
+      Joi.string().trim(false).length(24).hex()
+    )
+    .required(),
+  cdate: Joi.alternatives()
+    .try(Joi.any().only().allow(null), Joi.number())
+    .required(),
+  mdate: Joi.alternatives()
+    .try(Joi.any().only().allow(null), Joi.number())
+    .required(),
+  tags: Joi.array()
+    .items(
+      Joi.string().pattern(/[[\x01-\x1F\x7F]]/, {
+        name: 'control characters',
+        invert: true,
+      })
+    )
+    .required(),
+};

package/src/testArtifacts.ts

@@ -1,5 +1,4 @@
 import Entity from './Entity';
-import nymph from './Nymph';
 
 export type TestModelData = {
   name?: string;
@@ -72,8 +71,6 @@ export class TestModel extends Entity<TestModelData> {
   }
 }
 
-nymph.setEntityClass(TestModel.class, TestModel);
-
 /**
  * This class is a test class that extends the Entity class.
  */
@@ -89,5 +86,3 @@ export class TestBModel extends TestModel {
     return super.factorySync(guid) as TestBModel & TestModelData;
   }
 }
-
-nymph.setEntityClass(TestBModel.class, TestBModel);