@ambulancewa/linxio-js 2.23.2

package/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+Copyright (c) 2026 Ambulance Western Australia Limited. linxio-js is built on 
+the Linxio platform and is not officially connected with or endorsed by Linxio
+and/or its affiliates. Any proprietary or copyrighted content remains the 
+property of Linxio, its affiliates, and/or the respective owner of the 
+copyrighted material.
+
+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/README.md

@@ -0,0 +1,117 @@
+![@ambulancewa/linxio-js](https://raw.githubusercontent.com/ambulancewa/linxio-js/refs/heads/main/repo-header.png)
+
+linxio-js is a secure, lightweight, high-performance Node.js SDK for interacting with the [`Linxio`](https://linxio.com/) API. The client is fully-typed for use in Typescript projects, and is available as ECMAScript and CommonJS modules for use pretty much anywhere you can run Javascript. Query vehicles, drivers, and devices, stream live GPS positions, subscribe to real-time notifications, auto-paginate large fleets, export reports, manage geofences and routes, and more!
+
+```ts
+import { createClient } from "@ambulancewa/linxio-js";
+
+const linxio = createClient();
+
+await linxio.auth.login({
+    email: process.env.LINXIO_EMAIL!,
+    password: process.env.LINXIO_PASSWORD!,
+});
+
+const { data, error } = await linxio.vehicles.iterate({
+    fields: ["id", "regNo", "lastLoggedAt"],
+    limit: 100,
+});
+```
+
+## 👏 Key Features
+
+- Fully typed TypeScript API.
+- Available as both ESM and CommonJS packages.
+- Fetch-native HTTP client with timeouts, typed errors, and safe JSON handling.
+- Service methods return `{ data, error }` results for straightforward script ergonomics.
+- Automatic JWT refresh with concurrent refresh coalescing.
+- Exponential backoff retries for idempotent requests.
+- Domain services for vehicles, routes, geofences, devices, drivers, sensors, fuel, users, clients, reports, digital forms, cameras, and realtime.
+- Auto-pagination helpers and streaming iterators for paginated endpoints.
+- Low-level `client.request()` escape hatch for tenant-specific endpoints.
+- Socket.IO realtime helpers for live coordinates and notifications.
+
+## 📦 Installation
+
+Prerequisites for installation:
+- [Node.js](https://nodejs.org/en/download/) (v14 or higher)
+- [pnpm](https://pnpm.io/installation) or your preferred compatible package manager
+
+Installation is super straightforward. Simply install the package from npmjs:
+
+```bash
+pnpm add @ambulancewa/linxio-js
+```
+
+Full documentation is available at our Open Source Software Projects (OSSP) site: https://linxio-js.ambulancewa.dev
+
+## ⚡ Usage
+
+```ts
+const login = await linxio.auth.login({
+    email,
+    password,
+    domain: "optional-domain",
+});
+
+if (login.error) {
+    throw login.error;
+}
+
+console.log(login.data.expireAt);
+```
+
+Once initialised, you can use the client to query the Linxio API:
+
+```ts
+const { data: vehicles, error, meta } = await linxio.vehicles.list({
+    fields: ["id", "regNo"],
+    limit: 50,
+    sort: "regNo",
+});
+
+if (error) {
+    throw error;
+}
+
+console.log(meta.total, vehicles);
+
+const routes = await linxio.routes.getVehicleRoutes(vehicles[0].id, {
+    dateFrom: "2026-06-01T00:00:00+08:00",
+    dateTo: "2026-06-08T00:00:00+08:00",
+});
+```
+
+## ⚙️ Advanced requests
+
+Use domain services for normal workflows. For tenant-specific or newly
+discovered endpoints, `client.request()` keeps the same auth, retry, timeout,
+and token-refresh behavior.
+
+```ts
+const response = await linxio.request("GET", "/vehicles/count");
+```
+
+## 🔴 Realtime
+
+```ts
+const unsubscribe = linxio.realtime.onPosition([304], (position) => {
+    console.log(position.vehicleId, position.lat, position.lng);
+});
+
+unsubscribe();
+```
+
+## ❌ Errors
+
+```ts
+import { LinxioApiError } from "linxio-js";
+
+const { error } = await linxio.vehicles.create({});
+
+if (error instanceof LinxioApiError) {
+    console.error(error.status, error.path, error.body);
+}
+```
+
+Low-level `client.request()` calls throw typed SDK errors directly.