@signalapp/libsignal-client 0.76.2 → 0.76.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -669,7 +669,7 @@ For more information on this, and how to apply and follow the GNU AGPL, see
669
669
 
670
670
  ```
671
671
 
672
- ## libsignal-account-keys, attest, libsignal-node, signal-neon-futures, libsignal-bridge, libsignal-bridge-macros, libsignal-bridge-testing, libsignal-bridge-types, libsignal-core, signal-crypto, device-transfer, libsignal-keytrans, signal-media, libsignal-message-backup, libsignal-message-backup-macros, libsignal-net, libsignal-net-chat, libsignal-net-infra, poksho, libsignal-protocol, usernames, zkcredential, zkgroup
672
+ ## libsignal-account-keys, attest, libsignal-node, signal-neon-futures, libsignal-bridge, libsignal-bridge-macros, libsignal-bridge-testing, libsignal-bridge-types, libsignal-core, signal-crypto, device-transfer, libsignal-keytrans, signal-media, libsignal-message-backup, libsignal-message-backup-macros, libsignal-net, libsignal-net-chat, libsignal-net-infra, poksho, libsignal-protocol, libsignal-svrb, usernames, zkcredential, zkgroup
673
673
 
674
674
  ```
675
675
  GNU AFFERO GENERAL PUBLIC LICENSE
@@ -81,6 +81,16 @@ export declare class RegistrationService {
81
81
  submitCaptcha(captcha: string): Promise<{
82
82
  allowedToRequestCode: boolean;
83
83
  }>;
84
+ /**
85
+ * Request that a verification code be sent via the given transport method.
86
+ *
87
+ * With the websocket transport, this makes a POST request to
88
+ * `/v1/verification/session/{sessionId}/code`.
89
+ *
90
+ * The `languages` parameter should be a list of languages in Accept-Language syntax. Note that
91
+ * "quality weighting" can be left out; the Signal server will always consider the list to be in
92
+ * priority order.
93
+ */
84
94
  requestVerification({ transport, client, languages, }: {
85
95
  transport: 'sms' | 'voice';
86
96
  client: string;
@@ -76,6 +76,16 @@ class RegistrationService {
76
76
  await Native.RegistrationService_SubmitCaptcha(this.tokioAsyncContext, this, captcha);
77
77
  return this.sessionState;
78
78
  }
79
+ /**
80
+ * Request that a verification code be sent via the given transport method.
81
+ *
82
+ * With the websocket transport, this makes a POST request to
83
+ * `/v1/verification/session/{sessionId}/code`.
84
+ *
85
+ * The `languages` parameter should be a list of languages in Accept-Language syntax. Note that
86
+ * "quality weighting" can be left out; the Signal server will always consider the list to be in
87
+ * priority order.
88
+ */
79
89
  async requestVerification({ transport, client, languages = [], }) {
80
90
  await Native.RegistrationService_RequestVerificationCode(this.tokioAsyncContext, this, transport, client, languages);
81
91
  }
package/dist/net.d.ts CHANGED
@@ -77,9 +77,9 @@ export declare class Net {
77
77
  * @param listener the listener for incoming events.
78
78
  * @param options additional options to pass through.
79
79
  * @param options.languages If provided, a list of languages in Accept-Language syntax to apply
80
- * to all requests made on this connection.
80
+ * to all requests made on this connection. Note that "quality weighting" can be left out; the
81
+ * Signal server will always consider the list to be in priority order.
81
82
  * @param options.abortSignal an {@link AbortSignal} that will cancel the connection attempt.
82
- * @returns the connected listener, if the connection succeeds.
83
83
  */
84
84
  connectUnauthenticatedChat(listener: ConnectionEventsListener, options?: {
85
85
  languages?: string[];
@@ -87,6 +87,17 @@ export declare class Net {
87
87
  }): Promise<UnauthenticatedChatConnection>;
88
88
  /**
89
89
  * Creates a new instance of {@link AuthenticatedChatConnection}.
90
+ *
91
+ * @param username the identifier for the local device
92
+ * @param password the password for the local device
93
+ * @param receiveStories whether or not the local user has Stories enabled, so the server can
94
+ * filter them out ahead of time
95
+ * @param listener the listener for incoming events.
96
+ * @param options additional options to pass through.
97
+ * @param options.languages If provided, a list of languages in Accept-Language syntax to apply
98
+ * to all requests made on this connection. Note that "quality weighting" can be left out; the
99
+ * Signal server will always consider the list to be in priority order.
100
+ * @param options.abortSignal an {@link AbortSignal} that will cancel the connection attempt.
90
101
  */
91
102
  connectAuthenticatedChat(username: string, password: string, receiveStories: boolean, listener: ChatServiceListener, options?: {
92
103
  languages?: string[];
package/dist/net.js CHANGED
@@ -88,9 +88,9 @@ class Net {
88
88
  * @param listener the listener for incoming events.
89
89
  * @param options additional options to pass through.
90
90
  * @param options.languages If provided, a list of languages in Accept-Language syntax to apply
91
- * to all requests made on this connection.
91
+ * to all requests made on this connection. Note that "quality weighting" can be left out; the
92
+ * Signal server will always consider the list to be in priority order.
92
93
  * @param options.abortSignal an {@link AbortSignal} that will cancel the connection attempt.
93
- * @returns the connected listener, if the connection succeeds.
94
94
  */
95
95
  async connectUnauthenticatedChat(listener, options) {
96
96
  const env = this.options.localTestServer ? undefined : this.options.env;
@@ -98,6 +98,17 @@ class Net {
98
98
  }
99
99
  /**
100
100
  * Creates a new instance of {@link AuthenticatedChatConnection}.
101
+ *
102
+ * @param username the identifier for the local device
103
+ * @param password the password for the local device
104
+ * @param receiveStories whether or not the local user has Stories enabled, so the server can
105
+ * filter them out ahead of time
106
+ * @param listener the listener for incoming events.
107
+ * @param options additional options to pass through.
108
+ * @param options.languages If provided, a list of languages in Accept-Language syntax to apply
109
+ * to all requests made on this connection. Note that "quality weighting" can be left out; the
110
+ * Signal server will always consider the list to be in priority order.
111
+ * @param options.abortSignal an {@link AbortSignal} that will cancel the connection attempt.
101
112
  */
102
113
  connectAuthenticatedChat(username, password, receiveStories, listener, options) {
103
114
  return Chat_1.AuthenticatedChatConnection.connect(this.asyncContext, this._connectionManager, username, password, receiveStories, listener, options);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@signalapp/libsignal-client",
3
- "version": "0.76.2",
3
+ "version": "0.76.4",
4
4
  "license": "AGPL-3.0-only",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",