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:889

`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:789

`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:798

`Static`generateDidKeyPersona

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

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

`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:600

`Static`generateMessagesSubscribe

generateMessagesSubscribe(input?): Promise<GenerateMessagesSubscribeOutput>
Generates a MessagesSubscribe message for testing.
Parameters
- Optionalinput: GenerateMessagesSubscribeInput
Returns Promise<GenerateMessagesSubscribeOutput>
- Defined in tests/utils/test-data-generator.ts:745

`Static`generatePersona

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

`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
  - OptionalprotocolContextDerivedPublicJwk?: PublicJwk
  - OptionalprotocolContextDerivingRootKeyId?: 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.
  - OptionalprotocolParentContextId?: string
  - protocolPath: string
  - Optionalrecipient?: string
Returns Promise<{
    dataStream: Readable;
    encryptedDataBytes: Uint8Array;
    encryptionInput: EncryptionInput;
    message: RecordsWriteMessage;
    recordsWrite: RecordsWrite;
}>
- Defined in tests/utils/test-data-generator.ts:474

`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
- Optionalinput: GenerateProtocolsConfigureInput
Returns Promise<GenerateProtocolsConfigureOutput>
- Defined in tests/utils/test-data-generator.ts:296

`Static`generateProtocolsQuery

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

`Static`generateRecordsDelete

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

`Static`generateRecordsQuery

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

`Static`generateRecordsSubscribe

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

`Static`generateRecordsWrite

generateRecordsWrite(input?): Promise<GenerateRecordsWriteOutput>
Generates a RecordsWrite message for testing. dataBytes & dataStream returned will be undefined as long as dataCid or dataSize is given. Implementation currently uses RecordsWrite.create().
Parameters
- Optionalinput: GenerateRecordsWriteInput
Returns Promise<GenerateRecordsWriteOutput>
- Defined in tests/utils/test-data-generator.ts:409

`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:837

`Static`randomCborSha256Cid

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

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

`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:861

`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:811

`Static`randomString

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

`Static`randomTimestamp

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

Class TestDataGenerator

Index

Constructors

Methods

Constructors

constructor

Returns TestDataGenerator

Methods

StaticcreateDidResolutionResult

Parameters

Returns DidResolutionResult

StaticgenerateAuthorization

Returns AuthorizationModel

StaticgenerateAuthorizationSignature

Returns GeneralJws

StaticgenerateDidKeyPersona

Returns Promise<Persona>

StaticgenerateFromRecordsWrite

Parameters

Returns Promise<GenerateFromRecordsWriteOut>

StaticgenerateGrantCreate

Parameters

Returns Promise<GenerateGrantCreateOutput>

StaticgenerateMessagesQuery

Parameters

Returns Promise<GenerateMessagesQueryOutput>

StaticgenerateMessagesRead

Parameters

Returns Promise<GenerateMessagesReadOutput>

StaticgenerateMessagesSubscribe

Parameters

Returns Promise<GenerateMessagesSubscribeOutput>

StaticgeneratePersona

Parameters

Returns Promise<Persona>

StaticgenerateProtocolEncryptedRecordsWrite

Parameters

author: Persona

encryptSymmetricKeyWithProtocolContextDerivedKey: boolean

encryptSymmetricKeyWithProtocolPathDerivedKey: boolean

plaintextBytes: Uint8Array

OptionalprotocolContextDerivedPublicJwk?: PublicJwk

OptionalprotocolContextDerivingRootKeyId?: string

protocolDefinition: ProtocolDefinition

OptionalprotocolParentContextId?: string

protocolPath: string

Optionalrecipient?: string

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

StaticgenerateProtocolsConfigure

Parameters

Returns Promise<GenerateProtocolsConfigureOutput>

StaticgenerateProtocolsQuery

Parameters

Returns Promise<GenerateProtocolsQueryOutput>

StaticgenerateRecordsDelete

Parameters

Returns Promise<GenerateRecordsDeleteOutput>

StaticgenerateRecordsQuery

Parameters

Returns Promise<GenerateRecordsQueryOutput>

StaticgenerateRecordsSubscribe

Parameters

Returns Promise<GenerateRecordsSubscribeOutput>

StaticgenerateRecordsWrite

Parameters

Returns Promise<GenerateRecordsWriteOutput>

StaticrandomBytes

Parameters

Returns Uint8Array

StaticrandomCborSha256Cid

Returns Promise<string>

StaticrandomInt

Parameters

Returns number

StaticrandomSignatureString

Returns Promise<string>

StaticrandomString

Parameters

Returns string

StaticrandomTimestamp

`Static`createDidResolutionResult

`Static`generateAuthorization

`Static`generateAuthorizationSignature

`Static`generateDidKeyPersona

`Static`generateFromRecordsWrite

`Static`generateGrantCreate

`Static`generateMessagesQuery

`Static`generateMessagesRead

`Static`generateMessagesSubscribe

`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