[@xmpp/client, @xmpp/sasl, @xmpp/sasl2] Update CredentialsFactory signatures (DefinitelyTyped#74322)

Author: vpzomtrrfrt

types/xmpp__client/index.d.ts

@@ -7,7 +7,8 @@ import { IQCaller } from "@xmpp/iq/caller";
 import { IncomingContext, Middleware } from "@xmpp/middleware";
 import { Reconnect } from "@xmpp/reconnect";
 import { Resource } from "@xmpp/resource-binding";
-import { Credentials, SASL } from "@xmpp/sasl";
+import { SASL } from "@xmpp/sasl";
+import { CredentialsFactory, CredentialsObj } from "@xmpp/sasl2";
 import { StreamFeatures } from "@xmpp/stream-features";
 import { StreamManagement } from "@xmpp/stream-management";
 import koaCompose = require("koa-compose");
@@ -68,7 +69,7 @@ export interface Options extends ConnectionOptions {
      * Resource for `@xmpp/resource-binding`.
      */
     resource?: Resource | undefined;
-    credentials?: Credentials | undefined;
+    credentials?: CredentialsObj | CredentialsFactory<Client> | undefined;
     /**
      * Username for `@xmpp/sasl`.
      */

types/xmpp__client/package.json

@@ -15,6 +15,7 @@
         "@types/xmpp__reconnect": "*",
         "@types/xmpp__resource-binding": "*",
         "@types/xmpp__sasl": "*",
+        "@types/xmpp__sasl2": "*",
         "@types/xmpp__stream-features": "*",
         "@types/xmpp__stream-management": "*"
     },

types/xmpp__sasl/index.d.ts

@@ -13,19 +13,21 @@ declare function sasl<TEntity extends Entity>(
         streamFeatures: StreamFeatures<TEntity>;
         saslFactory: SASLFactory;
     },
-    credentials: Credentials,
+    credentials: Credentials<TEntity>,
 ): SASL;
 
-export type Credentials = Partial<CredentialsObj> | CredentialsFactory;
+export type Credentials<TEntity extends Entity> = Partial<CredentialsObj> | CredentialsFactory<TEntity>;
 
 export interface CredentialsObj {
     username: string;
     password: string;
 }
 
-export type CredentialsFactory = (
+export type CredentialsFactory<TEntity extends Entity> = (
     callback: (credentials: CredentialsObj) => Promise<void>,
-    mechanism: string,
+    mechanisms: string[],
+    fast: null,
+    entity: TEntity,
 ) => Promise<void>;
 
 export interface SASL {

types/xmpp__sasl/xmpp__sasl-tests.ts

@@ -34,7 +34,7 @@ sasl({ streamFeatures: sf, saslFactory }, { password: "foo" }); // $ExpectType S
 // $ExpectType SASL
 sasl({ streamFeatures: sf, saslFactory }, async (cb, mech) => {
     cb; // $ExpectType (credentials: CredentialsObj) => Promise<void>
-    mech; // $ExpectType string
+    mech; // $ExpectType string[]
 
     await cb({ username: "foo", password: "bar" });
 });

types/xmpp__sasl2/index.d.ts

@@ -1,4 +1,4 @@
-import { FAST } from "@xmpp/client-core/src/fast/fast.js";
+import { FAST, Token } from "@xmpp/client-core/src/fast/fast.js";
 import { Entity } from "@xmpp/middleware";
 import { StreamFeatures } from "@xmpp/stream-features";
 import { Element } from "@xmpp/xml";
@@ -7,22 +7,23 @@ import SASLFactory = require("saslmechanisms");
 // eslint-disable-next-line @definitelytyped/no-unnecessary-generics
 export default function sasl2<TEntity extends Entity>(
     params: { streamFeatures: StreamFeatures<TEntity>; saslFactory: SASLFactory },
-    onAuthenticate: CredentialsFactory,
+    onAuthenticate: CredentialsFactory<TEntity>,
 ): SASL2;
 
 export interface SASL2 {
     use(ns: string, req: (element: Element) => Promise<void>, res: (element: Element) => Promise<void>): void;
     setup(params: { fast: FAST }): void;
 }
 
-export type CredentialsFactory = (
-    callback: (credentials: CredentialsObj, mechanism: string, userAgent: string) => Promise<void>,
+export type CredentialsFactory<TEntity extends Entity> = (
+    callback: (credentials: CredentialsObj, mechanism: string, userAgent: Element) => Promise<void>,
     mechanisms: string[],
     fast: FAST | null,
-    entity: Entity,
+    entity: TEntity,
 ) => Promise<void>;
 
 export interface CredentialsObj {
-    username: string;
-    password: string;
+    username?: string;
+    password?: string;
+    token?: Token;
 }

types/xmpp__sasl2/xmpp__sasl2-tests.ts

@@ -2,7 +2,7 @@ import Connection from "@xmpp/connection";
 import middleware, { Entity } from "@xmpp/middleware";
 import sasl2, { CredentialsFactory, SASL2 } from "@xmpp/sasl2";
 import streamFeatures from "@xmpp/stream-features";
-import { Element } from "@xmpp/xml";
+import xml, { Element } from "@xmpp/xml";
 import SASLFactory = require("saslmechanisms");
 
 class Foo extends Connection implements Entity {
@@ -23,7 +23,13 @@ const sf = streamFeatures({ middleware: mw });
 
 const saslFactory = new SASLFactory();
 
-const onAuthenticate = null as unknown as CredentialsFactory;
+const onAuthenticate: CredentialsFactory<Foo> = (callback, mechanisms, fast, entity) => {
+    return callback(
+        {},
+        mechanisms[0],
+        xml("user-agent"),
+    );
+};
 
 const saslMw = sasl2({ streamFeatures: sf, saslFactory }, onAuthenticate); // $ExpectType SASL2