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

package/dist/HttpRequester.js

@@ -0,0 +1,365 @@
+import { fetchEventSource, EventStreamContentType, } from 'fetch-event-source-hperrin';
+export default class HttpRequester {
+    fetch;
+    requestCallbacks = [];
+    responseCallbacks = [];
+    iteratorCallbacks = [];
+    static makeUrl(url, data) {
+        if (!data) {
+            return url;
+        }
+        for (let [key, value] of Object.entries(data)) {
+            url =
+                url +
+                    (url.indexOf('?') !== -1 ? '&' : '?') +
+                    encodeURIComponent(key) +
+                    '=' +
+                    encodeURIComponent(JSON.stringify(value));
+        }
+        return url;
+    }
+    constructor(ponyFetch) {
+        this.fetch = ponyFetch ? ponyFetch : (...args) => fetch(...args);
+    }
+    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);
+    }
+    off(event, callback) {
+        const prop = (event + 'Callbacks');
+        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;
+    }
+    async GET(opt) {
+        return await this._httpRequest('GET', opt);
+    }
+    async POST(opt) {
+        return await this._httpRequest('POST', opt);
+    }
+    async POST_ITERATOR(opt) {
+        return await this._iteratorRequest('POST', opt);
+    }
+    async PUT(opt) {
+        return await this._httpRequest('PUT', opt);
+    }
+    async PATCH(opt) {
+        return await this._httpRequest('PATCH', opt);
+    }
+    async DELETE(opt) {
+        return await this._httpRequest('DELETE', opt);
+    }
+    async _httpRequest(method, opt) {
+        const dataString = JSON.stringify(opt.data);
+        let url = opt.url;
+        if (method === 'GET') {
+            // TODO: what should this size be?
+            // && dataString.length < 1) {
+            url = HttpRequester.makeUrl(opt.url, opt.data);
+        }
+        const options = {
+            method,
+            headers: opt.headers ?? {},
+            credentials: 'include',
+        };
+        if (method !== 'GET' && opt.data) {
+            options.headers['Content-Type'] =
+                'application/json';
+            options.body = dataString;
+        }
+        for (let i = 0; i < this.requestCallbacks.length; i++) {
+            this.requestCallbacks[i] && this.requestCallbacks[i](this, url, options);
+        }
+        const response = await this.fetch(url, options);
+        let text;
+        try {
+            text = await response.text();
+        }
+        catch (e) {
+            throw new InvalidResponseError('Server response did not contain valid text body.');
+        }
+        if (!response.ok) {
+            let errObj;
+            try {
+                errObj = JSON.parse(text);
+            }
+            catch (e) {
+                if (!(e instanceof SyntaxError)) {
+                    throw e;
+                }
+            }
+            if (typeof errObj !== 'object') {
+                errObj = {
+                    textStatus: response.statusText,
+                };
+            }
+            errObj.status = response.status;
+            throw response.status < 200
+                ? new InformationalError(response, errObj)
+                : response.status < 300
+                    ? new SuccessError(response, errObj)
+                    : response.status < 400
+                        ? new RedirectError(response, errObj)
+                        : response.status < 500
+                            ? new ClientError(response, errObj)
+                            : new ServerError(response, errObj);
+        }
+        for (let i = 0; i < this.responseCallbacks.length; i++) {
+            this.responseCallbacks[i] &&
+                this.responseCallbacks[i](this, response, text);
+        }
+        if (opt.dataType === 'json') {
+            if (!text.length) {
+                throw new InvalidResponseError('Server response was empty.');
+            }
+            try {
+                return JSON.parse(text);
+            }
+            catch (e) {
+                if (!(e instanceof SyntaxError)) {
+                    throw e;
+                }
+                throw new InvalidResponseError('Server response was invalid: ' + JSON.stringify(text));
+            }
+        }
+        else {
+            return text;
+        }
+    }
+    async _iteratorRequest(method, opt) {
+        const dataString = JSON.stringify(opt.data);
+        let url = opt.url;
+        if (method === 'GET') {
+            // TODO: what should this size be?
+            // && dataString.length < 1) {
+            url = HttpRequester.makeUrl(opt.url, opt.data);
+        }
+        const hasBody = method !== 'GET' && opt.data;
+        const headers = opt.headers ?? {};
+        if (hasBody) {
+            headers['Content-Type'] = 'application/json';
+        }
+        for (let i = 0; i < this.iteratorCallbacks.length; i++) {
+            this.iteratorCallbacks[i] &&
+                this.iteratorCallbacks[i](this, url, headers);
+        }
+        const responses = [];
+        let nextResponseResolve;
+        let nextResponseReadyPromise = new Promise((res) => {
+            nextResponseResolve = res;
+        });
+        let responsesDone = false;
+        let serverResponse;
+        const ctrl = new AbortController();
+        fetchEventSource(url, {
+            openWhenHidden: true,
+            fetch: this.fetch,
+            method,
+            headers,
+            credentials: 'include',
+            body: hasBody ? dataString : undefined,
+            signal: ctrl.signal,
+            async onopen(response) {
+                serverResponse = response;
+                if (response.ok) {
+                    if (response.headers.get('content-type') === EventStreamContentType) {
+                        throw new InvalidResponseError('Server response is not an event stream.');
+                    }
+                    // Response is ok, wait for messages.
+                    return;
+                }
+                let text = '';
+                try {
+                    text = await response.text();
+                }
+                catch (e) {
+                    // Ignore error here.
+                }
+                let errObj;
+                try {
+                    errObj = JSON.parse(text);
+                }
+                catch (e) {
+                    if (!(e instanceof SyntaxError)) {
+                        throw e;
+                    }
+                }
+                if (typeof errObj !== 'object') {
+                    errObj = {
+                        textStatus: response.statusText,
+                    };
+                }
+                errObj.status = response.status;
+                throw response.status < 200
+                    ? new InformationalError(response, errObj)
+                    : response.status < 300
+                        ? new SuccessError(response, errObj)
+                        : response.status < 400
+                            ? new RedirectError(response, errObj)
+                            : response.status < 500
+                                ? new ClientError(response, errObj)
+                                : new ServerError(response, errObj);
+            },
+            onmessage(event) {
+                if (event.event === 'next') {
+                    let text = event.data;
+                    if (opt.dataType === 'json') {
+                        if (!text.length) {
+                            responses.push(new InvalidResponseError('Server response was empty.'));
+                        }
+                        else {
+                            try {
+                                responses.push(JSON.parse(text));
+                            }
+                            catch (e) {
+                                if (!(e instanceof SyntaxError)) {
+                                    responses.push(e);
+                                }
+                                else {
+                                    responses.push(new InvalidResponseError('Server response was invalid: ' + JSON.stringify(text)));
+                                }
+                            }
+                        }
+                    }
+                    else {
+                        responses.push(text);
+                    }
+                }
+                else if (event.event === 'error') {
+                    let text = event.data;
+                    let errObj;
+                    try {
+                        errObj = JSON.parse(text);
+                    }
+                    catch (e) {
+                        if (!(e instanceof SyntaxError)) {
+                            throw e;
+                        }
+                    }
+                    if (typeof errObj !== 'object') {
+                        errObj = {
+                            status: 500,
+                            textStatus: 'Iterator Error',
+                        };
+                    }
+                    responses.push(errObj.status < 200
+                        ? new InformationalError(serverResponse, errObj)
+                        : errObj.status < 300
+                            ? new SuccessError(serverResponse, errObj)
+                            : errObj.status < 400
+                                ? new RedirectError(serverResponse, errObj)
+                                : errObj.status < 500
+                                    ? new ClientError(serverResponse, errObj)
+                                    : new ServerError(serverResponse, errObj));
+                }
+                else if (event.event === 'finished') {
+                    responsesDone = true;
+                }
+                else if (event.event === 'ping') {
+                    // Ignore keep-alive pings.
+                    return;
+                }
+                const resolve = nextResponseResolve;
+                if (!responsesDone) {
+                    nextResponseReadyPromise = new Promise((res) => {
+                        nextResponseResolve = res;
+                    });
+                }
+                // Resolve the promise to continue any waiting iterator.
+                resolve();
+            },
+            onclose() {
+                responses.push(new ConnectionClosedUnexpectedlyError('The connection to the server was closed unexpectedly.'));
+                responsesDone = true;
+                nextResponseResolve();
+            },
+            onerror(err) {
+                // Rethrow to stop the operation.
+                throw err;
+            },
+        }).catch((err) => {
+            responses.push(new ConnectionError('The connection could not be established: ' + err));
+            responsesDone = true;
+            nextResponseResolve();
+        });
+        const iterator = {
+            abortController: ctrl,
+            async *[Symbol.asyncIterator]() {
+                do {
+                    await nextResponseReadyPromise;
+                    while (responses.length) {
+                        yield responses.shift();
+                    }
+                } while (!responsesDone);
+            },
+        };
+        return iterator;
+    }
+}
+export class InvalidResponseError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'InvalidResponseError';
+    }
+}
+export class ConnectionClosedUnexpectedlyError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ConnectionClosedUnexpectedlyError';
+    }
+}
+export class ConnectionError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ConnectionError';
+    }
+}
+export class HttpError extends Error {
+    status;
+    statusText;
+    constructor(name, response, errObj) {
+        super(errObj.textStatus);
+        this.name = name;
+        this.status = response.status;
+        this.statusText = response.statusText;
+        Object.assign(this, errObj);
+    }
+}
+export class InformationalError extends HttpError {
+    constructor(response, errObj) {
+        super('InformationalError', response, errObj);
+    }
+}
+export class SuccessError extends HttpError {
+    constructor(response, errObj) {
+        super('SuccessError', response, errObj);
+    }
+}
+export class RedirectError extends HttpError {
+    constructor(response, errObj) {
+        super('RedirectError', response, errObj);
+    }
+}
+export class ClientError extends HttpError {
+    constructor(response, errObj) {
+        super('ClientError', response, errObj);
+    }
+}
+export class ServerError extends HttpError {
+    constructor(response, errObj) {
+        super('ServerError', response, errObj);
+    }
+}
+//# sourceMappingURL=HttpRequester.js.map

package/dist/HttpRequester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpRequester.js","sourceRoot":"","sources":["../src/HttpRequester.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AA8BpC,MAAM,CAAC,OAAO,OAAO,aAAa;IACxB,KAAK,CAAqC;IAC1C,gBAAgB,GAAmC,EAAE,CAAC;IACtD,iBAAiB,GAAoC,EAAE,CAAC;IACxD,iBAAiB,GAAoC,EAAE,CAAC;IAEhE,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,IAA0B;QACpD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,GAAG,CAAC;QACb,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9C,GAAG;gBACD,GAAG;oBACH,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;oBACrC,kBAAkB,CAAC,GAAG,CAAC;oBACvB,GAAG;oBACH,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,YAAY,SAA8C;QACxD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACnE,CAAC;IAED,EAAE,CACA,KAAQ,EACR,QAMa;QAEb,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAMpB,CAAC;QACd,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;IAED,GAAG,CACD,KAAQ,EACR,QAMa;QAEb,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,WAAW,CAMpB,CAAC;QACd,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;IAED,KAAK,CAAC,GAAG,CAAC,GAAgC;QACxC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAgC;QACzC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAgC;QAClD,OAAO,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAgC;QACxC,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAgC;QAC1C,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAgC;QAC3C,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,MAAmD,EACnD,GAAgC;QAEhC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QAClB,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,kCAAkC;YAClC,8BAA8B;YAC9B,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,OAAO,GAAgB;YAC3B,MAAM;YACN,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE;YAC1B,WAAW,EAAE,SAAS;SACvB,CAAC;QAEF,IAAI,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YAChC,OAAO,CAAC,OAAkC,CAAC,cAAc,CAAC;gBACzD,kBAAkB,CAAC;YACrB,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC;QAC5B,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3E,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,oBAAoB,CAC5B,kDAAkD,CACnD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,CAAC,CAAC,YAAY,WAAW,CAAC,EAAE,CAAC;oBAChC,MAAM,CAAC,CAAC;gBACV,CAAC;YACH,CAAC;YAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,GAAG;oBACP,UAAU,EAAE,QAAQ,CAAC,UAAU;iBAChC,CAAC;YACJ,CAAC;YACD,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAChC,MAAM,QAAQ,CAAC,MAAM,GAAG,GAAG;gBACzB,CAAC,CAAC,IAAI,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAC1C,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;oBACrB,CAAC,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC;oBACpC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;wBACrB,CAAC,CAAC,IAAI,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC;wBACrC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;4BACrB,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;4BACnC,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9C,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBACvB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,MAAM,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;YAC/D,CAAC;YACD,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,CAAC,CAAC,YAAY,WAAW,CAAC,EAAE,CAAC;oBAChC,MAAM,CAAC,CAAC;gBACV,CAAC;gBACD,MAAM,IAAI,oBAAoB,CAC5B,+BAA+B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvD,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,gBAAgB,CACpB,MAAmD,EACnD,GAAgC;QAEhC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QAClB,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,kCAAkC;YAClC,8BAA8B;YAC9B,GAAG,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC;QAC7C,MAAM,OAAO,GAA2B,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;QAE1D,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvD,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBACvB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QAED,MAAM,SAAS,GAAU,EAAE,CAAC;QAC5B,IAAI,mBAA0C,CAAC;QAC/C,IAAI,wBAAwB,GAAG,IAAI,OAAO,CAAO,CAAC,GAAG,EAAE,EAAE;YACvD,mBAAmB,GAAG,GAAG,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,IAAI,cAAwB,CAAC;QAE7B,MAAM,IAAI,GAAG,IAAI,eAAe,EAAE,CAAC;QAEnC,gBAAgB,CAAC,GAAG,EAAE;YACpB,cAAc,EAAE,IAAI;YACpB,KAAK,EAAE,IAAI,CAAC,KAAK;YAEjB,MAAM;YACN,OAAO;YACP,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;YACtC,MAAM,EAAE,IAAI,CAAC,MAAM;YAEnB,KAAK,CAAC,MAAM,CAAC,QAAQ;gBACnB,cAAc,GAAG,QAAQ,CAAC;gBAC1B,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;oBAChB,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,sBAAsB,EAAE,CAAC;wBACpE,MAAM,IAAI,oBAAoB,CAC5B,yCAAyC,CAC1C,CAAC;oBACJ,CAAC;oBAED,qCAAqC;oBACrC,OAAO;gBACT,CAAC;gBAED,IAAI,IAAI,GAAW,EAAE,CAAC;gBACtB,IAAI,CAAC;oBACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC/B,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,qBAAqB;gBACvB,CAAC;gBAED,IAAI,MAAM,CAAC;gBACX,IAAI,CAAC;oBACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC5B,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,IAAI,CAAC,CAAC,CAAC,YAAY,WAAW,CAAC,EAAE,CAAC;wBAChC,MAAM,CAAC,CAAC;oBACV,CAAC;gBACH,CAAC;gBAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;oBAC/B,MAAM,GAAG;wBACP,UAAU,EAAE,QAAQ,CAAC,UAAU;qBAChC,CAAC;gBACJ,CAAC;gBACD,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;gBAChC,MAAM,QAAQ,CAAC,MAAM,GAAG,GAAG;oBACzB,CAAC,CAAC,IAAI,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC;oBAC1C,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;wBACrB,CAAC,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC;wBACpC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;4BACrB,CAAC,CAAC,IAAI,aAAa,CAAC,QAAQ,EAAE,MAAM,CAAC;4BACrC,CAAC,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;gCACrB,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;gCACnC,CAAC,CAAC,IAAI,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;YAED,SAAS,CAAC,KAAK;gBACb,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;oBAC3B,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;oBAEtB,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;wBAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;4BACjB,SAAS,CAAC,IAAI,CACZ,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,CACvD,CAAC;wBACJ,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC;gCACH,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;4BACnC,CAAC;4BAAC,OAAO,CAAM,EAAE,CAAC;gCAChB,IAAI,CAAC,CAAC,CAAC,YAAY,WAAW,CAAC,EAAE,CAAC;oCAChC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gCACpB,CAAC;qCAAM,CAAC;oCACN,SAAS,CAAC,IAAI,CACZ,IAAI,oBAAoB,CACtB,+BAA+B,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvD,CACF,CAAC;gCACJ,CAAC;4BACH,CAAC;wBACH,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACvB,CAAC;gBACH,CAAC;qBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;oBACnC,IAAI,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;oBAEtB,IAAI,MAAM,CAAC;oBACX,IAAI,CAAC;wBACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC5B,CAAC;oBAAC,OAAO,CAAM,EAAE,CAAC;wBAChB,IAAI,CAAC,CAAC,CAAC,YAAY,WAAW,CAAC,EAAE,CAAC;4BAChC,MAAM,CAAC,CAAC;wBACV,CAAC;oBACH,CAAC;oBAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;wBAC/B,MAAM,GAAG;4BACP,MAAM,EAAE,GAAG;4BACX,UAAU,EAAE,gBAAgB;yBAC7B,CAAC;oBACJ,CAAC;oBACD,SAAS,CAAC,IAAI,CACZ,MAAM,CAAC,MAAM,GAAG,GAAG;wBACjB,CAAC,CAAC,IAAI,kBAAkB,CAAC,cAAc,EAAE,MAAM,CAAC;wBAChD,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG;4BACnB,CAAC,CAAC,IAAI,YAAY,CAAC,cAAc,EAAE,MAAM,CAAC;4BAC1C,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG;gCACnB,CAAC,CAAC,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC;gCAC3C,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG;oCACnB,CAAC,CAAC,IAAI,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC;oCACzC,CAAC,CAAC,IAAI,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,CAClD,CAAC;gBACJ,CAAC;qBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;oBACtC,aAAa,GAAG,IAAI,CAAC;gBACvB,CAAC;qBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;oBAClC,2BAA2B;oBAC3B,OAAO;gBACT,CAAC;gBAED,MAAM,OAAO,GAAG,mBAAmB,CAAC;gBACpC,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,wBAAwB,GAAG,IAAI,OAAO,CAAO,CAAC,GAAG,EAAE,EAAE;wBACnD,mBAAmB,GAAG,GAAG,CAAC;oBAC5B,CAAC,CAAC,CAAC;gBACL,CAAC;gBAED,wDAAwD;gBACxD,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,OAAO;gBACL,SAAS,CAAC,IAAI,CACZ,IAAI,iCAAiC,CACnC,uDAAuD,CACxD,CACF,CAAC;gBAEF,aAAa,GAAG,IAAI,CAAC;gBACrB,mBAAmB,EAAE,CAAC;YACxB,CAAC;YAED,OAAO,CAAC,GAAG;gBACT,iCAAiC;gBACjC,MAAM,GAAG,CAAC;YACZ,CAAC;SACF,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,SAAS,CAAC,IAAI,CACZ,IAAI,eAAe,CAAC,2CAA2C,GAAG,GAAG,CAAC,CACvE,CAAC;YAEF,aAAa,GAAG,IAAI,CAAC;YACrB,mBAAmB,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAA2B;YACvC,eAAe,EAAE,IAAI;YACrB,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;gBAC3B,GAAG,CAAC;oBACF,MAAM,wBAAwB,CAAC;oBAE/B,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;wBACxB,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;oBAC1B,CAAC;gBACH,CAAC,QAAQ,CAAC,aAAa,EAAE;YAC3B,CAAC;SACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED,MAAM,OAAO,iCAAkC,SAAQ,KAAK;IAC1D,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,mCAAmC,CAAC;IAClD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAClC,MAAM,CAAS;IACf,UAAU,CAAS;IAEnB,YACE,IAAY,EACZ,QAAkB,EAClB,MAA8B;QAE9B,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C,YAAY,QAAkB,EAAE,MAA8B;QAC5D,KAAK,CAAC,oBAAoB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,SAAS;IACzC,YAAY,QAAkB,EAAE,MAA8B;QAC5D,KAAK,CAAC,cAAc,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,YAAY,QAAkB,EAAE,MAA8B;QAC5D,KAAK,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC,YAAY,QAAkB,EAAE,MAA8B;QAC5D,KAAK,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC,YAAY,QAAkB,EAAE,MAA8B;QAC5D,KAAK,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;CACF"}

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

@@ -1,19 +1,52 @@
-import Entity from './Entity';
-import { EntityConstructor, EntityInterface, EntityJson, ServerCallResponse, ServerCallStaticResponse } from './Entity.types';
-import EntityWeakCache from './EntityWeakCache';
-import { EventType, NymphOptions, Options, RequestCallback, ResponseCallback, Selector } from './Nymph.types';
-import PubSub from './PubSub';
+import Entity, { type EntityInstanceType } from './Entity.js';
+import type { EntityConstructor, EntityInterface, EntityJson, ServerCallResponse, ServerCallStaticResponse } from './Entity.types.js';
+import EntityWeakCache from './EntityWeakCache.js';
+import type { AbortableAsyncIterator } from './HttpRequester.js';
+import type { EventType, NymphOptions, Options, RequestCallback, ResponseCallback, Selector } from './Nymph.types.js';
+import type PubSub from './PubSub.js';
 export default class Nymph {
+    /**
+     * And optional PubSub client instance.
+     */
     pubsub: PubSub | undefined;
+    /**
+     * A simple map of names to Entity classes.
+     */
     private entityClasses;
+    /**
+     * The entity class for this instance of Nymph.
+     */
     Entity: typeof Entity;
     private requestCallbacks;
     private responseCallbacks;
     private restUrl;
     private weakCache;
+    /**
+     * Headers that will be sent with every request.
+     *
+     * These are used by Tilmeld for authentication.
+     */
+    headers: {
+        [k: string]: string;
+    };
+    /**
+     * The entity cache.
+     */
     cache: EntityWeakCache;
     constructor(NymphOptions: NymphOptions);
+    /**
+     * 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<T extends EntityConstructor>(entityClass: T): T;
+    getEntityClass<T extends EntityConstructor>(className: T): T;
     getEntityClass(className: string): EntityConstructor;
     newUID(name: string): Promise<number>;
     setUID(name: string, value: number): Promise<any>;
@@ -30,14 +63,14 @@ export default class Nymph {
     getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, ...selectors: Selector[]): Promise<string | null>;
-    getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): Promise<ReturnType<T['factorySync']> | null>;
+    getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): Promise<EntityInstanceType<T> | null>;
     getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'count';
     }, guid: string): Promise<number>;
     getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, guid: string): Promise<string | null>;
-    getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, guid: string): Promise<ReturnType<T['factorySync']> | null>;
+    getEntity<T extends EntityConstructor = EntityConstructor>(options: Options<T>, guid: string): Promise<EntityInstanceType<T> | null>;
     getEntityData<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'count';
     }, ...selectors: Selector[]): Promise<number>;
@@ -58,18 +91,18 @@ export default class Nymph {
     getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T> & {
         return: 'guid';
     }, ...selectors: Selector[]): Promise<string[]>;
-    getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): Promise<ReturnType<T['factorySync']>[]>;
-    initEntity<T extends EntityConstructor = EntityConstructor>(entityJSON: EntityJson<T>): ReturnType<T['factorySync']>;
-    getEntityFromCache<T extends EntityConstructor = EntityConstructor>(EntityClass: EntityConstructor, guid: string): ReturnType<T['factorySync']> | null;
+    getEntities<T extends EntityConstructor = EntityConstructor>(options: Options<T>, ...selectors: Selector[]): Promise<EntityInstanceType<T>[]>;
+    initEntity<T extends EntityConstructor = EntityConstructor>(entityJSON: EntityJson<T>): EntityInstanceType<T>;
+    getEntityFromCache<T extends EntityConstructor = EntityConstructor>(EntityClass: EntityConstructor, guid: string): EntityInstanceType<T> | null;
     setEntityToCache(EntityClass: EntityConstructor, entity: EntityInterface): void;
     initEntitiesFromData<T extends any>(item: T): T;
     deleteEntity(entity: EntityInterface | EntityInterface[], _plural?: boolean): Promise<any>;
     deleteEntities(entities: EntityInterface[]): Promise<any>;
     serverCall(entity: EntityInterface, method: string, params: any[], stateless?: boolean): Promise<ServerCallResponse>;
     serverCallStatic(className: string, method: string, params: any[]): Promise<ServerCallStaticResponse>;
+    serverCallStaticIterator(className: string, method: string, params: any[]): Promise<AbortableAsyncIterator<ServerCallStaticResponse>>;
     on<T extends EventType>(event: T, callback: T extends 'request' ? RequestCallback : T extends 'response' ? ResponseCallback : never): () => boolean;
     off<T extends EventType>(event: T, callback: T extends 'request' ? RequestCallback : T extends 'response' ? ResponseCallback : never): boolean;
-    setXsrfToken(token: string | null): void;
 }
 export declare class ClassNotAvailableError extends Error {
     constructor(message: string);