@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/esm/clusters/account-login.d.ts

@@ -0,0 +1,359 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { Command, OptionalEvent } from "../cluster/Cluster.js";
+import { TypeFromSchema } from "../tlv/TlvSchema.js";
+import { Identity } from "#general";
+export declare namespace AccountLogin {
+    /**
+     * Input to the AccountLogin getSetupPin command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1
+     */
+    const TlvGetSetupPinRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall specify the client’s Temporary Account Identifier. The length of this field shall be at
+         * least 16 characters to protect the account holder against password guessing attacks.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1.1
+         */
+        tempAccountIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
+    }>;
+    /**
+     * Input to the AccountLogin getSetupPin command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1
+     */
+    interface GetSetupPinRequest extends TypeFromSchema<typeof TlvGetSetupPinRequest> {
+    }
+    /**
+     * This message is sent in response to the GetSetupPIN command, and contains the Setup PIN code, or null when the
+     * account identified in the request does not match the active account of the running Content App.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.2
+     */
+    const TlvGetSetupPinResponse: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall provide the setup PIN code as a text string at least 8 characters in length or empty string
+         * to indicate that the accounts do not match.
+         *
+         * NOTE
+         *
+         * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+         * length.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.2.1
+         */
+        setupPin: import("../tlv/TlvObject.js").FieldType<string>;
+    }>;
+    /**
+     * This message is sent in response to the GetSetupPIN command, and contains the Setup PIN code, or null when the
+     * account identified in the request does not match the active account of the running Content App.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.2
+     */
+    interface GetSetupPinResponse extends TypeFromSchema<typeof TlvGetSetupPinResponse> {
+    }
+    /**
+     * Input to the AccountLogin login command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3
+     */
+    const TlvLoginRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall specify the client’s temporary account identifier.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.1
+         */
+        tempAccountIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
+        /**
+         * This field shall provide the setup PIN code as a text string at least 8 characters in length.
+         *
+         * NOTE
+         *
+         * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+         * length.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.2
+         */
+        setupPin: import("../tlv/TlvObject.js").FieldType<string>;
+        /**
+         * This optional field shall provide the Node ID of the Client. This field can be used by the Content App to
+         * keep track of Nodes which currently have access to it.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.3
+         */
+        node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+    }>;
+    /**
+     * Input to the AccountLogin login command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3
+     */
+    interface LoginRequest extends TypeFromSchema<typeof TlvLoginRequest> {
+    }
+    /**
+     * Input to the AccountLogin logout command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4
+     */
+    const TlvLogoutRequest: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This optional field shall provide the Node ID of the Client. This field can be used by the Content
+         *
+         * App to keep track of Nodes which currently have access to it.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4.1
+         */
+        node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+    }>;
+    /**
+     * Input to the AccountLogin logout command
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4
+     */
+    interface LogoutRequest extends TypeFromSchema<typeof TlvLogoutRequest> {
+    }
+    /**
+     * Body of the AccountLogin loggedOut event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1
+     */
+    const TlvLoggedOutEvent: import("../tlv/TlvObject.js").ObjectSchema<{
+        /**
+         * This field shall provide the Node ID corresponding to the user account that has logged out, if that Node ID
+         * is available. If it is NOT available, this field shall NOT be present in the event.
+         *
+         * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1.1
+         */
+        node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+    }>;
+    /**
+     * Body of the AccountLogin loggedOut event
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1
+     */
+    interface LoggedOutEvent extends TypeFromSchema<typeof TlvLoggedOutEvent> {
+    }
+    /**
+     * @see {@link Cluster}
+     */
+    const ClusterInstance: MutableCluster<{
+        readonly id: 1294;
+        readonly name: "AccountLogin";
+        readonly revision: 2;
+        readonly commands: {
+            /**
+             * The purpose of this command is to determine if the active user account of the given Content App matches
+             * the active user account of a given Commissionee, and when it does, return a Setup PIN code which can be
+             * used for password-authenticated session establishment (PASE) with the Commissionee.
+             *
+             * For example, a Video Player with a Content App Platform may invoke this command on one of its Content
+             * App endpoints to facilitate commissioning of a Phone App made by the same vendor as the Content App. If
+             * the accounts match, then the Content App may return a setup code that can be used
+             *
+             * by the Video Player to commission the Phone App without requiring the user to physically input a setup
+             * code.
+             *
+             * The account match is determined by the Content App using a method which is outside the scope of this
+             * specification and will typically involve a central service which is in communication with both the
+             * Content App and the Commissionee. The GetSetupPIN command is needed in order to provide the
+             * Commissioner/Admin with a Setup PIN when this Commissioner/Admin is operated by a different vendor from
+             * the Content App.
+             *
+             * This method is used to facilitate Setup PIN exchange (for PASE) between Commissioner and Commissionee
+             * when the same user account is active on both nodes. With this method, the Content App satisfies proof of
+             * possession related to commissioning by requiring the same user account to be active on both Commissionee
+             * and Content App, while the Commissioner/Admin ensures user consent by prompting the user prior to
+             * invocation of the command.
+             *
+             * Upon receipt of this command, the Content App checks if the account associated with the Temporary
+             * Account Identifier sent by the client is the same account that is active on itself. If the accounts are
+             * the same, then the Content App returns the GetSetupPIN Response which includes a Setup PIN that may be
+             * used for PASE with the Commissionee.
+             *
+             * The Temporary Account Identifier for a Commissionee may be populated with the Rotating ID field of the
+             * client’s commissionable node advertisement (see Rotating Device Identifier section in [MatterCore])
+             * encoded as an octet string where the octets of the Rotating Device Identifier are encoded as 2-character
+             * sequences by representing each octet’s value as a 2-digit hexadecimal number, using uppercase letters.
+             *
+             * The Setup PIN is a character string so that it can accommodate different future formats, including
+             * alpha-numeric encodings. For a Commissionee it shall be populated with the Manual Pairing Code (see
+             * Manual Pairing Code section in [MatterCore]) encoded as a string (11 characters) or the Passcode portion
+             * of the Manual Pairing Code (when less than 11 characters) .
+             *
+             * The server shall implement rate limiting to prevent brute force attacks. No more than 10 unique requests
+             * in a 10 minute period shall be allowed; a command response status of FAILURE should sent for additional
+             * commands received within the 10 minute period. Because access to this command is limited to nodes with
+             * Admin-level access, and the user is prompted for consent prior to Commissioning, there are in place
+             * multiple obstacles to successfully mounting a brute force attack. A Content App that supports this
+             * command shall ensure that the Temporary Account Identifier used by its clients is not valid for more
+             * than 10 minutes.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1
+             */
+            readonly getSetupPin: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall specify the client’s Temporary Account Identifier. The length of this field shall be at
+                 * least 16 characters to protect the account holder against password guessing attacks.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1.1
+                 */
+                tempAccountIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
+            }>, import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall provide the setup PIN code as a text string at least 8 characters in length or empty string
+                 * to indicate that the accounts do not match.
+                 *
+                 * NOTE
+                 *
+                 * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+                 * length.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.2.1
+                 */
+                setupPin: import("../tlv/TlvObject.js").FieldType<string>;
+            }>, any>;
+            /**
+             * The purpose of this command is to allow the Content App to assume the user account of a given
+             * Commissionee by leveraging the Setup PIN code input by the user during the commissioning process.
+             *
+             * For example, a Video Player with a Content App Platform may invoke this command on one of its Content
+             * App endpoints after the commissioning has completed of a Phone App made by the same vendor as the
+             * Content App. The Content App may determine whether the Temporary Account Identifier maps to an account
+             * with a corresponding Setup PIN and, if so, it may automatically login to the account for the
+             * corresponding user. The end result is that a user performs commissioning of a Phone App to a Video
+             * Player by inputting the Setup PIN for the Phone App into the Video Player UX. Once commissioning has
+             * completed, the Video Player invokes this command to allow the corresponding Content App to assume the
+             * same user account as the Phone App.
+             *
+             * The verification of Setup PIN for the given Temporary Account Identifier is determined by the Content
+             * App using a method which is outside the scope of this specification and will typically involve a central
+             * service which is in communication with both the Content App and the Commissionee. Implementations of
+             * such a service should impose aggressive time outs for any mapping of Temporary Account Identifier to
+             * Setup PIN in order to prevent accidental login due to delayed invocation.
+             *
+             * Upon receipt, the Content App checks if the account associated with the client’s Temp Account Identifier
+             * has a current active Setup PIN with the given value. If the Setup PIN is valid for the user account
+             * associated with the Temp Account Identifier, then the Content App may make that user account active.
+             *
+             * The Temporary Account Identifier for a Commissionee may be populated with the Rotating ID field of the
+             * client’s commissionable node advertisement encoded as an octet string where the octets of the Rotating
+             * Device Identifier are encoded as 2-character sequences by representing each octet’s value as a 2-digit
+             * hexadecimal number, using uppercase letters.
+             *
+             * The Setup PIN for a Commissionee may be populated with the Manual Pairing Code encoded as a string of
+             * decimal numbers (11 characters) or the Passcode portion of the Manual Pairing Code encoded as a string
+             * of decimal numbers (8 characters) .
+             *
+             * The server shall implement rate limiting to prevent brute force attacks. No more than 10 unique requests
+             * in a 10 minute period shall be allowed; a command response status of FAILURE should sent for additional
+             * commands received within the 10 minute period. Because access to this command is limited to nodes with
+             * Admin-level access, and the user is involved when obtaining the SetupPIN, there are in place multiple
+             * obstacles to successfully mounting a brute force attack. A Content App that supports this command shall
+             * ensure that the Temporary Account Identifier used by its clients is not valid for more than 10 minutes.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3
+             */
+            readonly login: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall specify the client’s temporary account identifier.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.1
+                 */
+                tempAccountIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * This field shall provide the setup PIN code as a text string at least 8 characters in length.
+                 *
+                 * NOTE
+                 *
+                 * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+                 * length.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.2
+                 */
+                setupPin: import("../tlv/TlvObject.js").FieldType<string>;
+                /**
+                 * This optional field shall provide the Node ID of the Client. This field can be used by the Content App to
+                 * keep track of Nodes which currently have access to it.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.3
+                 */
+                node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+            }>, void, any>;
+            /**
+             * The purpose of this command is to instruct the Content App to clear the current user account. This
+             * command SHOULD be used by clients of a Content App to indicate the end of a user session.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4
+             */
+            readonly logout: Command<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This optional field shall provide the Node ID of the Client. This field can be used by the Content
+                 *
+                 * App to keep track of Nodes which currently have access to it.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4.1
+                 */
+                node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+            }>, void, any>;
+        };
+        readonly events: {
+            /**
+             * This event can be used by the Content App to indicate that the current user has logged out. In response
+             * to this event, the Fabric Admin shall remove access to this Content App by the specified Node. If no
+             * Node is provided, then the Fabric Admin shall remove access to all non-Admin Nodes.
+             *
+             * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1
+             */
+            readonly loggedOut: OptionalEvent<import("../tlv/TlvObject.js").TypeFromFields<{
+                /**
+                 * This field shall provide the Node ID corresponding to the user account that has logged out, if that Node ID
+                 * is available. If it is NOT available, this field shall NOT be present in the event.
+                 *
+                 * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1.1
+                 */
+                node: import("../tlv/TlvObject.js").OptionalFieldType<import("../datatype/NodeId.js").NodeId>;
+            }>, any>;
+        };
+    }, []>;
+    /**
+     * This cluster provides commands that facilitate user account login on a Content App or a node. For example, a
+     * Content App running on a Video Player device, which is represented as an endpoint (see Device Type Library
+     * document), can use this cluster to help make the user account on the Content App match the user account on the
+     * Client.
+     *
+     * Often a fabric administrator will facilitate commissioning of a Client (such as a Casting Video Client), and
+     * invoke commands on the AccountLogin cluster on the Content App associated with that client. Specifically:
+     *
+     *   1. GetSetupPIN in order to attempt to obtain the Passcode for commissioning.
+     *
+     *   2. Login in order to let the Content App know that commissioning has completed. The Content App can use
+     *      information provided in this command in order to determine the user account associated with the client, and
+     *      potentially assume that user account.
+     *
+     *   3. Logout in order to let the Content App know that client access has been removed, and potentially clear the
+     *      current user account.
+     *
+     * The cluster server for this cluster may be supported on each endpoint that represents a Content App on a Video
+     * Player device.
+     *
+     * See Device Type Library document for details of how a Content App, represented as an endpoint on
+     *
+     * the Video Player device, may implement the cluster server for this cluster to simplify account login for its
+     * users.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2
+     */
+    interface Cluster extends Identity<typeof ClusterInstance> {
+    }
+    const Cluster: Cluster;
+    const Complete: Cluster;
+}
+export type AccountLoginCluster = AccountLogin.Cluster;
+export declare const AccountLoginCluster: AccountLogin.Cluster;
+//# sourceMappingURL=account-login.d.ts.map

package/dist/esm/clusters/account-login.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-login.d.ts","sourceRoot":"","sources":["../../../src/clusters/account-login.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAiB,aAAa,EAAiB,MAAM,uBAAuB,CAAC;AAG7F,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,YAAY,CAAC;IAC1B;;;;OAIG;IACI,MAAM,qBAAqB;QAC9B;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;;OAKG;IACI,MAAM,sBAAsB;QAC/B;;;;;;;;;;WAUG;;MAEL,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;;;OAIG;IACI,MAAM,eAAe;QACxB;;;;WAIG;;QAGH;;;;;;;;;WASG;;QAGH;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,YAAa,SAAQ,cAAc,CAAC,OAAO,eAAe,CAAC;KAAG;IAE/E;;;;OAIG;IACI,MAAM,gBAAgB;QACzB;;;;;;WAMG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,aAAc,SAAQ,cAAc,CAAC,OAAO,gBAAgB,CAAC;KAAG;IAEjF;;;;OAIG;IACI,MAAM,iBAAiB;QAC1B;;;;;WAKG;;MAEL,CAAC;IAEH;;;;OAIG;IACH,UAAiB,cAAe,SAAQ,cAAc,CAAC,OAAO,iBAAiB,CAAC;KAAG;IAEnF;;OAEG;IACI,MAAM,eAAe;;;;;YAMpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAgDG;;gBA5LP;;;;;mBAKG;;;gBAkBH;;;;;;;;;;mBAUG;;;YAoKC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAwCG;;gBA1LP;;;;mBAIG;;gBAGH;;;;;;;;;mBASG;;gBAGH;;;;;mBAKG;;;YA2KC;;;;;eAKG;;gBA/JP;;;;;;mBAMG;;;;;YA8JC;;;;;;eAMG;;gBAnJP;;;;;mBAKG;;;;UAsJL,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,OAAO,CAAC;AACvD,eAAO,MAAM,mBAAmB,sBAAuB,CAAC"}

package/dist/esm/clusters/account-login.js

@@ -0,0 +1,225 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { Command, TlvNoResponse, OptionalEvent, EventPriority } from "../cluster/Cluster.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvString } from "../tlv/TlvString.js";
+import { AccessLevel } from "#model";
+import { TlvNodeId } from "../datatype/NodeId.js";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+var AccountLogin;
+((AccountLogin2) => {
+  AccountLogin2.TlvGetSetupPinRequest = TlvObject({
+    /**
+     * This field shall specify the client’s Temporary Account Identifier. The length of this field shall be at
+     * least 16 characters to protect the account holder against password guessing attacks.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1.1
+     */
+    tempAccountIdentifier: TlvField(0, TlvString.bound({ minLength: 16, maxLength: 100 }))
+  });
+  AccountLogin2.TlvGetSetupPinResponse = TlvObject({
+    /**
+     * This field shall provide the setup PIN code as a text string at least 8 characters in length or empty string
+     * to indicate that the accounts do not match.
+     *
+     * NOTE
+     *
+     * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+     * length.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.2.1
+     */
+    setupPin: TlvField(0, TlvString)
+  });
+  AccountLogin2.TlvLoginRequest = TlvObject({
+    /**
+     * This field shall specify the client’s temporary account identifier.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.1
+     */
+    tempAccountIdentifier: TlvField(0, TlvString.bound({ minLength: 16, maxLength: 100 })),
+    /**
+     * This field shall provide the setup PIN code as a text string at least 8 characters in length.
+     *
+     * NOTE
+     *
+     * Newer cluster clients should be aware that AccountLogin cluster version 1 specified an 11 digit minimum
+     * length.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.2
+     */
+    setupPin: TlvField(1, TlvString.bound({ minLength: 8 })),
+    /**
+     * This optional field shall provide the Node ID of the Client. This field can be used by the Content App to
+     * keep track of Nodes which currently have access to it.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3.3
+     */
+    node: TlvOptionalField(2, TlvNodeId)
+  });
+  AccountLogin2.TlvLogoutRequest = TlvObject({
+    /**
+     * This optional field shall provide the Node ID of the Client. This field can be used by the Content
+     *
+     * App to keep track of Nodes which currently have access to it.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4.1
+     */
+    node: TlvOptionalField(0, TlvNodeId)
+  });
+  AccountLogin2.TlvLoggedOutEvent = TlvObject({
+    /**
+     * This field shall provide the Node ID corresponding to the user account that has logged out, if that Node ID
+     * is available. If it is NOT available, this field shall NOT be present in the event.
+     *
+     * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1.1
+     */
+    node: TlvOptionalField(0, TlvNodeId)
+  });
+  AccountLogin2.ClusterInstance = MutableCluster({
+    id: 1294,
+    name: "AccountLogin",
+    revision: 2,
+    commands: {
+      /**
+       * The purpose of this command is to determine if the active user account of the given Content App matches
+       * the active user account of a given Commissionee, and when it does, return a Setup PIN code which can be
+       * used for password-authenticated session establishment (PASE) with the Commissionee.
+       *
+       * For example, a Video Player with a Content App Platform may invoke this command on one of its Content
+       * App endpoints to facilitate commissioning of a Phone App made by the same vendor as the Content App. If
+       * the accounts match, then the Content App may return a setup code that can be used
+       *
+       * by the Video Player to commission the Phone App without requiring the user to physically input a setup
+       * code.
+       *
+       * The account match is determined by the Content App using a method which is outside the scope of this
+       * specification and will typically involve a central service which is in communication with both the
+       * Content App and the Commissionee. The GetSetupPIN command is needed in order to provide the
+       * Commissioner/Admin with a Setup PIN when this Commissioner/Admin is operated by a different vendor from
+       * the Content App.
+       *
+       * This method is used to facilitate Setup PIN exchange (for PASE) between Commissioner and Commissionee
+       * when the same user account is active on both nodes. With this method, the Content App satisfies proof of
+       * possession related to commissioning by requiring the same user account to be active on both Commissionee
+       * and Content App, while the Commissioner/Admin ensures user consent by prompting the user prior to
+       * invocation of the command.
+       *
+       * Upon receipt of this command, the Content App checks if the account associated with the Temporary
+       * Account Identifier sent by the client is the same account that is active on itself. If the accounts are
+       * the same, then the Content App returns the GetSetupPIN Response which includes a Setup PIN that may be
+       * used for PASE with the Commissionee.
+       *
+       * The Temporary Account Identifier for a Commissionee may be populated with the Rotating ID field of the
+       * client’s commissionable node advertisement (see Rotating Device Identifier section in [MatterCore])
+       * encoded as an octet string where the octets of the Rotating Device Identifier are encoded as 2-character
+       * sequences by representing each octet’s value as a 2-digit hexadecimal number, using uppercase letters.
+       *
+       * The Setup PIN is a character string so that it can accommodate different future formats, including
+       * alpha-numeric encodings. For a Commissionee it shall be populated with the Manual Pairing Code (see
+       * Manual Pairing Code section in [MatterCore]) encoded as a string (11 characters) or the Passcode portion
+       * of the Manual Pairing Code (when less than 11 characters) .
+       *
+       * The server shall implement rate limiting to prevent brute force attacks. No more than 10 unique requests
+       * in a 10 minute period shall be allowed; a command response status of FAILURE should sent for additional
+       * commands received within the 10 minute period. Because access to this command is limited to nodes with
+       * Admin-level access, and the user is prompted for consent prior to Commissioning, there are in place
+       * multiple obstacles to successfully mounting a brute force attack. A Content App that supports this
+       * command shall ensure that the Temporary Account Identifier used by its clients is not valid for more
+       * than 10 minutes.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.1
+       */
+      getSetupPin: Command(
+        0,
+        AccountLogin2.TlvGetSetupPinRequest,
+        1,
+        AccountLogin2.TlvGetSetupPinResponse,
+        { invokeAcl: AccessLevel.Administer, timed: true }
+      ),
+      /**
+       * The purpose of this command is to allow the Content App to assume the user account of a given
+       * Commissionee by leveraging the Setup PIN code input by the user during the commissioning process.
+       *
+       * For example, a Video Player with a Content App Platform may invoke this command on one of its Content
+       * App endpoints after the commissioning has completed of a Phone App made by the same vendor as the
+       * Content App. The Content App may determine whether the Temporary Account Identifier maps to an account
+       * with a corresponding Setup PIN and, if so, it may automatically login to the account for the
+       * corresponding user. The end result is that a user performs commissioning of a Phone App to a Video
+       * Player by inputting the Setup PIN for the Phone App into the Video Player UX. Once commissioning has
+       * completed, the Video Player invokes this command to allow the corresponding Content App to assume the
+       * same user account as the Phone App.
+       *
+       * The verification of Setup PIN for the given Temporary Account Identifier is determined by the Content
+       * App using a method which is outside the scope of this specification and will typically involve a central
+       * service which is in communication with both the Content App and the Commissionee. Implementations of
+       * such a service should impose aggressive time outs for any mapping of Temporary Account Identifier to
+       * Setup PIN in order to prevent accidental login due to delayed invocation.
+       *
+       * Upon receipt, the Content App checks if the account associated with the client’s Temp Account Identifier
+       * has a current active Setup PIN with the given value. If the Setup PIN is valid for the user account
+       * associated with the Temp Account Identifier, then the Content App may make that user account active.
+       *
+       * The Temporary Account Identifier for a Commissionee may be populated with the Rotating ID field of the
+       * client’s commissionable node advertisement encoded as an octet string where the octets of the Rotating
+       * Device Identifier are encoded as 2-character sequences by representing each octet’s value as a 2-digit
+       * hexadecimal number, using uppercase letters.
+       *
+       * The Setup PIN for a Commissionee may be populated with the Manual Pairing Code encoded as a string of
+       * decimal numbers (11 characters) or the Passcode portion of the Manual Pairing Code encoded as a string
+       * of decimal numbers (8 characters) .
+       *
+       * The server shall implement rate limiting to prevent brute force attacks. No more than 10 unique requests
+       * in a 10 minute period shall be allowed; a command response status of FAILURE should sent for additional
+       * commands received within the 10 minute period. Because access to this command is limited to nodes with
+       * Admin-level access, and the user is involved when obtaining the SetupPIN, there are in place multiple
+       * obstacles to successfully mounting a brute force attack. A Content App that supports this command shall
+       * ensure that the Temporary Account Identifier used by its clients is not valid for more than 10 minutes.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.3
+       */
+      login: Command(
+        2,
+        AccountLogin2.TlvLoginRequest,
+        2,
+        TlvNoResponse,
+        { invokeAcl: AccessLevel.Administer, timed: true }
+      ),
+      /**
+       * The purpose of this command is to instruct the Content App to clear the current user account. This
+       * command SHOULD be used by clients of a Content App to indicate the end of a user session.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 6.2.4.4
+       */
+      logout: Command(3, AccountLogin2.TlvLogoutRequest, 3, TlvNoResponse, { timed: true })
+    },
+    events: {
+      /**
+       * This event can be used by the Content App to indicate that the current user has logged out. In response
+       * to this event, the Fabric Admin shall remove access to this Content App by the specified Node. If no
+       * Node is provided, then the Fabric Admin shall remove access to all non-Admin Nodes.
+       *
+       * @see {@link MatterSpecification.v13.Cluster} § 6.2.5.1
+       */
+      loggedOut: OptionalEvent(
+        0,
+        EventPriority.Critical,
+        AccountLogin2.TlvLoggedOutEvent,
+        { readAcl: AccessLevel.Administer }
+      )
+    }
+  });
+  AccountLogin2.Cluster = AccountLogin2.ClusterInstance;
+  AccountLogin2.Complete = AccountLogin2.Cluster;
+})(AccountLogin || (AccountLogin = {}));
+const AccountLoginCluster = AccountLogin.Cluster;
+ClusterRegistry.register(AccountLogin.Complete);
+export {
+  AccountLogin,
+  AccountLoginCluster
+};
+//# sourceMappingURL=account-login.js.map

package/dist/esm/clusters/account-login.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/account-login.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,SAAS,eAAe,eAAe,qBAAqB;AACrE,SAAS,UAAU,WAAW,wBAAwB;AACtD,SAAS,iBAAiB;AAE1B,SAAS,mBAAmB;AAC5B,SAAS,iBAAiB;AAE1B,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,kBAAV;AAMI,EAAMA,cAAA,wBAAwB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO3C,uBAAuB,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,IAAI,WAAW,IAAI,CAAC,CAAC;AAAA,EACzF,CAAC;AAeM,EAAMA,cAAA,yBAAyB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAY5C,UAAU,SAAS,GAAG,SAAS;AAAA,EACnC,CAAC;AAeM,EAAMA,cAAA,kBAAkB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMrC,uBAAuB,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,IAAI,WAAW,IAAI,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAYrF,UAAU,SAAS,GAAG,UAAU,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvD,MAAM,iBAAiB,GAAG,SAAS;AAAA,EACvC,CAAC;AAcM,EAAMA,cAAA,mBAAmB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQtC,MAAM,iBAAiB,GAAG,SAAS;AAAA,EACvC,CAAC;AAcM,EAAMA,cAAA,oBAAoB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOvC,MAAM,iBAAiB,GAAG,SAAS;AAAA,EACvC,CAAC;AAYM,EAAMA,cAAA,kBAAkB,eAAe;AAAA,IAC1C,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAkDN,aAAa;AAAA,QACT;AAAA,QACAA,cAAA;AAAA,QACA;AAAA,QACAA,cAAA;AAAA,QACA,EAAE,WAAW,YAAY,YAAY,OAAO,KAAK;AAAA,MACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MA2CA,OAAO;AAAA,QACH;AAAA,QACAA,cAAA;AAAA,QACA;AAAA,QACA;AAAA,QACA,EAAE,WAAW,YAAY,YAAY,OAAO,KAAK;AAAA,MACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQA,QAAQ,QAAQ,GAAKA,cAAA,kBAAkB,GAAK,eAAe,EAAE,OAAO,KAAK,CAAC;AAAA,IAC9E;AAAA,IAEA,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAQJ,WAAW;AAAA,QACP;AAAA,QACA,cAAc;AAAA,QACdA,cAAA;AAAA,QACA,EAAE,SAAS,YAAY,WAAW;AAAA,MACtC;AAAA,IACJ;AAAA,EACJ,CAAC;AAgCM,EAAMA,cAAA,UAAmBA,cAAA;AACzB,EAAMA,cAAA,WAAWA,cAAA;AAAA,GAtTX;AA0TV,MAAM,sBAAsB,aAAa;AAChD,gBAAgB,SAAS,aAAa,QAAQ;",
+  "names": ["AccountLogin"]
+}