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

package/CHANGELOG.md

@@ -3,6 +3,108 @@
 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.23](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.22...v1.0.0-alpha.23) (2021-12-30)
+
+### Features
+
+- add optional weakly referenced cache to client lib ([fbb184c](https://github.com/sciactive/nymphjs/commit/fbb184c6a721968bb92cc9b05c328594618554ed))
+
+# [1.0.0-alpha.22](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.21...v1.0.0-alpha.22) (2021-12-14)
+
+### Features
+
+- update smui to latest versions ([912873b](https://github.com/sciactive/nymphjs/commit/912873b863d1ae5d51c359a3c0558bff38ce85cd))
+
+# [1.0.0-alpha.21](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.20...v1.0.0-alpha.21) (2021-11-29)
+
+### Features
+
+- open sleeping reference props to protected, allow custom property definitions in data proxies ([79779c3](https://github.com/sciactive/nymphjs/commit/79779c35123f8b829f3eb847088e68a58865c76d))
+
+# [1.0.0-alpha.20](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.19...v1.0.0-alpha.20) (2021-11-24)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.19](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.18...v1.0.0-alpha.19) (2021-11-18)
+
+### Features
+
+- update smui and other packages to latest versions ([2465340](https://github.com/sciactive/nymphjs/commit/24653400d887bc04c41c3c4ee0c73ce2f2289e0d))
+
+# [1.0.0-alpha.18](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.17...v1.0.0-alpha.18) (2021-11-09)
+
+### Features
+
+- move entity sorter to its own package and add more features ([ef57460](https://github.com/sciactive/nymphjs/commit/ef57460d88c927a0e3a44b0071f553f1c92708bc))
+
+# [1.0.0-alpha.17](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.16...v1.0.0-alpha.17) (2021-10-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.16](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.15...v1.0.0-alpha.16) (2021-10-14)
+
+### Bug Fixes
+
+- don't ignore built files in npm packages ([7d688db](https://github.com/sciactive/nymphjs/commit/7d688dbec362f1f71fb451a1d0dbcaecc15d99fc))
+
+# [1.0.0-alpha.15](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.14...v1.0.0-alpha.15) (2021-10-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.14](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.13...v1.0.0-alpha.14) (2021-10-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.13](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.12...v1.0.0-alpha.13) (2021-10-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.12](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.11...v1.0.0-alpha.12) (2021-10-13)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.11](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.10...v1.0.0-alpha.11) (2021-10-13)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.10](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.9...v1.0.0-alpha.10) (2021-10-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.9](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.8...v1.0.0-alpha.9) (2021-10-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.8](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.7...v1.0.0-alpha.8) (2021-10-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.7](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.6...v1.0.0-alpha.7) (2021-10-05)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-alpha.6](https://github.com/sciactive/nymphjs/compare/v1.0.0-alpha.5...v1.0.0-alpha.6) (2021-10-05)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [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/client
+
+# [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
+
+- 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))
+- migrate Tilmeld Client to new instance based Nymph Client ([dffe83b](https://github.com/sciactive/nymphjs/commit/dffe83b3900171a56d703cd491536b5d21360198))
+- 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

package/README.md

@@ -12,50 +12,31 @@ npm install --save @nymphjs/client
 
 This package is the Nymph client for browsers. You can find UMD in `dist`, or TS source in `src`. There is also a **[Node.js client](https://github.com/sciactive/nymphjs/packages/client-node)**.
 
-## Setup
-
-```html
-<head>
-  <!-- Nymph setup -->
-  <script>
-    NymphOptions = {
-      restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
-      pubsubUrl: 'wss://yournymphpubsubserver',
-    };
-  </script>
-  <!-- End Nymph setup -->
-
-  <!-- Old school JS -->
-  <script src="node_modules/nymph-client/dist/NymphClient.js"></script>
-  <script src="path/to/your/entity/js/Todo.js"></script>
-  <!-- End Old school JS -->
-</head>
-```
-
 ## Usage
 
-For detailed docs, check out the User Guide on the website:
-
-- [Entity Class](https://nymph.io/user-guide/entity-class)
-- [Entity Querying](https://nymph.io/user-guide/entity-querying)
-- [Extending the Entity Class](https://nymph.io/user-guide/extending-the-entity-class)
-- [Subscribing to Queries](https://nymph.io/user-guide/subscribing-to-queries)
-
 Here's an overview:
 
-```js
+```ts
 import { Nymph, PubSub } from '@nymphjs/client';
 import Todo from 'Todo';
 
+const nymphOptions = {
+  restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
+  pubsubUrl: 'wss://yournymphpubsubserver',
+};
+const nymph = new Nymph(nymphOptions);
+const pubsub = new PubSub(nymphOptions, nymph);
+nymph.addEntityClass(Todo);
+
 // Now you can use Nymph and PubSub.
 const myTodo = new Todo();
 myTodo.name = 'This is a new todo!';
 myTodo.done = false;
 await myTodo.$save();
 
-let allMyTodos = await Nymph.getEntities({ class: Todo });
+let allMyTodos = await nymph.getEntities({ class: Todo });
 
-let subscription = PubSub.subscribeWith(myTodo, () => {
+let subscription = pubsub.subscribeWith(myTodo, () => {
   // When this is called, the entity will already contain new data from the
   // publish event. If the entity is deleted, the GUID will be set to null.
   if (myTodo.guid != null) {
@@ -71,7 +52,7 @@ let subscription = PubSub.subscribeWith(myTodo, () => {
 // Subscribing to a query.
 let todos = [];
 let userCount = 0;
-let subscription = PubSub.subscribeEntities(
+let subscription = pubsub.subscribeEntities(
   {
     class: Todo.class,
   },
@@ -87,7 +68,7 @@ let subscription = PubSub.subscribeEntities(
     // This takes an existing array of entities and either updates it to match
     // another array, or performs actions from a publish event object to update
     // it.
-    PubSub.updateArray(todos, update);
+    pubsub.updateArray(todos, update);
 
     // `todos` is now up to date with the latest publishes from the server.
   },