diff --git a/dist/core/README.md b/dist/core/README.md index 85abfafb..e1f67537 100644 --- a/dist/core/README.md +++ b/dist/core/README.md @@ -7,13 +7,14 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/core` package provides the modules that define -Whiteflag core protocol features as specified in the Whiteflag standard. -As such, this package is not a fully functional implementation of the -protocol, but separates core protocol functions from implementation-specific -design decisions. Therefore, this package is not intended to be used directly -by implementations of Whiteflag; instead, the `@whiteflagprotocol/main` should -be used. +The [`@whiteflagprotocol/core`](https://www.npmjs.com/package/@whiteflagprotocol/core) +package provides the modules that define Whiteflag core protocol features as +specified in the Whiteflag standard. As such, this package is not a fully +functional implementation of the protocol, but separates core protocol +functions from implementation-specific design decisions. Therefore, this +package is not intended to be used directly by implementations of Whiteflag; +instead, the [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package should be used. This description provides a generic overview of the WFJSL core package. Please see the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) @@ -35,7 +36,7 @@ code `F`) and set the `Text` field, may be done as follows: ```{javascript} let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. The `WfCoreMessage` class diff --git a/dist/core/index.d.ts b/dist/core/index.d.ts index 19dd00ab..de5f384b 100644 --- a/dist/core/index.d.ts +++ b/dist/core/index.d.ts @@ -4,7 +4,7 @@ * @document docs/md/modules.md * @primaryExport */ -export { encodeField, decodeField, isValidValue } from './lib/codec.ts'; +export { WfCodec, encodeField, decodeField, isValidValue } from './lib/codec.ts'; export { WfProtocolError, WfErrorCode } from './lib/errors.ts'; export { WfMsgType, WfCoreMessage, isValidMessage, validateMessage, encryptMessage, decryptMessage } from './lib/message.ts'; export { WfVersion } from './lib/versions.ts'; diff --git a/dist/core/index.js b/dist/core/index.js index 1f76546d..c5062dd8 100644 --- a/dist/core/index.js +++ b/dist/core/index.js @@ -1,5 +1,5 @@ 'use strict'; -export { encodeField, decodeField, isValidValue } from "./lib/codec.js"; +export { WfCodec, encodeField, decodeField, isValidValue } from "./lib/codec.js"; export { WfProtocolError, WfErrorCode } from "./lib/errors.js"; export { WfMsgType, WfCoreMessage, isValidMessage, validateMessage, encryptMessage, decryptMessage } from "./lib/message.js"; export { WfVersion } from "./lib/versions.js"; diff --git a/dist/crypto/README.md b/dist/crypto/README.md index 94597c02..e85ca77f 100644 --- a/dist/crypto/README.md +++ b/dist/crypto/README.md @@ -7,9 +7,10 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/crypto` package provides cryptographic functions for -other Whiteflag packages. Therefore, it should normally not be necessary to -add this package as a dependency. +The [`@whiteflagprotocol/crypto`](https://www.npmjs.com/package/@whiteflagprotocol/crypto) +package provides cryptographic functions for other Whiteflag packages. +Therefore, it should normally not be necessary to add this package as a +dependency. The WFJSL uses the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) for the basic implementation of Whiteflag cryptographic functions, such as diff --git a/dist/crypto/lib/hash.d.ts b/dist/crypto/lib/hash.d.ts index cdb508e2..ba7e90b4 100644 --- a/dist/crypto/lib/hash.d.ts +++ b/dist/crypto/lib/hash.d.ts @@ -21,7 +21,7 @@ declare function hkdf(ikm: Uint8Array, salt: Uint8Array, length?: number, algorithm?: string): Promise>; +declare function hash(data: Uint8Array, length?: number, algorithm?: AlgorithmIdentifier): Promise>; /** * Hash-Based Message Authentication Code function * @function hmac diff --git a/dist/main/README.md b/dist/main/README.md index 6ba56d48..65fcdaad 100644 --- a/dist/main/README.md +++ b/dist/main/README.md @@ -7,9 +7,10 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/main` package provides all classes and functions -required to implement the Whiteflag protocol. Normally this should be -the only dependency for projects implementing Whiteflag. +The [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package provides all classes and functions required to implement the Whiteflag +protocol. This should normally be the only dependency for projects +implementing Whiteflag. This description provides a generic overview of the Whiteflag main package. Please refer to the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) @@ -17,7 +18,7 @@ for a detailed description of all classes and functions. ## Whiteflag message class -The Whiteflag message class `WfMessage` defined in the `main` module +The Whiteflag message class `WfMessage` defined in the `message` module represents a Whiteflag message. This class extends the core Whiteflag message class `WfCoreMessage` by adding @@ -31,8 +32,8 @@ factory method. For example, creating a new FreeText message (message code `F`) and set the `Text` field, may be done as follows: ```{javascript} -let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +let wfMessage = new WfMessage('F'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. It automatically verifies the fields @@ -52,7 +53,7 @@ static factory methods such as `fromHex(...)` or `fromU8a(...)`, since the message type is probably not known before decoding. ```{javascript} -wfMessage = await WfCoreMessage.fromHex(hexMessage); +wfMessage = await WfMessage.fromHex(hexMessage); ``` Encryption and decryption is automatically performed upon encoding and diff --git a/dist/util/README.md b/dist/util/README.md index 91b73752..405b75d0 100644 --- a/dist/util/README.md +++ b/dist/util/README.md @@ -7,11 +7,12 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/util` package provides common utilities for other -Whiteflag packages. These utilities include common data conversions, generic -helper functions, etc. for other Whiteflag packages. It should normally not be -necessary to add this package as a dependency, but its functionality might be -useful for other purposes. +The [`@whiteflagprotocol/util`](https://www.npmjs.com/package/@whiteflagprotocol/util) +package provides common utilities for other Whiteflag packages. These +utilities include common data conversions, generic helper functions, etc. +for other Whiteflag packages. It should normally not be necessary to add this +package as a dependency, but its functionality might be useful for other +purposes. This description provides a generic overview of the WFJSL utility package. Please see the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 00000000..8b0078ae Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/md/core.md b/docs/md/core.md index 05fc6944..1de2e394 100644 --- a/docs/md/core.md +++ b/docs/md/core.md @@ -4,13 +4,14 @@ ## Overview -The `@whiteflagprotocol/core` package provides the modules that define -Whiteflag core protocol features as specified in the Whiteflag standard. -As such, this package is not a fully functional implementation of the -protocol, but separates core protocol functions from implementation-specific -design decisions. Therefore, this package is not intended to be used directly -by implementations of Whiteflag; instead, the `@whiteflagprotocol/main` should -be used. +The [`@whiteflagprotocol/core`](https://www.npmjs.com/package/@whiteflagprotocol/core) +package provides the modules that define Whiteflag core protocol features as +specified in the Whiteflag standard. As such, this package is not a fully +functional implementation of the protocol, but separates core protocol +functions from implementation-specific design decisions. Therefore, this +package is not intended to be used directly by implementations of Whiteflag; +instead, the [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package should be used. This description provides a generic overview of the Whiteflag core package. Please refer to the [WFJSL TypeDoc documentation](../typedoc) for a detailed @@ -32,7 +33,7 @@ code `F`) and set the `Text` field, may be done as follows: ```{javascript} let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. The `WfCoreMessage` class diff --git a/docs/md/crypto.md b/docs/md/crypto.md index 8b59e270..7d95ec9c 100644 --- a/docs/md/crypto.md +++ b/docs/md/crypto.md @@ -4,9 +4,10 @@ ## Overview -The `@whiteflagprotocol/crypto` package provides cryptographic functions for -other Whiteflag packages. Therefore, it should normally not be necessary to -add this package as a dependency. +The [`@whiteflagprotocol/crypto`](https://www.npmjs.com/package/@whiteflagprotocol/crypto) +package provides cryptographic functions for other Whiteflag packages. +Therefore, it should normally not be necessary to add this package as a +dependency. The WFJSL uses the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) for the basic implementation of Whiteflag cryptographic functions, such as diff --git a/docs/md/main.md b/docs/md/main.md index 0a907dae..77d20b57 100644 --- a/docs/md/main.md +++ b/docs/md/main.md @@ -4,9 +4,10 @@ ## Overview -The `@whiteflagprotocol/main` package provides all classes and functions -required to implement the Whiteflag protocol. Normally this should be -the only dependency for projects implementing Whiteflag. +The [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package provides all classes and functions required to implement the Whiteflag +protocol. This should normally be the only dependency for projects +implementing Whiteflag. This description provides a generic overview of the Whiteflag main package. Please refer to the [WFJSL TypeDoc documentation](../typedoc) for a detailed @@ -28,8 +29,8 @@ factory method. For example, creating a new FreeText message (message code `F`) and set the `Text` field, may be done as follows: ```{javascript} -let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +let wfMessage = new WfMessage('F'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. It automatically verifies the fields @@ -49,7 +50,7 @@ static factory methods such as `fromHex(...)` or `fromU8a(...)`, since the message type is probably not known before decoding. ```{javascript} -wfMessage = await WfCoreMessage.fromHex(hexMessage); +wfMessage = await WfMessage.fromHex(hexMessage); ``` Encryption and decryption is automatically performed upon encoding and diff --git a/docs/md/util.md b/docs/md/util.md index b51ec798..174da8f6 100644 --- a/docs/md/util.md +++ b/docs/md/util.md @@ -4,11 +4,12 @@ ## Overview -The `@whiteflagprotocol/util` package provides common utilities for other -Whiteflag packages. These utilities include common data conversions, generic -helper functions, etc. for other Whiteflag packages. It should normally not be -necessary to add this package as a dependency, but its functionality might be -useful for other purposes. +The [`@whiteflagprotocol/util`](https://www.npmjs.com/package/@whiteflagprotocol/util) +package provides common utilities for other Whiteflag packages. These +utilities include common data conversions, generic helper functions, etc. +for other Whiteflag packages. It should normally not be necessary to add this +package as a dependency, but its functionality might be useful for other +purposes. This description provides a generic overview of the Whiteflag utility package. Please refer to the [TypeDoc documentation](../typedoc) for a detailed diff --git a/docs/typedoc/_whiteflagprotocol/core.html b/docs/typedoc/_whiteflagprotocol/core.html new file mode 100644 index 00000000..c558ecd2 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core.html @@ -0,0 +1,116 @@ +@whiteflagprotocol/core | Whiteflag JavaScript Library
Whiteflag JavaScript Library
    Preparing search index...

    Module @whiteflagprotocol/core

    WFJSL Core Implementation

    The Whiteflag JavaScript Library (WFJSL) is an implementation of the Whiteflag +Protocol written in TypeScript, +and compiled to JavaScript, +to support the development of Whiteflag-enabled applications in JavaScript.

    +

    The @whiteflagprotocol/core +package provides the modules that define Whiteflag core protocol features as +specified in the Whiteflag standard. As such, this package is not a fully +functional implementation of the protocol, but separates core protocol +functions from implementation-specific design decisions. Therefore, this +package is not intended to be used directly by implementations of Whiteflag; +instead, the @whiteflagprotocol/main +package should be used.

    +

    This description provides a generic overview of the WFJSL core package. +Please see the WFJSL TypeDoc documentation +for a detailed description of all classes and functions.

    +

    The Whiteflag message class WfCoreMessage defined in the message module +represents a Whiteflag message. The class contains the methods to create, +set field values, encode and encrypt a Whiteflag message. Please note that +there normally is no need to use the WfCoreMessage directly. Instead, the +WfMessage child class of the @whiteflagprotocol/main package is the main +class to use for Whiteflag message, as this extended class provides methods to +process the metadata required for full protocol functionality.

    +

    A new message may be created using the constructor, or by using a static +factory method. For example, creating a new FreeText message (message +code F) and set the Text field, may be done as follows:

    +
    let wfMessage = new WfCoreMessage('F');
+wfMessage.set('Text', 'Example text to be sent with the FreeText message');
+
    + +

    The encode() method encodes the message. The WfCoreMessage class +automatically verifies the fields and values when encoding and decoding. +Encoding and decoding are asynchronous, meaning the functions return +Promises. +Once encoded, the methods toHex() and toU8a() may be used to obtain the +encoded message as a hexadecimal string or a UInt8array, respectively.

    +
    await wfMessage.encode();
+const hexMessage = wfMessage.toHex();
+
    + +

    If a message is encoded, or decoded, the message is "final", meaning its +content cannot be changed. Decoding a message is done using a one of the +static factory methods such as fromHex(...) or fromU8a(...), since the +message type is probably not known before decoding.

    +
    wfMessage = await WfCoreMessage.fromHex(hexMessage);
+
    + +

    Encryption and decryption is automatically performed upon encoding and +decoding, based on the value of the EncryptionIndicator field in the message +header. Since the WfCoreMessage class does not hold any metadata, all +encryption and decryption parameters must be provided to the respective method +when encoding or decoding a message.

    +

    The message module, also provides the following functions. These functions +are used by the WfCoreMessage class, but may also be used for alternative +processing of Whiteflag messages.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    FunctionPurpose
    isValidMessageChecks if an object is a valid Whiteflag message
    validateMessageChecks a message object for validation errors
    encryptMessageEncrypts a binary encoded message
    decryptMessageDecrypts an encrypted binary message
    +

    Both validation functions may be used for both plain JavaScript objects and +objects of the WfCoreMessage class. The encryption and decryption functions +work only on binary encoded messages provided as a BinaryBuffer.

    +

    The codec module provides the encoding and decoding for each field in +a Whiteflag message i.a.w. the Whiteflag specification. The available field +encodings are defined with the WfCodec enum. For the encoding, decoding, and +verification of field values, the module provides the following functions.

    + + + + + + + + + + + + + + + + + + + + + +
    FunctionPurpose
    encodeFieldEncodes a Whiteflag message field
    decodeFieldDecodes a Whiteflag message field
    isValidValueChecks if the field value is valid
    +

    These functions are used by the WfCoreMessage class when encoding and +decoding a message.

    +

    Currently, only one version of the Whiteflag protocol has been developed. For +ease of implementation of future Whiteflag versions, WFJSL functions and +classes take the Whiteflag version into account. The versions module defines +the available Whiteflag versions with the WfVersions enum.

    +

    Enumerations

    WfCodec
    WfErrorCode
    WfMsgType
    WfVersion

    Classes

    WfCoreMessage
    WfProtocolError

    Functions

    decodeField
    decryptMessage
    encodeField
    encryptMessage
    isValidMessage
    isValidValue
    validateMessage

    Settings

    Member Visibility

    On This Page

    WFJSL Core Implementation
    Enumerations
    Classes
    Functions
    diff --git a/docs/typedoc/_whiteflagprotocol/core/WfCodec.html b/docs/typedoc/_whiteflagprotocol/core/WfCodec.html new file mode 100644 index 00000000..c92c8f8b --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfCodec.html @@ -0,0 +1,22 @@ +WfCodec | Whiteflag JavaScript Library
    Whiteflag JavaScript Library
      Preparing search index...

      Enumeration WfCodec

      Whiteflag field encodings, defining the encoding of Whiteflag +message fields as defined by the Whiteflag specification +WfCodec

      +

      v1-draft.7

      +

      4.1.2 Message Encoding

      +
      Index

      Enumeration Members

      BIN +DATETIME +DEC +DURATION +HEX +LAT +LONG +UTF8 +

      Enumeration Members

      BIN: "binary"

      Binary field

      +
      DATETIME: "datetime"

      Datetime field

      +
      DEC: "decimal"

      Decimal field

      +
      DURATION: "duration"

      Duration field

      +
      HEX: "hexadecimal"

      HExadecimal field

      +
      LAT: "latitude"

      Latitude field

      +
      LONG: "longitude"

      Longitude field

      +
      UTF8: "utf-8"

      UTF-8 / ASCII text field

      +

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      diff --git a/docs/typedoc/_whiteflagprotocol/core/WfCoreMessage.html b/docs/typedoc/_whiteflagprotocol/core/WfCoreMessage.html new file mode 100644 index 00000000..8eccc539 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfCoreMessage.html @@ -0,0 +1,95 @@ +WfCoreMessage | Whiteflag JavaScript Library
      Whiteflag JavaScript Library
        Preparing search index...

        Class WfCoreMessage

        A core Whiteflag message as defined by the Whiteflag specification +WfCoreMessage

        +

        v1-draft.7

        +

        4 Message Format

        +

        Ths class represents a core Whiteflag message as +defined by the Whiteflag specification. It has a message header and +a message body which contain the message fields as specified for the +message type. It performs the encoding/encryption and decoding/decryption +to and from binary messages. Since the processing of Whiteflag messges +in accordance with the protocol requires additional metadata, the extrended +WfMessage class of the @whitelag/protol package should normallly be +used instead of this class.

        +

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +

        Methods

        decode +encode +get +isEncoded +isValid +set +toHex +toObject +toString +toU8a +validate +fromBinary +fromHex +fromObject +fromU8a +

        Constructors

        Methods

        • Function

          Encodes the message, making the contents final +encode

          +

          Parameters

          • Optionalikm: Uint8Array<ArrayBufferLike>

            the input key material to derive the encryption key, if the message is to be encrypted

            +
          • Optionaladdress: Uint8Array<ArrayBufferLike>

            the binary encoded originator address, if the message is to be encrypted

            +
          • Optionaliv: Uint8Array<ArrayBufferLike>

            the initialisation vector, if required for the encryption method

            +

          Returns Promise<WfCoreMessage>

          this Whitedlag message object with the encoded message

          +
        • Function

          Returns the value of the specified message field +get

          +

          Parameters

          • fieldName: string

            the name of the message field

            +

          Returns string | null

          the value of the message field

          +
        • Function

          Indicates if the message has already been encoded +isEncoded

          +

          Returns boolean

          true if message has been encoded, else false

          +
        • Function

          Indicates if the message is valid, i.e. if all fields contain valid values +isValid

          +

          Returns boolean

          true if message is valid, else false

          +
        • Function

          Sets the value of the specified message field, if the message has not been encoded +set

          +

          Parameters

          • fieldName: string

            the name of the message field

            +
          • value: string

            the value to set

            +

          Returns boolean

          true if succesful, else false

          +
        • Function

          Returns the Whiteflag message encoded as a hexadecimal string +toHex

          +

          Returns string

          a hexadecimal string with the encoded message

          +
        • Function

          Returns the Whiteflag message as a plain object +toObject

          +

          Returns Object

          the message as a plain object

          +
        • Function

          Returns the Whiteflag message as a string +toString

          +

          Returns string

          a concatinated string of field values

          +
        • Function

          Returns the encoded Whiteflag message as a UInt8array +toU8a

          +

          Returns Uint8Array

          a UInt8array with the encoded message

          +
        • Function

          Returns message validation errors +validate

          +

          Returns string[]

          an array of validation errors

          +
        • Function

          Creates new Whiteflag message from a binary buffer +fromBinary

          +

          Parameters

          • message: BinaryBuffer

            a binary buffer with the encoded message

            +
          • Optionalikm: Uint8Array<ArrayBufferLike>

            the input key material to derive the encryption key, if the message is encrypted

            +
          • Optionaladdress: Uint8Array<ArrayBufferLike>

            the binary encoded originator address, if the message is encrypted

            +
          • Optionaliv: Uint8Array<ArrayBufferLike>

            the initialisation vector, if required for the encryption method

            +

          Returns Promise<WfCoreMessage>

          a new Whiteflag message object with the decoded message

          +

        • Creates new Whiteflag message from a hexadecimal encoded string

          +

          Parameters

          • message: string

            atring with the hexadecimal encoded message

            +
          • Optionalikm: string

            the hexadecimalinput key material to derive the encryption key, if the message is encrypted

            +
          • Optionaladdress: string

            the hexadecimal encoded originator address, if the message is encrypted

            +
          • Optionaliv: string

            the hexadecimal initialisation vector, if required for the encryption method

            +

          Returns Promise<WfCoreMessage>

          a new Whiteflag message object with the decoded message

          +
        • Function

          Creates new Whiteflag message from a plain object +fromObject

          +

          Parameters

          • message: any

            a plain JavaScript object with message header and body

            +

          Returns Promise<WfCoreMessage>

          a new Whiteflag message object

          +

        • Creates new Whiteflag message from a binary encoded message

          +

          Parameters

          • message: Uint8Array

            a Uint8Array with the binary encoded message

            +
          • Optionalikm: Uint8Array<ArrayBufferLike>

            the input key material to derive the encryption key, if the message is encrypted

            +
          • Optionaladdress: Uint8Array<ArrayBufferLike>

            the binary encoded originator address, if the message is encrypted

            +
          • Optionaliv: Uint8Array<ArrayBufferLike>

            the initialisation vector, if required for the encryption method

            +

          Returns Promise<WfCoreMessage>

          a new Whiteflag message object with the decoded message

          +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        diff --git a/docs/typedoc/_whiteflagprotocol/core/WfErrorCode.html b/docs/typedoc/_whiteflagprotocol/core/WfErrorCode.html new file mode 100644 index 00000000..ead74c41 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfErrorCode.html @@ -0,0 +1,17 @@ +WfErrorCode | Whiteflag JavaScript Library
        Whiteflag JavaScript Library
          Preparing search index...

          Enumeration WfErrorCode

          Defines Whiteflag protocol errors +WfErrorCode

          +
          Index

          Enumeration Members

          AUTHENTICATION +ENCRYPTION +FORMAT +METAHEADER +PROTOCOL +REFERENCE +SIGNATURE +

          Enumeration Members

          AUTHENTICATION: "WF_AUTH_ERROR"

          Whiteflag message authentication error

          +
          ENCRYPTION: "WF_ENCRYPTION_ERROR"

          Whiteflag encryption error

          +
          FORMAT: "WF_FORMAT_ERROR"

          Whiteflag message format error

          +
          METAHEADER: "WF_METAHEADER_ERROR"

          Incorrect or missingWhiteflag message meta data

          +
          PROTOCOL: "WF_PROTOCOL_ERROR"

          Generic Whiteflag protocol error

          +
          REFERENCE: "WF_REFERENCE_ERROR"

          Whiteflag message reference error

          +
          SIGNATURE: "WF_SIGN_ERROR"

          Whiteflag signature error

          +

          Settings

          Member Visibility

          On This Page

          Enumeration Members
          diff --git a/docs/typedoc/_whiteflagprotocol/core/WfMsgType.html b/docs/typedoc/_whiteflagprotocol/core/WfMsgType.html new file mode 100644 index 00000000..63ad4c76 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfMsgType.html @@ -0,0 +1,30 @@ +WfMsgType | Whiteflag JavaScript Library
          Whiteflag JavaScript Library
            Preparing search index...

            Enumeration WfMsgType

            Whiteflag message types, defining the types of Whiteflag message +as specified by the Whiteflag standard +WfFieldType

            +

            v1-draft.7

            +

            2.4.2.1 Functional Messages, 2.4.2.2 Management Messages

            +
            Index

            Enumeration Members

            A +D +E +F +I +K +M +P +Q +R +S +T +

            Enumeration Members

            A: "A"

            Authentication message

            +
            D: "D"

            Protection sign

            +
            E: "E"

            Emergency signal

            +
            F: "F"

            Free text message

            +
            I: "I"

            Infrstructure sign

            +
            K: "K"

            Cryptographic support message

            +
            M: "M"

            Mission signal

            +
            P: "P"

            Protection sign

            +
            Q: "Q"

            Request signal

            +
            R: "R"

            Reference message

            +
            S: "S"

            Status signal

            +
            T: "T"

            Test message

            +

            Settings

            Member Visibility

            On This Page

            Enumeration Members
            diff --git a/docs/typedoc/_whiteflagprotocol/core/WfProtocolError.html b/docs/typedoc/_whiteflagprotocol/core/WfProtocolError.html new file mode 100644 index 00000000..79fd572a --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfProtocolError.html @@ -0,0 +1,43 @@ +WfProtocolError | Whiteflag JavaScript Library
            Whiteflag JavaScript Library
              Preparing search index...

              Class WfProtocolError

              Error class for Whiteflag protocol and message errors +ProtocolError

              +

              Hierarchy

              • Error
                • WfProtocolError
              Index

              Constructors

              constructor +

              Properties

              cause? +causes +code +message +name +stack? +stackTraceLimit +

              Methods

              captureStackTrace +prepareStackTrace +

              Constructors

              • Constructor for protocol errors

                +

                Parameters

                • message: string

                  a human readable error message

                  +
                • causes: any

                  underlying errors causing this error

                  +
                • code: WfErrorCode = WfErrorCode.PROTOCOL

                  constant identifying the error

                  +

                Returns WfProtocolError

              Properties

              cause?: unknown
              causes: string[]

              Underlying causes of the error

              +
              code: string

              The Whiteflag protocol error code

              +
              message: string
              name: string
              stack?: string
              stackTraceLimit: number

              The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

              +

              The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

              +

              If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

              +

              Methods

              • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                +
                const myObject = {};
                Error.captureStackTrace(myObject);
                myObject.stack;  // Similar to `new Error().stack`
+
                + +

                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                +

                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                +

                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                +
                function a() {
                  b();
                }

                function b() {
                  c();
                }

                function c() {
                  // Create an error without stack trace to avoid calculating the stack trace twice.
                  const { stackTraceLimit } = Error;
                  Error.stackTraceLimit = 0;
                  const error = new Error();
                  Error.stackTraceLimit = stackTraceLimit;

                  // Capture the stack trace above function b
                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                  throw error;
                }

                a();
+
                + +

                Parameters

                • targetObject: object
                • OptionalconstructorOpt: Function

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              diff --git a/docs/typedoc/_whiteflagprotocol/core/WfVersion.html b/docs/typedoc/_whiteflagprotocol/core/WfVersion.html new file mode 100644 index 00000000..ba9d68e5 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/WfVersion.html @@ -0,0 +1,5 @@ +WfVersion | Whiteflag JavaScript Library
              Whiteflag JavaScript Library
                Preparing search index...

                Enumeration WfVersion

                Defines Whiteflag versions +WfVersion

                +
                Index

                Enumeration Members

                v1 +

                Enumeration Members

                v1: "1"

                Whiteflag version 1

                +

                Settings

                Member Visibility

                On This Page

                Enumeration Members
                diff --git a/docs/typedoc/_whiteflagprotocol/core/decodeField.html b/docs/typedoc/_whiteflagprotocol/core/decodeField.html new file mode 100644 index 00000000..8c212130 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/decodeField.html @@ -0,0 +1,9 @@ +decodeField | Whiteflag JavaScript Library
                Whiteflag JavaScript Library
                  Preparing search index...

                  Function decodeField

                  • Function

                    Decodes a Whiteflag message field +decodeField

                    +

                    Parameters

                    • buffer: BinaryBuffer

                      a binary buffer with the encoded field

                      +
                    • codec: WfCodec

                      the message field encoding: 'utf-8', 'bin', 'dec', 'hex', 'datetime', 'duration', 'lat', 'long'

                      +
                    • version: v1 = WfVersion.v1

                      the version of the Whiteflag specification

                      +

                    Returns string

                    a string with the decoded field value

                    +

                    v1-draft.7

                    +

                    4.1.2 Message Encoding, 4.1.3 Message Compression

                    +

                  Settings

                  Member Visibility
                  diff --git a/docs/typedoc/_whiteflagprotocol/core/decryptMessage.html b/docs/typedoc/_whiteflagprotocol/core/decryptMessage.html new file mode 100644 index 00000000..ef2f0f01 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/decryptMessage.html @@ -0,0 +1,10 @@ +decryptMessage | Whiteflag JavaScript Library
                  Whiteflag JavaScript Library
                    Preparing search index...

                    Function decryptMessage

                    • Function

                      Decrypts an encrypted binary message +decryptMessage

                      +

                      Parameters

                      • message: BinaryBuffer

                        a binary buffer with the encrypted message

                        +
                      • method: WfCryptoMethod

                        the Whiteflag encryption method

                        +
                      • ikm: Uint8Array

                        the input key material to derive the encryption key

                        +
                      • address: Uint8Array

                        the binary encoded originator address

                        +
                      • Optionaliv: Uint8Array<ArrayBufferLike>

                        the initialisation vector, if required for the encryption method

                        +
                      • version: v1 = WfVersion.v1

                        the Whiteflag protocol version

                        +

                      Returns Promise<BinaryBuffer>

                      the decrypted binary encoded message

                      +

                    Settings

                    Member Visibility
                    diff --git a/docs/typedoc/_whiteflagprotocol/core/encodeField.html b/docs/typedoc/_whiteflagprotocol/core/encodeField.html new file mode 100644 index 00000000..c7ac5cc6 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/encodeField.html @@ -0,0 +1,9 @@ +encodeField | Whiteflag JavaScript Library
                    Whiteflag JavaScript Library
                      Preparing search index...

                      Function encodeField

                      • Function

                        Encodes a Whiteflag message field +encodeField

                        +

                        Parameters

                        • value: string

                          the message field value

                          +
                        • codec: WfCodec

                          the message field encoding: 'utf-8', 'bin', 'dec', 'hex', 'datetime', 'duration', 'lat', 'long'

                          +
                        • version: v1 = WfVersion.v1

                          the version of the Whiteflag specification

                          +

                        Returns BinaryBuffer

                        a binary buffer with the compressed encoded field

                        +

                        v1-draft.7

                        +

                        4.1.2 Message Encoding, 4.1.3 Message Compression

                        +

                      Settings

                      Member Visibility
                      diff --git a/docs/typedoc/_whiteflagprotocol/core/encryptMessage.html b/docs/typedoc/_whiteflagprotocol/core/encryptMessage.html new file mode 100644 index 00000000..d52078d5 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/encryptMessage.html @@ -0,0 +1,10 @@ +encryptMessage | Whiteflag JavaScript Library
                      Whiteflag JavaScript Library
                        Preparing search index...

                        Function encryptMessage

                        • Function

                          Encrypts a binary encoded message +encryptMessage

                          +

                          Parameters

                          • message: BinaryBuffer

                            a binary buffer with the binary encoded message

                            +
                          • method: WfCryptoMethod

                            the Whiteflag encryption method

                            +
                          • ikm: Uint8Array

                            the input key material to derive the encryption key

                            +
                          • address: Uint8Array

                            the binary encoded originator address

                            +
                          • Optionaliv: Uint8Array<ArrayBufferLike>

                            the initialisation vector, if required for the encryption method

                            +
                          • version: v1 = WfVersion.v1

                            the Whiteflag protocol version

                            +

                          Returns Promise<BinaryBuffer>

                          the encrypted message

                          +

                        Settings

                        Member Visibility
                        diff --git a/docs/typedoc/_whiteflagprotocol/core/isValidMessage.html b/docs/typedoc/_whiteflagprotocol/core/isValidMessage.html new file mode 100644 index 00000000..efa9849a --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/isValidMessage.html @@ -0,0 +1,5 @@ +isValidMessage | Whiteflag JavaScript Library
                        Whiteflag JavaScript Library
                          Preparing search index...

                          Function isValidMessage

                          • Function

                            Checks if an object is a valid Whiteflag message +isValidMessage

                            +

                            Parameters

                            • message: any

                              the message object to validate

                              +

                            Returns boolean

                            true if message is valid, else false

                            +

                          Settings

                          Member Visibility
                          diff --git a/docs/typedoc/_whiteflagprotocol/core/isValidValue.html b/docs/typedoc/_whiteflagprotocol/core/isValidValue.html new file mode 100644 index 00000000..38656ce8 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/isValidValue.html @@ -0,0 +1,7 @@ +isValidValue | Whiteflag JavaScript Library
                          Whiteflag JavaScript Library
                            Preparing search index...

                            Function isValidValue

                            • Function

                              Checks if the field value is valid +isValidValue

                              +

                              Parameters

                              • value: string

                                the field value

                                +
                              • codec: WfCodec

                                the field encoding

                                +
                              • version: v1 = WfVersion.v1

                                the Whiteflag protocol version

                                +

                              Returns boolean

                              true if valid, else false

                              +

                            Settings

                            Member Visibility
                            diff --git a/docs/typedoc/_whiteflagprotocol/core/validateMessage.html b/docs/typedoc/_whiteflagprotocol/core/validateMessage.html new file mode 100644 index 00000000..e76b2007 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/core/validateMessage.html @@ -0,0 +1,5 @@ +validateMessage | Whiteflag JavaScript Library
                            Whiteflag JavaScript Library
                              Preparing search index...

                              Function validateMessage

                              • Function

                                Checks a message object for validation errors +validateMessage

                                +

                                Parameters

                                • message: any

                                  the message object to validate

                                  +

                                Returns string[]

                                an array of validation errors

                                +

                              Settings

                              Member Visibility
                              diff --git a/docs/typedoc/_whiteflagprotocol/crypto.html b/docs/typedoc/_whiteflagprotocol/crypto.html new file mode 100644 index 00000000..ab79ddf2 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto.html @@ -0,0 +1,104 @@ +@whiteflagprotocol/crypto | Whiteflag JavaScript Library
                              Whiteflag JavaScript Library
                                Preparing search index...

                                Module @whiteflagprotocol/crypto

                                WFJSL Cryptographic Functions

                                The Whiteflag JavaScript Library (WFJSL) is an implementation of the Whiteflag +Protocol written in TypeScript, +and compiled to JavaScript, +to support the development of Whiteflag-enabled applications in JavaScript.

                                +

                                The @whiteflagprotocol/crypto +package provides cryptographic functions for other Whiteflag packages. +Therefore, it should normally not be necessary to add this package as a +dependency.

                                +

                                The WFJSL uses the Web Crypto API +for the basic implementation of Whiteflag cryptographic functions, such as +secret negotiation, encryption, and authentication. Putting these critical +security functions in a separate package makes them better inspectable, +testable and maintainable.

                                +

                                Most cryptography functions are asynchronous and return a +Promise.

                                +

                                This description provides a generic overview of the WFJSL cryptography +package. Please see the WFJSL TypeDoc documentation +for a detailed description of all classes and functions.

                                +

                                The Whiteflag cryptography package provides three hashing functions +with the hash module:

                                + + + + + + + + + + + + + + + + + + + + + +
                                FunctionPurpose
                                hkdfHash-based Key Derivation Function using SHA-256 i.a.w. RFC 5869
                                hashBasic hashing function, using SHA-256 as default
                                hmacHash-Based Message Authentication Code function, using SHA-256 as default
                                +

                                The hkdf function is used by Whiteflag to derive encryption keys and +authentication tokens and bind them to the blockchain address of a specific +originator. The hash and hmac functions are wrappers easy common access +to the underlying algorithms through the Web Crypto API; they are used by +the hkdf function, but may also be used for other functionality as required.

                                +

                                The Whiteflag cryptography package provides the following functions for +message encryption with the cipher module:

                                + + + + + + + + + + + + + + + + + + + + + +
                                FunctionPurpose
                                encryptEncrypts a binary encoded Whiteflag message, based on the Whiteflag encryption method
                                decryptDecrypts a binary encoded Whiteflag message, based on the Whiteflag encryption method
                                deriveKeyDerives the encryption key based on the Whiteflag encryption method
                                +

                                The encrypt and decrypt functions take a binary encoded Whiteflag message, +along with a number of encryption parameters such as the encryption key, to +perform the encryption and decryption of messages.

                                +

                                The deriveKey function uses the hkdf function with the input key material, +information parameter, salt, and key length for the encryption method, to +generate the Web Crypto API encryption key to be used with the encrypt and +decrypt functions i.a.w. the Whiteflag standard.

                                +

                                The Whiteflag encryption methods are defined by the WfCryptoMethod enum.

                                +

                                The Whiteflag cryptography package provides the following functions for +key generation with the keys module:

                                + + + + + + + + + + + + + + + + + +
                                FunctionPurpose
                                createAesKeyCreates an AES encryption and decryption key
                                createHmacKeyCreates an HMAC signing key
                                +

                                All key generation functions create a Web Crypto API CryptoKey object, +typically from a raw key generated or provided elsewhere. These keys are +primarily intended to provide the correct Web Crypto API keys to other +functions of the cryptography package.

                                +

                                Enumerations

                                WfCryptoMethod

                                Functions

                                createAesKey
                                createHmacKey
                                decrypt
                                deriveKey
                                encrypt
                                hash
                                hkdf
                                hmac

                                Settings

                                Member Visibility

                                On This Page

                                WFJSL Cryptographic Functions
                                Enumerations
                                Functions
                                diff --git a/docs/typedoc/_whiteflagprotocol/crypto/WfCryptoMethod.html b/docs/typedoc/_whiteflagprotocol/crypto/WfCryptoMethod.html new file mode 100644 index 00000000..24fd98fe --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/WfCryptoMethod.html @@ -0,0 +1,10 @@ +WfCryptoMethod | Whiteflag JavaScript Library
                                Whiteflag JavaScript Library
                                  Preparing search index...

                                  Enumeration WfCryptoMethod

                                  Whiteflag encryption methods, defining the encryption methods +for Whiteflag messages as specified by the Whiteflag standard +WfCryptoMethod

                                  +

                                  v1-draft.7

                                  +

                                  5.2.4 Message Encryption

                                  +
                                  Index

                                  Enumeration Members

                                  ECDH +PSK +

                                  Enumeration Members

                                  ECDH: "1"

                                  Whiteflag encryption method 1: negotiated key

                                  +
                                  PSK: "2"

                                  Whiteflag encryption method 2: pre-shared key

                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Enumeration Members
                                  diff --git a/docs/typedoc/_whiteflagprotocol/crypto/createAesKey.html b/docs/typedoc/_whiteflagprotocol/crypto/createAesKey.html new file mode 100644 index 00000000..af86c012 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/createAesKey.html @@ -0,0 +1,6 @@ +createAesKey | Whiteflag JavaScript Library
                                  Whiteflag JavaScript Library
                                    Preparing search index...

                                    Function createAesKey

                                    • Function

                                      Creates an AES encryption and decryption key +createAesKey

                                      +

                                      Parameters

                                      • rawKey: Uint8Array<ArrayBuffer>

                                        the raw key

                                        +
                                      • algorithm: string = DEFAULT_ENCRYPTALG

                                        the AES mode to use the key for, default is CTR mode

                                        +

                                      Returns Promise<CryptoKey>

                                      the AES enrcyption key

                                      +

                                    Settings

                                    Member Visibility
                                    diff --git a/docs/typedoc/_whiteflagprotocol/crypto/createHmacKey.html b/docs/typedoc/_whiteflagprotocol/crypto/createHmacKey.html new file mode 100644 index 00000000..5bd66cdd --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/createHmacKey.html @@ -0,0 +1,6 @@ +createHmacKey | Whiteflag JavaScript Library
                                    Whiteflag JavaScript Library
                                      Preparing search index...

                                      Function createHmacKey

                                      • Function

                                        Creates an HMAC signing key +createHmacKey

                                        +

                                        Parameters

                                        • rawKey: Uint8Array<ArrayBuffer>

                                          the raw key

                                          +
                                        • algorithm: string = DEFAULT_HASHALG

                                          the hashing algorithm, default is SHA-256

                                          +

                                        Returns Promise<CryptoKey>

                                        the HMAC signing key

                                        +

                                      Settings

                                      Member Visibility
                                      diff --git a/docs/typedoc/_whiteflagprotocol/crypto/decrypt.html b/docs/typedoc/_whiteflagprotocol/crypto/decrypt.html new file mode 100644 index 00000000..2c593cf7 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/decrypt.html @@ -0,0 +1,10 @@ +decrypt | Whiteflag JavaScript Library
                                      Whiteflag JavaScript Library
                                        Preparing search index...

                                        Function decrypt

                                        • Function

                                          Decrypts a message based on the specified encryption method +decrypt

                                          +

                                          Parameters

                                          • message: Uint8Array<ArrayBuffer>

                                            the message to be decyrpted

                                            +
                                          • method: WfCryptoMethod

                                            the Whiteflag encryption method

                                            +
                                          • key: CryptoKey

                                            the encryption key

                                            +
                                          • Optionaliv: Uint8Array<ArrayBuffer>

                                            the initialisation vector, if required for the method

                                            +
                                          • version: v1 = WfVersion.v1

                                            the Whiteflag protocol version

                                            +

                                          Returns Promise<Uint8Array<ArrayBufferLike>>

                                          v1-draft.7

                                          +

                                          5.2.4 Message Encryption

                                          +

                                        Settings

                                        Member Visibility
                                        diff --git a/docs/typedoc/_whiteflagprotocol/crypto/deriveKey.html b/docs/typedoc/_whiteflagprotocol/crypto/deriveKey.html new file mode 100644 index 00000000..84abd66f --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/deriveKey.html @@ -0,0 +1,10 @@ +deriveKey | Whiteflag JavaScript Library
                                        Whiteflag JavaScript Library
                                          Preparing search index...

                                          Function deriveKey

                                          • Function

                                            Derives the encryption key based on the Whiteflag encryption method +deriveKey

                                            +

                                            Parameters

                                            • ikm: Uint8Array<ArrayBuffer>

                                              the raw input key material

                                              +
                                            • method: WfCryptoMethod

                                              the Whiteflag encryption method

                                              +
                                            • info: Uint8Array<ArrayBuffer>

                                              information to bind the key, e.g. the blockchain address of the originator

                                              +
                                            • version: v1 = WfVersion.v1

                                              the Whiteflag protocol version

                                              +

                                            Returns Promise<CryptoKey>

                                            the encryption key

                                            +

                                            v1-draft.7

                                            +

                                            5.2.3 Encryption Key and Authentication Token Derivation

                                            +

                                          Settings

                                          Member Visibility
                                          diff --git a/docs/typedoc/_whiteflagprotocol/crypto/encrypt.html b/docs/typedoc/_whiteflagprotocol/crypto/encrypt.html new file mode 100644 index 00000000..3bd01f54 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/encrypt.html @@ -0,0 +1,10 @@ +encrypt | Whiteflag JavaScript Library
                                          Whiteflag JavaScript Library
                                            Preparing search index...

                                            Function encrypt

                                            • Function

                                              Encrypts a message based on the specified encryption method +encrypt

                                              +

                                              Parameters

                                              • message: Uint8Array<ArrayBuffer>

                                                the message to be encrypted

                                                +
                                              • method: WfCryptoMethod

                                                the Whiteflag encryption method

                                                +
                                              • key: CryptoKey

                                                the input key material for the encryption key

                                                +
                                              • Optionaliv: Uint8Array<ArrayBuffer>

                                                the initialisation vector, if required for the method

                                                +
                                              • version: v1 = WfVersion.v1

                                                the Whiteflag protocol version

                                                +

                                              Returns Promise<Uint8Array<ArrayBufferLike>>

                                              v1-draft.7

                                              +

                                              5.2.4 Message Encryption

                                              +

                                            Settings

                                            Member Visibility
                                            diff --git a/docs/typedoc/_whiteflagprotocol/crypto/hash.html b/docs/typedoc/_whiteflagprotocol/crypto/hash.html new file mode 100644 index 00000000..92a5dc73 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/hash.html @@ -0,0 +1,7 @@ +hash | Whiteflag JavaScript Library
                                            Whiteflag JavaScript Library
                                              Preparing search index...

                                              Function hash

                                              • Function

                                                Basic hashing function +hash

                                                +

                                                Parameters

                                                • data: Uint8Array<ArrayBuffer>

                                                  data to hash

                                                  +
                                                • length: number = HASHLEN

                                                  the required output length in octets; default is 32

                                                  +
                                                • algorithm: AlgorithmIdentifier = HASHALG

                                                  the hash algorithm to be used; default is SHA-256

                                                  +

                                                Returns Promise<Uint8Array<ArrayBuffer>>

                                                the hash value

                                                +

                                              Settings

                                              Member Visibility
                                              diff --git a/docs/typedoc/_whiteflagprotocol/crypto/hkdf.html b/docs/typedoc/_whiteflagprotocol/crypto/hkdf.html new file mode 100644 index 00000000..ff752f79 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/hkdf.html @@ -0,0 +1,8 @@ +hkdf | Whiteflag JavaScript Library
                                              Whiteflag JavaScript Library
                                                Preparing search index...

                                                Function hkdf

                                                • Function

                                                  Hash-based Key Derivation Function using SHA-256 i.a.w. RFC 5869 +hkdf

                                                  +

                                                  Parameters

                                                  • ikm: Uint8Array<ArrayBuffer>

                                                    input key material

                                                    +
                                                  • salt: Uint8Array<ArrayBuffer>

                                                    salt

                                                    +
                                                  • info: Uint8Array<ArrayBuffer>

                                                    info

                                                    +
                                                  • keylen: number

                                                    output key length in octets

                                                    +

                                                  Returns Promise<Uint8Array<ArrayBuffer>>

                                                  generated key

                                                  +

                                                Settings

                                                Member Visibility
                                                diff --git a/docs/typedoc/_whiteflagprotocol/crypto/hmac.html b/docs/typedoc/_whiteflagprotocol/crypto/hmac.html new file mode 100644 index 00000000..058df2e7 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/crypto/hmac.html @@ -0,0 +1,7 @@ +hmac | Whiteflag JavaScript Library
                                                Whiteflag JavaScript Library
                                                  Preparing search index...

                                                  Function hmac

                                                  • Function

                                                    Hash-Based Message Authentication Code function +hmac

                                                    +

                                                    Parameters

                                                    • rawKey: Uint8Array<ArrayBuffer>

                                                      the raw HMAC key

                                                      +
                                                    • message: Uint8Array<ArrayBuffer>

                                                      the message to authenticate

                                                      +
                                                    • algorithm: string = HASHALG

                                                      the hash algorithm to be used; default is SHA-256

                                                      +

                                                    Returns Promise<Uint8Array<ArrayBuffer>>

                                                    the message authentication code

                                                    +

                                                  Settings

                                                  Member Visibility
                                                  diff --git a/docs/typedoc/_whiteflagprotocol/main.html b/docs/typedoc/_whiteflagprotocol/main.html new file mode 100644 index 00000000..dcf954f9 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/main.html @@ -0,0 +1,49 @@ +@whiteflagprotocol/main | Whiteflag JavaScript Library
                                                  Whiteflag JavaScript Library
                                                    Preparing search index...

                                                    Module @whiteflagprotocol/main

                                                    WFJSL Main Interface

                                                    The Whiteflag JavaScript Library (WFJSL) is an implementation of the Whiteflag +Protocol written in TypeScript, +and compiled to JavaScript, +to support the development of Whiteflag-enabled applications in JavaScript.

                                                    +

                                                    The @whiteflagprotocol/main +package provides all classes and functions required to implement the Whiteflag +protocol. This should normally be the only dependency for projects +implementing Whiteflag.

                                                    +

                                                    This description provides a generic overview of the Whiteflag main package. +Please refer to the WFJSL TypeDoc documentation +for a detailed description of all classes and functions.

                                                    +

                                                    The Whiteflag message class WfMessage defined in the message module +represents a Whiteflag message.

                                                    +

                                                    This class extends the core Whiteflag message class WfCoreMessage by adding +metadata to the message, additional data conversions (such as to and from +JSON), and specific Whiteflag protocol features. This allows the class to be +used and integrated in larger functional applications in accordance with the +Whiteflag protocol specification.

                                                    +

                                                    A new message may be created using the constructor, or by using a static +factory method. For example, creating a new FreeText message (message +code F) and set the Text field, may be done as follows:

                                                    +
                                                    let wfMessage = new WfMessage('F');
+wfMessage.set('Text', 'Example text to be sent with the FreeText message');
+
                                                    + +

                                                    The encode() method encodes the message. It automatically verifies the fields +and values when encoding and decoding. Encoding and decoding are asynchronous, +meaning the functions return Promises. +Once encoded, the methods toHex() and toU8a() may be used to obtain the +encoded message as a hexadecimal string or a UInt8array, respectively.

                                                    +
                                                    await wfMessage.encode();
+const hexMessage = wfMessage.toHex();
+
                                                    + +

                                                    If a message is encoded, or decoded, the message is "final", meaning its +content cannot be changed. Decoding a message is done using a one of the +static factory methods such as fromHex(...) or fromU8a(...), since the +message type is probably not known before decoding.

                                                    +
                                                    wfMessage = await WfMessage.fromHex(hexMessage);
+
                                                    + +

                                                    Encryption and decryption is automatically performed upon encoding and +decoding, based on the value of the EncryptionIndicator field in the message +header.

                                                    +

                                                    Currently, only one version of the Whiteflag protocol has been developed. For +ease of implementation of future Whiteflag versions, WFJSL functions and +classes take the Whiteflag version into account. The available Whiteflag +versions are defined with the WfVersions enum.

                                                    +

                                                    Enumerations

                                                    WfVersion

                                                    Classes

                                                    WfMessage

                                                    Interfaces

                                                    WfMetaHeader

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    WFJSL Main Interface
                                                    Enumerations
                                                    Classes
                                                    Interfaces
                                                    diff --git a/docs/typedoc/_whiteflagprotocol/main/WfMessage.html b/docs/typedoc/_whiteflagprotocol/main/WfMessage.html new file mode 100644 index 00000000..86584a49 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/main/WfMessage.html @@ -0,0 +1,114 @@ +WfMessage | Whiteflag JavaScript Library
                                                    Whiteflag JavaScript Library
                                                      Preparing search index...

                                                      Class WfMessage

                                                      A Whiteflag message as defined by the Whiteflag specification +WfMessage

                                                      +

                                                      v1-draft.7

                                                      +

                                                      4 Message Format

                                                      +

                                                      This class extends the core Whiteflag message class by +adding metadata to the message, additional data conversions (such as to and +from JSON), and specific Whiteflag protocol features. This allows the class +to be used and integrated in larger functional applications in accordance +with the Whiteflag specification.

                                                      +

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      constructor +

                                                      Properties

                                                      meta +

                                                      Methods

                                                      decode +encode +get +getMeta +isEncoded +isValid +set +setMeta +toHex +toJSON +toObject +toString +toU8a +validate +fromBinary +fromHex +fromJSON +fromObject +fromU8a +

                                                      Constructors

                                                      Properties

                                                      meta: WfMetaHeader = {}

                                                      The message metadata required for processing the message

                                                      +

                                                      Methods

                                                      • Function

                                                        Encodes the message, making the contents final +encode

                                                        +

                                                        Parameters

                                                        • Optionalikm: Uint8Array<ArrayBufferLike>

                                                          the input key material to derive the encryption key, if the message is to be encrypted

                                                          +
                                                        • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                          the binary encoded originator address, if the message is to be encrypted

                                                          +
                                                        • Optionaliv: Uint8Array<ArrayBufferLike>

                                                          the initialisation vector, if required for the encryption method

                                                          +

                                                        Returns Promise<WfCoreMessage>

                                                        this Whitedlag message object with the encoded message

                                                        +
                                                      • Function

                                                        Returns the value of the specified message field +get

                                                        +

                                                        Parameters

                                                        • fieldName: string

                                                          the name of the message field

                                                          +

                                                        Returns string | null

                                                        the value of the message field

                                                        +
                                                      • Function

                                                        Returns the value of the metaheader field +getMeta

                                                        +

                                                        Parameters

                                                        • fieldName: string

                                                          the name of the metaheader field

                                                          +

                                                        Returns string | null

                                                        the value of the metaheader field

                                                        +
                                                      • Function

                                                        Indicates if the message is valid, i.e. if all fields contain valid values +isValid

                                                        +

                                                        Returns boolean

                                                        true if message is valid, else false

                                                        +
                                                      • Function

                                                        Sets the value of the specified message field, if the message has not been encoded +set

                                                        +

                                                        Parameters

                                                        • fieldName: string

                                                          the name of the message field

                                                          +
                                                        • value: string

                                                          the value to set

                                                          +

                                                        Returns boolean

                                                        true if succesful, else false

                                                        +
                                                      • Function

                                                        Sets the value of the specified metaheader field +setMeta

                                                        +

                                                        Parameters

                                                        • fieldName: string

                                                          the name of the metaheader field

                                                          +
                                                        • value: string

                                                          the value to set

                                                          +

                                                        Returns boolean

                                                        true if succesful, else false

                                                        +
                                                      • Function

                                                        Returns the Whiteflag message encoded as a hexadecimal string +toHex

                                                        +

                                                        Returns string

                                                        a hexadecimal string with the encoded message

                                                        +
                                                      • Function

                                                        Returns the Whiteflag message as a plain object +toObject

                                                        +

                                                        Returns string

                                                        the message as a plain object

                                                        +
                                                      • Function

                                                        Returns the encoded Whiteflag message as a UInt8array +toU8a

                                                        +

                                                        Returns Uint8Array

                                                        a UInt8array with the encoded message

                                                        +
                                                      • Function

                                                        Creates new Whiteflag message from a binary buffer +fromBinary

                                                        +

                                                        Parameters

                                                        • message: BinaryBuffer

                                                          a binary buffer with the encoded message

                                                          +
                                                        • Optionalikm: Uint8Array<ArrayBufferLike>

                                                          the input key material to derive the encryption key, if the message is encrypted

                                                          +
                                                        • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                          the binary encoded originator address, if the message is encrypted

                                                          +
                                                        • Optionaliv: Uint8Array<ArrayBufferLike>

                                                          the initialisation vector, if required for the encryption method

                                                          +

                                                        Returns Promise<WfCoreMessage>

                                                        a new Whiteflag message object with the decoded message

                                                        +

                                                      • Creates new Whiteflag message from a hexadecimal encoded string

                                                        +

                                                        Parameters

                                                        • message: string

                                                          atring with the hexadecimal encoded message

                                                          +
                                                        • Optionalikm: string

                                                          the hexadecimalinput key material to derive the encryption key, if the message is encrypted

                                                          +
                                                        • Optionaladdress: string

                                                          the hexadecimal encoded originator address, if the message is encrypted

                                                          +
                                                        • Optionaliv: string

                                                          the hexadecimal initialisation vector, if required for the encryption method

                                                          +

                                                        Returns Promise<WfCoreMessage>

                                                        a new Whiteflag message object with the decoded message

                                                        +
                                                      • Function

                                                        Creates new Whiteflag message from a plain object +fromObject

                                                        +

                                                        Parameters

                                                        • message: string

                                                          a plain JavaScript object with message header and body

                                                          +

                                                        Returns Promise<WfMessage>

                                                        a new Whiteflag message

                                                        +

                                                        if message could not be created

                                                        +

                                                      • Creates new Whiteflag message from a binary encoded message

                                                        +

                                                        Parameters

                                                        • message: Uint8Array

                                                          a Uint8Array with the binary encoded message

                                                          +
                                                        • Optionalikm: Uint8Array<ArrayBufferLike>

                                                          the input key material to derive the encryption key, if the message is encrypted

                                                          +
                                                        • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                          the binary encoded originator address, if the message is encrypted

                                                          +
                                                        • Optionaliv: Uint8Array<ArrayBufferLike>

                                                          the initialisation vector, if required for the encryption method

                                                          +

                                                        Returns Promise<WfCoreMessage>

                                                        a new Whiteflag message object with the decoded message

                                                        +

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      Methods
                                                      diff --git a/docs/typedoc/_whiteflagprotocol/main/WfMetaHeader.html b/docs/typedoc/_whiteflagprotocol/main/WfMetaHeader.html new file mode 100644 index 00000000..3f3e3318 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/main/WfMetaHeader.html @@ -0,0 +1,23 @@ +WfMetaHeader | Whiteflag JavaScript Library
                                                      Whiteflag JavaScript Library
                                                        Preparing search index...

                                                        Interface WfMetaHeader

                                                        Defines a Whiteflag message header object +WfMetaHeader

                                                        +
                                                        interface WfMetaHeader {
                                                            autoGenerated?: string;
                                                            blockchain?: string;
                                                            blockDepth?: number;
                                                            blockNumber?: number;
                                                            confirmed?: boolean;
                                                            encodedMessage?: string;
                                                            encryptionInitVector?: string;
                                                            encryptionKeyInput?: string;
                                                            formatValid?: boolean;
                                                            originatorAddress?: string;
                                                            originatorPubKey?: string;
                                                            originatorValid?: boolean;
                                                            recipientAddress?: string;
                                                            referenceValid?: boolean;
                                                            transactionHash?: string;
                                                            transactionIndex?: number;
                                                            transactionTime?: string;
                                                            transceiveDirection?: string;
                                                            transmissionSuccess?: boolean;
                                                            validationErrors?: string[];
                                                            [key: string]: any;
                                                        }

                                                        Indexable

                                                        • [key: string]: any
                                                        Index

                                                        Properties

                                                        autoGenerated? +blockchain? +blockDepth? +blockNumber? +confirmed? +encodedMessage? +encryptionInitVector? +encryptionKeyInput? +formatValid? +originatorAddress? +originatorPubKey? +originatorValid? +recipientAddress? +referenceValid? +transactionHash? +transactionIndex? +transactionTime? +transceiveDirection? +transmissionSuccess? +validationErrors? +

                                                        Properties

                                                        autoGenerated?: string
                                                        blockchain?: string
                                                        blockDepth?: number
                                                        blockNumber?: number
                                                        confirmed?: boolean
                                                        encodedMessage?: string
                                                        encryptionInitVector?: string
                                                        encryptionKeyInput?: string
                                                        formatValid?: boolean
                                                        originatorAddress?: string
                                                        originatorPubKey?: string
                                                        originatorValid?: boolean
                                                        recipientAddress?: string
                                                        referenceValid?: boolean
                                                        transactionHash?: string
                                                        transactionIndex?: number
                                                        transactionTime?: string
                                                        transceiveDirection?: string
                                                        transmissionSuccess?: boolean
                                                        validationErrors?: string[]

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Properties
                                                        diff --git a/docs/typedoc/_whiteflagprotocol/main/WfVersion.html b/docs/typedoc/_whiteflagprotocol/main/WfVersion.html new file mode 100644 index 00000000..596f98a3 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/main/WfVersion.html @@ -0,0 +1,5 @@ +WfVersion | Whiteflag JavaScript Library
                                                        Whiteflag JavaScript Library
                                                          Preparing search index...

                                                          Enumeration WfVersion

                                                          Defines Whiteflag versions +WfVersion

                                                          +
                                                          Index

                                                          Enumeration Members

                                                          v1 +

                                                          Enumeration Members

                                                          v1: "1"

                                                          Whiteflag version 1

                                                          +

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Enumeration Members
                                                          diff --git a/docs/typedoc/_whiteflagprotocol/util.html b/docs/typedoc/_whiteflagprotocol/util.html new file mode 100644 index 00000000..3dc80703 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util.html @@ -0,0 +1,92 @@ +@whiteflagprotocol/util | Whiteflag JavaScript Library
                                                          Whiteflag JavaScript Library
                                                            Preparing search index...

                                                            Module @whiteflagprotocol/util

                                                            WFJSL Utility Classes and Functions

                                                            The Whiteflag JavaScript Library (WFJSL) is an implementation of the Whiteflag +Protocol written in TypeScript, +and compiled to JavaScript, +to support the development of Whiteflag-enabled applications in JavaScript.

                                                            +

                                                            The @whiteflagprotocol/util +package provides common utilities for other Whiteflag packages. These +utilities include common data conversions, generic helper functions, etc. +for other Whiteflag packages. It should normally not be necessary to add this +package as a dependency, but its functionality might be useful for other +purposes.

                                                            +

                                                            This description provides a generic overview of the WFJSL utility package. +Please see the WFJSL TypeDoc documentation +for a detailed description of all classes and functions.

                                                            +

                                                            The binary module of the Whiteflag utility package provides the +BinaryBuffer class. Objects of this class represent a binary encoded piece +of data, e.g. a Whiteflag message, that can be manipulated at bit level.

                                                            +

                                                            Static methods to create a binary buffer:

                                                            +
                                                              +
                                                            • BinaryBuffer.empty(): creates an empty binary buffer
                                                              • +
                                                            • BinaryBuffer.from(...): creates a binary buffer from another binary buffer
                                                              • +
                                                            • BinaryBuffer.fromBytes(...): creates a binary buffer from bytes in a number array
                                                              • +
                                                            • BinaryBuffer.fromHex(...): creates a binary buffer from a hexadecimal string
                                                              • +
                                                            • BinaryBuffer.fromU8a(...): creates a binary buffer from a Uint8Array
                                                              • +
                                                            +

                                                            Public methods to manipulate a binary buffer:

                                                            +
                                                              +
                                                            • BinaryBuffer.append(...): appends another binary buffer to the end of the binary buffer
                                                              • +
                                                            • BinaryBuffer.crop(...): shortens the binary buffer to the length of the specified bits
                                                              • +
                                                            • BinaryBuffer.extract(...): extracts the specified bits from the binary buffer
                                                              • +
                                                            • BinaryBuffer.insert(...): inserts another binary buffer at the start of the binary buffer
                                                              • +
                                                            • BinaryBuffer.shiftLeft(...): shifts bits in the buffer to the left, shrinking the buffer
                                                              • +
                                                            • BinaryBuffer.shiftRight(...): shifts bits in the buffer to the right, enlarging the buffer
                                                              • +
                                                            +

                                                            Some of these functions have an equivalent that allow to use a different +binary representation, e.g. appendHex(...) or insertU8a(...).

                                                            +

                                                            The encoding module provides generic functions to convert data +from one encoding to another.

                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            EncodingDescriptionConverts to
                                                            Base64a string with a 64-character binary-to-text encodingBase64url
                                                            Base64urla string with a URL-safe 64-character binary-to-text encodingBase64, Hexadecimal, String, UInt8Array
                                                            Hexadecimala string with a hexadecimal representation of a binaryBase64url, String, UInt8Array
                                                            Objecta plain JavaScript objectBase64url
                                                            Texta string with UTF-8 charactersBase64url, Hexadecimal, UInt8Array
                                                            UInt8Arrayan array of bytes representing a binary encodingBase64url, Hexadecimal, String
                                                            +

                                                            For example hexToB64u(...) creates a base64url encoded string from a +hexadecimal string. The module also provides some additional helper functions +for different data encodings:

                                                            +
                                                              +
                                                            • isObject(...) checks if something is an object
                                                              • +
                                                            • isString(...) checks if something is a string
                                                              • +
                                                            • isBase64(...) checks if a string is base64 encoded
                                                              • +
                                                            • isBase64u(...) checks if a string is base64url encoded
                                                              • +
                                                            • isHex(...) checks if a string is hexadecimal encoded
                                                              • +
                                                            • noHexPrefix(...) removes the '0x' hex prefix if present
                                                              • +
                                                            +

                                                            Whiteflag uses JSON Web Signatures (JWS). To create, sign and convert JWSs +the jws module provides a common Jws class to other Whiteflag packages.

                                                            +

                                                            Classes

                                                            BinaryBuffer
                                                            Jws

                                                            Functions

                                                            b64ToB64u
                                                            b64uToB64
                                                            b64uToHex
                                                            b64uToObj
                                                            b64uToString
                                                            b64uToU8a
                                                            cropBits
                                                            hexToB64u
                                                            hexToString
                                                            hexToU8a
                                                            isBase64
                                                            isBase64u
                                                            isHex
                                                            isObject
                                                            isString
                                                            noHexPrefix
                                                            objToB64u
                                                            shiftLeft
                                                            shiftRight
                                                            stringToB64u
                                                            stringToHex
                                                            stringToU8a
                                                            u8aToB64u
                                                            u8aToHex
                                                            u8aToString

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            WFJSL Utility Classes and Functions
                                                            Classes
                                                            Functions
                                                            diff --git a/docs/typedoc/_whiteflagprotocol/util/BinaryBuffer.html b/docs/typedoc/_whiteflagprotocol/util/BinaryBuffer.html new file mode 100644 index 00000000..233af4c9 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/BinaryBuffer.html @@ -0,0 +1,116 @@ +BinaryBuffer | Whiteflag JavaScript Library
                                                            Whiteflag JavaScript Library
                                                              Preparing search index...

                                                              Class BinaryBuffer

                                                              A class representing a binary buffer +BinaryBuffer

                                                              +

                                                              Objects of this class represent a binary encoded piece of data, +e.g. a Whiteflag message, that can be manipulated at bit level. This class +provides the basic (not Whiteflag-specific) functionality for other +Whiteflag packages to encode and decode binary Whiteflag messages.

                                                              +
                                                              Index

                                                              Properties

                                                              length +

                                                              Methods

                                                              append +appendBytes +appendHex +appendU8a +crop +extract +extractHex +extractU8a +insertBytes +insertHex +insertU8a +shiftLeft +shiftRight +toHex +toU8a +empty +from +fromBytes +fromHex +fromU8a +

                                                              Properties

                                                              length: number

                                                              The number of used bits in the buffer

                                                              +

                                                              Methods

                                                              • Function

                                                                Appends bytes from a number array to the binary buffer +appendBytes

                                                                +

                                                                Parameters

                                                                • byteArray: number[]

                                                                  an array of numbers representing bytes

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to append

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Appends a hexadecimal string to the binary buffer +appendHex

                                                                +

                                                                Parameters

                                                                • hexString: string

                                                                  a hexadecimal string

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to append

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Appends a Uint8Array to the binary buffer +appendU8a

                                                                +

                                                                Parameters

                                                                • u8array: Uint8Array

                                                                  an array of 8-bit unsigned integers

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to append

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Shortens the binary buffer to the length of the specified bits +crop

                                                                +

                                                                Parameters

                                                                • nBits: number

                                                                  the number of used bits, or, if negative, the number of bits to remove

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +

                                                              • Extracts the specified bits from the binary buffer

                                                                +

                                                                Parameters

                                                                • startBit: number

                                                                  the first bit to extract (inclusive)

                                                                  +
                                                                • endBit: number = -1

                                                                  the final bit of the extraction (exclusive), negative means until end of buffer

                                                                  +

                                                                Returns BinaryBuffer

                                                                a new binary buffer with the extracted bits

                                                                +

                                                              • Extracts the specified bits from the binary buffer to a hexadecimal string

                                                                +

                                                                Parameters

                                                                • startBit: number

                                                                  the first bit to extract (inclusive)

                                                                  +
                                                                • endBit: number = -1

                                                                  the final bit of the extraction (exclusive), negative means until end of buffer

                                                                  +

                                                                Returns string

                                                                a hexadecimal string with the extracted data

                                                                +
                                                              • Function

                                                                Extracts the specified bits from the binary buffer to a Uint8Array +extractU8a

                                                                +

                                                                Parameters

                                                                • startBit: number

                                                                  the first bit to extract (inclusive)

                                                                  +
                                                                • endBit: number = -1

                                                                  the final bit of the extraction (exclusive), negative means until end of buffer

                                                                  +

                                                                Returns Uint8Array

                                                                an array of 8-bit unsigned integers with the extracted data

                                                                +
                                                              • Function

                                                                Inserts bytes from a number array at the start of the binary buffer +insertBytes

                                                                +

                                                                Parameters

                                                                • byteArray: number[]

                                                                  an array of numbers representing bytes

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to insert

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Inserts a hexadecimal string at the start of the binary buffer +insertHex

                                                                +

                                                                Parameters

                                                                • hexString: string

                                                                  a hexadecimal string

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to insert

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Inserts a Uint8Array at the start of the binary buffer +insertU8a

                                                                +

                                                                Parameters

                                                                • u8array: Uint8Array

                                                                  an array of 8-bit unsigned integers

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits to insert

                                                                  +

                                                                Returns BinaryBuffer

                                                                the updated binary buffer

                                                                +
                                                              • Function

                                                                Shifts bits in the buffer to the left, shrinking the buffer +shiftLeft

                                                                +

                                                                Parameters

                                                                • shift: number

                                                                  the number of bits to shift to the left

                                                                  +

                                                                Returns BinaryBuffer

                                                                the shifted binary buffer

                                                                +
                                                              • Function

                                                                Shifts bits in the buffer to the right, enlarging the buffer +shiftRight

                                                                +

                                                                Parameters

                                                                • shift: number

                                                                  the number of bits to shift to the right

                                                                  +

                                                                Returns BinaryBuffer

                                                                the shifted binary buffer

                                                                +
                                                              • Function

                                                                Gives the value of the binary buffer as a hexadecimal string +toHex

                                                                +

                                                                Returns string

                                                                a hexadecimal string

                                                                +
                                                              • Function

                                                                Gives the value of the binary buffer as a Uint8Array +toU8a

                                                                +

                                                                Returns Uint8Array

                                                                an array of 8-bit unsigned integers

                                                                +
                                                              • Function

                                                                Creates a binary buffer from bytes in a number array +fromBytes

                                                                +

                                                                Parameters

                                                                • byteArray: number[]

                                                                  an array of numbers representing bytes

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits

                                                                  +

                                                                Returns BinaryBuffer

                                                                a new binary buffer

                                                                +
                                                              • Function

                                                                Creates a binary buffer from a hexadecimal string +fromHex

                                                                +

                                                                Parameters

                                                                • hexString: string

                                                                  a hexadecimal string

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits

                                                                  +

                                                                Returns BinaryBuffer

                                                                a new binary buffer

                                                                +
                                                              • Function

                                                                Creates a binary buffer from a Uint8Array +fromU8a

                                                                +

                                                                Parameters

                                                                • u8array: Uint8Array

                                                                  an array of 8-bit unsigned integers

                                                                  +
                                                                • nBits: number = 0

                                                                  the number of used bits

                                                                  +

                                                                Returns BinaryBuffer

                                                                a new binary buffer

                                                                +

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Properties
                                                              Methods
                                                              diff --git a/docs/typedoc/_whiteflagprotocol/util/Jws.html b/docs/typedoc/_whiteflagprotocol/util/Jws.html new file mode 100644 index 00000000..fe1fc5f7 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/Jws.html @@ -0,0 +1,56 @@ +Jws | Whiteflag JavaScript Library
                                                              Whiteflag JavaScript Library
                                                                Preparing search index...

                                                                Class Jws

                                                                A class representing a JSON Web Token (JWS) +Jws

                                                                +

                                                                Whiteflag uses JSON Web Signatures (JWS) for one of its +authentication methods. This class provides the basic (not Whiteflag- +specific) functionality to create, sign and convert JWSs for other +Whiteflag packages.

                                                                +
                                                                Index

                                                                Methods

                                                                getSignature +getSignInput +isSigned +setSignAlgorithm +setSignature +toCompact +toFlat +toFull +fromCompact +fromObject +fromPayload +

                                                                Methods

                                                                • Function

                                                                  Returns the JWS signature +getSignature

                                                                  +

                                                                  Returns string

                                                                  a string with the the JWS signature

                                                                  +
                                                                • Function

                                                                  Returns the JWS signature input +getSignInput

                                                                  +

                                                                  Returns string

                                                                  a string with the input to be signed by the signing algorithm

                                                                  +
                                                                • Function

                                                                  Indicates if the JWS has been signed +isSigned

                                                                  +

                                                                  Returns boolean

                                                                  true if signed, else false

                                                                  +
                                                                • Function

                                                                  Sets the identifier of the signing algorithm, if not yet signed +setSignAlgorithm

                                                                  +

                                                                  Parameters

                                                                  • algorithm: string

                                                                    the identifier of the algorithm used to sign the payload

                                                                    +

                                                                  Returns boolean

                                                                  true if identifier could be set, false if already signed

                                                                  +
                                                                • Function

                                                                  Sets the signature, if not yet signed +setSignature

                                                                  +

                                                                  Parameters

                                                                  • signature: string

                                                                    the base64url encoded signature

                                                                    +

                                                                  Returns boolean

                                                                  true if signature could be added, false if already signed

                                                                  +
                                                                • Function

                                                                  Return a compact serialised JWS as a compact serialized string +toCompact

                                                                  +

                                                                  Returns string

                                                                  the JWS as a compact serialized JWS string

                                                                  +
                                                                • Function

                                                                  Returns a flattened JWS +toFlat

                                                                  +

                                                                  Returns Object

                                                                  the JWS as a flattened JWS plain JavaScript object

                                                                  +
                                                                • Function

                                                                  Returns a full JWS +toFull

                                                                  +

                                                                  Returns Object

                                                                  the JWS as a full JWS plain JavaScript object

                                                                  +
                                                                • Function

                                                                  Creates a new JWS object from a compact serialised JWS string +fromCompact

                                                                  +

                                                                  Parameters

                                                                  • jws: string

                                                                    a compact serialised JWS string

                                                                    +

                                                                  Returns Jws

                                                                  a new JWS object

                                                                  +
                                                                • Function

                                                                  Creates a new JWS object from a plain javaScript object +fromObject

                                                                  +

                                                                  Parameters

                                                                  • jws: any

                                                                    a plain object

                                                                    +

                                                                  Returns Jws

                                                                  a new JWS object

                                                                  +
                                                                • Function

                                                                  Creates a new JWS from a payload +fromPayload

                                                                  +

                                                                  Parameters

                                                                  • payload: Object

                                                                    the JWS payload

                                                                    +

                                                                  Returns Jws

                                                                  a new Binary Array

                                                                  +

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Methods
                                                                diff --git a/docs/typedoc/_whiteflagprotocol/util/b64ToB64u.html b/docs/typedoc/_whiteflagprotocol/util/b64ToB64u.html new file mode 100644 index 00000000..7940a8db --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64ToB64u.html @@ -0,0 +1,5 @@ +b64ToB64u | Whiteflag JavaScript Library
                                                                Whiteflag JavaScript Library
                                                                  Preparing search index...

                                                                  Function b64ToB64u

                                                                  • Function

                                                                    Convert base64 to base64url +base64

                                                                    +

                                                                    Parameters

                                                                    • base64: string

                                                                      a base64 encoded string

                                                                      +

                                                                    Returns string

                                                                    a base64url encoded string

                                                                    +

                                                                  Settings

                                                                  Member Visibility
                                                                  diff --git a/docs/typedoc/_whiteflagprotocol/util/b64uToB64.html b/docs/typedoc/_whiteflagprotocol/util/b64uToB64.html new file mode 100644 index 00000000..e97a8b3b --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64uToB64.html @@ -0,0 +1,5 @@ +b64uToB64 | Whiteflag JavaScript Library
                                                                  Whiteflag JavaScript Library
                                                                    Preparing search index...

                                                                    Function b64uToB64

                                                                    • Function

                                                                      Convert base64url to base64 +base64u

                                                                      +

                                                                      Parameters

                                                                      • base64u: string

                                                                        a base64url encoded string

                                                                        +

                                                                      Returns string

                                                                      a base64 encoded string

                                                                      +

                                                                    Settings

                                                                    Member Visibility
                                                                    diff --git a/docs/typedoc/_whiteflagprotocol/util/b64uToHex.html b/docs/typedoc/_whiteflagprotocol/util/b64uToHex.html new file mode 100644 index 00000000..e306779f --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64uToHex.html @@ -0,0 +1,5 @@ +b64uToHex | Whiteflag JavaScript Library
                                                                    Whiteflag JavaScript Library
                                                                      Preparing search index...

                                                                      Function b64uToHex

                                                                      • Function

                                                                        Creates hexadecimal string from a base64url encoded string +b64uToHex

                                                                        +

                                                                        Parameters

                                                                        • b64uString: string

                                                                          a base64url encoded string

                                                                          +

                                                                        Returns string

                                                                        a hexadecimal encoded string

                                                                        +

                                                                      Settings

                                                                      Member Visibility
                                                                      diff --git a/docs/typedoc/_whiteflagprotocol/util/b64uToObj.html b/docs/typedoc/_whiteflagprotocol/util/b64uToObj.html new file mode 100644 index 00000000..f1daec6a --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64uToObj.html @@ -0,0 +1,5 @@ +b64uToObj | Whiteflag JavaScript Library
                                                                      Whiteflag JavaScript Library
                                                                        Preparing search index...

                                                                        Function b64uToObj

                                                                        • Function

                                                                          Creates an object from a base64URL encoded JSON string +b64uToObj

                                                                          +

                                                                          Parameters

                                                                          • base64u: string

                                                                            a base64URL encoded JSON string

                                                                            +

                                                                          Returns Object

                                                                          an object with the data from the JSON object

                                                                          +

                                                                        Settings

                                                                        Member Visibility
                                                                        diff --git a/docs/typedoc/_whiteflagprotocol/util/b64uToString.html b/docs/typedoc/_whiteflagprotocol/util/b64uToString.html new file mode 100644 index 00000000..5895d1db --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64uToString.html @@ -0,0 +1,5 @@ +b64uToString | Whiteflag JavaScript Library
                                                                        Whiteflag JavaScript Library
                                                                          Preparing search index...

                                                                          Function b64uToString

                                                                          • Function

                                                                            Creates a standard string from a base64url encoded string +b64uToString

                                                                            +

                                                                            Parameters

                                                                            • b64uString: string

                                                                              a base64url encoded string

                                                                              +

                                                                            Returns string

                                                                            a standard string

                                                                            +

                                                                          Settings

                                                                          Member Visibility
                                                                          diff --git a/docs/typedoc/_whiteflagprotocol/util/b64uToU8a.html b/docs/typedoc/_whiteflagprotocol/util/b64uToU8a.html new file mode 100644 index 00000000..8a3deb6a --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/b64uToU8a.html @@ -0,0 +1,5 @@ +b64uToU8a | Whiteflag JavaScript Library
                                                                          Whiteflag JavaScript Library
                                                                            Preparing search index...

                                                                            Function b64uToU8a

                                                                            • Function

                                                                              Creates a UInt8 typed array from a base64url encoded string +b64uToU8a

                                                                              +

                                                                              Parameters

                                                                              • b64uString: string

                                                                                a base64url encoded string

                                                                                +

                                                                              Returns Uint8Array

                                                                              a UInt8 typed array

                                                                              +

                                                                            Settings

                                                                            Member Visibility
                                                                            diff --git a/docs/typedoc/_whiteflagprotocol/util/cropBits.html b/docs/typedoc/_whiteflagprotocol/util/cropBits.html new file mode 100644 index 00000000..66b34e0b --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/cropBits.html @@ -0,0 +1,6 @@ +cropBits | Whiteflag JavaScript Library
                                                                            Whiteflag JavaScript Library
                                                                              Preparing search index...

                                                                              Function cropBits

                                                                              • Function

                                                                                Shortens a Uint8Array to the length of the specified bits +cropBits

                                                                                +

                                                                                Parameters

                                                                                • u8array: Uint8Array

                                                                                  the Uint8Array containing the bitset

                                                                                  +
                                                                                • nBits: number

                                                                                  the number of used bits, or, if negative, the number of bits to remove

                                                                                  +

                                                                                Returns Uint8Array

                                                                                a new Uint8Array with the unused bits cleared

                                                                                +

                                                                              Settings

                                                                              Member Visibility
                                                                              diff --git a/docs/typedoc/_whiteflagprotocol/util/hexToB64u.html b/docs/typedoc/_whiteflagprotocol/util/hexToB64u.html new file mode 100644 index 00000000..23d776ce --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/hexToB64u.html @@ -0,0 +1,5 @@ +hexToB64u | Whiteflag JavaScript Library
                                                                              Whiteflag JavaScript Library
                                                                                Preparing search index...

                                                                                Function hexToB64u

                                                                                • Function

                                                                                  Creates a base64url encoded string from a hexadecimal string +hexToB64u

                                                                                  +

                                                                                  Parameters

                                                                                  • hexString: string

                                                                                    a hexadecimal string

                                                                                    +

                                                                                  Returns string

                                                                                  a base64url encoded string

                                                                                  +

                                                                                Settings

                                                                                Member Visibility
                                                                                diff --git a/docs/typedoc/_whiteflagprotocol/util/hexToString.html b/docs/typedoc/_whiteflagprotocol/util/hexToString.html new file mode 100644 index 00000000..7318724c --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/hexToString.html @@ -0,0 +1,5 @@ +hexToString | Whiteflag JavaScript Library
                                                                                Whiteflag JavaScript Library
                                                                                  Preparing search index...

                                                                                  Function hexToString

                                                                                  • Function

                                                                                    Creates a regular string from a hexadecimal string +hexToString

                                                                                    +

                                                                                    Parameters

                                                                                    • hexString: string

                                                                                      a hexadecimal string

                                                                                      +

                                                                                    Returns string

                                                                                    a regular string

                                                                                    +

                                                                                  Settings

                                                                                  Member Visibility
                                                                                  diff --git a/docs/typedoc/_whiteflagprotocol/util/hexToU8a.html b/docs/typedoc/_whiteflagprotocol/util/hexToU8a.html new file mode 100644 index 00000000..d04c5fc3 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/hexToU8a.html @@ -0,0 +1,5 @@ +hexToU8a | Whiteflag JavaScript Library
                                                                                  Whiteflag JavaScript Library
                                                                                    Preparing search index...

                                                                                    Function hexToU8a

                                                                                    • Function

                                                                                      Creates a UInt8 typed array from a hexadecimal string +hexToU8a

                                                                                      +

                                                                                      Parameters

                                                                                      • hexString: string

                                                                                        a hexadecimal string

                                                                                        +

                                                                                      Returns Uint8Array<ArrayBuffer>

                                                                                      an array of 8-bit unsigned integers

                                                                                      +

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    diff --git a/docs/typedoc/_whiteflagprotocol/util/isBase64.html b/docs/typedoc/_whiteflagprotocol/util/isBase64.html new file mode 100644 index 00000000..5a3fab42 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/isBase64.html @@ -0,0 +1,5 @@ +isBase64 | Whiteflag JavaScript Library
                                                                                    Whiteflag JavaScript Library
                                                                                      Preparing search index...

                                                                                      Function isBase64

                                                                                      • Function

                                                                                        Checks if a string is base64 encoded +isBase64

                                                                                        +

                                                                                        Parameters

                                                                                        • base64: string

                                                                                          a string that might be base64 encoded

                                                                                          +

                                                                                        Returns boolean

                                                                                        true if base64 encoded, else false

                                                                                        +

                                                                                      Settings

                                                                                      Member Visibility
                                                                                      diff --git a/docs/typedoc/_whiteflagprotocol/util/isBase64u.html b/docs/typedoc/_whiteflagprotocol/util/isBase64u.html new file mode 100644 index 00000000..170cf1fa --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/isBase64u.html @@ -0,0 +1,5 @@ +isBase64u | Whiteflag JavaScript Library
                                                                                      Whiteflag JavaScript Library
                                                                                        Preparing search index...

                                                                                        Function isBase64u

                                                                                        • Function

                                                                                          Checks if a string is base64url encoded +isBase64u

                                                                                          +

                                                                                          Parameters

                                                                                          • base64u: string

                                                                                            a string that might be base64url encoded

                                                                                            +

                                                                                          Returns boolean

                                                                                          true if base64url encoded, else false

                                                                                          +

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        diff --git a/docs/typedoc/_whiteflagprotocol/util/isHex.html b/docs/typedoc/_whiteflagprotocol/util/isHex.html new file mode 100644 index 00000000..c886ee61 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/isHex.html @@ -0,0 +1,5 @@ +isHex | Whiteflag JavaScript Library
                                                                                        Whiteflag JavaScript Library
                                                                                          Preparing search index...

                                                                                          Function isHex

                                                                                          • Function

                                                                                            Checks if a string is hexadecimal encoded +hexString

                                                                                            +

                                                                                            Parameters

                                                                                            • hexString: string

                                                                                              a string that might be hexadecimal encoded

                                                                                              +

                                                                                            Returns boolean

                                                                                            true if hexadecimal encoded, else false

                                                                                            +

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          diff --git a/docs/typedoc/_whiteflagprotocol/util/isObject.html b/docs/typedoc/_whiteflagprotocol/util/isObject.html new file mode 100644 index 00000000..dd532ad2 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/isObject.html @@ -0,0 +1,5 @@ +isObject | Whiteflag JavaScript Library
                                                                                          Whiteflag JavaScript Library
                                                                                            Preparing search index...

                                                                                            Function isObject

                                                                                            • Function

                                                                                              Checks if something is an object +isObject

                                                                                              +

                                                                                              Parameters

                                                                                              • obj: any

                                                                                                something that might be an object

                                                                                                +

                                                                                              Returns boolean

                                                                                              true if object, else false

                                                                                              +

                                                                                            Settings

                                                                                            Member Visibility
                                                                                            diff --git a/docs/typedoc/_whiteflagprotocol/util/isString.html b/docs/typedoc/_whiteflagprotocol/util/isString.html new file mode 100644 index 00000000..375c1c62 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/isString.html @@ -0,0 +1,5 @@ +isString | Whiteflag JavaScript Library
                                                                                            Whiteflag JavaScript Library
                                                                                              Preparing search index...

                                                                                              Function isString

                                                                                              • Function

                                                                                                Checks if something is a string +isString

                                                                                                +

                                                                                                Parameters

                                                                                                • charString: any

                                                                                                  something that might be a string

                                                                                                  +

                                                                                                Returns boolean

                                                                                                true if string, else false

                                                                                                +

                                                                                              Settings

                                                                                              Member Visibility
                                                                                              diff --git a/docs/typedoc/_whiteflagprotocol/util/noHexPrefix.html b/docs/typedoc/_whiteflagprotocol/util/noHexPrefix.html new file mode 100644 index 00000000..92afa0ec --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/noHexPrefix.html @@ -0,0 +1,5 @@ +noHexPrefix | Whiteflag JavaScript Library
                                                                                              Whiteflag JavaScript Library
                                                                                                Preparing search index...

                                                                                                Function noHexPrefix

                                                                                                • Function

                                                                                                  Removes the '0x' hex prefix if present +hexString

                                                                                                  +

                                                                                                  Parameters

                                                                                                  • hexString: string

                                                                                                    a hexadecimal encoded string

                                                                                                    +

                                                                                                  Returns string

                                                                                                  the the string without the hex prefix

                                                                                                  +

                                                                                                Settings

                                                                                                Member Visibility
                                                                                                diff --git a/docs/typedoc/_whiteflagprotocol/util/objToB64u.html b/docs/typedoc/_whiteflagprotocol/util/objToB64u.html new file mode 100644 index 00000000..1726b454 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/objToB64u.html @@ -0,0 +1,5 @@ +objToB64u | Whiteflag JavaScript Library
                                                                                                Whiteflag JavaScript Library
                                                                                                  Preparing search index...

                                                                                                  Function objToB64u

                                                                                                  • Function

                                                                                                    Creates a base64URL encoded JSON string from an object +objToB64u

                                                                                                    +

                                                                                                    Parameters

                                                                                                    • obj: Object

                                                                                                      the object to be encoded

                                                                                                      +

                                                                                                    Returns string

                                                                                                    a base64URL encoded JSON string

                                                                                                    +

                                                                                                  Settings

                                                                                                  Member Visibility
                                                                                                  diff --git a/docs/typedoc/_whiteflagprotocol/util/shiftLeft.html b/docs/typedoc/_whiteflagprotocol/util/shiftLeft.html new file mode 100644 index 00000000..b7bb6d69 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/shiftLeft.html @@ -0,0 +1,6 @@ +shiftLeft | Whiteflag JavaScript Library
                                                                                                  Whiteflag JavaScript Library
                                                                                                    Preparing search index...

                                                                                                    Function shiftLeft

                                                                                                    • Function

                                                                                                      Shifts bits in a Uint8Array to the left modulo 8 +shiftLeft

                                                                                                      +

                                                                                                      Parameters

                                                                                                      • u8array: Uint8Array

                                                                                                        the Uint8Array to be left shifted

                                                                                                        +
                                                                                                      • shift: number

                                                                                                        the nummber of bits to be left shifted by modulo 8 bits

                                                                                                        +

                                                                                                      Returns Uint8Array

                                                                                                      a new Uint8Array with the left shifted bits

                                                                                                      +

                                                                                                    Settings

                                                                                                    Member Visibility
                                                                                                    diff --git a/docs/typedoc/_whiteflagprotocol/util/shiftRight.html b/docs/typedoc/_whiteflagprotocol/util/shiftRight.html new file mode 100644 index 00000000..0e18ac19 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/shiftRight.html @@ -0,0 +1,6 @@ +shiftRight | Whiteflag JavaScript Library
                                                                                                    Whiteflag JavaScript Library
                                                                                                      Preparing search index...

                                                                                                      Function shiftRight

                                                                                                      • Function

                                                                                                        Shifts bits in a Uint8Array to the right modulo 8 +shiftRight

                                                                                                        +

                                                                                                        Parameters

                                                                                                        • u8array: Uint8Array

                                                                                                          the Uint8Array to be right shifted

                                                                                                          +
                                                                                                        • shift: number

                                                                                                          the nummber of bits to be right shifted by modulo 8 bits

                                                                                                          +

                                                                                                        Returns Uint8Array

                                                                                                        a new Uint8Array with the right shifted bits

                                                                                                        +

                                                                                                      Settings

                                                                                                      Member Visibility
                                                                                                      diff --git a/docs/typedoc/_whiteflagprotocol/util/stringToB64u.html b/docs/typedoc/_whiteflagprotocol/util/stringToB64u.html new file mode 100644 index 00000000..082d545a --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/stringToB64u.html @@ -0,0 +1,5 @@ +stringToB64u | Whiteflag JavaScript Library
                                                                                                      Whiteflag JavaScript Library
                                                                                                        Preparing search index...

                                                                                                        Function stringToB64u

                                                                                                        • Function

                                                                                                          Creates a base64url encoded string from a regular string +stringToB64u

                                                                                                          +

                                                                                                          Parameters

                                                                                                          • charString: string

                                                                                                            a regular character string

                                                                                                            +

                                                                                                          Returns string

                                                                                                          a base64url encoded string

                                                                                                          +

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        diff --git a/docs/typedoc/_whiteflagprotocol/util/stringToHex.html b/docs/typedoc/_whiteflagprotocol/util/stringToHex.html new file mode 100644 index 00000000..ba40eef0 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/stringToHex.html @@ -0,0 +1,5 @@ +stringToHex | Whiteflag JavaScript Library
                                                                                                        Whiteflag JavaScript Library
                                                                                                          Preparing search index...

                                                                                                          Function stringToHex

                                                                                                          • Function

                                                                                                            Creates a hexadecimal string from a regular string +stringToHex

                                                                                                            +

                                                                                                            Parameters

                                                                                                            • charString: string

                                                                                                              a regular character string

                                                                                                              +

                                                                                                            Returns string

                                                                                                            a hexadecimal string

                                                                                                            +

                                                                                                          Settings

                                                                                                          Member Visibility
                                                                                                          diff --git a/docs/typedoc/_whiteflagprotocol/util/stringToU8a.html b/docs/typedoc/_whiteflagprotocol/util/stringToU8a.html new file mode 100644 index 00000000..a77e6efb --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/stringToU8a.html @@ -0,0 +1,5 @@ +stringToU8a | Whiteflag JavaScript Library
                                                                                                          Whiteflag JavaScript Library
                                                                                                            Preparing search index...

                                                                                                            Function stringToU8a

                                                                                                            • Function

                                                                                                              Creates a UInt8 typed array from a regular string +stringToU8a

                                                                                                              +

                                                                                                              Parameters

                                                                                                              • charString: string

                                                                                                                a regular character string

                                                                                                                +

                                                                                                              Returns Uint8Array<ArrayBuffer>

                                                                                                              an array of 8-bit unsigned integers

                                                                                                              +

                                                                                                            Settings

                                                                                                            Member Visibility
                                                                                                            diff --git a/docs/typedoc/_whiteflagprotocol/util/u8aToB64u.html b/docs/typedoc/_whiteflagprotocol/util/u8aToB64u.html new file mode 100644 index 00000000..022dd668 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/u8aToB64u.html @@ -0,0 +1,5 @@ +u8aToB64u | Whiteflag JavaScript Library
                                                                                                            Whiteflag JavaScript Library
                                                                                                              Preparing search index...

                                                                                                              Function u8aToB64u

                                                                                                              • Function

                                                                                                                Creates a base64url encoded string from a UInt8 typed array +u8aToB64u

                                                                                                                +

                                                                                                                Parameters

                                                                                                                • u8array: Uint8Array

                                                                                                                  an array of 8-bit unsigned integers

                                                                                                                  +

                                                                                                                Returns string

                                                                                                                a base64url encoded string

                                                                                                                +

                                                                                                              Settings

                                                                                                              Member Visibility
                                                                                                              diff --git a/docs/typedoc/_whiteflagprotocol/util/u8aToHex.html b/docs/typedoc/_whiteflagprotocol/util/u8aToHex.html new file mode 100644 index 00000000..de8c09f5 --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/u8aToHex.html @@ -0,0 +1,5 @@ +u8aToHex | Whiteflag JavaScript Library
                                                                                                              Whiteflag JavaScript Library
                                                                                                                Preparing search index...

                                                                                                                Function u8aToHex

                                                                                                                • Function

                                                                                                                  Creates a hexadecimal string from an Uint8Array +u8aToHex

                                                                                                                  +

                                                                                                                  Parameters

                                                                                                                  • u8array: Uint8Array

                                                                                                                    an array of 8-bit unsigned integers

                                                                                                                    +

                                                                                                                  Returns string

                                                                                                                  a hexadecimal string

                                                                                                                  +

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                diff --git a/docs/typedoc/_whiteflagprotocol/util/u8aToString.html b/docs/typedoc/_whiteflagprotocol/util/u8aToString.html new file mode 100644 index 00000000..75a59dab --- /dev/null +++ b/docs/typedoc/_whiteflagprotocol/util/u8aToString.html @@ -0,0 +1,5 @@ +u8aToString | Whiteflag JavaScript Library
                                                                                                                Whiteflag JavaScript Library
                                                                                                                  Preparing search index...

                                                                                                                  Function u8aToString

                                                                                                                  • Function

                                                                                                                    Creates a standard string from a UInt8 typed array +u8aToString

                                                                                                                    +

                                                                                                                    Parameters

                                                                                                                    • u8array: Uint8Array

                                                                                                                      a UInt8 typed array

                                                                                                                      +

                                                                                                                    Returns string

                                                                                                                    a standard string

                                                                                                                    +

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  diff --git a/docs/typedoc/assets/favicon.ico b/docs/typedoc/assets/favicon.ico new file mode 100644 index 00000000..8b0078ae Binary files /dev/null and b/docs/typedoc/assets/favicon.ico differ diff --git a/docs/typedoc/assets/hierarchy.js b/docs/typedoc/assets/hierarchy.js index fda42cbe..9807cd7c 100644 --- a/docs/typedoc/assets/hierarchy.js +++ b/docs/typedoc/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyNzb0OwjAMBOB3uTlQ0Q6NvDIzM1QdQurSiPxIcZiqvDuqOpUBsXg4+e5bkVMqAhp0Pypknj3b4lIU0ArdbzeawCDc52vKfGMR82QovFycQJdWK7yzB8GmzI13jybsP82hcV5K8FCw3oiAUGQ6bROnPVCwi/NT5gga2k6PVaHt9MH/YQfj4pf9n1tr/QBt31Xp" \ No newline at end of file +window.hierarchyData = "eJyVjrEKgzAYhN/l5lhRCClZO3fuIFJC/NXQmL8kkQ6Sdy9SKDiVTgcH3923ITLnBN1J2fYCkUZPNjsOCXqDlO0ewSwEjdt44UhXSslMBIGHCwN0054F1uihcX/NLtPozfSMnNmyry1Hqg/gac6Lh4D1JiVo5DRU+1L1KQTs7PwQKUB3qlF9EVCNOmj8p7AYF+ov9OO+lPIGhqFcyQ==" \ No newline at end of file diff --git a/docs/typedoc/assets/navigation.js b/docs/typedoc/assets/navigation.js index a758c742..bdf2109b 100644 --- a/docs/typedoc/assets/navigation.js +++ b/docs/typedoc/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJylmE2P2zYQhv+L9rqImtQ13L3VQYtF2sUGbbI9BHugJMqibZmGKK/tFv3vhfihJaWZIZMgl3jfdx6QoxlypC//Zj2/9NldVsqOZ7fZkfWN/fWm6dt9dpvtxKHK7t7dZmUj9lXHD9ndlzGs4qWs+G+C7ysg+sbItZUNafH258WPPyz+u/Uh3fXYP3Cl2AZaxY11tKMDQ/EDuR4jx9bDD7H1WEd8PUI9sb2oCJRQL4MjGfXE9icK9GJ1DKNNrOfEkpwlvqa/6/eyo1Dnevh/CujXrpPde1khGD7IpZFxyIPafLoeEUSrNr0RccDHTvaylHu9GhhztBZuLTjsiXdKyAOMeRlFDLAXRQZ33ZCHMsTme1Hk+u9JfTs8OIKRWz1krcKehRvNg3ieELRMalmP5HkIEt4hHso3zVjP/rqG56sAjhES04yUtQfKPROeb7I0Q1pgDIlv3/nMkvVlw6sI0HeRCWuhY0CTrJKYMrCJfU4+eqh8oSfTBOX5qGRRl1RADI104acRQ2O8AeLE0EgQydsiQE6cZKXYsw9qLicl1gp4xAagfDRNi+VZ//PaYUiy9FD6d9JCyo6znv/C1e/8CgJujINxtdMO7Mw3tvuWlRFS07KSRtk6hCGvIh7eiReOrsLI9Aps3cKAVxELb5hq4FiroIG7qkYCjYIGtqxEAo1CzEHa/MD7RlYw4lybX63zfMO9L44N76Z4c7lpKfXuJxbr0fLQSQ4D0IP2UdZCHDVowYUYa4qfqxTGWshDqpRtG5wsHkVLScn+h3dSKE5gcmshFwP1gmYMQtJCSAKAWcY6ygveVTUVDHSVF9yyktz6jl8VGD4I3306j6TcdxG7IU/oKc3agP2FV0/LhFdpw6/UWWl6L4+xwwtPwmvXA+/ZPWeVf6yEjJ41Tv+KVx2fkfSqk8/GxwHxLeNjjJOPHmrew1MzYznbZIE/LSdP+dSL/Stq+JW0pWK5+CTXy8UJiL0ploteFkbEsjvImoAATpoQBdzzCw5otEgDHostDpBapAF/9Z04bHCGcjqN+bxiOOOkRQywFgfWXdenuvarwmNovXA6PubJ41r0CkIMWmE0dE7hF7wiGn6JVoQG4NnUiGgyNQTJpSbQqRRqzRSHi1KowmmxcDAHLp7KgVBIQQtFF7NQj8WWlz0cK52Gh+OJFyqa9Q9nsGq2Z6pgDkPzfux4LcAdH4b2PToZg8hii1edLLbRqlONqPs/eA1mTot7I5KAP8WmwQmdVVGEzi++D6PHt2IxSAk5Cl1IDoL0kIPQbXRaMXw3pxWLbkUDkH3oeHoTOhyvaE2IFjX+ymMO1JCsL2AjJF2g+KHtkXLfRX41A89un+QcxBSJtIJPGS0xDNAQM4720J87h0+ss4doPgRa6XumlQCUjyZib8jUMgMZUxQ0q3AIdM8vUdBsioFAj8U2CoKaBmIZXxQ3O0Ug1ucVo97U4LkiBI2mGCi+P88Wg0V25zzkx1Fo3ggxzpOAIXM0mkhQpCS1gQRAc8iUYTwkJv6gnIfAoCNGSPJsBAwZNULUaKIOSPS6D1m+LwEXeXKeLQEWKW3PRsCQMSBEjaYYKLI/54lh4oXl2cjbaTudejVme077ADSbmV10/mFKGO5683Xm+X+JavwM" \ No newline at end of file +window.navigationData = "eJyV1lFv2jAUhuH/4ms0tIohxNVGtQl1Q1Rbyy4qNDnJCTGEGDlOAU3971NCEtltd/xx//qRbeyYp7/C0smKqfh8zJSlNJebg9FWxzoXAxFnKk8MFWL61IexNiQG4iBtJqbiz5thwzr4kNl9DexUkYjpzfvS7/RWJxQHsWEb+ujkZeBIX43Rpq4QrY85cVFuHs4HyGtTTluRKZUuEK1NOe1WG1pQWcoNND8n99WPN7573w5sNgiRvQGcnVCsE/qmKE/CrhP75njkk+Z8sPA++D0DU3HFXJ2YJ6+aq98zsCpXMlcJDPt9GF7JvMLZpmbQ5zqSFj+7rwa8odcO3uyY5s0mQT9OTbwgm+nAOWjCoT/i/9c3NiQtfaHyO50R1+2Zvb1k872Mr3LbAeF7hpBtymJGPRM4wz4O3yyEa1MGy2SZIVLdccwuSSFml6Qcs5eBx7Fl9jJmb8ZeKv7lqQPwViAPWc1hDxnyIWg16AFbkJVzkgnxr1dPdvWrxX8ae/tXWZWzXh1A+zdThTTnWZWmgRnW4tCtuXXfHcswdncsOSMajx70bDyqwlKfMmc3Go+qJoK4Sxrk5nRCuTmdgtwy2qLcMtoGuV/WqGKDipc6iD5OJCo+TiT7POjDTFngoHQl92WiE3pY+jTEodvnxCES2ryuZP8LzWRJyFnuSgAD9q5PWQ66FU3GMstoSzH/jrbSpWQx9MfsSgYr6rt8byhVwDKdmCF1tEWPb58yXJmp1P6gFNi8Pg1xP9UmQ72m5cBmi9EVuzWAQqfPiQESurZOzJDVRKLr7tMQB624K0MYelGc+J2/euuX9T/HRjVP" \ No newline at end of file diff --git a/docs/typedoc/assets/search.js b/docs/typedoc/assets/search.js index 21853ac4..6e1238f5 100644 --- a/docs/typedoc/assets/search.js +++ b/docs/typedoc/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy1XV2T27aS/S/y61xbDX77zXYm106uP9Z2cnfLldrSSNQM7ZE0S1J2fF3571sASakBHFJNiXmzh0B3EzxodPcBhB+zcvetmj399GP2pdiuZk/V1Wy72OSzp7PlrsxnV7N9ed/+5/FdvbmfXc2W94uqyqvZ09nsr6uuX0hZGMzDQ+9Vvtyt8p+L/H7lC3nUPF23T5nAq9nDosy3dad/UEH5/aF+nVfV4hYY+qhtsDk0OEtNvh16j+bpRe+Rb0+8R9vgwvcoqt8X98WqX01RfdUNplHz++J+P6Dka/v4LBVGwqLO+1+la3Hhu/x7/WJXDqj5ttb/vljJdVnuyhe7FVaR66fL5umZCl5Xtx+/P2Dxm+q2bp6dKfxduat3y929eQuo4qFtkbctzlT0e15WxW4LVXw9PBMJt33ck/vi5oke4aUl+/jnQb+XWnDpF/KkfQyEOYYye45qKD7oef7qjUTHo5tieEDYC3amQ30/Pft4/fHV62uRUj3t6mIzDCix5usXMqVm1CfQ99v7Zx9fvZUN72pfLupToJNqfnn93yKld/mfk+j717OPIn33i3oafW/f/FOmcLe9nUTjbx9/TkUa9/U6PV9jfDriYYpZkzP9QHw6MmH6WJPL9fUu7Uwhb3OmRuCczcpR+Tqbv4vdM15omaQnrI3Q+tY0CMFnv318ef3m46sXPU6lR+mjxb6+y7d1sRT6l3YY+AtCe67fvHj/P+/G2dIGn5Pa8fPb96+R/+mzYb0rNxI/JNX/+vrjs5fXz366fi+3YZPXi7t8scqHI5hRdrx7//bj2xdv/yW3ogulprPh/fXP1++v37wAq3ufEWW+zst8uxSs8VIrPrz655tnH397P8KKqrjdLup9ebEVKhVFs7YxVrtzXUVE3Ndtq7rcL+uRah/ZHaUjYb8nG425Ojr85WKvZY0zp+szrSXDThsOy4mMSWZFzEejXt7lq2Fk8EbnwgIsgBuQg/IH4iUQpYJc0JNDE6H1nWV4AZTqebQQa3p8fAkcw4t1DldsxugEbqtHpwCTQp0/i3WuJ9P5SqyzmEznr2KdXybT+VqsczOZzndinQ+T6fwvsc7/m0wniLl6dArWM6HOD2KdgpVLqBPEtz06BZHtoE5ll6BwxdIxgDU729GLw5d+teOil+Mo8LdkC+c8PA5Fk2qPMubQZUo7mhR8lB2HLlPacZvXo4xo2k9pQVFdmxcD1YoBO4oqP/Sa1hpTqRhpy9e2z5SWVCO/TDX5l6l3L01dUW5DvRNVIkda8fbmc74cNxj1btd1mtaWD3VZmFLkGFuqrtO0tvyWLkYask9HRdQCKzpObZQhrNOUtqzL3eZ5sV2U30dZo7vddN2mtmfsDNJ9pp9DWuoZs0h3+1vmkRY8Fr26zyT4jUWbBSxz7HZnh0axiN63NNvtptA8wPhbmu12U2geYugt1U7Ds3WDkklLCYPyVfdEXDRBzLMl6cmhjfANDsbB1OEriVU9Mm2F2h4fXwUOncbf7qja/HfUnp9lmS/q/Fle/Zp/R3IeNQ0WefUlH/DBjR2n1LzcLJbDeu42i+VFilpvAFUcn50tvCy+5n1v0Dy9yPrWo0Dxx2dnCr9bVHdQcvvgXLFfVmsstnlwrtjNYonFNg/OFPvv9QvT5HVe3+1WUMG3dfO/TddEqMqdlg1VWjzc5aWjhz2Rb1TpN5uJe2I3POHbPDNxqfTFTy/HaXyUL1enEMXHwHk7XGz78OtIIx6qgfKi3AY/JBmwo21x/rjHp72Nra9tM4lG7H64vrbF+drwJNltNnyxdp8MThJm/3/ycldUeb+gJ20Luf2NZSfsB5718Hep7UMy+gRhm40krMN31UzHl9V6Ch2+32Y6NotTu+l6dcCR/5J/r5A2/XfpyA+EQAdZT3gj8RsY6wZ04njIVdq2Olfrcdw2i+I4yfR/RkWK/167ucFBhN6UemJLrdE9LLxevOx2ayD5JzdznFThJgVc/qntqI5we1Ah4es+GBxsmxFAA+3SEZL0y7NNzgScUCliAbwROL5Zz6YB/ZXFJrSNj7rravWPovqH3nGTL2tTfh5nyxAbccoawES09hTbu7wsLrbHYSVO2QMYiWnt4ezEKWNcZmJyS16PAc5tXnvYucwCnyc5ZQPmSKYdF5cvOW2Tz5VMa1E1AjMuZzK5JaMwU02OGZvBOaXfZ2+mHY9698sHtsn0tDmfqxOr5Vj9Tg38tAUnqt/n2OAwSKdtAOzR1N+F1+JPG+RW4ae1xmOUThkE2aRpbQLM0imrelil6e0aM8MRuzS9RaNmue4w8TwHbJfECjDXpx+bMTMNMV6XWxTFpzMiz6qu1dm5gBWCL/b17p/5Ni8X9alwxlKsj0DsblnHEYg5vGePTTf3u+WX5Z2bvp4wyOo1tTU/5Q/13WhrVm2vqa15s9/cjIJJY8626zahPcvddl2Um3HY4Z0mtKUNsUXptG1Q21NS1TjHqvZ8zqttUf+en867Pdva/sW2qL/m43NwuYW/5t9fbR/2J5x1n31f8u9F23tC65qzRYLUxjar6Ta8G+wse3ZlcVtsF/WufLZalXlVjbHq2Hlx6Py32PZuf8NLjaNMe9jfDNGaF1o2+kseu/4NX7PMl8VDkW/rMz7moe/f8i0Ph7hGD9ih598wXnW52FaLpZ7uLzmFITCLdR2koC+169V2dSoO7zWsaPv+PZZ9bI7dn2PY4In98+1a5sXX/KeizJe1WyqX2Ga6r1j3qe3bFJWu03/YL5cjJyfvXh26T2hfm+sWu+21ffhZYNyx7+Hg9GWWHav7+7q4P5ii/zOK9bmJw4+753G490U8uonDenfTPMPWGt2DwvdGOha+N9IvE84zcFf40F5OkfC3N597he/MswuEO7UoV/6JfcsiFTzhdeUPbec8Ibypxjzfr9csJ2HyzeOb7vFZKpbl7uF5UVdAvH500zw6S/Rd/mcv4u/yPy9DvBHe+2WN+Ms+rFGAv6uRfsFnLarniyqHk7WobrpHF4lGY97JPnvMiwo7gaK6wAEUlVPF4nJPVKZPiu4FSFFdho5fvqEZ8/nb2ZNlqx3suzJfF2iEt9rFPnRPz1Kwu/ncOxt3N58vm43VXbGu/5Wv0Vc0z+6bZ+cLf1/c3vVKL9uH54k3QOgdm+bxhcPTqsDTp9NwwSTqFGB/1Sm4wGXt00XvCO3TxWXDY4TjsTGyLxgYI7rXCxjp4xyBHQ6aAPLG5kycv4t3q/Qu9kzYE95ouEztmtcTa9/n21tWfz2p79Ghg0jtY+uteiiDxcNDvl2NsOHQYWobnn+v82q0ITdtr6mtcaeExJZTc+U8S1y/IrHklLcZa4kOR0cY0TafTn/+Z10unDhl2IRjj8mtGAeNttPU2GjFjgNH22lqdBTbKi/rsfO36TX9/G3kjvtITZ+pv1EjddwnavpM/YVwjDhsiSx2PMsSP6AUmHI60BxrS+0FPsNmnI6GxlswDh2n48jRfmTzUPfGT8iFtO2ns0BvQhhhQNt8Wv1jfZfZezO553I328jsmBqT7iYSmRUT4DI+URnjRnQNzo3D41P5M1d2aDGVtmH/d2xyrj6QKJm9AG4mZj2RnjTBxXRL1JNDG+EbHKzr0wgq7J7Gps2EGuFcdDS+zP+cUKNbi0ca3958nlAjyM+R0qbZhHqhh3GU/pYuJtGIi+G2xkOb6TSeHFrWajqtwwPbNZlEH6yl2/q6JpPqG/qOhzYTaRz2Aeb5RJpAKd5V1jSZSN9JeHZNJtHXV2O3VbJWk2jFhXdb56HNJBp7K9q2Ut5sUr3DeGWtJtU67HRYq0m04oK4rfPQZjqNw0PbNZlO38kJylqdrxXEip+/gcD787fhs8i8nO4ydJ2AJ79AIchSbUP/SbkP7Ee4B9ToQ3Knf6/besVfTuq1t5IO6h3eNyrVW1RabQ6K9JZOvSmobXaZvqp5z2f3t7uyqO9Acm7prdoxZs0n0S/5vtWU37fevdhtHmCZ2VKqf7C7a3epxp+bi06G1a2HbkMZoWt/f39aV9PoMl26ICAbS91yqtEEp3L6lQp2N0h1vlt8v98tTk1P3fLh0FKq9Y+rWbN58+mPWXe6/+lMPQ4eZ7Ormbn/TV+i15hzNdO/9KFFXc1Wu+Xe/POPtlmzRV83blo/mc+uPs2vovnjNIn/+OPqU9fZPDB/6GQc/2I60uzqE12F0eMkTq2O5HUkq6OaXX1SqKPyOiqrYzC7+hSgjoHXMbA6hrOrTyHqGHodQ6tjNLv6FKGOkdcxsjrGs6tPMeoYex1jq2Myu/qUoI6J1zGxOqazq08p6ph6HVOrYza7+pShjpnXMbMBoPFAcwgBHzzkoMfAB+MHAMhGEGlckLoK1eNwHtidfRCRjSLS2KAAQZ58IJGNJNL4oBB29sFENppIY4Qi2NkHFNmIIo0TimFnH1Rko4o0ViiBnX1gkY0s0nihFHb2wUU2ukhjhjLY2QcY2QhTGjMKeiflI0zZCFMaM4pgZx9hyvFRxkkp2Bm4KRthKuhzjcoHmLIBpsI+J6d8fCkbXyrq8zrKh5ey4aU0YBScFcqHl7LhpZI+H6J8dCkbXUrjRcEZpXx0KRtdSuNFwRmlfHQpG12BQRecUYGPrsBGV2DQBWdU4KMrsNEVGHTBGRX46AqcVVADRsEZFYCF0IZXYOAFZ1Tg4yuw8RVEvT478AEW2AALNGQCQj478AEW2AALNGYCOB0DH2GBjbBAYyaA0A58hAU2wgKNmQDCM/ARFtgICzVmAgjP0EdYaCMspN7lNfQRFtoICzVmAojt0EdYaCMsNIEWxHboIyx0Yi2DMIjtEIRbNsJCjZkAYjv0ERbaCAs1ZkKI7dBHWGgjLNSYCeFqEfoIC22EhRozIYRn6CMstBEWasyEEJ6hj7DQRlikMRNCeEY+wiIbYZHGTAjhGfkIi2yERRozIURY5CMsshEWacyEEGGRj7DIRlgU9oW6kQ+wyAnoo14vFIGY3gZYZACGNfsAi2yARQZgcJGMfIBFNsAiDZkI+oLIB1hkAyzSkImg2458gEU2wGINmQima7EPsNgGWKwhE8FoJvYBFtsAizVkohB9qtgHWGwDLNaQiWDqFvsAi22AaSrrU4TTNx9hsY2w2OSMCTTbR1jspI0aMxFEWAwyRxthscZMBBEW+wiLbYTFGjPxHJrtIyy2ERZrzMRwVsU+wmIbYYnGTAyTucRHWGIjLKG+YkLiAyyxAZaovrJA4uMrsfGVBH2VgcSHV2LDKwl7c3wfXYmNrsSE+HCxSHx0JTa6krg3bU58dCVOYULjJYYrTQJqEza6EoMuuNIkProSG12JQRecjomPrsRGV2rQBUc79dGV2uhKNWBiXFXx4ZXa8Eo1YmI4HVMfX6mNr1RDJoEOP/UBltoASw3AoMNPfYSlNsJSjZkETqnUR1hqIyzVmEmgw099hKU2wlJT+4ITMvURljrlL42ZBCIsBRUwG2Fp1q/ZR1hqIyzTmElgIJT5CMtshGUaMwkMhDIfYZmNsEz1wjPzEZbZCMuCXnhmPsIyG2FZ2AvPzEdYZiMsMwiDGULmIyyzEZYZhMEMIfMRltkIyzRmUpghZD7CMhthWdo7qzIfYZlTZM16Z1UG6qxuoXXeO62aZ3Z39re2v8ZNCpOb5pnb3ym3zlWvB26euf2dius86HXCzTO3v1N0nZuIH+ZXzTO3v1N3nWsMpT3jByqvc6f0OtcwSqF/aJ65/Z3q6zzpr1fPQf117hRg56a4jwvHc1CCnTs12Hk28P6gCjt38Gdq9zhrIlTq92r9Bn+4dg2r/Q7+TAUfJ16ECv5uxd8U8XHuRajm7xb9TR0fp1+Eyv5u3d+U8lNcfkeVf7f0b6r5OIMjVPx3q/+moI+TOEL1f5cAMDV9nMcRogBcDsCU9VPMICAWwKEByFT2cSpIgAgghwkgU9xPMQkBuAByyAAy9X2cTRKgA8jhA8jU+HFCSYASIIcTIFPnxzklAVqAHF6ATK0fp5UEqAFyuAEy5X6cWRJgB8ihB8iU/HFySYAhIIciIFP1z+C6TYAkIIclINWfnxLgCcghCijoT1EJUAXkcAVkyv896wdgC8ihC8gwABlevwFhQA5jQIYEyPD6CTgDckgDMjxA1kOZAvw5vAEZKiDDrClgDsihDsiwARle/wB5QA57QIYQyPD6A/gDcggEMpxAhv03oBDI4RDI0AIZ9n+ARSCHRiDDDGTYfwEigRwmgVoqAU8gQCaQwyaQIQhojhEICAVyGAUyJAHNMQQBqUAOq0CGKKA5xiAgFshhFsiQBTTvoe4BCB12gQxhQHOMQkAwkMMwkCENaI5hCEgGclgGMsQBzTEOAdFADtNAhjygOQYiIBvIYRsoarZ8YCQCwoEcxoGiZtsHRiIgHchhHcgQCUQYiYB4IId5IEMmEOFgCJAP5LAPZBgFIhwNAQaCHAqCooZGxcsBYCHIoSHIMAtEOB4BTAQ5VAQZdoEIBySAjSCHjiDDMBDhjA4wEuRQEmRYBiIckgBWghxaggzTQIRjEsBMkENNkGEbSOGgHrAT5NATFDebkHBUDhgKcigKMqwDKYxEwFKQQ1OQYR5IYSQCpoIcqoIM+0AKIxGwFeTQFRQ3FWWMRMBYkENZUNxkxhiJgLUgh7Ygw0SQwkgEzAU51AUZNkLvWocCABId+oIMI0EKIxEwGORQGGRoCQowEgGNQQ6PQYaboJ78HHAZ5JAZlDRb4nCACwgNchgNMiwFBRiJgNUgh9Ygw1RQgJEImA1yqA1quI0AIxGwG+TQG2QYCwowEgHDQQ7FQYa1oAAjEbAc5NAcZJgLCjASAdNBDtVBhr0gvH2CANtBDt1BKQ14ZcB4kEN5kGExCO/BIMB6kEN7kGEyCO/DIMB8kEN9UNps0MSBJmA/yKE/yDAahPdjEGBAyKFAyLAahPdkEGBByKFByDAbhPdlEGBCyKFCyLAbhPdmEGBDyKFDyDAchPdnEGBEyKFEyLAcFOJAE7Ai5NAiZJgOCnv2jQIkOtQIGbaDIoxEwI6QQ4+QYTwowkgEDAk5FAll4YBXBiwJOTQJZdGAVwZMCTlUCRn2o6dsBsgSctgSMgRIT9kJ8CXkECZkOBCK8FwEnAk5pAkZHoQiPBcBb0IOcaIMEUIR3l0KmBPlMCfKMCG4cqUAc6Ic5kQ1zAn8hAowJ8phTtQ86A9zFaBOlEOdqPkAChXgTpTDnaj5AAoVIE+UQ54oQ4ZQhDfpAvZEOeyJatgTnLEpQJ8ohz5R87Q/Y1OAP1EOf6LmWX/GpgCBohwCRTVHJXDGpgCDohwGRbXHJfDmbkChKIdCUc2RCZyxKcChKIdDUc2xCZwvKUCiKIdEUc3RCZwvKcCiKIdFUc3xCZwvKUCjKIdGUc0RCpwvKcCjKIdHUc0xCpwvKUCkKIdIUc1RCpwvKcCkKIdJUc1xCpwvKUClKPdEhZr350sKHapwT1Uo6k93FDpY4Z2sUP3pjoKHKxwkNscrcLKh0AkL94iFCvuTDYWOWbjnLFTUn2wodNbCPWyh4v5kQ6HzFu6BC5X0JxsKHbpwT12otD/ZUOjghXvyQjVrMwwyFTp84ZAqKpj3J94KsCrKYVWUYUkoglGqArSKcmgVFTQxIoxSFeBVlMOrqKCJEWGUqgCxohxiRRmihGJ8wgkwK8phVlRzJCPGp5wAtaIcakUFzbEyfNIJcCvK4VaU4UoIb0lUgFxRDrmiDFlCeGehAuyKctgVZdgSwrsLFaBXlEOvKEOXYHpQAXpFOfSKauiVGE8FQK90fzOner/mZZ2vmmtd9KHcxezqx+x/29O+weEOvR+zUM2e/vjrr+Pp3qc//mIHfPUzraX7Yd6jEJ1OH6TohFkupv1xOy5LcVnhCFnmB+q4pIBLikZIMj8yxyWFXFIsk7Sv7/JtXSwXzeUuR3GKSVOpVBi/LvAoK+MjH8g+ILuJhL0j8XGPgqavjnSFIrv7R7hI/gGisBMpe2V26wgXyb9EFHUisxEizV0jXGTERcatSJqPENn9vDiXGnOpSSeVRkh1UUgJF5l2IoUfvbAwaL+0VAK7iYTblXJZWdNdV+5EUtm9kwzWHIyBzKHwOyOZJI7BQOZOrOsemSiOvUA2aMtFvbzLV+aeIsvvMlmBDL3Lxb6yfWXARimQTdTmmnsmgg1PIJuY7PpJNjYcT4HMQy5326ou982NjMwk5tKCdjp2M52E03K5K63XnB9FygWYX8jQA7a04G4Bapyw7roqthYwaUo6bK20w32bbOzYZwhHvmn7sx+WeTEzLxEivswXdb7IK3MJIhPFHGLSOYm5zHk1Mu82i6UrlLnEdN4JFX4V8+PxfJXnGE6F8+lwfxJ3iBkTFM+7RUpq1veHeme9JLMrEc5RI6QBcPFwZ/uxhMlLx8vbbTZ2PJMw/59JQXKQ11xmeJSWsrmaST/CQdqX/Lv1LVIeH81lS5Ll2AKGsFD2BfUV7s2FgwwTPByQzXPX7/DVXzYuq9x19yH7VF2oQ8IIopFmfuPHsouZ1SJdOEy5+W4W0pl5aSstE1unpQGfyBZJ1XROhDjIy+Jr7nocNrfTVl4mfOF96eUCVuwkm4u2w2f9Q1l0ky9X1oRLGDQz2ZrR/jg7Dyd5wJYJX2TrwZMNbhczk3CRdS+hZrEJn3vCOKmR5oGdR0st2IWDvvXAnjBHl7bSslHS3LyS+XUliynx7dhs6LjTEcaH6EZrJpEDXhj5thLBp2VRdJteJjJ3cbi2ha//HCfChZHfusJF8XFLhW/JLk3hoviACefn2sIsm1ShbHlubv+2sMXGJhAawa8QZwDgwZEwRm3uYuDuhgfhmWx8zV0K7TVeR1ERMyfuXI4wEme3M3DbeHlnLn/Bw88T8qiBT2nhbDnc1cAWLeZq4rR7ya4oIQyLtNzPle1yMiaYhLUs/quIzEQWR8RdeqCyzsnKh/Hw24d8GBl6dW1UKsuZizFb5JIu2wgO8b3M89zm1ntHbAS7mo4+3iUUtclry8SUOx5hYcf+8VqO5ISjTzZs9i/ScmEpFyYbKzc3SBhI0tbhC4MN10NzLySbV+w6WyZH8RkQdxGwMGaxrrDlQnlQHatOqAwVx5truUQen8Vd7CIEyN2XlbWiJExY2lZmhE5Y5/CWKObI0y4hETrNwooE2HcIZe7buhiMr7gWNmSwZxd7ccxzcAgTGXYxF5fEESHMN473DHMg8JUz7mrywpSU3S7MRfK6aNzV5IU5alG1gbvlFNnbHgrKYhvdr8DjYr0/vLVP5jeO9xNziVY2fyjuy6bA8fez+ffNuHeUfl/kOvgC0K31eo+FTKIXrvHEritlkfjbGnEgbmdfpMVLIn1nI/Lr4n5vCWQfpPvAMt9mfoOejx8Pt7tARAlD3i+WR2IgDmUDdu8E3cx9CL9gd3Mrd2fcCaUyJ3S/s2HFFyQl84hWwM5J3VA28TYOJZTyFWwuWwq1jL5Secq9gpCT9KIt7geE3J6WcZcvVnZNlk9bYaRl3RfOEcyXry5MVcKvxm4J55QHh1DSBTlKhqVdWdwW20W9KxerVZlX9nybc9HC0Pwo8WF/49Tn9BlSJnCsiZ7/00dKmTyZl7J4Bb4NIZQtEQ/lTv/4/72FEOaYhOHzQ2U5pIRhTBjW/J/1Imydj2TuyMI451cimf4yXxYPRb6tIXR4KCMsfpb5Oi/z7dKuELMZI1x7D3IAYHg4JCy4WC/G61CR7EtXTlLJRqbLSUgY8FQgqeRrojDK8W/r4Pk4X9iEpHzVl6XyyoES0vLszlnu5rjrSNq0i7LDxhWhoewSWS6c+5Ek6IQftrAIDUdDwN2zdDRN5IhcPZ9USffqQkqnk+pG4Hy3AyXdKwtL551QNyXiXLc+bNcKlY2j9W14tTaSvSm7m4VDkXNNwl0Q3bUrXAzfFCAkLLobVbgYXogUFu+9b8ermV0lglSXCGTSd3QLhykPUoSxidm65aRiEQNBV9YgYWCCSi8RTyTCTp4UEw5Eef2sy4tJdVKF5HZdLrbVYqn5FLccpn8rgi01wm9xlNeIsQTygFaYtDCBHus959moMPA38pZ58TVfFWW+9BjTOV+NhAGVkbnRmfduW+2XSy+U4HAUxjb7dIH8Jx/BpCsNCAkFI9Jznhbxf8joZR/HSARlAs4bU7cdRwkr+Pt6nVrxE3d7srmnbyCy98zwtVcY9bgXE1svyL9oKvyi/iXGvETDuZi58INaV91xYZyREJK1X8mqeDDHnMjAYGLVRW1XYhgQutoYCRfRTh7Irhlm2zmQyFb7Vmax2/qb5fTPujCQyFaNb2t/C58VoYullOhF+Y6Vpm8klmi2LW3y+m5nZRAJMy9tR0/IIX9bm1Fz91WwudBNdRlivq3RK/MQcd6ta8I92FoiKoCk/JvMOyAKSyHf1pvqtv7+4Cw+XGLTU1hg+LbuMnBv467lp9rUSph0fFt3N6tZ5RoeCLVT5UCEyL7Sf/JyV1T2/OOfXOCr/riaPRQP+X2xzWdPP/3x11//DxBGwcM="; \ No newline at end of file +window.searchData = "eJzFnWtznEiyhv8L/tprk1Dc9OnItjz2zPiytjy7JxSODdRNS9jqRgu0NQ6H//uJKqA7qyrpThDE+TQTVlXyUvXULV8afjpl8VA5Z1c/nW/5duWceQtnm24y58z5n4fbvM7Wd+nNfVnUxbK4e7YsysxZOLvyzjlz/kP//eltvblzFs7yLq2qrHLOHOfXoose76P/a/2iWGXLU9GeteWIqAvnPi2zbX1E6uHCEO6v/PzNu0FXfXKdb4de+Wl3e6SCl+eXF5dv3l4Mk7FK66zON9nEWi5eDJShOm1KBZ8/nl++eT+wU1a7Mq3zYuKeeX3x72EybrO/p1Xw5/nlMAV3aT2xgvfvfhsoodjeTKvh8+WreJiGXb2OJ9CAJ6iLsixKWYChZF92wonq/PPl64t3l29ecIeHLuJJuqtvs22dL8cOlEMDkPou3r34+L8fxmnLtsvyx/08ul69//iWNYoMTeui3IwaTCf0vL24PH99cf7y4uNwTZusTm+zdJWV0+v68PH95fsX7/8crqr78/SaPl68uvh48e4FZ200RJXZOiuz7XLMAnlC1ac3v707v/z8cYSqKr/ZpvWunEoVnqDeVjeXP+4501NbcsrJaeBVn6QjGqC7QXrfMFTBamoFHBw0BWMgOKrg1VAF66kVvBmqIJ9awR9DFXybWsHboQo2Uyv4MFTB/dQK/jlUwX+nVsBZXTUFY5bUowo+DVVQTa2As+vRFIzZ7tgK8KL0V1ZWzbbulJC25ISL0ncYeNknqsbQBuhuEWnw9MxGmb3Nqiq94azNqPRjmyKAQ/pmWWyrutwt66IcIeKJXn34serQAgd5nisOzbTKlryjlSVtX3MGVdl2rKp9zRlU3WT1GElNtRn05NWFutvVGFV5le0rz6Ltr/QuH6nse1t1Bl3VuD6s5urDunitcleDFdXF2KQXQ9P766/ZclRD1UXR1Z1F2ae6zFWaa4Syqqs7i7LPcTpO1i4ecyhjaFLDKK1HzaOo7gzK1mWxeZ5v0/LHGG2y9nVXeyZ1I0elrDrbuJTBx49MWXvOsSnjjxwDsuqUo0DfB35o66g8DkOeVv7/by9oy3jkblBvB9RaricOGtOdjDlOXld3HmW8HSHZbKN2hH2qQmHsnl/l2d3pnQ4q+1iodAUyg8895+jFJ9TRbCZ5LYHKTqtgSEvoxSfU0e58uTr04tPr+Cu927FVqMITauh2EdzGMMo/Vsnxpyhk9xdHJakS/CcpVPG3WX1bHB8DqtwzvcLwW23k0xnxFy9fj1PwJFuubofLeGrcPZ0d/XQ8R9wv6r4aliw+oQkBuiyztM7Os+qP7PhWtBGHiz++xywdrzfpcoiQtvykStoVgqGhLTnx1cv8e8Zrg33ZSRW06wLj+m3JSa9+m1a3jEvLYtNe99tqzbnut9V62utu0uMPn7XX3aQjnj0zr3t0Odik+dFsufw7eylgZN9lvEdk35XcEdl34rIDs++qIU5n3xlLfqtl7GJvNMGIkxYhYOwZq20V4iyKzzDyOZKhgto6ByV1tfpHXv1DVsqWtUrgjlI20AegtBEeQKsu395mZT6VutN+AKWO8AJmUXfCF6CkmZ7AXLrejgDuJqst5ibRw/IrKEW0VzFLmzF8C1qh7VnMou+Ef0FpM72LuXSNYa2ai7WTvgqlxvZUZmmruvj90/GnNWlxX6thz2ly1ZzOKdN6hmeTuYpOuzy0IsLhmakHT2S6aXlmjnsWbRzXh5JHOj6zKOS5P5TGHudnNpUj5hDKAZpN35h5RNabZybh+VN9mojZZLZ2GzF6KY9qMn1BqJ2c6vR197D5aY1d4UcfIfFBJd3VxW/ZNivTmrld02TIHz0UN6j+cNL2bdCj8PquWH5b3jJO7YQ8rfJM2l5m9/XRXM4xbau28kza3u0212PwasRtu9rTq1sW23VebkYxh+tOr6w9gQxJa+jy2gCbfYBZNLY/53mzzeu/Mnb+w1Lahsm3ef09G50L4ev9I/vxZnu/4y0cfWq/ZT/yNsj0WpufJfEPh7rIpvbg59rY6ooyv8m3aV2U56tVmVVHHfwejYcY6T7GnEo/7K5PJPpPCr3fXX/LBj0FNELn2D4/RJiv38tsmd/n2bYe3+37EHP2+v5XYWMbcx9gvrasy3RbpUs5k7w+YcP0iEQRWiNnVpVvtivm+aRXZt6GmFXnZfNz+UfIHPqD+2Eql1n+PXuZl9my5pk2pFIVZYWizKR2k1fSePm0Wy7HDXgcpdpHmV5tm1DIi616gmqM1EOIrAsxic6jTuCuzu+OaZV/P+oEYiOsyXM8363Xx/fbMugzXHjwcU7J7umKu2x7c/wwQl//yb7iIBlPtbvuOYen9/fZ9uhS0KNpX3EuTc9/1McfgTwq7LqtPZe6Ezmpo9oGPpo8UNmJrMpRZQMf/2UrW5bF/QhRbbXp9WR/12V6PEHWI+lQczZV49BqK8/FVht+HFxt5bnoyrdVVtZj54um9nzzRRN/XKc2defq0yb6uC5t6s7Vo9Vtvq7/zNZjRqiqe9fUnUnZx/zmdrS0sq08vbaTbmuPrME/YhugaBxdg3+OxZ/HNvf10WxH3xTW1ptekbQ0Rghqq82jZ+xcqpzB2WZShhd4RNdcjDOcrCOqJuQcH3h+fzjdfb8/VI893pgPOn1CL/jhXVw+5zTqtUCqJeRtHldzMp9NqhmcwD6lJq+kmOOGiq5EZgbaGpOpqJo2Ob+7Kcq8vj097ezVVG0voZpTqxrITTUTN3Xxotjccw4Heyny37oqE+p41bzNkC1iPfDthwwFu7uTORhNQVN+MgVyghzcG7LSDP3Be6zCljL88SyOkg/pj7siHTCdyEr3+0qP0YJ+N3AdisvieSh2J3XsSz52xdGvvlNBOVdvSk5+dc52ZF9y8qu/v/7KvPr766+TX/3044FIQFN4cg2cjde+5IRXl5mp53l9epPVFZzw2rfZ38xRty859dWZXY/KTq2A0/FdwQmvnVfP0ypjTDldwRmufbrf9yUnvTpnrlOlJr0qc83tCk56bSbmXcEJr72V68WHMlvnp9sclZ1QQXH9lTnL7EtOeHV+AnBfcuqr85J8h6JTXl/hxGx+XHgGDZxRj8rOoIAz1aOyEyrYxSmzE/Ylp746p/m7glNfmzn9obIjFXxZOM0jMGc/ne/tL1rPHO+p/zRxFs5avqJEfpajEbdwlsVmIyMunFWx3Kn//dIWa562lIWb0s9cZ3HlLkT0NI6CL18WV11l9Qf1D12Mw7+oiuAsroCqCFZF0Cp6zuLKoyp6VkVPq+g7iyufquhbFX2tonAWV4KqKKyKQqsYOIurgKoYWBUDrWLoLK5CqmJoVQy1ipGzuIqoipFVMdIqxs7iKqYqxlbFWKuYOIurhKqYWBUTHQDJA5DsgA0PGPQofGh+CIB0gkByASRDYEMEOkUg2QCSI7BBAp0kkHwAyRLYMIFOE0hGgOQJbKBAJwokJ0AyBTZUoFMFkhUguQIbLNDJAskLkGyBDRfodIFkBki+wAYMdMI8yYxHEubZhHk6YZ5kxiMJ82zCPGOOUpMUPUsR05ROmCeZ8UjCPJswTyfMk8x4JGGeTZinE+ZJZjySMM8mzNMJ8yQzHkmYZxPm6YR5khmPJMyzCfN0wjzJjEcS5tmEeTphnmTGIwnzbMI8nTBfMuOThPk2Yb5OmC+Z8WEhvKdRGOmVbcJ8nTBfMuN7ZGWbMN9YCdVSSK+FxGKoE+ZLZnyx8JOnwvX0yjZhvk6YL5nxA1K2TZivE+ZLZvyQrGwT5uuE+ZIZPyIr24T5OmG+ZMaPyco2Yb5OmC+Z8ROysk2YrxMmJDPCpSoLmzChEyYkMwKorhI2YUInTEhmBEmYsAkTOmFCMiN8srJNmDD2W2rDRRImiC2XTpiQzAiSMGETJnTChGRGkIQJmzChEyYkMyIiZduECZ0wIZkRMVnZJkzohAnJjEjIyjZhQicskMwE5BwW2IQFOmEB9E4GgU1YoBMWSGYCcokNbMICnbBAMhOQS2xgExbohAWSmYCcAAObsMDY1attPbnEBsTGXicskMwE9KHAJizQCQskMwG5xAY2YYFOWCCZCcglNrAJC3TCAslMQC6xgU1YoBMWKsLIJTa0CQt1wkLJTEjiGdqEhTphoWQmJAkLbcJCnbBQMhOShIU2YaFOmExhX4UkYaFNWKgTFkpmQpKw0CYsNM6O6vBIEhYSx0edsFAyE9JHT5uwUCcslMyEJGGhTVioExZKZkKSsNAmLNQJiyQzIUlYZBMW6YRFkpmIJCyyCYt0wiLJTEQSFtmERTphkWQmIgmLbMIinbBI9G4fI5uwSCcsCnq3j5FNWKQTFklmIpLtyCYsMjIUUe+KERFJCp2wSDITkQMjsgmLdMKipHfvGdmERTphsdu794xtwmKdsBh6956xTVisExYrwsjxHNuExTphsd+7cY1twmKdsFj0blxjm7BYJywOejeusU1YrBMWK8LIaSi2CYt1wuKod9cb24TFRh5MEUbOYTGRCtMJi5PeLXNsExbrhCVu75Y5sQlLdMIS6N0yJzZhiU5Y4vVumRObsEQnLPF7t8yJTViiE5aI3i1zYhOW6IQlkpmIXDESm7BEJywJe/fbiU1YohOWRL377cQmLNEJSxRhdMrUJiwxsq2SmZhcqxIi4WpmXCU0MZ01damcq5F0dSU3MZ04dYm0q2vkXV2JTkznTl0i8+oaqVdX0hPT6VOXSL66RvbVlQDFdAbVJfKvrpGAdSVDMZ1EdYkUrGvkYF2JUUznUV0iC+saaVhXkhTTqVSXSMS6RibWVVl+OpvqErlY10jGuirZ35OyJ9KxrsGfSuInPVl7gj8r6S95Smj+yLS/wZ9K5Sc0f1Tm30z9q2x+QvNHJf/N7L9K6Cc0f1T+3zQAVE4/ofmjLADTA1Bp/YTmj3IBTBtAZfYTmj/KCDCdAJXcT2j+KC/ANAMaN8ClAaT8AMMQAK/xnGgCCU8ADFMAVJ4f3B7viEDQMAZA5frBpRkkvAEwzAFQ+X5waQgJfwAMgwBUzh9cmkLCIwDDJACV9weXxpDwCcAwCkDl/sGlOSS8AjDMAlD5f3BpEAm/AAzDAJQHAC5NIuEZgGEagPIBoMe9JHwDMIwDUF4A9DiYhHcAhnkAfuOA0iQS/gEYBgIoTwD6nEyCRMNEAOULgHQz7a0fED4CGEYCKG8AgNx4AuElgGEmgPIH6J0+EHYCGH4CKIuA3jUD4SiAYSmAcgmgx1UlXAUwbAVQTgH0OKuEswCGtQB+wyE9Egh3AQx7ARp/gdyBA2EwgOEwQGMxkFthIDwGMEwGEA2F9EgkfAYwjAZQ3gHQLi8QXgMYZgMo/wBopxcIvwEMwwGUhwC02wuE5wCG6QDKRwDa8QXCdwDDeADlJQDt+gLhPYBhPoDyE4B2foHwH8AwIEB5CkC7v0B4EGCYEKB8BaAdYCB8CDCMCFDeAtAuMBBeBBhmBCh/gT4RAmFHgOFHQNCASJNMWBJgeBKgbAag3WQgbAkwfAlQVgP4NMmENQGGNwHKbgCfJpmwJ8DwJ0BZDkA7y0BYFGB4FKBsB/BpkgmbAgyfApT1AH7PUzIEiIZXAcp+AL/nSRkCRMOvAGVBgE+TTFgWYHgWoGwI8GmSCdsCDN8CwuYRJZpEwroAw7uAsHlMiSaRsC/A8C9AWRIgaBIJCwMMDwOULQGCJpGwMcDwMUBZEyBoEgkrAwwvA5Q9AYImkbAzwPAzQFkUIGgSCUsDDE8DlE0BgiaRsDXA8DUggiMbNMLaAMPbgMg7skEj7A0w/A1QlgWInifHCBINjwOihkR6LBA2Bxg+B0QNifRYIKwOMLwOUPYF0P44EHYHGH4HKAsDaJsbCMsDDM8DlI0BtNUNhO3R/Zt66vd7VtbZqnmHnnxoN3UWP53/tE8DQ9I9kPzTgcQ5+/nr1+Hp37Ofv9ADwPJv8irda6lQENdHUTxvQJj2VQY4lsCx/AGx1OsHcKQARxIDIqlXBuBIIY4U8CLt6ttsW+fLtHlNHgoHKBpwg+HXTB9ixe4hVsLrv+tQ1MW1euQeafJRILmtYEbaqVB6JHx7Aa+xmkhmB/oejhQOiFTIn23iSBjQIBoQqfvSAg6GCQ3iAcFMrnxMaMDsvlyDCTURb9w1nxW4bl/UhyHH/ea5vGDo/eIIShzJHRCpfRs4ioQJcHljRXt1NwqFEXB5bdV96PcQJUC3FjCDqG8zoRDongLe/Ibe+I1uCGPosgMdPvp1CIWJ9kVTN4DmvxFvtDQfakyzSr2n+BA6RKFD3mTQhJKfwjNjoeES8qaD5v12mPIIU84Pcq1+iozHLl4TQh7kWv95aMZlDjf52ZLmFbGo71DX8YJkS1wf9Q9v1u++hYYkoH7xgxYb3mzWBFs3n1NGYwTdFXMx2n/PE/GCuijkYdxG2b+8HklCDcVc1ZoPd5oQIwBD3uKx2pXWJgI1OU+MdjMemsY83rTafDAX3QeaxkIeee0bvvBOCA8in9dF3dfuEH8oih821WLeiDI/VoCmV7w2uzwGm2g2zbizeFPO/uusqMFj1OC80XX4ZIDW6nhR5a1h9JcSUGPhfnSZQBLfM0AR8TztDmo0avAifczt3/41pHjxiHHLDYpjHU7wwcvjzQP4JZ94EOGtu8cjY63NBngTyQOi+c6DviDioTwgSPuie9T1uJVdXis37+rDjYL58Xnti7+6hRZIxI5oZ5eEeYOHl/Vhafj+fGZ/4Vcu4aGMYwW8mXz/qj50j6i1RNTeY7sRlIYPN2zzva1D3AjJS3jTAn6jExKIAom4Fdh2BjA34toLmnAb4qHI3JHvXyyIJKIwImklRl0b8rpGfS4VLWyoW/w2VMyO1HxwEnUGWoZiXpPprw7EbYbnHMFrM/3NfzgYPi8K3lLbfHcCrY6o9SMesMYYwJtFbn0qkYInnpDXWSoSlWnAozvkdZmKZSUaMOLM3VrzqXSED+ryiHlf6qvnKATq6Ih3O7m2UKE1hpka1N49jSdhzJzPAwa9KxpHwtspn9cw6N3OOJK2hDLbp7puX5eEAgk8OkPegOoC6TQL3EzM8zv6ijGayhDKfjuBx8wurMwmF7jJmZmAvLJXFekOoUC8rcbhtaF4CsOKBLediCEvcFaHeT7cf5QZNTca8H67GMVcEFQ0aheNpjZm3rMN9j292+mhEA7MxOfXB2ME4zlN8EbLN202QU3NtAfu9D0vag8eO91nRvBBQDuN8aaPu0KnBjUmr1u0vbKH9gVMc8PaWqCmjJgSsjq9bb/+ifnHncoKtJW+wX37Ii8cCR/gmQfm4vorsaTjEwAwNxfER+ZQf2F0XV572R+DO8RL8HzvMm/V/GobCqcZVLz71bKsHmowZo61e1+R1vCaPcILU2lDPETzO3Md/K92I2iEM8/7Gs74eMY85NufqUMdg+cKpnW4/6Cc1rJa8npYHBsXvIgyE0rabeEDGDN/UekHJbzhaY6rCyfmEVMRByXUOjGvdey3d+PNAW4gMSygffLSZkgek+iDHXgBxZF8v6kLzK09/tAGjomHbGclAXOvT98wPk8xb1dtq6iJXIvF2312waw9KD6bRby5pYtlbvxx6kA+fsKJpScKEP/Mwwx6pTqmC/ef4M1Y3XvRcRg8vwjekO5ebo7D4P4KuPdl5rbQaiZaUzPu8jI+s7ELK7OFpMXcdiLyWmhGb/awCyfmtpd9fMDnGdGO6ITbbmY+CzuD7UhOoGs33ixmfSgUrRp49mEmjO0PeqJ4mFzm1tH68iYKhwlmbj7Iz2OikJhm5qpLfsMShcSTEHN23MUpMTUGeAsZ8cSpSOa8iJ+QAObDAyoQcRjGj0oA81yxq9ex1kQoA80K8B20mRVJ8NsBypyh2496aljhQ4lorfKEtzp24aiDObpJ5qMI9hdHUZPh5Qh4zf6wlikfLduHQWDHKKn7w49v+byp4mGtvMBik9W3hbZdDZEuZk71Ya0ayfSdNeON1+wPa+L2InR7zKEn41Dn5wjjzu25TXVT/7jXbw1PLNw43RlONZbGJ2oo5jL+sO5eU4s5QF3nd88n8aZ6+8W4kjUcHGlkSrRDKuQ02FBUphlAf+FX62Q0JzF3sX1f/8UwY5o5zwJ/WTj3+X12l28z5+zqy69f/wdUHyOW"; \ No newline at end of file diff --git a/docs/typedoc/core.html b/docs/typedoc/core.html deleted file mode 100644 index c67df8dc..00000000 --- a/docs/typedoc/core.html +++ /dev/null @@ -1 +0,0 @@ -core | whiteflag-js
                                                                                                                  whiteflag-js
                                                                                                                    Preparing search index...

                                                                                                                    Module core

                                                                                                                    Enumerations

                                                                                                                    WfErrorCode → WfErrorCode
                                                                                                                    WfMsgType → WfMsgType
                                                                                                                    WfVersion → WfVersion

                                                                                                                    Classes

                                                                                                                    WfCoreMessage → WfCoreMessage
                                                                                                                    WfProtocolError → WfProtocolError

                                                                                                                    Functions

                                                                                                                    decodeField → decodeField
                                                                                                                    decryptMessage → decryptMessage
                                                                                                                    encodeField → encodeField
                                                                                                                    encryptMessage → encryptMessage
                                                                                                                    isValidMessage → isValidMessage
                                                                                                                    isValidValue → isValidValue
                                                                                                                    validateMessage → validateMessage

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Enumerations
                                                                                                                    Classes
                                                                                                                    Functions
                                                                                                                    diff --git a/docs/typedoc/core/lib/codec.html b/docs/typedoc/core/lib/codec.html deleted file mode 100644 index 5c6186ca..00000000 --- a/docs/typedoc/core/lib/codec.html +++ /dev/null @@ -1 +0,0 @@ -core/lib/codec | whiteflag-js
                                                                                                                    whiteflag-js
                                                                                                                      Preparing search index...

                                                                                                                      Module core/lib/codec

                                                                                                                      Enumerations

                                                                                                                      WfCodec

                                                                                                                      Functions

                                                                                                                      decodeField
                                                                                                                      encodeField
                                                                                                                      isValidValue

                                                                                                                      Settings

                                                                                                                      Member Visibility

                                                                                                                      On This Page

                                                                                                                      Enumerations
                                                                                                                      Functions
                                                                                                                      diff --git a/docs/typedoc/core/lib/codec/WfCodec.html b/docs/typedoc/core/lib/codec/WfCodec.html deleted file mode 100644 index 10bb3790..00000000 --- a/docs/typedoc/core/lib/codec/WfCodec.html +++ /dev/null @@ -1,22 +0,0 @@ -WfCodec | whiteflag-js
                                                                                                                      whiteflag-js
                                                                                                                        Preparing search index...

                                                                                                                        Enumeration WfCodec

                                                                                                                        Whiteflag field encodings, defining the encoding of Whiteflag -message fields as defined by the Whiteflag specification -WfCodec

                                                                                                                        -

                                                                                                                        v1-draft.7

                                                                                                                        -

                                                                                                                        4.1.2 Message Encoding

                                                                                                                        -
                                                                                                                        Index

                                                                                                                        Enumeration Members

                                                                                                                        BIN -DATETIME -DEC -DURATION -HEX -LAT -LONG -UTF8 -

                                                                                                                        Enumeration Members

                                                                                                                        BIN: "binary"

                                                                                                                        Binary field

                                                                                                                        -
                                                                                                                        DATETIME: "datetime"

                                                                                                                        Datetime field

                                                                                                                        -
                                                                                                                        DEC: "decimal"

                                                                                                                        Decimal field

                                                                                                                        -
                                                                                                                        DURATION: "duration"

                                                                                                                        Duration field

                                                                                                                        -
                                                                                                                        HEX: "hexadecimal"

                                                                                                                        HExadecimal field

                                                                                                                        -
                                                                                                                        LAT: "latitude"

                                                                                                                        Latitude field

                                                                                                                        -
                                                                                                                        LONG: "longitude"

                                                                                                                        Longitude field

                                                                                                                        -
                                                                                                                        UTF8: "utf-8"

                                                                                                                        UTF-8 / ASCII text field

                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Enumeration Members
                                                                                                                        diff --git a/docs/typedoc/core/lib/codec/decodeField.html b/docs/typedoc/core/lib/codec/decodeField.html deleted file mode 100644 index 9ca8fa14..00000000 --- a/docs/typedoc/core/lib/codec/decodeField.html +++ /dev/null @@ -1,9 +0,0 @@ -decodeField | whiteflag-js
                                                                                                                        whiteflag-js
                                                                                                                          Preparing search index...

                                                                                                                          Function decodeField

                                                                                                                          • Function

                                                                                                                            Decodes a Whiteflag message field -decodeField

                                                                                                                            -

                                                                                                                            Parameters

                                                                                                                            • buffer: BinaryBuffer

                                                                                                                              a binary buffer with the encoded field

                                                                                                                              -
                                                                                                                            • codec: WfCodec

                                                                                                                              the message field encoding: 'utf-8', 'bin', 'dec', 'hex', 'datetime', 'duration', 'lat', 'long'

                                                                                                                              -
                                                                                                                            • version: v1 = WfVersion.v1

                                                                                                                              the version of the Whiteflag specification

                                                                                                                              -

                                                                                                                            Returns string

                                                                                                                            a string with the decoded field value

                                                                                                                            -

                                                                                                                            v1-draft.7

                                                                                                                            -

                                                                                                                            4.1.2 Message Encoding, 4.1.3 Message Compression

                                                                                                                            -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          diff --git a/docs/typedoc/core/lib/codec/encodeField.html b/docs/typedoc/core/lib/codec/encodeField.html deleted file mode 100644 index 00904962..00000000 --- a/docs/typedoc/core/lib/codec/encodeField.html +++ /dev/null @@ -1,9 +0,0 @@ -encodeField | whiteflag-js
                                                                                                                          whiteflag-js
                                                                                                                            Preparing search index...

                                                                                                                            Function encodeField

                                                                                                                            • Function

                                                                                                                              Encodes a Whiteflag message field -encodeField

                                                                                                                              -

                                                                                                                              Parameters

                                                                                                                              • value: string

                                                                                                                                the message field value

                                                                                                                                -
                                                                                                                              • codec: WfCodec

                                                                                                                                the message field encoding: 'utf-8', 'bin', 'dec', 'hex', 'datetime', 'duration', 'lat', 'long'

                                                                                                                                -
                                                                                                                              • version: v1 = WfVersion.v1

                                                                                                                                the version of the Whiteflag specification

                                                                                                                                -

                                                                                                                              Returns BinaryBuffer

                                                                                                                              a binary buffer with the compressed encoded field

                                                                                                                              -

                                                                                                                              v1-draft.7

                                                                                                                              -

                                                                                                                              4.1.2 Message Encoding, 4.1.3 Message Compression

                                                                                                                              -

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            diff --git a/docs/typedoc/core/lib/codec/isValidValue.html b/docs/typedoc/core/lib/codec/isValidValue.html deleted file mode 100644 index c6f6748f..00000000 --- a/docs/typedoc/core/lib/codec/isValidValue.html +++ /dev/null @@ -1,7 +0,0 @@ -isValidValue | whiteflag-js
                                                                                                                            whiteflag-js
                                                                                                                              Preparing search index...

                                                                                                                              Function isValidValue

                                                                                                                              • Function

                                                                                                                                Checks if the field value is valid -isValidValue

                                                                                                                                -

                                                                                                                                Parameters

                                                                                                                                • value: string

                                                                                                                                  the field value

                                                                                                                                  -
                                                                                                                                • codec: WfCodec

                                                                                                                                  the field encoding

                                                                                                                                  -
                                                                                                                                • version: v1 = WfVersion.v1

                                                                                                                                  the Whiteflag protocol version

                                                                                                                                  -

                                                                                                                                Returns boolean

                                                                                                                                true if valid, else false

                                                                                                                                -

                                                                                                                              Settings

                                                                                                                              Member Visibility
                                                                                                                              diff --git a/docs/typedoc/core/lib/errors.html b/docs/typedoc/core/lib/errors.html deleted file mode 100644 index da71f436..00000000 --- a/docs/typedoc/core/lib/errors.html +++ /dev/null @@ -1 +0,0 @@ -core/lib/errors | whiteflag-js
                                                                                                                              whiteflag-js
                                                                                                                                Preparing search index...

                                                                                                                                Module core/lib/errors

                                                                                                                                Enumerations

                                                                                                                                WfErrorCode

                                                                                                                                Classes

                                                                                                                                WfProtocolError

                                                                                                                                Functions

                                                                                                                                catchedError

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Enumerations
                                                                                                                                Classes
                                                                                                                                Functions
                                                                                                                                diff --git a/docs/typedoc/core/lib/errors/WfErrorCode.html b/docs/typedoc/core/lib/errors/WfErrorCode.html deleted file mode 100644 index 1fdb4030..00000000 --- a/docs/typedoc/core/lib/errors/WfErrorCode.html +++ /dev/null @@ -1,17 +0,0 @@ -WfErrorCode | whiteflag-js
                                                                                                                                whiteflag-js
                                                                                                                                  Preparing search index...

                                                                                                                                  Enumeration WfErrorCode

                                                                                                                                  Defines Whiteflag protocol errors -WfErrorCode

                                                                                                                                  -
                                                                                                                                  Index

                                                                                                                                  Enumeration Members

                                                                                                                                  AUTHENTICATION -ENCRYPTION -FORMAT -METAHEADER -PROTOCOL -REFERENCE -SIGNATURE -

                                                                                                                                  Enumeration Members

                                                                                                                                  AUTHENTICATION: "WF_AUTH_ERROR"

                                                                                                                                  Whiteflag message authentication error

                                                                                                                                  -
                                                                                                                                  ENCRYPTION: "WF_ENCRYPTION_ERROR"

                                                                                                                                  Whiteflag encryption error

                                                                                                                                  -
                                                                                                                                  FORMAT: "WF_FORMAT_ERROR"

                                                                                                                                  Whiteflag message format error

                                                                                                                                  -
                                                                                                                                  METAHEADER: "WF_METAHEADER_ERROR"

                                                                                                                                  Incorrect or missingWhiteflag message meta data

                                                                                                                                  -
                                                                                                                                  PROTOCOL: "WF_PROTOCOL_ERROR"

                                                                                                                                  Generic Whiteflag protocol error

                                                                                                                                  -
                                                                                                                                  REFERENCE: "WF_REFERENCE_ERROR"

                                                                                                                                  Whiteflag message reference error

                                                                                                                                  -
                                                                                                                                  SIGNATURE: "WF_SIGN_ERROR"

                                                                                                                                  Whiteflag signature error

                                                                                                                                  -

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Enumeration Members
                                                                                                                                  diff --git a/docs/typedoc/core/lib/errors/WfProtocolError.html b/docs/typedoc/core/lib/errors/WfProtocolError.html deleted file mode 100644 index cb0e87ee..00000000 --- a/docs/typedoc/core/lib/errors/WfProtocolError.html +++ /dev/null @@ -1,43 +0,0 @@ -WfProtocolError | whiteflag-js
                                                                                                                                  whiteflag-js
                                                                                                                                    Preparing search index...

                                                                                                                                    Class WfProtocolError

                                                                                                                                    Error class for Whiteflag protocol and message errors -ProtocolError

                                                                                                                                    -

                                                                                                                                    Hierarchy

                                                                                                                                    • Error
                                                                                                                                      • WfProtocolError
                                                                                                                                    Index

                                                                                                                                    Constructors

                                                                                                                                    constructor -

                                                                                                                                    Properties

                                                                                                                                    cause? -causes -code -message -name -stack? -stackTraceLimit -

                                                                                                                                    Methods

                                                                                                                                    captureStackTrace -prepareStackTrace -

                                                                                                                                    Constructors

                                                                                                                                    • Constructor for protocol errors

                                                                                                                                      -

                                                                                                                                      Parameters

                                                                                                                                      • message: string

                                                                                                                                        a human readable error message

                                                                                                                                        -
                                                                                                                                      • causes: any

                                                                                                                                        underlying errors causing this error

                                                                                                                                        -
                                                                                                                                      • code: WfErrorCode = WfErrorCode.PROTOCOL

                                                                                                                                        constant identifying the error

                                                                                                                                        -

                                                                                                                                      Returns WfProtocolError

                                                                                                                                    Properties

                                                                                                                                    cause?: unknown
                                                                                                                                    causes: string[]

                                                                                                                                    Underlying causes of the error

                                                                                                                                    -
                                                                                                                                    code: string

                                                                                                                                    The Whiteflag protocol error code

                                                                                                                                    -
                                                                                                                                    message: string
                                                                                                                                    name: string
                                                                                                                                    stack?: string
                                                                                                                                    stackTraceLimit: number

                                                                                                                                    The Error.stackTraceLimit property specifies the number of stack frames -collected by a stack trace (whether generated by new Error().stack or -Error.captureStackTrace(obj)).

                                                                                                                                    -

                                                                                                                                    The default value is 10 but may be set to any valid JavaScript number. Changes -will affect any stack trace captured after the value has been changed.

                                                                                                                                    -

                                                                                                                                    If set to a non-number value, or set to a negative number, stack traces will -not capture any frames.

                                                                                                                                    -

                                                                                                                                    Methods

                                                                                                                                    • Creates a .stack property on targetObject, which when accessed returns -a string representing the location in the code at which -Error.captureStackTrace() was called.

                                                                                                                                      -
                                                                                                                                      const myObject = {};
                                                                                                                                      Error.captureStackTrace(myObject);
                                                                                                                                      myObject.stack;  // Similar to `new Error().stack`
-
                                                                                                                                      - -

                                                                                                                                      The first line of the trace will be prefixed with -${myObject.name}: ${myObject.message}.

                                                                                                                                      -

                                                                                                                                      The optional constructorOpt argument accepts a function. If given, all frames -above constructorOpt, including constructorOpt, will be omitted from the -generated stack trace.

                                                                                                                                      -

                                                                                                                                      The constructorOpt argument is useful for hiding implementation -details of error generation from the user. For instance:

                                                                                                                                      -
                                                                                                                                      function a() {
                                                                                                                                        b();
                                                                                                                                      }

                                                                                                                                      function b() {
                                                                                                                                        c();
                                                                                                                                      }

                                                                                                                                      function c() {
                                                                                                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                                        const { stackTraceLimit } = Error;
                                                                                                                                        Error.stackTraceLimit = 0;
                                                                                                                                        const error = new Error();
                                                                                                                                        Error.stackTraceLimit = stackTraceLimit;

                                                                                                                                        // Capture the stack trace above function b
                                                                                                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                                        throw error;
                                                                                                                                      }

                                                                                                                                      a();
-
                                                                                                                                      - -

                                                                                                                                      Parameters

                                                                                                                                      • targetObject: object
                                                                                                                                      • OptionalconstructorOpt: Function

                                                                                                                                      Returns void

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Constructors
                                                                                                                                    Properties
                                                                                                                                    Methods
                                                                                                                                    diff --git a/docs/typedoc/core/lib/errors/catchedError.html b/docs/typedoc/core/lib/errors/catchedError.html deleted file mode 100644 index 54220f55..00000000 --- a/docs/typedoc/core/lib/errors/catchedError.html +++ /dev/null @@ -1,5 +0,0 @@ -catchedError | whiteflag-js
                                                                                                                                    whiteflag-js
                                                                                                                                      Preparing search index...

                                                                                                                                      Function catchedError

                                                                                                                                      • Processes a catched error in a type safe manner

                                                                                                                                        -

                                                                                                                                        Parameters

                                                                                                                                        • msg: string = 'Unspecified error'

                                                                                                                                          a generic message to use if no specific error message

                                                                                                                                          -
                                                                                                                                        • err: any = ...

                                                                                                                                          the error to handle

                                                                                                                                          -

                                                                                                                                        Returns WfProtocolError

                                                                                                                                        a new error object

                                                                                                                                        -

                                                                                                                                      Settings

                                                                                                                                      Member Visibility
                                                                                                                                      diff --git a/docs/typedoc/core/lib/message.html b/docs/typedoc/core/lib/message.html deleted file mode 100644 index c7848a7d..00000000 --- a/docs/typedoc/core/lib/message.html +++ /dev/null @@ -1 +0,0 @@ -core/lib/message | whiteflag-js
                                                                                                                                      whiteflag-js
                                                                                                                                        Preparing search index...

                                                                                                                                        Module core/lib/message

                                                                                                                                        Enumerations

                                                                                                                                        WfMsgType

                                                                                                                                        Classes

                                                                                                                                        WfCoreMessage

                                                                                                                                        Functions

                                                                                                                                        decryptMessage
                                                                                                                                        encryptMessage
                                                                                                                                        isValidMessage
                                                                                                                                        validateMessage

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Enumerations
                                                                                                                                        Classes
                                                                                                                                        Functions
                                                                                                                                        diff --git a/docs/typedoc/core/lib/message/WfCoreMessage.html b/docs/typedoc/core/lib/message/WfCoreMessage.html deleted file mode 100644 index b245591d..00000000 --- a/docs/typedoc/core/lib/message/WfCoreMessage.html +++ /dev/null @@ -1,95 +0,0 @@ -WfCoreMessage | whiteflag-js
                                                                                                                                        whiteflag-js
                                                                                                                                          Preparing search index...

                                                                                                                                          Class WfCoreMessage

                                                                                                                                          A core Whiteflag message as defined by the Whiteflag specification -WfCoreMessage

                                                                                                                                          -

                                                                                                                                          v1-draft.7

                                                                                                                                          -

                                                                                                                                          4 Message Format

                                                                                                                                          -

                                                                                                                                          Ths class represents a core Whiteflag message as -defined by the Whiteflag specification. It has a message header and -a message body which contain the message fields as specified for the -message type. It performs the encoding/encryption and decoding/decryption -to and from binary messages. Since the processing of Whiteflag messges -in accordance with the protocol requires additional metadata, the extrended -WfMessage class of the @whitelag/protol package should normallly be -used instead of this class.

                                                                                                                                          -

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Constructors

                                                                                                                                          constructor -

                                                                                                                                          Methods

                                                                                                                                          decode -encode -get -isEncoded -isValid -set -toHex -toObject -toString -toU8a -validate -fromBinary -fromHex -fromObject -fromU8a -

                                                                                                                                          Constructors

                                                                                                                                          Methods

                                                                                                                                          • Function

                                                                                                                                            Encodes the message, making the contents final -encode

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                              the input key material to derive the encryption key, if the message is to be encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                              the binary encoded originator address, if the message is to be encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                              the initialisation vector, if required for the encryption method

                                                                                                                                              -

                                                                                                                                            Returns Promise<WfCoreMessage>

                                                                                                                                            this Whitedlag message object with the encoded message

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns the value of the specified message field -get

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • fieldName: string

                                                                                                                                              the name of the message field

                                                                                                                                              -

                                                                                                                                            Returns string | null

                                                                                                                                            the value of the message field

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Indicates if the message has already been encoded -isEncoded

                                                                                                                                            -

                                                                                                                                            Returns boolean

                                                                                                                                            true if message has been encoded, else false

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Indicates if the message is valid, i.e. if all fields contain valid values -isValid

                                                                                                                                            -

                                                                                                                                            Returns boolean

                                                                                                                                            true if message is valid, else false

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Sets the value of the specified message field, if the message has not been encoded -set

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • fieldName: string

                                                                                                                                              the name of the message field

                                                                                                                                              -
                                                                                                                                            • value: string

                                                                                                                                              the value to set

                                                                                                                                              -

                                                                                                                                            Returns boolean

                                                                                                                                            true if succesful, else false

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns the Whiteflag message encoded as a hexadecimal string -toHex

                                                                                                                                            -

                                                                                                                                            Returns string

                                                                                                                                            a hexadecimal string with the encoded message

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns the Whiteflag message as a plain object -toObject

                                                                                                                                            -

                                                                                                                                            Returns Object

                                                                                                                                            the message as a plain object

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns the Whiteflag message as a string -toString

                                                                                                                                            -

                                                                                                                                            Returns string

                                                                                                                                            a concatinated string of field values

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns the encoded Whiteflag message as a UInt8array -toU8a

                                                                                                                                            -

                                                                                                                                            Returns Uint8Array

                                                                                                                                            a UInt8array with the encoded message

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Returns message validation errors -validate

                                                                                                                                            -

                                                                                                                                            Returns string[]

                                                                                                                                            an array of validation errors

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Creates new Whiteflag message from a binary buffer -fromBinary

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • message: BinaryBuffer

                                                                                                                                              a binary buffer with the encoded message

                                                                                                                                              -
                                                                                                                                            • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                              the input key material to derive the encryption key, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                              the binary encoded originator address, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                              the initialisation vector, if required for the encryption method

                                                                                                                                              -

                                                                                                                                            Returns Promise<WfCoreMessage>

                                                                                                                                            a new Whiteflag message object with the decoded message

                                                                                                                                            -

                                                                                                                                          • Creates new Whiteflag message from a hexadecimal encoded string

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • message: string

                                                                                                                                              atring with the hexadecimal encoded message

                                                                                                                                              -
                                                                                                                                            • Optionalikm: string

                                                                                                                                              the hexadecimalinput key material to derive the encryption key, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaladdress: string

                                                                                                                                              the hexadecimal encoded originator address, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaliv: string

                                                                                                                                              the hexadecimal initialisation vector, if required for the encryption method

                                                                                                                                              -

                                                                                                                                            Returns Promise<WfCoreMessage>

                                                                                                                                            a new Whiteflag message object with the decoded message

                                                                                                                                            -
                                                                                                                                          • Function

                                                                                                                                            Creates new Whiteflag message from a plain object -fromObject

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • message: any

                                                                                                                                              a plain JavaScript object with message header and body

                                                                                                                                              -

                                                                                                                                            Returns Promise<WfCoreMessage>

                                                                                                                                            a new Whiteflag message object

                                                                                                                                            -

                                                                                                                                          • Creates new Whiteflag message from a binary encoded message

                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            • message: Uint8Array

                                                                                                                                              a Uint8Array with the binary encoded message

                                                                                                                                              -
                                                                                                                                            • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                              the input key material to derive the encryption key, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                              the binary encoded originator address, if the message is encrypted

                                                                                                                                              -
                                                                                                                                            • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                              the initialisation vector, if required for the encryption method

                                                                                                                                              -

                                                                                                                                            Returns Promise<WfCoreMessage>

                                                                                                                                            a new Whiteflag message object with the decoded message

                                                                                                                                            -

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Constructors
                                                                                                                                          Methods
                                                                                                                                          diff --git a/docs/typedoc/core/lib/message/WfMsgType.html b/docs/typedoc/core/lib/message/WfMsgType.html deleted file mode 100644 index 5517e1af..00000000 --- a/docs/typedoc/core/lib/message/WfMsgType.html +++ /dev/null @@ -1,30 +0,0 @@ -WfMsgType | whiteflag-js
                                                                                                                                          whiteflag-js
                                                                                                                                            Preparing search index...

                                                                                                                                            Enumeration WfMsgType

                                                                                                                                            Whiteflag message types, defining the types of Whiteflag message -as specified by the Whiteflag standard -WfFieldType

                                                                                                                                            -

                                                                                                                                            v1-draft.7

                                                                                                                                            -

                                                                                                                                            2.4.2.1 Functional Messages, 2.4.2.2 Management Messages

                                                                                                                                            -
                                                                                                                                            Index

                                                                                                                                            Enumeration Members

                                                                                                                                            A -D -E -F -I -K -M -P -Q -R -S -T -

                                                                                                                                            Enumeration Members

                                                                                                                                            A: "A"

                                                                                                                                            Authentication message

                                                                                                                                            -
                                                                                                                                            D: "D"

                                                                                                                                            Protection sign

                                                                                                                                            -
                                                                                                                                            E: "E"

                                                                                                                                            Emergency signal

                                                                                                                                            -
                                                                                                                                            F: "F"

                                                                                                                                            Free text message

                                                                                                                                            -
                                                                                                                                            I: "I"

                                                                                                                                            Infrstructure sign

                                                                                                                                            -
                                                                                                                                            K: "K"

                                                                                                                                            Cryptographic support message

                                                                                                                                            -
                                                                                                                                            M: "M"

                                                                                                                                            Mission signal

                                                                                                                                            -
                                                                                                                                            P: "P"

                                                                                                                                            Protection sign

                                                                                                                                            -
                                                                                                                                            Q: "Q"

                                                                                                                                            Request signal

                                                                                                                                            -
                                                                                                                                            R: "R"

                                                                                                                                            Reference message

                                                                                                                                            -
                                                                                                                                            S: "S"

                                                                                                                                            Status signal

                                                                                                                                            -
                                                                                                                                            T: "T"

                                                                                                                                            Test message

                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Enumeration Members
                                                                                                                                            diff --git a/docs/typedoc/core/lib/message/decryptMessage.html b/docs/typedoc/core/lib/message/decryptMessage.html deleted file mode 100644 index 60d97bbf..00000000 --- a/docs/typedoc/core/lib/message/decryptMessage.html +++ /dev/null @@ -1,10 +0,0 @@ -decryptMessage | whiteflag-js
                                                                                                                                            whiteflag-js
                                                                                                                                              Preparing search index...

                                                                                                                                              Function decryptMessage

                                                                                                                                              • Function

                                                                                                                                                Decrypts an encrypted binary message -decryptMessage

                                                                                                                                                -

                                                                                                                                                Parameters

                                                                                                                                                • message: BinaryBuffer

                                                                                                                                                  a binary buffer with the encrypted message

                                                                                                                                                  -
                                                                                                                                                • method: WfCryptoMethod

                                                                                                                                                  the Whiteflag encryption method

                                                                                                                                                  -
                                                                                                                                                • ikm: Uint8Array

                                                                                                                                                  the input key material to derive the encryption key

                                                                                                                                                  -
                                                                                                                                                • address: Uint8Array

                                                                                                                                                  the binary encoded originator address

                                                                                                                                                  -
                                                                                                                                                • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                                  the initialisation vector, if required for the encryption method

                                                                                                                                                  -
                                                                                                                                                • version: v1 = WfVersion.v1

                                                                                                                                                  the Whiteflag protocol version

                                                                                                                                                  -

                                                                                                                                                Returns Promise<BinaryBuffer>

                                                                                                                                                the decrypted binary encoded message

                                                                                                                                                -

                                                                                                                                              Settings

                                                                                                                                              Member Visibility
                                                                                                                                              diff --git a/docs/typedoc/core/lib/message/encryptMessage.html b/docs/typedoc/core/lib/message/encryptMessage.html deleted file mode 100644 index c15ecf35..00000000 --- a/docs/typedoc/core/lib/message/encryptMessage.html +++ /dev/null @@ -1,10 +0,0 @@ -encryptMessage | whiteflag-js
                                                                                                                                              whiteflag-js
                                                                                                                                                Preparing search index...

                                                                                                                                                Function encryptMessage

                                                                                                                                                • Function

                                                                                                                                                  Encrypts a binary encoded message -encryptMessage

                                                                                                                                                  -

                                                                                                                                                  Parameters

                                                                                                                                                  • message: BinaryBuffer

                                                                                                                                                    a binary buffer with the binary encoded message

                                                                                                                                                    -
                                                                                                                                                  • method: WfCryptoMethod

                                                                                                                                                    the Whiteflag encryption method

                                                                                                                                                    -
                                                                                                                                                  • ikm: Uint8Array

                                                                                                                                                    the input key material to derive the encryption key

                                                                                                                                                    -
                                                                                                                                                  • address: Uint8Array

                                                                                                                                                    the binary encoded originator address

                                                                                                                                                    -
                                                                                                                                                  • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                                    the initialisation vector, if required for the encryption method

                                                                                                                                                    -
                                                                                                                                                  • version: v1 = WfVersion.v1

                                                                                                                                                    the Whiteflag protocol version

                                                                                                                                                    -

                                                                                                                                                  Returns Promise<BinaryBuffer>

                                                                                                                                                  the encrypted message

                                                                                                                                                  -

                                                                                                                                                Settings

                                                                                                                                                Member Visibility
                                                                                                                                                diff --git a/docs/typedoc/core/lib/message/isValidMessage.html b/docs/typedoc/core/lib/message/isValidMessage.html deleted file mode 100644 index 64126d0d..00000000 --- a/docs/typedoc/core/lib/message/isValidMessage.html +++ /dev/null @@ -1,5 +0,0 @@ -isValidMessage | whiteflag-js
                                                                                                                                                whiteflag-js
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Function isValidMessage

                                                                                                                                                  • Function

                                                                                                                                                    Checks if an object is a valid Whiteflag message -isValidMessage

                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    • message: any

                                                                                                                                                      the message object to validate

                                                                                                                                                      -

                                                                                                                                                    Returns boolean

                                                                                                                                                    true if message is valid, else false

                                                                                                                                                    -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  diff --git a/docs/typedoc/core/lib/message/validateMessage.html b/docs/typedoc/core/lib/message/validateMessage.html deleted file mode 100644 index 65ece762..00000000 --- a/docs/typedoc/core/lib/message/validateMessage.html +++ /dev/null @@ -1,5 +0,0 @@ -validateMessage | whiteflag-js
                                                                                                                                                  whiteflag-js
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Function validateMessage

                                                                                                                                                    • Function

                                                                                                                                                      Checks a message object for validation errors -validateMessage

                                                                                                                                                      -

                                                                                                                                                      Parameters

                                                                                                                                                      • message: any

                                                                                                                                                        the message object to validate

                                                                                                                                                        -

                                                                                                                                                      Returns string[]

                                                                                                                                                      an array of validation errors

                                                                                                                                                      -

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility
                                                                                                                                                    diff --git a/docs/typedoc/core/lib/versions.html b/docs/typedoc/core/lib/versions.html deleted file mode 100644 index bda189e5..00000000 --- a/docs/typedoc/core/lib/versions.html +++ /dev/null @@ -1 +0,0 @@ -core/lib/versions | whiteflag-js
                                                                                                                                                    whiteflag-js
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Module core/lib/versions

                                                                                                                                                      Enumerations

                                                                                                                                                      WfVersion

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Enumerations
                                                                                                                                                      diff --git a/docs/typedoc/core/lib/versions/WfVersion.html b/docs/typedoc/core/lib/versions/WfVersion.html deleted file mode 100644 index 1c512390..00000000 --- a/docs/typedoc/core/lib/versions/WfVersion.html +++ /dev/null @@ -1,5 +0,0 @@ -WfVersion | whiteflag-js
                                                                                                                                                      whiteflag-js
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Enumeration WfVersion

                                                                                                                                                        Defines Whiteflag versions -WfVersion

                                                                                                                                                        -
                                                                                                                                                        Index

                                                                                                                                                        Enumeration Members

                                                                                                                                                        v1 -

                                                                                                                                                        Enumeration Members

                                                                                                                                                        v1: "1"

                                                                                                                                                        Whiteflag version 1

                                                                                                                                                        -

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        On This Page

                                                                                                                                                        Enumeration Members
                                                                                                                                                        diff --git a/docs/typedoc/crypto.html b/docs/typedoc/crypto.html deleted file mode 100644 index 879bd76b..00000000 --- a/docs/typedoc/crypto.html +++ /dev/null @@ -1 +0,0 @@ -crypto | whiteflag-js
                                                                                                                                                        whiteflag-js
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Module crypto

                                                                                                                                                          Enumerations

                                                                                                                                                          WfCryptoMethod → WfCryptoMethod

                                                                                                                                                          Functions

                                                                                                                                                          createAesKey → createAesKey
                                                                                                                                                          createHmacKey → createHmacKey
                                                                                                                                                          decrypt → decrypt
                                                                                                                                                          deriveKey → deriveKey
                                                                                                                                                          encrypt → encrypt
                                                                                                                                                          hash → hash
                                                                                                                                                          hkdf → hkdf
                                                                                                                                                          hmac → hmac

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Enumerations
                                                                                                                                                          Functions
                                                                                                                                                          diff --git a/docs/typedoc/crypto/lib/cipher.html b/docs/typedoc/crypto/lib/cipher.html deleted file mode 100644 index 4d481138..00000000 --- a/docs/typedoc/crypto/lib/cipher.html +++ /dev/null @@ -1 +0,0 @@ -crypto/lib/cipher | whiteflag-js
                                                                                                                                                          whiteflag-js
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Module crypto/lib/cipher

                                                                                                                                                            Enumerations

                                                                                                                                                            WfCryptoMethod

                                                                                                                                                            Functions

                                                                                                                                                            decrypt
                                                                                                                                                            deriveKey
                                                                                                                                                            encrypt

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Enumerations
                                                                                                                                                            Functions
                                                                                                                                                            diff --git a/docs/typedoc/crypto/lib/cipher/WfCryptoMethod.html b/docs/typedoc/crypto/lib/cipher/WfCryptoMethod.html deleted file mode 100644 index afc03dc6..00000000 --- a/docs/typedoc/crypto/lib/cipher/WfCryptoMethod.html +++ /dev/null @@ -1,10 +0,0 @@ -WfCryptoMethod | whiteflag-js
                                                                                                                                                            whiteflag-js
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Enumeration WfCryptoMethod

                                                                                                                                                              Whiteflag encryption methods, defining the encryption methods -for Whiteflag messages as specified by the Whiteflag standard -WfCryptoMethod

                                                                                                                                                              -

                                                                                                                                                              v1-draft.7

                                                                                                                                                              -

                                                                                                                                                              5.2.4 Message Encryption

                                                                                                                                                              -
                                                                                                                                                              Index

                                                                                                                                                              Enumeration Members

                                                                                                                                                              ECDH -PSK -

                                                                                                                                                              Enumeration Members

                                                                                                                                                              ECDH: "1"

                                                                                                                                                              Whiteflag encryption method 1: negotiated key

                                                                                                                                                              -
                                                                                                                                                              PSK: "2"

                                                                                                                                                              Whiteflag encryption method 2: pre-shared key

                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility

                                                                                                                                                              On This Page

                                                                                                                                                              Enumeration Members
                                                                                                                                                              diff --git a/docs/typedoc/crypto/lib/cipher/decrypt.html b/docs/typedoc/crypto/lib/cipher/decrypt.html deleted file mode 100644 index 160be003..00000000 --- a/docs/typedoc/crypto/lib/cipher/decrypt.html +++ /dev/null @@ -1,10 +0,0 @@ -decrypt | whiteflag-js
                                                                                                                                                              whiteflag-js
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Function decrypt

                                                                                                                                                                • Function

                                                                                                                                                                  Decrypts a message based on the specified encryption method -decrypt

                                                                                                                                                                  -

                                                                                                                                                                  Parameters

                                                                                                                                                                  • message: Uint8Array<ArrayBuffer>

                                                                                                                                                                    the message to be decyrpted

                                                                                                                                                                    -
                                                                                                                                                                  • method: WfCryptoMethod

                                                                                                                                                                    the Whiteflag encryption method

                                                                                                                                                                    -
                                                                                                                                                                  • key: CryptoKey

                                                                                                                                                                    the encryption key

                                                                                                                                                                    -
                                                                                                                                                                  • Optionaliv: Uint8Array<ArrayBuffer>

                                                                                                                                                                    the initialisation vector, if required for the method

                                                                                                                                                                    -
                                                                                                                                                                  • version: v1 = WfVersion.v1

                                                                                                                                                                    the Whiteflag protocol version

                                                                                                                                                                    -

                                                                                                                                                                  Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                  v1-draft.7

                                                                                                                                                                  -

                                                                                                                                                                  5.2.4 Message Encryption

                                                                                                                                                                  -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility
                                                                                                                                                                diff --git a/docs/typedoc/crypto/lib/cipher/deriveKey.html b/docs/typedoc/crypto/lib/cipher/deriveKey.html deleted file mode 100644 index 914baa3b..00000000 --- a/docs/typedoc/crypto/lib/cipher/deriveKey.html +++ /dev/null @@ -1,10 +0,0 @@ -deriveKey | whiteflag-js
                                                                                                                                                                whiteflag-js
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Function deriveKey

                                                                                                                                                                  • Function

                                                                                                                                                                    Derives the encryption key based on the Whiteflag encryption method -deriveKey

                                                                                                                                                                    -

                                                                                                                                                                    Parameters

                                                                                                                                                                    • ikm: Uint8Array<ArrayBuffer>

                                                                                                                                                                      the raw input key material

                                                                                                                                                                      -
                                                                                                                                                                    • method: WfCryptoMethod

                                                                                                                                                                      the Whiteflag encryption method

                                                                                                                                                                      -
                                                                                                                                                                    • info: Uint8Array<ArrayBuffer>

                                                                                                                                                                      information to bind the key, e.g. the blockchain address of the originator

                                                                                                                                                                      -
                                                                                                                                                                    • version: v1 = WfVersion.v1

                                                                                                                                                                      the Whiteflag protocol version

                                                                                                                                                                      -

                                                                                                                                                                    Returns Promise<CryptoKey>

                                                                                                                                                                    the encryption key

                                                                                                                                                                    -

                                                                                                                                                                    v1-draft.7

                                                                                                                                                                    -

                                                                                                                                                                    5.2.3 Encryption Key and Authentication Token Derivation

                                                                                                                                                                    -

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility
                                                                                                                                                                  diff --git a/docs/typedoc/crypto/lib/cipher/encrypt.html b/docs/typedoc/crypto/lib/cipher/encrypt.html deleted file mode 100644 index edc333c2..00000000 --- a/docs/typedoc/crypto/lib/cipher/encrypt.html +++ /dev/null @@ -1,10 +0,0 @@ -encrypt | whiteflag-js
                                                                                                                                                                  whiteflag-js
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Function encrypt

                                                                                                                                                                    • Function

                                                                                                                                                                      Encrypts a message based on the specified encryption method -encrypt

                                                                                                                                                                      -

                                                                                                                                                                      Parameters

                                                                                                                                                                      • message: Uint8Array<ArrayBuffer>

                                                                                                                                                                        the message to be encrypted

                                                                                                                                                                        -
                                                                                                                                                                      • method: WfCryptoMethod

                                                                                                                                                                        the Whiteflag encryption method

                                                                                                                                                                        -
                                                                                                                                                                      • key: CryptoKey

                                                                                                                                                                        the input key material for the encryption key

                                                                                                                                                                        -
                                                                                                                                                                      • Optionaliv: Uint8Array<ArrayBuffer>

                                                                                                                                                                        the initialisation vector, if required for the method

                                                                                                                                                                        -
                                                                                                                                                                      • version: v1 = WfVersion.v1

                                                                                                                                                                        the Whiteflag protocol version

                                                                                                                                                                        -

                                                                                                                                                                      Returns Promise<Uint8Array<ArrayBufferLike>>

                                                                                                                                                                      v1-draft.7

                                                                                                                                                                      -

                                                                                                                                                                      5.2.4 Message Encryption

                                                                                                                                                                      -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility
                                                                                                                                                                    diff --git a/docs/typedoc/crypto/lib/common.html b/docs/typedoc/crypto/lib/common.html deleted file mode 100644 index ff0f8ab9..00000000 --- a/docs/typedoc/crypto/lib/common.html +++ /dev/null @@ -1 +0,0 @@ -crypto/lib/common | whiteflag-js
                                                                                                                                                                    whiteflag-js
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Module crypto/lib/common

                                                                                                                                                                      Functions

                                                                                                                                                                      zeroise

                                                                                                                                                                      Settings

                                                                                                                                                                      Member Visibility

                                                                                                                                                                      On This Page

                                                                                                                                                                      Functions
                                                                                                                                                                      diff --git a/docs/typedoc/crypto/lib/common/zeroise.html b/docs/typedoc/crypto/lib/common/zeroise.html deleted file mode 100644 index 34a072c7..00000000 --- a/docs/typedoc/crypto/lib/common/zeroise.html +++ /dev/null @@ -1,5 +0,0 @@ -zeroise | whiteflag-js
                                                                                                                                                                      whiteflag-js
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Function zeroise

                                                                                                                                                                        • Function

                                                                                                                                                                          Basic zeroisation function -zeroise

                                                                                                                                                                          -

                                                                                                                                                                          Parameters

                                                                                                                                                                          • u8array: Uint8Array

                                                                                                                                                                            typed array to zeroise

                                                                                                                                                                            -

                                                                                                                                                                          Returns Uint8Array

                                                                                                                                                                          the zeroised typed array

                                                                                                                                                                          -

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        diff --git a/docs/typedoc/crypto/lib/hash.html b/docs/typedoc/crypto/lib/hash.html deleted file mode 100644 index 850d93a0..00000000 --- a/docs/typedoc/crypto/lib/hash.html +++ /dev/null @@ -1 +0,0 @@ -crypto/lib/hash | whiteflag-js
                                                                                                                                                                        whiteflag-js
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Module crypto/lib/hash

                                                                                                                                                                          Functions

                                                                                                                                                                          hash
                                                                                                                                                                          hkdf
                                                                                                                                                                          hmac

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Functions
                                                                                                                                                                          diff --git a/docs/typedoc/crypto/lib/hash/hash.html b/docs/typedoc/crypto/lib/hash/hash.html deleted file mode 100644 index cd278e21..00000000 --- a/docs/typedoc/crypto/lib/hash/hash.html +++ /dev/null @@ -1,7 +0,0 @@ -hash | whiteflag-js
                                                                                                                                                                          whiteflag-js
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Function hash

                                                                                                                                                                            • Function

                                                                                                                                                                              Basic hashing function -hash

                                                                                                                                                                              -

                                                                                                                                                                              Parameters

                                                                                                                                                                              • data: Uint8Array<ArrayBuffer>

                                                                                                                                                                                data to hash

                                                                                                                                                                                -
                                                                                                                                                                              • length: number = HASHLEN

                                                                                                                                                                                the required output length in octets; default is 32

                                                                                                                                                                                -
                                                                                                                                                                              • algorithm: string = HASHALG

                                                                                                                                                                                the hash algorithm to be used; default is SHA-256

                                                                                                                                                                                -

                                                                                                                                                                              Returns Promise<Uint8Array<ArrayBuffer>>

                                                                                                                                                                              the hash value

                                                                                                                                                                              -

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility
                                                                                                                                                                            diff --git a/docs/typedoc/crypto/lib/hash/hkdf.html b/docs/typedoc/crypto/lib/hash/hkdf.html deleted file mode 100644 index 8e855feb..00000000 --- a/docs/typedoc/crypto/lib/hash/hkdf.html +++ /dev/null @@ -1,8 +0,0 @@ -hkdf | whiteflag-js
                                                                                                                                                                            whiteflag-js
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Function hkdf

                                                                                                                                                                              • Function

                                                                                                                                                                                Hash-based Key Derivation Function using SHA-256 i.a.w. RFC 5869 -hkdf

                                                                                                                                                                                -

                                                                                                                                                                                Parameters

                                                                                                                                                                                • ikm: Uint8Array<ArrayBuffer>

                                                                                                                                                                                  input key material

                                                                                                                                                                                  -
                                                                                                                                                                                • salt: Uint8Array<ArrayBuffer>

                                                                                                                                                                                  salt

                                                                                                                                                                                  -
                                                                                                                                                                                • info: Uint8Array<ArrayBuffer>

                                                                                                                                                                                  info

                                                                                                                                                                                  -
                                                                                                                                                                                • keylen: number

                                                                                                                                                                                  output key length in octets

                                                                                                                                                                                  -

                                                                                                                                                                                Returns Promise<Uint8Array<ArrayBuffer>>

                                                                                                                                                                                generated key

                                                                                                                                                                                -

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility
                                                                                                                                                                              diff --git a/docs/typedoc/crypto/lib/hash/hmac.html b/docs/typedoc/crypto/lib/hash/hmac.html deleted file mode 100644 index d5dfd859..00000000 --- a/docs/typedoc/crypto/lib/hash/hmac.html +++ /dev/null @@ -1,7 +0,0 @@ -hmac | whiteflag-js
                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Function hmac

                                                                                                                                                                                • Function

                                                                                                                                                                                  Hash-Based Message Authentication Code function -hmac

                                                                                                                                                                                  -

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  • rawKey: Uint8Array<ArrayBuffer>

                                                                                                                                                                                    the raw HMAC key

                                                                                                                                                                                    -
                                                                                                                                                                                  • message: Uint8Array<ArrayBuffer>

                                                                                                                                                                                    the message to authenticate

                                                                                                                                                                                    -
                                                                                                                                                                                  • algorithm: string = HASHALG

                                                                                                                                                                                    the hash algorithm to be used; default is SHA-256

                                                                                                                                                                                    -

                                                                                                                                                                                  Returns Promise<Uint8Array<ArrayBuffer>>

                                                                                                                                                                                  the message authentication code

                                                                                                                                                                                  -

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                diff --git a/docs/typedoc/crypto/lib/keys.html b/docs/typedoc/crypto/lib/keys.html deleted file mode 100644 index 8c82f40c..00000000 --- a/docs/typedoc/crypto/lib/keys.html +++ /dev/null @@ -1 +0,0 @@ -crypto/lib/keys | whiteflag-js
                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Module crypto/lib/keys

                                                                                                                                                                                  Functions

                                                                                                                                                                                  createAesKey
                                                                                                                                                                                  createHmacKey

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Functions
                                                                                                                                                                                  diff --git a/docs/typedoc/crypto/lib/keys/createAesKey.html b/docs/typedoc/crypto/lib/keys/createAesKey.html deleted file mode 100644 index ea398995..00000000 --- a/docs/typedoc/crypto/lib/keys/createAesKey.html +++ /dev/null @@ -1,6 +0,0 @@ -createAesKey | whiteflag-js
                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Function createAesKey

                                                                                                                                                                                    • Function

                                                                                                                                                                                      Creates an AES encryption and decryption key -createAesKey

                                                                                                                                                                                      -

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      • rawKey: Uint8Array<ArrayBuffer>

                                                                                                                                                                                        the raw key

                                                                                                                                                                                        -
                                                                                                                                                                                      • algorithm: string = DEFAULT_ENCRYPTALG

                                                                                                                                                                                        the AES mode to use the key for, default is CTR mode

                                                                                                                                                                                        -

                                                                                                                                                                                      Returns Promise<CryptoKey>

                                                                                                                                                                                      the AES enrcyption key

                                                                                                                                                                                      -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    diff --git a/docs/typedoc/crypto/lib/keys/createHmacKey.html b/docs/typedoc/crypto/lib/keys/createHmacKey.html deleted file mode 100644 index de62255d..00000000 --- a/docs/typedoc/crypto/lib/keys/createHmacKey.html +++ /dev/null @@ -1,6 +0,0 @@ -createHmacKey | whiteflag-js
                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Function createHmacKey

                                                                                                                                                                                      • Function

                                                                                                                                                                                        Creates an HMAC signing key -createHmacKey

                                                                                                                                                                                        -

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        • rawKey: Uint8Array<ArrayBuffer>

                                                                                                                                                                                          the raw key

                                                                                                                                                                                          -
                                                                                                                                                                                        • algorithm: string = DEFAULT_HASHALG

                                                                                                                                                                                          the hashing algorithm, default is SHA-256

                                                                                                                                                                                          -

                                                                                                                                                                                        Returns Promise<CryptoKey>

                                                                                                                                                                                        the HMAC signing key

                                                                                                                                                                                        -

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                      diff --git a/docs/typedoc/hierarchy.html b/docs/typedoc/hierarchy.html index 97010ea4..e0214e9d 100644 --- a/docs/typedoc/hierarchy.html +++ b/docs/typedoc/hierarchy.html @@ -1 +1 @@ -whiteflag-js
                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        whiteflag-js

                                                                                                                                                                                        Hierarchy Summary

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        +Whiteflag JavaScript Library
                                                                                                                                                                                        Whiteflag JavaScript Library
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Whiteflag JavaScript Library

                                                                                                                                                                                          Hierarchy Summary

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                          diff --git a/docs/typedoc/index.html b/docs/typedoc/index.html index df395d22..783c61ea 100644 --- a/docs/typedoc/index.html +++ b/docs/typedoc/index.html @@ -1,4 +1,7 @@ -whiteflag-js
                                                                                                                                                                                          whiteflag-js
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            whiteflag-js

                                                                                                                                                                                            Whiteflag JavaScript Library

                                                                                                                                                                                            Whiteflag is a fully neutral and +Whiteflag JavaScript Library

                                                                                                                                                                                            Whiteflag JavaScript Library
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Whiteflag JavaScript Library

                                                                                                                                                                                              Whiteflag JavaScript Library

                                                                                                                                                                                              GitHub latest release +Ubuntu Test +Windows Test

                                                                                                                                                                                              +

                                                                                                                                                                                              Whiteflag is a fully neutral and secure communications protocol based on blockchain technology. It enables near real-time communication in armed conflicts and disasters to exchange early warning and status information to create shared situational awareness. @@ -34,4 +37,4 @@

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Whiteflag JavaScript Library
                                                                                                                                                                                              +

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Whiteflag JavaScript Library
                                                                                                                                                                                              diff --git a/docs/typedoc/main.html b/docs/typedoc/main.html deleted file mode 100644 index 26673264..00000000 --- a/docs/typedoc/main.html +++ /dev/null @@ -1 +0,0 @@ -main | whiteflag-js
                                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Module main

                                                                                                                                                                                                Enumerations

                                                                                                                                                                                                WfVersion → WfVersion

                                                                                                                                                                                                Classes

                                                                                                                                                                                                WfMessage → WfMessage

                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                WfMetaHeader → WfMetaHeader

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Enumerations
                                                                                                                                                                                                Classes
                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                diff --git a/docs/typedoc/main/lib/message.html b/docs/typedoc/main/lib/message.html deleted file mode 100644 index dedc9151..00000000 --- a/docs/typedoc/main/lib/message.html +++ /dev/null @@ -1 +0,0 @@ -main/lib/message | whiteflag-js
                                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Module main/lib/message

                                                                                                                                                                                                  Classes

                                                                                                                                                                                                  WfMessage

                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                  WfMetaHeader

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Classes
                                                                                                                                                                                                  Interfaces
                                                                                                                                                                                                  diff --git a/docs/typedoc/main/lib/message/WfMessage.html b/docs/typedoc/main/lib/message/WfMessage.html deleted file mode 100644 index d134facb..00000000 --- a/docs/typedoc/main/lib/message/WfMessage.html +++ /dev/null @@ -1,114 +0,0 @@ -WfMessage | whiteflag-js
                                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Class WfMessage

                                                                                                                                                                                                    A Whiteflag message as defined by the Whiteflag specification -WfMessage

                                                                                                                                                                                                    -

                                                                                                                                                                                                    v1-draft.7

                                                                                                                                                                                                    -

                                                                                                                                                                                                    4 Message Format

                                                                                                                                                                                                    -

                                                                                                                                                                                                    This class extends the core Whiteflag message class by -adding metadata to the message, additional data conversions (such as to and -from JSON), and specific Whiteflag protocol features. This allows the class -to be used and integrated in larger functional applications in accordance -with the Whiteflag specification.

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                    constructor -

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    meta -

                                                                                                                                                                                                    Methods

                                                                                                                                                                                                    decode -encode -get -getMeta -isEncoded -isValid -set -setMeta -toHex -toJSON -toObject -toString -toU8a -validate -fromBinary -fromHex -fromJSON -fromObject -fromU8a -

                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    meta: WfMetaHeader = {}

                                                                                                                                                                                                    The message metadata required for processing the message

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Methods

                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Encodes the message, making the contents final -encode

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the input key material to derive the encryption key, if the message is to be encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the binary encoded originator address, if the message is to be encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the initialisation vector, if required for the encryption method

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns Promise<WfCoreMessage>

                                                                                                                                                                                                      this Whitedlag message object with the encoded message

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Returns the value of the specified message field -get

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • fieldName: string

                                                                                                                                                                                                        the name of the message field

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns string | null

                                                                                                                                                                                                      the value of the message field

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Returns the value of the metaheader field -getMeta

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • fieldName: string

                                                                                                                                                                                                        the name of the metaheader field

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns string | null

                                                                                                                                                                                                      the value of the metaheader field

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Indicates if the message is valid, i.e. if all fields contain valid values -isValid

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                      true if message is valid, else false

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Sets the value of the specified message field, if the message has not been encoded -set

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • fieldName: string

                                                                                                                                                                                                        the name of the message field

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • value: string

                                                                                                                                                                                                        the value to set

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                      true if succesful, else false

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Sets the value of the specified metaheader field -setMeta

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • fieldName: string

                                                                                                                                                                                                        the name of the metaheader field

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • value: string

                                                                                                                                                                                                        the value to set

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                      true if succesful, else false

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Returns the Whiteflag message encoded as a hexadecimal string -toHex

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                      a hexadecimal string with the encoded message

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Returns the Whiteflag message as a plain object -toObject

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                      the message as a plain object

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Creates new Whiteflag message from a binary buffer -fromBinary

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • message: BinaryBuffer

                                                                                                                                                                                                        a binary buffer with the encoded message

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the input key material to derive the encryption key, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the binary encoded originator address, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the initialisation vector, if required for the encryption method

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns Promise<WfCoreMessage>

                                                                                                                                                                                                      a new Whiteflag message object with the decoded message

                                                                                                                                                                                                      -

                                                                                                                                                                                                    • Creates new Whiteflag message from a hexadecimal encoded string

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                        atring with the hexadecimal encoded message

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalikm: string

                                                                                                                                                                                                        the hexadecimalinput key material to derive the encryption key, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaladdress: string

                                                                                                                                                                                                        the hexadecimal encoded originator address, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaliv: string

                                                                                                                                                                                                        the hexadecimal initialisation vector, if required for the encryption method

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns Promise<WfCoreMessage>

                                                                                                                                                                                                      a new Whiteflag message object with the decoded message

                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Function

                                                                                                                                                                                                      Creates new Whiteflag message from a plain object -fromObject

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                        a plain JavaScript object with message header and body

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns Promise<WfMessage>

                                                                                                                                                                                                      a new Whiteflag message

                                                                                                                                                                                                      -

                                                                                                                                                                                                      if message could not be created

                                                                                                                                                                                                      -

                                                                                                                                                                                                    • Creates new Whiteflag message from a binary encoded message

                                                                                                                                                                                                      -

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • message: Uint8Array

                                                                                                                                                                                                        a Uint8Array with the binary encoded message

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionalikm: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the input key material to derive the encryption key, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaladdress: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the binary encoded originator address, if the message is encrypted

                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Optionaliv: Uint8Array<ArrayBufferLike>

                                                                                                                                                                                                        the initialisation vector, if required for the encryption method

                                                                                                                                                                                                        -

                                                                                                                                                                                                      Returns Promise<WfCoreMessage>

                                                                                                                                                                                                      a new Whiteflag message object with the decoded message

                                                                                                                                                                                                      -

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    Methods
                                                                                                                                                                                                    diff --git a/docs/typedoc/main/lib/message/WfMetaHeader.html b/docs/typedoc/main/lib/message/WfMetaHeader.html deleted file mode 100644 index a1baf00e..00000000 --- a/docs/typedoc/main/lib/message/WfMetaHeader.html +++ /dev/null @@ -1,23 +0,0 @@ -WfMetaHeader | whiteflag-js
                                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface WfMetaHeader

                                                                                                                                                                                                      Defines a Whiteflag message header object -WfMetaHeader

                                                                                                                                                                                                      -
                                                                                                                                                                                                      interface WfMetaHeader {
                                                                                                                                                                                                          autoGenerated?: string;
                                                                                                                                                                                                          blockchain?: string;
                                                                                                                                                                                                          blockDepth?: number;
                                                                                                                                                                                                          blockNumber?: number;
                                                                                                                                                                                                          confirmed?: boolean;
                                                                                                                                                                                                          encodedMessage?: string;
                                                                                                                                                                                                          encryptionInitVector?: string;
                                                                                                                                                                                                          encryptionKeyInput?: string;
                                                                                                                                                                                                          formatValid?: boolean;
                                                                                                                                                                                                          originatorAddress?: string;
                                                                                                                                                                                                          originatorPubKey?: string;
                                                                                                                                                                                                          originatorValid?: boolean;
                                                                                                                                                                                                          recipientAddress?: string;
                                                                                                                                                                                                          referenceValid?: boolean;
                                                                                                                                                                                                          transactionHash?: string;
                                                                                                                                                                                                          transactionIndex?: number;
                                                                                                                                                                                                          transactionTime?: string;
                                                                                                                                                                                                          transceiveDirection?: string;
                                                                                                                                                                                                          transmissionSuccess?: boolean;
                                                                                                                                                                                                          validationErrors?: string[];
                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      autoGenerated? -blockchain? -blockDepth? -blockNumber? -confirmed? -encodedMessage? -encryptionInitVector? -encryptionKeyInput? -formatValid? -originatorAddress? -originatorPubKey? -originatorValid? -recipientAddress? -referenceValid? -transactionHash? -transactionIndex? -transactionTime? -transceiveDirection? -transmissionSuccess? -validationErrors? -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      autoGenerated?: string
                                                                                                                                                                                                      blockchain?: string
                                                                                                                                                                                                      blockDepth?: number
                                                                                                                                                                                                      blockNumber?: number
                                                                                                                                                                                                      confirmed?: boolean
                                                                                                                                                                                                      encodedMessage?: string
                                                                                                                                                                                                      encryptionInitVector?: string
                                                                                                                                                                                                      encryptionKeyInput?: string
                                                                                                                                                                                                      formatValid?: boolean
                                                                                                                                                                                                      originatorAddress?: string
                                                                                                                                                                                                      originatorPubKey?: string
                                                                                                                                                                                                      originatorValid?: boolean
                                                                                                                                                                                                      recipientAddress?: string
                                                                                                                                                                                                      referenceValid?: boolean
                                                                                                                                                                                                      transactionHash?: string
                                                                                                                                                                                                      transactionIndex?: number
                                                                                                                                                                                                      transactionTime?: string
                                                                                                                                                                                                      transceiveDirection?: string
                                                                                                                                                                                                      transmissionSuccess?: boolean
                                                                                                                                                                                                      validationErrors?: string[]

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Properties
                                                                                                                                                                                                      diff --git a/docs/typedoc/modules.html b/docs/typedoc/modules.html index 8fff09e1..181f3043 100644 --- a/docs/typedoc/modules.html +++ b/docs/typedoc/modules.html @@ -1 +1 @@ -whiteflag-js
                                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                          whiteflag-js

                                                                                                                                                                                                          Modules

                                                                                                                                                                                                          core
                                                                                                                                                                                                          core/lib/codec
                                                                                                                                                                                                          core/lib/errors
                                                                                                                                                                                                          core/lib/message
                                                                                                                                                                                                          core/lib/versions
                                                                                                                                                                                                          crypto
                                                                                                                                                                                                          crypto/lib/cipher
                                                                                                                                                                                                          crypto/lib/common
                                                                                                                                                                                                          crypto/lib/hash
                                                                                                                                                                                                          crypto/lib/keys
                                                                                                                                                                                                          main
                                                                                                                                                                                                          main/lib/message
                                                                                                                                                                                                          util
                                                                                                                                                                                                          util/lib/binary
                                                                                                                                                                                                          util/lib/encoding
                                                                                                                                                                                                          util/lib/jws

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Modules
                                                                                                                                                                                                          +Whiteflag JavaScript Library
                                                                                                                                                                                                          Whiteflag JavaScript Library
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                              Whiteflag JavaScript Library

                                                                                                                                                                                                              Modules

                                                                                                                                                                                                              @whiteflagprotocol/core
                                                                                                                                                                                                              @whiteflagprotocol/crypto
                                                                                                                                                                                                              @whiteflagprotocol/main
                                                                                                                                                                                                              @whiteflagprotocol/util

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Modules
                                                                                                                                                                                                              diff --git a/docs/typedoc/util.html b/docs/typedoc/util.html deleted file mode 100644 index c2b4ec3d..00000000 --- a/docs/typedoc/util.html +++ /dev/null @@ -1 +0,0 @@ -util | whiteflag-js
                                                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Module util

                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                BinaryBuffer → BinaryBuffer
                                                                                                                                                                                                                Jws → Jws

                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                b64ToB64u → b64ToB64u
                                                                                                                                                                                                                b64uToB64 → b64uToB64
                                                                                                                                                                                                                b64uToHex → b64uToHex
                                                                                                                                                                                                                b64uToObj → b64uToObj
                                                                                                                                                                                                                b64uToString → b64uToString
                                                                                                                                                                                                                b64uToU8a → b64uToU8a
                                                                                                                                                                                                                cropBits → cropBits
                                                                                                                                                                                                                hexToB64u → hexToB64u
                                                                                                                                                                                                                hexToString → hexToString
                                                                                                                                                                                                                hexToU8a → hexToU8a
                                                                                                                                                                                                                isBase64 → isBase64
                                                                                                                                                                                                                isBase64u → isBase64u
                                                                                                                                                                                                                isHex → isHex
                                                                                                                                                                                                                isObject → isObject
                                                                                                                                                                                                                isString → isString
                                                                                                                                                                                                                noHexPrefix → noHexPrefix
                                                                                                                                                                                                                objToB64u → objToB64u
                                                                                                                                                                                                                shiftLeft → shiftLeft
                                                                                                                                                                                                                shiftRight → shiftRight
                                                                                                                                                                                                                stringToB64u → stringToB64u
                                                                                                                                                                                                                stringToHex → stringToHex
                                                                                                                                                                                                                stringToU8a → stringToU8a
                                                                                                                                                                                                                u8aToB64u → u8aToB64u
                                                                                                                                                                                                                u8aToHex → u8aToHex
                                                                                                                                                                                                                u8aToString → u8aToString

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                diff --git a/docs/typedoc/util/lib/binary.html b/docs/typedoc/util/lib/binary.html deleted file mode 100644 index 6f0c30dc..00000000 --- a/docs/typedoc/util/lib/binary.html +++ /dev/null @@ -1 +0,0 @@ -util/lib/binary | whiteflag-js
                                                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Module util/lib/binary

                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                  BinaryBuffer

                                                                                                                                                                                                                  Functions

                                                                                                                                                                                                                  cropBits
                                                                                                                                                                                                                  shiftLeft
                                                                                                                                                                                                                  shiftRight

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                  Functions
                                                                                                                                                                                                                  diff --git a/docs/typedoc/util/lib/binary/BinaryBuffer.html b/docs/typedoc/util/lib/binary/BinaryBuffer.html deleted file mode 100644 index b46f70ac..00000000 --- a/docs/typedoc/util/lib/binary/BinaryBuffer.html +++ /dev/null @@ -1,116 +0,0 @@ -BinaryBuffer | whiteflag-js
                                                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Class BinaryBuffer

                                                                                                                                                                                                                    A class representing a binary buffer -BinaryBuffer

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Objects of this class represent a binary encoded piece of data, -e.g. a Whiteflag message, that can be manipulated at bit level. This class -provides the basic (not Whiteflag-specific) functionality for other -Whiteflag packages to encode and decode binary Whiteflag messages.

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    length -

                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                    append -appendBytes -appendHex -appendU8a -crop -extract -extractHex -extractU8a -insertBytes -insertHex -insertU8a -shiftLeft -shiftRight -toHex -toU8a -empty -from -fromBytes -fromHex -fromU8a -

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    length: number

                                                                                                                                                                                                                    The number of used bits in the buffer

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Appends bytes from a number array to the binary buffer -appendBytes

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • byteArray: number[]

                                                                                                                                                                                                                        an array of numbers representing bytes

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to append

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Appends a hexadecimal string to the binary buffer -appendHex

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • hexString: string

                                                                                                                                                                                                                        a hexadecimal string

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to append

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Appends a Uint8Array to the binary buffer -appendU8a

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • u8array: Uint8Array

                                                                                                                                                                                                                        an array of 8-bit unsigned integers

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to append

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Shortens the binary buffer to the length of the specified bits -crop

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • nBits: number

                                                                                                                                                                                                                        the number of used bits, or, if negative, the number of bits to remove

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                    • Extracts the specified bits from the binary buffer

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • startBit: number

                                                                                                                                                                                                                        the first bit to extract (inclusive)

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • endBit: number = -1

                                                                                                                                                                                                                        the final bit of the extraction (exclusive), negative means until end of buffer

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      a new binary buffer with the extracted bits

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                    • Extracts the specified bits from the binary buffer to a hexadecimal string

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • startBit: number

                                                                                                                                                                                                                        the first bit to extract (inclusive)

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • endBit: number = -1

                                                                                                                                                                                                                        the final bit of the extraction (exclusive), negative means until end of buffer

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                      a hexadecimal string with the extracted data

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Extracts the specified bits from the binary buffer to a Uint8Array -extractU8a

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • startBit: number

                                                                                                                                                                                                                        the first bit to extract (inclusive)

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • endBit: number = -1

                                                                                                                                                                                                                        the final bit of the extraction (exclusive), negative means until end of buffer

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns Uint8Array

                                                                                                                                                                                                                      an array of 8-bit unsigned integers with the extracted data

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Inserts bytes from a number array at the start of the binary buffer -insertBytes

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • byteArray: number[]

                                                                                                                                                                                                                        an array of numbers representing bytes

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to insert

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Inserts a hexadecimal string at the start of the binary buffer -insertHex

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • hexString: string

                                                                                                                                                                                                                        a hexadecimal string

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to insert

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Inserts a Uint8Array at the start of the binary buffer -insertU8a

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • u8array: Uint8Array

                                                                                                                                                                                                                        an array of 8-bit unsigned integers

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits to insert

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the updated binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Shifts bits in the buffer to the left, shrinking the buffer -shiftLeft

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • shift: number

                                                                                                                                                                                                                        the number of bits to shift to the left

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the shifted binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Shifts bits in the buffer to the right, enlarging the buffer -shiftRight

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • shift: number

                                                                                                                                                                                                                        the number of bits to shift to the right

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      the shifted binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Gives the value of the binary buffer as a hexadecimal string -toHex

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                      a hexadecimal string

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Gives the value of the binary buffer as a Uint8Array -toU8a

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Returns Uint8Array

                                                                                                                                                                                                                      an array of 8-bit unsigned integers

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Creates a binary buffer from bytes in a number array -fromBytes

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • byteArray: number[]

                                                                                                                                                                                                                        an array of numbers representing bytes

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      a new binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Creates a binary buffer from a hexadecimal string -fromHex

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • hexString: string

                                                                                                                                                                                                                        a hexadecimal string

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      a new binary buffer

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                      Creates a binary buffer from a Uint8Array -fromU8a

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • u8array: Uint8Array

                                                                                                                                                                                                                        an array of 8-bit unsigned integers

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • nBits: number = 0

                                                                                                                                                                                                                        the number of used bits

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Returns BinaryBuffer

                                                                                                                                                                                                                      a new binary buffer

                                                                                                                                                                                                                      -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                    diff --git a/docs/typedoc/util/lib/binary/cropBits.html b/docs/typedoc/util/lib/binary/cropBits.html deleted file mode 100644 index d0efbc45..00000000 --- a/docs/typedoc/util/lib/binary/cropBits.html +++ /dev/null @@ -1,6 +0,0 @@ -cropBits | whiteflag-js
                                                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Function cropBits

                                                                                                                                                                                                                      • Function

                                                                                                                                                                                                                        Shortens a Uint8Array to the length of the specified bits -cropBits

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        • u8array: Uint8Array

                                                                                                                                                                                                                          the Uint8Array containing the bitset

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • nBits: number

                                                                                                                                                                                                                          the number of used bits, or, if negative, the number of bits to remove

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                        Returns Uint8Array

                                                                                                                                                                                                                        a new Uint8Array with the unused bits cleared

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                      diff --git a/docs/typedoc/util/lib/binary/shiftLeft.html b/docs/typedoc/util/lib/binary/shiftLeft.html deleted file mode 100644 index cf8f7279..00000000 --- a/docs/typedoc/util/lib/binary/shiftLeft.html +++ /dev/null @@ -1,6 +0,0 @@ -shiftLeft | whiteflag-js
                                                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Function shiftLeft

                                                                                                                                                                                                                        • Function

                                                                                                                                                                                                                          Shifts bits in a Uint8Array to the left modulo 8 -shiftLeft

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          • u8array: Uint8Array

                                                                                                                                                                                                                            the Uint8Array to be left shifted

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • shift: number

                                                                                                                                                                                                                            the nummber of bits to be left shifted by modulo 8 bits

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          Returns Uint8Array

                                                                                                                                                                                                                          a new Uint8Array with the left shifted bits

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                        diff --git a/docs/typedoc/util/lib/binary/shiftRight.html b/docs/typedoc/util/lib/binary/shiftRight.html deleted file mode 100644 index a00eadee..00000000 --- a/docs/typedoc/util/lib/binary/shiftRight.html +++ /dev/null @@ -1,6 +0,0 @@ -shiftRight | whiteflag-js
                                                                                                                                                                                                                        whiteflag-js
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Function shiftRight

                                                                                                                                                                                                                          • Function

                                                                                                                                                                                                                            Shifts bits in a Uint8Array to the right modulo 8 -shiftRight

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • u8array: Uint8Array

                                                                                                                                                                                                                              the Uint8Array to be right shifted

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • shift: number

                                                                                                                                                                                                                              the nummber of bits to be right shifted by modulo 8 bits

                                                                                                                                                                                                                              -

                                                                                                                                                                                                                            Returns Uint8Array

                                                                                                                                                                                                                            a new Uint8Array with the right shifted bits

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                          diff --git a/docs/typedoc/util/lib/encoding.html b/docs/typedoc/util/lib/encoding.html deleted file mode 100644 index 0a9318d3..00000000 --- a/docs/typedoc/util/lib/encoding.html +++ /dev/null @@ -1 +0,0 @@ -util/lib/encoding | whiteflag-js
                                                                                                                                                                                                                          whiteflag-js
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Module util/lib/encoding

                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                            b64ToB64u
                                                                                                                                                                                                                            b64uToB64
                                                                                                                                                                                                                            b64uToHex
                                                                                                                                                                                                                            b64uToObj
                                                                                                                                                                                                                            b64uToString
                                                                                                                                                                                                                            b64uToU8a
                                                                                                                                                                                                                            hexToB64u
                                                                                                                                                                                                                            hexToString
                                                                                                                                                                                                                            hexToU8a
                                                                                                                                                                                                                            isBase64
                                                                                                                                                                                                                            isBase64u
                                                                                                                                                                                                                            isHex
                                                                                                                                                                                                                            isObject
                                                                                                                                                                                                                            isString
                                                                                                                                                                                                                            noHexPrefix
                                                                                                                                                                                                                            objToB64u
                                                                                                                                                                                                                            stringToB64u
                                                                                                                                                                                                                            stringToHex
                                                                                                                                                                                                                            stringToU8a
                                                                                                                                                                                                                            u8aToB64u
                                                                                                                                                                                                                            u8aToHex
                                                                                                                                                                                                                            u8aToString

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            Functions
                                                                                                                                                                                                                            diff --git a/docs/typedoc/util/lib/encoding/b64ToB64u.html b/docs/typedoc/util/lib/encoding/b64ToB64u.html deleted file mode 100644 index faf75583..00000000 --- a/docs/typedoc/util/lib/encoding/b64ToB64u.html +++ /dev/null @@ -1,5 +0,0 @@ -b64ToB64u | whiteflag-js
                                                                                                                                                                                                                            whiteflag-js
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Function b64ToB64u

                                                                                                                                                                                                                              • Function

                                                                                                                                                                                                                                Convert base64 to base64url -base64

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • base64: string

                                                                                                                                                                                                                                  a base64 encoded string

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                a base64url encoded string

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                              diff --git a/docs/typedoc/util/lib/encoding/b64uToB64.html b/docs/typedoc/util/lib/encoding/b64uToB64.html deleted file mode 100644 index 88906d40..00000000 --- a/docs/typedoc/util/lib/encoding/b64uToB64.html +++ /dev/null @@ -1,5 +0,0 @@ -b64uToB64 | whiteflag-js
                                                                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Function b64uToB64

                                                                                                                                                                                                                                • Function

                                                                                                                                                                                                                                  Convert base64url to base64 -base64u

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • base64u: string

                                                                                                                                                                                                                                    a base64url encoded string

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                  a base64 encoded string

                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                diff --git a/docs/typedoc/util/lib/encoding/b64uToHex.html b/docs/typedoc/util/lib/encoding/b64uToHex.html deleted file mode 100644 index c462a391..00000000 --- a/docs/typedoc/util/lib/encoding/b64uToHex.html +++ /dev/null @@ -1,5 +0,0 @@ -b64uToHex | whiteflag-js
                                                                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Function b64uToHex

                                                                                                                                                                                                                                  • Function

                                                                                                                                                                                                                                    Creates hexadecimal string from a base64url encoded string -b64uToHex

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • b64uString: string

                                                                                                                                                                                                                                      a base64url encoded string

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                    a hexadecimal encoded string

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                  diff --git a/docs/typedoc/util/lib/encoding/b64uToObj.html b/docs/typedoc/util/lib/encoding/b64uToObj.html deleted file mode 100644 index 041618a9..00000000 --- a/docs/typedoc/util/lib/encoding/b64uToObj.html +++ /dev/null @@ -1,5 +0,0 @@ -b64uToObj | whiteflag-js
                                                                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Function b64uToObj

                                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                                      Creates an object from a base64URL encoded JSON string -b64uToObj

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • base64u: string

                                                                                                                                                                                                                                        a base64URL encoded JSON string

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                      Returns Object

                                                                                                                                                                                                                                      an object with the data from the JSON object

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    diff --git a/docs/typedoc/util/lib/encoding/b64uToString.html b/docs/typedoc/util/lib/encoding/b64uToString.html deleted file mode 100644 index a1bbea55..00000000 --- a/docs/typedoc/util/lib/encoding/b64uToString.html +++ /dev/null @@ -1,5 +0,0 @@ -b64uToString | whiteflag-js
                                                                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Function b64uToString

                                                                                                                                                                                                                                      • Function

                                                                                                                                                                                                                                        Creates a standard string from a base64url encoded string -b64uToString

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        • b64uString: string

                                                                                                                                                                                                                                          a base64url encoded string

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                        a standard string

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                      diff --git a/docs/typedoc/util/lib/encoding/b64uToU8a.html b/docs/typedoc/util/lib/encoding/b64uToU8a.html deleted file mode 100644 index 8be7515d..00000000 --- a/docs/typedoc/util/lib/encoding/b64uToU8a.html +++ /dev/null @@ -1,5 +0,0 @@ -b64uToU8a | whiteflag-js
                                                                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Function b64uToU8a

                                                                                                                                                                                                                                        • Function

                                                                                                                                                                                                                                          Creates a UInt8 typed array from a base64url encoded string -b64uToU8a

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • b64uString: string

                                                                                                                                                                                                                                            a base64url encoded string

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Returns Uint8Array

                                                                                                                                                                                                                                          a UInt8 typed array

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        diff --git a/docs/typedoc/util/lib/encoding/hexToB64u.html b/docs/typedoc/util/lib/encoding/hexToB64u.html deleted file mode 100644 index 364a8359..00000000 --- a/docs/typedoc/util/lib/encoding/hexToB64u.html +++ /dev/null @@ -1,5 +0,0 @@ -hexToB64u | whiteflag-js
                                                                                                                                                                                                                                        whiteflag-js
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Function hexToB64u

                                                                                                                                                                                                                                          • Function

                                                                                                                                                                                                                                            Creates a base64url encoded string from a hexadecimal string -hexToB64u

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • hexString: string

                                                                                                                                                                                                                                              a hexadecimal string

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                            a base64url encoded string

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                          diff --git a/docs/typedoc/util/lib/encoding/hexToString.html b/docs/typedoc/util/lib/encoding/hexToString.html deleted file mode 100644 index f1108079..00000000 --- a/docs/typedoc/util/lib/encoding/hexToString.html +++ /dev/null @@ -1,5 +0,0 @@ -hexToString | whiteflag-js
                                                                                                                                                                                                                                          whiteflag-js
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Function hexToString

                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                              Creates a regular string from a hexadecimal string -hexToString

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • hexString: string

                                                                                                                                                                                                                                                a hexadecimal string

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                              a regular string

                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            diff --git a/docs/typedoc/util/lib/encoding/hexToU8a.html b/docs/typedoc/util/lib/encoding/hexToU8a.html deleted file mode 100644 index bbbd4f87..00000000 --- a/docs/typedoc/util/lib/encoding/hexToU8a.html +++ /dev/null @@ -1,5 +0,0 @@ -hexToU8a | whiteflag-js
                                                                                                                                                                                                                                            whiteflag-js
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Function hexToU8a

                                                                                                                                                                                                                                              • Function

                                                                                                                                                                                                                                                Creates a UInt8 typed array from a hexadecimal string -hexToU8a

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                • hexString: string

                                                                                                                                                                                                                                                  a hexadecimal string

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                Returns Uint8Array<ArrayBuffer>

                                                                                                                                                                                                                                                an array of 8-bit unsigned integers

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                              diff --git a/docs/typedoc/util/lib/encoding/isBase64.html b/docs/typedoc/util/lib/encoding/isBase64.html deleted file mode 100644 index 1699da10..00000000 --- a/docs/typedoc/util/lib/encoding/isBase64.html +++ /dev/null @@ -1,5 +0,0 @@ -isBase64 | whiteflag-js
                                                                                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Function isBase64

                                                                                                                                                                                                                                                • Function

                                                                                                                                                                                                                                                  Checks if a string is base64 encoded -isBase64

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                  • base64: string

                                                                                                                                                                                                                                                    a string that might be base64 encoded

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                  true if base64 encoded, else false

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                diff --git a/docs/typedoc/util/lib/encoding/isBase64u.html b/docs/typedoc/util/lib/encoding/isBase64u.html deleted file mode 100644 index 09bb6262..00000000 --- a/docs/typedoc/util/lib/encoding/isBase64u.html +++ /dev/null @@ -1,5 +0,0 @@ -isBase64u | whiteflag-js
                                                                                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Function isBase64u

                                                                                                                                                                                                                                                  • Function

                                                                                                                                                                                                                                                    Checks if a string is base64url encoded -isBase64u

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • base64u: string

                                                                                                                                                                                                                                                      a string that might be base64url encoded

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                    true if base64url encoded, else false

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                  diff --git a/docs/typedoc/util/lib/encoding/isHex.html b/docs/typedoc/util/lib/encoding/isHex.html deleted file mode 100644 index 0022c61d..00000000 --- a/docs/typedoc/util/lib/encoding/isHex.html +++ /dev/null @@ -1,5 +0,0 @@ -isHex | whiteflag-js
                                                                                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Function isHex

                                                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                                                      Checks if a string is hexadecimal encoded -hexString

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • hexString: string

                                                                                                                                                                                                                                                        a string that might be hexadecimal encoded

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                      true if hexadecimal encoded, else false

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                    diff --git a/docs/typedoc/util/lib/encoding/isObject.html b/docs/typedoc/util/lib/encoding/isObject.html deleted file mode 100644 index b6da9cc9..00000000 --- a/docs/typedoc/util/lib/encoding/isObject.html +++ /dev/null @@ -1,5 +0,0 @@ -isObject | whiteflag-js
                                                                                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Function isObject

                                                                                                                                                                                                                                                      • Function

                                                                                                                                                                                                                                                        Checks if something is an object -isObject

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • obj: any

                                                                                                                                                                                                                                                          something that might be an object

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                        true if object, else false

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                      diff --git a/docs/typedoc/util/lib/encoding/isString.html b/docs/typedoc/util/lib/encoding/isString.html deleted file mode 100644 index 2519bef7..00000000 --- a/docs/typedoc/util/lib/encoding/isString.html +++ /dev/null @@ -1,5 +0,0 @@ -isString | whiteflag-js
                                                                                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Function isString

                                                                                                                                                                                                                                                        • Function

                                                                                                                                                                                                                                                          Checks if something is a string -isString

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          • charString: any

                                                                                                                                                                                                                                                            something that might be a string

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                          true if string, else false

                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        diff --git a/docs/typedoc/util/lib/encoding/noHexPrefix.html b/docs/typedoc/util/lib/encoding/noHexPrefix.html deleted file mode 100644 index a50f7b0f..00000000 --- a/docs/typedoc/util/lib/encoding/noHexPrefix.html +++ /dev/null @@ -1,5 +0,0 @@ -noHexPrefix | whiteflag-js
                                                                                                                                                                                                                                                        whiteflag-js
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Function noHexPrefix

                                                                                                                                                                                                                                                          • Function

                                                                                                                                                                                                                                                            Removes the '0x' hex prefix if present -hexString

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • hexString: string

                                                                                                                                                                                                                                                              a hexadecimal encoded string

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                            the the string without the hex prefix

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          diff --git a/docs/typedoc/util/lib/encoding/objToB64u.html b/docs/typedoc/util/lib/encoding/objToB64u.html deleted file mode 100644 index fded2772..00000000 --- a/docs/typedoc/util/lib/encoding/objToB64u.html +++ /dev/null @@ -1,5 +0,0 @@ -objToB64u | whiteflag-js
                                                                                                                                                                                                                                                          whiteflag-js
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Function objToB64u

                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                              Creates a base64URL encoded JSON string from an object -objToB64u

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • obj: Object

                                                                                                                                                                                                                                                                the object to be encoded

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                                              a base64URL encoded JSON string

                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            diff --git a/docs/typedoc/util/lib/encoding/stringToB64u.html b/docs/typedoc/util/lib/encoding/stringToB64u.html deleted file mode 100644 index 1b24c646..00000000 --- a/docs/typedoc/util/lib/encoding/stringToB64u.html +++ /dev/null @@ -1,5 +0,0 @@ -stringToB64u | whiteflag-js
                                                                                                                                                                                                                                                            whiteflag-js
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Function stringToB64u

                                                                                                                                                                                                                                                              • Function

                                                                                                                                                                                                                                                                Creates a base64url encoded string from a regular string -stringToB64u

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • charString: string

                                                                                                                                                                                                                                                                  a regular character string

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                a base64url encoded string

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              diff --git a/docs/typedoc/util/lib/encoding/stringToHex.html b/docs/typedoc/util/lib/encoding/stringToHex.html deleted file mode 100644 index 2efb6f5a..00000000 --- a/docs/typedoc/util/lib/encoding/stringToHex.html +++ /dev/null @@ -1,5 +0,0 @@ -stringToHex | whiteflag-js
                                                                                                                                                                                                                                                              whiteflag-js
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Function stringToHex

                                                                                                                                                                                                                                                                • Function

                                                                                                                                                                                                                                                                  Creates a hexadecimal string from a regular string -stringToHex

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  • charString: string

                                                                                                                                                                                                                                                                    a regular character string

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                  a hexadecimal string

                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                diff --git a/docs/typedoc/util/lib/encoding/stringToU8a.html b/docs/typedoc/util/lib/encoding/stringToU8a.html deleted file mode 100644 index a09f93e5..00000000 --- a/docs/typedoc/util/lib/encoding/stringToU8a.html +++ /dev/null @@ -1,5 +0,0 @@ -stringToU8a | whiteflag-js
                                                                                                                                                                                                                                                                whiteflag-js
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Function stringToU8a

                                                                                                                                                                                                                                                                  • Function

                                                                                                                                                                                                                                                                    Creates a UInt8 typed array from a regular string -stringToU8a

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • charString: string

                                                                                                                                                                                                                                                                      a regular character string

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Returns Uint8Array<ArrayBuffer>

                                                                                                                                                                                                                                                                    an array of 8-bit unsigned integers

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  diff --git a/docs/typedoc/util/lib/encoding/u8aToB64u.html b/docs/typedoc/util/lib/encoding/u8aToB64u.html deleted file mode 100644 index 55c4fb2a..00000000 --- a/docs/typedoc/util/lib/encoding/u8aToB64u.html +++ /dev/null @@ -1,5 +0,0 @@ -u8aToB64u | whiteflag-js
                                                                                                                                                                                                                                                                  whiteflag-js
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Function u8aToB64u

                                                                                                                                                                                                                                                                    • Function

                                                                                                                                                                                                                                                                      Creates a base64url encoded string from a UInt8 typed array -u8aToB64u

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      • u8array: Uint8Array

                                                                                                                                                                                                                                                                        an array of 8-bit unsigned integers

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Returns string

                                                                                                                                                                                                                                                                      a base64url encoded string

                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                    diff --git a/docs/typedoc/util/lib/encoding/u8aToHex.html b/docs/typedoc/util/lib/encoding/u8aToHex.html deleted file mode 100644 index 675ef538..00000000 --- a/docs/typedoc/util/lib/encoding/u8aToHex.html +++ /dev/null @@ -1,5 +0,0 @@ -u8aToHex | whiteflag-js
                                                                                                                                                                                                                                                                    whiteflag-js
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Function u8aToHex

                                                                                                                                                                                                                                                                      • Function

                                                                                                                                                                                                                                                                        Creates a hexadecimal string from an Uint8Array -u8aToHex

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • u8array: Uint8Array

                                                                                                                                                                                                                                                                          an array of 8-bit unsigned integers

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                        a hexadecimal string

                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      diff --git a/docs/typedoc/util/lib/encoding/u8aToString.html b/docs/typedoc/util/lib/encoding/u8aToString.html deleted file mode 100644 index bcd26597..00000000 --- a/docs/typedoc/util/lib/encoding/u8aToString.html +++ /dev/null @@ -1,5 +0,0 @@ -u8aToString | whiteflag-js
                                                                                                                                                                                                                                                                      whiteflag-js
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Function u8aToString

                                                                                                                                                                                                                                                                        • Function

                                                                                                                                                                                                                                                                          Creates a standard string from a UInt8 typed array -u8aToString

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                          • u8array: Uint8Array

                                                                                                                                                                                                                                                                            a UInt8 typed array

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                          Returns string

                                                                                                                                                                                                                                                                          a standard string

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                        diff --git a/docs/typedoc/util/lib/jws.html b/docs/typedoc/util/lib/jws.html deleted file mode 100644 index a79e38ea..00000000 --- a/docs/typedoc/util/lib/jws.html +++ /dev/null @@ -1 +0,0 @@ -util/lib/jws | whiteflag-js
                                                                                                                                                                                                                                                                        whiteflag-js
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Module util/lib/jws

                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                          Jws

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                          diff --git a/docs/typedoc/util/lib/jws/Jws.html b/docs/typedoc/util/lib/jws/Jws.html deleted file mode 100644 index 9c51fc7c..00000000 --- a/docs/typedoc/util/lib/jws/Jws.html +++ /dev/null @@ -1,56 +0,0 @@ -Jws | whiteflag-js
                                                                                                                                                                                                                                                                          whiteflag-js
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Class Jws

                                                                                                                                                                                                                                                                            A class representing a JSON Web Token (JWS) -Jws

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Whiteflag uses JSON Web Signatures (JWS) for one of its -authentication methods. This class provides the basic (not Whiteflag- -specific) functionality to create, sign and convert JWSs for other -Whiteflag packages.

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                            getSignature -getSignInput -isSigned -setSignAlgorithm -setSignature -toCompact -toFlat -toFull -fromCompact -fromObject -fromPayload -

                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Returns the JWS signature -getSignature

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                                                              a string with the the JWS signature

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Returns the JWS signature input -getSignInput

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                                                              a string with the input to be signed by the signing algorithm

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Indicates if the JWS has been signed -isSigned

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                              true if signed, else false

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Sets the identifier of the signing algorithm, if not yet signed -setSignAlgorithm

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • algorithm: string

                                                                                                                                                                                                                                                                                the identifier of the algorithm used to sign the payload

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                              true if identifier could be set, false if already signed

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Sets the signature, if not yet signed -setSignature

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • signature: string

                                                                                                                                                                                                                                                                                the base64url encoded signature

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                              true if signature could be added, false if already signed

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Return a compact serialised JWS as a compact serialized string -toCompact

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns string

                                                                                                                                                                                                                                                                              the JWS as a compact serialized JWS string

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Returns a flattened JWS -toFlat

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns Object

                                                                                                                                                                                                                                                                              the JWS as a flattened JWS plain JavaScript object

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Returns a full JWS -toFull

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Returns Object

                                                                                                                                                                                                                                                                              the JWS as a full JWS plain JavaScript object

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Creates a new JWS object from a compact serialised JWS string -fromCompact

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • jws: string

                                                                                                                                                                                                                                                                                a compact serialised JWS string

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Returns Jws

                                                                                                                                                                                                                                                                              a new JWS object

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Creates a new JWS object from a plain javaScript object -fromObject

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • jws: any

                                                                                                                                                                                                                                                                                a plain object

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Returns Jws

                                                                                                                                                                                                                                                                              a new JWS object

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Function

                                                                                                                                                                                                                                                                              Creates a new JWS from a payload -fromPayload

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • payload: Object

                                                                                                                                                                                                                                                                                the JWS payload

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                              Returns Jws

                                                                                                                                                                                                                                                                              a new Binary Array

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                            diff --git a/package.json b/package.json index 0376ab56..ac0b9620 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "whiteflag-js", - "version": "1.0.0-dev", + "version": "1.0.0", "description": "JavaScript implementation of the Whiteflag protocol", "license": "CC0-1.0", "private": true, @@ -48,10 +48,10 @@ "scripts": { "test": "tsc && mocha --recursive", "docs:cleanup": "rimraf -g ./docs/typedoc/**/*", - "docs:src": "typedoc --groupReferencesByType --router structure", + "docs:typedoc": "typedoc", "docs": "npm-run-all docs:*", "build:cleanup": "rimraf -g ./dist/**/*.md ./dist/**/*.json ./dist/**/**/*.json ./dist/**/*.js ./dist/**/**/*.js ./dist/**/*.ts ./dist/**/**/*.ts", - "build:compile": "tsc --declaration false", + "build:compile": "tsc --declaration false --removeComments true", "build:declaration": "tsc --emitDeclarationOnly --declaration true --removeComments false", "build:packages": "copyfiles -u 1 src/**/package.json src/**/*.md dist", "build:test": "mocha --recursive --reporter dot", diff --git a/src/core/README.md b/src/core/README.md index 85abfafb..e1f67537 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -7,13 +7,14 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/core` package provides the modules that define -Whiteflag core protocol features as specified in the Whiteflag standard. -As such, this package is not a fully functional implementation of the -protocol, but separates core protocol functions from implementation-specific -design decisions. Therefore, this package is not intended to be used directly -by implementations of Whiteflag; instead, the `@whiteflagprotocol/main` should -be used. +The [`@whiteflagprotocol/core`](https://www.npmjs.com/package/@whiteflagprotocol/core) +package provides the modules that define Whiteflag core protocol features as +specified in the Whiteflag standard. As such, this package is not a fully +functional implementation of the protocol, but separates core protocol +functions from implementation-specific design decisions. Therefore, this +package is not intended to be used directly by implementations of Whiteflag; +instead, the [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package should be used. This description provides a generic overview of the WFJSL core package. Please see the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) @@ -35,7 +36,7 @@ code `F`) and set the `Text` field, may be done as follows: ```{javascript} let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. The `WfCoreMessage` class diff --git a/src/core/index.ts b/src/core/index.ts index 0ef74f4a..2d6d29cb 100644 --- a/src/core/index.ts +++ b/src/core/index.ts @@ -6,6 +6,7 @@ * @primaryExport */ export { + WfCodec, encodeField, decodeField, isValidValue diff --git a/src/crypto/README.md b/src/crypto/README.md index 94597c02..e85ca77f 100644 --- a/src/crypto/README.md +++ b/src/crypto/README.md @@ -7,9 +7,10 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/crypto` package provides cryptographic functions for -other Whiteflag packages. Therefore, it should normally not be necessary to -add this package as a dependency. +The [`@whiteflagprotocol/crypto`](https://www.npmjs.com/package/@whiteflagprotocol/crypto) +package provides cryptographic functions for other Whiteflag packages. +Therefore, it should normally not be necessary to add this package as a +dependency. The WFJSL uses the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) for the basic implementation of Whiteflag cryptographic functions, such as diff --git a/src/crypto/lib/hash.ts b/src/crypto/lib/hash.ts index a2d6d101..8baf1e5f 100644 --- a/src/crypto/lib/hash.ts +++ b/src/crypto/lib/hash.ts @@ -73,7 +73,7 @@ async function hkdf(ikm: Uint8Array, */ async function hash(data: Uint8Array, length = HASHLEN, - algorithm = HASHALG + algorithm: AlgorithmIdentifier = HASHALG ): Promise> { /* Create hash */ const hash = await crypto.subtle.digest(algorithm, data); diff --git a/src/main/README.md b/src/main/README.md index 6ba56d48..65fcdaad 100644 --- a/src/main/README.md +++ b/src/main/README.md @@ -7,9 +7,10 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/main` package provides all classes and functions -required to implement the Whiteflag protocol. Normally this should be -the only dependency for projects implementing Whiteflag. +The [`@whiteflagprotocol/main`](https://www.npmjs.com/package/@whiteflagprotocol/main) +package provides all classes and functions required to implement the Whiteflag +protocol. This should normally be the only dependency for projects +implementing Whiteflag. This description provides a generic overview of the Whiteflag main package. Please refer to the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) @@ -17,7 +18,7 @@ for a detailed description of all classes and functions. ## Whiteflag message class -The Whiteflag message class `WfMessage` defined in the `main` module +The Whiteflag message class `WfMessage` defined in the `message` module represents a Whiteflag message. This class extends the core Whiteflag message class `WfCoreMessage` by adding @@ -31,8 +32,8 @@ factory method. For example, creating a new FreeText message (message code `F`) and set the `Text` field, may be done as follows: ```{javascript} -let wfMessage = new WfCoreMessage('F'); -WfCoreMessage.set('Text', 'Example text to be sent with the FreeText message'); +let wfMessage = new WfMessage('F'); +wfMessage.set('Text', 'Example text to be sent with the FreeText message'); ``` The `encode()` method encodes the message. It automatically verifies the fields @@ -52,7 +53,7 @@ static factory methods such as `fromHex(...)` or `fromU8a(...)`, since the message type is probably not known before decoding. ```{javascript} -wfMessage = await WfCoreMessage.fromHex(hexMessage); +wfMessage = await WfMessage.fromHex(hexMessage); ``` Encryption and decryption is automatically performed upon encoding and diff --git a/src/util/README.md b/src/util/README.md index 91b73752..405b75d0 100644 --- a/src/util/README.md +++ b/src/util/README.md @@ -7,11 +7,12 @@ Protocol written in [TypeScript](https://developer.mozilla.org/en-US/docs/Glossa and compiled to [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript), to support the development of Whiteflag-enabled applications in JavaScript. -The `@whiteflagprotocol/util` package provides common utilities for other -Whiteflag packages. These utilities include common data conversions, generic -helper functions, etc. for other Whiteflag packages. It should normally not be -necessary to add this package as a dependency, but its functionality might be -useful for other purposes. +The [`@whiteflagprotocol/util`](https://www.npmjs.com/package/@whiteflagprotocol/util) +package provides common utilities for other Whiteflag packages. These +utilities include common data conversions, generic helper functions, etc. +for other Whiteflag packages. It should normally not be necessary to add this +package as a dependency, but its functionality might be useful for other +purposes. This description provides a generic overview of the WFJSL utility package. Please see the [WFJSL TypeDoc documentation](https://js.whiteflagprotocol.org/typedoc) diff --git a/tsconfig.json b/tsconfig.json index 831dd2c0..86d28633 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -20,11 +20,5 @@ }, "noImplicitThis": true, }, - "include": ["./src/**/*"], - "typedocOptions": { - "entryPoints": [ - "src/**/*.ts" - ], - "out": "docs/typedoc" - } + "include": ["./src/**/*"] } \ No newline at end of file diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..063fd4c7 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,13 @@ +{ + "name": "Whiteflag JavaScript Library", + "entryPointStrategy": "packages", + "entryPoints": ["src/*"], + "packageOptions": { + "entryPointStrategy": "resolve", + "entryPoints": [ "./index.ts" ] + }, + "out": "docs/typedoc", + "groupReferencesByType": true, + "router": "structure", + "favicon": "docs/favicon.ico" +} \ No newline at end of file