@deephaven-enterprise/auth-nodejs 2026.1.41 → 2026.1.43

package/README.md

@@ -1,3 +1,58 @@
 # @deephaven-enterprise/auth-nodejs
 
-Deephaven Enterprise Auth Utils for NodeJS
+Deephaven Enterprise authentication utilities for Node.js.
+
+Helpers for authenticating against a Deephaven Enterprise server from a Node.js
+process, including key pair signing and login utilities.
+
+This is a low-level building block. For most applications, use
+[`@deephaven-enterprise/jsapi-nodejs`](../jsapi-nodejs), which wires
+authentication together with the JS API and worker connections for you.
+
+## Usage
+
+`login` takes a connected (but not yet authenticated) Enterprise client — see
+[`@deephaven-enterprise/client-utils`](../client-utils) for creating one — and
+returns it authenticated:
+
+```typescript
+import {
+  createPasswordCredentials,
+  login,
+} from '@deephaven-enterprise/auth-nodejs';
+
+// `unauthenticatedClient` comes from `createEnterpriseClient` (client-utils).
+const credentials = createPasswordCredentials('my-username', 'my-password');
+const authenticatedClient = await login(unauthenticatedClient, credentials);
+```
+
+Key-pair authentication is also supported. Generate a key pair, upload the
+public key for a user, then log in with the private key:
+
+```typescript
+import {
+  generateBase64KeyPair,
+  login,
+  uploadPublicKey,
+  type Username,
+} from '@deephaven-enterprise/auth-nodejs';
+
+const userName = 'my-username' as Username;
+const keyPair = generateBase64KeyPair();
+
+// Upload the public key using an already-authenticated client.
+await uploadPublicKey({
+  dheClient: authenticatedClient,
+  userName,
+  publicKey: keyPair.publicKey,
+  comment: 'my-service key',
+  type: keyPair.type,
+});
+
+// Later, authenticate a fresh client with the key pair.
+const client = await login(unauthenticatedClient, {
+  type: 'keyPair',
+  username: userName,
+  keyPair,
+});
+```

package/dist/index.d.ts

@@ -1,4 +1,19 @@
-export * from './clientUtils.js';
-export * from './keyPairUtils.js';
-export * from './types.js';
-export * from './loginUtils.js';
+import { type AuthenticatedEnterpriseClient, type UnauthenticatedEnterpriseClient, createEnterpriseClient } from '@deephaven-enterprise/client-utils';
+/**
+ * @deprecated Use `AuthenticatedEnterpriseClient` from
+ * `@deephaven-enterprise/client-utils` instead.
+ */
+export type AuthenticatedClient = AuthenticatedEnterpriseClient;
+/**
+ * @deprecated Use `UnauthenticatedEnterpriseClient` from
+ * `@deephaven-enterprise/client-utils` instead.
+ */
+export type UnauthenticatedClient = UnauthenticatedEnterpriseClient;
+/**
+ * @deprecated Use `createEnterpriseClient` from `@deephaven-enterprise/client-utils`
+ * instead.
+ */
+export declare const createClient: typeof createEnterpriseClient;
+export * from './keyPairUtils.ts';
+export * from './types.ts';
+export * from './loginUtils.ts';

package/dist/index.js

@@ -1,4 +1,9 @@
-export * from './clientUtils.js';
-export * from './keyPairUtils.js';
-export * from './types.js';
-export * from './loginUtils.js';
+import { createEnterpriseClient, } from '@deephaven-enterprise/client-utils';
+/**
+ * @deprecated Use `createEnterpriseClient` from `@deephaven-enterprise/client-utils`
+ * instead.
+ */
+export const createClient = createEnterpriseClient;
+export * from "./keyPairUtils.js";
+export * from "./types.js";
+export * from "./loginUtils.js";

package/dist/keyPairUtils.d.ts

@@ -1,4 +1,5 @@
-import type { AuthenticatedClient, Base64KeyPair, Base64Nonce, Base64PrivateKey, Base64PublicKey, Base64Signature, KeyPairType, Username } from './types.js';
+import type { AuthenticatedEnterpriseClient } from '@deephaven-enterprise/client-utils';
+import type { Base64KeyPair, Base64Nonce, Base64PrivateKey, Base64PublicKey, Base64Signature, KeyPairType, Username } from './types.ts';
 /**
  * Generate a base64 encoded asymmetric key pair using eliptic curve.
  * @returns The base64 encoded public and private keys.
@@ -30,7 +31,7 @@ export declare function signWithPrivateKey(nonce: Base64Nonce, privateKey: Base6
  * @returns A promise that resolves when the keys have been deleted.
  */
 export declare function deletePublicKeys({ dheClient, userName, publicKeys, type, }: {
-    dheClient: AuthenticatedClient;
+    dheClient: AuthenticatedEnterpriseClient;
     userName: Username;
     publicKeys: Base64PublicKey[];
     type: KeyPairType;
@@ -45,7 +46,7 @@ export declare function deletePublicKeys({ dheClient, userName, publicKeys, type
  * @returns The response from the server.
  */
 export declare function uploadPublicKey({ dheClient, userName, publicKey, comment, type, }: {
-    dheClient: AuthenticatedClient;
+    dheClient: AuthenticatedEnterpriseClient;
     userName: Username;
     comment: string;
     publicKey: Base64PublicKey;

package/dist/loginUtils.d.ts

@@ -1,4 +1,20 @@
-import type { AuthenticatedClient, PasswordCredentials, KeyPairCredentials, UnauthenticatedClient } from './types.js';
+import type { AuthenticatedEnterpriseClient, UnauthenticatedEnterpriseClient } from '@deephaven-enterprise/client-utils';
+import type { PasswordCredentials, KeyPairCredentials } from './types.ts';
+/**
+ * Create a PasswordCredentials object from a username and password.
+ * @param username The username for the credentials.
+ * @param password The password for the credentials.
+ * @returns A PasswordCredentials object.
+ */
+export declare function createPasswordCredentials(username: string, password: string): PasswordCredentials;
+/**
+ * Authenticate a given client with the provided credentials. Return the
+ * authenticated client.
+ * @param dheClient The DHE client to authenticate.
+ * @param credentials The credentials to use for authentication.
+ * @returns The authenticated client.
+ */
+export declare function login(dheClient: UnauthenticatedEnterpriseClient, credentials: PasswordCredentials | KeyPairCredentials): Promise<AuthenticatedEnterpriseClient>;
 /**
  * Authenticate a given client with username and password. Return the
  * authenticated client.
@@ -6,11 +22,11 @@ import type { AuthenticatedClient, PasswordCredentials, KeyPairCredentials, Unau
  * @param credentials The user / password credentials to use for authentication.
  * @returns The authenticated client.
  */
-export declare function loginClientWithPassword(dheClient: UnauthenticatedClient, credentials: PasswordCredentials): Promise<AuthenticatedClient>;
+export declare function loginClientWithPassword(dheClient: UnauthenticatedEnterpriseClient, credentials: PasswordCredentials): Promise<AuthenticatedEnterpriseClient>;
 /**
  * Authenticate a given client with a key pair. Return the authenticated client.
  * @param dheClient The DHE client to authenticate.
  * @param credentials The key pair credentials to use for authentication.
  * @returns The authenticated client.
  */
-export declare function loginClientWithKeyPair(dheClient: UnauthenticatedClient, credentials: KeyPairCredentials): Promise<AuthenticatedClient>;
+export declare function loginClientWithKeyPair(dheClient: UnauthenticatedEnterpriseClient, credentials: KeyPairCredentials): Promise<AuthenticatedEnterpriseClient>;

package/dist/loginUtils.js

@@ -1,4 +1,33 @@
-import { keyWithSentinel, signWithPrivateKey } from './keyPairUtils.js';
+import { keyWithSentinel, signWithPrivateKey } from "./keyPairUtils.js";
+/**
+ * Create a PasswordCredentials object from a username and password.
+ * @param username The username for the credentials.
+ * @param password The password for the credentials.
+ * @returns A PasswordCredentials object.
+ */
+export function createPasswordCredentials(username, password) {
+    return {
+        type: 'password',
+        username: username,
+        token: password,
+    };
+}
+/**
+ * Authenticate a given client with the provided credentials. Return the
+ * authenticated client.
+ * @param dheClient The DHE client to authenticate.
+ * @param credentials The credentials to use for authentication.
+ * @returns The authenticated client.
+ */
+export async function login(dheClient, credentials) {
+    if (credentials.type === 'keyPair') {
+        return loginClientWithKeyPair(dheClient, credentials);
+    }
+    if (credentials.type === 'password') {
+        return loginClientWithPassword(dheClient, credentials);
+    }
+    throw new Error('Unsupported credentials type');
+}
 /**
  * Authenticate a given client with username and password. Return the
  * authenticated client.

package/dist/types.d.ts

@@ -1,7 +1,4 @@
-import type { Brand } from '@deephaven/utils/dist/TypeUtils.js';
-import type { EnterpriseClient } from '@deephaven-enterprise/jsapi-types';
-export type AuthenticatedClient = Brand<'AuthenticatedClient', EnterpriseClient>;
-export type UnauthenticatedClient = Brand<'UnauthenticatedClient', EnterpriseClient>;
+import type { Brand } from '@deephaven/utils/dist/TypeUtils.d.ts';
 export type Base64Nonce = Brand<'Base64Nonce', string>;
 export type Base64Signature = Brand<'Base64Signature', string>;
 export type Base64PrivateKey = Brand<'Base64PrivateKey', string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/auth-nodejs",
-  "version": "2026.1.41",
+  "version": "2026.1.43",
   "description": "Deephaven Enterprise Auth Utils for NodeJS",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -22,7 +22,8 @@
     "build": "tsc --build"
   },
   "dependencies": {
-    "@deephaven-enterprise/jsapi-types": "file:../jsapi-types",
+    "@deephaven-enterprise/client-utils": "2026.1.43",
+    "@deephaven-enterprise/jsapi-types": "2026.1.43",
     "@deephaven/utils": "^0.97.0"
   },
   "publishConfig": {

package/dist/clientUtils.d.ts

@@ -1,11 +0,0 @@
-import type { ConnectOptions, EnterpriseDhType as DheType } from '@deephaven-enterprise/jsapi-types';
-import type { UnauthenticatedClient } from './types.js';
-/**
- * Create a connected, unauthenticated DHE client.
- * @param dhe DHE JsApi.
- * @param serverUrl The DHE server URL.
- * @param connectOptions Optional connection options.
- * @returns A connected, unauthenticated DHE client.
- */
-export declare function createClient(dhe: DheType, serverUrl: URL, connectOptions?: ConnectOptions): Promise<UnauthenticatedClient>;
-export default createClient;

package/dist/clientUtils.js

@@ -1,17 +0,0 @@
-/**
- * Create a connected, unauthenticated DHE client.
- * @param dhe DHE JsApi.
- * @param serverUrl The DHE server URL.
- * @param connectOptions Optional connection options.
- * @returns A connected, unauthenticated DHE client.
- */
-export async function createClient(dhe, serverUrl, connectOptions) {
-    const dheClient = new dhe.Client(serverUrl.toString(), connectOptions);
-    return new Promise(resolve => {
-        const unsubscribe = dheClient.addEventListener(dhe.Client.EVENT_CONNECT, () => {
-            unsubscribe();
-            resolve(dheClient);
-        });
-    });
-}
-export default createClient;