@nymphjs/client 1.0.0-beta.11 → 1.0.0-beta.110

package/{lib → dist}/Nymph.js

@@ -1,27 +1,52 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidRequestError = exports.ClassNotAvailableError = void 0;
-const Entity_1 = __importDefault(require("./Entity"));
-const EntityWeakCache_1 = __importDefault(require("./EntityWeakCache"));
-const HttpRequester_1 = __importDefault(require("./HttpRequester"));
-const utils_1 = require("./utils");
+import Entity from './Entity.js';
+import EntityWeakCache from './EntityWeakCache.js';
+import HttpRequester, { ClientError } from './HttpRequester.js';
+import { entitiesToReferences, entityConstructorsToClassNames, } from './utils.js';
 let requester;
-class Nymph {
+export default class Nymph {
+    /**
+     * And optional PubSub client instance.
+     */
+    pubsub = undefined;
+    /**
+     * A simple map of names to Entity classes.
+     */
+    entityClasses = {};
+    /**
+     * The entity class for this instance of Nymph.
+     */
+    Entity;
+    requestCallbacks = [];
+    responseCallbacks = [];
+    restUrl = '';
+    weakCache = false;
+    /**
+     * Headers that will be sent with every request.
+     *
+     * These are used by Tilmeld for authentication.
+     */
+    headers = {};
+    /**
+     * The entity cache.
+     */
+    cache = new EntityWeakCache();
+    /**
+     * Return `null` or empty array instead of error when entity/ies not found.
+     */
+    returnNullOnNotFound = false;
     constructor(NymphOptions) {
-        this.pubsub = undefined;
-        this.entityClasses = {};
-        this.requestCallbacks = [];
-        this.responseCallbacks = [];
-        this.restUrl = '';
-        this.weakCache = false;
-        this.cache = new EntityWeakCache_1.default();
         this.restUrl = NymphOptions.restUrl;
+        // @ts-ignore TS doesn't know about WeakRef.
         this.weakCache = !!NymphOptions.weakCache && typeof WeakRef !== 'undefined';
-        this.Entity = this.addEntityClass(Entity_1.default);
-        requester = new HttpRequester_1.default('fetch' in NymphOptions ? NymphOptions.fetch : undefined);
+        if ('returnNullOnNotFound' in NymphOptions &&
+            NymphOptions.returnNullOnNotFound != null) {
+            this.returnNullOnNotFound = NymphOptions.returnNullOnNotFound;
+        }
+        this.Entity = this.addEntityClass(Entity);
+        requester = new HttpRequester('fetch' in NymphOptions ? NymphOptions.fetch : undefined);
+        if ('renewTokens' in NymphOptions && !NymphOptions.renewTokens) {
+            this.headers['X-Tilmeld-Token-Renewal'] = 'off';
+        }
         requester.on('request', (_requester, url, options) => {
             for (let i = 0; i < this.requestCallbacks.length; i++) {
                 this.requestCallbacks[i] && this.requestCallbacks[i](url, options);
@@ -33,26 +58,45 @@ class Nymph {
             }
         });
     }
+    /**
+     * Add your class to this instance.
+     *
+     * This will create a class that extends your class within this instance of
+     * Nymph and return it. You can then use this class's constructor and methods,
+     * which will use this instance of Nymph.
+     *
+     * Because this creates a subclass, don't use the class returned from
+     * `getEntityClass` to check with `instanceof`. Instead, use the base class
+     * that you passed into this method.
+     */
     addEntityClass(entityClass) {
         const nymph = this;
         class NymphEntity extends entityClass {
+            static nymph = nymph;
             constructor(...args) {
                 super(...args);
             }
         }
-        NymphEntity.nymph = nymph;
         this.entityClasses[entityClass.class] = NymphEntity;
         return NymphEntity;
     }
     getEntityClass(className) {
-        if (className in this.entityClasses) {
-            return this.entityClasses[className];
+        let key = null;
+        if (typeof className === 'string') {
+            key = className;
+        }
+        else {
+            key = className.class;
         }
-        throw new ClassNotAvailableError("Tried to get class that's not available: " + className);
+        if (key in this.entityClasses) {
+            return this.entityClasses[key];
+        }
+        throw new ClassNotAvailableError('Tried to use class: ' + key);
     }
     async newUID(name) {
         const data = await requester.POST({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'text',
             data: { action: 'uid', data: name },
         });
@@ -61,6 +105,7 @@ class Nymph {
     async setUID(name, value) {
         return await requester.PUT({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: { action: 'uid', data: { name, value } },
         });
@@ -68,6 +113,7 @@ class Nymph {
     async getUID(name) {
         const data = await requester.GET({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'text',
             data: { action: 'uid', data: name },
         });
@@ -76,6 +122,7 @@ class Nymph {
     async deleteUID(name) {
         return await requester.DELETE({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'text',
             data: { action: 'uid', data: name },
         });
@@ -121,6 +168,7 @@ class Nymph {
     async requestWithMethod(entity, method, data, plural) {
         const response = await requester[method]({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: {
                 action: plural ? 'entities' : 'entity',
@@ -140,7 +188,21 @@ class Nymph {
         throw new Error('Server error');
     }
     async getEntity(options, ...selectors) {
-        const data = (await this.getEntityData(options, ...selectors));
+        let data = null;
+        try {
+            // @ts-ignore: Implementation signatures of overloads are not externally visible.
+            data = (await this.getEntityData(options, ...selectors));
+        }
+        catch (e) {
+            if (this.returnNullOnNotFound &&
+                e instanceof ClientError &&
+                e.status === 404) {
+                data = null;
+            }
+            else {
+                throw e;
+            }
+        }
         if (options.return && options.return === 'count') {
             return Number(data ?? 0);
         }
@@ -155,20 +217,22 @@ class Nymph {
         return null;
     }
     async getEntityData(options, ...selectors) {
-        if (options.class === this.getEntityClass('Entity')) {
+        if (options.class instanceof Entity) {
             throw new InvalidRequestError("You can't make REST requests with the base Entity class.");
         }
+        // Set up options and selectors.
         if (typeof selectors[0] === 'string') {
             selectors = [{ type: '&', guid: selectors[0] }];
         }
         const data = await requester.GET({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: {
                 action: 'entity',
                 data: [
                     { ...options, class: options.class.class },
-                    ...(0, utils_1.entityConstructorsToClassNames)(selectors),
+                    ...entityConstructorsToClassNames(selectors),
                 ],
             },
         });
@@ -178,19 +242,36 @@ class Nymph {
         return null;
     }
     async getEntities(options, ...selectors) {
-        const data = await requester.GET({
-            url: this.restUrl,
-            dataType: 'json',
-            data: {
-                action: 'entities',
-                data: [
-                    { ...options, class: options.class.class },
-                    ...(0, utils_1.entityConstructorsToClassNames)(selectors),
-                ],
-            },
-        });
+        let data = null;
+        try {
+            data = await requester.GET({
+                url: this.restUrl,
+                headers: { ...this.headers },
+                dataType: 'json',
+                data: {
+                    action: 'entities',
+                    data: [
+                        { ...options, class: options.class.class },
+                        ...entityConstructorsToClassNames(selectors),
+                    ],
+                },
+            });
+        }
+        catch (e) {
+            if (this.returnNullOnNotFound &&
+                e instanceof ClientError &&
+                e.status === 404) {
+                data = null;
+            }
+            else {
+                throw e;
+            }
+        }
         if (options.return && options.return === 'count') {
-            return Number(data);
+            return Number(data ?? 0);
+        }
+        if (data == null) {
+            return [];
         }
         if (options.return && options.return === 'guid') {
             return data;
@@ -204,6 +285,7 @@ class Nymph {
         }
         let entity = EntityClass.factorySync();
         if (this.weakCache) {
+            // Try to get it from cache.
             const entityFromCache = this.cache.get(EntityClass, entityJSON.guid || '');
             if (entityFromCache != null) {
                 entity = entityFromCache;
@@ -225,10 +307,10 @@ class Nymph {
     }
     initEntitiesFromData(item) {
         if (Array.isArray(item)) {
+            // Recurse into lower arrays.
             return item.map((entry) => this.initEntitiesFromData(entry));
         }
-        else if (item instanceof Object &&
-            !(item instanceof this.getEntityClass('Entity'))) {
+        else if (item instanceof Object && !(item instanceof Entity)) {
             if (item.hasOwnProperty('class') &&
                 item.hasOwnProperty('guid') &&
                 item.hasOwnProperty('cdate') &&
@@ -240,15 +322,18 @@ class Nymph {
             }
             else {
                 for (let [key, value] of Object.entries(item)) {
+                    // @ts-ignore: Key comes from the object. It's fine.
                     item[key] = this.initEntitiesFromData(value);
                 }
             }
         }
+        // Not an entity or array, just return it.
         return item;
     }
     async deleteEntity(entity, _plural = false) {
         return await requester.DELETE({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: {
                 action: _plural ? 'entities' : 'entity',
@@ -270,6 +355,7 @@ class Nymph {
     async serverCall(entity, method, params, stateless = false) {
         const data = await requester.POST({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: {
                 action: 'method',
@@ -277,7 +363,7 @@ class Nymph {
                     entity,
                     stateless,
                     method,
-                    params: (0, utils_1.entitiesToReferences)((0, utils_1.entityConstructorsToClassNames)(params)),
+                    params: entitiesToReferences(entityConstructorsToClassNames(params)),
                 },
             },
         });
@@ -289,6 +375,7 @@ class Nymph {
     async serverCallStatic(className, method, params) {
         const data = await requester.POST({
             url: this.restUrl,
+            headers: { ...this.headers },
             dataType: 'json',
             data: {
                 action: 'method',
@@ -296,17 +383,50 @@ class Nymph {
                     class: className,
                     static: true,
                     method: method,
-                    params: (0, utils_1.entitiesToReferences)((0, utils_1.entityConstructorsToClassNames)(params)),
+                    params: entitiesToReferences(entityConstructorsToClassNames(params)),
                 },
             },
         });
         return this.initEntitiesFromData(data);
     }
+    async serverCallStaticIterator(className, method, params) {
+        const iterable = await requester.POST_ITERATOR({
+            url: this.restUrl,
+            headers: { ...this.headers },
+            dataType: 'json',
+            data: {
+                action: 'method',
+                data: {
+                    class: className,
+                    static: true,
+                    method: method,
+                    iterator: true,
+                    params: entitiesToReferences(entityConstructorsToClassNames(params)),
+                },
+            },
+        });
+        const that = this;
+        const iterator = {
+            abortController: iterable.abortController,
+            async *[Symbol.asyncIterator]() {
+                for await (let response of iterable) {
+                    if (response instanceof Error) {
+                        yield response;
+                    }
+                    else {
+                        yield that.initEntitiesFromData(response);
+                    }
+                }
+            },
+        };
+        return iterator;
+    }
     on(event, callback) {
         const prop = (event + 'Callbacks');
         if (!(prop in this)) {
             throw new Error('Invalid event type.');
         }
+        // @ts-ignore: The callback should always be the right type here.
         this[prop].push(callback);
         return () => this.off(event, callback);
     }
@@ -315,29 +435,25 @@ class Nymph {
         if (!(prop in this)) {
             return false;
         }
+        // @ts-ignore: The callback should always be the right type here.
         const i = this[prop].indexOf(callback);
         if (i > -1) {
+            // @ts-ignore: The callback should always be the right type here.
             this[prop].splice(i, 1);
         }
         return true;
     }
-    setXsrfToken(token) {
-        requester.setXsrfToken(token);
-    }
 }
-exports.default = Nymph;
-class ClassNotAvailableError extends Error {
+export class ClassNotAvailableError extends Error {
     constructor(message) {
         super(message);
         this.name = 'ClassNotAvailableError';
     }
 }
-exports.ClassNotAvailableError = ClassNotAvailableError;
-class InvalidRequestError extends Error {
+export class InvalidRequestError extends Error {
     constructor(message) {
         super(message);
         this.name = 'InvalidRequestError';
     }
 }
-exports.InvalidRequestError = InvalidRequestError;
 //# sourceMappingURL=Nymph.js.map

package/dist/Nymph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Nymph.js","sourceRoot":"","sources":["../src/Nymph.ts"],"names":[],"mappings":"AAAA,OAAO,MAAmC,MAAM,aAAa,CAAC;AAQ9D,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD,OAAO,aAAa,EAAE,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAUhE,OAAO,EACL,oBAAoB,EACpB,8BAA8B,GAC/B,MAAM,YAAY,CAAC;AAEpB,IAAI,SAAwB,CAAC;AAE7B,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB;;OAEG;IACI,MAAM,GAAuB,SAAS,CAAC;IAE9C;;OAEG;IACK,aAAa,GAAuC,EAAE,CAAC;IAE/D;;OAEG;IACI,MAAM,CAAgB;IAErB,gBAAgB,GAAsB,EAAE,CAAC;IACzC,iBAAiB,GAAuB,EAAE,CAAC;IAC3C,OAAO,GAAW,EAAE,CAAC;IACrB,SAAS,GAAG,KAAK,CAAC;IAC1B;;;;OAIG;IACI,OAAO,GAA4B,EAAE,CAAC;IAC7C;;OAEG;IACI,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC;;OAEG;IACI,oBAAoB,GAAG,KAAK,CAAC;IAEpC,YAAmB,YAA0B;QAC3C,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;QACpC,4CAA4C;QAC5C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC,SAAS,IAAI,OAAO,OAAO,KAAK,WAAW,CAAC;QAC5E,IACE,sBAAsB,IAAI,YAAY;YACtC,YAAY,CAAC,oBAAoB,IAAI,IAAI,EACzC,CAAC;YACD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,oBAAoB,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE1C,SAAS,GAAG,IAAI,aAAa,CAC3B,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACzD,CAAC;QAEF,IAAI,aAAa,IAAI,YAAY,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;YAC/D,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC;QAClD,CAAC;QAED,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;YACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtD,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE;YACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvD,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACzE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACI,cAAc,CAA8B,WAAc;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC;QACnB,MAAM,WAAY,SAAQ,WAAW;YACnC,MAAM,CAAC,KAAK,GAAU,KAAK,CAAC;YAE5B,YAAY,GAAG,IAAW;gBACxB,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YACjB,CAAC;;QAEH,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;QACpD,OAAO,WAAW,CAAC;IACrB,CAAC;IAIM,cAAc,CACnB,SAAqB;QAErB,IAAI,GAAG,GAAkB,IAAI,CAAC;QAC9B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,GAAG,GAAG,SAAS,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC;QACxB,CAAC;QACD,IAAI,GAAG,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,MAAM,IAAI,sBAAsB,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YAChC,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;SACpC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,KAAa;QAC7C,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC;YACzB,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,IAAY;QAC9B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC;YAC/B,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;SACpC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC;YAC5B,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,MAAuB;QAC7C,IAAI,MAAM,GAAmB,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAA2B;QACnD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,IAAI,MAAM,GAAmB,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;QACvE,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACvB,IACE,CAAC,MAAM,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC;gBACvC,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,EACtC,CAAC;gBACD,MAAM,IAAI,mBAAmB,CAC3B,+DAA+D;oBAC7D,sDAAsD,CACzD,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,MAAuB;QAC9C,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,mBAAmB,CAC3B,uDAAuD,CACxD,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;QAC/B,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,QAA2B;QACpD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACvB,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,mBAAmB,CAC3B,+DAA+D;oBAC7D,sDAAsD,CACzD,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/C,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;IAcO,KAAK,CAAC,iBAAiB,CAC7B,MAAe,EACf,MAAmD,EACnD,IAA0B,EAC1B,MAAe;QAEf,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;YACvC,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ;gBACtC,IAAI;aACL;SACF,CAAC,CAAC;QACH,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YACzE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACzB,QAAQ,CAAC,CAAC,CAAC;gBACX,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW;gBACvC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7C,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC,CACC,CAAC;QACX,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAC1E,OAAO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAM,CAAC;QACrC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IA0BM,KAAK,CAAC,SAAS,CACpB,OAAmB,EACnB,GAAG,SAAgC;QAEnC,IAAI,IAAI,GAAQ,IAAI,CAAC;QACrB,IAAI,CAAC;YACH,iFAAiF;YACjF,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAI/C,CAAC;QACX,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IACE,IAAI,CAAC,oBAAoB;gBACzB,CAAC,YAAY,WAAW;gBACxB,CAAC,CAAC,MAAM,KAAK,GAAG,EAChB,CAAC;gBACD,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACjD,OAAO,MAAM,CAAC,IAAI,IAAI,CAAC,CAAW,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACjB,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAChD,OAAO,IAAc,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,CAAC,UAAU,CAAC,IAAqB,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IA0BM,KAAK,CAAC,aAAa,CACxB,OAAmB,EACnB,GAAG,SAAgC;QAEnC,IAAI,OAAO,CAAC,KAAK,YAAY,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,mBAAmB,CAC3B,0DAA0D,CAC3D,CAAC;QACJ,CAAC;QACD,gCAAgC;QAChC,IAAI,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACrC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC;YAC/B,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE;oBACJ,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;oBAC1C,GAAG,8BAA8B,CAAC,SAAS,CAAC;iBAC7C;aACF;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACnE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAcM,KAAK,CAAC,WAAW,CACtB,OAAmB,EACnB,GAAG,SAAqB;QAExB,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC;gBACzB,GAAG,EAAE,IAAI,CAAC,OAAO;gBACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;gBAC5B,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE;oBACJ,MAAM,EAAE,UAAU;oBAClB,IAAI,EAAE;wBACJ,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE;wBAC1C,GAAG,8BAA8B,CAAC,SAAS,CAAC;qBAC7C;iBACF;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IACE,IAAI,CAAC,oBAAoB;gBACzB,CAAC,YAAY,WAAW;gBACxB,CAAC,CAAC,MAAM,KAAK,GAAG,EAChB,CAAC;gBACD,IAAI,GAAG,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACjD,OAAO,MAAM,CAAC,IAAI,IAAI,CAAC,CAAW,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACjB,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAChD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;IAEM,UAAU,CACf,UAAyB;QAEzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,sBAAsB,CAC9B,UAAU,CAAC,KAAK,GAAG,yBAAyB,CAC7C,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,4BAA4B;YAC5B,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CACpC,WAAW,EACX,UAAU,CAAC,IAAI,IAAI,EAAE,CACtB,CAAC;YACF,IAAI,eAAe,IAAI,IAAI,EAAE,CAAC;gBAC5B,MAAM,GAAG,eAAwC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAA0B,CAAC;IAC3D,CAAC;IAEM,kBAAkB,CACvB,WAA8B,EAC9B,IAAY;QAEZ,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAiC,CAAC;IAC3E,CAAC;IAEM,gBAAgB,CACrB,WAA8B,EAC9B,MAAuB;QAEvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;IAEM,oBAAoB,CAAgB,IAAO;QAChD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,6BAA6B;YAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAM,CAAC;QACpE,CAAC;aAAM,IAAI,IAAI,YAAY,MAAM,IAAI,CAAC,CAAC,IAAI,YAAY,MAAM,CAAC,EAAE,CAAC;YAC/D,IACE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,cAAc,CAAE,IAA0B,CAAC,KAAK,CAAC,EACtD,CAAC;gBACD,OAAO,IAAI,CAAC,UAAU,CAAC,IAAyB,CAAM,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9C,oDAAoD;oBACpD,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;QACH,CAAC;QACD,0CAA0C;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,MAA2C,EAC3C,OAAO,GAAG,KAAK;QAEf,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC;YAC5B,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ;gBACvC,IAAI,EACF,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;oBAC9B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;wBACjB,IAAI,EAAE,CAAC,CAAC,IAAI;wBACZ,KAAK,EAAG,CAAC,CAAC,WAAiC,CAAC,KAAK;qBAClD,CAAC,CAAC;oBACL,CAAC,CAAC;wBACE,IAAI,EAAG,MAA0B,CAAC,IAAI;wBACtC,KAAK,EAAG,MAAM,CAAC,WAAiC,CAAC,KAAK;qBACvD;aACR;SACF,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,QAA2B;QACrD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAEM,KAAK,CAAC,UAAU,CACrB,MAAuB,EACvB,MAAc,EACd,MAAa,EACb,SAAS,GAAG,KAAK;QAEjB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YAChC,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE;oBACJ,MAAM;oBACN,SAAS;oBACT,MAAM;oBACN,MAAM,EAAE,oBAAoB,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;iBACrE;aACF;SACF,CAAC,CAAC;QAEH,OAAO;YACL,GAAG,IAAI;YACP,MAAM,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC;SAC/C,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAC3B,SAAiB,EACjB,MAAc,EACd,MAAa;QAEb,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC;YAChC,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE;oBACJ,KAAK,EAAE,SAAS;oBAChB,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,MAAM;oBACd,MAAM,EAAE,oBAAoB,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;iBACrE;aACF;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACnC,SAAiB,EACjB,MAAc,EACd,MAAa;QAEb,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC;YAC7C,GAAG,EAAE,IAAI,CAAC,OAAO;YACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE;YAC5B,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE;gBACJ,MAAM,EAAE,QAAQ;gBAChB,IAAI,EAAE;oBACJ,KAAK,EAAE,SAAS;oBAChB,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,MAAM;oBACd,QAAQ,EAAE,IAAI;oBACd,MAAM,EAAE,oBAAoB,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;iBACrE;aACF;SACF,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,MAAM,QAAQ,GAA2B;YACvC,eAAe,EAAE,QAAQ,CAAC,eAAe;YACzC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;gBAC3B,IAAI,KAAK,EAAE,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;oBACpC,IAAI,QAAQ,YAAY,KAAK,EAAE,CAAC;wBAC9B,MAAM,QAAQ,CAAC;oBACjB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;oBAC5C,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,EAAE,CACP,KAAQ,EACR,QAIW;QAEX,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAItB,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QACD,iEAAiE;QACjE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEM,GAAG,CACR,KAAQ,EACR,QAIW;QAEX,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAItB,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,iEAAiE;QACjE,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACX,iEAAiE;YACjE,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC/C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;IACvC,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF"}

package/{lib → dist}/Nymph.types.d.ts

@@ -1,22 +1,98 @@
-import { EntityConstructor, EntityInterface } from './Entity.types';
+import { EntityConstructor, EntityInterface } from './Entity.types.js';
 export type NymphOptions = {
+    /**
+     * The URL of your Nymph REST server.
+     */
     restUrl: string;
+    /**
+     * The URL of your Nymph PubSub server.
+     */
     pubsubUrl?: string;
+    /**
+     * A fetch implementation.
+     */
     fetch?: WindowOrWorkerGlobalScope['fetch'];
+    /**
+     * A WebSocket implementation.
+     */
     WebSocket?: typeof WebSocket;
+    /**
+     * Return `null` or empty array instead of error when entity/ies not found.
+     */
+    returnNullOnNotFound?: boolean;
+    /**
+     * Whether to not output status messages to the console.
+     */
     noConsole?: boolean;
+    /**
+     * Don't automatically try to connect to PubSub server.
+     */
+    noAutoconnect?: boolean;
+    /**
+     * Use a WeakRef based cache of entities.
+     *
+     * This ensures all entities returned are the same instance if they have the
+     * same class and GUID. This also means that whenever an entity is returned
+     * from the server, the single instance in memory will be refreshed. This
+     * could have annoying results, like destroying dirty data (the dreaded
+     * triple-D).
+     *
+     * This could also be a potential source of memory leaks. Although the
+     * entities themselves are referenced weakly so they get garbage collected,
+     * the GUID used as a key and the WeakRef object itself are not weak
+     * references, so not destroyed when the instance is garbage collected.
+     *
+     * However, even with these caveats, this might help you if you have a big app
+     * with the same entities stored in several different places in memory. This
+     * can help to synchronize them correctly and avoid data conflicts.
+     */
     weakCache?: boolean;
+    /**
+     * Whether to renew tokens when a request is made.
+     *
+     * If you turn this off, the client will request that the server not renew an
+     * authentication token, even if it is within the renewal time of the
+     * expiration date.
+     *
+     * This defaults to true.
+     */
+    renewTokens?: boolean;
 };
 export type EventType = 'request' | 'response';
 export type RequestCallback = (url: string, options: RequestInit) => void;
 export type ResponseCallback = (response: Response, text: string) => void;
 export type Options<T extends EntityConstructor = EntityConstructor> = {
+    /**
+     * The Entity class to query.
+     */
     class: T;
+    /**
+     * The limit of entities to be returned. Not needed when using `getEntity`, as
+     * it always returns only one.
+     */
     limit?: number;
+    /**
+     * The offset from the first matching entity, in order, to start retrieving.
+     */
     offset?: number;
+    /**
+     * If true, entities will be retrieved from newest to oldest/largest to
+     * smallest (with regard to `sort`).
+     */
     reverse?: boolean;
-    sort?: 'cdate' | 'mdate';
+    /**
+     * How to sort the entities. Should be "cdate", "mdate", the name of a
+     * property, or null.
+     */
+    sort?: 'cdate' | 'mdate' | string | null;
+    /**
+     * What to return, the entities with their data, just the GUIDs, or just a
+     * count.
+     */
     return?: 'entity' | 'guid' | 'count';
+    /**
+     * If true, Nymph will skip the cache and retrieve the entity from the DB.
+     */
     skipCache?: boolean;
 };
 export type Clause<C> = C | Exclude<C, undefined>[];
@@ -34,6 +110,8 @@ type PrimitiveSelector = {
     '!equal'?: PrimitiveSelector['equal'];
     contain?: [string, any];
     '!contain'?: PrimitiveSelector['contain'];
+    search?: [string, string];
+    '!search'?: PrimitiveSelector['search'];
     match?: [string, string];
     '!match'?: PrimitiveSelector['match'];
     imatch?: [string, string];
@@ -71,6 +149,8 @@ export type Selector = {
     '!equal'?: Clause<OrWithTime<PrimitiveSelector['equal']>>;
     contain?: Clause<OrWithTime<PrimitiveSelector['contain']>>;
     '!contain'?: Clause<OrWithTime<PrimitiveSelector['contain']>>;
+    search?: Clause<PrimitiveSelector['search']>;
+    '!search'?: Clause<PrimitiveSelector['search']>;
     match?: Clause<PrimitiveSelector['match']>;
     '!match'?: Clause<PrimitiveSelector['match']>;
     imatch?: Clause<PrimitiveSelector['imatch']>;

package/dist/Nymph.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Nymph.types.js.map

package/{lib → dist}/PubSub.d.ts

@@ -1,9 +1,12 @@
-import Nymph from './Nymph';
-import { NymphOptions, Options, Selector } from './Nymph.types';
-import { EntityConstructor, EntityInterface } from './Entity.types';
-import { PubSubCallbacks, PubSubConnectCallback, PubSubCountCallback, PubSubDisconnectCallback, PubSubEventType, PubSubRejectCallback, PubSubResolveCallback, PubSubSubscribable, PubSubUpdate } from './PubSub.types';
+import Nymph from './Nymph.js';
+import type { NymphOptions, Options, Selector } from './Nymph.types.js';
+import type { EntityInstanceType } from './Entity.js';
+import type { EntityConstructor, EntityInterface } from './Entity.types.js';
+import type { PubSubCallbacks, PubSubConnectCallback, PubSubCountCallback, PubSubDisconnectCallback, PubSubEventType, PubSubRejectCallback, PubSubResolveCallback, PubSubErrorCallback, PubSubSubscribable, PubSubUpdate } from './PubSub.types.js';
 export default class PubSub {
     private nymph;
+    private authToken;
+    private switchToken;
     private connection;
     private waitForConnectionTimeout;
     private pubsubUrl;
@@ -11,16 +14,17 @@ export default class PubSub {
     private subscriptions;
     private connectCallbacks;
     private disconnectCallbacks;
+    private errorCallbacks;
     private noConsole;
     constructor(nymphOptions: NymphOptions, nymph: Nymph);
     subscribeEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<string[]>>;
-    subscribeEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<ReturnType<T['factorySync']>[]>>;
+    subscribeEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<EntityInstanceType<T>[]>>;
     subscribeEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<string | null>>;
-    subscribeEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<ReturnType<T['factorySync']> | null>>;
+    subscribeEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): PubSubSubscribable<PubSubUpdate<EntityInstanceType<T> | null>>;
     subscribeUID(name: string): (resolve?: PubSubResolveCallback<number> | undefined, reject?: PubSubRejectCallback | undefined, count?: PubSubCountCallback | undefined) => {
         unsubscribe: () => void;
     };
@@ -34,6 +38,8 @@ export default class PubSub {
     private _onclose;
     private _send;
     isConnectionOpen(): boolean;
+    isConnectionConnecting(): boolean;
+    isConnection(): boolean;
     private _subscribeQuery;
     private _subscribeUID;
     private _sendQuery;
@@ -44,10 +50,10 @@ export default class PubSub {
     private _unsubscribeUID;
     private _sendUnQuery;
     private _sendUnUID;
-    updateArray(oldArr: EntityInterface[], update: PubSubUpdate<EntityInterface[]>): void;
-    on<T extends PubSubEventType>(event: T, callback: T extends 'connect' ? PubSubConnectCallback : T extends 'disconnect' ? PubSubDisconnectCallback : never): () => boolean;
-    off<T extends PubSubEventType>(event: T, callback: T extends 'connect' ? PubSubConnectCallback : T extends 'disconnect' ? PubSubDisconnectCallback : never): boolean;
-    setToken(token: string | null): void;
+    updateArray(current: EntityInterface[], update: PubSubUpdate<EntityInterface[]>): void;
+    on<T extends PubSubEventType>(event: T, callback: T extends 'connect' ? PubSubConnectCallback : T extends 'disconnect' ? PubSubDisconnectCallback : T extends 'error' ? PubSubErrorCallback : never): () => boolean;
+    off<T extends PubSubEventType>(event: T, callback: T extends 'connect' ? PubSubConnectCallback : T extends 'disconnect' ? PubSubDisconnectCallback : T extends 'error' ? PubSubErrorCallback : never): boolean;
+    authenticate(authToken: string | null, switchToken?: string | null): void;
 }
 export declare class PubSubSubscription<T> {
     query: string;