Skip to content

Commit 27093ba

Browse files
authored
Release Re-Auth and AuthTokenManager (neo4j#1150)
Removes the @experimental tags form the APIs. The API is consider stable.
1 parent 7b9cd09 commit 27093ba

File tree

5 files changed

+7
-21
lines changed

5 files changed

+7
-21
lines changed

packages/core/src/auth-token-manager.ts

+3-9
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ export type SecurityErrorCode = `Neo.ClientError.Security.${string}`
2626
/**
2727
* Interface for the piece of software responsible for keeping track of current active {@link AuthToken} across the driver.
2828
* @interface
29-
* @experimental Exposed as preview feature.
30-
* @since 5.8
29+
* @since 5.14
3130
*/
3231
export default class AuthTokenManager {
3332
/**
@@ -57,8 +56,7 @@ export default class AuthTokenManager {
5756
/**
5857
* Interface which defines an {@link AuthToken} with an expiration data time associated
5958
* @interface
60-
* @experimental Exposed as preview feature.
61-
* @since 5.8
59+
* @since 5.14
6260
*/
6361
export class AuthTokenAndExpiration {
6462
public readonly token: AuthToken
@@ -102,7 +100,6 @@ class AuthTokenManagers {
102100
* @param {function(): Promise<AuthTokenAndExpiration>} param0.tokenProvider - Retrieves a new valid auth token.
103101
* Must only ever return auth information belonging to the same identity.
104102
* @returns {AuthTokenManager} The temporal auth data manager.
105-
* @experimental Exposed as preview feature.
106103
*/
107104
bearer ({ tokenProvider }: { tokenProvider: () => Promise<AuthTokenAndExpiration> }): AuthTokenManager {
108105
if (typeof tokenProvider !== 'function') {
@@ -124,7 +121,6 @@ class AuthTokenManagers {
124121
* @param {function(): Promise<AuthToken>} param0.tokenProvider - Retrieves a new valid auth token.
125122
* Must only ever return auth information belonging to the same identity.
126123
* @returns {AuthTokenManager} The basic auth data manager.
127-
* @experimental Exposed as preview feature.
128124
*/
129125
basic ({ tokenProvider }: { tokenProvider: () => Promise<AuthToken> }): AuthTokenManager {
130126
if (typeof tokenProvider !== 'function') {
@@ -138,9 +134,7 @@ class AuthTokenManagers {
138134
}
139135

140136
/**
141-
* Holds the common {@link AuthTokenManagers} used in the Driver
142-
*
143-
* @experimental Exposed as preview feature.
137+
* Holds the common {@link AuthTokenManagers} used in the Driver.
144138
*/
145139
const authTokenManagers: AuthTokenManagers = new AuthTokenManagers()
146140

packages/core/src/driver.ts

-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,6 @@ class SessionConfig {
207207
* which supports Bolt 5.1 and onwards.
208208
*
209209
* @type {AuthToken|undefined}
210-
* @experimental Exposed as preview feature.
211210
* @see {@link driver}
212211
*/
213212
this.auth = undefined

packages/neo4j-driver-deno/lib/core/auth-token-manager.ts

+3-9
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ export type SecurityErrorCode = `Neo.ClientError.Security.${string}`
2626
/**
2727
* Interface for the piece of software responsible for keeping track of current active {@link AuthToken} across the driver.
2828
* @interface
29-
* @experimental Exposed as preview feature.
30-
* @since 5.8
29+
* @since 5.14
3130
*/
3231
export default class AuthTokenManager {
3332
/**
@@ -57,8 +56,7 @@ export default class AuthTokenManager {
5756
/**
5857
* Interface which defines an {@link AuthToken} with an expiration data time associated
5958
* @interface
60-
* @experimental Exposed as preview feature.
61-
* @since 5.8
59+
* @since 5.14
6260
*/
6361
export class AuthTokenAndExpiration {
6462
public readonly token: AuthToken
@@ -102,7 +100,6 @@ class AuthTokenManagers {
102100
* @param {function(): Promise<AuthTokenAndExpiration>} param0.tokenProvider - Retrieves a new valid auth token.
103101
* Must only ever return auth information belonging to the same identity.
104102
* @returns {AuthTokenManager} The temporal auth data manager.
105-
* @experimental Exposed as preview feature.
106103
*/
107104
bearer ({ tokenProvider }: { tokenProvider: () => Promise<AuthTokenAndExpiration> }): AuthTokenManager {
108105
if (typeof tokenProvider !== 'function') {
@@ -124,7 +121,6 @@ class AuthTokenManagers {
124121
* @param {function(): Promise<AuthToken>} param0.tokenProvider - Retrieves a new valid auth token.
125122
* Must only ever return auth information belonging to the same identity.
126123
* @returns {AuthTokenManager} The basic auth data manager.
127-
* @experimental Exposed as preview feature.
128124
*/
129125
basic ({ tokenProvider }: { tokenProvider: () => Promise<AuthToken> }): AuthTokenManager {
130126
if (typeof tokenProvider !== 'function') {
@@ -138,9 +134,7 @@ class AuthTokenManagers {
138134
}
139135

140136
/**
141-
* Holds the common {@link AuthTokenManagers} used in the Driver
142-
*
143-
* @experimental Exposed as preview feature.
137+
* Holds the common {@link AuthTokenManagers} used in the Driver.
144138
*/
145139
const authTokenManagers: AuthTokenManagers = new AuthTokenManagers()
146140

packages/neo4j-driver-deno/lib/core/driver.ts

-1
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,6 @@ class SessionConfig {
207207
* which supports Bolt 5.1 and onwards.
208208
*
209209
* @type {AuthToken|undefined}
210-
* @experimental Exposed as preview feature.
211210
* @see {@link driver}
212211
*/
213212
this.auth = undefined

packages/neo4j-driver/src/result-rx.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export default class RxResult {
110110
/**
111111
* Pauses the automatic streaming of records.
112112
*
113-
* This method provides a way of controll the flow of records
113+
* This method provides a way of control the flow of records
114114
*
115115
* @experimental
116116
*/

0 commit comments

Comments
 (0)