@nymphjs/client 1.0.0-beta.9 → 1.0.0-beta.91

package/CHANGELOG.md

@@ -3,6 +3,384 @@
 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.91](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.90...v1.0.0-beta.91) (2025-03-07)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.90](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.89...v1.0.0-beta.90) (2025-02-09)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.89](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.88...v1.0.0-beta.89) (2025-02-09)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.88](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.87...v1.0.0-beta.88) (2025-01-30)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.87](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.86...v1.0.0-beta.87) (2025-01-20)
+
+### Features
+
+- deprecate node client and allow multiple client instances to each log in own users ([17b42f4](https://github.com/sciactive/nymphjs/commit/17b42f449f2355a3ce896b8e86a47edd660e9277))
+
+# [1.0.0-beta.86](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.85...v1.0.0-beta.86) (2024-12-28)
+
+### Bug Fixes
+
+- entity search functions handling of null values ([6ac0335](https://github.com/sciactive/nymphjs/commit/6ac0335ecb792979ecfb621395a55b68a607429f))
+
+# [1.0.0-beta.85](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.84...v1.0.0-beta.85) (2024-12-27)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.84](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.83...v1.0.0-beta.84) (2024-12-21)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.83](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.82...v1.0.0-beta.83) (2024-12-20)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.82](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.81...v1.0.0-beta.82) (2024-12-15)
+
+### Features
+
+- migrate to es modules, upgrade all packages, migrate to Svelte 5 ([3f2b9e5](https://github.com/sciactive/nymphjs/commit/3f2b9e517b39934eddce66601d7fc747fbf3f9e6))
+
+# [1.0.0-beta.81](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.80...v1.0.0-beta.81) (2024-09-28)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.80](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.79...v1.0.0-beta.80) (2024-09-28)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.79](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.78...v1.0.0-beta.79) (2024-09-28)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.78](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.77...v1.0.0-beta.78) (2024-09-27)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.77](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.76...v1.0.0-beta.77) (2024-09-26)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.76](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.75...v1.0.0-beta.76) (2024-09-25)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.75](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.74...v1.0.0-beta.75) (2024-09-24)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.74](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.73...v1.0.0-beta.74) (2024-09-21)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.73](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.72...v1.0.0-beta.73) (2024-09-20)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.72](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.71...v1.0.0-beta.72) (2024-09-20)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.71](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.70...v1.0.0-beta.71) (2024-09-20)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.70](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.69...v1.0.0-beta.70) (2024-09-20)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.69](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.68...v1.0.0-beta.69) (2024-09-19)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.68](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.67...v1.0.0-beta.68) (2024-09-19)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.67](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.66...v1.0.0-beta.67) (2024-09-03)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.66](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.65...v1.0.0-beta.66) (2024-08-06)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.65](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.64...v1.0.0-beta.65) (2024-08-05)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.64](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.63...v1.0.0-beta.64) (2024-08-04)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.63](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.62...v1.0.0-beta.63) (2024-06-18)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.62](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.61...v1.0.0-beta.62) (2024-06-15)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.61](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.60...v1.0.0-beta.61) (2024-06-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.60](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.59...v1.0.0-beta.60) (2024-06-14)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.59](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.58...v1.0.0-beta.59) (2024-06-14)
+
+### Features
+
+- add uniqueness constraint feature, refactor some types ([8133d32](https://github.com/sciactive/nymphjs/commit/8133d32b2c04907182dca2e9171b8217ed1b57e4))
+
+# [1.0.0-beta.58](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.57...v1.0.0-beta.58) (2024-06-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.57](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.56...v1.0.0-beta.57) (2024-06-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.56](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.55...v1.0.0-beta.56) (2024-06-11)
+
+### Features
+
+- allow connections where tokens are not renewed ([39071a5](https://github.com/sciactive/nymphjs/commit/39071a545644075190bd8213be25e0a0c46d2b5d))
+
+# [1.0.0-beta.55](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.54...v1.0.0-beta.55) (2024-05-26)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.54](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.53...v1.0.0-beta.54) (2024-05-26)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.53](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.52...v1.0.0-beta.53) (2024-05-26)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.52](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.51...v1.0.0-beta.52) (2024-05-25)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.51](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.50...v1.0.0-beta.51) (2024-04-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.50](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.49...v1.0.0-beta.50) (2024-04-08)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.49](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.48...v1.0.0-beta.49) (2024-03-04)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [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/client
+
+# [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/client
+
+# [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/client
+
+# [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/client
+
+# [1.0.0-beta.44](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.43...v1.0.0-beta.44) (2023-07-13)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.43](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.42...v1.0.0-beta.43) (2023-07-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.42](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.41...v1.0.0-beta.42) (2023-07-12)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.41](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.40...v1.0.0-beta.41) (2023-07-12)
+
+### Features
+
+- remove synchronous database queries ([b579fb2](https://github.com/sciactive/nymphjs/commit/b579fb2eacd96cdd1b386a62c5c00cdbb2438f6e))
+- rewrite server side async api to match client side api ([9c537a8](https://github.com/sciactive/nymphjs/commit/9c537a8be49e9b989af0822a4c2236e8c2d20f87))
+
+# [1.0.0-beta.40](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.39...v1.0.0-beta.40) (2023-07-10)
+
+### Bug Fixes
+
+- rewrite updateArray function to fix it ([22185c7](https://github.com/sciactive/nymphjs/commit/22185c7627f6dc616f9d3187ee8c9a383ca71441))
+
+# [1.0.0-beta.39](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.38...v1.0.0-beta.39) (2023-07-09)
+
+### Bug Fixes
+
+- go back to older code for updateArray, but better number handling ([7a58c98](https://github.com/sciactive/nymphjs/commit/7a58c983eac73839544361b4d32fb2dbb0881da2))
+
+# [1.0.0-beta.38](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.37...v1.0.0-beta.38) (2023-07-09)
+
+### Bug Fixes
+
+- pull value from the array in updateArray function ([352d1ea](https://github.com/sciactive/nymphjs/commit/352d1eab0cf8868f672ce0350564eb75ac9d4a45))
+- simplify updateArray code ([348154c](https://github.com/sciactive/nymphjs/commit/348154c4d42b1e2b54bc491c1588a59c7c48984c))
+
+# [1.0.0-beta.37](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.36...v1.0.0-beta.37) (2023-07-09)
+
+### Bug Fixes
+
+- correctly iterate through new arrays on updateArray pubsub method ([27d7cc8](https://github.com/sciactive/nymphjs/commit/27d7cc847d93300e3d76cf6fa528176c3d06ae67))
+
+# [1.0.0-beta.36](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.35...v1.0.0-beta.36) (2023-07-09)
+
+### Bug Fixes
+
+- use code 1000 for closing pubsub connection ([cbd56af](https://github.com/sciactive/nymphjs/commit/cbd56af98d0775dee36025d909a82a0af0633d72))
+
+# [1.0.0-beta.35](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.34...v1.0.0-beta.35) (2023-06-14)
+
+### Features
+
+- add iteratable server call support using event streams ([fa7c1ec](https://github.com/sciactive/nymphjs/commit/fa7c1ec869e1fb52db20c8245e98a681f73dbf83))
+
+# [1.0.0-beta.34](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.33...v1.0.0-beta.34) (2023-05-13)
+
+### Bug Fixes
+
+- subscribeWith making guid null ([dbb38d4](https://github.com/sciactive/nymphjs/commit/dbb38d424f2395bbfa01ab4a0663dcaebf0c7aa7))
+
+# [1.0.0-beta.33](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.32...v1.0.0-beta.33) (2023-05-13)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.32](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.31...v1.0.0-beta.32) (2023-05-13)
+
+### Features
+
+- issue initial request with pubsub instead of rest on subscribe ([8a232d2](https://github.com/sciactive/nymphjs/commit/8a232d2faeb8622924f9c35a01a8f71a70659bb3))
+
+# [1.0.0-beta.31](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.30...v1.0.0-beta.31) (2023-05-12)
+
+### Bug Fixes
+
+- pubsub client reconnect multiple times issue ([bba0897](https://github.com/sciactive/nymphjs/commit/bba08974fadf318d040f8844a2d583f6bc15b486))
+
+# [1.0.0-beta.30](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.29...v1.0.0-beta.30) (2023-05-12)
+
+### Features
+
+- allow providing getEntityClass with a class instead of string ([ecd64c1](https://github.com/sciactive/nymphjs/commit/ecd64c1bf92e3657889613b76bcc46652f371ead))
+
+# [1.0.0-beta.29](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.28...v1.0.0-beta.29) (2023-05-08)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.28](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.27...v1.0.0-beta.28) (2023-05-05)
+
+### Bug Fixes
+
+- pubsub client auth ([979d913](https://github.com/sciactive/nymphjs/commit/979d9138abc86c7cef8b80b4f63c519b7b7ded78))
+
+# [1.0.0-beta.27](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.26...v1.0.0-beta.27) (2023-05-04)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.26](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.25...v1.0.0-beta.26) (2023-05-04)
+
+### Features
+
+- update packages and migrate to mysql2 ([72ad611](https://github.com/sciactive/nymphjs/commit/72ad611bd2bf7bf85c3ba8a3486503d9b50c49d6))
+
+# [1.0.0-beta.25](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.24...v1.0.0-beta.25) (2023-05-04)
+
+### Features
+
+- add flags to disable rest and pubsub support on an entity class ([52106a3](https://github.com/sciactive/nymphjs/commit/52106a3d44065bcfec40d361344bf1eba59a5136)), closes [#1](https://github.com/sciactive/nymphjs/issues/1)
+
+# [1.0.0-beta.24](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.23...v1.0.0-beta.24) (2023-05-02)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.23](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.22...v1.0.0-beta.23) (2023-05-02)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.22](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.21...v1.0.0-beta.22) (2023-05-01)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.21](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.20...v1.0.0-beta.21) (2023-05-01)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.20](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.19...v1.0.0-beta.20) (2023-04-30)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.19](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.18...v1.0.0-beta.19) (2023-04-29)
+
+### Bug Fixes
+
+- some type issues ([ee69d5d](https://github.com/sciactive/nymphjs/commit/ee69d5d73361dacda5745d697df18fafd47810bc))
+
+# [1.0.0-beta.18](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.17...v1.0.0-beta.18) (2023-04-27)
+
+### Features
+
+- add the ability to switch to a user without their password ([ca4466a](https://github.com/sciactive/nymphjs/commit/ca4466af1704d68905ac087350a8cf151c1072d9))
+
+# [1.0.0-beta.17](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.16...v1.0.0-beta.17) (2023-04-24)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.16](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.15...v1.0.0-beta.16) (2023-03-31)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.15](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.14...v1.0.0-beta.15) (2023-03-23)
+
+### Features
+
+- add option to sort results by a property ([16384e7](https://github.com/sciactive/nymphjs/commit/16384e7bdab88abb55ccccabb06ac09f92fa8a03))
+
+# [1.0.0-beta.14](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.13...v1.0.0-beta.14) (2023-03-17)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.13](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.12...v1.0.0-beta.13) (2023-03-16)
+
+### Features
+
+- add noAutoconnect option to pubsub client ([266e715](https://github.com/sciactive/nymphjs/commit/266e715988b34f3e0d58ac68178677d2086b5160))
+
+# [1.0.0-beta.12](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.11...v1.0.0-beta.12) (2023-03-04)
+
+**Note:** Version bump only for package @nymphjs/client
+
+# [1.0.0-beta.11](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.10...v1.0.0-beta.11) (2023-02-27)
+
+### Features
+
+- allow customizing HTTP status codes in response from server called methods ([8c5c3d4](https://github.com/sciactive/nymphjs/commit/8c5c3d4af741edabc1a8947aaebf026ba546c46a))
+
+# [1.0.0-beta.10](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.9...v1.0.0-beta.10) (2023-01-19)
+
+**Note:** Version bump only for package @nymphjs/client
+
 # [1.0.0-beta.9](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.8...v1.0.0-beta.9) (2023-01-09)
 
 ### Bug Fixes

package/README.md

@@ -2,7 +2,7 @@
 
 Powerful object data storage and querying.
 
-The Nymph Client allows you to query and push data to a Nymph REST server from the browser. You can also subscribe to entities and queries on a Nymph PubSub server and be notified of changes.
+The Nymph Client allows you to query and push data to a Nymph REST server from the browser or Node.js. You can also subscribe to entities and queries on a Nymph PubSub server and be notified of changes.
 
 ## Installation
 
@@ -10,7 +10,7 @@ The Nymph Client allows you to query and push data to a Nymph REST server from t
 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)**.
+This package is the Nymph client for browsers and Node.js, but requires at least Node.js 22 to be used in Node. You can find ES modules in `dist`, or TS source in `src`.
 
 ## Usage
 
@@ -18,7 +18,7 @@ Here's an overview:
 
 ```ts
 import { Nymph, PubSub } from '@nymphjs/client';
-import TodoClass from 'Todo';
+import TodoClass from './Todo.js';
 
 const nymphOptions = {
   restUrl: 'https://yournymphrestserver/path/to/your/endpoint',
@@ -59,7 +59,7 @@ let subscription = pubsub.subscribeEntities(
   {
     type: '&',
     '!tag': 'archived',
-  }
+  },
 )(
   (update) => {
     // The first time this is called, `update` will be an array of Todo
@@ -77,7 +77,7 @@ let subscription = pubsub.subscribeEntities(
     // If you provide this callback, the server will send updates of how many
     // clients are subscribed to this query.
     userCount = count;
-  }
+  },
 );
 
 // ...
@@ -88,7 +88,7 @@ subscription.unsubscribe();
 
 # License
 
-Copyright 2021 SciActive Inc
+Copyright 2021-2025 SciActive Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/asyncitertest.js

@@ -0,0 +1,53 @@
+async function* iterate() {
+  let values = [1, 2, 3];
+  let finished = false;
+
+  let promise = new Promise((resolve) => {
+    setTimeout(() => {
+      promise = new Promise((resolve) => {
+        setTimeout(() => {
+          values.push(4);
+          promise = new Promise((resolve) => {
+            setTimeout(() => {
+              values.push(5, 6);
+              finished = true;
+              resolve();
+            }, 3000);
+          });
+          resolve();
+        }, 3000);
+      });
+      resolve();
+    }, 0);
+  });
+
+  const iterable = {
+    async *[Symbol.asyncIterator]() {
+      do {
+        await promise;
+
+        while (values.length) {
+          yield values.shift();
+        }
+      } while (!finished);
+    },
+  };
+
+  yield* iterable;
+}
+
+(async () => {
+  const iter = iterate();
+
+  for await (let value of iter) {
+    console.log(value);
+  }
+
+  console.log('done');
+
+  for await (let value of ['a', 'b', 'c']) {
+    console.log(value);
+  }
+
+  console.log('done');
+})();

package/dist/Entity.d.ts

@@ -0,0 +1,156 @@
+import type Nymph from './Nymph.js';
+import { EntityConstructor, EntityData, EntityInterface, EntityJson, EntityPatch, EntityReference } from './Entity.types.js';
+export type EntityDataType<T> = T extends Entity<infer DataType> ? DataType : never;
+export type EntityInstanceType<T extends EntityConstructor> = T extends new () => infer E ? E & EntityDataType<E> : never;
+export default class Entity<T extends EntityData = EntityData> implements EntityInterface {
+    /**
+     * The instance of Nymph to use for queries.
+     */
+    static nymph: Nymph;
+    /**
+     * The lookup name for this entity.
+     *
+     * This is used for reference arrays (and sleeping references) and server
+     * requests.
+     */
+    static class: string;
+    /**
+     * The instance of Nymph to use for queries.
+     */
+    $nymph: Nymph;
+    /**
+     * The entity's Globally Unique ID.
+     */
+    guid: string | null;
+    /**
+     * The creation date of the entity as a high precision Unix timestamp.
+     */
+    cdate: number | null;
+    /**
+     * The modified date of the entity as a high precision Unix timestamp.
+     */
+    mdate: number | null;
+    /**
+     * Array of the entity's tags.
+     */
+    tags: string[];
+    /**
+     * Array of the entity's original tags (for patch).
+     */
+    protected $originalTags: string[];
+    /**
+     * A map of props to whether they're dirty (for patch).
+     */
+    protected $dirty: {
+        [k: string]: boolean;
+    };
+    /**
+     * The data proxy handler.
+     */
+    protected $dataHandler: Object;
+    /**
+     * The actual data store.
+     */
+    protected $dataStore: T;
+    /**
+     * The data proxy object.
+     */
+    protected $data: T;
+    /**
+     * Whether this instance is a sleeping reference.
+     */
+    protected $isASleepingReference: boolean;
+    /**
+     * The reference to use to wake.
+     */
+    protected $sleepingReference: EntityReference | null;
+    /**
+     * A promise that resolved when the entity's data is wake.
+     */
+    protected $wakePromise: Promise<Entity<T>> | null;
+    /**
+     * Initialize an entity.
+     */
+    constructor(..._rest: any[]);
+    /**
+     * Create or retrieve a new entity instance.
+     *
+     * Note that this will always return an entity, even if the GUID is not found.
+     *
+     * @param guid An optional GUID to retrieve.
+     */
+    static factory<E extends Entity>(this: {
+        new (): E;
+    }, guid?: string): Promise<E & EntityDataType<E>>;
+    /**
+     * Create a new entity instance.
+     */
+    static factorySync<E extends Entity>(this: {
+        new (): E;
+    }): E & EntityDataType<E>;
+    /**
+     * Create a new sleeping reference instance.
+     *
+     * Sleeping references won't retrieve their data from the server until they
+     * are readied with `$wake()` or a parent's `$wakeAll()`.
+     *
+     * @param reference The Nymph Entity Reference to use to wake.
+     * @returns The new instance.
+     */
+    static factoryReference<E extends Entity>(this: {
+        new (): E;
+    }, reference: EntityReference): E & EntityDataType<E>;
+    /**
+     * Call a static method on the server version of this entity.
+     *
+     * @param method The name of the method.
+     * @param params The parameters to call the method with.
+     * @returns The value that the method on the server returned.
+     */
+    static serverCallStatic(method: string, params: Iterable<any>): Promise<any>;
+    /**
+     * Call a static iterator method on the server version of this entity.
+     *
+     * @param method The name of the method.
+     * @param params The parameters to call the method with.
+     * @returns An iterator that iterates over values that the method on the server yields.
+     */
+    static serverCallStaticIterator(method: string, params: Iterable<any>): Promise<import("./HttpRequester.js").AbortableAsyncIterator<any>>;
+    toJSON(): EntityJson;
+    $init(entityJson: EntityJson | null): Entity<T>;
+    $addTag(...tags: string[]): void;
+    $arraySearch(array: any[], strict?: boolean): number;
+    $delete(): Promise<boolean>;
+    $equals(object: any): boolean;
+    $getPatch(): EntityPatch;
+    $hasTag(...tags: string[]): boolean;
+    $isDirty(property: string): boolean | null;
+    $inArray(array: any[], strict?: boolean): boolean;
+    $is(object: any): boolean;
+    $patch(): Promise<boolean>;
+    /**
+     * Check if this is a sleeping reference and throw an error if so.
+     */
+    protected $check(): void;
+    /**
+     * Check if this is a sleeping reference.
+     */
+    $asleep(): boolean;
+    /**
+     * Wake from a sleeping reference.
+     */
+    $wake(): Promise<Entity<T>>;
+    $wakeAll(level?: number): Promise<Entity<T>>;
+    protected $referenceSleep(reference: EntityReference): void;
+    $refresh(): Promise<boolean | 0>;
+    $removeTag(...tags: string[]): void;
+    $save(): Promise<boolean>;
+    $serverCall(method: string, params: Iterable<any>, stateless?: boolean): Promise<any>;
+    $toReference(): EntityReference | EntityInterface;
+}
+export declare class EntityIsSleepingReferenceError extends Error {
+    constructor(message: string);
+}
+export declare class InvalidStateError extends Error {
+    constructor(message: string);
+}