@dremio/js-sdk 0.23.0 → 0.24.0

package/dist/common/fromTextEventStream.d.ts

@@ -0,0 +1,7 @@
+import { Observable } from "rxjs";
+import { type EventSourceMessage } from "eventsource-parser/stream";
+/**
+ * Takes an instance of `Response` that will resolve to a `text/event-stream` and maps it
+ * into an observable that emits for each event as it arrives
+ */
+export declare const fromTextEventStream: (response: Promise<Response>) => Observable<EventSourceMessage>;

package/dist/common/fromTextEventStream.js

@@ -0,0 +1,92 @@
+/*
+ * Copyright (C) 2024-2025 Dremio Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Observable } from "rxjs";
+import { EventSourceParserStream } from "eventsource-parser/stream";
+import { HttpError } from "./HttpError.js";
+/**
+ * Takes an instance of `Response` that will resolve to a `text/event-stream` and maps it
+ * into an observable that emits for each event as it arrives
+ */
+export const fromTextEventStream = (response) => new Observable((subscriber) => {
+    /**
+     * Create an internal AbortController so that the response stream
+     * can be canceled early if the subscriber unsubscribes early
+     */
+    const controller = new AbortController();
+    const { signal } = controller;
+    response
+        .then(async (response) => {
+        if (!response.ok) {
+            throw await HttpError.fromResponse(response);
+        }
+        /**
+         * Even though the correct Content-Type header isn't strictly required,
+         * it's indicates either a client mistake or server implementation bug
+         */
+        if (response.headers.get("Content-Type") !== "text/event-stream") {
+            throw new Error(`Expected response type to be text/event-stream. Received ${response.headers.get("Content-Type")}.`);
+        }
+        /**
+         * Response body should never be undefined for a text/event-stream
+         */
+        if (!response.body) {
+            throw new Error(`Response body was undefined`);
+        }
+        /**
+         * Pipe the raw byte stream through a text decoder, and then
+         * through a parser that extracts individual SSE events
+         */
+        return response.body
+            .pipeThrough(new TextDecoderStream())
+            .pipeThrough(new EventSourceParserStream());
+    })
+        .then(async (readableStream) => {
+        const reader = readableStream.getReader();
+        /**
+         * Check if the observable has been unsubscribed before reading
+         * each chunk
+         */
+        while (!signal.aborted) {
+            const { done, value } = await reader.read();
+            /**
+             * Check again after reading a chunk if the observable
+             * has been unsubscribed to avoid calling .next() or
+             * .complete() unnecessarily on the observable
+             */
+            if (signal.aborted) {
+                break;
+            }
+            if (done) {
+                subscriber.complete();
+                break;
+            }
+            subscriber.next(value);
+        }
+        /**
+         * Always call .cancel() on the reader even if the while loop
+         * was exited due to stream completion in order to indicate it
+         * can be fully cleaned up
+         */
+        await reader.cancel();
+    })
+        .catch((e) => {
+        subscriber.error(e);
+    });
+    return () => {
+        controller.abort();
+    };
+});
+//# sourceMappingURL=fromTextEventStream.js.map

package/dist/common/fromTextEventStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fromTextEventStream.js","sourceRoot":"","sources":["../../src/common/fromTextEventStream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAA2B,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAA2B,EAAE,EAAE,CACjE,IAAI,UAAU,CAAqB,CAAC,UAAU,EAAE,EAAE;IAChD;;;OAGG;IACH,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAE9B,QAAQ;SACL,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACvB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QAED;;;WAGG;QACH,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CACb,4DAA4D,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CACpG,CAAC;QACJ,CAAC;QAED;;WAEG;QACH,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QAED;;;WAGG;QACH,OAAO,QAAQ,CAAC,IAAI;aACjB,WAAW,CAAC,IAAI,iBAAiB,EAAE,CAAC;aACpC,WAAW,CAAC,IAAI,uBAAuB,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;SACD,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,EAAE,CAAC;QAE1C;;;WAGG;QACH,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;YAE5C;;;;eAIG;YACH,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM;YACR,CAAC;YAED,IAAI,IAAI,EAAE,CAAC;gBACT,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACtB,MAAM;YACR,CAAC;YAED,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAED;;;;WAIG;QACH,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;QACpB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEL,OAAO,GAAG,EAAE;QACV,UAAU,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Observable } from \"rxjs\";\nimport { type EventSourceMessage, EventSourceParserStream } from \"eventsource-parser/stream\";\nimport { HttpError } from \"./HttpError.ts\";\n\n/**\n * Takes an instance of `Response` that will resolve to a `text/event-stream` and maps it\n * into an observable that emits for each event as it arrives\n */\nexport const fromTextEventStream = (response: Promise<Response>) =>\n  new Observable<EventSourceMessage>((subscriber) => {\n    /**\n     * Create an internal AbortController so that the response stream\n     * can be canceled early if the subscriber unsubscribes early\n     */\n    const controller = new AbortController();\n    const { signal } = controller;\n\n    response\n      .then(async (response) => {\n        if (!response.ok) {\n          throw await HttpError.fromResponse(response);\n        }\n\n        /**\n         * Even though the correct Content-Type header isn't strictly required,\n         * it's indicates either a client mistake or server implementation bug\n         */\n        if (response.headers.get(\"Content-Type\") !== \"text/event-stream\") {\n          throw new Error(\n            `Expected response type to be text/event-stream. Received ${response.headers.get(\"Content-Type\")}.`,\n          );\n        }\n\n        /**\n         * Response body should never be undefined for a text/event-stream\n         */\n        if (!response.body) {\n          throw new Error(`Response body was undefined`);\n        }\n\n        /**\n         * Pipe the raw byte stream through a text decoder, and then\n         * through a parser that extracts individual SSE events\n         */\n        return response.body\n          .pipeThrough(new TextDecoderStream())\n          .pipeThrough(new EventSourceParserStream());\n      })\n      .then(async (readableStream) => {\n        const reader = readableStream.getReader();\n\n        /**\n         * Check if the observable has been unsubscribed before reading\n         * each chunk\n         */\n        while (!signal.aborted) {\n          const { done, value } = await reader.read();\n\n          /**\n           * Check again after reading a chunk if the observable\n           * has been unsubscribed to avoid calling .next() or\n           * .complete() unnecessarily on the observable\n           */\n          if (signal.aborted) {\n            break;\n          }\n\n          if (done) {\n            subscriber.complete();\n            break;\n          }\n\n          subscriber.next(value);\n        }\n\n        /**\n         * Always call .cancel() on the reader even if the while loop\n         * was exited due to stream completion in order to indicate it\n         * can be fully cleaned up\n         */\n        await reader.cancel();\n      })\n      .catch((e: unknown) => {\n        subscriber.error(e);\n      });\n\n    return () => {\n      controller.abort();\n    };\n  });\n"]}

package/dist/common/sharedExports.d.ts

@@ -1,5 +1,6 @@
 import { HttpError } from "../common/HttpError.ts";
 export { HttpError };
 export * from "./CredentialProvider.ts";
+export * from "./fromTextEventStream.ts";
 export * from "./Problem.ts";
 export * from "./Query.ts";

package/dist/common/sharedExports.js

@@ -16,6 +16,7 @@
 import { HttpError } from "../common/HttpError.js";
 export { HttpError };
 export * from "./CredentialProvider.js";
+export * from "./fromTextEventStream.js";
 export * from "./Problem.js";
 export * from "./Query.js";
 //# sourceMappingURL=sharedExports.js.map

package/dist/common/sharedExports.js.map

@@ -1 +1 @@
-{"version":3,"file":"sharedExports.js","sourceRoot":"","sources":["../../src/common/sharedExports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { HttpError } from \"../common/HttpError.ts\";\nexport { HttpError };\nexport * from \"./CredentialProvider.ts\";\nexport * from \"./Problem.ts\";\nexport * from \"./Query.ts\";\n"]}
+{"version":3,"file":"sharedExports.js","sourceRoot":"","sources":["../../src/common/sharedExports.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,CAAC;AACrB,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC","sourcesContent":["/*\n * Copyright (C) 2024-2025 Dremio Corporation\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { HttpError } from \"../common/HttpError.ts\";\nexport { HttpError };\nexport * from \"./CredentialProvider.ts\";\nexport * from \"./fromTextEventStream.ts\";\nexport * from \"./Problem.ts\";\nexport * from \"./Query.ts\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dremio/js-sdk",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "JavaScript library for the Dremio API",
   "keywords": [
     "dremio",
@@ -32,6 +32,7 @@
     "prepare": "node --run dist"
   },
   "dependencies": {
+    "eventsource-parser": "^3.0.1",
     "moize": "^6",
     "parse-ms": "^4",
     "rxjs": "^7",