@nymphjs/server 1.0.0-alpha.1 → 1.0.0-alpha.5

package/CHANGELOG.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.5](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.4...v1.0.0-alpha.5) (2021-09-30)
+
+**Note:** Version bump only for package @nymphjs/server
+
+# [1.0.0-alpha.4](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.3...v1.0.0-alpha.4) (2021-09-27)
+
+### Features
+
+- gate UIDs on Tilmeld with config and abilities ([99a9141](https://github.com/sciactive/nymphjs/commit/99a9141cc92fe3d1ad68d21e42de4e9b5493e4d9))
+- use new instances of nymph for server and pubsub requests ([0c18fab](https://github.com/sciactive/nymphjs/commit/0c18faba2b55fe82c16806d221fc54d2cd42c992))
+
+# [1.0.0-alpha.3](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.2...v1.0.0-alpha.3) (2021-09-22)
+
+### Features
+
+- allow multiple instances of Nymph Client ([81eacd7](https://github.com/sciactive/nymphjs/commit/81eacd7caff6f3c209d7d6dbfdac0414a1857c6d))
+- move to fully instance based design, no more globals ([c036220](https://github.com/sciactive/nymphjs/commit/c0362209b90a475b8b85269a829b0ec6bed4465f))
+
+# [1.0.0-alpha.2](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.1...v1.0.0-alpha.2) (2021-09-21)
+
+### Features
+
+- allow multiple instances of Nymph, including transactional instances ([8ff8bcf](https://github.com/sciactive/nymphjs/commit/8ff8bcf4d549998faa2b3d86440394d75bcdc202))
+- support qref queries from the client ([3c8bef0](https://github.com/sciactive/nymphjs/commit/3c8bef0251111983b06eb13ad42a2afef80a1446))
+
 # 1.0.0-alpha.1 (2021-09-06)
 
 ### Bug Fixes

package/README.md

@@ -16,25 +16,27 @@ You need to install Express, Nymph, and a Nymph driver, then you can use the RES
 
 ```ts
 import express from 'express';
+import { Nymph } from '@nymphjs/nymph';
 import SQLite3Driver from '@nymphjs/driver-sqlite3';
-import Nymph from '@nymphjs/nymph';
-import rest from '@nymphjs/server';
+import createServer from '@nymphjs/server';
 
 // Import all the entities you will be using on the server.
-import './entities/MyEntity';
+import MyEntity from './entities/MyEntity';
 
 // Configure Nymph.
-const sqliteConfig = {
-  filename: ':memory:',
-};
-
-Nymph.init({}, new SQLite3Driver(sqliteConfig));
+const nymph = new Nymph(
+  {},
+  new SQLite3Driver({
+    filename: ':memory:',
+  })
+);
+nymph.addEntityClass(MyEntity);
 
 // Create your Express app.
 const app = express();
 
-// Use the REST server (with an optional path).
-app.use('/rest', rest);
+// Create and use the REST server (with an optional path).
+app.use('/rest', createServer(nymph));
 
 // Do anything else you need to do...
 
@@ -49,11 +51,14 @@ Now you can configure your client using your server's address (and the optional
 ```ts
 import { Nymph } from '@nymphjs/client';
 
-Nymph.init({
+import MyEntity from './entities/MyEntityClient';
+
+const nymph = new Nymph({
   // You should configure your Express server to
   // use HTTPS, but you don't have to.
   restUrl: 'https://mydomain.tld/rest',
 });
+nymph.addEntityClass(MyEntity);
 ```
 
 # License

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-declare const rest: import("express-serve-static-core").Express;
-export default rest;
+import { Nymph } from '@nymphjs/nymph';
+export default function createServer(nymph: Nymph): import("express-serve-static-core").Express;