Version 1.0.0

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

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';

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";

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

dist/crypto/lib/hash.d.ts

@@ -21,7 +21,7 @@ declare function hkdf(ikm: Uint8Array<ArrayBuffer>, salt: Uint8Array<ArrayBuffer
  * @param algorithm the hash algorithm to be used; default is SHA-256
  * @returns the hash value
  */
-declare function hash(data: Uint8Array<ArrayBuffer>, length?: number, algorithm?: string): Promise<Uint8Array<ArrayBuffer>>;
+declare function hash(data: Uint8Array<ArrayBuffer>, length?: number, algorithm?: AlgorithmIdentifier): Promise<Uint8Array<ArrayBuffer>>;
 /**
  * Hash-Based Message Authentication Code function
  * @function hmac

dist/main/README.md

@@ -7,17 +7,18 @@ 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)
 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

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)

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

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

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

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