@nymphjs/server 1.0.0-beta.45 → 1.0.0-beta.47

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.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/server
+
+# [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/server
+
 # [1.0.0-beta.45](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.44...v1.0.0-beta.45) (2023-07-17)
 
 **Note:** Version bump only for package @nymphjs/server

package/README.md

@@ -28,7 +28,7 @@ const nymph = new Nymph(
   {},
   new SQLite3Driver({
     filename: ':memory:',
-  })
+  }),
 );
 const MyEntity = nymph.addEntityClass(MyEntityClass);
 
@@ -87,7 +87,7 @@ const nymph = new Nymph(
   new SQLite3Driver({
     filename: ':memory:',
   }),
-  tilmeld
+  tilmeld,
 );
 const MyEntity = nymph.addEntityClass(MyEntityClass);
 
@@ -123,8 +123,8 @@ app.user(
     {
       restUrl: 'https://mydomain.tld/rest',
     },
-    nymph
-  )
+    nymph,
+  ),
 );
 
 // Do anything else you need to do...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nymphjs/server",
-  "version": "1.0.0-beta.45",
+  "version": "1.0.0-beta.47",
   "description": "Nymph.js - REST Server",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -31,21 +31,21 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@nymphjs/nymph": "^1.0.0-beta.45",
+    "@nymphjs/nymph": "^1.0.0-beta.47",
     "cookie-parser": "^1.4.6",
     "express": "^4.18.2"
   },
   "devDependencies": {
-    "@nymphjs/client": "^1.0.0-beta.45",
-    "@nymphjs/client-node": "^1.0.0-beta.45",
-    "@nymphjs/driver-sqlite3": "^1.0.0-beta.45",
-    "@tsconfig/recommended": "^1.0.2",
-    "@types/cookie-parser": "^1.4.3",
-    "@types/express": "^4.17.17",
-    "@types/jest": "^29.5.2",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.1.3"
+    "@nymphjs/client": "^1.0.0-beta.47",
+    "@nymphjs/client-node": "^1.0.0-beta.47",
+    "@nymphjs/driver-sqlite3": "^1.0.0-beta.47",
+    "@tsconfig/recommended": "^1.0.3",
+    "@types/cookie-parser": "^1.4.6",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.8",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
-  "gitHead": "54e7585f6b1cd6c920e47e01414dfc427eb73886"
+  "gitHead": "228f0d25911d1b98859f2acf8ace3d3f251c4882"
 }

package/src/cache.test.ts

@@ -48,7 +48,7 @@ describe('Nymph REST Server and Client with Client Weak Ref Cache', () => {
     // @ts-ignore TS doesn't know about WeakRef.
     if (typeof WeakRef === 'undefined') {
       throw new Error(
-        'You must run this test in an environment that includes WeakRef.'
+        'You must run this test in an environment that includes WeakRef.',
       );
     }
 
@@ -61,7 +61,7 @@ describe('Nymph REST Server and Client with Client Weak Ref Cache', () => {
     const checkA = await Employee.factory(employee.guid);
     const checkB = await nymph.getEntity(
       { class: Employee },
-      { type: '&', guid: employee.guid }
+      { type: '&', guid: employee.guid },
     );
 
     if (!checkB) {

package/src/createServer.ts

@@ -43,7 +43,7 @@ export class ForbiddenClassError extends Error {
  */
 export function createServer(
   nymph: Nymph,
-  { jsonOptions = {} }: { jsonOptions?: OptionsJson } = {}
+  { jsonOptions = {} }: { jsonOptions?: OptionsJson } = {},
 ) {
   const rest = express();
   rest.use(cookieParser());
@@ -52,7 +52,7 @@ export function createServer(
   function instantiateNymph(
     _request: Request,
     response: NymphResponse,
-    next: NextFunction
+    next: NextFunction,
   ) {
     response.locals.nymph = nymph.clone();
     next();
@@ -61,7 +61,7 @@ export function createServer(
   async function authenticateTilmeld(
     request: Request,
     response: NymphResponse,
-    next: NextFunction
+    next: NextFunction,
   ) {
     if (response.locals.nymph.tilmeld) {
       response.locals.nymph.tilmeld.request = request;
@@ -79,7 +79,7 @@ export function createServer(
   function unauthenticateTilmeld(
     _request: Request,
     response: NymphResponse,
-    next: NextFunction
+    next: NextFunction,
   ) {
     if (response.locals.nymph.tilmeld) {
       response.locals.nymph.tilmeld.request = null;
@@ -163,7 +163,7 @@ export function createServer(
           selectors = classNamesToEntityConstructors(
             response.locals.nymph,
             selectors,
-            true
+            true,
           );
         } catch (e: any) {
           if (e?.message === 'Not accessible.') {
@@ -185,12 +185,12 @@ export function createServer(
           if (action === 'entity') {
             result = await response.locals.nymph.getEntity(
               options,
-              ...selectors
+              ...selectors,
             );
           } else {
             result = await response.locals.nymph.getEntities(
               options,
-              ...selectors
+              ...selectors,
             );
           }
         } catch (e: any) {
@@ -217,7 +217,7 @@ export function createServer(
           if (
             !(await response.locals.nymph.tilmeld.checkClientUIDPermissions(
               data,
-              TilmeldAccessLevels.READ_ACCESS
+              TilmeldAccessLevels.READ_ACCESS,
             ))
           ) {
             httpError(response, 403);
@@ -345,7 +345,7 @@ export function createServer(
         try {
           const params = referencesToEntities(
             [...data.params],
-            response.locals.nymph
+            response.locals.nymph,
           );
           if (data.static) {
             let EntityClass: EntityConstructor;
@@ -396,7 +396,7 @@ export function createServer(
                   | Iterator<any, any, boolean>
                   | AsyncIterator<any, any, boolean> = method.call(
                   EntityClass,
-                  ...params
+                  ...params,
                 );
                 let sequence = result;
                 if (result instanceof Promise) {
@@ -505,7 +505,7 @@ export function createServer(
           if (
             !(await response.locals.nymph.tilmeld.checkClientUIDPermissions(
               data,
-              TilmeldAccessLevels.WRITE_ACCESS
+              TilmeldAccessLevels.WRITE_ACCESS,
             ))
           ) {
             httpError(response, 403);
@@ -565,7 +565,7 @@ export function createServer(
     response: NymphResponse,
     action: string,
     data: any,
-    patch: boolean
+    patch: boolean,
   ) {
     if (action === 'uid') {
       if (typeof data.name !== 'string' || typeof data.value !== 'number') {
@@ -576,7 +576,7 @@ export function createServer(
         if (
           !(await response.locals.nymph.tilmeld.checkClientUIDPermissions(
             data.name,
-            TilmeldAccessLevels.FULL_ACCESS
+            TilmeldAccessLevels.FULL_ACCESS,
           ))
         ) {
           httpError(response, 403);
@@ -716,7 +716,7 @@ export function createServer(
           try {
             entity = await response.locals.nymph.getEntity(
               { class: EntityClass },
-              { type: '&', guid: entData.guid }
+              { type: '&', guid: entData.guid },
             );
           } catch (e: any) {
             lastException = e;
@@ -765,7 +765,7 @@ export function createServer(
           if (
             !(await response.locals.nymph.tilmeld.checkClientUIDPermissions(
               data,
-              TilmeldAccessLevels.FULL_ACCESS
+              TilmeldAccessLevels.FULL_ACCESS,
             ))
           ) {
             httpError(response, 403);
@@ -800,12 +800,12 @@ export function createServer(
     entityData: EntityJson | EntityPatch,
     nymph: Nymph,
     patch = false,
-    allowConflict = false
+    allowConflict = false,
   ): Promise<EntityInterface> {
     if (entityData.class === 'Entity') {
       // Don't let clients use the `Entity` class, since it has no validity/AC checks.
       throw new InvalidParametersError(
-        "Can't use Entity class directly from the front end."
+        "Can't use Entity class directly from the front end.",
       );
     }
     let EntityClass = nymph.getEntityClass(entityData.class);
@@ -819,7 +819,7 @@ export function createServer(
         {
           type: '&',
           guid: `${entityData['guid']}`,
-        }
+        },
       );
       if (entity === null) {
         throw new Error(NOT_FOUND_ERROR);
@@ -878,7 +878,7 @@ export function createServer(
   function httpError(
     res: NymphResponse,
     defaultStatusCode: number,
-    error?: Error & { status?: number; statusText?: string }
+    error?: Error & { status?: number; statusText?: string },
   ) {
     const status = error?.status || defaultStatusCode;
     const statusText =
@@ -923,7 +923,7 @@ export function createServer(
   function eventStreamError(
     res: NymphResponse,
     defaultStatusCode: number,
-    error?: Error & { status?: number; statusText?: string }
+    error?: Error & { status?: number; statusText?: string },
   ) {
     const status = error?.status || defaultStatusCode;
     const statusText =

package/src/index.test.ts

@@ -134,7 +134,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         ref: ['subordinates', jane],
-      }
+      },
     );
 
     expect(checkSteve?.guid).toEqual(steve.guid);
@@ -147,7 +147,7 @@ describe('Nymph REST Server and Client', () => {
           'subordinates',
           [{ class: Employee }, { type: '&', guid: jane.guid }],
         ],
-      }
+      },
     );
 
     expect(checkSteveQref?.guid).toEqual(steve.guid);
@@ -161,7 +161,7 @@ describe('Nymph REST Server and Client', () => {
     expect(entity.$hasTag('test', 'test2')).toEqual(true);
     entity.$addTag('test', 'test3', 'test4', 'test5', 'test6');
     expect(entity.$hasTag('test', 'test3', 'test4', 'test5', 'test6')).toEqual(
-      true
+      true,
     );
     entity.$removeTag('test2');
     expect(!entity.$hasTag('test2')).toEqual(true);
@@ -237,7 +237,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         equal: ['name', 'Jane Doe'],
-      }
+      },
     );
 
     expect(jane).not.toBeNull();
@@ -257,7 +257,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         tag: ['employee'],
-      }
+      },
     );
 
     expect(entities.length).toEqual(4);
@@ -283,13 +283,13 @@ describe('Nymph REST Server and Client', () => {
 
     const resultSelectors = await nymph.getEntities(
       { class: Employee },
-      { type: '&', equal: ['name', 'Jane Doe'] }
+      { type: '&', equal: ['name', 'Jane Doe'] },
     );
 
     // Testing count return with selectors...
     const resultSelectorsCount = await nymph.getEntities(
       { class: Employee, return: 'count' },
-      { type: '&', equal: ['name', 'Jane Doe'] }
+      { type: '&', equal: ['name', 'Jane Doe'] },
     );
     expect(resultSelectorsCount).toBeGreaterThanOrEqual(1);
     expect(resultSelectorsCount).toEqual(resultSelectors.length);
@@ -312,7 +312,7 @@ describe('Nymph REST Server and Client', () => {
     // Testing empty count...
     const resultSelectorsEmpty = await nymph.getEntities(
       { class: Employee, return: 'count' },
-      { type: '&', tag: 'pickle' }
+      { type: '&', tag: 'pickle' },
     );
     expect(resultSelectorsEmpty).toEqual(0);
   });
@@ -331,7 +331,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         tag: 'employee',
-      }
+      },
     );
 
     expect(entities.length).toEqual(4);
@@ -357,7 +357,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         like: ['name', '%Jane%'],
-      }
+      },
     );
 
     expect(entities.length).toEqual(4);
@@ -383,7 +383,7 @@ describe('Nymph REST Server and Client', () => {
           type: '|',
           like: ['name', '%Jane%'],
         },
-      }
+      },
     );
 
     expect(entities.length).toEqual(4);
@@ -418,7 +418,7 @@ describe('Nymph REST Server and Client', () => {
             },
           ],
         },
-      }
+      },
     );
 
     expect(entities.length).toEqual(4);
@@ -443,7 +443,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         guid,
-      }
+      },
     );
 
     expect(check.length).toEqual(0);
@@ -466,7 +466,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '|',
         guid: guids,
-      }
+      },
     );
 
     expect(check.length).toEqual(0);
@@ -483,7 +483,7 @@ describe('Nymph REST Server and Client', () => {
       error = e;
     }
     expect(error.message).toEqual(
-      "Can't use Entity class directly from the front end."
+      "Can't use Entity class directly from the front end.",
     );
   });
 
@@ -623,7 +623,7 @@ describe('Nymph REST Server and Client', () => {
       {
         class: Employee,
       },
-      jane1.guid
+      jane1.guid,
     );
     if (jane1 == null || jane2 == null) {
       throw new Error('Entity is null.');
@@ -649,7 +649,7 @@ describe('Nymph REST Server and Client', () => {
       {
         class: Employee,
       },
-      first.guid
+      first.guid,
     );
 
     if (second == null || second.guid == null) {
@@ -681,7 +681,7 @@ describe('Nymph REST Server and Client', () => {
       {
         class: Employee,
       },
-      first.guid
+      first.guid,
     );
 
     if (second == null || second.guid == null) {
@@ -704,7 +704,7 @@ describe('Nymph REST Server and Client', () => {
       {
         type: '&',
         '!guid': first.guid,
-      }
+      },
     );
 
     if (third == null || third.guid == null) {

package/src/testArtifacts.ts

@@ -64,7 +64,7 @@ export class EmployeeModel extends EntityServer<EmployeeModelData> {
   ];
 
   static async factory(
-    guid?: string
+    guid?: string,
   ): Promise<EmployeeModel & EmployeeModelData> {
     return (await super.factory(guid)) as EmployeeModel & EmployeeModelData;
   }
@@ -132,7 +132,7 @@ export class EmployeeModel extends EntityServer<EmployeeModelData> {
 
     if (!aborted) {
       throw new Error(
-        "testStaticIterableAbort wasn't aborted after the first iteration."
+        "testStaticIterableAbort wasn't aborted after the first iteration.",
       );
     }
   }
@@ -144,7 +144,7 @@ export class EmployeeModel extends EntityServer<EmployeeModelData> {
   public static *throwErrorStaticIterable() {
     yield 1;
     throw new BadFunctionCallError(
-      'This function throws errors after the first iteration.'
+      'This function throws errors after the first iteration.',
     );
   }
 
@@ -253,7 +253,7 @@ export class RestrictedModel extends EntityServer<RestrictedModelData> {
   public static restEnabled = false;
 
   static async factory(
-    guid?: string
+    guid?: string,
   ): Promise<RestrictedModel & RestrictedModelData> {
     return (await super.factory(guid)) as RestrictedModel & RestrictedModelData;
   }
@@ -334,7 +334,7 @@ export class PubSubDisabledModel extends EntityServer<PubSubDisabledModelData> {
   public static pubSubEnabled = false;
 
   static async factory(
-    guid?: string
+    guid?: string,
   ): Promise<PubSubDisabledModel & PubSubDisabledModelData> {
     return (await super.factory(guid)) as PubSubDisabledModel &
       PubSubDisabledModelData;
@@ -378,7 +378,7 @@ export class PubSubDisabled extends Entity<PubSubDisabledData> {
   }
 
   static async factory(
-    guid?: string
+    guid?: string,
   ): Promise<PubSubDisabled & PubSubDisabledData> {
     return (await super.factory(guid)) as PubSubDisabled & PubSubDisabledData;
   }