Update type definitions

openpgpjs · Feb 15, 2023 · 9d933cb · 9d933cb
1 parent 809deee
commit 9d933cb
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/openpgp.d.ts b/openpgp.d.ts
@@ -166,7 +166,7 @@ export class CleartextMessage {
    *
    *  @param privateKeys private keys with decrypted secret key data for signing
    */
-  sign(privateKeys: PrivateKey[], signature?: Signature, signingKeyIDs?: KeyID[], date?: Date, userIDs?: UserID[], config?: Config): void;
+  sign(privateKeys: PrivateKey[], signature?: Signature, signingKeyIDs?: KeyID[], date?: Date, userIDs?: UserID[], notations?: Notation[], config?: Config): void;
 
   /** Verify signatures of cleartext signed message
    *  @param keys array of keys to verify signatures
@@ -285,7 +285,7 @@ export class Message<T extends MaybeStream<Data>> {
   /** Sign the message (the literal data packet of the message)
       @param signingKeys private keys with decrypted secret key data for signing
   */
-  public sign(signingKeys: PrivateKey[], signature?: Signature, signingKeyIDs?: KeyID[], date?: Date, userIDs?: UserID[], config?: Config): Promise<Message<T>>;
+  public sign(signingKeys: PrivateKey[], signature?: Signature, signingKeyIDs?: KeyID[], date?: Date, userIDs?: UserID[], notations?: Notation[], config?: Config): Promise<Message<T>>;
 
   /** Unwrap compressed message
    */
@@ -521,14 +521,14 @@ export class SignaturePacket extends BasePacket {
   public issuerFingerprint: null | Uint8Array;
   public preferredAEADAlgorithms: enums.aead[] | null;
   public revoked: null | boolean;
-  public rawNotations: RawNotation[];
+  public rawNotations: Notation[];
   public sign(key: AnySecretKeyPacket, data: Uint8Array, date?: Date, detached?: boolean): Promise<void>;
   public verify(key: AnyKeyPacket, signatureType: enums.signature, data: Uint8Array | object, date?: Date, detached?: boolean, config?: Config): Promise<void>; // throws on error
   public isExpired(date?: Date): boolean;
   public getExpirationTime(): Date | typeof Infinity;
 }
 
-export interface RawNotation {
+export interface Notation {
   name: string;
   value: Uint8Array;
   humanReadable: boolean;
@@ -604,6 +604,8 @@ interface EncryptOptions {
   signingUserIDs?: MaybeArray<UserID>;
   /** (optional) array of user IDs to encrypt for, e.g. { name:'Robert Receiver', email:'robert@openpgp.org' } */
   encryptionUserIDs?: MaybeArray<UserID>;
+  /** (optional) array of notations to add to the signatures, e.g. { name: 'test@example.org', value: new TextEncoder().encode('test'), humanReadable: true } */
+  signatureNotations?: MaybeArray<Notation>;
   config?: PartialConfig;
 }
 
@@ -637,6 +639,7 @@ interface SignOptions {
   signingKeyIDs?: MaybeArray<KeyID>;
   date?: Date;
   signingUserIDs?: MaybeArray<UserID>;
+  signatureNotations?: MaybeArray<Notation>;
   config?: PartialConfig;
 }
 

diff --git a/test/typescript/definitions.ts b/test/typescript/definitions.ts
@@ -134,6 +134,14 @@ import {
   const textSignedObject: Message<string> = await sign({ signingKeys: privateKeys, message: textMessage, format: 'object' });
   expect(textSignedObject).to.be.instanceOf(Message);
 
+  // Sign text message (armored)
+  const textSignedWithNotations: string = await sign({ signingKeys: privateKeys, message: textMessage, signatureNotations: [{
+    name: 'test@example.org',
+    value: new TextEncoder().encode('test'),
+    humanReadable: true
+  }] });
+  expect(textSignedWithNotations).to.include('-----BEGIN PGP MESSAGE-----');
+
   // Verify signed text message (armored)
   const signedMessage = await readMessage({ armoredMessage: textSignedArmor });
   const verifiedText = await verify({ verificationKeys: publicKeys, message: signedMessage });