@nubisco/openbridge-sdk 0.29.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nubisco Lda
+
+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,21 @@
+# @nubisco/openbridge-sdk
+
+Plugin authoring SDK: the `definePlugin()` helper with full TypeScript types. This is the package plugin authors depend on.
+
+Part of [OpenBridge](https://github.com/nubisco/openbridge), a local-first home automation bridge for developers.
+
+## Install
+
+```sh
+npm install @nubisco/openbridge-sdk
+```
+
+Requires Node.js >= 20.
+
+## Documentation
+
+See the [OpenBridge documentation](https://github.com/nubisco/openbridge#readme). This package is published from the OpenBridge monorepo and versioned in lockstep with the `openbridge` daemon.
+
+## License
+
+MIT (c) Jose Silva

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+export type { Plugin, PluginManifest, PluginContext, PluginLogger, DeviceDescriptor } from '@nubisco/openbridge-core';
+export type { Service, Characteristic, CharacteristicValue, WithUUID, Categories } from 'hap-nodejs';
+export { Accessory } from 'hap-nodejs';
+import type { Accessory, Service as HAPService } from 'hap-nodejs';
+/**
+ * Extended accessory with context storage and subtype service lookup.
+ * This mirrors the Homebridge PlatformAccessory interface so plugins
+ * can work with both OpenBridge and Homebridge.
+ */
+export interface PlatformAccessory extends Accessory {
+    context: Record<string, unknown>;
+    getServiceByUUIDAndSubType(uuid: HAPService | string, subtype: string): HAPService | undefined;
+    configureController(controller: unknown): void;
+}
+/**
+ * Logger interface for plugin use.
+ * Compatible with both OpenBridge's PluginLogger and Homebridge's Logger.
+ */
+export interface Logger {
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+    debug(message: string, ...args: unknown[]): void;
+    log?(level: string, message: string, ...args: unknown[]): void;
+    success?(message: string, ...args: unknown[]): void;
+}
+/**
+ * API shim interface for platform plugins.
+ * Provides the HAP surface that platform plugins need to register accessories.
+ */
+export interface API {
+    hap: typeof import('hap-nodejs');
+    on(event: string, listener: (...args: unknown[]) => void): void;
+    emit(event: string, ...args: unknown[]): void;
+    registerPlatformAccessories(pluginName: string, platformName: string, accessories: unknown[]): void;
+    unregisterPlatformAccessories(pluginName: string, platformName: string, accessories: unknown[]): void;
+    updatePlatformAccessories(accessories: unknown[]): void;
+    platformAccessory: unknown;
+    user: {
+        storagePath(): string;
+        configPath(): string;
+        persistPath(): string;
+        cachedAccessoryPath(): string;
+    };
+    versionGreaterOrEqual?(version: string): boolean;
+}
+/** Define a plugin with type safety */
+export declare function definePlugin(plugin: import('@nubisco/openbridge-core').Plugin): import('@nubisco/openbridge-core').Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAIrH,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACpG,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,YAAY,CAAA;AAElE;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,0BAA0B,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;IAC9F,mBAAmB,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI,CAAA;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC/C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC/C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAChD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAChD,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC9D,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE,cAAc,YAAY,CAAC,CAAA;IAChC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;IAC/D,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC7C,2BAA2B,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IACnG,6BAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IACrG,yBAAyB,CAAC,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IACvD,iBAAiB,EAAE,OAAO,CAAA;IAC1B,IAAI,EAAE;QACJ,WAAW,IAAI,MAAM,CAAA;QACrB,UAAU,IAAI,MAAM,CAAA;QACpB,WAAW,IAAI,MAAM,CAAA;QACrB,mBAAmB,IAAI,MAAM,CAAA;KAC9B,CAAA;IACD,qBAAqB,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CACjD;AAID,uCAAuC;AACvC,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,0BAA0B,EAAE,MAAM,GAChD,OAAO,0BAA0B,EAAE,MAAM,CAE3C"}

package/dist/index.js

@@ -0,0 +1,7 @@
+export { Accessory } from 'hap-nodejs';
+// ─── Helper ──────────────────────────────────────────────────────────────────
+/** Define a plugin with type safety */
+export function definePlugin(plugin) {
+    return plugin;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAiDtC,gFAAgF;AAEhF,uCAAuC;AACvC,MAAM,UAAU,YAAY,CAC1B,MAAiD;IAEjD,OAAO,MAAM,CAAA;AACf,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@nubisco/openbridge-sdk",
+  "version": "0.29.0",
+  "description": "Plugin authoring SDK for OpenBridge — definePlugin() helper with full TypeScript types",
+  "author": "José Silva <jose@nubisco.io>",
+  "license": "MIT",
+  "homepage": "https://github.com/nubisco/openbridge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nubisco/openbridge.git",
+    "directory": "packages/sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/nubisco/openbridge/issues"
+  },
+  "keywords": [
+    "homekit",
+    "home-automation",
+    "plugin",
+    "sdk",
+    "typescript",
+    "openbridge"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "hap-nodejs": ">=0.12.0",
+    "@nubisco/openbridge-core": "0.29.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "@types/node": "^20.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}