api view

Author: KarishmaGhiya

sdk/postgresql/postgresql-auth/review/postgresql-auth-node.api.md

@@ -7,10 +7,10 @@
 import type { TokenCredential } from '@azure/core-auth';
 
 // @public
-export function configureEntraAuthentication(sequelizeInstance: SequelizeBeforeConnectHook, credential: TokenCredential, options?: ConfigureEntraIdAuthOptions): typeof sequelizeInstance;
+export function configureEntraAuthentication(sequelizeInstance: SequelizeBeforeConnectHook, credential: TokenCredential, options?: ConfigureEntraAuthenticationOptions): typeof sequelizeInstance;
 
 // @public
-export interface ConfigureEntraIdAuthOptions {
+export interface ConfigureEntraAuthenticationOptions {
     fallbackUsername?: string;
 }
 
@@ -19,7 +19,7 @@ export function entraTokenProvider(credential: TokenCredential, options?: GetEnt
 
 // @public
 export interface GetEntraTokenPasswordOptions {
-    scope?: string;
+    scope?: string | string[];
 }
 
 // @public

sdk/postgresql/postgresql-auth/src/entraConnection.ts

@@ -7,18 +7,18 @@ import { logger } from "./logger.js";
 /**
  * Options for {@link entraTokenProvider}.
  */
-export interface GetEntraTokenPasswordOptions {
+export interface GetEntraAccessTokenOptions {
   /**
    * The OAuth scope to request. Defaults to the Azure Database for
    * PostgreSQL scope (`https://ossrdbms-aad.database.windows.net/.default`).
    */
-  scope?: string;
+  scope?: string | string[];
 }
 
 /**
  * Options for configuring Entra ID authentication with Sequelize.
  */
-export interface ConfigureEntraIdAuthOptions {
+export interface ConfigureEntraAuthenticationOptions {
   /**
    * Fallback username to use when the access token does not contain a usable `upn` or `appid` claim.
    *
@@ -123,7 +123,7 @@ function decodeJwtToken(token: string): DecodedJwtPayload | null {
 export function configureEntraAuthentication(
   sequelizeInstance: SequelizeBeforeConnectHook,
   credential: TokenCredential,
-  options: ConfigureEntraIdAuthOptions = {},
+  options: ConfigureEntraAuthenticationOptions = {},
 ): typeof sequelizeInstance {
   if (!credential) {
     throw new Error("credential is required");
@@ -181,7 +181,7 @@ export function configureEntraAuthentication(
  */
 export async function entraTokenProvider(
   credential: TokenCredential,
-  options: GetEntraTokenPasswordOptions = {},
+  options: GetEntraAccessTokenOptions = {},
 ): Promise<string> {
   if (!credential) {
     throw new Error("credential is required");

sdk/postgresql/postgresql-auth/src/index.ts

@@ -12,7 +12,7 @@
  */
 export { configureEntraAuthentication, entraTokenProvider } from "./entraConnection.js";
 export type {
-  ConfigureEntraIdAuthOptions,
-  GetEntraTokenPasswordOptions,
+  ConfigureEntraAuthenticationOptions,
+  GetEntraAccessTokenOptions as GetEntraTokenPasswordOptions,
   SequelizeBeforeConnectHook,
 } from "./entraConnection.js";