\n The official JavaScript and TypeScript SDK for the Fleetbase API.\n
\n\n
\n \n \n \n \n \n
\n\nFleetbase SDK provides typed resources, stores, API actions, browser and Node.js transports, and extension points for custom adapters. Version 2 keeps the established v1 consumer API while providing correct ESM, CommonJS, TypeScript, and browser builds.\n\n## Installation\n\n```sh\n# npm\nnpm install @fleetbase/sdk\n\n# pnpm\npnpm add @fleetbase/sdk\n\n# Yarn\nyarn add @fleetbase/sdk\n\n# Bun\nbun add @fleetbase/sdk\n```\n\nThe SDK supports Node.js 20.19.4 and newer at runtime, including legacy Node 20 consumers. Use Node 22/24 for maintained deployments; building this repository requires Node 22.13 or newer. Its browser transport uses the standard Fetch API, so it works without framework-specific dependencies in modern browser applications and bundlers.\n\n## Quick start\n\n```ts\nimport Fleetbase from '@fleetbase/sdk';\n\nconst fleetbase = new Fleetbase('your_public_key');\n\nconst place = await fleetbase.places.create({\n name: 'Space Needle',\n street1: '400 Broad Street',\n city: 'Seattle',\n state: 'WA',\n country: 'US',\n});\n\nconsole.log(place.id);\n```\n\nThe same root API is available to CommonJS consumers:\n\n```js\nconst { default: Fleetbase } = require('@fleetbase/sdk');\n\nconst fleetbase = new Fleetbase('your_server_key');\n```\n\nNever expose a Fleetbase secret key in browser code. Browser applications must use a public key. Keep server credentials in environment variables or a secret manager.\n\n## Resources and stores\n\nThe client exposes stores for frequently used API resources:\n\n```ts\nconst order = await fleetbase.orders.findRecord('order_123');\nconst places = await fleetbase.places.query({ city: 'Seattle' });\nconst driver = await fleetbase.drivers.findRecord('driver_123');\nconst quotes = await fleetbase.serviceQuotes.fromPreliminary({\n pickup: 'place_pickup',\n dropoff: 'place_dropoff',\n});\n```\n\nDriver-app stores cover the FleetOps driver workflow — `manifests`, `manifestStops`, `trailers`, `fuelReports`, `issues`, and `workOrders` — alongside the driver-scoped helpers on existing stores:\n\n```ts\nconst manifests = await fleetbase.drivers.manifests('driver_123', { status: 'active' });\nconst manifest = await fleetbase.manifests.optimize('manifest_123', { latitude: 1.29, longitude: 103.85 });\nawait fleetbase.manifestStops.update('manifest_stop_123', { status: 'arrived' }); // PATCH\nawait fleetbase.trailers.attach('trailer_123', { vehicle: 'vehicle_123' });\nconst trailers = await fleetbase.vehicles.trailers('vehicle_123');\nawait fleetbase.drivers.changePassword('driver_123', { password: 'current', new_password: 'next', new_password_confirmation: 'next' });\n```\n\nInspection stores and vehicle inspection actions are deferred until a released Fleet-Ops driver inspection API can be verified. Trailer attach returns a raw connection; detach and work-order send return acknowledgements without replacing the resource's attributes.\n\nResource instances can also be created directly:\n\n```ts\nimport { Place, Point } from '@fleetbase/sdk';\n\nconst place = new Place({\n name: 'Warehouse',\n location: new Point(47.6062, -122.3321),\n});\n```\n\nThe root package exports the existing resource classes, adapters, collection helpers, resolver and registry hooks, string helpers, validation utilities, and TypeScript request/configuration types.\n\n## Custom adapters\n\nImplement the stable adapter interface when requests need to use an application-specific transport:\n\n```ts\nimport { Adapter } from '@fleetbase/sdk';\n\nclass CustomAdapter extends Adapter {\n get(path, query, options) {\n return customRequest('GET', path, { query, ...options });\n }\n\n post(path, data, options) {\n return customRequest('POST', path, { data, ...options });\n }\n\n put(path, data, options) {\n return customRequest('PUT', path, { data, ...options });\n }\n\n patch(path, data, options) {\n return customRequest('PATCH', path, { data, ...options });\n }\n\n delete(path, options) {\n return customRequest('DELETE', path, options);\n }\n}\n\nconst fleetbase = new Fleetbase('your_key', {\n adapter: new CustomAdapter(),\n});\n```\n\nCalling `fleetbase.setAdapter(adapter)` updates the client and all existing stores.\n\n## Errors\n\nTransport failures reject with `FleetbaseError`, which remains a normal JavaScript `Error` and adds safe structured details when available:\n\n```ts\nimport { FleetbaseError } from '@fleetbase/sdk';\n\ntry {\n await fleetbase.orders.findRecord('missing');\n} catch (error) {\n if (error instanceof FleetbaseError) {\n console.error(error.status, error.code, error.requestId);\n }\n}\n```\n\n## Package formats\n\nThe npm package contains:\n\n- native ESM with declarations and source maps;\n- true CommonJS (`.cjs`) with CommonJS declarations;\n- a minified browser bundle at `dist/fleetbase.min.js`;\n- no runtime dependencies.\n\nEvery release candidate is checked with Publint, Are The Types Wrong, packed-tarball content and size assertions, ESM/CommonJS export parity, strict TypeScript, cross-platform smoke tests, and 100% statement, branch, function, and line coverage.\n\nProduction-build fixtures verify the exact candidate tarball with Vite, webpack, esbuild, React, Vue, Svelte, Angular, Ember, Next.js (client and server), Nuxt (client and server), Expo web/React Native Android, and an edge-runtime VM. Chromium, Firefox, and WebKit gates also execute SDK construction, Fetch transport, resource serialization, authorization headers, and browser-only key validation. See the [compatibility policy](./docs/compatibility.md) for the release-blocking matrix.\n\n## Development\n\n```sh\npnpm install --frozen-lockfile\npnpm run verify\n```\n\nPull-request tests are deterministic and do not need Fleetbase credentials. API behavior is cross-checked against the official [Postman collections](https://github.com/fleetbase/postman), [Core API](https://github.com/fleetbase/core-api), and [Fleet-Ops](https://github.com/fleetbase/fleetops) sources.\n\nMaintainers can also run the secret-gated `Live API integration` workflow. It installs the exact packed SDK candidate and performs a read-only current-organization request using the `FLEETBASE_PUBLIC_KEY` repository secret; scheduled runs skip cleanly until that secret is configured, while manually dispatched runs fail clearly when it is absent.\n\nSee the [modernization plan](https://github.com/fleetbase/fleetbase-js/blob/main/MODERNIZATION_PLAN.md) for the v2 compatibility and release program and the [contribution guide](https://github.com/fleetbase/fleetbase-js/blob/main/CONTRIBUTING.md) for the development workflow.\n\n## License\n\n[AGPL-3.0-or-later](./LICENSE.md)\n","readmeFilename":"README.md"}
![\"Fleetbase\"](\"https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/fleetbase-logo-svg.svg\"){kind=logo}
\n![\"CI\"](\"https://github.com/fleetbase/fleetbase-js/actions/workflows/ci.yml/badge.svg?branch=main\"){kind=icon}
\n ![\"Coverage\"](\"https://codecov.io/gh/fleetbase/fleetbase-js/branch/main/graph/badge.svg\"){kind=icon}
\n ![\"npm](\"https://img.shields.io/npm/v/@fleetbase/sdk?label=npm\")
![\"Weekly](\"https://img.shields.io/npm/dw/@fleetbase/sdk\")
![\"License\"](\"https://img.shields.io/github/license/fleetbase/fleetbase-js\")