tedious 18.2.4 → 18.3.0

package/lib/connection.d.ts

@@ -7,6 +7,7 @@
 import * as tls from 'tls';
 import * as net from 'net';
 import { type SecureContextOptions } from 'tls';
+import { type TokenCredential } from '@azure/core-auth';
 import BulkLoad, { type Options as BulkLoadOptions, type Callback as BulkLoadCallback } from './bulk-load';
 import Debug from './debug';
 import { EventEmitter } from 'events';
@@ -169,6 +170,16 @@ interface AzureActiveDirectoryServicePrincipalSecret {
         tenantId: string;
     };
 }
+/** Structure that defines the options that are necessary to authenticate the Tedious.JS instance with an `@azure/identity` token credential. */
+interface TokenCredentialAuthentication {
+    /** Unique designator for the type of authentication to be used. */
+    type: 'token-credential';
+    /** Set of configurations that are required or allowed with this authentication type. */
+    options: {
+        /** Credential object used to authenticate to the resource. */
+        credential: TokenCredential;
+    };
+}
 interface NtlmAuthentication {
     type: 'ntlm';
     options: {
@@ -201,7 +212,7 @@ interface DefaultAuthentication {
         password?: string | undefined;
     };
 }
-export type ConnectionAuthentication = DefaultAuthentication | NtlmAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
+export type ConnectionAuthentication = DefaultAuthentication | NtlmAuthentication | TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
 interface InternalConnectionConfig {
     server: string;
     authentication: ConnectionAuthentication;
@@ -283,7 +294,7 @@ interface State {
         reconnect?(this: Connection): void;
     };
 }
-type Authentication = DefaultAuthentication | NtlmAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
+type Authentication = DefaultAuthentication | NtlmAuthentication | TokenCredentialAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryMsiAppServiceAuthentication | AzureActiveDirectoryMsiVmAuthentication | AzureActiveDirectoryAccessTokenAuthentication | AzureActiveDirectoryServicePrincipalSecret | AzureActiveDirectoryDefaultAuthentication;
 type AuthenticationType = Authentication['type'];
 export interface ConnectionConfiguration {
     /**
@@ -339,6 +350,7 @@ interface AuthenticationOptions {
      *
      * * `default`: [[DefaultAuthentication.options]]
      * * `ntlm` :[[NtlmAuthentication]]
+     * * `token-credential`: [[CredentialChainAuthentication.options]]
      * * `azure-active-directory-password` : [[AzureActiveDirectoryPasswordAuthentication.options]]
      * * `azure-active-directory-access-token` : [[AzureActiveDirectoryAccessTokenAuthentication.options]]
      * * `azure-active-directory-msi-vm` : [[AzureActiveDirectoryMsiVmAuthentication.options]]