node: Enforce @typescript-eslint/method-signature-style

Author: jrose-signal

RELEASE_NOTES.md

@@ -2,4 +2,6 @@ v0.82.0
 
 - Node: migrate libsignal-client to the ECMAScript module format (from CommonJS).
 
+- Node: interfaces now use property notation for method requirements, which TypeScript can check more strictly.
+
 - net: Direct connections to the Signal servers will be tried as a fallback if connecting through an HTTP or SOCKS proxy fails or takes too long.

node/Native.d.ts

@@ -64,80 +64,83 @@ enum IdentityChange {
 }
 
 type IdentityKeyStore = {
-  _getIdentityKey(): Promise<PrivateKey>;
-  _getLocalRegistrationId(): Promise<number>;
-  _saveIdentity(name: ProtocolAddress, key: PublicKey): Promise<IdentityChange>;
-  _isTrustedIdentity(
+  _getIdentityKey: () => Promise<PrivateKey>;
+  _getLocalRegistrationId: () => Promise<number>;
+  _saveIdentity: (
+    name: ProtocolAddress,
+    key: PublicKey
+  ) => Promise<IdentityChange>;
+  _isTrustedIdentity: (
     name: ProtocolAddress,
     key: PublicKey,
     sending: boolean
-  ): Promise<boolean>;
-  _getIdentity(name: ProtocolAddress): Promise<PublicKey | null>;
+  ) => Promise<boolean>;
+  _getIdentity: (name: ProtocolAddress) => Promise<PublicKey | null>;
 };
 
 type SessionStore = {
-  _saveSession(addr: ProtocolAddress, record: SessionRecord): Promise<void>;
-  _getSession(addr: ProtocolAddress): Promise<SessionRecord | null>;
+  _saveSession: (addr: ProtocolAddress, record: SessionRecord) => Promise<void>;
+  _getSession: (addr: ProtocolAddress) => Promise<SessionRecord | null>;
 };
 
 type PreKeyStore = {
-  _savePreKey(preKeyId: number, record: PreKeyRecord): Promise<void>;
-  _getPreKey(preKeyId: number): Promise<PreKeyRecord>;
-  _removePreKey(preKeyId: number): Promise<void>;
+  _savePreKey: (preKeyId: number, record: PreKeyRecord) => Promise<void>;
+  _getPreKey: (preKeyId: number) => Promise<PreKeyRecord>;
+  _removePreKey: (preKeyId: number) => Promise<void>;
 };
 
 type SignedPreKeyStore = {
-  _saveSignedPreKey(
+  _saveSignedPreKey: (
     signedPreKeyId: number,
     record: SignedPreKeyRecord
-  ): Promise<void>;
-  _getSignedPreKey(signedPreKeyId: number): Promise<SignedPreKeyRecord>;
+  ) => Promise<void>;
+  _getSignedPreKey: (signedPreKeyId: number) => Promise<SignedPreKeyRecord>;
 };
 
 type KyberPreKeyStore = {
-  _saveKyberPreKey(
+  _saveKyberPreKey: (
     kyberPreKeyId: number,
     record: KyberPreKeyRecord
-  ): Promise<void>;
-  _getKyberPreKey(kyberPreKeyId: number): Promise<KyberPreKeyRecord>;
-  _markKyberPreKeyUsed(
+  ) => Promise<void>;
+  _getKyberPreKey: (kyberPreKeyId: number) => Promise<KyberPreKeyRecord>;
+  _markKyberPreKeyUsed: (
     kyberPreKeyId: number,
     signedPreKeyId: number,
     baseKey: PublicKey
-  ): Promise<void>;
+  ) => Promise<void>;
 };
 
 type SenderKeyStore = {
-  _saveSenderKey(
+  _saveSenderKey: (
     sender: ProtocolAddress,
     distributionId: Uuid,
     record: SenderKeyRecord
-  ): Promise<void>;
-  _getSenderKey(
+  ) => Promise<void>;
+  _getSenderKey: (
     sender: ProtocolAddress,
     distributionId: Uuid
-  ): Promise<SenderKeyRecord | null>;
+  ) => Promise<SenderKeyRecord | null>;
 };
 
 type InputStream = {
-  _read(amount: number): Promise<Uint8Array>;
-  _skip(amount: number): Promise<void>;
+  _read: (amount: number) => Promise<Uint8Array>;
+  _skip: (amount: number) => Promise<void>;
 };
 
 type SyncInputStream = Uint8Array;
 
 type ChatListener = {
-  _incoming_message(
+  _incoming_message: (
     envelope: Uint8Array,
     timestamp: number,
     ack: ServerMessageAck
-  ): void;
-  _queue_empty(): void;
-  _received_alerts(alerts: string[]): void;
-  _connection_interrupted(
+  ) => void;
+  _queue_empty: () => void;
+  _received_alerts: (alerts: string[]) => void;
+  _connection_interrupted: (
     // A LibSignalError or null, but not naming the type to avoid circular import dependencies.
     reason: Error | null
-  ): void;
+  ) => void;
 };
 
 type ChallengeOption = 'pushChallenge' | 'captcha';

node/eslint.config.js

@@ -98,6 +98,7 @@ const config = defineConfig(
       '@typescript-eslint/consistent-type-assertions': 'error',
       '@typescript-eslint/explicit-module-boundary-types': 'error',
       '@typescript-eslint/restrict-template-expressions': 'off',
+      '@typescript-eslint/method-signature-style': 'error',
       'jsdoc/check-access': 'error',
       'jsdoc/check-alignment': 'error',
       'jsdoc/check-line-alignment': 'error',

node/ts/index.ts

@@ -237,16 +237,16 @@ export class KEMKeyPair {
 
 /** The public information contained in a {@link SignedPreKeyRecord} */
 export type SignedPublicPreKey = {
-  id(): number;
-  publicKey(): PublicKey;
-  signature(): Uint8Array;
+  id: () => number;
+  publicKey: () => PublicKey;
+  signature: () => Uint8Array;
 };
 
 /** The public information contained in a {@link KyberPreKeyRecord} */
 export type SignedKyberPublicPreKey = {
-  id(): number;
-  publicKey(): KEMPublicKey;
-  signature(): Uint8Array;
+  id: () => number;
+  publicKey: () => KEMPublicKey;
+  signature: () => Uint8Array;
 };
 
 export class PreKeyBundle {
@@ -1320,7 +1320,7 @@ export class SealedSenderDecryptionResult {
 }
 
 export interface CiphertextMessageConvertible {
-  asCiphertextMessage(): CiphertextMessage;
+  asCiphertextMessage: () => CiphertextMessage;
 }
 
 export class CiphertextMessage {

node/ts/net/Chat.ts

@@ -41,7 +41,7 @@ export interface ConnectionEventsListener {
    * closures. If the closure was not due to a deliberate disconnect, the error
    * will be provided.
    */
-  onConnectionInterrupted(cause: LibSignalError | null): void;
+  onConnectionInterrupted: (cause: LibSignalError | null) => void;
 }
 
 export interface ChatServiceListener extends ConnectionEventsListener {
@@ -53,26 +53,26 @@ export interface ChatServiceListener extends ConnectionEventsListener {
    * If `ack`'s `send` method is not called, the server will leave this message in the message
    * queue and attempt to deliver it again in the future.
    */
-  onIncomingMessage(
+  onIncomingMessage: (
     envelope: Uint8Array,
     timestamp: number,
     ack: ChatServerMessageAck
-  ): void;
+  ) => void;
 
   /**
    * Called when the server indicates that there are no further messages in the message queue.
    *
    * Note that further messages may still be delivered; this merely indicates that all messages that
    * were in the queue *when the connection was established* have been delivered.
    */
-  onQueueEmpty(): void;
+  onQueueEmpty: () => void;
 
   /**
    * Called when the server has alerts for the current device.
    *
    * In practice this happens as part of the connecting process.
    */
-  onReceivedAlerts?(alerts: string[]): void;
+  onReceivedAlerts?: (alerts: string[]) => void;
 }
 
 /**
@@ -86,20 +86,20 @@ export type ChatConnection = {
    * Initiates termination of the underlying connection to the Chat Service. After the service is
    * disconnected, it cannot be used again.
    */
-  disconnect(): Promise<void>;
+  disconnect: () => Promise<void>;
 
   /**
    * Sends request to the Chat service.
    */
-  fetch(
+  fetch: (
     chatRequest: ChatRequest,
     options?: RequestOptions
-  ): Promise<Native.ChatResponse>;
+  ) => Promise<Native.ChatResponse>;
 
   /**
    * Information about the connection to the Chat service.
    */
-  connectionInfo(): ConnectionInfo;
+  connectionInfo: () => ConnectionInfo;
 };
 
 export interface ConnectionInfo {
@@ -438,8 +438,8 @@ function makeNativeChatListener(
         );
       }
     },
-    _connection_interrupted(cause: LibSignalError | null): void {
-      listener.onConnectionInterrupted(cause);
+    _connection_interrupted(cause: Error | null): void {
+      listener.onConnectionInterrupted(cause as LibSignalError);
     },
   };
 }

node/ts/net/KeyTransparency.ts

@@ -24,13 +24,13 @@ import {
  * used by the {@link Client}.
  */
 export interface Store {
-  getLastDistinguishedTreeHead(): Promise<Uint8Array | null>;
-  setLastDistinguishedTreeHead(
+  getLastDistinguishedTreeHead: () => Promise<Uint8Array | null>;
+  setLastDistinguishedTreeHead: (
     bytes: Readonly<Uint8Array> | null
-  ): Promise<void>;
+  ) => Promise<void>;
 
-  getAccountData(aci: Aci): Promise<Uint8Array | null>;
-  setAccountData(aci: Aci, bytes: Readonly<Uint8Array>): Promise<void>;
+  getAccountData: (aci: Aci) => Promise<Uint8Array | null>;
+  setAccountData: (aci: Aci, bytes: Readonly<Uint8Array>) => Promise<void>;
 }
 
 /**
@@ -146,11 +146,11 @@ export interface Client {
    * @throws {IoError} if an error occurred while communicating with the
    * server.
    * */
-  search(
+  search: (
     request: Request,
     store: Store,
     options?: Readonly<Options>
-  ): Promise<void>;
+  ) => Promise<void>;
 
   /**
    * Perform a monitor operation for an account previously searched for.
@@ -182,11 +182,11 @@ export interface Client {
    * @throws {IoError} if an error occurred while communicating with the
    * server.
    */
-  monitor(
+  monitor: (
     request: MonitorRequest,
     store: Store,
     options?: Readonly<Options>
-  ): Promise<void>;
+  ) => Promise<void>;
 }
 
 export class ClientImpl implements Client {

node/ts/net/chat/UnauthUsernamesService.ts

@@ -25,12 +25,12 @@ export interface UnauthUsernamesService {
    * Throws / completes with failure only if the request can't be completed, potentially including
    * if the hash is structurally invalid.
    */
-  lookUpUsernameHash(
+  lookUpUsernameHash: (
     request: {
       hash: Uint8Array;
     },
     options?: RequestOptions
-  ): Promise<Aci | null>;
+  ) => Promise<Aci | null>;
 }
 
 UnauthenticatedChatConnection.prototype.lookUpUsernameHash = async function (

node/ts/test/MessageBackupTest.ts

@@ -215,7 +215,7 @@ describe('OnlineBackupValidator', () => {
     // Here we override that `read` member with one that always produces a Uint8Array,
     // for more convenient use in the test. Note that this is unchecked.
     type ReadableUsingUint8Array = Omit<Readable, 'read'> & {
-      read(size: number): Uint8Array;
+      read: (size: number) => Uint8Array;
     };
     const input: ReadableUsingUint8Array = new Readable();
     input.push(exampleBackup);