sesame-kit 0.4.0

package/types/ir.d.ts

@@ -0,0 +1,147 @@
+/**
+ * 登録済みリモコン一覧を取得 (ページング)。
+ * @param {{type:number, companyID:string, page?:number, pageSize?:number}} p
+ *   type は **実 remote.type** (自己学習=0xFE00, UI メニューの 0xFEFF ではない / 上記トラップ参照)
+ */
+export function getRemoteList(client: any, p: {
+    type: number;
+    companyID: string;
+    page?: number;
+    pageSize?: number;
+}): Promise<any>;
+/**
+ * プリセットリモコン (メーカー DB) 検索。最大 1000 件返却。
+ * @param {{type:number, companyID:string, searchTerm:string}} p
+ */
+export function searchRemoteList(client: any, p: {
+    type: number;
+    companyID: string;
+    searchTerm: string;
+}): Promise<any>;
+/**
+ * リモコンを追加 (Hub3 1 台あたり 3 個上限がサーバ側にある)。
+ * `remote` の形は biz3 がそのまま remoteDevice オブジェクトを渡しているので、
+ * 呼び出し側で {hub3DeviceId, type, name, irOperation, ...} を入れる。
+ */
+export function addIRRemote(client: any, { remote, companyID }: {
+    remote: any;
+    companyID: any;
+}): Promise<any>;
+/** リモコン削除。 */
+export function deleteIRRemote(client: any, { hub3DeviceId, uuid, companyID }: {
+    hub3DeviceId: any;
+    uuid: any;
+    companyID: any;
+}): Promise<any>;
+/** リモコンの alias を更新。注: 命名差で `deviceId`/`uuid`。 */
+export function updateRemoteAlias(client: any, { hub3DeviceId, uuid, alias, companyID }: {
+    hub3DeviceId: any;
+    uuid: any;
+    alias: any;
+    companyID: any;
+}): Promise<any>;
+/**
+ * IR キー (ボタン) を追加。学習フロー (learnIRKey) から呼ばれることが多い。
+ * `irCode` の形は biz3 がオブジェクトをそのまま乗せるので、
+ * 呼び出し側で {hub3DeviceId, remoteId, name, irData, irWaveLength, irType, ...} を入れる。
+ */
+export function addIRCode(client: any, { irCode, companyID }: {
+    irCode: any;
+    companyID: any;
+}): Promise<any>;
+/** キー名変更。 */
+export function updateIRCode(client: any, { hub3DeviceId, remoteId, keyUUID, name, companyID }: {
+    hub3DeviceId: any;
+    remoteId: any;
+    keyUUID: any;
+    name: any;
+    companyID: any;
+}): Promise<any>;
+/** キー削除。 */
+export function deleteIRCode(client: any, { hub3DeviceId, remoteId, keyUUID, companyID }: {
+    hub3DeviceId: any;
+    remoteId: any;
+    keyUUID: any;
+    companyID: any;
+}): Promise<any>;
+/** 現在の IR モード (CONTROL=0 / REGISTER=1) を取得。 */
+export function getIRMode(client: any, { deviceId, companyID }: {
+    deviceId: any;
+    companyID: any;
+}): Promise<any>;
+/** モード切替。学習するには REGISTER に入れる必要がある。 */
+export function setIRMode(client: any, { deviceId, mode, companyID }: {
+    deviceId: any;
+    mode: any;
+    companyID: any;
+}): Promise<any>;
+/**
+ * IR データ (= 学習で取り込まれた赤外線波形) の購読を開始。
+ * 戻り値は `{ unsubscribe, onData }`。`onData(fn)` で `subscribeIRDataRsp` 受信ごとに fn が呼ばれる。
+ * 利用後は必ず `unsubscribe()` を呼ぶこと。
+ */
+export function subscribeIRData(client: any, { deviceId, companyID }: {
+    deviceId: any;
+    companyID: any;
+}): Promise<{
+    onData(fn: any): () => boolean;
+    unsubscribe(): void;
+}>;
+/** モード変化 (例: REGISTER から CONTROL に戻った瞬間) の購読。subscribeIRData と同形。 */
+export function subscribeIRMode(client: any, { deviceId, companyID }: {
+    deviceId: any;
+    companyID: any;
+}): Promise<{
+    onData(fn: any): () => boolean;
+    unsubscribe(): void;
+}>;
+/**
+ * 学習で取った irData を既知のメーカー DB と照合する。
+ * @param {{irData:string, irType:number, brandName?:string, companyID:string}} p
+ */
+export function matchRemote(client: any, { irData, irType, brandName, companyID }: {
+    irData: any;
+    irType: any;
+    brandName: any;
+    companyID: any;
+}): Promise<any>;
+/**
+ * 物理リモコンのボタン 1 個を学習して、リモコンに新キーとして登録する。
+ *
+ *   1. setIRMode(REGISTER) — Hub3 を学習モードに
+ *   2. subscribeIRData — 波形イベント購読
+ *   3. (ユーザが物理リモコンを Hub3 に向けてボタンを押す)
+ *   4. subscribeIRDataRsp イベントで波形を受信
+ *   5. unsubscribeIRData + setIRMode(CONTROL)
+ *   6. addIRCode で名前付きキーとして保存
+ *
+ * @param {{
+ *   hub3DeviceId: string,
+ *   remoteId: string,            // 既存リモコンの irDeviceUUID
+ *   keyName: string,
+ *   irType: number,              // remote.type
+ *   companyID: string,
+ *   timeoutMs?: number,          // ボタン押下待ち timeout (default 60s)
+ *   onPrompt?: () => void,       // 学習モード突入後に呼ばれる (ユーザに「ボタン押して」と促す)
+ * }} p
+ * @returns {Promise<{keyUUID: string, captured: any, saved: any}>}
+ *   keyUUID はクライアント発番 (これを send の command に使う)
+ */
+export function learnIRKey(client: any, p: {
+    hub3DeviceId: string;
+    remoteId: string;
+    keyName: string;
+    irType: number;
+    companyID: string;
+    timeoutMs?: number;
+    onPrompt?: () => void;
+}): Promise<{
+    keyUUID: string;
+    captured: any;
+    saved: any;
+}>;
+export const MODE: Readonly<{
+    CONTROL: 0;
+    REGISTER: 1;
+}>;
+//# sourceMappingURL=ir.d.ts.map

package/types/ir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir.d.ts","sourceRoot":"","sources":["../src/ir.js"],"names":[],"mappings":"AAsDA;;;;GAIG;AACH,8CAHW;IAAC,IAAI,EAAC,MAAM,CAAC;IAAC,SAAS,EAAC,MAAM,CAAC;IAAC,IAAI,CAAC,EAAC,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAC,MAAM,CAAA;CAAC,gBAczE;AAED;;;GAGG;AACH,iDAFW;IAAC,IAAI,EAAC,MAAM,CAAC;IAAC,SAAS,EAAC,MAAM,CAAC;IAAC,UAAU,EAAC,MAAM,CAAA;CAAC,gBAc5D;AAID;;;;GAIG;AACH;;;iBAKC;AAED,cAAc;AACd;;;;iBAKC;AAED,iDAAiD;AACjD;;;;;iBAYC;AAID;;;;GAIG;AACH;;;iBAKC;AAED,aAAa;AACb;;;;;;iBAaC;AAED,YAAY;AACZ;;;;;iBAYC;AAID,+CAA+C;AAC/C;;;iBAKC;AAED,uCAAuC;AACvC;;;;iBAKC;AAED;;;;GAIG;AACH;;;;;;GA+BC;AAED,qEAAqE;AACrE;;;;;;GAwBC;AAID;;;GAGG;AACH;;;;;iBAcC;AAID;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,2CAZW;IACN,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB,GACS,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAC,CAAC,CAwCjE;AAtSD;;;GAGG"}

package/types/itemcodes.d.ts

@@ -0,0 +1,21 @@
+export const ITEM_CODES: Readonly<{
+    NONE: 0;
+    REGISTRATION: 1;
+    LOGIN: 2;
+    USER: 3;
+    HISTORY: 4;
+    VERSION_TAG: 5;
+    TIME: 8;
+    AUTOLOCK: 11;
+    INITIAL: 14;
+    MAGNET: 17;
+    HISTORY_DELETE: 18;
+    MECH_SETTING: 80;
+    MECH_STATUS: 81;
+    LOCK: 82;
+    UNLOCK: 83;
+    MOVE_TO: 84;
+    TOGGLE: 88;
+    CLICK: 89;
+}>;
+//# sourceMappingURL=itemcodes.d.ts.map

package/types/itemcodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemcodes.d.ts","sourceRoot":"","sources":["../src/itemcodes.js"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;;;;GAmBG"}

package/types/lock.d.ts

@@ -0,0 +1,89 @@
+/**
+ * lock 制御コマンドを送信し、サーバ ack を待って解決する。
+ *
+ * @param {import("./transport.js").Hub3WsClient} client
+ * @param {{
+ *   deviceId: string,    // ロックの deviceUUID
+ *   secretKey: string,   // 32hex のロック共通鍵 (devices command で取得)
+ *   subUUID: string,     // ログインユーザの subUUID
+ *   cmd: number,         // CMD.LOCK | UNLOCK | TOGGLE | CLICK
+ *   timeoutMs?: number,
+ * }} params
+ * @returns {Promise<any>} biz3TriggerLocker ack メッセージ
+ */
+export function triggerLock(client: import("./transport.js").Hub3WsClient, params: {
+    deviceId: string;
+    secretKey: string;
+    subUUID: string;
+    cmd: number;
+    timeoutMs?: number;
+}): Promise<any>;
+/** ロックを施錠 (cmd=82)。 */
+export function lockLock(client: any, p: any): Promise<any>;
+/** ロックを解錠 (cmd=83)。 */
+export function lockUnlock(client: any, p: any): Promise<any>;
+/** ロックを反転 (cmd=88, cloud のみ)。現在状態に応じてサーバが LOCK/UNLOCK を判定。 */
+export function lockToggle(client: any, p: any): Promise<any>;
+/** SESAME Bot のボタンクリック (cmd=89)。 */
+export function botClick(client: any, p: any): Promise<any>;
+/**
+ * 任意の SESAME ItemCode をクラウド経由 (biz3TriggerLocker) で送る汎用レール。
+ *
+ * フレームは lock/unlock と同型 `{action, cmd, sign:cmacTime(secretKey), history:base64(payload), device_id}`
+ * (公式 SDK CHAPIClientBiz.cmdSesame と一致: msg=3byte時刻の CMAC を sign、payload を history に base64)。
+ * lock/unlock(82/83) と autolock(11) 等は同一 ItemCode 名前空間 (Android SesameSDK SesameProtocols.kt)。
+ *
+ * ⚠️ **lock/unlock/toggle/bot 以外は実機に反映されない (実機検証済み)**:
+ *   biz3TriggerLocker は lock/unlock/toggle/bot のみを実機へ中継する。それ以外の ItemCode は
+ *   サーバが `success:true` で **ack だけ返すが、ロック本体には適用されない** (autolock=11 で
+ *   2026 実機確認: ack は返るが autolock 設定は変化せず)。biz3 web/SDK にも設定系のクラウド送信
+ *   経路は無く (useIotCtrl.js の IoT cmd は ADD/REMOVE_SESAME・LED・RELAY 等のみで autolock は
+ *   "Unsupported"、公式アプリは BLE 直送)。よって本関数で lock/unlock 系以外を送っても
+ *   **`success:true` は「サーバ受領」止まりで実機反映の保証は無い**。lock/unlock/toggle/bot 用、
+ *   もしくは将来クラウド対応された ItemCode 用の汎用レールとして残す。
+ *
+ * @param {import("./transport.js").Hub3WsClient} client
+ * @param {{
+ *   deviceId: string,                 // ロックの deviceUUID
+ *   secretKey: string,                // 32hex の共通鍵
+ *   cmd: number,                      // SesameItemCode 値 (CMD.AUTOLOCK 等)
+ *   payload?: Uint8Array|Buffer|number[], // BLE ペイロード (省略時は subUUID の history タグ)
+ *   subUUID?: string,                 // payload 省略時に history へ使う
+ *   timeoutMs?: number,
+ * }} params
+ * @returns {Promise<any>} biz3TriggerLocker ack メッセージ (success:false は reject)
+ */
+export function triggerItemCommand(client: import("./transport.js").Hub3WsClient, params: {
+    deviceId: string;
+    secretKey: string;
+    cmd: number;
+    payload?: Uint8Array | Buffer | number[];
+    subUUID?: string;
+    timeoutMs?: number;
+}): Promise<any>;
+/**
+ * オートロック (解錠 N 秒後に自動施錠) を設定する。autolock = ItemCode 11、payload = 2byte LE 秒数。
+ * `seconds=0` で無効化 (autolock_jp.md: 遅延時間 0 は自動施錠無効)。
+ *
+ * ⚠️ **クラウド経由では実機に反映されない (2026 実機検証済み)**。biz3TriggerLocker は cmd=11 に
+ *   `success:true` を返すが、ロック本体の autolock 設定は変化しない。autolock の正規経路は **BLE 直送のみ**
+ *   (公式アプリ準拠)。本関数はフレーム生成としては正しい (BLE トランスポートや将来のクラウド対応用) が、
+ *   現状の biz3 クラウドでは効果が無い。CLI からは公開していない ({@link triggerItemCommand} 参照)。
+ *
+ * @param {import("./transport.js").Hub3WsClient} client
+ * @param {{ deviceId: string, secretKey: string, seconds: number, timeoutMs?: number }} params
+ *   seconds: 0..65535 (0=無効)。SESAME 本体の選択肢は 0/5/10/.../秒。
+ * @returns {Promise<{ack: any, cmd: number, seconds: number}>}
+ */
+export function setAutolock(client: import("./transport.js").Hub3WsClient, { deviceId, secretKey, seconds, timeoutMs }: {
+    deviceId: string;
+    secretKey: string;
+    seconds: number;
+    timeoutMs?: number;
+}): Promise<{
+    ack: any;
+    cmd: number;
+    seconds: number;
+}>;
+import { Buffer } from "node:buffer";
+//# sourceMappingURL=lock.d.ts.map

package/types/lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../src/lock.js"],"names":[],"mappings":"AA6EA;;;;;;;;;;;;GAYG;AACH,oCAVW,OAAO,gBAAgB,EAAE,YAAY,UACrC;IACN,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GACS,OAAO,CAAC,GAAG,CAAC,CAiBxB;AAED,uBAAuB;AACvB,4DAA4F;AAC5F,uBAAuB;AACvB,8DAAgG;AAChG,8DAA8D;AAC9D,8DAAgG;AAChG,oCAAoC;AACpC,4DAA6F;AAE7F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,2CAXW,OAAO,gBAAgB,EAAE,YAAY,UACrC;IACN,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,UAAU,GAAC,MAAM,GAAC,MAAM,EAAE,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GACS,OAAO,CAAC,GAAG,CAAC,CAwBxB;AAED;;;;;;;;;;;;;GAaG;AACH,oCALW,OAAO,gBAAgB,EAAE,YAAY,+CACrC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAE1E,OAAO,CAAC;IAAC,GAAG,EAAE,GAAG,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAAC,CAU7D;uBAhLsB,aAAa"}