@libertas-ai/types 0.1.2 → 0.1.3

package/index.d.ts

@@ -92,7 +92,7 @@ declare type LibertasDataStore = number;
 /**
  * Used to send broadcast data report in {@link libertasEndpointSendResponse}. It should be 0xffffffff.
  */
-declare const enum LibertasPeer {
+declare enum LibertasPeer {
     Broadcast = 0xffffffff,
 }
 
@@ -105,7 +105,7 @@ declare const enum LibertasPeer {
  * @see {@link LibertasVirtualDeviceCallback}
  * 
  */
-declare const enum LibertasDeviceAction {
+declare enum LibertasDeviceAction {
     StatusResponse        = 0x01,
     ReadRequest           = 0x02,
     SubscribeRequest      = 0x03,
@@ -352,7 +352,7 @@ declare type LibertasDeviceCallback = (device: LibertasDevice, action: LibertasD
 /**
  * Possible interactions of an endpoint connection.
  */
-declare const enum LibertasEndpointAction {
+declare enum LibertasEndpointAction {
     /// endpoint subscription request opcode.
     SubscriptionRequest = 3,
     /// endpoint data message opcode.
@@ -368,17 +368,17 @@ declare const enum LibertasEndpointAction {
 /**
  * The signature of a virtual device I/O callback function.
  * 
- * @param device A {@link LibertasDevice}.
- * @param ref The reference number of the original request. See remarks.
+ * @param device A {@link LibertasVirtualDevice}.
+ * @param peer Uniquely identifies a peer as subscription ID. See remarks.
+ * @param transId The transaction Id of the original request. See remarks.
  * @param action The {@link LibertasDeviceAction}. See remarks
  * @param data The request data. It's a union type. The value shall be cast to a type decided by action.
  * @param tag The arbitrary data passed to {@link libertasSetOnVirtualDevice} with the callback instance.
- * @param peer Uniquely identifies a peer as subscription ID. See remarks.
  * 
  * @see {@link libertasSetOnVirtualDevice}
  * 
- * @remarks The callback is used to notify the virtual device of a request. Each request has an internally assigned ref number by the engine. 
- * The ref number must be passed back in the corresponding response.
+ * @remarks The callback is used to notify the virtual device of a request. Each request has an internally assigned transaction ID (transId) by the engine. 
+ * The transId must be passed back in the corresponding response.
  * 
  * Valid actions:
  * {@link LibertasDeviceAction.ReadRequest}, {@link LibertasDeviceAction.SubscribeRequest}, and {@link LibertasDeviceAction.ReportData} all request attribute data. {@link LibertasDeviceAction.ReadRequest}
@@ -387,7 +387,7 @@ declare const enum LibertasEndpointAction {
  * calculate interval duration for more flexible subscrption delivery. A virtual device may even respond more data than requested if the common dirty-marking algorithm is not adequate.
  */
 
-declare type LibertasVirtualDeviceCallback = (device: LibertasVirtualDevice, ref: number, action: LibertasDeviceAction, data: LibertasVirtualDeviceReq, tag?: any, peer?: number) => void;
+declare type LibertasVirtualDeviceCallback = (device: LibertasVirtualDevice, peer: number, transId: number, action: LibertasDeviceAction, data: LibertasVirtualDeviceReq, tag?: any) => void;
 
 /**
  * Callback of an endpoint connection.
@@ -570,40 +570,44 @@ declare function libertasVirtualDeviceUpdateEvents(device: LibertasVirtualDevice
 /**
  * Update attributes unsolicited, or in response to a ReadRequest or SubscribeRequest.
  * @param device A {@link LibertasVirtualDevice}.
- * @param ref The ref number of the request.
+ * @param peer The peer taskId.
+ * @param transId The transaction Id of the request.
  * @param attributes An array of {@link LibertasClusterReport}. Note that the events and eventStatus are undefined. Use {@link libertasVirtualDeviceUpdateEvents} to write events.
  * 
  * @remarks
  * The framework will maintain a cache of all attributes.
  * 
- * If a ref number is present, a read response or a report in response to this referenced request will be immediately sent out;
+ * If a transId is present, a read response or a report in response to this referenced request will be immediately sent out;
  * otherwise the Libertas OS engine will decide when to send out the subscription reports.
  */
-declare function libertasVirtualDeviceAttributesRsp(device: LibertasVirtualDevice, ref: number, attributes: LibertasClusterReport[]) : void;
+declare function libertasVirtualDeviceAttributesRsp(device: LibertasVirtualDevice, peer: number, transId: number, attributes: LibertasClusterReport[]) : void;
 
-/**
+/** 
  * Send out command responses.
  * @param device A {@link LibertasVirtualDevice}.
- * @param ref The ref number of the request.
+ * @param peer The peer taskId.
+ * @param transId The transaction Id of the request.
  * @param rsp A {@link LibertasCommandRsp}.
  */
-declare function libertasVirtualDeviceCommandRsp(device: LibertasVirtualDevice, ref: number, rsp: LibertasCommandRsp) : void;
+declare function libertasVirtualDeviceCommandRsp(device: LibertasVirtualDevice, peer: number, transId: number, rsp: LibertasCommandRsp) : void;
 
-/**
+/** 
  * Send out write response.
  * @param device A {@link LibertasVirtualDevice}.
- * @param ref The ref number of the request.
+ * @param peer The peer taskId.
+ * @param transId The transaction Id of the request.
  * @param responses An array of {@link LibertasClusterWriteRsp}.
  */
-declare function libertasVirtualDeviceWriteRsp(device: LibertasVirtualDevice, ref: number, responses: LibertasClusterWriteRsp[]) : void;
+declare function libertasVirtualDeviceWriteRsp(device: LibertasVirtualDevice, peer: number, transId: number, responses: LibertasClusterWriteRsp[]) : void;
 
-/**
+/** 
  * Send out an error status code against an incoming request.
  * @param device A {@link LibertasVirtualDevice}.
- * @param ref The ref number of the request.
+ * @param peer The peer taskId.
+ * @param transId The transaction Id of the request.
  * @param status A {@link Matter.Status}.
  */
-declare function libertasVirtualDeviceStatusRsp(device: LibertasVirtualDevice, ref: number, status: number) : void;
+declare function libertasVirtualDeviceStatusRsp(device: LibertasVirtualDevice, peer: number, transId: number, status: number) : void;
 
 /**
  * Listen to a virtual device events.
@@ -772,7 +776,7 @@ declare function libertasTriggerAction(action: LibertasAction): void;
  * - `AlertHigh`: High alerts.
  * - `AlertSevere`: Severe alerts.
  */
-declare const enum NotificationImportance {
+declare enum NotificationImportance {
   Debug = 0,
   Info = 1,
   AlertLow = 2,
@@ -785,7 +789,7 @@ declare const enum NotificationImportance {
 /**
  * Notification argument variant tags.
  */
-declare const enum NotificationArgTag {
+declare enum NotificationArgTag {
   /**
    * A literal string argument included in the message as-is, without being
    * treated as a resource string. This can be used to include specific text that
@@ -936,7 +940,7 @@ declare interface DataName {
     arguments: NotificationArgument[];
 }
 
-declare const enum IndexDirection {
+declare enum IndexDirection {
     Above,
     Below,
 }
@@ -1137,7 +1141,7 @@ declare function libertasDataReadIndexed<T>(
 /**
  * Log levels
  */
-declare const enum LibertasLogLevel {
+declare enum LibertasLogLevel {
     TRACE,
     DEBUG,
     INFO,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libertas-ai/types",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Libertas TypeScript SDK",
   "license": "ISC",
   "author": "Qingjun Wei",