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

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);

package/src/testMocks.ts

@@ -1,11 +1,19 @@
+import type Nymph from './Nymph';
 import { EntityConstructor, EntityInterface, EntityJson } from './Entity.types';
 import { Options, Selector } from './Nymph.types';
 import newGUID from './newGUID';
 import { ClassNotAvailableError } from './errors';
+import Entity from './Entity';
 
 const entities: { [k: string]: EntityJson } = {};
 
 export class MockNymphDriver {
+  private nymph: MockNymph;
+
+  public constructor(nymph: MockNymph) {
+    this.nymph = nymph;
+  }
+
   public getEntitySync<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     ...selectors: Selector[]
@@ -33,7 +41,7 @@ export class MockNymphDriver {
     }
 
     const entity: EntityInterface = (
-      (options.class as T) ?? MockNymph.getEntityClass('Entity')
+      (options.class as T) ?? this.nymph.getEntityClass('Entity')
     ).factorySync();
     const entityJson = entities[guid];
     entity.guid = guid;
@@ -47,51 +55,48 @@ export class MockNymphDriver {
 }
 
 export class MockNymph {
-  public static entityClasses: { [k: string]: EntityConstructor } = {};
-  public static driver = new MockNymphDriver();
-  public static Tilmeld: any = undefined;
-
-  public static setEntityClass(
-    className: string,
-    entityClass: EntityConstructor
-  ) {
-    this.entityClasses[className] = entityClass;
+  private entityClasses: { [k: string]: EntityConstructor } = {};
+  public driver: MockNymphDriver;
+  public Tilmeld: any = undefined;
+
+  public constructor() {
+    this.driver = new MockNymphDriver(this);
+
+    // class NymphEntity extends Entity {}
+    this.addEntityClass(Entity);
+  }
+
+  public addEntityClass(entityClass: EntityConstructor) {
+    this.entityClasses[entityClass.class] = entityClass;
+    entityClass.nymph = this as unknown as Nymph;
   }
 
-  public static getEntityClass(className: string): EntityConstructor {
+  public getEntityClass(className: string): EntityConstructor {
     if (className in this.entityClasses) {
-      return this.entityClasses[className];
+      const EntityClass = this.entityClasses[className];
+      EntityClass.nymph = this as unknown as Nymph;
+      return EntityClass;
     }
     throw new ClassNotAvailableError('Tried to use class: ' + className);
   }
 
-  public static async getEntity<
-    T extends EntityConstructor = EntityConstructor
-  >(
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     ...selectors: Selector[]
   ): Promise<string | null>;
-  public static async getEntity<
-    T extends EntityConstructor = EntityConstructor
-  >(
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     ...selectors: Selector[]
   ): Promise<ReturnType<T['factorySync']> | null>;
-  public static async getEntity<
-    T extends EntityConstructor = EntityConstructor
-  >(
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     guid: string
   ): Promise<string | null>;
-  public static async getEntity<
-    T extends EntityConstructor = EntityConstructor
-  >(
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     guid: string
   ): Promise<ReturnType<T['factorySync']> | null>;
-  public static async getEntity<
-    T extends EntityConstructor = EntityConstructor
-  >(
+  public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> = {},
     ...selectors: Selector[] | string[]
   ): Promise<ReturnType<T['factorySync']> | string | null> {
@@ -99,7 +104,7 @@ export class MockNymph {
     return this.driver.getEntitySync(options, ...selectors);
   }
 
-  public static async saveEntity(entity: EntityInterface): Promise<boolean> {
+  public async saveEntity(entity: EntityInterface): Promise<boolean> {
     const className = (entity.constructor as any).class as string;
 
     if (entity.guid == null) {
@@ -127,7 +132,7 @@ export class MockNymph {
     return true;
   }
 
-  public static async deleteEntity(entity: EntityInterface): Promise<boolean> {
+  public async deleteEntity(entity: EntityInterface): Promise<boolean> {
     if (entity.guid != null && entity.guid in entities) {
       delete entities[entity.guid];
       return true;

package/src/utils.ts

@@ -1,5 +1,6 @@
+import Entity from './Entity';
 import { EntityReference } from './Entity.types';
-import { Nymph } from './Nymph';
+import Nymph from './Nymph';
 
 export function xor(a: any, b: any): boolean {
   return !!(a && !b) || (!a && b);
@@ -13,19 +14,17 @@ export function uniqueStrings(array: string[]) {
   return Object.keys(obj);
 }
 
-export function entitiesToReferences(item: any, nymph: Nymph): any {
-  const EntityClass = nymph.getEntityClass('Entity');
-
-  if (item instanceof EntityClass && typeof item.$toReference === 'function') {
+export function entitiesToReferences(item: any): any {
+  if (item instanceof Entity && typeof item.$toReference === 'function') {
     // Convert entities to references.
     return item.$toReference();
   } else if (Array.isArray(item)) {
     // Recurse into lower arrays.
-    return item.map((entry) => entitiesToReferences(entry, nymph));
+    return item.map((entry) => entitiesToReferences(entry));
   } else if (item instanceof Object) {
     let newObj = Object.create(item);
     for (let [key, value] of Object.entries(item)) {
-      newObj[key] = entitiesToReferences(value, nymph);
+      newObj[key] = entitiesToReferences(value);
     }
     return newObj;
   }
@@ -38,8 +37,6 @@ export function referencesToEntities(
   nymph: Nymph,
   useSkipAc = false
 ): any {
-  const Entity = nymph.getEntityClass('Entity');
-
   if (Array.isArray(item)) {
     // Check if it's a reference.
     if (item[0] === 'nymph_entity_reference') {

package/dist/driver/PreInitializedDriver.d.ts

@@ -1,30 +0,0 @@
-import type { Nymph } from '../Nymph';
-import { EntityConstructor, EntityInterface } from '../Entity.types';
-import { Options, Selector } from '../Nymph.types';
-import NymphDriver from './NymphDriver';
-export default class PreInitializedDriver extends NymphDriver {
-    connect(): Promise<boolean>;
-    isConnected(): boolean;
-    startTransaction(_name: string): Promise<Nymph>;
-    commit(_name: string): Promise<boolean>;
-    rollback(_name: string): Promise<boolean>;
-    inTransaction(): Promise<boolean>;
-    deleteEntityByID(_guid: string, _className?: EntityConstructor | string | null): Promise<boolean>;
-    deleteUID(_name: string): Promise<boolean>;
-    disconnect(): Promise<boolean>;
-    protected exportEntities(_writeLine: (line: string) => void): Promise<void>;
-    getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
-        return: 'guid';
-    }, ...selectors: Selector[]): Promise<string[]>;
-    getEntities<T extends EntityConstructor = EntityConstructor>(options?: Options<T>, ...selectors: Selector[]): Promise<ReturnType<T['factorySync']>[]>;
-    protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
-        return: 'guid';
-    }, ...selectors: Selector[]): string[];
-    protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(options?: Options<T>, ...selectors: Selector[]): ReturnType<T['factorySync']>[];
-    getUID(_name: string): Promise<number | null>;
-    import(_filename: string): Promise<boolean>;
-    newUID(_name: string): Promise<number | null>;
-    renameUID(_oldName: string, _newName: string): Promise<boolean>;
-    saveEntity(_entity: EntityInterface): Promise<boolean>;
-    setUID(_name: string, _value: number): Promise<boolean>;
-}

package/dist/driver/PreInitializedDriver.js

@@ -1,65 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const NymphDriver_1 = __importDefault(require("./NymphDriver"));
-const MSG = 'Nymph is not yet initialized!';
-class PreInitializedDriver extends NymphDriver_1.default {
-    connect() {
-        throw new Error(MSG);
-    }
-    isConnected() {
-        throw new Error(MSG);
-    }
-    startTransaction(_name) {
-        throw new Error(MSG);
-    }
-    commit(_name) {
-        throw new Error(MSG);
-    }
-    rollback(_name) {
-        throw new Error(MSG);
-    }
-    inTransaction() {
-        throw new Error(MSG);
-    }
-    deleteEntityByID(_guid, _className) {
-        throw new Error(MSG);
-    }
-    deleteUID(_name) {
-        throw new Error(MSG);
-    }
-    disconnect() {
-        throw new Error(MSG);
-    }
-    exportEntities(_writeLine) {
-        throw new Error(MSG);
-    }
-    getEntities(_options = {}, ..._selectors) {
-        throw new Error(MSG);
-    }
-    getEntitiesSync(_options = {}, ..._selectors) {
-        throw new Error(MSG);
-    }
-    getUID(_name) {
-        throw new Error(MSG);
-    }
-    import(_filename) {
-        throw new Error(MSG);
-    }
-    newUID(_name) {
-        throw new Error(MSG);
-    }
-    renameUID(_oldName, _newName) {
-        throw new Error(MSG);
-    }
-    saveEntity(_entity) {
-        throw new Error(MSG);
-    }
-    setUID(_name, _value) {
-        throw new Error(MSG);
-    }
-}
-exports.default = PreInitializedDriver;
-//# sourceMappingURL=PreInitializedDriver.js.map

package/dist/driver/PreInitializedDriver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PreInitializedDriver.js","sourceRoot":"","sources":["../../src/driver/PreInitializedDriver.ts"],"names":[],"mappings":";;;;;AAGA,gEAAwC;AAExC,MAAM,GAAG,GAAG,+BAA+B,CAAC;AAE5C,MAAqB,oBAAqB,SAAQ,qBAAW;IAC3D,OAAO;QACL,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,WAAW;QACT,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,gBAAgB,CAAC,KAAa;QAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,CAAC,KAAa;QAClB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,QAAQ,CAAC,KAAa;QACpB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,aAAa;QACX,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,gBAAgB,CACd,KAAa,EACb,UAA8C;QAE9C,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,SAAS,CAAC,KAAa;QACrB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,UAAU;QACR,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACS,cAAc,CAAC,UAAkC;QACzD,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IASD,WAAW,CACT,WAAuB,EAAE,EACzB,GAAG,UAAsB;QAEzB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IASS,eAAe,CACvB,WAAuB,EAAE,EACzB,GAAG,UAAsB;QAEzB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,CAAC,KAAa;QAClB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,CAAC,SAAiB;QACtB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,CAAC,KAAa;QAClB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,SAAS,CAAC,QAAgB,EAAE,QAAgB;QAC1C,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,UAAU,CAAC,OAAwB;QACjC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,CAAC,KAAa,EAAE,MAAc;QAClC,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;CACF;AAhFD,uCAgFC"}

package/src/driver/PreInitializedDriver.ts

@@ -1,88 +0,0 @@
-import type { Nymph } from '../Nymph';
-import { EntityConstructor, EntityInterface } from '../Entity.types';
-import { Options, Selector } from '../Nymph.types';
-import NymphDriver from './NymphDriver';
-
-const MSG = 'Nymph is not yet initialized!';
-
-export default class PreInitializedDriver extends NymphDriver {
-  connect(): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  isConnected(): boolean {
-    throw new Error(MSG);
-  }
-  startTransaction(_name: string): Promise<Nymph> {
-    throw new Error(MSG);
-  }
-  commit(_name: string): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  rollback(_name: string): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  inTransaction(): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  deleteEntityByID(
-    _guid: string,
-    _className?: EntityConstructor | string | null
-  ): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  deleteUID(_name: string): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  disconnect(): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  protected exportEntities(_writeLine: (line: string) => void): Promise<void> {
-    throw new Error(MSG);
-  }
-  getEntities<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): Promise<string[]>;
-  getEntities<T extends EntityConstructor = EntityConstructor>(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[]>;
-  getEntities<T extends EntityConstructor = EntityConstructor>(
-    _options: Options<T> = {},
-    ..._selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[] | string[]> {
-    throw new Error(MSG);
-  }
-  protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): string[];
-  protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[];
-  protected getEntitiesSync<T extends EntityConstructor = EntityConstructor>(
-    _options: Options<T> = {},
-    ..._selectors: Selector[]
-  ): ReturnType<T['factorySync']>[] | string[] {
-    throw new Error(MSG);
-  }
-  getUID(_name: string): Promise<number | null> {
-    throw new Error(MSG);
-  }
-  import(_filename: string): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  newUID(_name: string): Promise<number | null> {
-    throw new Error(MSG);
-  }
-  renameUID(_oldName: string, _newName: string): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  saveEntity(_entity: EntityInterface): Promise<boolean> {
-    throw new Error(MSG);
-  }
-  setUID(_name: string, _value: number): Promise<boolean> {
-    throw new Error(MSG);
-  }
-}