diff --git a/license b/license new file mode 100644 index 0000000..40e0dda --- /dev/null +++ b/license @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Task Venture Capital GmbH + +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. diff --git a/readme.md b/readme.md index ee4cbe0..65aa62c 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,116 @@ # @smarthome.exchange/api -Typed API client for connecting tools, CLIs, and apps to a smarthome.exchange hub. +🔌 Typed API client for connecting tools, CLIs, automations, and apps to a smarthome.exchange hub. + +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/](https://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/](https://code.foss.global/) account to submit Pull Requests directly. + +## Install + +```bash +pnpm add @smarthome.exchange/api +``` + +## Basic Usage + +```ts +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 + +```ts +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 + +```ts +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 + +```bash +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](./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. + +### Company Information + +Task Venture Capital GmbH\ +Registered at District Court Bremen HRB 35230 HB, Germany + +For any legal inquiries or further information, please contact us via email at hello@task.vc. + +By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.