David
feff828ec1
src/dispatcher.ts routes a directive to capability.on(name | "*"), device.onDirective() or device.onReportState(), with the payload checked by the descriptor of the interface. The DirectiveContext answers with respond/report/defer/error; respond() and report() start from device.state(). A handler or 1.x listener that throws or rejects is answered with INTERNAL_ERROR (an AlexaError with itself) and reported through "error", never as an unhandled rejection. Undeclared interface, unknown directive, AdjustMode on an unordered mode and a missing handler get INVALID_DIRECTIVE, a bad payload INVALID_VALUE; a device with an "Event" or "ReportState" listener keeps the answer to itself. Every answer passes the dispatcher: the first one per correlationToken is published, a second is refused. No answer within answerWithinMs (6500, 0 = off, unref'd timer) sends INTERNAL_ERROR and emits "unanswered". A messageId that arrived in the last 60 s is dropped. New: "unknownEndpoint", options answerUnknownEndpoints, publisher, timers, and bridge.receive() to run a bridge without a broker. 168 tests pass (18 new). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
50 lines
2.4 KiB
TypeScript
50 lines
2.4 KiB
TypeScript
import type { MqttClient } from "mqtt";
|
|
/** What became of a publish. A failure is a value: publish() never rejects. */
|
|
export type PublishResult = {
|
|
ok: true;
|
|
topic: string;
|
|
} | {
|
|
ok: false;
|
|
topic: string;
|
|
error: Error;
|
|
};
|
|
/** Where the bridge, its devices and their messages publish. The message is sent as JSON. */
|
|
export interface Publisher {
|
|
publish(topic: string, message: object): Promise<PublishResult>;
|
|
}
|
|
/** What was thrown, as an Error. */
|
|
export declare const asError: (err: unknown) => Error;
|
|
/**
|
|
* Publishes to the broker through the client the bridge has at the time: a new one after disconnect() and connect(),
|
|
* none before connect() and after disconnect(). Without a client the publish is refused. With a client that lost
|
|
* its connection mqtt.js keeps the message and sends it after the reconnect, and the publish resolves then.
|
|
*/
|
|
export declare class MqttPublisher implements Publisher {
|
|
private readonly client;
|
|
constructor(client: () => MqttClient | null);
|
|
publish(topic: string, message: object): Promise<PublishResult>;
|
|
}
|
|
/**
|
|
* Keeps what it is asked to publish, for tests and dry runs without a broker:
|
|
*
|
|
* const sent = new MemoryPublisher();
|
|
* device.publisher = sent; // or new Alex2MQTT(..., { publisher: sent }) and bridge.receive()
|
|
* await device.getStatusMessage(token, true).addPowerControllerProp(PowerController.ON).send();
|
|
* sent.published[0] // { topic: "<root>/<endpointId>/alexaResponce", message: { event, context } }
|
|
*/
|
|
export declare class MemoryPublisher implements Publisher {
|
|
/** Oldest first. The message is what a subscriber gets after JSON.parse. */
|
|
readonly published: Array<{
|
|
topic: string;
|
|
message: any;
|
|
}>;
|
|
/** Set it and every publish fails with this error, as a publish to a broker that is gone does. */
|
|
failWith: Error | null;
|
|
publish(topic: string, message: object): Promise<PublishResult>;
|
|
}
|
|
/**
|
|
* send() as 1.x promises it: resolves with the topic, or with "" when nothing was published, and never rejects
|
|
* (1.5.1 rejected, and a send() nobody caught killed the host on any broker hiccup). What went wrong goes to report:
|
|
* the message cannot be built, the device is on no bridge, or the publish failed.
|
|
*/
|
|
export declare function send(publisher: Publisher | null, topic: string, build: () => object, report?: (err: Error) => void): Promise<string>;
|