@ledgerhq/device-management-kit 0.0.0-develop-20240925001059

package/lib/esm/src/api/apdu/utils/ApduBuilder.js

@@ -0,0 +1,142 @@
+import { Apdu } from "../../apdu/model/Apdu";
+import { ByteArrayBuilder } from "./ByteArrayBuilder";
+export const HEADER_LENGTH = 5;
+export const APDU_MAX_PAYLOAD = 255;
+export const APDU_MAX_SIZE = APDU_MAX_PAYLOAD + 5;
+/**
+ * ApduBuilder is a utility class to help build APDU commands.
+ * It allows to easily add data to the data field of the APDU command
+ * and to encode this data in different formats.
+ *
+ * @example
+ * ```
+ * const apduBuilder = new ApduBuilder({ ins: 0x01, cla: 0x02, p1: 0x03, p2: 0x04 })
+ *  .add8BitUIntToData(0x05)
+ *  .add16BitUIntToData(0x0607)
+ *  .addHexaStringToData("0x0809")
+ *  .addAsciiStringToData("hello")
+ *
+ * const apdu = apduBuilder.build();
+ * const builderErrors = apduBuilder.getErrors();
+ * ```
+ */
+export class ApduBuilder {
+    _ins;
+    _cla;
+    _p1;
+    p2;
+    data = new ByteArrayBuilder(APDU_MAX_PAYLOAD);
+    constructor({ ins, cla, p1, p2 }) {
+        this._cla = cla & 0xff;
+        this._ins = ins & 0xff;
+        this._p1 = p1 & 0xff;
+        this.p2 = p2 & 0xff;
+    }
+    // ==========
+    // Public API
+    // ==========
+    /**
+     * Build a new Apdu instance with the current state of the builder
+     * @returns {Apdu} - Returns a new Apdu instance
+     */
+    build = () => new Apdu(this._cla, this._ins, this._p1, this.p2, this.data.build());
+    /**
+     * Add a 8-bit unsigned integer to the data field (max value 0xff = 255)
+     * @param value?: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add8BitUIntToData = (value) => {
+        this.data.add8BitUIntToData(value);
+        return this;
+    };
+    /**
+     * Add a 16-bit unsigned integer to the data field (max value 0xffff = 65535)
+     * @param value: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add16BitUIntToData = (value) => {
+        this.data.add16BitUIntToData(value);
+        return this;
+    };
+    /**
+     * Add a 32-bit unsigned integer to the data field (max value 0xffffffff = 4294967295)
+     * @param value: number - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    add32BitUIntToData = (value) => {
+        this.data.add32BitUIntToData(value);
+        return this;
+    };
+    /**
+     * Add a Uint8Array to the data field if it has enough remaining space
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addBufferToData = (value) => {
+        this.data.addBufferToData(value);
+        return this;
+    };
+    /**
+     * Add a string to the data field if it has enough remaining space
+     * and it can be formatted as a hexadecimal string
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addHexaStringToData = (value) => {
+        this.data.addHexaStringToData(value);
+        return this;
+    };
+    /**
+     * Add an ascii string to the data field if it has enough remaining space
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    addAsciiStringToData = (value) => {
+        this.data.addAsciiStringToData(value);
+        return this;
+    };
+    /**
+     * Add a Length-Value encoded hexadecimal string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromHexa = (value) => {
+        this.data.encodeInLVFromHexa(value);
+        return this;
+    };
+    /**
+     * Add a Length-Value encoded buffer to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromBuffer = (value) => {
+        this.data.encodeInLVFromBuffer(value);
+        return this;
+    };
+    /**
+     * Add a Length-Value encoded ascii string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ApduBuilder} - Returns the current instance of ApduBuilder
+     */
+    encodeInLVFromAscii = (value) => {
+        this.data.encodeInLVFromAscii(value);
+        return this;
+    };
+    /**
+     * Returns the remaining payload length
+     * @returns {number}
+     */
+    getAvailablePayloadLength = () => this.data.getAvailablePayloadLength();
+    /**
+     * Returns the current errors
+     * @returns {AppBuilderError[]} - Returns an array of errors
+     */
+    getErrors = () => this.data.getErrors();
+}
+//# sourceMappingURL=ApduBuilder.js.map

package/lib/esm/src/api/apdu/utils/ApduBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduBuilder.js","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAG5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAC/B,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,aAAa,GAAG,gBAAgB,GAAG,CAAC,CAAC;AASlD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,WAAW;IACL,IAAI,CAAS;IACb,IAAI,CAAS;IACb,GAAG,CAAS;IACZ,EAAE,CAAS;IACpB,IAAI,GAAqB,IAAI,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAExE,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,EAAmB;QAC/C,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,aAAa;IACb,aAAa;IACb,aAAa;IAEb;;;OAGG;IACH,KAAK,GAAG,GAAS,EAAE,CACjB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAEvE;;;;OAIG;IACH,iBAAiB,GAAG,CAAC,KAAa,EAAe,EAAE;QACjD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;OAIG;IACH,kBAAkB,GAAG,CAAC,KAAa,EAAe,EAAE;QAClD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;OAIG;IACH,kBAAkB,GAAG,CAAC,KAAa,EAAe,EAAE;QAClD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;OAIG;IACH,eAAe,GAAG,CAAC,KAAiB,EAAe,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;OAKG;IACH,mBAAmB,GAAG,CAAC,KAAa,EAAe,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;OAIG;IACH,oBAAoB,GAAG,CAAC,KAAa,EAAe,EAAE;QACpD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,kBAAkB,GAAG,CAAC,KAAa,EAAe,EAAE;QAClD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,oBAAoB,GAAG,CAAC,KAAiB,EAAe,EAAE;QACxD,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,mBAAmB,GAAG,CAAC,KAAa,EAAe,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IAEF;;;OAGG;IACH,yBAAyB,GAAG,GAAW,EAAE,CACvC,IAAI,CAAC,IAAI,CAAC,yBAAyB,EAAE,CAAC;IAExC;;;OAGG;IACH,SAAS,GAAG,GAAsB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;CAC5D"}

package/lib/esm/src/api/apdu/utils/ApduParser.d.ts

@@ -0,0 +1,79 @@
+import { ApduResponse } from "../../device-session/ApduResponse";
+import { HexaString } from "../../utils/HexaString";
+export type TaggedField = {
+    readonly tag: number;
+    readonly value: Uint8Array;
+};
+/**
+ * ApduParser is a utility class to help parse APDU responses.
+ *
+ * It provides methods to extract fields of different types from the response.
+ *
+ * @example
+ * ```
+ * const parser = new ApduParser(apduResponse);
+ * const targetId = parser.encodeToHexaString(parser.extractFieldByLength(4));
+ * const seVersion = parser.encodeToString(parser.extractFieldLVEncoded());
+ * ```
+ */
+export declare class ApduParser {
+    private parser;
+    constructor(response: ApduResponse);
+    /**
+     * Test if the length is greater than the response length
+     * @param length: number
+     * @returns {boolean} - Returns false if the length is greater than the response length
+     */
+    testMinimalLength: (length: number) => boolean;
+    /**
+     * Extract a single byte from the response
+     * @returns {number | undefined} - Returns the byte extracted from the response
+     */
+    extract8BitUInt: () => number | undefined;
+    /**
+     * Extract a 16-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 16-bit unsigned integer extracted from the response
+     */
+    extract16BitUInt: () => number | undefined;
+    /**
+     * Extract a 32-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 32-bit unsigned integer extracted from the response
+     */
+    extract32BitUInt: () => number | undefined;
+    /**
+     * Extract a field of a specified length from the response
+     * @param length: number - The length of the field to extract
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldByLength: (length: number) => Uint8Array | undefined;
+    /**
+     * Extract a field from the response that is length-value encoded
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldLVEncoded: () => Uint8Array | undefined;
+    /**
+     * Extract a field from the response that is tag-length-value encoded
+     * @returns {TaggedField | undefined} - Returns the field extracted from the response
+     */
+    extractFieldTLVEncoded: () => TaggedField | undefined;
+    /**
+     * Encode a value to a hexadecimal string
+     * @param value {Uint8Array} - The value to encode
+     * @param prefix {boolean} - Whether to add a prefix to the encoded value
+     * @returns {string} - The encoded value as a hexadecimal string
+     */
+    encodeToHexaString(value?: Uint8Array, prefix?: false): string;
+    encodeToHexaString(value?: Uint8Array, prefix?: true): HexaString;
+    /**
+     * Encode a value to an ASCII string
+     * @param value {Uint8Array} - The value to encode
+     * @returns {string} - The encoded value as an ASCII string
+     */
+    encodeToString: (value?: Uint8Array) => string;
+    /**
+     * Get the remaining length of the response
+     * @returns {number} - The remaining length of the response
+     */
+    getUnparsedRemainingLength: () => number;
+}
+//# sourceMappingURL=ApduParser.d.ts.map

package/lib/esm/src/api/apdu/utils/ApduParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduParser.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAInD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAkB;gBAEpB,QAAQ,EAAE,YAAY;IAIlC;;;;OAIG;IACH,iBAAiB,WAAY,MAAM,KAAG,OAAO,CACL;IAExC;;;OAGG;IACH,eAAe,QAAO,MAAM,GAAG,SAAS,CAAkC;IAE1E;;;OAGG;IACH,gBAAgB,QAAO,MAAM,GAAG,SAAS,CAAmC;IAE5E;;;OAGG;IACH,gBAAgB,QAAO,MAAM,GAAG,SAAS,CAAmC;IAE5E;;;;OAIG;IACH,oBAAoB,WAAY,MAAM,KAAG,UAAU,GAAG,SAAS,CACpB;IAE3C;;;OAGG;IACH,qBAAqB,QAAO,UAAU,GAAG,SAAS,CACZ;IAEtC;;;OAGG;IACH,sBAAsB,QAAO,WAAW,GAAG,SAAS,CACb;IAEvC;;;;;OAKG;IACH,kBAAkB,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM;IAC9D,kBAAkB,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,IAAI,GAAG,UAAU;IAUjE;;;;OAIG;IACH,cAAc,WAAY,UAAU,KAAG,MAAM,CACT;IAEpC;;;OAGG;IACH,0BAA0B,QAAO,MAAM,CACI;CAC5C"}

package/lib/esm/src/api/apdu/utils/ApduParser.js

@@ -0,0 +1,73 @@
+import { ByteArrayParser } from "./ByteArrayParser";
+/**
+ * ApduParser is a utility class to help parse APDU responses.
+ *
+ * It provides methods to extract fields of different types from the response.
+ *
+ * @example
+ * ```
+ * const parser = new ApduParser(apduResponse);
+ * const targetId = parser.encodeToHexaString(parser.extractFieldByLength(4));
+ * const seVersion = parser.encodeToString(parser.extractFieldLVEncoded());
+ * ```
+ */
+export class ApduParser {
+    parser;
+    constructor(response) {
+        this.parser = new ByteArrayParser(response.data);
+    }
+    /**
+     * Test if the length is greater than the response length
+     * @param length: number
+     * @returns {boolean} - Returns false if the length is greater than the response length
+     */
+    testMinimalLength = (length) => this.parser.testMinimalLength(length);
+    /**
+     * Extract a single byte from the response
+     * @returns {number | undefined} - Returns the byte extracted from the response
+     */
+    extract8BitUInt = () => this.parser.extract8BitUInt();
+    /**
+     * Extract a 16-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 16-bit unsigned integer extracted from the response
+     */
+    extract16BitUInt = () => this.parser.extract16BitUInt();
+    /**
+     * Extract a 32-bit unsigned integer (Big Endian coding) from the response
+     * @returns {number | undefined} - Returns the 32-bit unsigned integer extracted from the response
+     */
+    extract32BitUInt = () => this.parser.extract32BitUInt();
+    /**
+     * Extract a field of a specified length from the response
+     * @param length: number - The length of the field to extract
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldByLength = (length) => this.parser.extractFieldByLength(length);
+    /**
+     * Extract a field from the response that is length-value encoded
+     * @returns {Uint8Array | undefined} - Returns the field extracted from the response
+     */
+    extractFieldLVEncoded = () => this.parser.extractFieldLVEncoded();
+    /**
+     * Extract a field from the response that is tag-length-value encoded
+     * @returns {TaggedField | undefined} - Returns the field extracted from the response
+     */
+    extractFieldTLVEncoded = () => this.parser.extractFieldTLVEncoded();
+    encodeToHexaString(value, prefix = false) {
+        return prefix
+            ? this.parser.encodeToHexaString(value, true)
+            : this.parser.encodeToHexaString(value, false);
+    }
+    /**
+     * Encode a value to an ASCII string
+     * @param value {Uint8Array} - The value to encode
+     * @returns {string} - The encoded value as an ASCII string
+     */
+    encodeToString = (value) => this.parser.encodeToString(value);
+    /**
+     * Get the remaining length of the response
+     * @returns {number} - The remaining length of the response
+     */
+    getUnparsedRemainingLength = () => this.parser.getUnparsedRemainingLength();
+}
+//# sourceMappingURL=ApduParser.js.map

package/lib/esm/src/api/apdu/utils/ApduParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApduParser.js","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ApduParser.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAOpD;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,UAAU;IACb,MAAM,CAAkB;IAEhC,YAAY,QAAsB;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,iBAAiB,GAAG,CAAC,MAAc,EAAW,EAAE,CAC9C,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,eAAe,GAAG,GAAuB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IAE1E;;;OAGG;IACH,gBAAgB,GAAG,GAAuB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAE5E;;;OAGG;IACH,gBAAgB,GAAG,GAAuB,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAE5E;;;;OAIG;IACH,oBAAoB,GAAG,CAAC,MAAc,EAA0B,EAAE,CAChE,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,qBAAqB,GAAG,GAA2B,EAAE,CACnD,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,CAAC;IAEtC;;;OAGG;IACH,sBAAsB,GAAG,GAA4B,EAAE,CACrD,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,CAAC;IAUvC,kBAAkB,CAChB,KAAkB,EAClB,SAAkB,KAAK;QAEvB,OAAO,MAAM;YACX,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC;YAC7C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,cAAc,GAAG,CAAC,KAAkB,EAAU,EAAE,CAC9C,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAEpC;;;OAGG;IACH,0BAA0B,GAAG,GAAW,EAAE,CACxC,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;CAC5C"}

package/lib/esm/src/api/apdu/utils/AppBuilderError.d.ts

@@ -0,0 +1,28 @@
+import { SdkError } from "../../Error";
+interface SdkAppBuilderError extends SdkError {
+    readonly message: string;
+}
+export declare class ValueOverflowError implements SdkAppBuilderError {
+    readonly _tag = "ValueOverflow";
+    readonly originalError?: Error;
+    readonly message: string;
+    constructor(value: string, max?: number | bigint);
+}
+export declare class DataOverflowError implements SdkAppBuilderError {
+    readonly _tag = "DataOverflow";
+    readonly message: string;
+    readonly originalError?: Error;
+    constructor(value: string, remaining?: number);
+}
+export declare class HexaStringEncodeError implements SdkAppBuilderError {
+    readonly _tag = "HexaString";
+    readonly message: string;
+    readonly originalError?: Error;
+    constructor(value: string);
+}
+/**
+ * Type for all possible errors that can be thrown by the AppBuilder.
+ */
+export type AppBuilderError = ValueOverflowError | DataOverflowError | HexaStringEncodeError;
+export {};
+//# sourceMappingURL=AppBuilderError.d.ts.map

package/lib/esm/src/api/apdu/utils/AppBuilderError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppBuilderError.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/AppBuilderError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,UAAU,kBAAmB,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,kBAAmB,YAAW,kBAAkB;IAC3D,QAAQ,CAAC,IAAI,mBAAmB;IAChC,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBACb,KAAK,EAAE,MAAM,EAAE,GAAG,GAAE,MAAM,GAAG,MAAyB;CAGnE;AAED,qBAAa,iBAAkB,YAAW,kBAAkB;IAC1D,QAAQ,CAAC,IAAI,kBAAkB;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;gBACnB,KAAK,EAAE,MAAM,EAAE,SAAS,SAAI;CAMzC;AAED,qBAAa,qBAAsB,YAAW,kBAAkB;IAC9D,QAAQ,CAAC,IAAI,gBAAgB;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC;gBACnB,KAAK,EAAE,MAAM;CAG1B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,CAAC"}

package/lib/esm/src/api/apdu/utils/AppBuilderError.js

@@ -0,0 +1,29 @@
+import { APDU_MAX_PAYLOAD } from "./ApduBuilder";
+export class ValueOverflowError {
+    _tag = "ValueOverflow";
+    originalError;
+    message;
+    constructor(value, max = APDU_MAX_PAYLOAD) {
+        this.message = `Value overflow for ${value}, max is ${max}`;
+    }
+}
+export class DataOverflowError {
+    _tag = "DataOverflow";
+    message;
+    originalError;
+    constructor(value, remaining = 0) {
+        this.message =
+            remaining === 0
+                ? `this.data is already full (value: ${value})`
+                : `this.data will overflow with "${value}", remaining bytes: ${remaining}`;
+    }
+}
+export class HexaStringEncodeError {
+    _tag = "HexaString";
+    message;
+    originalError;
+    constructor(value) {
+        this.message = `Invalid encoded hexa string or length is null: ${value}`;
+    }
+}
+//# sourceMappingURL=AppBuilderError.js.map

package/lib/esm/src/api/apdu/utils/AppBuilderError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppBuilderError.js","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/AppBuilderError.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAMjD,MAAM,OAAO,kBAAkB;IACpB,IAAI,GAAG,eAAe,CAAC;IACvB,aAAa,CAAS;IACtB,OAAO,CAAS;IACzB,YAAY,KAAa,EAAE,MAAuB,gBAAgB;QAChE,IAAI,CAAC,OAAO,GAAG,sBAAsB,KAAK,YAAY,GAAG,EAAE,CAAC;IAC9D,CAAC;CACF;AAED,MAAM,OAAO,iBAAiB;IACnB,IAAI,GAAG,cAAc,CAAC;IACtB,OAAO,CAAS;IAChB,aAAa,CAAS;IAC/B,YAAY,KAAa,EAAE,SAAS,GAAG,CAAC;QACtC,IAAI,CAAC,OAAO;YACV,SAAS,KAAK,CAAC;gBACb,CAAC,CAAC,qCAAqC,KAAK,GAAG;gBAC/C,CAAC,CAAC,iCAAiC,KAAK,uBAAuB,SAAS,EAAE,CAAC;IACjF,CAAC;CACF;AAED,MAAM,OAAO,qBAAqB;IACvB,IAAI,GAAG,YAAY,CAAC;IACpB,OAAO,CAAS;IAChB,aAAa,CAAS;IAC/B,YAAY,KAAa;QACvB,IAAI,CAAC,OAAO,GAAG,kDAAkD,KAAK,EAAE,CAAC;IAC3E,CAAC;CACF"}

package/lib/esm/src/api/apdu/utils/ByteArrayBuilder.d.ts

@@ -0,0 +1,166 @@
+import { AppBuilderError } from "./AppBuilderError";
+/**
+ * ByteArrayBuilder is a utility class to help build APDU payloads.
+ * It allows to easily add data to the payload of an APDU command
+ * and to encode this data in different formats.
+ *
+ * @example
+ * ```
+ * const builder = new ByteArrayBuilder(255)
+ *  .add8BitUIntToData(0x05)
+ *  .add16BitUIntToData(0x0607)
+ *  .addHexaStringToData("0x0809")
+ *  .addAsciiStringToData("hello")
+ *
+ * const payload = builder.build();
+ * const builderErrors = builder.getErrors();
+ * ```
+ */
+export declare class ByteArrayBuilder {
+    private maxPayloadSize;
+    private data;
+    private readonly errors;
+    constructor(maxPayloadSize?: number);
+    /**
+     * Build a new payload instance with the current state of the builder
+     * @returns {payload} - Returns a new payload instance
+     */
+    build: () => Uint8Array;
+    /**
+     * Try to build a new payload instance with the current state of the builder
+     * if the builder don't contain any error.
+     * @returns {payload | undefined} - Returns a new payload instance or undefined
+     */
+    tryBuild: () => Uint8Array | undefined;
+    /**
+     * Add a 8-bit unsigned integer to the payload (max value 0xff = 255)
+     * @param value: number | bigint - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add8BitUIntToData: (value: number | bigint) => ByteArrayBuilder;
+    /**
+     * Add a 16-bit unsigned integer to the payload (max value 0xffff = 65535)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add16BitUIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a 32-bit unsigned integer to the payload (max value 0xffffffff = 4294967295)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add32BitUIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a 64-bit unsigned integer to the payload (max value 0xffffffffffffffff = 18446744073709551615)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add64BitUIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a 16-bit signed integer to the payload (value between -0x8000 to 0x7fff)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add16BitIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a 32-bit signed integer to the payload (value between -0x80000000 to 0x7fffffff)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add32BitIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a 64-bit signed integer to the payload (value between -0x8000000000000000 to 0x7fffffffffffffff)
+     * @param value: number | bigint - The value to add to the data
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    add64BitIntToData: (value: number | bigint, bigEndian?: boolean) => ByteArrayBuilder;
+    /**
+     * Add a Uint8Array to the payload if it has enough remaining space
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    addBufferToData: (value: Uint8Array) => ByteArrayBuilder;
+    /**
+     * Add a string to the payload if it has enough remaining space
+     * and it can be formatted as a hexadecimal string
+     * @param value: string - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    addHexaStringToData: (value: string) => ByteArrayBuilder;
+    /**
+     * Add an ascii string to the data field if it has enough remaining space
+     * @param value: string - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    addAsciiStringToData: (value: string) => ByteArrayBuilder;
+    /**
+     * Add a Length-Value encoded hexadecimal string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    encodeInLVFromHexa: (value: string) => ByteArrayBuilder;
+    /**
+     * Add a Length-Value encoded buffer to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: Uint8Array - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    encodeInLVFromBuffer: (value: Uint8Array) => ByteArrayBuilder;
+    /**
+     * Add a Length-Value encoded ascii string to the data field if it has enough remaining space
+     * Length-Value encoding is a way to encode data in a binary format with the first byte
+     * being the length of the data and the following bytes being the data itself
+     * @param value: string - The value to add to the data
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    encodeInLVFromAscii: (value: string) => ByteArrayBuilder;
+    /**
+     * Returns the remaining payload length
+     * @returns {number}
+     */
+    getAvailablePayloadLength: () => number;
+    /**
+     * Returns the current errors
+     * @returns {AppBuilderError[]} - Returns an array of errors
+     */
+    getErrors: () => AppBuilderError[];
+    /**
+     * Verifies if the builder contains errors
+     * @returns {boolean} - Returns wether the builder contains errors or not
+     */
+    hasErrors: () => boolean;
+    /**
+     * Check if there is enough space to add a value to the data field
+     * @param value {string | Uint8Array | number[]} - Value to add to the data
+     * @param hasLv {boolean} - Length-Value encoding flag
+     * @returns {boolean} - Returns true if there is enough space to add the value
+     */
+    private hasEnoughLengthRemaining;
+    /**
+     * Add a number to the payload
+     * @param value: number | bigint - The value to add to the data
+     * @param sizeInBits: bigint - The number size in bits, for example 16 for a uint16
+     * @param signed: boolean - Whether the value is signed or unsigned.
+     * @param bigEndian: boolean - True to encode in big endian, false for little endian
+     * @returns {ByteArrayBuilder} - Returns the current instance of ByteArrayBuilder
+     */
+    private addNumberToData;
+    /**
+     * Checks the bounds of a signed or unsigned integer value and converts it to two's complement if it is signed and negative.
+     * @param value The value to check and convert.
+     * @param sizeInBits The size of the value in bits.
+     * @param signed Whether the value is signed or unsigned.
+     * @returns The converted value, or null if the value is out of bounds.
+     */
+    private checkBoundsAndConvert;
+}
+//# sourceMappingURL=ByteArrayBuilder.d.ts.map

package/lib/esm/src/api/apdu/utils/ByteArrayBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ByteArrayBuilder.d.ts","sourceRoot":"","sources":["../../../../../../src/api/apdu/utils/ByteArrayBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,eAAe,EAIhB,MAAM,mBAAmB,CAAC;AAI3B;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAgB;IAIf,OAAO,CAAC,cAAc;IAHlC,OAAO,CAAC,IAAI,CAAgC;IAC5C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;gBAE5B,cAAc,GAAE,MAAwB;IAM5D;;;OAGG;IACH,KAAK,QAAO,UAAU,CAAc;IAEpC;;;;OAIG;IACH,QAAQ,QAAO,UAAU,GAAG,SAAS,CAEnC;IAEF;;;;OAIG;IACH,iBAAiB,UAAW,MAAM,GAAG,MAAM,KAAG,gBAAgB,CAE5D;IAEF;;;;;OAKG;IACH,kBAAkB,UACT,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;;OAKG;IACH,kBAAkB,UACT,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;;OAKG;IACH,kBAAkB,UACT,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;;OAKG;IACH,iBAAiB,UACR,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;;OAKG;IACH,iBAAiB,UACR,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;;OAKG;IACH,iBAAiB,UACR,MAAM,GAAG,MAAM,cACX,OAAO,KACjB,gBAAgB,CAEjB;IAEF;;;;OAIG;IACH,eAAe,UAAW,UAAU,KAAG,gBAAgB,CAQrD;IAEF;;;;;OAKG;IACH,mBAAmB,UAAW,MAAM,KAAG,gBAAgB,CAQrD;IAEF;;;;OAIG;IACH,oBAAoB,UAAW,MAAM,KAAG,gBAAgB,CAItD;IAEF;;;;;;OAMG;IACH,kBAAkB,UAAW,MAAM,KAAG,gBAAgB,CAgBpD;IAEF;;;;;;OAMG;IACH,oBAAoB,UAAW,UAAU,KAAG,gBAAgB,CAS1D;IAEF;;;;;;OAMG;IACH,mBAAmB,UAAW,MAAM,KAAG,gBAAgB,CASrD;IAEF;;;OAGG;IACH,yBAAyB,QAAO,MAAM,CAEpC;IAEF;;;OAGG;IACH,SAAS,QAAO,eAAe,EAAE,CAAgB;IAEjD;;;OAGG;IACH,SAAS,QAAO,OAAO,CAA6B;IAMpD;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB,CAO9B;IAEF;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IA6BvB;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;CAuC9B"}