Class TestDataGenerator

Utility class for generating data for testing.

Constructors

constructor

new TestDataGenerator(): TestDataGenerator
Returns TestDataGenerator

Methods

`Static` createDidResolutionResult

createDidResolutionResult(persona): DidResolutionResult
Creates a mock DID resolution result for testing purposes.
Parameters
- persona: Persona
Returns DidResolutionResult
- Defined in tests/utils/test-data-generator.ts:855

`Static` generateAuthorization

generateAuthorization(): AuthorizationModel
Generates a dummy authorization property for a DWN message that only conforms to schema validation.

Returns AuthorizationModel
- Defined in tests/utils/test-data-generator.ts:755

`Static` generateAuthorizationSignature

generateAuthorizationSignature(): GeneralJws
Generates a dummy authorization property for a DWN message that only conforms to schema validation.

Returns GeneralJws
- Defined in tests/utils/test-data-generator.ts:764

`Static` generateDidKeyPersona

generateDidKeyPersona(): Promise<Persona>
Generates a did:key persona.

Returns Promise<Persona>
- Defined in tests/utils/test-data-generator.ts:875

`Static` generateEventsGet

generateEventsGet(input?): Promise<GenerateEventsGetOutput>
Parameters
- Optional input: GenerateEventsGetInput
Returns Promise<GenerateEventsGetOutput>
- Defined in tests/utils/test-data-generator.ts:676

`Static` generateEventsQuery

generateEventsQuery(input): Promise<GenerateEventsQueryOutput>
Parameters
- input: GenerateEventsQueryInput
Returns Promise<GenerateEventsQueryOutput>
- Defined in tests/utils/test-data-generator.ts:694

`Static` generateEventsSubscribe

generateEventsSubscribe(input?): Promise<GenerateEventsSubscribeOutput>
Generates a EventsSubscribe message for testing.
Parameters
- Optional input: GenerateEventsSubscribeInput
Returns Promise<GenerateEventsSubscribeOutput>
- Defined in tests/utils/test-data-generator.ts:713

`Static` generateFromRecordsWrite

generateFromRecordsWrite(input): Promise<GenerateFromRecordsWriteOut>
Generates a valid RecordsWrite that modifies the given an existing write. Any mutable property is not specified will be automatically mutated. e.g. if published is not specified, it will be toggled from the state of the given existing write.
Parameters
- input: GenerateFromRecordsWriteInput
Returns Promise<GenerateFromRecordsWriteOut>
- Defined in tests/utils/test-data-generator.ts:549

`Static` generateMessagesGet

generateMessagesGet(input): Promise<GenerateMessagesGetOutput>
Parameters
- input: GenerateMessagesGetInput
Returns Promise<GenerateMessagesGetOutput>
- Defined in tests/utils/test-data-generator.ts:734

`Static` generatePersona

generatePersona(input?): Promise<Persona>
Generates a persona.
Parameters
- Optional input: Partial<Persona>
Returns Promise<Persona>
- Defined in tests/utils/test-data-generator.ts:248

`Static` generateProtocolEncryptedRecordsWrite

generateProtocolEncryptedRecordsWrite(input): Promise<{
    dataStream: Readable;
    encryptedDataBytes: Uint8Array;
    encryptionInput: EncryptionInput;
    message: RecordsWriteMessage;
    recordsWrite: RecordsWrite;
}>
Generates a encrypted RecordsWrite message for testing.
Parameters
- input: {
      author: Persona;
      encryptSymmetricKeyWithProtocolContextDerivedKey: boolean;
      encryptSymmetricKeyWithProtocolPathDerivedKey: boolean;
      plaintextBytes: Uint8Array;
      protocolContextDerivedPublicJwk?: PublicJwk;
      protocolContextDerivingRootKeyId?: string;
      protocolDefinition: ProtocolDefinition;
      protocolParentContextId?: string;
      protocolPath: string;
      recipient?: string;
  }
  - author: Persona
  - encryptSymmetricKeyWithProtocolContextDerivedKey: boolean
    Set to true to attach the symmetric key encrypted by the protocol context derived public key
  - encryptSymmetricKeyWithProtocolPathDerivedKey: boolean
    Set to true to attach the symmetric key encrypted by the protocol path derived public key
  - plaintextBytes: Uint8Array
  - Optional protocolContextDerivedPublicJwk?: PublicJwk
  - Optional protocolContextDerivingRootKeyId?: string
  - protocolDefinition: ProtocolDefinition
    Protocol definition used to generate the RecordsWrite. Must be the RECIPIENT's protocol definition if encryptSymmetricKeyWithProtocolPathDerivedKey is true, because the recipient's public keys will be needed to encrypt the symmetric key.
  - Optional protocolParentContextId?: string
  - protocolPath: string
  - Optional recipient?: string
Returns Promise<{
    dataStream: Readable;
    encryptedDataBytes: Uint8Array;
    encryptionInput: EncryptionInput;
    message: RecordsWriteMessage;
    recordsWrite: RecordsWrite;
}>
- Defined in tests/utils/test-data-generator.ts:423

`Static` generateProtocolsConfigure

generateProtocolsConfigure(input?): Promise<GenerateProtocolsConfigureOutput>
Generates a ProtocolsConfigure message for testing. Optional parameters are generated if not given. Implementation currently uses ProtocolsConfigure.create().
Parameters
- Optional input: GenerateProtocolsConfigureInput
Returns Promise<GenerateProtocolsConfigureOutput>
- Defined in tests/utils/test-data-generator.ts:282

`Static` generateProtocolsQuery

generateProtocolsQuery(input?): Promise<GenerateProtocolsQueryOutput>
Generates a ProtocolsQuery message for testing.
Parameters
- Optional input: GenerateProtocolsQueryInput
Returns Promise<GenerateProtocolsQueryOutput>
- Defined in tests/utils/test-data-generator.ts:326

`Static` generateRecordsDelete

generateRecordsDelete(input?): Promise<GenerateRecordsDeleteOutput>
Generates a RecordsDelete for testing.
Parameters
- Optional input: GenerateRecordsDeleteInput
Returns Promise<GenerateRecordsDeleteOutput>
- Defined in tests/utils/test-data-generator.ts:660

`Static` generateRecordsQuery

generateRecordsQuery(input?): Promise<GenerateRecordsQueryOutput>
Generates a RecordsQuery message for testing.
Parameters
- Optional input: GenerateRecordsQueryInput
Returns Promise<GenerateRecordsQueryOutput>
- Defined in tests/utils/test-data-generator.ts:582

`Static` generateRecordsSubscribe

generateRecordsSubscribe(input?): Promise<GenerateRecordsSubscribeOutput>
Generates a RecordsSubscribe message for testing.
Parameters
- Optional input: GenerateRecordsSubscribeInput
Returns Promise<GenerateRecordsSubscribeOutput>
- Defined in tests/utils/test-data-generator.ts:622

`Static` generateRecordsWrite

generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>
Generates a RecordsWrite message for testing. Implementation currently uses RecordsWrite.create().
Parameters
- Optional input: GenerateRecordsWriteInput
Returns Promise<GenerateRecordsWriteOutput>
- Defined in tests/utils/test-data-generator.ts:358

`Static` randomBytes

randomBytes(length): Uint8Array
Generates a random byte array of given length.
Parameters
- length: number
Returns Uint8Array
- Defined in tests/utils/test-data-generator.ts:803

`Static` randomCborSha256Cid

randomCborSha256Cid(): Promise<string>
Generates a random CBOR SHA256 CID.

Returns Promise<string>
- Defined in tests/utils/test-data-generator.ts:815

`Static` randomInt

randomInt(min, max): number
Generates a random within a range (inclusive).
Parameters
- min: number
  lowest potential value.
- max: number
  greatest potential value.
Returns number
- Defined in tests/utils/test-data-generator.ts:827

`Static` randomSignatureString

randomSignatureString(): Promise<string>
Generates a random but well-formed signature string in Base64Url format.

Returns Promise<string>
- Defined in tests/utils/test-data-generator.ts:777

`Static` randomString

randomString(length): string
Generates a random alpha-numeric string.
Parameters
- length: number
Returns string
- Defined in tests/utils/test-data-generator.ts:788

`Static` randomTimestamp

randomTimestamp(options?): string
Generates a random timestamp. Optionally allows you to set specific non-randomized values for the timestamp.
Parameters
- Optional options: {
      day?: number;
      hour?: number;
      microsecond?: number;
      millisecond?: number;
      minute?: number;
      month?: number;
      second?: number;
      year?: number;
  }
  - Optional day?: number
  - Optional hour?: number
  - Optional microsecond?: number
  - Optional millisecond?: number
  - Optional minute?: number
  - Optional month?: number
  - Optional second?: number
  - Optional year?: number
Returns string
random UTC ISO-8601 timestamp
- Defined in tests/utils/test-data-generator.ts:836

Class TestDataGenerator

Index

Constructors

Methods

Constructors

constructor

Returns TestDataGenerator

Methods

Static createDidResolutionResult

Parameters

Returns DidResolutionResult

Static generateAuthorization

Returns AuthorizationModel

Static generateAuthorizationSignature

Returns GeneralJws

Static generateDidKeyPersona

Returns Promise<Persona>

Static generateEventsGet

Parameters

Returns Promise<GenerateEventsGetOutput>

Static generateEventsQuery

Parameters

Returns Promise<GenerateEventsQueryOutput>

Static generateEventsSubscribe

Parameters

Returns Promise<GenerateEventsSubscribeOutput>

Static generateFromRecordsWrite

Parameters

Returns Promise<GenerateFromRecordsWriteOut>

Static generateMessagesGet

Parameters

Returns Promise<GenerateMessagesGetOutput>

Static generatePersona

Parameters

Returns Promise<Persona>

Static generateProtocolEncryptedRecordsWrite

Parameters

author: Persona

encryptSymmetricKeyWithProtocolContextDerivedKey: boolean

encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

plaintextBytes: Uint8Array

Optional protocolContextDerivedPublicJwk?: PublicJwk

Optional protocolContextDerivingRootKeyId?: string

protocolDefinition: ProtocolDefinition

Optional protocolParentContextId?: string

protocolPath: string

Optional recipient?: string

Returns Promise<{ dataStream: Readable; encryptedDataBytes: Uint8Array; encryptionInput: EncryptionInput; message: RecordsWriteMessage; recordsWrite: RecordsWrite; }>

Static generateProtocolsConfigure

Parameters

Returns Promise<GenerateProtocolsConfigureOutput>

Static generateProtocolsQuery

Parameters

Returns Promise<GenerateProtocolsQueryOutput>

Static generateRecordsDelete

Parameters

Returns Promise<GenerateRecordsDeleteOutput>

Static generateRecordsQuery

Parameters

Returns Promise<GenerateRecordsQueryOutput>

Static generateRecordsSubscribe

Parameters

Returns Promise<GenerateRecordsSubscribeOutput>

Static generateRecordsWrite

Parameters

Returns Promise<GenerateRecordsWriteOutput>

Static randomBytes

Parameters

Returns Uint8Array

Static randomCborSha256Cid

Returns Promise<string>

Static randomInt

Parameters

Returns number

Static randomSignatureString

Returns Promise<string>

Static randomString

Parameters

Returns string

Static randomTimestamp

`Static` createDidResolutionResult

`Static` generateAuthorization

`Static` generateAuthorizationSignature

`Static` generateDidKeyPersona

`Static` generateEventsGet

`Static` generateEventsQuery

`Static` generateEventsSubscribe

`Static` generateFromRecordsWrite

`Static` generateMessagesGet

`Static` generatePersona

`Static` generateProtocolEncryptedRecordsWrite

`Optional` protocolContextDerivedPublicJwk?: PublicJwk

`Optional` protocolContextDerivingRootKeyId?: string

`Optional` protocolParentContextId?: string

`Optional` recipient?: string

Returns Promise<{
dataStream: Readable;
encryptedDataBytes: Uint8Array;
encryptionInput: EncryptionInput;
message: RecordsWriteMessage;
recordsWrite: RecordsWrite;
}>

`Static` generateProtocolsConfigure

`Static` generateProtocolsQuery

`Static` generateRecordsDelete

`Static` generateRecordsQuery

`Static` generateRecordsSubscribe

`Static` generateRecordsWrite

`Static` randomBytes

`Static` randomCborSha256Cid

`Static` randomInt

`Static` randomSignatureString

`Static` randomString

`Static` randomTimestamp

`Optional` day?: number

`Optional` hour?: number

`Optional` microsecond?: number

`Optional` millisecond?: number

`Optional` minute?: number

`Optional` month?: number

`Optional` second?: number

`Optional` year?: number