ibm-cloud-sdk-core 3.0.0 → 3.0.1

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.
Files changed (19) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/auth/authenticators/authenticator-interface.d.ts +1 -1
  3. package/auth/authenticators/authenticator.d.ts +1 -1
  4. package/auth/authenticators/basic-authenticator.d.ts +1 -1
  5. package/auth/authenticators/token-request-based-authenticator.d.ts +1 -1
  6. package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +2 -2
  7. package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +2 -2
  8. package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +2 -2
  9. package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md +2 -2
  10. package/docs/ibm-cloud-sdk-core.api.json +8 -44
  11. package/es/auth/authenticators/authenticator-interface.d.ts +1 -1
  12. package/es/auth/authenticators/authenticator.d.ts +1 -1
  13. package/es/auth/authenticators/basic-authenticator.d.ts +1 -1
  14. package/es/auth/authenticators/token-request-based-authenticator.d.ts +1 -1
  15. package/etc/ibm-cloud-sdk-core.api.md +4 -4
  16. package/ibm-cloud-sdk-core.d.ts +4 -4
  17. package/package.json +1 -1
  18. package/temp/ibm-cloud-sdk-core.api.json +8 -44
  19. package/temp/ibm-cloud-sdk-core.api.md +4 -4
package/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ ## [3.0.1](https://github.com/IBM/node-sdk-core/compare/v3.0.0...v3.0.1) (2022-07-28)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * correct AuthenticatorInterface type ([#206](https://github.com/IBM/node-sdk-core/issues/206)) ([31dc7bd](https://github.com/IBM/node-sdk-core/commit/31dc7bd1e744a071cdabc2b5bf1e9513024079ac)), closes [#176](https://github.com/IBM/node-sdk-core/issues/176)
7
+
1
8
  # [3.0.0](https://github.com/IBM/node-sdk-core/compare/v2.17.15...v3.0.0) (2022-07-28)
2
9
 
3
10
 
package/auth/authenticators/authenticator-interface.d.ts CHANGED
@@ -38,7 +38,7 @@ export interface AuthenticatorInterface {
38
38
  * @param {object.<string, string>} requestOptions.headers The headers the
39
39
  * authentication information will be added to.
40
40
  */
41
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
41
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
42
42
  /**
43
43
  * Returns a string that indicates the authentication type.
44
44
  */
package/auth/authenticators/authenticator.d.ts CHANGED
@@ -46,7 +46,7 @@ export declare class Authenticator implements AuthenticatorInterface {
46
46
  * @throws {Error} - The authenticate method was not implemented by a
47
47
  * subclass.
48
48
  */
49
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
49
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
50
50
  /**
51
51
  * Retrieves the authenticator's type.
52
52
  * The returned value will be the same string that is used
package/auth/authenticators/basic-authenticator.d.ts CHANGED
@@ -55,7 +55,7 @@ export declare class BasicAuthenticator extends Authenticator {
55
55
  * @param {object.<string, string>} requestOptions.headers - The headers the
56
56
  * authentication information will be added too.
57
57
  */
58
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
58
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
59
59
  /**
60
60
  * Returns the authenticator's type ('basic').
61
61
  *
package/auth/authenticators/token-request-based-authenticator.d.ts CHANGED
@@ -87,5 +87,5 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
87
87
  * authentication information will be added too. Overrides default headers
88
88
  * where there's conflict.
89
89
  */
90
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
90
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
91
91
  }
package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md CHANGED
@@ -9,7 +9,7 @@ Augment the request with authentication information.
9
9
  <b>Signature:</b>
10
10
 
11
11
  ```typescript
12
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
12
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -20,7 +20,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
20
20
 
21
21
  <b>Returns:</b>
22
22
 
23
- Promise&lt;void \| Error&gt;
23
+ Promise&lt;void&gt;
24
24
 
25
25
  ## Exceptions
26
26
 
package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md CHANGED
@@ -9,7 +9,7 @@ Add authentication information to the specified request.
9
9
  <b>Signature:</b>
10
10
 
11
11
  ```typescript
12
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
12
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -20,5 +20,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
20
20
 
21
21
  <b>Returns:</b>
22
22
 
23
- Promise&lt;void \| Error&gt;
23
+ Promise&lt;void&gt;
24
24
 
package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md CHANGED
@@ -11,7 +11,7 @@ Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
11
11
  <b>Signature:</b>
12
12
 
13
13
  ```typescript
14
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
14
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
15
15
  ```
16
16
 
17
17
  ## Parameters
@@ -22,5 +22,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
22
22
 
23
23
  <b>Returns:</b>
24
24
 
25
- Promise&lt;void \| Error&gt;
25
+ Promise&lt;void&gt;
26
26
 
package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md CHANGED
@@ -11,7 +11,7 @@ Authorization: Bearer <bearer-token>
11
11
  <b>Signature:</b>
12
12
 
13
13
  ```typescript
14
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
14
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
15
15
  ```
16
16
 
17
17
  ## Parameters
@@ -22,5 +22,5 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
22
22
 
23
23
  <b>Returns:</b>
24
24
 
25
- Promise&lt;void \| Error&gt;
25
+ Promise&lt;void&gt;
26
26
 
package/docs/ibm-cloud-sdk-core.api.json CHANGED
@@ -350,16 +350,7 @@
350
350
  },
351
351
  {
352
352
  "kind": "Content",
353
- "text": "<void | "
354
- },
355
- {
356
- "kind": "Reference",
357
- "text": "Error",
358
- "canonicalReference": "!Error:interface"
359
- },
360
- {
361
- "kind": "Content",
362
- "text": ">"
353
+ "text": "<void>"
363
354
  },
364
355
  {
365
356
  "kind": "Content",
@@ -370,7 +361,7 @@
370
361
  "isStatic": false,
371
362
  "returnTypeTokenRange": {
372
363
  "startIndex": 3,
373
- "endIndex": 7
364
+ "endIndex": 5
374
365
  },
375
366
  "releaseTag": "Public",
376
367
  "overloadIndex": 1,
@@ -677,16 +668,7 @@
677
668
  },
678
669
  {
679
670
  "kind": "Content",
680
- "text": "<void | "
681
- },
682
- {
683
- "kind": "Reference",
684
- "text": "Error",
685
- "canonicalReference": "!Error:interface"
686
- },
687
- {
688
- "kind": "Content",
689
- "text": ">"
671
+ "text": "<void>"
690
672
  },
691
673
  {
692
674
  "kind": "Content",
@@ -696,7 +678,7 @@
696
678
  "isOptional": false,
697
679
  "returnTypeTokenRange": {
698
680
  "startIndex": 3,
699
- "endIndex": 7
681
+ "endIndex": 5
700
682
  },
701
683
  "releaseTag": "Public",
702
684
  "overloadIndex": 1,
@@ -1280,16 +1262,7 @@
1280
1262
  },
1281
1263
  {
1282
1264
  "kind": "Content",
1283
- "text": "<void | "
1284
- },
1285
- {
1286
- "kind": "Reference",
1287
- "text": "Error",
1288
- "canonicalReference": "!Error:interface"
1289
- },
1290
- {
1291
- "kind": "Content",
1292
- "text": ">"
1265
+ "text": "<void>"
1293
1266
  },
1294
1267
  {
1295
1268
  "kind": "Content",
@@ -1300,7 +1273,7 @@
1300
1273
  "isStatic": false,
1301
1274
  "returnTypeTokenRange": {
1302
1275
  "startIndex": 3,
1303
- "endIndex": 7
1276
+ "endIndex": 5
1304
1277
  },
1305
1278
  "releaseTag": "Public",
1306
1279
  "overloadIndex": 1,
@@ -5910,16 +5883,7 @@
5910
5883
  },
5911
5884
  {
5912
5885
  "kind": "Content",
5913
- "text": "<void | "
5914
- },
5915
- {
5916
- "kind": "Reference",
5917
- "text": "Error",
5918
- "canonicalReference": "!Error:interface"
5919
- },
5920
- {
5921
- "kind": "Content",
5922
- "text": ">"
5886
+ "text": "<void>"
5923
5887
  },
5924
5888
  {
5925
5889
  "kind": "Content",
@@ -5930,7 +5894,7 @@
5930
5894
  "isStatic": false,
5931
5895
  "returnTypeTokenRange": {
5932
5896
  "startIndex": 3,
5933
- "endIndex": 7
5897
+ "endIndex": 5
5934
5898
  },
5935
5899
  "releaseTag": "Public",
5936
5900
  "overloadIndex": 1,
package/es/auth/authenticators/authenticator-interface.d.ts CHANGED
@@ -38,7 +38,7 @@ export interface AuthenticatorInterface {
38
38
  * @param {object.<string, string>} requestOptions.headers The headers the
39
39
  * authentication information will be added to.
40
40
  */
41
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
41
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
42
42
  /**
43
43
  * Returns a string that indicates the authentication type.
44
44
  */
package/es/auth/authenticators/authenticator.d.ts CHANGED
@@ -46,7 +46,7 @@ export declare class Authenticator implements AuthenticatorInterface {
46
46
  * @throws {Error} - The authenticate method was not implemented by a
47
47
  * subclass.
48
48
  */
49
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
49
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
50
50
  /**
51
51
  * Retrieves the authenticator's type.
52
52
  * The returned value will be the same string that is used
package/es/auth/authenticators/basic-authenticator.d.ts CHANGED
@@ -55,7 +55,7 @@ export declare class BasicAuthenticator extends Authenticator {
55
55
  * @param {object.<string, string>} requestOptions.headers - The headers the
56
56
  * authentication information will be added too.
57
57
  */
58
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
58
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
59
59
  /**
60
60
  * Returns the authenticator's type ('basic').
61
61
  *
package/es/auth/authenticators/token-request-based-authenticator.d.ts CHANGED
@@ -87,5 +87,5 @@ export declare class TokenRequestBasedAuthenticator extends Authenticator {
87
87
  * authentication information will be added too. Overrides default headers
88
88
  * where there's conflict.
89
89
  */
90
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
90
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
91
91
  }
package/etc/ibm-cloud-sdk-core.api.md CHANGED
@@ -21,7 +21,7 @@ export function atMostOne(a: any, b: any): boolean;
21
21
  export class Authenticator implements AuthenticatorInterface {
22
22
  constructor();
23
23
  // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
24
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
24
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
25
25
  authenticationType(): string;
26
26
  static AUTHTYPE_BASIC: string;
27
27
  // (undocumented)
@@ -42,7 +42,7 @@ export class Authenticator implements AuthenticatorInterface {
42
42
 
43
43
  // @public
44
44
  export interface AuthenticatorInterface {
45
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
45
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
46
46
  authenticationType(): string;
47
47
  }
48
48
 
@@ -72,7 +72,7 @@ export class BaseService {
72
72
  export class BasicAuthenticator extends Authenticator {
73
73
  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
74
74
  constructor(options: Options);
75
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
75
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
76
76
  authenticationType(): string;
77
77
  // (undocumented)
78
78
  protected authHeader: {
@@ -390,7 +390,7 @@ export type TokenManagerOptions = {
390
390
  export class TokenRequestBasedAuthenticator extends Authenticator {
391
391
  // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
392
392
  constructor(options: BaseOptions);
393
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
393
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
394
394
  // (undocumented)
395
395
  protected disableSslVerification: boolean;
396
396
  // (undocumented)
package/ibm-cloud-sdk-core.d.ts CHANGED
@@ -71,7 +71,7 @@ export declare class Authenticator implements AuthenticatorInterface {
71
71
  * @throws {Error} - The authenticate method was not implemented by a
72
72
  * subclass.
73
73
  */
74
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
74
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
75
75
  /**
76
76
  * Retrieves the authenticator's type.
77
77
  * The returned value will be the same string that is used
@@ -98,7 +98,7 @@ export declare interface AuthenticatorInterface {
98
98
  * @param {object.<string, string>} requestOptions.headers The headers the
99
99
  * authentication information will be added to.
100
100
  */
101
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
101
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
102
102
  /**
103
103
  * Returns a string that indicates the authentication type.
104
104
  */
@@ -255,7 +255,7 @@ export declare class BaseService {
255
255
  * @param {object.<string, string>} requestOptions.headers - The headers the
256
256
  * authentication information will be added too.
257
257
  */
258
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
258
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
259
259
  /**
260
260
  * Returns the authenticator's type ('basic').
261
261
  *
@@ -1411,7 +1411,7 @@ export declare class BaseService {
1411
1411
  * authentication information will be added too. Overrides default headers
1412
1412
  * where there's conflict.
1413
1413
  */
1414
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
1414
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
1415
1415
  }
1416
1416
 
1417
1417
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ibm-cloud-sdk-core",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
5
5
  "main": "index.js",
6
6
  "typings": "./es/index.d.ts",
package/temp/ibm-cloud-sdk-core.api.json CHANGED
@@ -350,16 +350,7 @@
350
350
  },
351
351
  {
352
352
  "kind": "Content",
353
- "text": "<void | "
354
- },
355
- {
356
- "kind": "Reference",
357
- "text": "Error",
358
- "canonicalReference": "!Error:interface"
359
- },
360
- {
361
- "kind": "Content",
362
- "text": ">"
353
+ "text": "<void>"
363
354
  },
364
355
  {
365
356
  "kind": "Content",
@@ -370,7 +361,7 @@
370
361
  "isStatic": false,
371
362
  "returnTypeTokenRange": {
372
363
  "startIndex": 3,
373
- "endIndex": 7
364
+ "endIndex": 5
374
365
  },
375
366
  "releaseTag": "Public",
376
367
  "overloadIndex": 1,
@@ -677,16 +668,7 @@
677
668
  },
678
669
  {
679
670
  "kind": "Content",
680
- "text": "<void | "
681
- },
682
- {
683
- "kind": "Reference",
684
- "text": "Error",
685
- "canonicalReference": "!Error:interface"
686
- },
687
- {
688
- "kind": "Content",
689
- "text": ">"
671
+ "text": "<void>"
690
672
  },
691
673
  {
692
674
  "kind": "Content",
@@ -696,7 +678,7 @@
696
678
  "isOptional": false,
697
679
  "returnTypeTokenRange": {
698
680
  "startIndex": 3,
699
- "endIndex": 7
681
+ "endIndex": 5
700
682
  },
701
683
  "releaseTag": "Public",
702
684
  "overloadIndex": 1,
@@ -1280,16 +1262,7 @@
1280
1262
  },
1281
1263
  {
1282
1264
  "kind": "Content",
1283
- "text": "<void | "
1284
- },
1285
- {
1286
- "kind": "Reference",
1287
- "text": "Error",
1288
- "canonicalReference": "!Error:interface"
1289
- },
1290
- {
1291
- "kind": "Content",
1292
- "text": ">"
1265
+ "text": "<void>"
1293
1266
  },
1294
1267
  {
1295
1268
  "kind": "Content",
@@ -1300,7 +1273,7 @@
1300
1273
  "isStatic": false,
1301
1274
  "returnTypeTokenRange": {
1302
1275
  "startIndex": 3,
1303
- "endIndex": 7
1276
+ "endIndex": 5
1304
1277
  },
1305
1278
  "releaseTag": "Public",
1306
1279
  "overloadIndex": 1,
@@ -5910,16 +5883,7 @@
5910
5883
  },
5911
5884
  {
5912
5885
  "kind": "Content",
5913
- "text": "<void | "
5914
- },
5915
- {
5916
- "kind": "Reference",
5917
- "text": "Error",
5918
- "canonicalReference": "!Error:interface"
5919
- },
5920
- {
5921
- "kind": "Content",
5922
- "text": ">"
5886
+ "text": "<void>"
5923
5887
  },
5924
5888
  {
5925
5889
  "kind": "Content",
@@ -5930,7 +5894,7 @@
5930
5894
  "isStatic": false,
5931
5895
  "returnTypeTokenRange": {
5932
5896
  "startIndex": 3,
5933
- "endIndex": 7
5897
+ "endIndex": 5
5934
5898
  },
5935
5899
  "releaseTag": "Public",
5936
5900
  "overloadIndex": 1,
package/temp/ibm-cloud-sdk-core.api.md CHANGED
@@ -21,7 +21,7 @@ export function atMostOne(a: any, b: any): boolean;
21
21
  export class Authenticator implements AuthenticatorInterface {
22
22
  constructor();
23
23
  // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
24
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
24
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
25
25
  authenticationType(): string;
26
26
  static AUTHTYPE_BASIC: string;
27
27
  // (undocumented)
@@ -42,7 +42,7 @@ export class Authenticator implements AuthenticatorInterface {
42
42
 
43
43
  // @public
44
44
  export interface AuthenticatorInterface {
45
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
45
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
46
46
  authenticationType(): string;
47
47
  }
48
48
 
@@ -72,7 +72,7 @@ export class BaseService {
72
72
  export class BasicAuthenticator extends Authenticator {
73
73
  // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
74
74
  constructor(options: Options);
75
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
75
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
76
76
  authenticationType(): string;
77
77
  // (undocumented)
78
78
  protected authHeader: {
@@ -390,7 +390,7 @@ export type TokenManagerOptions = {
390
390
  export class TokenRequestBasedAuthenticator extends Authenticator {
391
391
  // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
392
392
  constructor(options: BaseOptions);
393
- authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
393
+ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
394
394
  // (undocumented)
395
395
  protected disableSslVerification: boolean;
396
396
  // (undocumented)