@nymphjs/client 1.0.0-beta.13 → 1.0.0-beta.131

package/src/PubSub.types.ts

@@ -1,5 +1,5 @@
-import { EntityJson } from './Entity.types';
-import { PubSubSubscription } from './PubSub';
+import { EntityJson } from './Entity.types.js';
+import { PubSubSubscription } from './PubSub.js';
 
 export type PubSubResolveCallback<T> = (arg: T, event?: string) => void;
 export type PubSubRejectCallback = (err: any) => void;
@@ -7,29 +7,43 @@ export type PubSubCountCallback = (count: number) => void;
 export type PubSubCallbacks<T> = [
   PubSubResolveCallback<T> | undefined,
   PubSubRejectCallback | undefined,
-  PubSubCountCallback | undefined
+  PubSubCountCallback | undefined,
 ];
-export type PubSubEventType = 'connect' | 'disconnect';
+export type PubSubEventType = 'connect' | 'disconnect' | 'error';
 export type PubSubConnectCallback = () => void;
 export type PubSubDisconnectCallback = () => void;
+/**
+ * The error event is for unknown errors. Query errors fire their own reject
+ * callbacks.
+ */
+export type PubSubErrorCallback = (err: any) => void;
+export type PubSubUpdateRemoved = {
+  query: string;
+  removed: string;
+};
+export type PubSubUpdateAdded = {
+  query: string;
+  added: string;
+  data: EntityJson;
+};
+export type PubSubUpdateUpdated = {
+  query: string;
+  updated: string;
+  data: EntityJson;
+};
+export type PubSubUpdateMultiple = {
+  query: string;
+  multiple: true;
+  messages: (PubSubUpdateRemoved | PubSubUpdateAdded | PubSubUpdateUpdated)[];
+};
 export type PubSubUpdate<T> =
   | T
-  | {
-      query: string;
-      removed: string;
-    }
-  | {
-      query: string;
-      added: string;
-      data: EntityJson;
-    }
-  | {
-      query: string;
-      updated: string;
-      data: EntityJson;
-    };
+  | PubSubUpdateRemoved
+  | PubSubUpdateAdded
+  | PubSubUpdateUpdated
+  | PubSubUpdateMultiple;
 export type PubSubSubscribable<T> = (
   resolve?: PubSubResolveCallback<T> | undefined,
   reject?: PubSubRejectCallback | undefined,
-  count?: PubSubCountCallback | undefined
+  count?: PubSubCountCallback | undefined,
 ) => PubSubSubscription<T>;

package/src/entityRefresh.ts

@@ -1,4 +1,4 @@
-import Entity from './Entity';
+import Entity from './Entity.js';
 
 // Save referenced entities in an entity's data.
 export function saveEntities(entity: Entity) {
@@ -14,7 +14,7 @@ export function saveEntities(entity: Entity) {
 
 const addEntitiesToObject = (
   item: any,
-  entitiesObject: { [k: string]: Entity }
+  entitiesObject: { [k: string]: Entity },
 ) => {
   // @ts-ignore: Accessing a private property.
   if (item instanceof Entity && !item.$isASleepingReference) {
@@ -37,7 +37,7 @@ const addEntitiesToObject = (
 // after the restore.
 export function restoreEntities(
   entity: Entity,
-  savedEntities: { [k: string]: Entity }
+  savedEntities: { [k: string]: Entity },
 ) {
   let data: { containsSleepingReference: boolean } = {
     containsSleepingReference: false,
@@ -49,7 +49,7 @@ export function restoreEntities(
     entity.$dataStore[key] = retoreEntitiesFromObject(
       value,
       savedEntities,
-      data
+      data,
     );
   }
 
@@ -59,7 +59,7 @@ export function restoreEntities(
 const retoreEntitiesFromObject = <T extends any>(
   item: T,
   entitiesObject: { [k: string]: Entity },
-  data: { containsSleepingReference: boolean }
+  data: { containsSleepingReference: boolean },
 ): T => {
   if (item instanceof Entity) {
     // @ts-ignore: Accessing a private property.
@@ -78,7 +78,7 @@ const retoreEntitiesFromObject = <T extends any>(
   } else if (Array.isArray(item)) {
     // Recurse into lower arrays.
     return item.map((item) =>
-      retoreEntitiesFromObject(item, entitiesObject, data)
+      retoreEntitiesFromObject(item, entitiesObject, data),
     ) as T;
   } else if (item instanceof Object) {
     for (let [key, value] of Object.entries(item)) {

package/src/index.ts

@@ -1,19 +1,19 @@
-export * from './Entity';
-import Entity from './Entity';
+export * from './Entity.js';
+import Entity from './Entity.js';
 export { Entity };
 
-export * from './Entity.types';
+export * from './Entity.types.js';
 
-export * from './HttpRequester';
+export * from './HttpRequester.js';
 
-export * from './Nymph';
-import Nymph from './Nymph';
+export * from './Nymph.js';
+import Nymph from './Nymph.js';
 export { Nymph };
 
-export * from './Nymph.types';
+export * from './Nymph.types.js';
 
-export * from './PubSub';
-import PubSub from './PubSub';
+export * from './PubSub.js';
+import PubSub from './PubSub.js';
 export { PubSub };
 
-export * from './PubSub.types';
+export * from './PubSub.types.js';

package/src/utils.ts

@@ -1,6 +1,6 @@
-import { EntityReference } from './Entity.types';
-import Nymph from './Nymph';
-import Entity from './Entity';
+import { EntityReference } from './Entity.types.js';
+import Nymph from './Nymph.js';
+import Entity from './Entity.js';
 
 export function uniqueStrings(array: string[]) {
   const obj: { [k: string]: true } = {};
@@ -11,13 +11,14 @@ export function uniqueStrings(array: string[]) {
 }
 
 export function entityConstructorsToClassNames(item: any): any {
-  if (
-    typeof item === 'function' &&
-    item.prototype instanceof Entity &&
-    typeof item.class === 'string'
-  ) {
-    // Convert entity classes to strings.
-    return item.class;
+  if (item == null) {
+    return item;
+  } else if (typeof item === 'function' && item.prototype instanceof Entity) {
+    // Convert entity classes to class references.
+    return ['nymph_class_reference', item.class];
+  } else if (item instanceof Entity) {
+    // Don't touch entities.
+    return item;
   } else if (Array.isArray(item)) {
     // Recurse into lower arrays.
     return item.map((entry) => entityConstructorsToClassNames(entry));
@@ -32,10 +33,52 @@ export function entityConstructorsToClassNames(item: any): any {
   return item;
 }
 
+export function classNamesToEntityConstructors<T extends any>(
+  nymph: Nymph,
+  item: T,
+): T {
+  if (item == null) {
+    return item;
+  } else if (
+    Array.isArray(item) &&
+    item.length === 2 &&
+    item[0] === 'nymph_class_reference' &&
+    typeof item[1] === 'string'
+  ) {
+    // Convert class references to entity classes.
+    const EntityClass = nymph.getEntityClass(item[1]);
+    return EntityClass as T;
+  } else if (item instanceof Entity) {
+    // Don't touch entities.
+    return item;
+  } else if (typeof item === 'function' && item.prototype instanceof Entity) {
+    // Don't touch Entity classes.
+    return item;
+  } else if (Array.isArray(item)) {
+    // Recurse into lower arrays.
+    return item.map((entry) =>
+      classNamesToEntityConstructors(nymph, entry),
+    ) as T;
+  } else if (item instanceof Object) {
+    let newObj = Object.create(item);
+    for (let [key, value] of Object.entries(item)) {
+      newObj[key] = classNamesToEntityConstructors(nymph, value);
+    }
+    return newObj;
+  }
+  // Not an entity or array, just return it.
+  return item;
+}
+
 export function entitiesToReferences(item: any): any {
-  if (item instanceof Entity && typeof item.$toReference === 'function') {
+  if (item == null) {
+    return item;
+  } else if (item instanceof Entity) {
     // Convert entities to references.
     return item.$toReference();
+  } else if (typeof item === 'function' && item.prototype instanceof Entity) {
+    // Don't touch Entity classes.
+    return item;
   } else if (Array.isArray(item)) {
     // Recurse into lower arrays.
     return item.map((entry) => entitiesToReferences(entry));
@@ -51,7 +94,9 @@ export function entitiesToReferences(item: any): any {
 }
 
 export function referencesToEntities(item: any, nymph: Nymph): any {
-  if (Array.isArray(item)) {
+  if (item == null) {
+    return item;
+  } else if (Array.isArray(item)) {
     // Check if it's a reference.
     if (item[0] === 'nymph_entity_reference') {
       try {
@@ -64,10 +109,18 @@ export function referencesToEntities(item: any, nymph: Nymph): any {
       // Recurse into lower arrays.
       return item.map((item) => referencesToEntities(item, nymph));
     }
-  } else if (Entity && item instanceof Object && !(item instanceof Entity)) {
+  } else if (item instanceof Entity) {
+    // Don't touch entities.
+    return item;
+  } else if (typeof item === 'function' && item.prototype instanceof Entity) {
+    // Don't touch Entity classes.
+    return item;
+  } else if (item instanceof Object) {
+    let newObj = Object.create(item);
     for (let [key, value] of Object.entries(item)) {
-      item[key] = referencesToEntities(value, nymph);
+      newObj[key] = referencesToEntities(value, nymph);
     }
+    return newObj;
   }
   // Not an array, just return it.
   return item;

package/tsconfig.json

@@ -2,12 +2,15 @@
   "extends": "@tsconfig/recommended/tsconfig.json",
 
   "compilerOptions": {
-    "lib": ["DOM", "ES2021"],
-    "target": "ES2021",
+    "types": ["jest"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "lib": ["DOM", "es2024"],
+    "target": "es2024",
     "noImplicitAny": true,
-    "removeComments": true,
+    "removeComments": false,
     "sourceMap": true,
-    "outDir": "lib",
+    "outDir": "dist",
     "resolveJsonModule": true,
     "rootDir": "src/",
     "declaration": true

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}

package/dist/index.js.LICENSE.txt

@@ -1,8 +0,0 @@
-/**
- * @license
- * Lodash <https://lodash.com/>
- * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
- * Released under MIT license <https://lodash.com/license>
- * Based on Underscore.js 1.8.3 <http://underscorejs.org/LICENSE>
- * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
- */

package/lib/Entity.d.ts

@@ -1,51 +0,0 @@
-import type Nymph from './Nymph';
-import { EntityConstructor, EntityData, EntityInterface, EntityJson, EntityPatch, EntityReference } from './Entity.types';
-export default class Entity<T extends EntityData = EntityData> implements EntityInterface {
-    static nymph: Nymph;
-    static class: string;
-    $nymph: Nymph;
-    guid: string | null;
-    cdate: number | null;
-    mdate: number | null;
-    tags: string[];
-    protected $originalTags: string[];
-    protected $dirty: {
-        [k: string]: boolean;
-    };
-    protected $dataHandler: Object;
-    protected $dataStore: T;
-    protected $data: T;
-    protected $isASleepingReference: boolean;
-    protected $sleepingReference: EntityReference | null;
-    protected $readyPromise: Promise<Entity<T>> | null;
-    constructor(guid?: string);
-    static factory(guid?: string): Promise<Entity<EntityData>>;
-    static factorySync(guid?: string): Entity<EntityData>;
-    static factoryReference(reference: EntityReference): Entity<EntityData>;
-    static serverCallStatic(method: string, params: Iterable<any>): Promise<any>;
-    toJSON(): EntityJson<EntityConstructor>;
-    $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;
-    $inArray(array: any[], strict?: boolean): boolean;
-    $is(object: any): boolean;
-    $patch(): Promise<boolean>;
-    $ready(): Promise<Entity<T>>;
-    $readyAll(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);
-}