@lovice/api

TypeScript/JavaScript client library for the Device Locator API. This package provides type-safe access to the Device Locator service APIs.

Installation

npm install @lovice/api
# or
yarn add @lovice/api
# or
pnpm add @lovice/api
# or 
bun install @lovice/api

Usage

Basic Setup Example

import { createClient } from "@connectrpc/connect";
import { createGrpcWebTransport } from "@connectrpc/connect-web";
import { PositionsService } from '@lovice/api';

// Create a transport
const transport = createGrpcWebTransport({
  baseUrl: 'https://api.device-locator.com',
  useBinaryFormat: true,
});

// Create the client
const client = createClient(PositionsService, transport);

// Example: Using the positions service
const position = await client.getPosition({ deviceId: "device-123" });

API Documentation

Types

The package includes the following type definitions:

• Position - Represents a device's location with latitude, longitude, altitude, speed, and heading
• DevicePosition - Combines a device ID with its position
• Device - Device information including ID and name
• User - User information including ID, name, and associated devices
• Group - Group information including ID, name, description, and associated users

Services

This is not a full list of services. These are just some examples.

• PositionsService - Service for managing device positions
  • sendPositions(positions: DevicePosition[]): Promise<SendPositionsResponse> - Send multiple device position updates
  • getGroup(groupId: string): Promise<GetGroupResponse> - Get a group by ID, including user data and their devices
  • getGroupPositions(groupId: string): Promise<GetGroupPositionsResponse> - Get positions for all devices in a group

Development

This package is automatically generated from Protocol Buffer definitions. Do not modify the generated code directly. Instead, make changes to the proto files in the parent repository.

Building

The package is built using the following tools:

• buf - Protocol Buffer compiler
• protoc-gen-es - TypeScript code generator
• protoc-gen-connect-es - Connect-ES code generator

To rebuild the package:

make generate

License

This package is part of the Device Locator project and is subject to the same license terms as the main project.