This package wraps the hub's TypedRequest boundary in a programmer-friendly client. It speaks HTTP by default, switches to TypedSocket after start(), and returns the exact response shapes from @smarthome.exchange/interfaces.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @smarthome.exchange/api

Basic Usage

import { SmarthomeExchangeApiClient } from '@smarthome.exchange/api';

const client = new SmarthomeExchangeApiClient({
  hubUrl: 'http://localhost:8080',
});

const snapshotResponse = await client.getHomeSnapshot();
console.log(snapshotResponse.snapshot.home.name);

const deviceResponse = await client.listDevices({
  capability: 'light',
});
console.log(deviceResponse.devices.map((deviceArg) => deviceArg.name));

Socket Mode

const client = new SmarthomeExchangeApiClient({ hubUrl: 'http://localhost:8080' });

await client.start();

try {
  const agents = await client.listAgents();
  console.log(agents.statuses);
} finally {
  await client.stop();
}

Calling start() creates a TypedSocket client. Calls made before start() or after stop() use HTTP requests against ${hubUrl}/typedrequest. The useSocket option is reserved in the options interface; the current implementation chooses the transport based on whether start() has been called.

Client Methods

Method	Typed operation	Returns
`listDevices(filter?)`	`listDevices`	`{ devices }`
`listAgents()`	`listAgents`	`{ agents, statuses }`
`listTools(filter?)`	`listTools`	`{ tools }`
`getHomeSnapshot()`	`getHomeSnapshot`	`{ snapshot }`
`executeToolPlan(plan)`	`executeToolPlan`	`IToolPlanResult`
`listApprovals(filter?)`	`listApprovals`	`{ approvals }`
`submitApproval(request)`	`submitApproval`	Updated approval result

Tool Plan Example

const result = await client.executeToolPlan({
  id: 'plan:dim-living-room',
  callerId: 'app:console',
  title: 'Dim living room lights',
  reason: 'User selected the evening scene.',
  confidence: 1,
  calls: [
    {
      id: 'call:living-floor-dim',
      toolId: 'device:light.living.floor:set',
      callerId: 'app:console',
      input: {
        deviceId: 'light.living.floor',
        brightness: 35,
      },
    },
  ],
});

console.log(result.results[0]?.status);

Scripts

pnpm test
pnpm build
pnpm buildDocs

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

readme.md

@smarthome.exchange/api