@project-chip/matter.js 0.4.0 → 0.5.0

package/README.md

@@ -14,30 +14,31 @@ The following features are abstracted away to allow to be implemented environmen
 ## Exported functionality
 This library exports the Matter protocol functionality as well as some helper functions as named exports:
 
-| Export                                  | Description                                                                                                                              |
-|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
-| `@project-chip/matter.js`               | Exports the current (legacy!) low level API to implement a Device or a Controller. This will be replaced soon by the new High Level API! |
-| `@project-chip/matter.js/certificate`   | Exports Certificate (Root-/PAA/PAI/IAC/DA-Certificates) related functionality                                                            |
-| `@project-chip/matter.js/cluster`       | Exports Matter Cluster definitions and Default Cluster-Handlers                                                                          |
-| `@project-chip/matter.js/codec`         | Exports Codecs for e.g. Matter-Messages                                                                                                  |
-| `@project-chip/matter.js/common`        | Exports certain common functionalities                                                                                                   |
-| `@project-chip/matter.js/crypto`        | Exports Crypto related abstract functionality that needs to be implemented platform specific!                                            |
-| `@project-chip/matter.js/datatype`      | Exports Matter Data types                                                                                                                |
-| `@project-chip/matter.js/fabric`        | Exports Matter-Fabric functionality                                                                                                      |
-| `@project-chip/matter.js/interaction`   | Exports Matter Interaction protocol functionality                                                                                        |
-| `@project-chip/matter.js/log`           | Exports Logging functionality (based on "console")                                                                                       |
-| `@project-chip/matter.js/math`          | Exports Math functionality used by Matter                                                                                                |
-| `@project-chip/matter.js/mdns`          | Exports Basic MDNS functionality (uses Network implementation)                                                                           |
-| `@project-chip/matter.js/net`           | Exports Basic Network abstract functionality that needs to be implemented platform specific!                                             |
-| `@project-chip/matter.js/protocol`      | Exports Basic Matter protocol functionality                                                                                              |
-| `@project-chip/matter.js/schema`        | Exports Schema definitions and functionality                                                                                             |
-| `@project-chip/matter.js/securechannel` | Exports Secure Channel functionality                                                                                                     |
-| `@project-chip/matter.js/session`       | Exports Session and Secure-Session functionality                                                                                         |
-| `@project-chip/matter.js/spec`          | Exports Matter Specification References                                                                                                  |
-| `@project-chip/matter.js/storage`       | Exports Basic Storage abstract functionality that needs to be implemented platform specific!                                             |
-| `@project-chip/matter.js/time`          | Exports Basic Time/Timer abstract functionality that needs to be implemented platform specific!                                          |
-| `@project-chip/matter.js/tlv`           | Exports Matter TLV type definitions                                                                                                      |
-| `@project-chip/matter.js/util`          | Exports Basic Utility functionality                                                                                                      |
+| Export                                  | Description                                                                                     |
+|-----------------------------------------|-------------------------------------------------------------------------------------------------|
+| `@project-chip/matter.js`               | Exports the API to implement a Device or a Controller.                                          |
+| `@project-chip/matter.js/certificate`   | Exports Certificate (Root-/PAA/PAI/IAC/DA-Certificates) related functionality                   |
+| `@project-chip/matter.js/cluster`       | Exports Matter Cluster definitions and Default Cluster-Handlers                                 |
+| `@project-chip/matter.js/codec`         | Exports Codecs for e.g. Matter-Messages                                                         |
+| `@project-chip/matter.js/common`        | Exports certain common functionalities                                                          |
+| `@project-chip/matter.js/crypto`        | Exports Crypto related abstract functionality that needs to be implemented platform specific!   |
+| `@project-chip/matter.js/datatype`      | Exports Matter Data types                                                                       |
+| `@project-chip/matter.js/fabric`        | Exports Matter-Fabric functionality                                                             |
+| `@project-chip/matter.js/interaction`   | Exports Matter Interaction protocol functionality                                               |
+| `@project-chip/matter.js/log`           | Exports Logging functionality (based on "console")                                              |
+| `@project-chip/matter.js/math`          | Exports Math functionality used by Matter                                                       |
+| `@project-chip/matter.js/mdns`          | Exports Basic MDNS functionality (uses Network implementation)                                  |
+| `@project-chip/matter.js/model`         | Exports a JavaScript version of the Matter data model                                           |
+| `@project-chip/matter.js/net`           | Exports Basic Network abstract functionality that needs to be implemented platform specific!    |
+| `@project-chip/matter.js/protocol`      | Exports Basic Matter protocol functionality                                                     |
+| `@project-chip/matter.js/schema`        | Exports Schema definitions and functionality                                                    |
+| `@project-chip/matter.js/securechannel` | Exports Secure Channel functionality                                                            |
+| `@project-chip/matter.js/session`       | Exports Session and Secure-Session functionality                                                |
+| `@project-chip/matter.js/spec`          | Exports Matter Specification References                                                         |
+| `@project-chip/matter.js/storage`       | Exports Basic Storage abstract functionality that needs to be implemented platform specific!    |
+| `@project-chip/matter.js/time`          | Exports Basic Time/Timer abstract functionality that needs to be implemented platform specific! |
+| `@project-chip/matter.js/tlv`           | Exports Matter TLV type definitions                                                             |
+| `@project-chip/matter.js/util`          | Exports Basic Utility functionality                                                             |
 
 Both exports and the typings are exported as CommonJS and ES6 modules.
 

package/dist/cjs/CommissioningController.d.ts

@@ -1,41 +1,38 @@
-/**
- * @license
- * Copyright 2022 The matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
+import { ServerAddressIp } from "./common/ServerAddress.js";
+import { Endpoint } from "./device/Endpoint.js";
 import { MatterNode } from "./MatterNode.js";
+import { MdnsBroadcaster } from "./mdns/MdnsBroadcaster.js";
 import { MdnsScanner } from "./mdns/MdnsScanner.js";
-import { StorageManager } from "./storage/StorageManager.js";
+import { CommissioningOptions } from "./protocol/ControllerCommissioner.js";
 import { InteractionClient } from "./protocol/interaction/InteractionClient.js";
-import { Endpoint } from "./device/Endpoint.js";
-import { ClusterClientObj } from "./cluster/client/ClusterClient.js";
-import { BitSchema, TypeFromBitSchema } from "./schema/BitmapSchema.js";
-import { Attributes, Cluster, Commands, Events } from "./cluster/Cluster.js";
+import { StorageContext } from "./storage/StorageContext.js";
 /**
  * Constructor options for the CommissioningController class
  */
 export interface CommissioningControllerOptions {
-    ip: string;
-    port: number;
-    disableIpv4?: boolean;
-    listeningAddressIpv4?: string;
-    listeningAddressIpv6?: string;
-    delayedPairing?: boolean;
+    serverAddress?: ServerAddressIp;
+    readonly localPort?: number;
+    readonly disableIpv4?: boolean;
+    readonly listeningAddressIpv4?: string;
+    readonly listeningAddressIpv6?: string;
+    readonly delayedPairing?: boolean;
+    readonly subscribeAllAttributes?: boolean;
+    readonly subscribeMinIntervalFloorSeconds?: number;
+    readonly subscribeMaxIntervalCeilingSeconds?: number;
     passcode: number;
-    discriminator: number;
+    longDiscriminator?: number;
+    shortDiscriminator?: number;
+    commissioningOptions?: CommissioningOptions;
 }
 export declare class CommissioningController extends MatterNode {
-    private readonly ip;
-    private readonly port;
-    private readonly disableIpv4;
+    private readonly options;
+    serverAddress?: ServerAddressIp;
     private readonly listeningAddressIpv4?;
     private readonly listeningAddressIpv6?;
-    private readonly passcode;
-    private readonly discriminator;
-    readonly delayedPairing: boolean;
-    private storageManager?;
+    private storage?;
     private mdnsScanner?;
     private controllerInstance?;
+    private interactionClient?;
     private nodeId?;
     private endpoints;
     /**
@@ -49,6 +46,7 @@ export declare class CommissioningController extends MatterNode {
      * After connection the endpoint data of the device is analyzed and an object structure is created.
      */
     connect(): Promise<void>;
+    initializeAfterConnect(): Promise<void>;
     /**
      * Set the MDNS Scanner instance. Should be only used internally
      *
@@ -56,10 +54,16 @@ export declare class CommissioningController extends MatterNode {
      */
     setMdnsScanner(mdnsScanner: MdnsScanner): void;
     /**
-     * Set the StorageManager instance. Should be only used internally
-     * @param storageManager
+     * Set the MDNS Broadcaster instance. Should be only used internally
+     *
+     * @param _mdnsBroadcaster MdnsBroadcaster instance
+     */
+    setMdnsBroadcaster(_mdnsBroadcaster: MdnsBroadcaster): void;
+    /**
+     * Set the Storage instance. Should be only used internally
+     * @param storage storage context to use
      */
-    setStorageManager(storageManager: StorageManager): void;
+    setStorage(storage: StorageContext): void;
     /**
      * Returns the paired Fabric object of the node
      */
@@ -67,18 +71,11 @@ export declare class CommissioningController extends MatterNode {
     /**
      * Return info if a device is successfully paired.
      */
-    isCommissioned(): false;
+    isCommissioned(): boolean;
     /**
-     * Creates and Return a new InteractionClient to communicate with the device. This is only needed if you want to
-     * separate requests on a separate client.
-     */
-    createInteractionClient(): Promise<InteractionClient>;
-    /**
-     * Returns a cluster client of a root endpoint cluster bound to a new InteractionClient.
-     *
-     * @param cluster The cluster to get the client for
+     * Creates and Return a new InteractionClient to communicate with the device.
      */
-    getRootClusterClientWithNewInteractionClient<F extends BitSchema, SF extends TypeFromBitSchema<F>, A extends Attributes, C extends Commands, E extends Events>(cluster: Cluster<F, SF, A, C, E>): Promise<ClusterClientObj<A, C> | undefined>;
+    private createInteractionClient;
     /**
      * Read all data from the device and create a device object structure out of it.
      *
@@ -97,7 +94,6 @@ export declare class CommissioningController extends MatterNode {
      *
      * @param endpointId Endpoint ID
      * @param data Data of all clusters read from the device
-     * @param interactionClient InteractionClient to communicate with the device
      * @private
      */
     private createDevice;
@@ -109,5 +105,9 @@ export declare class CommissioningController extends MatterNode {
      * close network connections of the device
      */
     close(): Promise<void>;
+    getPort(): undefined;
+    start(): Promise<void>;
+    getActiveSessionInformation(): any;
+    getInteractionClient(): InteractionClient;
 }
 //# sourceMappingURL=CommissioningController.d.ts.map

package/dist/cjs/CommissioningController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommissioningController.d.ts","sourceRoot":"","sources":["../../src/CommissioningController.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAiB,MAAM,6CAA6C,CAAC;AAG/F,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAahD,OAAO,EAAE,gBAAgB,EAAmB,MAAM,mCAAmC,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAS7E;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,qBAAa,uBAAwB,SAAQ,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAE/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IAEjC,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,kBAAkB,CAAC,CAAmB;IAE9C,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,SAAS,CAA+B;IAEhD;;;;OAIG;gBACS,OAAO,EAAE,8BAA8B;IAcnD;;;OAGG;IACG,OAAO;IAwBb;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW;IAIvC;;;OAGG;IACH,iBAAiB,CAAC,cAAc,EAAE,cAAc;IAIhD;;OAEG;IACH,SAAS;IAOT;;OAEG;IACH,cAAc;IAOd;;;OAGG;IACG,uBAAuB,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAO3D;;;;OAIG;IACG,4CAA4C,CAAC,CAAC,SAAS,SAAS,EAAE,EAAE,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,MAAM,EAC/J,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GACjC,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAI9C;;;;OAIG;YACW,2BAA2B;IAqBzC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IA+C1B;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IAkHpB;;OAEG;IACH,UAAU,IAAI,QAAQ,EAAE;IAIxB;;OAEG;IACG,KAAK;CAGd"}
+{"version":3,"file":"CommissioningController.d.ts","sourceRoot":"","sources":["../../src/CommissioningController.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAa5D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAK5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAW7D;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAEvC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAC1C,QAAQ,CAAC,gCAAgC,CAAC,EAAE,MAAM,CAAC;IACnD,QAAQ,CAAC,kCAAkC,CAAC,EAAE,MAAM,CAAC;IAErD,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC/C;AAED,qBAAa,uBAAwB,SAAQ,UAAU;IAmBvC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAlBpC,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAC/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAS;IAE/C,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,OAAO,CAAC,WAAW,CAAC,CAAc;IAElC,OAAO,CAAC,kBAAkB,CAAC,CAAmB;IAC9C,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAE9C,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,SAAS,CAAuC;IAExD;;;;OAIG;gBAC0B,OAAO,EAAE,8BAA8B;IAKpE;;;OAGG;IACG,OAAO;IA8EP,sBAAsB;IA4D5B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW;IAIvC;;;;OAIG;IACH,kBAAkB,CAAC,gBAAgB,EAAE,eAAe;IAIpD;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,cAAc;IAIlC;;OAEG;IACH,SAAS;IAOT;;OAEG;IACH,cAAc;IAId;;OAEG;YACW,uBAAuB;IAOrC;;;;OAIG;YACW,2BAA2B;IAmBzC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAqD1B;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAuGpB;;OAEG;IACH,UAAU,IAAI,QAAQ,EAAE;IAIxB;;OAEG;IACG,KAAK;IAMX,OAAO;IAID,KAAK;IAMX,2BAA2B;IAI3B,oBAAoB;CAMvB"}