@inweb/client 25.7.0 → 25.7.2

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.
package/src/Api/User.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
2
+ // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
3
3
  // All rights reserved.
4
4
  //
5
5
  // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
14
14
  //
15
15
  // This application incorporates Open Design Alliance software pursuant to a
16
16
  // license agreement with Open Design Alliance.
17
- // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
17
+ // Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
18
18
  // All rights reserved.
19
19
  //
20
20
  // By use of this software, its documentation or related materials, you
@@ -43,7 +43,7 @@ export class User {
43
43
 
44
44
  /**
45
45
  * User avatar image URL or empty string if the user does not have an avatar. Use
46
- * {@link User.setAvatar | setAvatar()} to change avatar image.
46
+ * {@link setAvatar | setAvatar()} to change avatar image.
47
47
  *
48
48
  * @readonly
49
49
  */
@@ -258,7 +258,8 @@ export class User {
258
258
  }
259
259
 
260
260
  /**
261
- * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
261
+ * The user's access token (API key). Use {@link signInWithToken | Client.signInWithToken()}
262
+ * to log in using token.
262
263
  *
263
264
  * @readonly
264
265
  */
@@ -304,7 +305,6 @@ export class User {
304
305
  * Only administrators can update other users. If the current logged in user is not an
305
306
  * administrator, they can only update themself, otherwise an exception will be thrown.
306
307
  *
307
- * @async
308
308
  * @param data - Raw user data.
309
309
  */
310
310
  async update(data: any): Promise<this> {
@@ -333,7 +333,6 @@ export class User {
333
333
  *
334
334
  * You need to re-login to continue working after deleting the current logged in user.
335
335
  *
336
- * @async
337
336
  * @returns Returns the raw data of a deleted user.
338
337
  */
339
338
  delete(): Promise<any> {
@@ -357,8 +356,6 @@ export class User {
357
356
  /**
358
357
  * Save user data changes to the server. Call this method to update user data on the server
359
358
  * after any changes.
360
- *
361
- * @async
362
359
  */
363
360
  save(): Promise<this> {
364
361
  return this.update(this.data);
@@ -370,7 +367,6 @@ export class User {
370
367
  * Only administrators can set the avatar of other users. If the current logged in user is
371
368
  * not an administrator, they can only set their avatar, otherwise an exception will be thrown.
372
369
  *
373
- * @async
374
370
  * @param image - Avatar image. Can be a
375
371
  * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
376
372
  * string,
@@ -401,8 +397,6 @@ export class User {
401
397
  *
402
398
  * Only administrators can remove the avatar of other users. If the current logged in user is
403
399
  * not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
404
- *
405
- * @async
406
400
  */
407
401
  async deleteAvatar(): Promise<this> {
408
402
  if (this.httpClient.signInUserIsAdmin) {
@@ -428,7 +422,6 @@ export class User {
428
422
  *
429
423
  * To change their password, non-administrator users must provide their old password.
430
424
  *
431
- * @async
432
425
  * @param newPassword - New user password.
433
426
  * @param oldPassword - Old user password. Only required for non-administrator users to
434
427
  * change their password.
package/src/Api/Utils.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
2
+ // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
3
3
  // All rights reserved.
4
4
  //
5
5
  // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
14
14
  //
15
15
  // This application incorporates Open Design Alliance software pursuant to a
16
16
  // license agreement with Open Design Alliance.
17
- // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
17
+ // Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
18
18
  // All rights reserved.
19
19
  //
20
20
  // By use of this software, its documentation or related materials, you
@@ -1,5 +1,5 @@
1
1
  ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
2
+ // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
3
3
  // All rights reserved.
4
4
  //
5
5
  // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
14
14
  //
15
15
  // This application incorporates Open Design Alliance software pursuant to a
16
16
  // license agreement with Open Design Alliance.
17
- // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
17
+ // Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
18
18
  // All rights reserved.
19
19
  //
20
20
  // By use of this software, its documentation or related materials, you
package/src/index.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2002-2023, Open Design Alliance (the "Alliance").
2
+ // Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
3
3
  // All rights reserved.
4
4
  //
5
5
  // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
14
14
  //
15
15
  // This application incorporates Open Design Alliance software pursuant to a
16
16
  // license agreement with Open Design Alliance.
17
- // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
17
+ // Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
18
18
  // All rights reserved.
19
19
  //
20
20
  // By use of this software, its documentation or related materials, you