aes70 2.0.0 → 2.0.2

package/dist/AES70.es5.js

@@ -993,6 +993,16 @@
     }
   }
 
+  /**
+   * Error class raised when a connection is closed due to a timeout.
+   */
+  class TimeoutError extends Error {
+    constructor(error) {
+      super(`Connection has timed out.`);
+      this.name = 'aes70.TimeoutError';
+    }
+  }
+
   /**
    * Connection base class. It extends :class:`Events` and defines two events:
    *
@@ -1041,7 +1051,7 @@
         if (this._closed) return;
         this._closed = true;
         this.emit('close');
-        this.cleanup();
+        this.cleanup(e);
       });
     }
 
@@ -1133,7 +1143,7 @@
       this.emit('error', err);
     }
 
-    cleanup() {
+    cleanup(error) {
       if (this.is_closed()) throw new Error('cleanup() called twice.');
 
       // disable keepalive
@@ -1150,7 +1160,7 @@
 
       if (this.rx_idle_time() > t * 3) {
         this.emit('timeout');
-        this.error(new Error('Keepalive timeout.'));
+        this.error(new TimeoutError());
       } else if (this.tx_idle_time() > t * 0.75) {
         /* Try to flush buffers before actually sending out anything. */
         this.flush();
@@ -1527,6 +1537,20 @@
    * @static
    */
 
+  /**
+   * Error class raised when a connection is closed.
+   *
+   * @property {Error} [error] - The actual failure reason. May be undefined,
+   *   for instance if the connection was closed using close().
+   */
+  class CloseError extends Error {
+    constructor(error) {
+      super(`Connection has been closed.`);
+      this.name = 'aes70.CloseError';
+      this.error = error;
+    }
+  }
+
   class PendingCommand {
     get handle() {
       return this.command.handle;
@@ -1610,14 +1634,14 @@
       this._subscribers = new Map();
     }
 
-    cleanup() {
-      super.cleanup();
+    cleanup(error) {
+      super.cleanup(error);
       const subscribers = this._subscribers;
       this._subscribers = null;
       const pendingCommands = this._pendingCommands;
       this._pendingCommands = null;
 
-      const e = new Error('closed');
+      const e = new CloseError(error);
       pendingCommands.forEach((pendingCommand, id) => {
         pendingCommand.handleError(structuredClone(e));
       });
@@ -2695,9 +2719,9 @@
   const OcaResetCause = Enum8(OcaResetCause$1);
 
   class EventSubscriber {
-    constructor(callback, error_callback) {
+    constructor(callback, failure_callback) {
       this.callback = callback;
-      this.failure_callback = error_callback;
+      this.failure_callback = failure_callback;
     }
 
     emit(ctx, results) {
@@ -2709,13 +2733,14 @@
     }
 
     emit_error(ctx, error) {
-      if (this.error_callback) {
+      if (this.failure_callback) {
         try {
-          this.error_callback.call(ctx, error);
+          this.failure_callback.call(ctx, error);
         } catch (e) {
           console.error('Exception thrown by error event handler: ', e);
         }
       } else {
+        if (error instanceof CloseError) return;
         console.warn('No handler for error', error);
       }
     }
@@ -2823,7 +2848,7 @@
     [pos, try_again] = OcaBoolean.decodeFrom(view, pos);
     [pos, data] = OcaBlob.decodeFrom(view, pos);
 
-    return [type, try_again, view];
+    return [type, try_again, data];
   }
 
   /**
@@ -3011,6 +3036,130 @@
    * @static
    */
 
+  /**
+   * Observe a property in an object.
+   *
+   * The callback function is called when a property value or change is received. In
+   * that case the callback is called with the arguments `true, value, changeIndex`. When an
+   * error occurs, e.g. when fetching the initial property value using the corresponding
+   * getter, the callback is called with arguments `false, Error`.
+   *
+   * The meaning of the changeIndex argument is meaningful in situations where a property has
+   * associated min and max value. In that situation the value received by the callback is
+   * the return value of the getter, which is an instance of Arguments. When either the property
+   * itself or min/max changes, the changeIndex will be the corresponding index in the arguments
+   * list. If the property has no min and max or when the initial value is returned from the
+   * getter, the value of changeIndex is undefined.
+   *
+   * @param {ObjectBase} o The remote object.
+   * @param {string|Property} property
+   * @param {Function} callback The callback function
+   * @returns An unsubscribe/cleanup function.
+   */
+  function observeProperty(o, property, callback) {
+    let propertyName;
+
+    if (typeof property === 'string') {
+      propertyName = property;
+      property = o.get_properties().find_property(propertyName);
+
+      if (!property)
+        throw new Error(
+          `Could not find property ${propertyName} in ${o.ClassName}`
+        );
+    } else {
+      propertyName = property.name;
+    }
+
+    if (property.static) {
+      callback(true, o[propertyName]);
+      return () => {};
+    }
+
+    let lastValue = null;
+
+    const notify = (changeIndex) => {
+      try {
+        callback(true, lastValue, changeIndex);
+      } catch (error) {
+        console.error(
+          'Subscriber',
+          callback,
+          'to property',
+          propertyName,
+          'in',
+          o,
+          'threw exception',
+          error
+        );
+      }
+    };
+
+    const eventCallback = (value, changeType, eventId) => {
+      if (lastValue === null) return;
+      switch (changeType.value) {
+        case 1 /* OcaPropertyChangeType.CurrentChanged*/:
+          if (lastValue instanceof Arguments) {
+            lastValue.values[0] = value;
+            notify(0);
+            return;
+          } else {
+            lastValue = value;
+            notify();
+            return;
+          }
+        case 2 /*OcaPropertyChangeType.MinChanged*/:
+          if (lastValue instanceof Arguments) {
+            lastValue.values[1] = value;
+            notify(1);
+            return;
+          }
+          break;
+        case 3 /*OcaPropertyChangeType.MaxChanged*/:
+          if (lastValue instanceof Arguments) {
+            lastValue.values[2] = value;
+            notify(2);
+            return;
+          }
+          break;
+      }
+      console.warn('Unhandled event', value, changeType, eventId);
+    };
+
+    const errorCallback = (error) => {
+      callback(false, error);
+    };
+
+    let active = true;
+    const event = property.event(o);
+    const getter = property.getter(o);
+
+    if (!getter) {
+      throw new Error(`No getter found for ${propertyName} in ${o.ClassName}`);
+    }
+
+    let unsubscribe = null;
+
+    if (event) {
+      unsubscribe = event.subscribe(eventCallback, errorCallback);
+    }
+
+    getter((ok, result) => {
+      if (!active) return;
+      if (!ok) {
+        callback(false, result);
+      } else {
+        lastValue = result;
+        notify();
+      }
+    });
+
+    return () => {
+      active = false;
+      if (unsubscribe) unsubscribe();
+    };
+  }
+
   /**
    * Objects of this class can be used to keep a synchronized object containing
    * all properties of a remote OCA object. Instances of this class are usually
@@ -3040,7 +3189,7 @@
     sync() {
       if (this.synchronized) return Promise.resolve();
 
-      let index = 0;
+      let i = 0;
       const tasks = [];
 
       this.o.get_properties().forEach((prop) => {
@@ -3048,31 +3197,21 @@
 
         if (!getter) return;
 
-        const event = prop.event(this.o);
-
-        const change_handler = function (index, value, changeType) {
-          if (changeType !== OcaPropertyChangeType$1.CurrentChanged) return;
-
-          this.values[index] = value;
-        };
-
-        const get_handler = function (index, value) {
-          if (value instanceof Arguments) value = value.item(0);
-          this.values[index] = value;
-        };
-
-        if (event) {
-          const cb = change_handler.bind(this, index);
-          // NOTE: we do not want to wait for the promise to resolve
-          // before storing this unsubscription handler because that
-          // would have a potential race condition.
-          this.subscriptions.push(event.unsubscribe.bind(event, cb));
-          tasks.push(event.subscribe(cb).catch(function () {}));
-        }
-
-        tasks.push(getter().then(get_handler.bind(this, index), function () {}));
+        const index = i++;
 
-        index++;
+        const task = new Promise((resolve, reject) => {
+          const unsubscribe = observeProperty(this.o, prop, (ok, result) => {
+            if (ok) {
+              this.values[index] =
+                result instanceof Arguments ? result.item(0) : result;
+              resolve();
+            } else if (result instanceof RemoteError) {
+              resolve();
+            }
+          });
+          this.subscriptions.push(unsubscribe);
+        });
+        tasks.push(task);
       });
 
       return Promise.all(tasks);
@@ -3451,6 +3590,11 @@
       if (has_setter) descriptor.set = make_setter(prop.setter(blue_print, true));
 
       Object.defineProperty(o, prop.name, descriptor);
+      if (prop.aliases) {
+        prop.aliases.forEach((alias) => {
+          Object.defineProperty(o, alias, descriptor);
+        });
+      }
       index++;
     });
 
@@ -23316,130 +23460,6 @@
     }
   }
 
-  /**
-   * Observe a property in an object.
-   *
-   * The callback function is called when a property value or change is received. In
-   * that case the callback is called with the arguments `true, value, changeIndex`. When an
-   * error occurs, e.g. when fetching the initial property value using the corresponding
-   * getter, the callback is called with arguments `false, Error`.
-   *
-   * The meaning of the changeIndex argument is meaningful in situations where a property has
-   * associated min and max value. In that situation the value received by the callback is
-   * the return value of the getter, which is an instance of Arguments. When either the property
-   * itself or min/max changes, the changeIndex will be the corresponding index in the arguments
-   * list. If the property has no min and max or when the initial value is returned from the
-   * getter, the value of changeIndex is undefined.
-   *
-   * @param {ObjectBase} o The remote object.
-   * @param {string|Property} property
-   * @param {Function} callback The callback function
-   * @returns An unsubscribe/cleanup function.
-   */
-  function observeProperty(o, property, callback) {
-    let propertyName;
-
-    if (typeof property === 'string') {
-      propertyName = property;
-      property = o.get_properties().find_property(propertyName);
-
-      if (!property)
-        throw new Error(
-          `Could not find property ${propertyName} in ${o.ClassName}`
-        );
-    } else {
-      propertyName = property.name;
-    }
-
-    if (property.static) {
-      callback(true, o[propertyName]);
-      return () => {};
-    }
-
-    let lastValue = null;
-
-    const notify = (changeIndex) => {
-      try {
-        callback(true, lastValue, changeIndex);
-      } catch (error) {
-        console.error(
-          'Subscriber',
-          callback,
-          'to property',
-          propertyName,
-          'in',
-          o,
-          'threw exception',
-          error
-        );
-      }
-    };
-
-    const eventCallback = (value, changeType, eventId) => {
-      if (lastValue === null) return;
-      switch (changeType.value) {
-        case 1 /* OcaPropertyChangeType.CurrentChanged*/:
-          if (lastValue instanceof Arguments) {
-            lastValue.values[0] = value;
-            notify(0);
-            return;
-          } else {
-            lastValue = value;
-            notify();
-            return;
-          }
-        case 2 /*OcaPropertyChangeType.MinChanged*/:
-          if (lastValue instanceof Arguments) {
-            lastValue.values[1] = value;
-            notify(1);
-            return;
-          }
-          break;
-        case 3 /*OcaPropertyChangeType.MaxChanged*/:
-          if (lastValue instanceof Arguments) {
-            lastValue.values[2] = value;
-            notify(2);
-            return;
-          }
-          break;
-      }
-      console.warn('Unhandled event', value, changeType, eventId);
-    };
-
-    const errorCallback = (error) => {
-      callback(false, error);
-    };
-
-    let active = true;
-    const event = property.event(o);
-    const getter = property.getter(o);
-
-    if (!getter) {
-      throw new Error(`Not getter found for ${propertyName} in ${o.ClassName}`);
-    }
-
-    let unsubscribe = null;
-
-    if (event) {
-      unsubscribe = event.subscribe(eventCallback, errorCallback);
-    }
-
-    getter((ok, result) => {
-      if (!active) return;
-      if (!ok) {
-        callback(false, result);
-      } else {
-        lastValue = result;
-        notify();
-      }
-    });
-
-    return () => {
-      active = false;
-      if (unsubscribe) unsubscribe();
-    };
-  }
-
   class PropertyObserver {
     constructor(o, propertyName, cacheSubscriptions) {
       this.o = o;
@@ -24488,6 +24508,7 @@
     __proto__: null,
     AbstractUDPConnection: AbstractUDPConnection,
     ClientConnection: ClientConnection,
+    CloseError: CloseError,
     Command: Command,
     CommandRrq: CommandRrq,
     Connection: Connection,
@@ -24500,6 +24521,7 @@
     RemoteDevice: RemoteDevice,
     RemoteError: RemoteError,
     Response: Response$1,
+    TimeoutError: TimeoutError,
     Types: types,
     WebSocketConnection: WebSocketConnection,
     currentProtocolVersion: currentProtocolVersion,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aes70",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "A controller library for the AES70 protocol.",
   "type": "module",
   "main": "src/index.js",
@@ -16,7 +16,7 @@
   "scripts": {
     "test": "node --test --test-concurrency=1 tests/*.test.js",
     "test:only": "node --test --test-only --test-concurrency=1 tests/*.test.js",
-    "prepublishOnly": "npx rollup@4.52.0 src/bundle.browser.js --file dist/AES70.es5.js --format iife",
+    "prepublishOnly": "npx rollup@4.52.4 src/bundle.browser.js --file dist/AES70.es5.js --format iife",
     "docs": "cd esdoc && npm run build",
     "prettier": "npx prettier@2.0.5 --write .",
     "format": "npx prettier@2.0.5 --write .",

package/src/close_error.d.ts

@@ -0,0 +1,4 @@
+export declare class CloseError extends Error {
+  error?: Error;
+  constructor(error?: Error);
+}

package/src/close_error.js

@@ -0,0 +1,13 @@
+/**
+ * Error class raised when a connection is closed.
+ *
+ * @property {Error} [error] - The actual failure reason. May be undefined,
+ *   for instance if the connection was closed using close().
+ */
+export class CloseError extends Error {
+  constructor(error) {
+    super(`Connection has been closed.`);
+    this.name = 'aes70.CloseError';
+    this.error = error;
+  }
+}

package/src/connection.js

@@ -2,6 +2,7 @@ import { Events } from './events.js';
 import { decodeMessage } from './OCP1/decode_message.js';
 import { KeepAlive } from './OCP1/keepalive.js';
 import { MessageGenerator } from './OCP1/message_generator.js';
+import { TimeoutError } from './timeout_error.js';
 
 /**
  * Connection base class. It extends :class:`Events` and defines two events:
@@ -51,7 +52,7 @@ export class Connection extends Events {
       if (this._closed) return;
       this._closed = true;
       this.emit('close');
-      this.cleanup();
+      this.cleanup(e);
     });
   }
 
@@ -143,7 +144,7 @@ export class Connection extends Events {
     this.emit('error', err);
   }
 
-  cleanup() {
+  cleanup(error) {
     if (this.is_closed()) throw new Error('cleanup() called twice.');
 
     // disable keepalive
@@ -160,7 +161,7 @@ export class Connection extends Events {
 
     if (this.rx_idle_time() > t * 3) {
       this.emit('timeout');
-      this.error(new Error('Keepalive timeout.'));
+      this.error(new TimeoutError());
     } else if (this.tx_idle_time() > t * 0.75) {
       /* Try to flush buffers before actually sending out anything. */
       this.flush();

package/src/controller/base_event.js

@@ -1,9 +1,10 @@
+import { CloseError } from '../close_error.js';
 import { OcaEvent } from '../types/OcaEvent.js';
 
 class EventSubscriber {
-  constructor(callback, error_callback) {
+  constructor(callback, failure_callback) {
     this.callback = callback;
-    this.failure_callback = error_callback;
+    this.failure_callback = failure_callback;
   }
 
   emit(ctx, results) {
@@ -15,13 +16,14 @@ class EventSubscriber {
   }
 
   emit_error(ctx, error) {
-    if (this.error_callback) {
+    if (this.failure_callback) {
       try {
-        this.error_callback.call(ctx, error);
+        this.failure_callback.call(ctx, error);
       } catch (e) {
         console.error('Exception thrown by error event handler: ', e);
       }
     } else {
+      if (error instanceof CloseError) return;
       console.warn('No handler for error', error);
     }
   }

package/src/controller/client_connection.js

@@ -8,6 +8,7 @@ import { Notification2 } from '../OCP1/notification2.js';
 import { Arguments } from './arguments.js';
 import { OcaStatus } from '../types/OcaStatus.js';
 import { EncodedArguments } from '../OCP1/encoded_arguments.js';
+import { CloseError } from '../close_error.js';
 
 class PendingCommand {
   get handle() {
@@ -92,14 +93,14 @@ export class ClientConnection extends Connection {
     this._subscribers = new Map();
   }
 
-  cleanup() {
-    super.cleanup();
+  cleanup(error) {
+    super.cleanup(error);
     const subscribers = this._subscribers;
     this._subscribers = null;
     const pendingCommands = this._pendingCommands;
     this._pendingCommands = null;
 
-    const e = new Error('closed');
+    const e = new CloseError(error);
     pendingCommands.forEach((pendingCommand, id) => {
       pendingCommand.handleError(structuredClone(e));
     });

package/src/controller/make_control_class.js

@@ -42,6 +42,11 @@ function createPropertySync(control_class) {
     if (has_setter) descriptor.set = make_setter(prop.setter(blue_print, true));
 
     Object.defineProperty(o, prop.name, descriptor);
+    if (prop.aliases) {
+      prop.aliases.forEach((alias) => {
+        Object.defineProperty(o, alias, descriptor);
+      });
+    }
     index++;
   });
 

package/src/controller/notification_error.js

@@ -25,7 +25,7 @@ function parseNotificationExceptionData(buffer) {
   [pos, try_again] = OcaBoolean.decodeFrom(view, pos);
   [pos, data] = OcaBlob.decodeFrom(view, pos);
 
-  return [type, try_again, view];
+  return [type, try_again, data];
 }
 
 /**

package/src/controller/observeProperty.js

@@ -103,7 +103,7 @@ export function observeProperty(o, property, callback) {
   const getter = property.getter(o);
 
   if (!getter) {
-    throw new Error(`Not getter found for ${propertyName} in ${o.ClassName}`);
+    throw new Error(`No getter found for ${propertyName} in ${o.ClassName}`);
   }
 
   let unsubscribe = null;

package/src/controller/property_sync.js

@@ -1,5 +1,7 @@
 import { Arguments } from './arguments.js';
 import { OcaPropertyChangeType } from '../types/OcaPropertyChangeType.js';
+import { observeProperty } from './observeProperty.js';
+import { RemoteError } from './remote_error.js';
 
 /**
  * Objects of this class can be used to keep a synchronized object containing
@@ -30,7 +32,7 @@ export class PropertySync {
   sync() {
     if (this.synchronized) return Promise.resolve();
 
-    let index = 0;
+    let i = 0;
     const tasks = [];
 
     this.o.get_properties().forEach((prop) => {
@@ -38,31 +40,21 @@ export class PropertySync {
 
       if (!getter) return;
 
-      const event = prop.event(this.o);
-
-      const change_handler = function (index, value, changeType) {
-        if (changeType !== OcaPropertyChangeType.CurrentChanged) return;
-
-        this.values[index] = value;
-      };
-
-      const get_handler = function (index, value) {
-        if (value instanceof Arguments) value = value.item(0);
-        this.values[index] = value;
-      };
-
-      if (event) {
-        const cb = change_handler.bind(this, index);
-        // NOTE: we do not want to wait for the promise to resolve
-        // before storing this unsubscription handler because that
-        // would have a potential race condition.
-        this.subscriptions.push(event.unsubscribe.bind(event, cb));
-        tasks.push(event.subscribe(cb).catch(function () {}));
-      }
-
-      tasks.push(getter().then(get_handler.bind(this, index), function () {}));
-
-      index++;
+      const index = i++;
+
+      const task = new Promise((resolve, reject) => {
+        const unsubscribe = observeProperty(this.o, prop, (ok, result) => {
+          if (ok) {
+            this.values[index] =
+              result instanceof Arguments ? result.item(0) : result;
+            resolve();
+          } else if (result instanceof RemoteError) {
+            resolve();
+          }
+        });
+        this.subscriptions.push(unsubscribe);
+      });
+      tasks.push(task);
     });
 
     return Promise.all(tasks);

package/src/index.default.d.ts

@@ -16,6 +16,8 @@ export * from './controller/abstract_udp_connection';
 export * from './controller/fetch_device_content';
 export * from './controller/remote_error';
 export * from './controller/notification_error';
+export * from './close_error';
+export * from './timeout_error';
 
 import * as RemoteControlClasses from './controller/ControlClasses';
 import * as Types from './types';

package/src/index.default.js

@@ -18,6 +18,8 @@ export * from './controller/PropertyObserver.js';
 export * from './controller/fetch_device_content.js';
 export * from './controller/remote_error.js';
 export * from './controller/notification_error.js';
+export * from './close_error.js';
+export * from './timeout_error.js';
 
 import * as RemoteControlClasses from './controller/ControlClasses.js';
 import * as Types from './types.js';

package/src/timeout_error.d.ts

@@ -0,0 +1,3 @@
+export declare class TimeoutError extends Error {
+  constructor();
+}

package/src/timeout_error.js

@@ -0,0 +1,9 @@
+/**
+ * Error class raised when a connection is closed due to a timeout.
+ */
+export class TimeoutError extends Error {
+  constructor(error) {
+    super(`Connection has timed out.`);
+    this.name = 'aes70.TimeoutError';
+  }
+}