@nymphjs/nymph 1.0.0-beta.46 → 1.0.0-beta.48

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-beta.48](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.47...v1.0.0-beta.48) (2023-11-10)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.47](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.46...v1.0.0-beta.47) (2023-11-10)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
 # [1.0.0-beta.46](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.45...v1.0.0-beta.46) (2023-08-29)
 
 **Note:** Version bump only for package @nymphjs/nymph

package/README.md

@@ -46,7 +46,7 @@ async function run() {
 
   const otherPendingTodos = await nymph.getEntities(
     { class: Todo },
-    { type: '&', '!guid': myEntity.guid, equal: ['done', false] }
+    { type: '&', '!guid': myEntity.guid, equal: ['done', false] },
   );
 
   const total = otherPendingTodos.length;
@@ -54,7 +54,7 @@ async function run() {
   console.log(
     `Besides the one I just created, there ${
       single ? 'is' : 'are'
-    } ${total} pending todo${single ? '' : 's'} in the database.`
+    } ${total} pending todo${single ? '' : 's'} in the database.`,
   );
 }
 ```
@@ -95,7 +95,7 @@ export default class Todo extends Entity<TodoData> {
     // instance of Nymph, so it could be a transactional instance.
     const otherTodos = await this.$nymph.getEntities(
       { class: Todo },
-      { type: '!&', guid: this.guid }
+      { type: '!&', guid: this.guid },
     );
     return otherTodos;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nymphjs/nymph",
-  "version": "1.0.0-beta.46",
+  "version": "1.0.0-beta.48",
   "description": "Nymph.js - Nymph ORM",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -31,21 +31,21 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@nymphjs/guid": "^1.0.0-beta.46",
-    "joi": "^17.9.2",
+    "@nymphjs/guid": "^1.0.0-beta.48",
+    "joi": "^17.11.0",
     "locutus": "^2.0.16",
     "lodash": "^4.17.21",
     "n-readlines": "^1.0.3"
   },
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.2",
-    "@types/jest": "^29.5.2",
-    "@types/locutus": "^0.0.6",
-    "@types/lodash": "^4.14.195",
-    "@types/n-readlines": "^1.0.3",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.1.3"
+    "@tsconfig/recommended": "^1.0.3",
+    "@types/jest": "^29.5.8",
+    "@types/locutus": "^0.0.8",
+    "@types/lodash": "^4.14.201",
+    "@types/n-readlines": "^1.0.6",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
-  "gitHead": "25431d66afea7c1a3299b9588afdd79960d82885"
+  "gitHead": "a2414ef7bf088f3da7683827753d88a769d3952c"
 }

package/src/Entity.test.ts

@@ -142,7 +142,7 @@ describe('Entity', () => {
     await testEntity.$refresh();
 
     expect(testEntityCopy.mdate ?? Infinity).toBeLessThanOrEqual(
-      testEntity.mdate ?? 0
+      testEntity.mdate ?? 0,
     );
   });
 
@@ -162,7 +162,7 @@ describe('Entity', () => {
     expect(testEntity.$hasTag('test', 'test2')).toEqual(true);
     testEntity.$addTag('test', 'test3', 'test4', 'test5', 'test6');
     expect(
-      testEntity.$hasTag('test', 'test3', 'test4', 'test5', 'test6')
+      testEntity.$hasTag('test', 'test3', 'test4', 'test5', 'test6'),
     ).toEqual(true);
     testEntity.$removeTag('test2');
     expect(testEntity.$hasTag('test2')).toEqual(false);

package/src/Entity.ts

@@ -249,7 +249,7 @@ export default class Entity<T extends EntityData = EntityData>
           data[name] = referencesToEntities(
             JSON.parse(this.$sdata[name]),
             this.$nymph,
-            this.$skipAc
+            this.$skipAc,
           );
           delete this.$sdata[name];
         }
@@ -284,7 +284,7 @@ export default class Entity<T extends EntityData = EntityData>
       defineProperty: (
         data: EntityData,
         name: string,
-        descriptor: PropertyDescriptor
+        descriptor: PropertyDescriptor,
       ) => {
         this.$check();
 
@@ -302,7 +302,7 @@ export default class Entity<T extends EntityData = EntityData>
           data[name] = referencesToEntities(
             JSON.parse(this.$sdata[name]),
             this.$nymph,
-            this.$skipAc
+            this.$skipAc,
           );
           delete this.$sdata[name];
         }
@@ -313,7 +313,7 @@ export default class Entity<T extends EntityData = EntityData>
         this.$check();
 
         return Object.getOwnPropertyNames(data).concat(
-          Object.getOwnPropertyNames(this.$sdata)
+          Object.getOwnPropertyNames(this.$sdata),
         );
       },
     };
@@ -389,7 +389,7 @@ export default class Entity<T extends EntityData = EntityData>
       defineProperty: (
         entity: Entity,
         name: string,
-        descriptor: PropertyDescriptor
+        descriptor: PropertyDescriptor,
       ) => {
         if (
           typeof name !== 'string' ||
@@ -426,7 +426,7 @@ export default class Entity<T extends EntityData = EntityData>
       ownKeys: (entity: Entity) => {
         this.$check();
         return Object.getOwnPropertyNames(entity).concat(
-          Object.getOwnPropertyNames(entity.$data)
+          Object.getOwnPropertyNames(entity.$data),
         );
       },
     }) as Entity<T>;
@@ -439,7 +439,7 @@ export default class Entity<T extends EntityData = EntityData>
         {
           class: this as any as EntityConstructor,
         },
-        { type: '&', guid }
+        { type: '&', guid },
       );
       if (entity != null) {
         return entity;
@@ -676,7 +676,7 @@ export default class Entity<T extends EntityData = EntityData>
 
     if (this.guid != input.guid) {
       throw new EntityConflictError(
-        'Tried to accept JSON input for the wrong entity.'
+        'Tried to accept JSON input for the wrong entity.',
       );
     }
 
@@ -726,10 +726,10 @@ export default class Entity<T extends EntityData = EntityData>
           (this.constructor as typeof Entity).class !== 'Group') ||
         !(this.$nymph.tilmeld as any).currentUser ||
         (!(this.$nymph.tilmeld as any).currentUser.abilities?.includes(
-          'tilmeld/admin'
+          'tilmeld/admin',
         ) &&
           !(this.$nymph.tilmeld as any).currentUser.abilities?.includes(
-            'system/admin'
+            'system/admin',
           ))
       ) {
         protectedProps.push('user');
@@ -771,7 +771,7 @@ export default class Entity<T extends EntityData = EntityData>
 
     if (this.guid != patch.guid) {
       throw new EntityConflictError(
-        'Tried to accept JSON patch for the wrong entity.'
+        'Tried to accept JSON patch for the wrong entity.',
       );
     }
 
@@ -796,10 +796,10 @@ export default class Entity<T extends EntityData = EntityData>
           (this.constructor as typeof Entity).class !== 'Group') ||
         !(this.$nymph.tilmeld as any).currentUser ||
         (!(this.$nymph.tilmeld as any).currentUser.abilities?.includes(
-          'tilmeld/admin'
+          'tilmeld/admin',
         ) &&
           !(this.$nymph.tilmeld as any).currentUser.abilities?.includes(
-            'system/admin'
+            'system/admin',
           ))
       ) {
         protectedProps.push('user');
@@ -819,7 +819,7 @@ export default class Entity<T extends EntityData = EntityData>
       (this.$data as any)[name] = referencesToEntities(
         patch.set[name],
         this.$nymph,
-        this.$skipAc
+        this.$skipAc,
       );
     }
 
@@ -872,7 +872,7 @@ export default class Entity<T extends EntityData = EntityData>
       (this.$dataStore as any)[name] = referencesToEntities(
         data[name],
         this.$nymph,
-        this.$skipAc
+        this.$skipAc,
       );
     }
     this.$sdata = mySdata;
@@ -895,14 +895,14 @@ export default class Entity<T extends EntityData = EntityData>
     ) {
       throw new InvalidParametersError(
         'referenceSleep expects parameter 1 to be a valid Nymph entity ' +
-          'reference.'
+          'reference.',
       );
     }
     const thisClass: string = (this.constructor as any).class;
     if (reference[2] !== thisClass) {
       throw new InvalidParametersError(
         'referenceSleep can only be called with an entity reference of the ' +
-          `same class. Given class: ${reference[2]}; this class: ${thisClass}.`
+          `same class. Given class: ${reference[2]}; this class: ${thisClass}.`,
       );
     }
     this.$isASleepingReference = true;
@@ -916,7 +916,7 @@ export default class Entity<T extends EntityData = EntityData>
   protected $check() {
     if (this.$isASleepingReference || this.$sleepingReference != null) {
       throw new EntityIsSleepingReferenceError(
-        'This entity is in a sleeping reference state. You must use .$wake() to wake it.'
+        'This entity is in a sleeping reference state. You must use .$wake() to wake it.',
       );
     }
   }
@@ -938,12 +938,12 @@ export default class Entity<T extends EntityData = EntityData>
     }
     if (this.$sleepingReference?.[1] == null) {
       throw new InvalidStateError(
-        'Tried to wake a sleeping reference with no GUID.'
+        'Tried to wake a sleeping reference with no GUID.',
       );
     }
     if (!this.$wakePromise) {
       const EntityClass = this.$nymph.getEntityClass(
-        this.$sleepingReference[2]
+        this.$sleepingReference[2],
       );
       this.$wakePromise = this.$nymph
         .getEntity(
@@ -951,14 +951,14 @@ export default class Entity<T extends EntityData = EntityData>
             class: EntityClass,
             skipAc: this.$skipAc,
           },
-          { type: '&', guid: this.$sleepingReference[1] }
+          { type: '&', guid: this.$sleepingReference[1] },
         )
         .then((entity) => {
           if (entity == null || entity.guid == null) {
             return Promise.reject(
               new InvalidStateError(
-                'The sleeping reference could not be retrieved.'
-              )
+                'The sleeping reference could not be retrieved.',
+              ),
             );
           }
           this.$isASleepingReference = false;
@@ -1011,7 +1011,7 @@ export default class Entity<T extends EntityData = EntityData>
         if (promises.length) {
           Promise.all(promises).then(
             () => resolve(this),
-            (errObj) => reject(errObj)
+            (errObj) => reject(errObj),
           );
         } else {
           resolve(this);
@@ -1035,12 +1035,12 @@ export default class Entity<T extends EntityData = EntityData>
     const refresh = await this.$nymph.getEntity(
       {
         class: this.$nymph.getEntityClass(
-          this.constructor as EntityConstructor
+          this.constructor as EntityConstructor,
         ),
         skipCache: true,
         skipAc: this.$skipAc,
       },
-      { type: '&', guid: this.guid }
+      { type: '&', guid: this.guid },
     );
     if (refresh == null) {
       return 0;

package/src/Nymph.ts

@@ -138,7 +138,7 @@ export default class Nymph {
     config: Partial<Config>,
     driver: NymphDriver,
     tilmeld?: TilmeldInterface,
-    parent?: Nymph
+    parent?: Nymph,
   ) {
     this.config = { ...defaults, ...config };
     this.driver = driver;
@@ -244,7 +244,7 @@ export default class Nymph {
   public getEntityClass<T extends EntityConstructor>(className: T): T;
   public getEntityClass(className: string): EntityConstructor;
   public getEntityClass<T extends EntityConstructor = EntityConstructor>(
-    className: T | string
+    className: T | string,
   ): T | EntityConstructor {
     let key: string | null = null;
     if (typeof className === 'string') {
@@ -268,7 +268,7 @@ export default class Nymph {
       this.config,
       this.driver.clone(),
       this.tilmeld?.clone(),
-      this
+      this,
     );
   }
 
@@ -791,11 +791,11 @@ export default class Nymph {
   ): Promise<ReturnType<T['factorySync']> | null>;
   public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
-    guid: string
+    guid: string,
   ): Promise<string | null>;
   public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
-    guid: string
+    guid: string,
   ): Promise<ReturnType<T['factorySync']> | null>;
   public async getEntity<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> = {},
@@ -813,7 +813,7 @@ export default class Nymph {
     }
     const entities = await this.driver.getEntities(
       options,
-      ...(selectors as Selector[])
+      ...(selectors as Selector[]),
     );
     if (options.return === 'count') {
       return entities as unknown as number;
@@ -864,7 +864,7 @@ export default class Nymph {
    */
   public async deleteEntityByID(
     guid: string,
-    className?: string
+    className?: string,
   ): Promise<boolean> {
     for (let callback of this.beforeDeleteEntityByIDCallbacks) {
       if (callback) {
@@ -1015,7 +1015,7 @@ export default class Nymph {
       ? NymphBeforeRollbackTransactionCallback
       : T extends 'afterRollbackTransaction'
       ? NymphAfterRollbackTransactionCallback
-      : never
+      : never,
   ) {
     const prop = (event + 'Callbacks') as T extends 'connect'
       ? 'connectCallbacks'
@@ -1156,7 +1156,7 @@ export default class Nymph {
       ? NymphBeforeRollbackTransactionCallback
       : T extends 'afterRollbackTransaction'
       ? NymphAfterRollbackTransactionCallback
-      : never
+      : never,
   ) {
     const prop = (event + 'Callbacks') as T extends 'connect'
       ? 'connectCallbacks'

package/src/Nymph.types.ts

@@ -36,11 +36,11 @@ export type NymphEventType =
   | 'afterRollbackTransaction';
 export type NymphConnectCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphDisconnectCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 /**
  * The NymphQueryCallback will be called on both top level and qref queries.
@@ -56,131 +56,131 @@ export type NymphDisconnectCallback = (
 export type NymphQueryCallback = (
   nymph: Nymph,
   options: Options,
-  selectors: FormattedSelector[]
+  selectors: FormattedSelector[],
 ) => void;
 export type NymphBeforeGetEntityCallback = (
   nymph: Nymph,
   options: Options,
-  selectors: Selector[]
+  selectors: Selector[],
 ) => Promise<void>;
 export type NymphBeforeGetEntitiesCallback = (
   nymph: Nymph,
   options: Options,
-  selectors: Selector[]
+  selectors: Selector[],
 ) => Promise<void>;
 export type NymphBeforeSaveEntityCallback = (
   nymph: Nymph,
-  entity: EntityInterface
+  entity: EntityInterface,
 ) => Promise<void>;
 export type NymphAfterSaveEntityCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedSaveEntityCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeDeleteEntityCallback = (
   nymph: Nymph,
-  entity: EntityInterface
+  entity: EntityInterface,
 ) => Promise<void>;
 export type NymphAfterDeleteEntityCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedDeleteEntityCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeDeleteEntityByIDCallback = (
   nymph: Nymph,
   guid: string,
-  className?: string
+  className?: string,
 ) => Promise<void>;
 export type NymphAfterDeleteEntityByIDCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedDeleteEntityByIDCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeNewUIDCallback = (
   nymph: Nymph,
-  name: string
+  name: string,
 ) => Promise<void>;
 export type NymphAfterNewUIDCallback = (
   nymph: Nymph,
-  result: Promise<number | null>
+  result: Promise<number | null>,
 ) => Promise<void>;
 export type NymphFailedNewUIDCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeSetUIDCallback = (
   nymph: Nymph,
   name: string,
-  value: number
+  value: number,
 ) => Promise<void>;
 export type NymphAfterSetUIDCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedSetUIDCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeRenameUIDCallback = (
   nymph: Nymph,
   oldName: string,
-  newName: string
+  newName: string,
 ) => Promise<void>;
 export type NymphAfterRenameUIDCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedRenameUIDCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeDeleteUIDCallback = (
   nymph: Nymph,
-  name: string
+  name: string,
 ) => Promise<void>;
 export type NymphAfterDeleteUIDCallback = (
   nymph: Nymph,
-  result: Promise<boolean>
+  result: Promise<boolean>,
 ) => Promise<void>;
 export type NymphFailedDeleteUIDCallback = (
   nymph: Nymph,
-  error: any
+  error: any,
 ) => Promise<void>;
 export type NymphBeforeStartTransactionCallback = (
   nymph: Nymph,
-  name: string
+  name: string,
 ) => Promise<void>;
 export type NymphAfterStartTransactionCallback = (
   nymph: Nymph,
   name: string,
-  result: Nymph
+  result: Nymph,
 ) => Promise<void>;
 export type NymphBeforeCommitTransactionCallback = (
   nymph: Nymph,
-  name: string
+  name: string,
 ) => Promise<void>;
 export type NymphAfterCommitTransactionCallback = (
   nymph: Nymph,
   name: string,
-  result: boolean
+  result: boolean,
 ) => Promise<void>;
 export type NymphBeforeRollbackTransactionCallback = (
   nymph: Nymph,
-  name: string
+  name: string,
 ) => Promise<void>;
 export type NymphAfterRollbackTransactionCallback = (
   nymph: Nymph,
   name: string,
-  result: boolean
+  result: boolean,
 ) => Promise<void>;
 
 export type Options<T extends EntityConstructor = EntityConstructor> = {
@@ -383,6 +383,6 @@ export interface TilmeldInterface {
   fillSession(user: any): Promise<void>;
   checkClientUIDPermissions(
     name: string,
-    type?: TilmeldAccessLevels
+    type?: TilmeldAccessLevels,
   ): Promise<boolean>;
 }