Release Re-Auth and AuthTokenManager (#1150)

bigmontz · web-flow · commit 27093ba30fb7 · 2023-10-24T14:22:41.000+02:00
Removes the @experimental tags form the APIs. The API is consider stable.
diff --git a/packages/core/src/auth-token-manager.ts b/packages/core/src/auth-token-manager.ts
@@ -26,8 +26,7 @@ export type SecurityErrorCode = `Neo.ClientError.Security.${string}`
 /**
  * Interface for the piece of software responsible for keeping track of current active {@link AuthToken} across the driver.
  * @interface
- * @experimental Exposed as preview feature.
- * @since 5.8
+ * @since 5.14
  */
 export default class AuthTokenManager {
   /**
@@ -57,8 +56,7 @@ export default class AuthTokenManager {
 /**
  * Interface which defines an {@link AuthToken} with an expiration data time associated
  * @interface
- * @experimental Exposed as preview feature.
- * @since 5.8
+ * @since 5.14
  */
 export class AuthTokenAndExpiration {
   public readonly token: AuthToken
@@ -102,7 +100,6 @@ class AuthTokenManagers {
    * @param {function(): Promise<AuthTokenAndExpiration>} param0.tokenProvider - Retrieves a new valid auth token.
    * Must only ever return auth information belonging to the same identity.
    * @returns {AuthTokenManager} The temporal auth data manager.
-   * @experimental Exposed as preview feature.
    */
   bearer ({ tokenProvider }: { tokenProvider: () => Promise<AuthTokenAndExpiration> }): AuthTokenManager {
     if (typeof tokenProvider !== 'function') {
@@ -124,7 +121,6 @@ class AuthTokenManagers {
    * @param {function(): Promise<AuthToken>} param0.tokenProvider - Retrieves a new valid auth token.
    * Must only ever return auth information belonging to the same identity.
    * @returns {AuthTokenManager} The basic auth data manager.
-   * @experimental Exposed as preview feature.
    */
   basic ({ tokenProvider }: { tokenProvider: () => Promise<AuthToken> }): AuthTokenManager {
     if (typeof tokenProvider !== 'function') {
@@ -138,9 +134,7 @@ class AuthTokenManagers {
 }
 
 /**
- * Holds the common {@link AuthTokenManagers} used in the Driver
- *
- * @experimental Exposed as preview feature.
+ * Holds the common {@link AuthTokenManagers} used in the Driver.
  */
 const authTokenManagers: AuthTokenManagers = new AuthTokenManagers()
 
diff --git a/packages/core/src/driver.ts b/packages/core/src/driver.ts
@@ -207,7 +207,6 @@ class SessionConfig {
      * which supports Bolt 5.1 and onwards.
      *
      * @type {AuthToken|undefined}
-     * @experimental Exposed as preview feature.
      * @see {@link driver}
      */
     this.auth = undefined
diff --git a/packages/neo4j-driver-deno/lib/core/auth-token-manager.ts b/packages/neo4j-driver-deno/lib/core/auth-token-manager.ts
@@ -26,8 +26,7 @@ export type SecurityErrorCode = `Neo.ClientError.Security.${string}`
 /**
  * Interface for the piece of software responsible for keeping track of current active {@link AuthToken} across the driver.
  * @interface
- * @experimental Exposed as preview feature.
- * @since 5.8
+ * @since 5.14
  */
 export default class AuthTokenManager {
   /**
@@ -57,8 +56,7 @@ export default class AuthTokenManager {
 /**
  * Interface which defines an {@link AuthToken} with an expiration data time associated
  * @interface
- * @experimental Exposed as preview feature.
- * @since 5.8
+ * @since 5.14
  */
 export class AuthTokenAndExpiration {
   public readonly token: AuthToken
@@ -102,7 +100,6 @@ class AuthTokenManagers {
    * @param {function(): Promise<AuthTokenAndExpiration>} param0.tokenProvider - Retrieves a new valid auth token.
    * Must only ever return auth information belonging to the same identity.
    * @returns {AuthTokenManager} The temporal auth data manager.
-   * @experimental Exposed as preview feature.
    */
   bearer ({ tokenProvider }: { tokenProvider: () => Promise<AuthTokenAndExpiration> }): AuthTokenManager {
     if (typeof tokenProvider !== 'function') {
@@ -124,7 +121,6 @@ class AuthTokenManagers {
    * @param {function(): Promise<AuthToken>} param0.tokenProvider - Retrieves a new valid auth token.
    * Must only ever return auth information belonging to the same identity.
    * @returns {AuthTokenManager} The basic auth data manager.
-   * @experimental Exposed as preview feature.
    */
   basic ({ tokenProvider }: { tokenProvider: () => Promise<AuthToken> }): AuthTokenManager {
     if (typeof tokenProvider !== 'function') {
@@ -138,9 +134,7 @@ class AuthTokenManagers {
 }
 
 /**
- * Holds the common {@link AuthTokenManagers} used in the Driver
- *
- * @experimental Exposed as preview feature.
+ * Holds the common {@link AuthTokenManagers} used in the Driver.
  */
 const authTokenManagers: AuthTokenManagers = new AuthTokenManagers()
 
diff --git a/packages/neo4j-driver-deno/lib/core/driver.ts b/packages/neo4j-driver-deno/lib/core/driver.ts
@@ -207,7 +207,6 @@ class SessionConfig {
      * which supports Bolt 5.1 and onwards.
      *
      * @type {AuthToken|undefined}
-     * @experimental Exposed as preview feature.
      * @see {@link driver}
      */
     this.auth = undefined
diff --git a/packages/neo4j-driver/src/result-rx.js b/packages/neo4j-driver/src/result-rx.js
@@ -110,7 +110,7 @@ export default class RxResult {
   /**
    * Pauses the automatic streaming of records.
    *
-   * This method provides a way of controll the flow of records
+   * This method provides a way of control the flow of records
    *
    * @experimental
    */

Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,6 @@ class SessionConfig {`
`207`	`207`	`* which supports Bolt 5.1 and onwards.`
`208`	`208`	`*`
`209`	`209`	`* @type {AuthToken\|undefined}`
`210`		`- * @experimental Exposed as preview feature.`
`211`	`210`	`* @see {@link driver}`
`212`	`211`	`*/`
`213`	`212`	`this.auth = undefined`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ export default class RxResult {`
`110`	`110`	`/**`
`111`	`111`	`* Pauses the automatic streaming of records.`
`112`	`112`	`*`
`113`		`- * This method provides a way of controll the flow of records`
	`113`	`+ * This method provides a way of control the flow of records`
`114`	`114`	`*`
`115`	`115`	`* @experimental`
`116`	`116`	`*/`