@nymphjs/nymph 1.0.0-beta.6 → 1.0.0-beta.61

package/CHANGELOG.md

@@ -3,6 +3,283 @@
 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.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/nymph
+
+# [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/nymph
+
+# [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/nymph
+
+# [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/nymph
+
+# [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
+
+- add debug and error logging feature ([95680ef](https://github.com/sciactive/nymphjs/commit/95680efad0a260589f32e3d8cff0f4c4e7de413b))
+- allow connections where tokens are not renewed ([39071a5](https://github.com/sciactive/nymphjs/commit/39071a545644075190bd8213be25e0a0c46d2b5d))
+- make transaction optional during import and off by default ([08d79f8](https://github.com/sciactive/nymphjs/commit/08d79f8f803c846ac79c0c489fc754437dae082b))
+
+# [1.0.0-beta.55](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.54...v1.0.0-beta.55) (2024-05-26)
+
+### Bug Fixes
+
+- cache check with no selectors ([f3a6215](https://github.com/sciactive/nymphjs/commit/f3a6215c7b1443f039b979ed400823c6f7f88236))
+
+# [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/nymph
+
+# [1.0.0-beta.53](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.52...v1.0.0-beta.53) (2024-05-26)
+
+### Features
+
+- add pragma statements config to sqlite3 driver ([b0f27e2](https://github.com/sciactive/nymphjs/commit/b0f27e24df85663ea777565e5d352775efcad858))
+
+# [1.0.0-beta.52](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.51...v1.0.0-beta.52) (2024-05-25)
+
+### Bug Fixes
+
+- support setup app and users and groups when userFields is limited ([20e25a2](https://github.com/sciactive/nymphjs/commit/20e25a2bcc35f96b3146fd9d973e34083a85f854))
+
+# [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/nymph
+
+# [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/nymph
+
+# [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/nymph
+
+# [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
+
+# [1.0.0-beta.45](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.44...v1.0.0-beta.45) (2023-07-17)
+
+### Bug Fixes
+
+- missing pubsub updates when new top level match uses qref with multiple results ([6dc26e2](https://github.com/sciactive/nymphjs/commit/6dc26e280453794ea9ce6c2b77482f85eb62bd23))
+
+# [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/nymph
+
+# [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/nymph
+
+# [1.0.0-beta.42](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.41...v1.0.0-beta.42) (2023-07-12)
+
+### Features
+
+- make fillSession async so that gatekeeper can be sync ([fb6def4](https://github.com/sciactive/nymphjs/commit/fb6def45cd031516c9bcd3438f905e2ff881707b))
+
+# [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)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.39](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.38...v1.0.0-beta.39) (2023-07-09)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.38](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.37...v1.0.0-beta.38) (2023-07-09)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.37](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.36...v1.0.0-beta.37) (2023-07-09)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.36](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.35...v1.0.0-beta.36) (2023-07-09)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.35](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.34...v1.0.0-beta.35) (2023-06-14)
+
+### Bug Fixes
+
+- get class from nymph instead of using constructor ([fc8538e](https://github.com/sciactive/nymphjs/commit/fc8538ea24be79b845ab1e00f930542f34517bfb))
+
+# [1.0.0-beta.34](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.33...v1.0.0-beta.34) (2023-05-13)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [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/nymph
+
+# [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)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [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)
+
+### Bug Fixes
+
+- use 4 byte utf8 encoding in mysql ([c335b6e](https://github.com/sciactive/nymphjs/commit/c335b6e8416f935c9116e7f54de753d4b2255a73))
+
+# [1.0.0-beta.28](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.27...v1.0.0-beta.28) (2023-05-05)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.27](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.26...v1.0.0-beta.27) (2023-05-04)
+
+### Bug Fixes
+
+- properly escape mysql ids with dots ([64bfaa5](https://github.com/sciactive/nymphjs/commit/64bfaa5d606f97a753ca7e6c5d2d86f7c0f7729a))
+
+# [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)
+
+### Bug Fixes
+
+- don't create empty entities ([1d4d2e9](https://github.com/sciactive/nymphjs/commit/1d4d2e99af2e9cdc647bcf58ac34572836f41176))
+- tilmeld uses wrong class when cloned with user ([059c2ce](https://github.com/sciactive/nymphjs/commit/059c2cedf1b07b9681e87c240eb36723a4581918))
+
+### 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/nymph
+
+# [1.0.0-beta.23](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.22...v1.0.0-beta.23) (2023-05-02)
+
+### Bug Fixes
+
+- rare case where currentUser isn't corrent ([97f233a](https://github.com/sciactive/nymphjs/commit/97f233a5fcfd4b97dd282562b0c99097ac3ef41d))
+
+# [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/nymph
+
+# [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/nymph
+
+# [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/nymph
+
+# [1.0.0-beta.19](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.18...v1.0.0-beta.19) (2023-04-29)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [1.0.0-beta.18](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.17...v1.0.0-beta.18) (2023-04-27)
+
+### Bug Fixes
+
+- small type issues ([b91579c](https://github.com/sciactive/nymphjs/commit/b91579c9c1e96500d903332648f5a93c9a7e7d9b))
+
+### Features
+
+- add the ability to switch to a user without their password ([ca4466a](https://github.com/sciactive/nymphjs/commit/ca4466af1704d68905ac087350a8cf151c1072d9))
+- forbid modifying ac props from client ([f9e896f](https://github.com/sciactive/nymphjs/commit/f9e896f6c57b08ae100bc50d33a0234b6a431333))
+
+# [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/nymph
+
+# [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/nymph
+
+# [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/nymph
+
+# [1.0.0-beta.13](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.12...v1.0.0-beta.13) (2023-03-16)
+
+### Bug Fixes
+
+- pubsub publishing changes before transaction is finished ([a918cc1](https://github.com/sciactive/nymphjs/commit/a918cc1451e03015ecce20f1c9bf6ceb62b7dff1))
+
+# [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/nymph
+
+# [1.0.0-beta.11](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.10...v1.0.0-beta.11) (2023-02-27)
+
+**Note:** Version bump only for package @nymphjs/nymph
+
+# [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/nymph
+
+# [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
+
+- reworked $is and $equals to better work with new instance based classes ([b1f3f0c](https://github.com/sciactive/nymphjs/commit/b1f3f0cca3e2b0dd392cd9da31167a6bd9487b40))
+
+# [1.0.0-beta.8](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.7...v1.0.0-beta.8) (2023-01-09)
+
+### Features
+
+- make entities in nymph client instance specific too ([1029f06](https://github.com/sciactive/nymphjs/commit/1029f061a1ad193e4a8a2dab0186b9a4b517f646))
+
+# [1.0.0-beta.7](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.6...v1.0.0-beta.7) (2023-01-05)
+
+### Bug Fixes
+
+- sqlite transaction returns wrong instance of nymph if it has been cloned ([b278c76](https://github.com/sciactive/nymphjs/commit/b278c7633722cb1cca7a941187ae2f1ff8ebdc7b))
+
 # [1.0.0-beta.6](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.5...v1.0.0-beta.6) (2023-01-05)
 
 ### Bug Fixes

package/README.md

@@ -22,7 +22,7 @@ Here's an overview:
 // main.ts
 import { Nymph } from '@nymphjs/nymph';
 import MySQLDriver from '@nymphjs/driver-mysql';
-import Todo from './Todo';
+import TodoClass from './Todo';
 
 const mysqlConfig = {
   host: 'your_db_host',
@@ -31,8 +31,10 @@ const mysqlConfig = {
   password: 'your_password',
 };
 
+// Create a new instance of Nymph.
 const nymph = new Nymph({}, new MySQLDriver(mysqlConfig));
-nymph.addEntityClass(Todo);
+// addEntityClass returns the class you should use for this instance of Nymph.
+const Todo = nymph.addEntityClass(TodoClass);
 
 // You are set up. Now you can use entity classes like `Todo` to store data,
 // and Nymph's query methods like `getEntities` to retrieve them.
@@ -44,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;
@@ -52,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.`,
   );
 }
 ```
@@ -70,23 +72,13 @@ export default class Todo extends Entity<TodoData> {
   static ETYPE = 'todo'; // This is used for the table name(s) in the DB.
   static class = 'Todo'; // This is used to map references to their class.
 
-  static async factory(guid?: string): Promise<Todo & TodoData> {
-    return (await super.factory(guid)) as Todo & TodoData;
-  }
-
-  static factorySync(guid?: string): Todo & TodoData {
-    return super.factorySync(guid) as Todo & TodoData;
-  }
-
-  constructor(guid?: string) {
-    super(guid);
+  constructor() {
+    super();
 
-    if (this.guid == null) {
-      // Within the methods of an entity, you will use `this.$data` to access
-      // its data. Outside, you don't need the $data part.
-      this.$data.text = '';
-      this.$data.done = false;
-    }
+    // Within the methods of an entity, you will use `this.$data` to access
+    // its data. Outside, you don't need the $data part.
+    this.$data.text = '';
+    this.$data.done = false;
   }
 
   async $getOtherTodos() {
@@ -95,7 +87,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/dist/Entity.d.ts

@@ -1,34 +1,273 @@
 import type Nymph from './Nymph';
-import { ACProperties, EntityData, EntityInterface, EntityJson, EntityPatch, EntityReference, SerializedEntityData } from './Entity.types';
+import type { Options } from './Nymph.types';
+import type { ACProperties, EntityConstructor, EntityData, EntityInterface, EntityJson, EntityPatch, EntityReference, SerializedEntityData } from './Entity.types';
+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;
+/**
+ * Database abstraction object.
+ *
+ * Provides a way to access, manipulate, and store data in Nymph.
+ *
+ * The GUID is not set until the entity is saved. GUIDs must be unique forever,
+ * even after deletion. It's the job of the Nymph DB driver to make sure no two
+ * entities ever have the same GUID. This is generally done by using a large
+ * randomly generated ID.
+ *
+ * Each entity class has an etype that determines which table(s) in the database
+ * it belongs to. If two entity classes have the same etype, their data will be
+ * stored in the same table(s). This isn't a good idea, however, because
+ * references to an entity store a class name, not an etype.
+ *
+ * Tags are used to classify entities. Where an etype is used to separate data
+ * by tables, tags can be used to separate entities within a table. You can
+ * define specific tags to be protected, meaning they cannot be added/removed
+ * from the client. It can be useful to allow user defined tags, such as for
+ * blog posts.
+ *
+ * Simply calling $delete() will not unset the entity. It will still take up
+ * memory. Likewise, simply calling unset will not delete the entity from the
+ * DB.
+ *
+ * Some notes about $equals() and $is(), the replacements for "==":
+ *
+ * The == operator will likely not give you the result you want, since two
+ * instances of the same entity will fail that check, even though they represent
+ * the same data in the database.
+ *
+ * $equals() performs a more strict comparison of the entity to another. Use
+ * $equals() instead of the == operator when you want to check both the entities
+ * they represent, and the data inside them. In order to return true for
+ * $equals(), the entity and object must meet the following criteria:
+ *
+ * - They must be entities.
+ * - They must have equal GUIDs, or both must have no GUID.
+ * - Their data and tags must be equal.
+ *
+ * $is() performs a less strict comparison of the entity to another. Use $is()
+ * instead of the == operator when the entity's data may have been changed, but
+ * you only care if they represent the same entity. In order to return true, the
+ * entity and object must meet the following criteria:
+ *
+ * - They must be entities.
+ * - They must have equal GUIDs, or both must have no GUID.
+ * - If they have no GUIDs, their data and tags must be equal.
+ *
+ * Some notes about saving entities in other entity's properties:
+ *
+ * Entities use references in the DB to store an entity in their properties. The
+ * reference is stored as an array with the values:
+ *
+ * - 0 => The string 'nymph_entity_reference'
+ * - 1 => The referenced entity's GUID.
+ * - 2 => The referenced entity's class name.
+ *
+ * Since the referenced entity's class name (meaning the `class` static
+ * property, not the name of the class itself) is stored in the reference on the
+ * parent entity, if you change the class name in an update, you need to
+ * reassign all referenced entities of that class and resave.
+ *
+ * When an entity is loaded, it does not request its referenced entities from
+ * Nymph. Instead, it creates instances without data called sleeping references.
+ * When you first access an entity's data, if it is a sleeping reference, it
+ * will fill its data from the DB. You can call clearCache() to turn all the
+ * entities back into sleeping references.
+ */
 export default class Entity<T extends EntityData = EntityData> implements EntityInterface {
+    /**
+     * The instance of Nymph to use for queries.
+     */
     static nymph: Nymph;
+    /**
+     * A unique name for this type of entity used to separate its data from other
+     * types of entities in the database.
+     */
     static ETYPE: string;
+    /**
+     * The lookup name for this entity.
+     *
+     * This is used for reference arrays (and sleeping references) and client
+     * requests.
+     */
     static class: string;
     $nymph: Nymph;
     guid: string | null;
     cdate: number | null;
     mdate: number | null;
     tags: string[];
+    /**
+     * The data proxy handler.
+     */
     protected $dataHandler: Object;
+    /**
+     * The actual data store.
+     */
     protected $dataStore: T;
+    /**
+     * The actual sdata store.
+     */
     protected $sdata: SerializedEntityData;
+    /**
+     * 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;
+    /**
+     * Properties that will not be serialized into JSON with toJSON(). This
+     * can be considered a denylist, because these properties will not be set
+     * with incoming JSON.
+     *
+     * Clients CAN still determine what is in these properties, unless they are
+     * also listed in searchRestrictedData.
+     */
     protected $privateData: string[];
+    /**
+     * Whether this entity should publish changes to PubSub servers.
+     */
+    static pubSubEnabled: boolean;
+    /**
+     * Whether this entity should be accessible on the frontend through the REST
+     * server.
+     *
+     * If this is false, any request from the client that attempts to use this
+     * entity will fail.
+     */
+    static restEnabled: boolean;
+    /**
+     * Properties that will not be searchable from the frontend. If the frontend
+     * includes any of these properties in any of their clauses, they will be
+     * filtered out before the search is executed.
+     */
     static searchRestrictedData: string[];
+    /**
+     * Properties that can only be modified by server side code. They will still
+     * be visible on the frontend, unlike $privateData, but any changes to them
+     * that come from the frontend will be ignored.
+     *
+     * In addition to what's listed here, all of the access control properties
+     * will be included when Tilmeld is being used. These are:
+     *
+     * - acUser
+     * - acGroup
+     * - acOther
+     * - acRead
+     * - acWrite
+     * - acFull
+     * - user
+     * - group
+     *
+     * You should modify these through client enabled methods or the $save method
+     * instead, for safety.
+     */
     protected $protectedData: string[];
+    /**
+     * If this is defined, then it lists the only properties that will be
+     * accepted from incoming JSON. Any other properties will be ignored.
+     *
+     * If you use an allowlist, you don't need to use protectedData, since you
+     * can simply leave those entries out of allowlistData.
+     */
     protected $allowlistData?: string[];
+    /**
+     * Tags that can only be added/removed by server side code. They will still be
+     * visible on the frontend, but any changes to them that come from the
+     * frontend will be ignored.
+     */
     protected $protectedTags: string[];
+    /**
+     * If this is defined, then it lists the only tags that will be accepted from
+     * incoming JSON. Any other tags will be ignored.
+     */
     protected $allowlistTags?: string[];
+    /**
+     * The names of methods allowed to be called by the frontend with serverCall.
+     */
     protected $clientEnabledMethods: string[];
+    /**
+     * The names of static methods allowed to be called by the frontend with
+     * serverCallStatic.
+     */
     static clientEnabledStaticMethods: string[];
+    /**
+     * Whether to use "skipAc" when accessing entity references.
+     */
     private $skipAc;
+    /**
+     * The AC properties' values when the entity was loaded.
+     */
     private $originalAcValues;
-    constructor(guid?: string);
-    static factory(guid?: string): Promise<EntityInterface | Entity<EntityData>>;
-    static factorySync(guid?: string): Entity<EntityData>;
-    static factoryReference(reference: EntityReference): Entity<EntityData>;
+    /**
+     * Alter the options for a query for this entity.
+     *
+     * @param options The current options.
+     * @returns The altered options.
+     */
+    static alterOptions?<T extends Options>(options: T): T;
+    /**
+     * 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 database 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>;
+    /**
+     * Get an array of strings that **must** be unique across the current etype.
+     *
+     * When you try to save another entity with any of the same unique strings,
+     * Nymph will throw an error.
+     *
+     * The default implementation of this static method instantiates the entity,
+     * assigns all of the given data, then calls `$getUniques` and returns its
+     * output. This can have a performance impact if a lot of extra processing
+     * happens during any of these steps. You can override this method to
+     * calculate the unique strings faster, but you must return the same strings
+     * that would be returned by `$getUniques`.
+     *
+     * @returns Resolves to an array of entity's unique constraint strings.
+     */
+    static getUniques({ guid, cdate, mdate, tags, data, sdata, }: {
+        guid?: string;
+        cdate?: number;
+        mdate?: number;
+        tags: string[];
+        data: EntityData;
+        sdata?: SerializedEntityData;
+    }): Promise<string[]>;
     toJSON(): EntityReference | EntityJson | null;
     $addTag(...tags: string[]): void;
     $arraySearch(array: any[], strict?: boolean): number;
@@ -38,7 +277,14 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     $equals(object: any): boolean;
     $getData(includeSData?: boolean): any;
     $getSData(): SerializedEntityData;
+    $getUniques(): Promise<string[]>;
     $getOriginalAcValues(): ACProperties;
+    $getCurrentAcValues(): ACProperties;
+    $getAcUid(): string | null;
+    $getAcGid(): string | null;
+    $getAcReadIds(): (string | null)[] | null;
+    $getAcWriteIds(): (string | null)[] | null;
+    $getAcFullIds(): (string | null)[] | null;
     $getValidatable(): any;
     $getTags(): string[];
     $hasTag(...tags: string[]): boolean;
@@ -47,11 +293,27 @@ export default class Entity<T extends EntityData = EntityData> implements Entity
     $jsonAcceptData(input: EntityJson, allowConflict?: boolean): void;
     $jsonAcceptPatch(patch: EntityPatch, allowConflict?: boolean): void;
     $putData(data: EntityData, sdata?: SerializedEntityData): void;
+    /**
+     * Set up a sleeping reference.
+     * @param array $reference The reference to use to wake.
+     */
     protected $referenceSleep(reference: EntityReference): void;
-    protected $referenceWake(): 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>>;
     $refresh(): Promise<boolean | 0>;
     $removeTag(...tags: string[]): void;
     $save(): Promise<boolean>;
-    $toReference(): EntityReference | this;
+    $toReference(): this | EntityReference;
     $useSkipAc(skipAc: boolean): void;
 }