@nymphjs/nymph 1.0.0-alpha.3 → 1.0.0-alpha.7

package/src/Nymph.ts

@@ -1,7 +1,7 @@
 import { Config, ConfigDefaults as defaults } from './conf';
 import { NymphDriver } from './driver';
 import Entity from './Entity';
-import { EntityConstructor, EntityInterface } from './Entity.types';
+import { EntityConstructor, EntityData, EntityInterface } from './Entity.types';
 import { ClassNotAvailableError } from './errors';
 import type {
   Selector,
@@ -58,7 +58,12 @@ export default 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,8 @@ export default 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;
   }
 
@@ -114,8 +119,10 @@ export default class Nymph {
       this.tilmeld = tilmeld;
     }
 
-    class NymphEntity extends Entity {}
-    this.setEntityClass(NymphEntity.class, NymphEntity);
+    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) {
@@ -124,14 +131,17 @@ export default class Nymph {
   }
 
   /**
-   * This is used internally by Nymph. Don't call it yourself.
+   * Get a clone of this instance with duplicate classes and event listeners.
+   *
    * @returns A clone of this instance.
    */
   public clone() {
     const nymph = new Nymph(this.config, this.driver, this.tilmeld?.clone());
-    nymph.entityClasses = this.entityClasses;
-    if (nymph.tilmeld) {
-      nymph.tilmeld.init(nymph);
+    for (const name in this.entityClasses) {
+      if (name === 'Entity' || (this.entityClasses[name] as any).skipOnClone) {
+        continue;
+      }
+      nymph.addEntityClass(this.entityClasses[name]);
     }
 
     const events = [
@@ -161,7 +171,7 @@ export default class Nymph {
       // @ts-ignore: The callback should be the right type here.
       const callbacks = this[prop];
       for (let callback of callbacks) {
-        if (callback.tilmeld) {
+        if (callback.skipOnClone) {
           continue;
         }
         nymph.on(event as NymphEventType, callback);
@@ -180,7 +190,7 @@ export default class Nymph {
     const result = this.driver.connect();
     for (let callback of this.connectCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -195,7 +205,7 @@ export default class Nymph {
     const result = this.driver.disconnect();
     for (let callback of this.disconnectCallbacks) {
       if (callback) {
-        callback(result);
+        callback(this, result);
       }
     }
     return await result;
@@ -210,7 +220,7 @@ export default class Nymph {
   ) {
     for (let callback of this.queryCallbacks) {
       if (callback) {
-        callback(options, selectors);
+        callback(this, options, selectors);
       }
     }
   }
@@ -282,13 +292,13 @@ export default 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;
@@ -313,13 +323,13 @@ export default 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;
@@ -334,13 +344,13 @@ export default 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;
@@ -356,13 +366,13 @@ export default 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;
@@ -382,13 +392,13 @@ export default 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;
@@ -477,10 +487,10 @@ export default 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/
@@ -567,7 +577,7 @@ export default 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);
@@ -613,7 +623,7 @@ export default 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(
@@ -635,13 +645,13 @@ export default 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;
@@ -660,13 +670,13 @@ export default 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;

package/src/Nymph.types.ts

@@ -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;
@@ -238,6 +278,14 @@ 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;
@@ -249,4 +297,5 @@ export interface TilmeldInterface {
   clearSession(): void;
   extractToken(token: string): any;
   fillSession(user: any): void;
+  checkClientUIDPermissions(name: string, type?: TilmeldAccessLevels): boolean;
 }

package/src/driver/testArtifacts.ts

@@ -9,8 +9,8 @@ export function QueriesTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.setEntityClass(TestModel.class, TestModel);
-  nymph.setEntityClass(TestBModel.class, TestBModel);
+  nymph.addEntityClass(TestModel);
+  nymph.addEntityClass(TestBModel);
 
   let testEntity: TestModel & TestModelData;
   let testGuid: string;
@@ -1679,8 +1679,8 @@ export function UIDTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.setEntityClass(TestModel.class, TestModel);
-  nymph.setEntityClass(TestBModel.class, TestBModel);
+  nymph.addEntityClass(TestModel);
+  nymph.addEntityClass(TestBModel);
 
   it('delete old test data', async () => {
     expect(await nymph.deleteUID('TestUID')).toEqual(true);
@@ -1723,8 +1723,8 @@ export function ExportImportTest(
   nymph: Nymph,
   it: (name: string, fn: () => void) => void
 ) {
-  nymph.setEntityClass(TestModel.class, TestModel);
-  nymph.setEntityClass(TestBModel.class, TestBModel);
+  nymph.addEntityClass(TestModel);
+  nymph.addEntityClass(TestBModel);
 
   async function deleteTestData() {
     let all = await nymph.getEntities({ class: TestModel });

package/src/index.ts

@@ -17,4 +17,7 @@ export * from './Nymph';
 import Nymph from './Nymph';
 export { Nymph };
 
+import nymphJoiProps from './nymphJoiProps';
+export { nymphJoiProps };
+
 export * from './utils';

package/src/nymphJoiProps.ts

@@ -0,0 +1,26 @@
+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,
+        })
+        .min(1)
+    )
+    .required(),
+};

package/src/testMocks.ts

@@ -55,7 +55,7 @@ export class MockNymphDriver {
 }
 
 export class MockNymph {
-  public entityClasses: { [k: string]: EntityConstructor } = {};
+  private entityClasses: { [k: string]: EntityConstructor } = {};
   public driver: MockNymphDriver;
   public Tilmeld: any = undefined;
 
@@ -63,11 +63,11 @@ export class MockNymph {
     this.driver = new MockNymphDriver(this);
 
     // class NymphEntity extends Entity {}
-    this.setEntityClass(Entity.class, Entity);
+    this.addEntityClass(Entity);
   }
 
-  public setEntityClass(className: string, entityClass: EntityConstructor) {
-    this.entityClasses[className] = entityClass;
+  public addEntityClass(entityClass: EntityConstructor) {
+    this.entityClasses[entityClass.class] = entityClass;
     entityClass.nymph = this as unknown as Nymph;
   }