@nymphjs/client 1.0.0-beta.7 → 1.0.0-beta.71

package/lib/utils.js

@@ -17,9 +17,11 @@ function entityConstructorsToClassNames(item) {
     if (typeof item === 'function' &&
         item.prototype instanceof Entity_1.default &&
         typeof item.class === 'string') {
+        // Convert entity classes to strings.
         return item.class;
     }
     else if (Array.isArray(item)) {
+        // Recurse into lower arrays.
         return item.map((entry) => entityConstructorsToClassNames(entry));
     }
     else if (item instanceof Object) {
@@ -29,14 +31,17 @@ function entityConstructorsToClassNames(item) {
         }
         return newObj;
     }
+    // Not an entity or array, just return it.
     return item;
 }
 exports.entityConstructorsToClassNames = entityConstructorsToClassNames;
 function entitiesToReferences(item) {
     if (item instanceof Entity_1.default && typeof item.$toReference === 'function') {
+        // Convert entities to references.
         return item.$toReference();
     }
     else if (Array.isArray(item)) {
+        // Recurse into lower arrays.
         return item.map((entry) => entitiesToReferences(entry));
     }
     else if (item instanceof Object) {
@@ -46,11 +51,13 @@ function entitiesToReferences(item) {
         }
         return newObj;
     }
+    // Not an entity or array, just return it.
     return item;
 }
 exports.entitiesToReferences = entitiesToReferences;
 function referencesToEntities(item, nymph) {
     if (Array.isArray(item)) {
+        // Check if it's a reference.
         if (item[0] === 'nymph_entity_reference') {
             try {
                 const EntityClass = nymph.getEntityClass(item[2]);
@@ -61,6 +68,7 @@ function referencesToEntities(item, nymph) {
             }
         }
         else {
+            // Recurse into lower arrays.
             return item.map((item) => referencesToEntities(item, nymph));
         }
     }
@@ -69,10 +77,13 @@ function referencesToEntities(item, nymph) {
             item[key] = referencesToEntities(value, nymph);
         }
     }
+    // Not an array, just return it.
     return item;
 }
 exports.referencesToEntities = referencesToEntities;
 function sortObj(obj) {
+    // adapted from
+    // http://am.aurlien.net/post/1221493460/sorting-javascript-objects
     const tempArray = Object.keys(obj);
     tempArray.sort();
     for (let i = 0; i < tempArray.length; i++) {

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA8B;AAE9B,SAAgB,aAAa,CAAC,KAAe;IAC3C,MAAM,GAAG,GAA0B,EAAE,CAAC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACrC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;KACtB;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAND,sCAMC;AAED,SAAgB,8BAA8B,CAAC,IAAS;IACtD,IACE,OAAO,IAAI,KAAK,UAAU;QAC1B,IAAI,CAAC,SAAS,YAAY,gBAAM;QAChC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAC9B;QAEA,OAAO,IAAI,CAAC,KAAK,CAAC;KACnB;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC;KACnE;SAAM,IAAI,IAAI,YAAY,MAAM,EAAE;QACjC,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7C,MAAM,CAAC,GAAG,CAAC,GAAG,8BAA8B,CAAC,KAAK,CAAC,CAAC;SACrD;QACD,OAAO,MAAM,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AApBD,wEAoBC;AAED,SAAgB,oBAAoB,CAAC,IAAS;IAC5C,IAAI,IAAI,YAAY,gBAAM,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,UAAU,EAAE;QAErE,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5B;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;KACzD;SAAM,IAAI,IAAI,YAAY,MAAM,EAAE;QACjC,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7C,MAAM,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;SAC3C;QACD,OAAO,MAAM,CAAC;KACf;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAhBD,oDAgBC;AAED,SAAgB,oBAAoB,CAAC,IAAS,EAAE,KAAY;IAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAEvB,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,wBAAwB,EAAE;YACxC,IAAI;gBACF,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClD,OAAO,WAAW,CAAC,gBAAgB,CAAC,IAAuB,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAM,EAAE;gBACf,OAAO,IAAI,CAAC;aACb;SACF;aAAM;YAEL,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;SAC9D;KACF;SAAM,IAAI,gBAAM,IAAI,IAAI,YAAY,MAAM,IAAI,CAAC,CAAC,IAAI,YAAY,gBAAM,CAAC,EAAE;QACxE,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC7C,IAAI,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAChD;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AArBD,oDAqBC;AAED,SAAgB,OAAO,CAAiC,GAAM;IAG5D,MAAM,SAAS,GAAyB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,SAAS,CAAC,IAAI,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;KAC1B;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAXD,0BAWC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA8B;AAE9B,SAAgB,aAAa,CAAC,KAAe;IAC3C,MAAM,GAAG,GAA0B,EAAE,CAAC;IACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACtC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACvB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAND,sCAMC;AAED,SAAgB,8BAA8B,CAAC,IAAS;IACtD,IACE,OAAO,IAAI,KAAK,UAAU;QAC1B,IAAI,CAAC,SAAS,YAAY,gBAAM;QAChC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAC9B,CAAC;QACD,qCAAqC;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,6BAA6B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC;SAAM,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;QAClC,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,GAAG,8BAA8B,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,0CAA0C;IAC1C,OAAO,IAAI,CAAC;AACd,CAAC;AApBD,wEAoBC;AAED,SAAgB,oBAAoB,CAAC,IAAS;IAC5C,IAAI,IAAI,YAAY,gBAAM,IAAI,OAAO,IAAI,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;QACtE,kCAAkC;QAClC,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,6BAA6B;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;SAAM,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;QAClC,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,MAAM,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,0CAA0C;IAC1C,OAAO,IAAI,CAAC;AACd,CAAC;AAhBD,oDAgBC;AAED,SAAgB,oBAAoB,CAAC,IAAS,EAAE,KAAY;IAC1D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,6BAA6B;QAC7B,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,wBAAwB,EAAE,CAAC;YACzC,IAAI,CAAC;gBACH,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAClD,OAAO,WAAW,CAAC,gBAAgB,CAAC,IAAuB,CAAC,CAAC;YAC/D,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;aAAM,CAAC;YACN,6BAA6B;YAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;SAAM,IAAI,gBAAM,IAAI,IAAI,YAAY,MAAM,IAAI,CAAC,CAAC,IAAI,YAAY,gBAAM,CAAC,EAAE,CAAC;QACzE,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,gCAAgC;IAChC,OAAO,IAAI,CAAC;AACd,CAAC;AArBD,oDAqBC;AAED,SAAgB,OAAO,CAAiC,GAAM;IAC5D,eAAe;IACf,mEAAmE;IACnE,MAAM,SAAS,GAAyB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,SAAS,CAAC,IAAI,EAAE,CAAC;IACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAXD,0BAWC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nymphjs/client",
-  "version": "1.0.0-beta.7",
-  "description": "NymphJS - Client",
+  "version": "1.0.0-beta.71",
+  "description": "Nymph.js - Client",
   "browser": "dist/index.js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -19,7 +19,7 @@
     "build:js": "webpack",
     "watch:ts": "tsc --watch",
     "watch:js": "webpack --watch",
-    "prepare": "npm run clean && npm run build",
+    "prepublish": "npm run clean && npm run build",
     "test": "jest --detectOpenHandles",
     "test:watch": "jest --watch"
   },
@@ -36,16 +36,19 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@tsconfig/recommended": "^1.0.1",
-    "@types/jest": "^29.2.5",
-    "@types/lodash": "^4.14.191",
-    "jest": "^29.3.1",
-    "lodash": "^4.17.21",
-    "ts-jest": "^29.0.3",
-    "ts-loader": "^9.4.2",
-    "typescript": "^4.9.4",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.1"
+    "@tsconfig/recommended": "^1.0.3",
+    "@types/jest": "^29.5.12",
+    "@types/lodash": "^4.14.202",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.3.3",
+    "webpack": "^5.90.3",
+    "webpack-cli": "^5.1.4"
   },
-  "gitHead": "0f2e7433e16e40c704f505a3c8db5383d9e6b240"
+  "dependencies": {
+    "fetch-event-source-hperrin": "^3.0.0",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "c6e7c987c990dfcdb9f2a176954b69bf5bbbefc7"
 }

package/src/Entity.ts

@@ -16,9 +16,12 @@ import {
   sortObj,
 } from './utils';
 
-const sleepErr =
-  'This entity is in a sleeping reference state. ' +
-  'You must use .$ready() to wake it.';
+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
@@ -84,15 +87,14 @@ export default class Entity<T extends EntityData = EntityData>
    */
   protected $sleepingReference: EntityReference | null = null;
   /**
-   * A promise that resolved when the entity's data is ready.
+   * A promise that resolved when the entity's data is wake.
    */
-  protected $readyPromise: Promise<Entity<T>> | null = null;
+  protected $wakePromise: Promise<Entity<T>> | null = null;
 
   /**
-   * Load an entity.
-   * @param guid The ID of the entity to load, undefined for a new entity.
+   * Initialize an entity.
    */
-  public constructor(guid?: string) {
+  public constructor(..._rest: any[]) {
     this.$nymph = (this.constructor as EntityConstructor).nymph;
     this.$dataHandler = {
       has: (data: EntityData, name: string) => {
@@ -129,7 +131,7 @@ export default class Entity<T extends EntityData = EntityData>
       deleteProperty: (data: EntityData, name: string) => {
         if (typeof name !== 'symbol' && this.$isASleepingReference) {
           console.error(
-            `Tried to delete data on a sleeping reference: ${name}`
+            `Tried to delete data on a sleeping reference: ${name}`,
           );
           return false;
         }
@@ -143,11 +145,11 @@ export default class Entity<T extends EntityData = EntityData>
       defineProperty: (
         data: EntityData,
         name: string,
-        descriptor: PropertyDescriptor
+        descriptor: PropertyDescriptor,
       ) => {
         if (typeof name !== 'symbol' && this.$isASleepingReference) {
           console.error(
-            `Tried to define data on a sleeping reference: ${name}`
+            `Tried to define data on a sleeping reference: ${name}`,
           );
           return false;
         }
@@ -161,7 +163,7 @@ export default class Entity<T extends EntityData = EntityData>
       getOwnPropertyDescriptor: (data: EntityData, name: string) => {
         if (typeof name !== 'symbol' && this.$isASleepingReference) {
           console.error(
-            `Tried to get property descriptor on a sleeping reference: ${name}`
+            `Tried to get property descriptor on a sleeping reference: ${name}`,
           );
           return undefined;
         }
@@ -179,17 +181,6 @@ export default class Entity<T extends EntityData = EntityData>
     this.$dataStore = {} as T;
     this.$data = new Proxy(this.$dataStore, this.$dataHandler);
 
-    if (guid != null) {
-      this.guid = guid;
-      this.$isASleepingReference = true;
-      this.$sleepingReference = [
-        'nymph_entity_reference',
-        this.guid,
-        (this.constructor as EntityConstructor).class,
-      ];
-      this.$ready();
-    }
-
     return new Proxy(this, {
       has(entity: Entity, name: string) {
         if (
@@ -245,7 +236,7 @@ export default class Entity<T extends EntityData = EntityData>
       defineProperty(
         entity: Entity,
         name: string,
-        descriptor: PropertyDescriptor
+        descriptor: PropertyDescriptor,
       ) {
         if (
           typeof name !== 'string' ||
@@ -273,57 +264,130 @@ export default class Entity<T extends EntityData = EntityData>
 
       ownKeys(entity: Entity) {
         return Object.getOwnPropertyNames(entity).concat(
-          Object.getOwnPropertyNames(entity.$data)
+          Object.getOwnPropertyNames(entity.$data),
         );
       },
     }) as Entity<T>;
   }
 
-  public static async factory(guid?: string) {
+  /**
+   * 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.
+   */
+  public static async factory<E extends Entity>(
+    this: {
+      new (): E;
+    },
+    guid?: string,
+  ): Promise<E & EntityDataType<E>> {
     const cacheEntity = (
-      guid ? this.nymph.getEntityFromCache(this, guid) : null
+      guid
+        ? (this as unknown as EntityConstructor).nymph.getEntityFromCache(
+            this as unknown as EntityConstructor,
+            guid,
+          )
+        : null
     ) as Entity | null;
-    const entity = cacheEntity || new this(guid);
+    if (cacheEntity) {
+      return cacheEntity as E & EntityDataType<E>;
+    }
+    const entity = new this();
     if (guid != null) {
-      await entity.$ready();
+      entity.guid = guid;
+      entity.$isASleepingReference = true;
+      entity.$sleepingReference = [
+        'nymph_entity_reference',
+        guid,
+        (this as unknown as EntityConstructor).class,
+      ];
+      await entity.$wake();
     }
-    return entity;
+    return entity as E & EntityDataType<E>;
   }
 
-  public static factorySync(guid?: string) {
-    const cacheEntity = (
-      guid ? this.nymph.getEntityFromCache(this, guid) : null
-    ) as Entity | null;
-    return cacheEntity || new this(guid);
+  /**
+   * Create a new entity instance.
+   */
+  public static factorySync<E extends Entity>(this: {
+    new (): E;
+  }): E & EntityDataType<E> {
+    return new this() as E & EntityDataType<E>;
   }
 
-  public static factoryReference(reference: EntityReference) {
+  /**
+   * 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.
+   */
+  public static factoryReference<E extends Entity>(
+    this: {
+      new (): E;
+    },
+    reference: EntityReference,
+  ): E & EntityDataType<E> {
     const cacheEntity = (
-      reference[1] ? this.nymph.getEntityFromCache(this, reference[1]) : null
+      reference[1]
+        ? (this as unknown as EntityConstructor).nymph.getEntityFromCache(
+            this as unknown as EntityConstructor,
+            reference[1],
+          )
+        : null
     ) as Entity | null;
 
     const entity = cacheEntity || new this();
     if (!cacheEntity) {
       entity.$referenceSleep(reference);
     }
-    return entity;
+    return entity as 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.
+   */
   public static async serverCallStatic(method: string, params: Iterable<any>) {
     const data = await this.nymph.serverCallStatic(
       this.class,
       method,
       // Turn the params into a real array, in case an arguments object was
       // passed.
-      Array.prototype.slice.call(params)
+      Array.prototype.slice.call(params),
     );
     return data.return;
   }
 
+  /**
+   * 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.
+   */
+  public static async serverCallStaticIterator(
+    method: string,
+    params: Iterable<any>,
+  ) {
+    return await this.nymph.serverCallStaticIterator(
+      this.class,
+      method,
+      // Turn the params into a real array, in case an arguments object was
+      // passed.
+      Array.prototype.slice.call(params),
+    );
+  }
+
   public toJSON() {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
     const obj: EntityJson = {
       class: (this.constructor as any).class as string,
       guid: this.guid,
@@ -359,7 +423,7 @@ export default class Entity<T extends EntityData = EntityData>
       })
       .reduce(
         (obj, { key, value }) => Object.assign(obj, { [key]: value }),
-        {}
+        {},
       ) as T;
     this.$data = new Proxy(this.$dataStore, this.$dataHandler);
 
@@ -369,9 +433,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $addTag(...tags: string[]) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     if (tags.length < 1) {
       return;
@@ -380,9 +442,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $arraySearch(array: any[], strict = false) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     if (!Array.isArray(array)) {
       return -1;
@@ -397,9 +457,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public async $delete(): Promise<boolean> {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     const guid = this.guid;
 
@@ -407,9 +465,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $equals(object: any) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     if (!(object instanceof Entity)) {
       return false;
@@ -419,9 +475,6 @@ export default class Entity<T extends EntityData = EntityData>
         return false;
       }
     }
-    if (object.constructor !== this.constructor) {
-      return false;
-    }
     if (object.cdate !== this.cdate) {
       return false;
     }
@@ -438,12 +491,10 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $getPatch(): EntityPatch {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
     if (this.guid == null) {
       throw new InvalidStateError(
-        "You can't make a patch from an unsaved entity."
+        "You can't make a patch from an unsaved entity.",
       );
     }
     const patch: EntityPatch = {
@@ -451,10 +502,10 @@ export default class Entity<T extends EntityData = EntityData>
       mdate: this.mdate,
       class: (this.constructor as EntityConstructor).class,
       addTags: this.tags.filter(
-        (tag) => this.$originalTags.indexOf(tag) === -1
+        (tag) => this.$originalTags.indexOf(tag) === -1,
       ),
       removeTags: this.$originalTags.filter(
-        (tag) => this.tags.indexOf(tag) === -1
+        (tag) => this.tags.indexOf(tag) === -1,
       ),
       unset: [],
       set: {},
@@ -474,9 +525,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $hasTag(...tags: string[]) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     if (!tags.length) {
       return false;
@@ -494,9 +543,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public $is(object: any) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     if (!(object instanceof Entity)) {
       return false;
@@ -517,9 +564,7 @@ export default class Entity<T extends EntityData = EntityData>
   }
 
   public async $patch() {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     const mdate = this.mdate;
 
@@ -527,21 +572,42 @@ export default class Entity<T extends EntityData = EntityData>
     return mdate !== this.mdate;
   }
 
-  public $ready() {
+  /**
+   * Check if this is a sleeping reference and throw an error if so.
+   */
+  protected $check() {
+    if (this.$isASleepingReference || this.$sleepingReference != null) {
+      throw new EntityIsSleepingReferenceError(
+        'This entity is in a sleeping reference state. You must use .$wake() to wake it.',
+      );
+    }
+  }
+
+  /**
+   * Check if this is a sleeping reference.
+   */
+  public $asleep() {
+    return this.$isASleepingReference || this.$sleepingReference != null;
+  }
+
+  /**
+   * Wake from a sleeping reference.
+   */
+  public $wake() {
     if (!this.$isASleepingReference) {
-      this.$readyPromise = null;
+      this.$wakePromise = null;
       return Promise.resolve(this);
     }
     if (this.$sleepingReference?.[1] == null) {
       throw new InvalidStateError(
-        'Tried to ready a sleeping reference with no GUID.'
+        'Tried to wake a sleeping reference with no GUID.',
       );
     }
-    if (!this.$readyPromise) {
-      this.$readyPromise = this.$nymph
+    if (!this.$wakePromise) {
+      this.$wakePromise = this.$nymph
         .getEntityData(
           { class: this.constructor as EntityConstructor },
-          { type: '&', guid: this.$sleepingReference[1] }
+          { type: '&', guid: this.$sleepingReference[1] },
         )
         .then((data) => {
           if (data == null) {
@@ -551,16 +617,16 @@ export default class Entity<T extends EntityData = EntityData>
           return this.$init(data);
         })
         .finally(() => {
-          this.$readyPromise = null;
+          this.$wakePromise = null;
         });
     }
-    return this.$readyPromise;
+    return this.$wakePromise;
   }
 
-  public $readyAll(level?: number) {
+  public $wakeAll(level?: number) {
     return new Promise((resolve, reject) => {
-      // Run this once this entity is ready.
-      const readyProps = () => {
+      // Run this once this entity is awake.
+      const wakeProps = () => {
         let newLevel;
         // If level is undefined, keep going forever, otherwise, stop once we've
         // gone deep enough.
@@ -572,17 +638,17 @@ export default class Entity<T extends EntityData = EntityData>
           return;
         }
         const promises = [];
-        // Go through data looking for entities to ready.
+        // Go through data looking for entities to wake.
         for (let [key, value] of Object.entries(this.$data)) {
           if (value instanceof Entity && value.$isASleepingReference) {
-            promises.push(value.$readyAll(newLevel));
+            promises.push(value.$wakeAll(newLevel));
           } else if (Array.isArray(value)) {
             for (let i = 0; i < value.length; i++) {
               if (
                 value[i] instanceof Entity &&
                 value[i].$isASleepingReference
               ) {
-                promises.push(value[i].$readyAll(newLevel));
+                promises.push(value[i].$wakeAll(newLevel));
               }
             }
           }
@@ -590,7 +656,7 @@ export default class Entity<T extends EntityData = EntityData>
         if (promises.length) {
           Promise.all(promises).then(
             () => resolve(this),
-            (errObj) => reject(errObj)
+            (errObj) => reject(errObj),
           );
         } else {
           resolve(this);
@@ -598,9 +664,9 @@ export default class Entity<T extends EntityData = EntityData>
       };
 
       if (this.$isASleepingReference) {
-        this.$ready().then(readyProps, (errObj) => reject(errObj));
+        this.$wake().then(wakeProps, (errObj) => reject(errObj));
       } else {
-        readyProps();
+        wakeProps();
       }
     }) as Promise<Entity<T>>;
   }
@@ -613,7 +679,7 @@ export default class Entity<T extends EntityData = EntityData>
 
   public async $refresh() {
     if (this.$isASleepingReference) {
-      await this.$ready();
+      await this.$wake();
       return true;
     }
 
@@ -627,24 +693,20 @@ export default class Entity<T extends EntityData = EntityData>
       {
         type: '&',
         guid: this.guid,
-      }
+      },
     );
     this.$init(data);
     return this.guid == null ? 0 : true;
   }
 
   public $removeTag(...tags: string[]) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     this.tags = difference(this.tags, tags);
   }
 
   public async $save() {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
 
     await this.$nymph.saveEntity(this);
     return !!this.guid;
@@ -653,11 +715,9 @@ export default class Entity<T extends EntityData = EntityData>
   public async $serverCall(
     method: string,
     params: Iterable<any>,
-    stateless = false
+    stateless = false,
   ) {
-    if (this.$isASleepingReference) {
-      throw new EntityIsSleepingReferenceError(sleepErr);
-    }
+    this.$check();
     // Turn the params into a real array, in case an arguments object was
     // passed.
     const paramArray = Array.prototype.slice.call(params);
@@ -665,7 +725,7 @@ export default class Entity<T extends EntityData = EntityData>
       this,
       method,
       paramArray,
-      stateless
+      stateless,
     );
     if (!stateless && data.entity) {
       this.$init(data.entity);