aes70 1.6.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aes70",
-  "version": "1.6.1",
+  "version": "2.0.0",
   "description": "A controller library for the AES70 protocol.",
   "type": "module",
   "main": "src/index.js",
@@ -15,8 +15,8 @@
   },
   "scripts": {
     "test": "node --test --test-concurrency=1 tests/*.test.js",
-    "test:only": "node --test-only --test-concurrency=1 tests/*.test.js",
-    "prepublishOnly": "make",
+    "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",
     "docs": "cd esdoc && npm run build",
     "prettier": "npx prettier@2.0.5 --write .",
     "format": "npx prettier@2.0.5 --write .",

package/src/OCP1/Arguments.js

@@ -4,6 +4,9 @@ import { createType } from './createType.js';
 export function Arguments(...Types) {
   return createType({
     isConstantLength: false,
+    canEncode: function (value) {
+      return Array.isArray(value) || isTypedArray(value);
+    },
     encodedLength: function (value) {
       if (!(Array.isArray(value) || isTypedArray(value)))
         throw new TypeError('Expected array.');

package/src/OCP1/Enum.js

@@ -7,6 +7,14 @@ export function Enum(DataType, Base) {
   const type = createType({
     isConstantLength: true,
     encodedLength: Base.encodedLength,
+    canEncode: function (value) {
+      const type = typeof value;
+      return (
+        (type === 'object' && value instanceof DataType) ||
+        (type === 'string' && DataType.hasName(value)) ||
+        (type === 'number' && DataType.hasValue(value))
+      );
+    },
     encodeTo: function (dataView, pos, value) {
       if (typeof value === 'object' && value instanceof DataType) {
         value = value.value;

package/src/OCP1/OcaActionObjectSearchResult.js

@@ -0,0 +1,20 @@
+/*
+ * This file has been generated.
+ */
+import { OcaList } from './OcaList.js';
+import { OcaObjectIdentification } from './OcaObjectIdentification.js';
+import { OcaString } from './OcaString.js';
+import { OcaUint32 } from './OcaUint32.js';
+import { Struct } from './Struct.js';
+
+import { OcaActionObjectSearchResult as type } from '../types/OcaActionObjectSearchResult.js';
+
+export const OcaActionObjectSearchResult = Struct(
+  {
+    Identification: OcaObjectIdentification,
+    ContainerPath: OcaList(OcaUint32),
+    Role: OcaString,
+    Label: OcaString,
+  },
+  type
+);

package/src/OCP1/OcaActionObjectSearchResultFlags.js

@@ -0,0 +1,3 @@
+import { Bitset16 } from './Bitset16.js';
+
+export const OcaActionObjectSearchResultFlags = Bitset16;

package/src/OCP1/OcaArray1D.js

@@ -0,0 +1,108 @@
+import { createType } from './createType.js';
+import { isTypedArray } from './is_typed_array.js';
+import { getLengthEncoder } from './getLengthEncoder.js';
+
+function OcaArray1DConstantLength(Type, length) {
+  const encodedLength = Type.encodedLength(void 0);
+  const encodeTo = Type.encodeTo;
+  const decode = Type.decode;
+
+  const canEncode = function (value) {
+    return (
+      (Array.isArray(value) || isTypedArray(value)) && value.length === length
+    );
+  };
+
+  return createType({
+    isConstantLength: true,
+    canEncode,
+    encodedLength: function () {
+      return length * encodedLength;
+    },
+    encodeTo: function (dataView, pos, value) {
+      for (let i = 0; i < length; i++) {
+        pos = encodeTo(dataView, pos, value[i]);
+      }
+
+      return pos;
+    },
+    decode: function (dataView, pos) {
+      const value = new Array(length);
+
+      for (let i = 0; i < length; i++) {
+        value[i] = decode(dataView, pos);
+        pos += encodedLength;
+      }
+
+      return value;
+    },
+  });
+}
+
+function OcaArray1DDynamicLength(Type, length) {
+  const encodedLength = Type.encodedLength;
+  const encodeTo = Type.encodeTo;
+  const decodeFrom = Type.decodeFrom;
+  const decodeLength = Type.decodeLength;
+
+  const canEncode = function (value) {
+    return (
+      (Array.isArray(value) || isTypedArray(value)) && value.length === length
+    );
+  };
+
+  return createType({
+    isConstantLength: false,
+    canEncode,
+    encodedLength: function (value) {
+      if (!canEncode(value))
+        throw new TypeError(`Expected array of length ${length}.`);
+
+      let result = 0;
+      for (let i = 0; i < length; i++) {
+        result += encodedLength(value[i]);
+      }
+      return result;
+    },
+    encodeTo: function (dataView, pos, value) {
+      for (let i = 0; i < length; i++) {
+        pos = encodeTo(dataView, pos, value[i]);
+      }
+
+      return pos;
+    },
+    decodeFrom: function (dataView, pos) {
+      const value = new Array(length);
+
+      for (let i = 0; i < length; i++) {
+        let tmp;
+
+        [pos, tmp] = decodeFrom(dataView, pos);
+
+        value[i] = tmp;
+      }
+
+      return [pos, value];
+    },
+    decodeLength: function (dataView, pos) {
+      for (let i = 0; i < length; i++) {
+        pos = decodeLength(dataView, pos);
+      }
+
+      return pos;
+    },
+  });
+}
+
+export function OcaArray1D(Type, length) {
+  if (
+    typeof length !== 'number' ||
+    !isFinite(length) ||
+    !Number.isInteger(length) ||
+    length <= 0
+  )
+    throw new TypeError(`Expected length to be a positive integer.`);
+  return Type.isConstantLength
+    ? OcaArray1DConstantLength(Type, length)
+    : OcaArray1DDynamicLength(Type, length);
+}

package/src/OCP1/OcaBitstring.js

@@ -44,6 +44,9 @@ function encodeBitstring(dataView, pos, from) {
 
 export const OcaBitstring = createType({
   isConstantLength: false,
+  canEncode: function (value) {
+    return Array.isArray(value);
+  },
   encodedLength: function (value) {
     if (!Array.isArray(value)) throw new TypeError('Expected Array.');
 

package/src/OCP1/OcaBlob.js

@@ -1,44 +1,3 @@
-import { createType } from './createType.js';
+import { createBlobType } from './createBlobType.js';
 
-export const OcaBlob = createType({
-  isConstantLength: false,
-  encodedLength: function (value) {
-    if (value instanceof ArrayBuffer) value = new Uint8Array(value);
-    if (!Array.isArray(value) && !(value instanceof Uint8Array))
-      throw new TypeError('Expected Array or Uint8Array');
-
-    const length = value.length;
-
-    if (length > 0xffff)
-      throw new Error('Array too long for OcaBlob OCP.1 encoding.');
-
-    return 2 + length;
-  },
-  encodeTo: function (dataView, pos, value) {
-    if (value instanceof ArrayBuffer) value = new Uint8Array(value);
-
-    const length = value.length;
-
-    dataView.setUint16(pos, length);
-    pos += 2;
-
-    const u8 = new Uint8Array(dataView.buffer, dataView.byteOffset);
-    u8.set(value, pos);
-    return pos + length;
-  },
-  decodeFrom: function (dataView, pos) {
-    const length = dataView.getUint16(pos);
-
-    pos += 2;
-
-    return [
-      pos + length,
-      new Uint8Array(dataView.buffer, dataView.byteOffset + pos, length),
-    ];
-  },
-  decodeLength: function (dataView, pos) {
-    const length = dataView.getUint16(pos);
-
-    return pos + 2 + length;
-  },
-});
+export const OcaBlob = createBlobType(2);

package/src/OCP1/OcaBlobFixedLen.js

@@ -3,6 +3,14 @@ import { createType } from './createType.js';
 export function OcaBlobFixedLen(Length) {
   return createType({
     isConstantLength: true,
+    canEncode: function (value) {
+      if (typeof value !== 'object') return false;
+
+      return (
+        (value instanceof Uint8Array || Array.isArray(value)) &&
+        value.length === Length
+      );
+    },
     encodedLength: function (value) {
       return Length;
     },

package/src/OCP1/OcaBlockConfigurability.js

@@ -0,0 +1,3 @@
+import { Bitset16 } from './Bitset16.js';
+
+export const OcaBlockConfigurability = Bitset16;

package/src/OCP1/OcaBoolean.js

@@ -2,6 +2,9 @@ import { createType } from './createType.js';
 
 export const OcaBoolean = createType({
   isConstantLength: true,
+  canEncode: function (value) {
+    return typeof value === 'boolean' || typeof value === 'number';
+  },
   encodedLength: function (value) {
     return 1;
   },

package/src/OCP1/OcaCommand.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaList } from './OcaList.js';
+import { OcaLongBlob } from './OcaLongBlob.js';
+import { OcaMethod } from './OcaMethod.js';
+import { Struct } from './Struct.js';
+
+import { OcaCommand as type } from '../types/OcaCommand.js';
+
+export const OcaCommand = Struct(
+  {
+    Method: OcaMethod,
+    Parameters: OcaList(OcaLongBlob),
+  },
+  type
+);

package/src/OCP1/OcaCommandResult.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaList } from './OcaList.js';
+import { OcaLongBlob } from './OcaLongBlob.js';
+import { OcaStatus } from './OcaStatus.js';
+import { Struct } from './Struct.js';
+
+import { OcaCommandResult as type } from '../types/OcaCommandResult.js';
+
+export const OcaCommandResult = Struct(
+  {
+    Status: OcaStatus,
+    Data: OcaList(OcaLongBlob),
+  },
+  type
+);

package/src/OCP1/OcaCommandSetResult.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaCommandResult } from './OcaCommandResult.js';
+import { OcaGenericEndState } from './OcaGenericEndState.js';
+import { OcaList } from './OcaList.js';
+import { Struct } from './Struct.js';
+
+import { OcaCommandSetResult as type } from '../types/OcaCommandSetResult.js';
+
+export const OcaCommandSetResult = Struct(
+  {
+    EndState: OcaGenericEndState,
+    CommandResults: OcaList(OcaCommandResult),
+  },
+  type
+);

package/src/OCP1/OcaConstructionParameter.js

@@ -0,0 +1,16 @@
+/*
+ * This file has been generated.
+ */
+import { OcaBlob } from './OcaBlob.js';
+import { OcaPropertyID } from './OcaPropertyID.js';
+import { Struct } from './Struct.js';
+
+import { OcaConstructionParameter as type } from '../types/OcaConstructionParameter.js';
+
+export const OcaConstructionParameter = Struct(
+  {
+    ID: OcaPropertyID,
+    Value: OcaBlob,
+  },
+  type
+);

package/src/OCP1/OcaCounter.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+import { OcaList } from './OcaList.js';
+import { OcaString } from './OcaString.js';
+import { OcaUint16 } from './OcaUint16.js';
+import { OcaUint32 } from './OcaUint32.js';
+import { OcaUint64 } from './OcaUint64.js';
+import { Struct } from './Struct.js';
+
+import { OcaCounter as type } from '../types/OcaCounter.js';
+
+export const OcaCounter = Struct(
+  {
+    ID: OcaUint16,
+    Value: OcaUint64,
+    InitialValue: OcaUint64,
+    Role: OcaString,
+    Notifiers: OcaList(OcaUint32),
+  },
+  type
+);

package/src/OCP1/OcaCounterNotifierFilterParameters.js

@@ -0,0 +1,19 @@
+/*
+ * This file has been generated.
+ */
+import { OcaFloat32 } from './OcaFloat32.js';
+import { OcaRelationalOperator } from './OcaRelationalOperator.js';
+import { OcaUint64 } from './OcaUint64.js';
+import { Struct } from './Struct.js';
+
+import { OcaCounterNotifierFilterParameters as type } from '../types/OcaCounterNotifierFilterParameters.js';
+
+export const OcaCounterNotifierFilterParameters = Struct(
+  {
+    Threshold: OcaUint64,
+    Operator: OcaRelationalOperator,
+    Period: OcaFloat32,
+    CountDelta: OcaUint64,
+  },
+  type
+);

package/src/OCP1/OcaCounterSet.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaBlob } from './OcaBlob.js';
+import { OcaCounter } from './OcaCounter.js';
+import { OcaList } from './OcaList.js';
+import { Struct } from './Struct.js';
+
+import { OcaCounterSet as type } from '../types/OcaCounterSet.js';
+
+export const OcaCounterSet = Struct(
+  {
+    ID: OcaBlob,
+    Counters: OcaList(OcaCounter),
+  },
+  type
+);

package/src/OCP1/OcaCounterUpdate.js

@@ -0,0 +1,18 @@
+/*
+ * This file has been generated.
+ */
+import { OcaBlob } from './OcaBlob.js';
+import { OcaUint16 } from './OcaUint16.js';
+import { OcaUint64 } from './OcaUint64.js';
+import { Struct } from './Struct.js';
+
+import { OcaCounterUpdate as type } from '../types/OcaCounterUpdate.js';
+
+export const OcaCounterUpdate = Struct(
+  {
+    CounterSetID: OcaBlob,
+    CounterID: OcaUint16,
+    Value: OcaUint64,
+  },
+  type
+);

package/src/OCP1/OcaCounterUpdateEventData.js

@@ -0,0 +1,15 @@
+/*
+ * This file has been generated.
+ */
+import { OcaCounterUpdate } from './OcaCounterUpdate.js';
+import { OcaList } from './OcaList.js';
+import { Struct } from './Struct.js';
+
+import { OcaCounterUpdateEventData as type } from '../types/OcaCounterUpdateEventData.js';
+
+export const OcaCounterUpdateEventData = Struct(
+  {
+    Updates: OcaList(OcaCounterUpdate),
+  },
+  type
+);

package/src/OCP1/OcaDatasetSearchResult.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaBlockMember } from './OcaBlockMember.js';
+import { OcaString } from './OcaString.js';
+import { Struct } from './Struct.js';
+
+import { OcaDatasetSearchResult as type } from '../types/OcaDatasetSearchResult.js';
+
+export const OcaDatasetSearchResult = Struct(
+  {
+    Object: OcaBlockMember,
+    Name: OcaString,
+    Type: OcaString,
+  },
+  type
+);

package/src/OCP1/OcaDeviceGenericState.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaDeviceGenericState as type } from '../types/OcaDeviceGenericState.js';
+
+export const OcaDeviceGenericState = Enum8(type);

package/src/OCP1/OcaDeviceOperationalState.js

@@ -0,0 +1,16 @@
+/*
+ * This file has been generated.
+ */
+import { OcaBlob } from './OcaBlob.js';
+import { OcaDeviceGenericState } from './OcaDeviceGenericState.js';
+import { Struct } from './Struct.js';
+
+import { OcaDeviceOperationalState as type } from '../types/OcaDeviceOperationalState.js';
+
+export const OcaDeviceOperationalState = Struct(
+  {
+    Generic: OcaDeviceGenericState,
+    Details: OcaBlob,
+  },
+  type
+);

package/src/OCP1/OcaExecutableType.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaExecutableType as type } from '../types/OcaExecutableType.js';
+
+export const OcaExecutableType = Enum8(type);

package/src/OCP1/OcaFloat32.js

@@ -2,6 +2,9 @@ import { createType } from './createType.js';
 
 export const OcaFloat32 = createType({
   isConstantLength: true,
+  canEncode: function (value) {
+    return typeof value === 'number';
+  },
   encodedLength: function (value) {
     return 4;
   },

package/src/OCP1/OcaFloat64.js

@@ -2,6 +2,9 @@ import { createType } from './createType.js';
 
 export const OcaFloat64 = createType({
   isConstantLength: true,
+  canEncode: function (value) {
+    return typeof value === 'number';
+  },
   encodedLength: function (value) {
     return 8;
   },

package/src/OCP1/OcaGenericEndState.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaGenericEndState as type } from '../types/OcaGenericEndState.js';
+
+export const OcaGenericEndState = Enum8(type);

package/src/OCP1/OcaGlobalTypeIdentifier.js

@@ -9,7 +9,7 @@ import { OcaGlobalTypeIdentifier as type } from '../types/OcaGlobalTypeIdentifie
 
 export const OcaGlobalTypeIdentifier = Struct(
   {
-    Authority: OcaBlobFixedLen(3),
+    Organization: OcaBlobFixedLen(3),
     ID: OcaUint32,
   },
   type

package/src/OCP1/OcaGroupException.js

@@ -0,0 +1,18 @@
+/*
+ * This file has been generated.
+ */
+import { OcaMethodID } from './OcaMethodID.js';
+import { OcaStatus } from './OcaStatus.js';
+import { OcaUint32 } from './OcaUint32.js';
+import { Struct } from './Struct.js';
+
+import { OcaGroupException as type } from '../types/OcaGroupException.js';
+
+export const OcaGroupException = Struct(
+  {
+    ONo: OcaUint32,
+    MethodID: OcaMethodID,
+    Status: OcaStatus,
+  },
+  type
+);

package/src/OCP1/OcaIODirection.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaIODirection as type } from '../types/OcaIODirection.js';
+
+export const OcaIODirection = Enum8(type);

package/src/OCP1/OcaIP4AutoconfigMode.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaIP4AutoconfigMode as type } from '../types/OcaIP4AutoconfigMode.js';
+
+export const OcaIP4AutoconfigMode = Enum8(type);

package/src/OCP1/OcaIP4Gateway.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaString } from './OcaString.js';
+import { OcaUint16 } from './OcaUint16.js';
+import { Struct } from './Struct.js';
+
+import { OcaIP4Gateway as type } from '../types/OcaIP4Gateway.js';
+
+export const OcaIP4Gateway = Struct(
+  {
+    DestinationPrefix: OcaString,
+    GatewayAddress: OcaString,
+    Metric: OcaUint16,
+  },
+  type
+);

package/src/OCP1/OcaIP4NetworkSettings.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+import { OcaIP4AutoconfigMode } from './OcaIP4AutoconfigMode.js';
+import { OcaIP4Gateway } from './OcaIP4Gateway.js';
+import { OcaList } from './OcaList.js';
+import { OcaString } from './OcaString.js';
+import { Struct } from './Struct.js';
+
+import { OcaIP4NetworkSettings as type } from '../types/OcaIP4NetworkSettings.js';
+
+export const OcaIP4NetworkSettings = Struct(
+  {
+    AddressAndPrefix: OcaString,
+    AutoconfigMode: OcaIP4AutoconfigMode,
+    DhcpServerAddress: OcaString,
+    DefaultGatewayAddress: OcaString,
+    AdditionalGateways: OcaList(OcaIP4Gateway),
+    DnsServerAddresses: OcaList(OcaString),
+    AdditionalParameters: OcaString,
+  },
+  type
+);

package/src/OCP1/OcaIP6AutoconfigMode.js

@@ -0,0 +1,4 @@
+import { Enum8 } from './Enum8.js';
+import { OcaIP6AutoconfigMode as type } from '../types/OcaIP6AutoconfigMode.js';
+
+export const OcaIP6AutoconfigMode = Enum8(type);

package/src/OCP1/OcaIP6Gateway.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+import { OcaString } from './OcaString.js';
+import { OcaUint16 } from './OcaUint16.js';
+import { Struct } from './Struct.js';
+
+import { OcaIP6Gateway as type } from '../types/OcaIP6Gateway.js';
+
+export const OcaIP6Gateway = Struct(
+  {
+    DestinationPrefix: OcaString,
+    GatewayAddress: OcaString,
+    Metric: OcaUint16,
+  },
+  type
+);

package/src/OCP1/OcaIP6NetworkSettings.js

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+import { OcaIP6AutoconfigMode } from './OcaIP6AutoconfigMode.js';
+import { OcaIP6Gateway } from './OcaIP6Gateway.js';
+import { OcaList } from './OcaList.js';
+import { OcaString } from './OcaString.js';
+import { Struct } from './Struct.js';
+
+import { OcaIP6NetworkSettings as type } from '../types/OcaIP6NetworkSettings.js';
+
+export const OcaIP6NetworkSettings = Struct(
+  {
+    AddressAndPrefix: OcaString,
+    AutoconfigMode: OcaIP6AutoconfigMode,
+    LinkLocalAddress: OcaString,
+    DhcpServerAddress: OcaString,
+    DefaultGatewayAddress: OcaString,
+    AdditionalGateways: OcaList(OcaIP6Gateway),
+    DnsServerAddresses: OcaList(OcaString),
+    AdditionalParameters: OcaString,
+  },
+  type
+);

package/src/OCP1/OcaInt16.js

@@ -2,6 +2,9 @@ import { createType } from './createType.js';
 
 export const OcaInt16 = createType({
   isConstantLength: true,
+  canEncode: function (value) {
+    return typeof value === 'number';
+  },
   encodedLength: function (value) {
     return 2;
   },