@glamboyosa/ore 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Timothy Ogbemudia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,15 @@
+interface OreOptions {
+    url: string;
+    headers?: HeadersInit;
+}
+declare class Ore {
+    private url;
+    private headers?;
+    private streamEnded;
+    private retryCount;
+    private maxRetries;
+    constructor(options: OreOptions);
+    fetchSSE(onBufferReceived: (buffer: string, parts: Array<string>) => void, onStreamEnded?: (streamEnded: boolean) => void, customHeaders?: HeadersInit, retries?: number): void;
+}
+
+export { Ore, type OreOptions };

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+interface OreOptions {
+    url: string;
+    headers?: HeadersInit;
+}
+declare class Ore {
+    private url;
+    private headers?;
+    private streamEnded;
+    private retryCount;
+    private maxRetries;
+    constructor(options: OreOptions);
+    fetchSSE(onBufferReceived: (buffer: string, parts: Array<string>) => void, onStreamEnded?: (streamEnded: boolean) => void, customHeaders?: HeadersInit, retries?: number): void;
+}
+
+export { Ore, type OreOptions };

package/dist/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Ore: () => Ore
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/client.ts
+var Ore = class {
+  url;
+  headers;
+  streamEnded = false;
+  retryCount = 0;
+  maxRetries = 3;
+  constructor(options) {
+    this.url = options.url;
+    this.headers = options.headers ? {
+      "Content-Type": "text/event-stream",
+      "Cache-Control": "no-cache",
+      Connection: "keep-alive",
+      ...options.headers
+    } : {
+      "Content-Type": "text/event-stream",
+      "Cache-Control": "no-cache",
+      Connection: "keep-alive"
+    };
+  }
+  fetchSSE(onBufferReceived, onStreamEnded, customHeaders, retries = this.maxRetries) {
+    const headers = { ...this.headers, ...customHeaders };
+    const fetchWithRetry = async () => {
+      try {
+        const response = await fetch(this.url, {
+          method: "GET",
+          headers
+        });
+        if (!response.ok) {
+          throw new Error("Failed to connect to SSE endpoint");
+        }
+        this.retryCount = 0;
+        const reader = response.body?.getReader();
+        const decoder = new TextDecoder("utf-8");
+        let buffer = "";
+        const processText = ({ done, value }) => {
+          if (done) {
+            this.streamEnded = true;
+            if (onStreamEnded) {
+              onStreamEnded(this.streamEnded);
+            }
+            return;
+          }
+          buffer += decoder.decode(value, { stream: true });
+          const parts = buffer.split("\n\n");
+          onBufferReceived(buffer, parts);
+          return reader.read().then(processText);
+        };
+        reader?.read().then(processText).catch((error) => {
+          if (this.retryCount < retries) {
+            console.error("Error:", error);
+            console.log("Retrying...");
+            this.retryCount++;
+            setTimeout(fetchWithRetry, 1e3);
+          } else {
+            console.error("Max retries exceeded. Cannot establish SSE connection.");
+            this.streamEnded = true;
+            if (onStreamEnded) {
+              onStreamEnded(this.streamEnded);
+            }
+          }
+        });
+      } catch (error) {
+        if (this.retryCount < retries) {
+          console.error("Error:", error);
+          console.log("Retrying...");
+          this.retryCount++;
+          setTimeout(fetchWithRetry, 1e3);
+        } else {
+          console.error("Max retries exceeded. Cannot establish SSE connection.");
+          this.streamEnded = true;
+          if (onStreamEnded) {
+            onStreamEnded(this.streamEnded);
+          }
+        }
+      }
+    };
+    fetchWithRetry();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Ore
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/client.ts"],"sourcesContent":["export * from \"./client\";\n","interface OreOptions {\n  url: string;\n  headers?: HeadersInit;\n}\n\nclass Ore {\n  private url: string;\n  private headers?: HeadersInit;\n  private streamEnded = false;\n  private retryCount = 0;\n  private maxRetries = 3;\n\n  constructor(options: OreOptions) {\n    this.url = options.url;\n    this.headers = options.headers\n      ? {\n          \"Content-Type\": \"text/event-stream\",\n          \"Cache-Control\": \"no-cache\",\n          Connection: \"keep-alive\",\n          ...options.headers,\n        }\n      : {\n          \"Content-Type\": \"text/event-stream\",\n          \"Cache-Control\": \"no-cache\",\n          Connection: \"keep-alive\",\n        };\n  }\n\n  public fetchSSE(\n    onBufferReceived: (buffer: string, parts: Array<string>) => void,\n    onStreamEnded?: (streamEnded: boolean) => void,\n    customHeaders?: HeadersInit,\n    retries: number = this.maxRetries,\n  ): void {\n    const headers = { ...this.headers, ...customHeaders };\n\n    const fetchWithRetry = async (): Promise<void> => {\n      try {\n        const response = await fetch(this.url, {\n          method: \"GET\",\n          headers: headers,\n        });\n\n        if (!response.ok) {\n          throw new Error(\"Failed to connect to SSE endpoint\");\n        }\n\n        this.retryCount = 0;\n\n        const reader = response.body?.getReader();\n        const decoder = new TextDecoder(\"utf-8\");\n        let buffer = \"\";\n        const processText = ({ done, value }: ReadableStreamReadResult<Uint8Array>): any => {\n          if (done) {\n            this.streamEnded = true;\n            if (onStreamEnded) {\n              onStreamEnded(this.streamEnded);\n            }\n            return;\n          }\n\n          buffer += decoder.decode(value, { stream: true });\n\n          const parts = buffer.split(\"\\n\\n\");\n\n          onBufferReceived(buffer, parts);\n\n          return reader!.read().then(processText);\n        };\n        reader\n          ?.read()\n          .then(processText)\n          .catch((error) => {\n            if (this.retryCount < retries) {\n              console.error(\"Error:\", error);\n              console.log(\"Retrying...\");\n              this.retryCount++;\n              setTimeout(fetchWithRetry, 1000);\n            } else {\n              console.error(\"Max retries exceeded. Cannot establish SSE connection.\");\n              this.streamEnded = true;\n              if (onStreamEnded) {\n                onStreamEnded(this.streamEnded);\n              }\n            }\n          });\n      } catch (error) {\n        if (this.retryCount < retries) {\n          console.error(\"Error:\", error);\n          console.log(\"Retrying...\");\n          this.retryCount++;\n          setTimeout(fetchWithRetry, 1000);\n        } else {\n          console.error(\"Max retries exceeded. Cannot establish SSE connection.\");\n          this.streamEnded = true;\n          if (onStreamEnded) {\n            onStreamEnded(this.streamEnded);\n          }\n        }\n      }\n    };\n\n    fetchWithRetry();\n  }\n}\n\nexport { Ore, type OreOptions };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKA,IAAM,MAAN,MAAU;AAAA,EACA;AAAA,EACA;AAAA,EACA,cAAc;AAAA,EACd,aAAa;AAAA,EACb,aAAa;AAAA,EAErB,YAAY,SAAqB;AAC/B,SAAK,MAAM,QAAQ;AACnB,SAAK,UAAU,QAAQ,UACnB;AAAA,MACE,gBAAgB;AAAA,MAChB,iBAAiB;AAAA,MACjB,YAAY;AAAA,MACZ,GAAG,QAAQ;AAAA,IACb,IACA;AAAA,MACE,gBAAgB;AAAA,MAChB,iBAAiB;AAAA,MACjB,YAAY;AAAA,IACd;AAAA,EACN;AAAA,EAEO,SACL,kBACA,eACA,eACA,UAAkB,KAAK,YACjB;AACN,UAAM,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,cAAc;AAEpD,UAAM,iBAAiB,YAA2B;AAChD,UAAI;AACF,cAAM,WAAW,MAAM,MAAM,KAAK,KAAK;AAAA,UACrC,QAAQ;AAAA,UACR;AAAA,QACF,CAAC;AAED,YAAI,CAAC,SAAS,IAAI;AAChB,gBAAM,IAAI,MAAM,mCAAmC;AAAA,QACrD;AAEA,aAAK,aAAa;AAElB,cAAM,SAAS,SAAS,MAAM,UAAU;AACxC,cAAM,UAAU,IAAI,YAAY,OAAO;AACvC,YAAI,SAAS;AACb,cAAM,cAAc,CAAC,EAAE,MAAM,MAAM,MAAiD;AAClF,cAAI,MAAM;AACR,iBAAK,cAAc;AACnB,gBAAI,eAAe;AACjB,4BAAc,KAAK,WAAW;AAAA,YAChC;AACA;AAAA,UACF;AAEA,oBAAU,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;AAEhD,gBAAM,QAAQ,OAAO,MAAM,MAAM;AAEjC,2BAAiB,QAAQ,KAAK;AAE9B,iBAAO,OAAQ,KAAK,EAAE,KAAK,WAAW;AAAA,QACxC;AACA,gBACI,KAAK,EACN,KAAK,WAAW,EAChB,MAAM,CAAC,UAAU;AAChB,cAAI,KAAK,aAAa,SAAS;AAC7B,oBAAQ,MAAM,UAAU,KAAK;AAC7B,oBAAQ,IAAI,aAAa;AACzB,iBAAK;AACL,uBAAW,gBAAgB,GAAI;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,wDAAwD;AACtE,iBAAK,cAAc;AACnB,gBAAI,eAAe;AACjB,4BAAc,KAAK,WAAW;AAAA,YAChC;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACL,SAAS,OAAO;AACd,YAAI,KAAK,aAAa,SAAS;AAC7B,kBAAQ,MAAM,UAAU,KAAK;AAC7B,kBAAQ,IAAI,aAAa;AACzB,eAAK;AACL,qBAAW,gBAAgB,GAAI;AAAA,QACjC,OAAO;AACL,kBAAQ,MAAM,wDAAwD;AACtE,eAAK,cAAc;AACnB,cAAI,eAAe;AACjB,0BAAc,KAAK,WAAW;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,mBAAe;AAAA,EACjB;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,84 @@
+// src/client.ts
+var Ore = class {
+  url;
+  headers;
+  streamEnded = false;
+  retryCount = 0;
+  maxRetries = 3;
+  constructor(options) {
+    this.url = options.url;
+    this.headers = options.headers ? {
+      "Content-Type": "text/event-stream",
+      "Cache-Control": "no-cache",
+      Connection: "keep-alive",
+      ...options.headers
+    } : {
+      "Content-Type": "text/event-stream",
+      "Cache-Control": "no-cache",
+      Connection: "keep-alive"
+    };
+  }
+  fetchSSE(onBufferReceived, onStreamEnded, customHeaders, retries = this.maxRetries) {
+    const headers = { ...this.headers, ...customHeaders };
+    const fetchWithRetry = async () => {
+      try {
+        const response = await fetch(this.url, {
+          method: "GET",
+          headers
+        });
+        if (!response.ok) {
+          throw new Error("Failed to connect to SSE endpoint");
+        }
+        this.retryCount = 0;
+        const reader = response.body?.getReader();
+        const decoder = new TextDecoder("utf-8");
+        let buffer = "";
+        const processText = ({ done, value }) => {
+          if (done) {
+            this.streamEnded = true;
+            if (onStreamEnded) {
+              onStreamEnded(this.streamEnded);
+            }
+            return;
+          }
+          buffer += decoder.decode(value, { stream: true });
+          const parts = buffer.split("\n\n");
+          onBufferReceived(buffer, parts);
+          return reader.read().then(processText);
+        };
+        reader?.read().then(processText).catch((error) => {
+          if (this.retryCount < retries) {
+            console.error("Error:", error);
+            console.log("Retrying...");
+            this.retryCount++;
+            setTimeout(fetchWithRetry, 1e3);
+          } else {
+            console.error("Max retries exceeded. Cannot establish SSE connection.");
+            this.streamEnded = true;
+            if (onStreamEnded) {
+              onStreamEnded(this.streamEnded);
+            }
+          }
+        });
+      } catch (error) {
+        if (this.retryCount < retries) {
+          console.error("Error:", error);
+          console.log("Retrying...");
+          this.retryCount++;
+          setTimeout(fetchWithRetry, 1e3);
+        } else {
+          console.error("Max retries exceeded. Cannot establish SSE connection.");
+          this.streamEnded = true;
+          if (onStreamEnded) {
+            onStreamEnded(this.streamEnded);
+          }
+        }
+      }
+    };
+    fetchWithRetry();
+  }
+};
+export {
+  Ore
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"sourcesContent":["interface OreOptions {\n  url: string;\n  headers?: HeadersInit;\n}\n\nclass Ore {\n  private url: string;\n  private headers?: HeadersInit;\n  private streamEnded = false;\n  private retryCount = 0;\n  private maxRetries = 3;\n\n  constructor(options: OreOptions) {\n    this.url = options.url;\n    this.headers = options.headers\n      ? {\n          \"Content-Type\": \"text/event-stream\",\n          \"Cache-Control\": \"no-cache\",\n          Connection: \"keep-alive\",\n          ...options.headers,\n        }\n      : {\n          \"Content-Type\": \"text/event-stream\",\n          \"Cache-Control\": \"no-cache\",\n          Connection: \"keep-alive\",\n        };\n  }\n\n  public fetchSSE(\n    onBufferReceived: (buffer: string, parts: Array<string>) => void,\n    onStreamEnded?: (streamEnded: boolean) => void,\n    customHeaders?: HeadersInit,\n    retries: number = this.maxRetries,\n  ): void {\n    const headers = { ...this.headers, ...customHeaders };\n\n    const fetchWithRetry = async (): Promise<void> => {\n      try {\n        const response = await fetch(this.url, {\n          method: \"GET\",\n          headers: headers,\n        });\n\n        if (!response.ok) {\n          throw new Error(\"Failed to connect to SSE endpoint\");\n        }\n\n        this.retryCount = 0;\n\n        const reader = response.body?.getReader();\n        const decoder = new TextDecoder(\"utf-8\");\n        let buffer = \"\";\n        const processText = ({ done, value }: ReadableStreamReadResult<Uint8Array>): any => {\n          if (done) {\n            this.streamEnded = true;\n            if (onStreamEnded) {\n              onStreamEnded(this.streamEnded);\n            }\n            return;\n          }\n\n          buffer += decoder.decode(value, { stream: true });\n\n          const parts = buffer.split(\"\\n\\n\");\n\n          onBufferReceived(buffer, parts);\n\n          return reader!.read().then(processText);\n        };\n        reader\n          ?.read()\n          .then(processText)\n          .catch((error) => {\n            if (this.retryCount < retries) {\n              console.error(\"Error:\", error);\n              console.log(\"Retrying...\");\n              this.retryCount++;\n              setTimeout(fetchWithRetry, 1000);\n            } else {\n              console.error(\"Max retries exceeded. Cannot establish SSE connection.\");\n              this.streamEnded = true;\n              if (onStreamEnded) {\n                onStreamEnded(this.streamEnded);\n              }\n            }\n          });\n      } catch (error) {\n        if (this.retryCount < retries) {\n          console.error(\"Error:\", error);\n          console.log(\"Retrying...\");\n          this.retryCount++;\n          setTimeout(fetchWithRetry, 1000);\n        } else {\n          console.error(\"Max retries exceeded. Cannot establish SSE connection.\");\n          this.streamEnded = true;\n          if (onStreamEnded) {\n            onStreamEnded(this.streamEnded);\n          }\n        }\n      }\n    };\n\n    fetchWithRetry();\n  }\n}\n\nexport { Ore, type OreOptions };\n"],"mappings":";AAKA,IAAM,MAAN,MAAU;AAAA,EACA;AAAA,EACA;AAAA,EACA,cAAc;AAAA,EACd,aAAa;AAAA,EACb,aAAa;AAAA,EAErB,YAAY,SAAqB;AAC/B,SAAK,MAAM,QAAQ;AACnB,SAAK,UAAU,QAAQ,UACnB;AAAA,MACE,gBAAgB;AAAA,MAChB,iBAAiB;AAAA,MACjB,YAAY;AAAA,MACZ,GAAG,QAAQ;AAAA,IACb,IACA;AAAA,MACE,gBAAgB;AAAA,MAChB,iBAAiB;AAAA,MACjB,YAAY;AAAA,IACd;AAAA,EACN;AAAA,EAEO,SACL,kBACA,eACA,eACA,UAAkB,KAAK,YACjB;AACN,UAAM,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,cAAc;AAEpD,UAAM,iBAAiB,YAA2B;AAChD,UAAI;AACF,cAAM,WAAW,MAAM,MAAM,KAAK,KAAK;AAAA,UACrC,QAAQ;AAAA,UACR;AAAA,QACF,CAAC;AAED,YAAI,CAAC,SAAS,IAAI;AAChB,gBAAM,IAAI,MAAM,mCAAmC;AAAA,QACrD;AAEA,aAAK,aAAa;AAElB,cAAM,SAAS,SAAS,MAAM,UAAU;AACxC,cAAM,UAAU,IAAI,YAAY,OAAO;AACvC,YAAI,SAAS;AACb,cAAM,cAAc,CAAC,EAAE,MAAM,MAAM,MAAiD;AAClF,cAAI,MAAM;AACR,iBAAK,cAAc;AACnB,gBAAI,eAAe;AACjB,4BAAc,KAAK,WAAW;AAAA,YAChC;AACA;AAAA,UACF;AAEA,oBAAU,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;AAEhD,gBAAM,QAAQ,OAAO,MAAM,MAAM;AAEjC,2BAAiB,QAAQ,KAAK;AAE9B,iBAAO,OAAQ,KAAK,EAAE,KAAK,WAAW;AAAA,QACxC;AACA,gBACI,KAAK,EACN,KAAK,WAAW,EAChB,MAAM,CAAC,UAAU;AAChB,cAAI,KAAK,aAAa,SAAS;AAC7B,oBAAQ,MAAM,UAAU,KAAK;AAC7B,oBAAQ,IAAI,aAAa;AACzB,iBAAK;AACL,uBAAW,gBAAgB,GAAI;AAAA,UACjC,OAAO;AACL,oBAAQ,MAAM,wDAAwD;AACtE,iBAAK,cAAc;AACnB,gBAAI,eAAe;AACjB,4BAAc,KAAK,WAAW;AAAA,YAChC;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACL,SAAS,OAAO;AACd,YAAI,KAAK,aAAa,SAAS;AAC7B,kBAAQ,MAAM,UAAU,KAAK;AAC7B,kBAAQ,IAAI,aAAa;AACzB,eAAK;AACL,qBAAW,gBAAgB,GAAI;AAAA,QACjC,OAAO;AACL,kBAAQ,MAAM,wDAAwD;AACtE,eAAK,cAAc;AACnB,cAAI,eAAe;AACjB,0BAAc,KAAK,WAAW;AAAA,UAChC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,mBAAe;AAAA,EACjB;AACF;","names":[]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@glamboyosa/ore",
+  "version": "0.0.1",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "@glamboyosa/ore",
+    "server-sent events",
+    "SSE",
+    "api"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "fmt": "pnpm biome format . --write && pnpm biome check . --apply-unsafe "
+  },
+  "files": [
+    "./dist/**"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^1.6.3",
+    "@types/node": "^20.11.30",
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.3"
+  }
+}