@azure/web-pubsub-express 1.0.6-alpha.20250224.1 → 1.0.6

package/dist/react-native/cloudEventsProtocols.d.ts

@@ -0,0 +1,411 @@
+import type { MqttDisconnectReasonCode } from "./enum/MqttErrorCodes/mqttDisconnectReasonCode.js";
+import type { MqttV311ConnectReturnCode } from "./enum/MqttErrorCodes/mqttV311ConnectReturnCode.js";
+import type { MqttV500ConnectReasonCode } from "./enum/MqttErrorCodes/mqttV500ConnectReasonCode.js";
+/**
+ * Response of the connect event.
+ */
+export interface ConnectResponse {
+    /**
+     * Set the groups the connection would like to join.
+     */
+    groups?: string[];
+    /**
+     * Set the roles the connection belongs to.
+     */
+    roles?: string[];
+    /**
+     * Set the userId for the connection.
+     */
+    userId?: string;
+    /**
+     * Set the subprotocol for the connection to complete WebSocket handshake.
+     */
+    subprotocol?: string;
+}
+/**
+ * Success respones of the connect event.
+ */
+export interface MqttConnectResponse extends ConnectResponse {
+    /**
+     * The MQTT specific properties in a successful MQTT connection event response.
+     */
+    mqtt?: MqttConnectResponseProperties;
+}
+/**
+ * Response of a failed connect event.
+ */
+export interface ConnectErrorResponse {
+    /**
+     * The error code.
+     */
+    code: 400 | 401 | 500;
+    /**
+     * The error detail.
+     */
+    detail?: string;
+}
+/**
+ * Response of an MQTT connection failure.
+ */
+export interface MqttConnectErrorResponse {
+    /**
+     * The properties of the MQTT connection failure response.
+     */
+    mqtt: MqttConnectErrorResponseProperties;
+}
+/**
+ * The properties of an MQTT connection failure response.
+ */
+export interface MqttConnectErrorResponseProperties {
+    /**
+     * The MQTT connect return code.
+     */
+    code: MqttV311ConnectReturnCode | MqttV500ConnectReasonCode;
+    /**
+     * The reason string for the connection failure.
+     */
+    reason?: string;
+    /**
+     * The user properties in the response.
+     */
+    userProperties?: MqttUserProperty[];
+}
+/**
+ * The protocol of Web PubSub Client.
+ */
+export type WebPubSubClientProtocol = "default" | "mqtt";
+/**
+ * The connection context representing the client WebSocket connection.
+ */
+export interface ConnectionContext {
+    /**
+     * The unique identifier generated by the service of the network connection.
+     */
+    signature: string;
+    /**
+     * The hub the connection belongs to.
+     */
+    hub: string;
+    /**
+     * The Id of the connection.
+     */
+    connectionId: string;
+    /**
+     * The event name of this CloudEvents request.
+     */
+    eventName: string;
+    /**
+     * The origin this CloudEvents request comes from.
+     */
+    origin: string;
+    /**
+     * The user id of the connection.
+     */
+    userId?: string;
+    /**
+     * The subprotocol of this connection.
+     */
+    subprotocol?: string;
+    /**
+     * Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.
+     */
+    states: Record<string, any>;
+    /**
+     * The type of client protocol.
+     */
+    clientProtocol: WebPubSubClientProtocol;
+    /**
+     * The MQTT properties that the client WebSocket connection has when it connects (For MQTT connection only).
+     */
+    mqtt?: MqttConnectionContextProperties;
+}
+/**
+ * The connection context properties representing the MQTT client WebSocket connection.
+ */
+export interface MqttConnectionContextProperties {
+    /**
+     * The unique identifier generated by the service of the network connection.
+     */
+    physicalConnectionId: string;
+    /**
+     * The unique identifier generated by the service of the MQTT session.
+     */
+    sessionId?: string;
+}
+/**
+ * Request for the connect event.
+ */
+export interface ConnectRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The claims that the client WebSocket connection has when it connects.
+     */
+    claims?: Record<string, string[]>;
+    /**
+     * The query that the client WebSocket connection has when it connects.
+     * @deprecated Please use queries instead.
+     */
+    query?: Record<string, string[]>;
+    /**
+     * The queries that the client WebSocket connection has when it connects.
+     */
+    queries?: Record<string, string[]>;
+    /**
+     * The headers that the client WebSocket connection has when it connects.
+     */
+    headers?: Record<string, string[]>;
+    /**
+     * The subprotocols that the client WebSocket connection uses to do handshake.
+     */
+    subprotocols?: string[];
+    /**
+     * The client certificate info that the client WebSocket connection uses to connect.
+     */
+    clientCertificates?: Certificate[];
+}
+/**
+ * Request for the MQTT connect event.
+ */
+export interface MqttConnectRequest extends ConnectRequest {
+    /**
+     * The MQTT specific properties in the MQTT connect event request.
+     */
+    mqtt: MqttConnectProperties;
+}
+/**
+ * The properties of the MQTT CONNECT packet.
+ */
+export interface MqttConnectProperties {
+    /**
+     * MQTT protocol version.
+     */
+    protocolVersion: number;
+    /**
+     * The username field in the MQTT CONNECT packet.
+     */
+    username?: string;
+    /**
+     * The password field in the MQTT CONNECT packet.
+     */
+    password?: string;
+    /**
+     * The user properties in the MQTT CONNECT packet.
+     */
+    userProperties?: MqttUserProperty[];
+}
+/**
+ * The properties of a successful MQTT connection event response
+ */
+export interface MqttConnectResponseProperties {
+    /**
+     * Additional diagnostic or other information provided by upstream server
+     * Now only MQTT 5.0 supports user properties
+     */
+    userProperties?: MqttUserProperty[];
+}
+/**
+ * The properties of a user in MQTT.
+ */
+export interface MqttUserProperty {
+    /**
+     * The name of the property.
+     */
+    name: string;
+    /**
+     * The value of the property.
+     */
+    value: string;
+}
+/**
+ * The client certificate.
+ */
+export interface Certificate {
+    /**
+     * The thumbprint of the certificate.
+     */
+    thumbprint: string;
+}
+/**
+ * Request for the connected event.
+ */
+export interface ConnectedRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+}
+/**
+ * Request for the user event.
+ */
+export type UserEventRequest = {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data.
+     */
+    data: string;
+    /**
+     * The type of the data.
+     */
+    dataType: "text";
+} | {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data, when data type is `json`, the data is the result of JSON.parse, so the type of the data depends on user scenarios
+     */
+    data: unknown;
+    /**
+     * The type of the data.
+     */
+    dataType: "json";
+} | {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data.
+     */
+    data: ArrayBuffer;
+    /**
+     * The type of the data.
+     */
+    dataType: "binary";
+};
+/**
+ * Request for the disconnected event.
+ */
+export interface DisconnectedRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The reason that the connection disconnects.
+     */
+    reason?: string;
+}
+/**
+ * Request for the disconnected event.
+ */
+export interface MqttDisconnectedRequest extends DisconnectedRequest {
+    /**
+     * The MQTT specific properties in the MQTT disconnected event request.
+     */
+    mqtt: MqttDisconnectedProperties;
+}
+/**
+ * The properties of an MQTT disconnected event.
+ */
+export interface MqttDisconnectedProperties {
+    /**
+     * The MQTT disconnect packet.
+     */
+    disconnectPacket: MqttDisconnectPacket;
+    /**
+     * Whether the disconnection is initiated by the client.
+     */
+    initiatedByClient: boolean;
+}
+/**
+ * The properties of the MQTT DISCONNECT packet.
+ */
+export interface MqttDisconnectPacket {
+    /**
+     * The MQTT disconnect return code.
+     */
+    code: MqttDisconnectReasonCode;
+    /**
+     * The user properties in the MQTT disconnect packet.
+     */
+    userProperties?: MqttUserProperty[];
+}
+/**
+ * The handler to set connect event response
+ */
+export interface ConnectResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
+    /**
+     * Return success response to the service.
+     * @param response - The response for the connect event.
+     */
+    success(response?: ConnectResponse | MqttConnectResponse): void;
+    /**
+     * Return failed response and the service will reject the client WebSocket connection.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
+     */
+    fail(code: 400 | 401 | 500, detail?: string): void;
+    /**
+     * Return failed response with MQTT response properties and the service will reject the client WebSocket connection.
+     * @param response - The response for the connect event which contains either default WebPubSub or MQTT response properties.
+     */
+    failWith(response: ConnectErrorResponse | MqttConnectErrorResponse): void;
+}
+/**
+ * The handler to set user event response
+ */
+export interface UserEventResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
+    /**
+     * Return success response with data to be delivered to the client WebSocket connection.
+     * @param data - The payload data to be returned to the client. Stringify the message if it is a JSON object.
+     * @param dataType - The type of the payload data.
+     */
+    success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json"): void;
+    /**
+     * Return failed response and the service will close the client WebSocket connection.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
+     */
+    fail(code: 400 | 401 | 500, detail?: string): void;
+}
+/**
+ * The options for the CloudEvents handler.
+ */
+export interface WebPubSubEventHandlerOptions {
+    /**
+     * Custom serving path for the path of the CloudEvents handler.
+     */
+    path?: string;
+    /**
+     * Handle 'connect' event, the service waits for the response to proceed.
+     */
+    handleConnect?: (connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void;
+    /**
+     * Handle user events, the service waits for the response to proceed.
+     */
+    handleUserEvent?: (userEventRequest: UserEventRequest, userEventResponse: UserEventResponseHandler) => void;
+    /**
+     * Event trigger for "connected" unblocking event. This is an unblocking event and the service does not wait for the response.
+     */
+    onConnected?: (connectedRequest: ConnectedRequest) => void;
+    /**
+     *
+     * Event triggers for "disconnected" unblocking event. This is an unblocking event and the service does not wait for the response.
+     */
+    onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void;
+    /**
+     * If not specified, by default allow all the endpoints, otherwise only allow specified endpoints
+     */
+    allowedEndpoints?: string[];
+}
+//# sourceMappingURL=cloudEventsProtocols.d.ts.map

package/dist/react-native/cloudEventsProtocols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsProtocols.d.ts","sourceRoot":"","sources":["../../src/cloudEventsProtocols.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mDAAmD,CAAC;AAClG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AACpG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D;;OAEG;IACH,IAAI,CAAC,EAAE,6BAA6B,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,kCAAkC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,yBAAyB,CAAC;IAC5D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B;;OAEG;IACH,cAAc,EAAE,uBAAuB,CAAC;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,+BAA+B,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,WAAW,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE;;OAEG;IACH,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,gBAAgB,EAAE,oBAAoB,CAAC;IACvC;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAChE;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,wBAAwB,GAAG,IAAI,CAAC;CAC3E;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAClF;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAElG;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,gBAAgB,EAAE,gBAAgB,EAClC,iBAAiB,EAAE,wBAAwB,KACxC,IAAI,CAAC;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAE3D;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,mBAAmB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEpE;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B"}

package/dist/react-native/cloudEventsProtocols.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=cloudEventsProtocols.js.map

package/dist/react-native/cloudEventsProtocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsProtocols.js","sourceRoot":"","sources":["../../src/cloudEventsProtocols.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { MqttDisconnectReasonCode } from \"./enum/MqttErrorCodes/mqttDisconnectReasonCode.js\";\nimport type { MqttV311ConnectReturnCode } from \"./enum/MqttErrorCodes/mqttV311ConnectReturnCode.js\";\nimport type { MqttV500ConnectReasonCode } from \"./enum/MqttErrorCodes/mqttV500ConnectReasonCode.js\";\n\n/**\n * Response of the connect event.\n */\nexport interface ConnectResponse {\n  /**\n   * Set the groups the connection would like to join.\n   */\n  groups?: string[];\n  /**\n   * Set the roles the connection belongs to.\n   */\n  roles?: string[];\n  /**\n   * Set the userId for the connection.\n   */\n  userId?: string;\n  /**\n   * Set the subprotocol for the connection to complete WebSocket handshake.\n   */\n  subprotocol?: string;\n}\n\n/**\n * Success respones of the connect event.\n */\nexport interface MqttConnectResponse extends ConnectResponse {\n  /**\n   * The MQTT specific properties in a successful MQTT connection event response.\n   */\n  mqtt?: MqttConnectResponseProperties;\n}\n\n/**\n * Response of a failed connect event.\n */\nexport interface ConnectErrorResponse {\n  /**\n   * The error code.\n   */\n  code: 400 | 401 | 500;\n  /**\n   * The error detail.\n   */\n  detail?: string;\n}\n\n/**\n * Response of an MQTT connection failure.\n */\nexport interface MqttConnectErrorResponse {\n  /**\n   * The properties of the MQTT connection failure response.\n   */\n  mqtt: MqttConnectErrorResponseProperties;\n}\n\n/**\n * The properties of an MQTT connection failure response.\n */\nexport interface MqttConnectErrorResponseProperties {\n  /**\n   * The MQTT connect return code.\n   */\n  code: MqttV311ConnectReturnCode | MqttV500ConnectReasonCode;\n  /**\n   * The reason string for the connection failure.\n   */\n  reason?: string;\n  /**\n   * The user properties in the response.\n   */\n  userProperties?: MqttUserProperty[];\n}\n\n/**\n * The protocol of Web PubSub Client.\n */\nexport type WebPubSubClientProtocol = \"default\" | \"mqtt\";\n\n/**\n * The connection context representing the client WebSocket connection.\n */\nexport interface ConnectionContext {\n  /**\n   * The unique identifier generated by the service of the network connection.\n   */\n  signature: string;\n  /**\n   * The hub the connection belongs to.\n   */\n  hub: string;\n  /**\n   * The Id of the connection.\n   */\n  connectionId: string;\n  /**\n   * The event name of this CloudEvents request.\n   */\n  eventName: string;\n  /**\n   * The origin this CloudEvents request comes from.\n   */\n  origin: string;\n  /**\n   * The user id of the connection.\n   */\n  userId?: string;\n  /**\n   * The subprotocol of this connection.\n   */\n  subprotocol?: string;\n  /**\n   * Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.\n   */\n  states: Record<string, any>;\n  /**\n   * The type of client protocol.\n   */\n  clientProtocol: WebPubSubClientProtocol;\n  /**\n   * The MQTT properties that the client WebSocket connection has when it connects (For MQTT connection only).\n   */\n  mqtt?: MqttConnectionContextProperties;\n}\n\n/**\n * The connection context properties representing the MQTT client WebSocket connection.\n */\nexport interface MqttConnectionContextProperties {\n  /**\n   * The unique identifier generated by the service of the network connection.\n   */\n  physicalConnectionId: string;\n  /**\n   * The unique identifier generated by the service of the MQTT session.\n   */\n  sessionId?: string;\n}\n\n/**\n * Request for the connect event.\n */\nexport interface ConnectRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n  /**\n   * The claims that the client WebSocket connection has when it connects.\n   */\n  claims?: Record<string, string[]>;\n  /**\n   * The query that the client WebSocket connection has when it connects.\n   * @deprecated Please use queries instead.\n   */\n  query?: Record<string, string[]>;\n  /**\n   * The queries that the client WebSocket connection has when it connects.\n   */\n  queries?: Record<string, string[]>;\n  /**\n   * The headers that the client WebSocket connection has when it connects.\n   */\n  headers?: Record<string, string[]>;\n  /**\n   * The subprotocols that the client WebSocket connection uses to do handshake.\n   */\n  subprotocols?: string[];\n  /**\n   * The client certificate info that the client WebSocket connection uses to connect.\n   */\n  clientCertificates?: Certificate[];\n}\n\n/**\n * Request for the MQTT connect event.\n */\nexport interface MqttConnectRequest extends ConnectRequest {\n  /**\n   * The MQTT specific properties in the MQTT connect event request.\n   */\n  mqtt: MqttConnectProperties;\n}\n\n/**\n * The properties of the MQTT CONNECT packet.\n */\nexport interface MqttConnectProperties {\n  /**\n   * MQTT protocol version.\n   */\n  protocolVersion: number;\n  /**\n   * The username field in the MQTT CONNECT packet.\n   */\n  username?: string;\n  /**\n   * The password field in the MQTT CONNECT packet.\n   */\n  password?: string;\n  /**\n   * The user properties in the MQTT CONNECT packet.\n   */\n  userProperties?: MqttUserProperty[];\n}\n\n/**\n * The properties of a successful MQTT connection event response\n */\nexport interface MqttConnectResponseProperties {\n  /**\n   * Additional diagnostic or other information provided by upstream server\n   * Now only MQTT 5.0 supports user properties\n   */\n  userProperties?: MqttUserProperty[];\n}\n\n/**\n * The properties of a user in MQTT.\n */\nexport interface MqttUserProperty {\n  /**\n   * The name of the property.\n   */\n  name: string;\n  /**\n   * The value of the property.\n   */\n  value: string;\n}\n\n/**\n * The client certificate.\n */\nexport interface Certificate {\n  /**\n   * The thumbprint of the certificate.\n   */\n  thumbprint: string;\n}\n\n/**\n * Request for the connected event.\n */\nexport interface ConnectedRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n}\n\n/**\n * Request for the user event.\n */\nexport type UserEventRequest =\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data.\n       */\n      data: string;\n      /**\n       * The type of the data.\n       */\n      dataType: \"text\";\n    }\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data, when data type is `json`, the data is the result of JSON.parse, so the type of the data depends on user scenarios\n       */\n      data: unknown;\n\n      /**\n       * The type of the data.\n       */\n      dataType: \"json\";\n    }\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data.\n       */\n      data: ArrayBuffer;\n      /**\n       * The type of the data.\n       */\n      dataType: \"binary\";\n    };\n\n/**\n * Request for the disconnected event.\n */\nexport interface DisconnectedRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n  /**\n   * The reason that the connection disconnects.\n   */\n  reason?: string;\n}\n\n/**\n * Request for the disconnected event.\n */\nexport interface MqttDisconnectedRequest extends DisconnectedRequest {\n  /**\n   * The MQTT specific properties in the MQTT disconnected event request.\n   */\n  mqtt: MqttDisconnectedProperties;\n}\n\n/**\n * The properties of an MQTT disconnected event.\n */\nexport interface MqttDisconnectedProperties {\n  /**\n   * The MQTT disconnect packet.\n   */\n  disconnectPacket: MqttDisconnectPacket;\n  /**\n   * Whether the disconnection is initiated by the client.\n   */\n  initiatedByClient: boolean;\n}\n\n/**\n * The properties of the MQTT DISCONNECT packet.\n */\nexport interface MqttDisconnectPacket {\n  /**\n   * The MQTT disconnect return code.\n   */\n  code: MqttDisconnectReasonCode;\n  /**\n   * The user properties in the MQTT disconnect packet.\n   */\n  userProperties?: MqttUserProperty[];\n}\n\n/**\n * The handler to set connect event response\n */\nexport interface ConnectResponseHandler {\n  /**\n   * Set the state of the connection\n   * @param name - The name of the state\n   * @param value - The value of the state\n   */\n  setState(name: string, value: unknown): void;\n  /**\n   * Return success response to the service.\n   * @param response - The response for the connect event.\n   */\n  success(response?: ConnectResponse | MqttConnectResponse): void;\n  /**\n   * Return failed response and the service will reject the client WebSocket connection.\n   * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.\n   * @param detail - The detail of the error.\n   */\n  fail(code: 400 | 401 | 500, detail?: string): void;\n  /**\n   * Return failed response with MQTT response properties and the service will reject the client WebSocket connection.\n   * @param response - The response for the connect event which contains either default WebPubSub or MQTT response properties.\n   */\n  failWith(response: ConnectErrorResponse | MqttConnectErrorResponse): void;\n}\n\n/**\n * The handler to set user event response\n */\nexport interface UserEventResponseHandler {\n  /**\n   * Set the state of the connection\n   * @param name - The name of the state\n   * @param value - The value of the state\n   */\n  setState(name: string, value: unknown): void;\n  /**\n   * Return success response with data to be delivered to the client WebSocket connection.\n   * @param data - The payload data to be returned to the client. Stringify the message if it is a JSON object.\n   * @param dataType - The type of the payload data.\n   */\n  success(data?: string | ArrayBuffer, dataType?: \"binary\" | \"text\" | \"json\"): void;\n  /**\n   * Return failed response and the service will close the client WebSocket connection.\n   * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.\n   * @param detail - The detail of the error.\n   */\n  fail(code: 400 | 401 | 500, detail?: string): void;\n}\n\n/**\n * The options for the CloudEvents handler.\n */\nexport interface WebPubSubEventHandlerOptions {\n  /**\n   * Custom serving path for the path of the CloudEvents handler.\n   */\n  path?: string;\n\n  /**\n   * Handle 'connect' event, the service waits for the response to proceed.\n   */\n  handleConnect?: (connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void;\n\n  /**\n   * Handle user events, the service waits for the response to proceed.\n   */\n  handleUserEvent?: (\n    userEventRequest: UserEventRequest,\n    userEventResponse: UserEventResponseHandler,\n  ) => void;\n\n  /**\n   * Event trigger for \"connected\" unblocking event. This is an unblocking event and the service does not wait for the response.\n   */\n  onConnected?: (connectedRequest: ConnectedRequest) => void;\n\n  /**\n   *\n   * Event triggers for \"disconnected\" unblocking event. This is an unblocking event and the service does not wait for the response.\n   */\n  onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void;\n\n  /**\n   * If not specified, by default allow all the endpoints, otherwise only allow specified endpoints\n   */\n  allowedEndpoints?: string[];\n}\n"]}

package/dist/react-native/enum/MqttErrorCodes/mqttDisconnectReasonCode.d.ts

@@ -0,0 +1,180 @@
+/**
+ * MQTT 5.0 Disconnect Reason Codes.
+ */
+export declare enum MqttDisconnectReasonCode {
+    /**
+     * 0x00 - Normal disconnection
+     * Sent by: Client or Server
+     * Description: Close the connection normally. Do not send the Will Message.
+     */
+    NormalDisconnection = 0,
+    /**
+     * 0x04 - Disconnect with Will Message
+     * Sent by: Client
+     * Description: The Client wishes to disconnect but requires that the Server also publishes its Will Message.
+     */
+    DisconnectWithWillMessage = 4,
+    /**
+     * 0x80 - Unspecified error
+     * Sent by: Client or Server
+     * Description: The Connection is closed but the sender either does not wish to reveal the reason, or none of the other Reason Codes apply.
+     */
+    UnspecifiedError = 128,
+    /**
+     * 0x81 - Malformed Packet
+     * Sent by: Client or Server
+     * Description: The received packet does not conform to this specification.
+     */
+    MalformedPacket = 129,
+    /**
+     * 0x82 - Protocol Error
+     * Sent by: Client or Server
+     * Description: An unexpected or out of order packet was received.
+     */
+    ProtocolError = 130,
+    /**
+     * 0x83 - Implementation specific error
+     * Sent by: Client or Server
+     * Description: The packet received is valid but cannot be processed by this implementation.
+     */
+    ImplementationSpecificError = 131,
+    /**
+     * 0x87 - Not authorized
+     * Sent by: Server
+     * Description: The request is not authorized.
+     */
+    NotAuthorized = 135,
+    /**
+     * 0x89 - Server busy
+     * Sent by: Server
+     * Description: The Server is busy and cannot continue processing requests from this Client.
+     */
+    ServerBusy = 137,
+    /**
+     * 0x8B - Server shutting down
+     * Sent by: Server
+     * Description: The Server is shutting down.
+     */
+    ServerShuttingDown = 139,
+    /**
+     * 0x8D - Keep Alive timeout
+     * Sent by: Server
+     * Description: The Connection is closed because no packet has been received for 1.5 times the Keepalive time.
+     */
+    KeepAliveTimeout = 141,
+    /**
+     * 0x8E - Session taken over
+     * Sent by: Server
+     * Description: Another Connection using the same ClientID has connected causing this Connection to be closed.
+     */
+    SessionTakenOver = 142,
+    /**
+     * 0x8F - Topic Filter invalid
+     * Sent by: Server
+     * Description: The Topic Filter is correctly formed, but is not accepted by this Server.
+     */
+    TopicFilterInvalid = 143,
+    /**
+     * 0x90 - Topic Name invalid
+     * Sent by: Client or Server
+     * Description: The Topic Name is correctly formed, but is not accepted by this Client or Server.
+     */
+    TopicNameInvalid = 144,
+    /**
+     * 0x93 - Receive Maximum exceeded
+     * Sent by: Client or Server
+     * Description: The Client or Server has received more than Receive Maximum publication for which it has not sent PUBACK or PUBCOMP.
+     */
+    ReceiveMaximumExceeded = 147,
+    /**
+     * 0x94 - Topic Alias invalid
+     * Sent by: Client or Server
+     * Description: The Client or Server has received a PUBLISH packet containing a Topic Alias which is greater than the Maximum Topic Alias it sent in the CONNECT or CONNACK packet.
+     */
+    TopicAliasInvalid = 148,
+    /**
+     * 0x95 - Packet too large
+     * Sent by: Client or Server
+     * Description: The packet size is greater than Maximum Packet Size for this Client or Server.
+     */
+    PacketTooLarge = 149,
+    /**
+     * 0x96 - Message rate too high
+     * Sent by: Client or Server
+     * Description: The received data rate is too high.
+     */
+    MessageRateTooHigh = 150,
+    /**
+     * 0x97 - Quota exceeded
+     * Sent by: Client or Server
+     * Description: An implementation or administrative imposed limit has been exceeded.
+     */
+    QuotaExceeded = 151,
+    /**
+     * 0x98 - Administrative action
+     * Sent by: Client or Server
+     * Description: The Connection is closed due to an administrative action.
+     */
+    AdministrativeAction = 152,
+    /**
+     * 0x99 - Payload format invalid
+     * Sent by: Client or Server
+     * Description: The payload format does not match the one specified by the Payload Format Indicator.
+     */
+    PayloadFormatInvalid = 153,
+    /**
+     * 0x9A - Retain not supported
+     * Sent by: Server
+     * Description: The Server does not support retained messages.
+     */
+    RetainNotSupported = 154,
+    /**
+     * 0x9B - QoS not supported
+     * Sent by: Server
+     * Description: The Client specified a QoS greater than the QoS specified in a Maximum QoS in the CONNACK.
+     */
+    QosNotSupported = 155,
+    /**
+     * 0x9C - Use another server
+     * Sent by: Server
+     * Description: The Client should temporarily change its Server.
+     */
+    UseAnotherServer = 156,
+    /**
+     * 0x9D - Server moved
+     * Sent by: Server
+     * Description: The Server is moved and the Client should permanently change its server location.
+     */
+    ServerMoved = 157,
+    /**
+     * 0x9E - Shared Subscriptions not supported
+     * Sent by: Server
+     * Description: The Server does not support Shared Subscriptions.
+     */
+    SharedSubscriptionsNotSupported = 158,
+    /**
+     * 0x9F - Connection rate exceeded
+     * Sent by: Server
+     * Description: This connection is closed because the connection rate is too high.
+     */
+    ConnectionRateExceeded = 159,
+    /**
+     * 0xA0 - Maximum connect time
+     * Sent by: Server
+     * Description: The maximum connection time authorized for this connection has been exceeded.
+     */
+    MaximumConnectTime = 160,
+    /**
+     * 0xA1 - Subscription Identifiers not supported
+     * Sent by: Server
+     * Description: The Server does not support Subscription Identifiers; the subscription is not accepted.
+     */
+    SubscriptionIdentifiersNotSupported = 161,
+    /**
+     * 0xA2 - Wildcard Subscriptions not supported
+     * Sent by: Server
+     * Description: The Server does not support Wildcard Subscriptions; the subscription is not accepted.
+     */
+    WildcardSubscriptionsNotSupported = 162
+}
+//# sourceMappingURL=mqttDisconnectReasonCode.d.ts.map

package/dist/react-native/enum/MqttErrorCodes/mqttDisconnectReasonCode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mqttDisconnectReasonCode.d.ts","sourceRoot":"","sources":["../../../../src/enum/MqttErrorCodes/mqttDisconnectReasonCode.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,oBAAY,wBAAwB;IAClC;;;;OAIG;IACH,mBAAmB,IAAO;IAE1B;;;;OAIG;IACH,yBAAyB,IAAO;IAEhC;;;;OAIG;IACH,gBAAgB,MAAO;IAEvB;;;;OAIG;IACH,eAAe,MAAO;IAEtB;;;;OAIG;IACH,aAAa,MAAO;IAEpB;;;;OAIG;IACH,2BAA2B,MAAO;IAElC;;;;OAIG;IACH,aAAa,MAAO;IAEpB;;;;OAIG;IACH,UAAU,MAAO;IAEjB;;;;OAIG;IACH,kBAAkB,MAAO;IAEzB;;;;OAIG;IACH,gBAAgB,MAAO;IAEvB;;;;OAIG;IACH,gBAAgB,MAAO;IAEvB;;;;OAIG;IACH,kBAAkB,MAAO;IAEzB;;;;OAIG;IACH,gBAAgB,MAAO;IAEvB;;;;OAIG;IACH,sBAAsB,MAAO;IAE7B;;;;OAIG;IACH,iBAAiB,MAAO;IAExB;;;;OAIG;IACH,cAAc,MAAO;IAErB;;;;OAIG;IACH,kBAAkB,MAAO;IAEzB;;;;OAIG;IACH,aAAa,MAAO;IAEpB;;;;OAIG;IACH,oBAAoB,MAAO;IAE3B;;;;OAIG;IACH,oBAAoB,MAAO;IAE3B;;;;OAIG;IACH,kBAAkB,MAAO;IAEzB;;;;OAIG;IACH,eAAe,MAAO;IAEtB;;;;OAIG;IACH,gBAAgB,MAAO;IAEvB;;;;OAIG;IACH,WAAW,MAAO;IAElB;;;;OAIG;IACH,+BAA+B,MAAO;IAEtC;;;;OAIG;IACH,sBAAsB,MAAO;IAE7B;;;;OAIG;IACH,kBAAkB,MAAO;IAEzB;;;;OAIG;IACH,mCAAmC,MAAO;IAE1C;;;;OAIG;IACH,iCAAiC,MAAO;CACzC"}