relayx-webjs 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+V1.0.8
+- History API fetch() to consume()
+
+V1.0.7
+- History API added
+- README updated to explain history API usage

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 TerraOrbital
+
+   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.

package/README.md

@@ -0,0 +1,186 @@
+# Relay JS Library for the Web
+![License](https://img.shields.io/badge/Apache_2.0-green?label=License)<br>
+A powerful library for integrating real-time communication into your web app, powered by the Relay Network.
+
+## Features
+1. Real-time communication made easy—connect, publish, and subscribe with minimal effort.
+2. Automatic reconnection built-in, with a 2-minute retry window for network disruptions.
+3. Message persistence during reconnection ensures no data loss when the client reconnects.
+
+## Installation
+Install the relay library by running the command below in your terminal<br>
+`npm install relayx-webjs`
+
+## Usage
+### Prerequisites
+1. Obtain API key and Secret key
+2. Initialize the library
+    ```javascript
+    import { Realtime, CONNECTED, RECONNECT, DISCONNECTED } from "relayx-webjs"
+
+    var realtime = new Realtime({
+        api_key: process.env.api_key,
+        secret: process.env.secret,
+    });
+    realtime.init();
+
+    // Initialization of topic listeners go here... (look at examples/example_chat.js for full implementation)
+
+    realtime.connect();
+
+    // Other application logic...
+    ```
+
+### Usage
+1. <b>Publish</b><br>
+Send a message to a topic:<br>
+    ```javascript
+    var sent = await realtime.publish("power_telemetry", {
+        "voltage_V": 5,
+        "current_mA": 400,
+        "power_W": 2 
+    });
+
+    if(sent){
+        console.log("Message was successfully sent to topic => power_telemetry");
+    }else{
+        console.log("Message was not sent to topic => power_telemetry");
+    }
+    ```
+2. <b>Listen</b><br>
+Subscribe to a topic to receive messages:<br>
+    ```javascript
+    await realtime.on("power_telemetry", (data) => {
+        console.log(data);
+    });
+    ```
+3. <b>Turn Off Listener</b><br>
+Unsubscribe from a topic:<br>
+    ```javascript
+    var unsubscribed = await realtime.off("power_telemetry");
+
+    if(unsubscribed){
+        console.log("Successfully unsubscribed from power_telemetry");
+    }else{
+        console.log("Unable to unsubscribe from power_telemetry");
+    }
+    ```
+4. <b>History</b><br>
+Get previously published messages between a start date and end date. Dates are in UTC.
+    ```javascript
+    var start = new Date();
+    var past = start.setDate(start.getDate() - 4) // Get start date from 4 days ago
+    var startDate = new Date(past)
+
+    var end = new Date();
+    var past = end.setDate(end.getDate() - 2) // Get end date from 2 days ago
+    var endDate = new Date(past)
+
+    var history = await realtime.history(topic, startDate, endDate)
+    ```
+    The end date is optional. Supplying only the start time will fetch all messages from the start time to now.
+    ```javascript
+    var start = new Date();
+    var past = start.setDate(start.getDate() - 4) // Get start date from 4 days ago
+    var startDate = new Date(past)
+
+    // This will get all messages from 4 days ago to now
+    var history = await realtime.history(topic, startDate)
+    ```
+5. <b>Valid Topic Check</b><br>
+Utility function to check if a particular topic is valid
+    ```javascript
+    var isValid = realtime.isTopicValid("topic");
+
+    console.log(`Topic Valid => ${isValid}`);
+    ```
+6. <b>Sleep</b><br>
+Utility async function to delay code execution
+    ```javascript
+    console.log("Starting code execution...");
+    await realtime.sleep(2000) // arg is in ms
+    console.log("This line executed after 2 seconds");
+    ```
+7. <b>Close Connection to Relay</b><br>
+Manually disconnect from the Relay Network
+    ```javascript
+    // Logic here
+
+    realtime.close();
+    ```
+
+## System Events
+1. <b>CONNECTED</b><br>
+This event is fired when the library connects to the Relay Network.
+    ```javascript
+    await realtime.on(CONNECTED, () => {
+        console.log("Connected to the Relay Network!");
+    });
+    ```
+
+2. <b>RECONNECT</b><br>
+This event is fired when the library reconnects to the Relay Network. This is only fired when the disconnection event is not manual, i.e, disconnection due to network issues.
+    ```javascript
+    await realtime.on(RECONNECT, (status) => {
+        console.log(`Reconnected! => ${status}`);
+    });
+    ```
+    `status` can have values of `RECONNECTING` & `RECONNECTED`.
+
+    `RECONNECTING` => Reconnection attempts have begun. If `status == RECONNECTING`, the `RECONNECT` event is fired every 1 second.<br>
+    `RECONNECTED` => Reconnected to the Relay Network.
+3. <b>DISCONNECTED</b><br>
+This event is fired when the library disconnects from the Relay Network. This includes disconnection due to network issues as well.
+    ```javascript
+    await realtime.on(DISCONNECTED, () => {
+        console.log("Disconnected from the Relay Network");
+    });
+    ```
+4. <b>MESSAGE_RESEND</b><br>
+This event is fired when the library resends the messages upon reconnection to the Relay Network.
+    ```javascript
+    await realtime.on(MESSAGE_RESEND, (messages) => {
+        console.log("Offline messages may have been resent");
+        console.log("Messages");
+        console.log(messages);
+    });
+    ```
+    `messages` is an array of the following object,<br>
+    ```json
+    {
+        "topic": "<topic the message belongs to>",
+        "message": "<message you sent>",
+        "resent": "<boolean, indicating if the message was sent successully>"
+    }
+    ```
+
+## API Reference
+1. init()<br>
+Initializes library with configuration options.
+    * debug (boolean): enables library level logging
+2. connect()<br>
+Connects the library to the Relay Network. This is an async function.
+3. close()<br>
+Disconnects the library from the Relay Network.
+3. on()<br>
+Subscribes to a topic. This is an async function.
+     * @param {string} topic - Name of the event
+     * @param {function} func - Callback function to call on user thread
+     * @returns {boolean} - To check if topic subscription was successful
+3. off()<br>
+Deletes reference to user defined event callback for a topic. This will stop listening to a topic. This is an async function.
+     * @param {string} topic 
+     * @returns {boolean} - To check if topic unsubscribe was successful
+4. history()<br>
+Get a list of messages published in the past. This is an async function.<br>
+A list of messages can be obtained using a start time and end time. End time is optional. If end time is not specified, all messages from the start time to now is returned.
+     * @param {string} topic 
+     * @param {Date} start
+     * @param {Date} end
+     * @returns {JSON Array} - List of messages published in the past
+5. isTopicValid()<br>
+Checks if a topic can be used to send messages to.
+     * @param {string} topic - Name of event
+     * @returns {boolean} - If topic is valid or not
+6. sleep()<br>
+Pauses code execution for a user defined time. Time passed into the method is in milliseconds.  This is an async function.

package/example/README.md

@@ -0,0 +1,82 @@
+# Relay Chat Demo
+
+A minimal React + Relay SDK example that lets you join a chat room and exchange messages in real‑time. The project is built with **Vite**, **React 18**, **TailwindCSS** and the Relay SDK.
+
+---
+
+## 1  Prerequisites
+
+* **Node.js ≥ 18** — required only for the local dev tooling (Vite/React build). **Your end‑users do *****not***** need Node**; the compiled site runs entirely in the browser.
+* A **Relay** account with:
+
+  * **API Key** 
+  * **Secret Key**
+
+---
+
+## 2  Clone & set your keys
+
+```bash
+# 1. Grab the repo (or unzip the archive you downloaded)
+$ git clone https://github.com/Realtime-Relay/relayx-webjs.git
+$ cd examples/chat-app
+
+# 2. Export your Relay credentials *in the same shell session*:
+#    (On Windows PowerShell use $Env: instead of export)
+$ export VITE_API_KEY="pk_live_yourKeyHere"
+$ export VITE_SECRET="sk_live_yourSecretHere"
+```
+
+> **Tip :** You can also create a `.env.local` (git‑ignored) and drop the two variables there:
+>
+> ```text
+> VITE_API_KEY=pk_live_yourKeyHere
+> VITE_SECRET=sk_live_yourSecretHere
+> ```
+
+---
+
+## 3  Install packages
+
+```bash
+npm install         # or yarn / pnpm install
+```
+
+---
+
+## 4  Run the dev server
+
+```bash
+npm run dev         # Vite will serve http://localhost:5173
+```
+
+To create an optimised production build:
+
+```bash
+npm run build       # output in /dist
+npm run preview     # serve the built bundle locally
+```
+
+---
+
+## 5  Using the app (walk‑through)
+
+All screenshots live in `./screenshots`.
+
+| Step | Action                                                                                                                                       | Screenshot                                    |
+| ---- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- |
+| 1    | **Landing page.** Enter a room name (e.g. `userinfo`) and click **Join**.                                                                     | ![Landing page](./screenshots/screen_1.png)   |
+| 2    | **Chat view (empty).** The header shows the room and connection status. When the **Connected** badge turns green you can type.               | ![Empty chat](./screenshots/screen_2.png)     |
+| 3    | **Exchange messages.** Open another tab/browser, join the same room, and start chatting—messages appear instantly thanks to Relay’s pub‑sub. | ![Chat in action](./screenshots/screen_3.png) |
+
+---
+
+## 6  Troubleshooting
+
+| Problem                         | Fix                                                                    |
+| ------------------------------- | ---------------------------------------------------------------------- |
+| **White screen / build errors** | Make sure Node ≥ 18 and you ran `npm install`.                         |
+| **“Not authorised” messages**   | Double‑check `VITE_API_KEY` / `VITE_SECRET`.               |
+| **Connection shows Offline**    | Browser can’t reach Relay cluster—check network/firewall or try again. |
+
+---

package/example/chat-app/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Relay Chat Demo</title>
+  </head>
+  <body class="min-h-screen">
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>