Fixes for CDSI lookup in node

Fix issues that made this harder to use in client libraries: - mutable arguments made Net.cdsiLookup harder to call - a missing error code field made discriminating a RateLimitedError un-idiomatic
signalapp · Nov 3, 2023 · 89630ec · 89630ec
1 parent d6afc1b
commit 89630ec
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/node/package.json b/node/package.json
@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "node-gyp-build": "^4.2.3",
+    "type-fest": "^3.5.0",
     "uuid": "^8.3.0"
   },
   "devDependencies": {

diff --git a/node/ts/Errors.ts b/node/ts/Errors.ts
@@ -32,6 +32,8 @@ export enum ErrorCode {
   InputDataTooLong,
   InvalidEntropyDataLength,
   InvalidUsernameLinkEncryptedData,
+
+  RateLimitedError,
 }
 
 export class LibSignalErrorBase extends Error {
@@ -164,6 +166,7 @@ export type UnsupportedMediaInputError = LibSignalErrorCommon & {
 };
 
 export type RateLimitedError = LibSignalErrorBase & {
+  code: ErrorCode.RateLimitedError;
   readonly retryAfterSecs: number;
 };
 

diff --git a/node/ts/net.ts b/node/ts/net.ts
@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 
+import type { ReadonlyDeep } from 'type-fest';
 import * as Native from '../Native';
 import { Aci } from './Address';
 
@@ -44,13 +45,13 @@ export class Net {
   }
 
   async cdsiLookup(
-    { username, password }: CDSAuthType,
+    { username, password }: Readonly<CDSAuthType>,
     {
       e164s,
       acisAndAccessKeys,
       timeout,
       returnAcisWithoutUaks,
-    }: CDSRequestOptionsType
+    }: ReadonlyDeep<CDSRequestOptionsType>
   ): Promise<CDSResponseType<string, string>> {
     const request = { _nativeHandle: Native.LookupRequest_new() };
     e164s.forEach((e164) => {

diff --git a/node/yarn.lock b/node/yarn.lock
@@ -2369,6 +2369,11 @@ type-fest@^0.20.2:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4"
   integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
 
+type-fest@^3.5.0:
+  version "3.13.1"
+  resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-3.13.1.tgz#bb744c1f0678bea7543a2d1ec24e83e68e8c8706"
+  integrity sha512-tLq3bSNx+xSpwvAJnzrK0Ep5CLNWjvFTOp71URMaAEWBfRb9nnJiBoUe0tF8bI4ZFO3omgBR6NvnbzVUT3Ly4g==
+
 typed-array-buffer@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/typed-array-buffer/-/typed-array-buffer-1.0.0.tgz#18de3e7ed7974b0a729d3feecb94338d1472cd60"