@hapi/nes 13.0.1 → 14.0.1

package/lib/client.d.ts

@@ -0,0 +1,375 @@
+import type { ClientRequestArgs } from "http";
+import type { ClientOptions } from "ws";
+
+// Same as exported type in @hapi/hapi v20
+type HTTP_METHODS = 'ACL' | 'BIND' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'DELETE' | 'GET' | 'HEAD' | 'LINK' | 'LOCK' |
+    'M-SEARCH' | 'MERGE' | 'MKACTIVITY' | 'MKCALENDAR' | 'MKCOL' | 'MOVE' | 'NOTIFY' | 'OPTIONS' | 'PATCH' | 'POST' |
+    'PROPFIND' | 'PROPPATCH' | 'PURGE' | 'PUT' | 'REBIND' | 'REPORT' | 'SEARCH' | 'SOURCE' | 'SUBSCRIBE' | 'TRACE' |
+    'UNBIND' | 'UNLINK' | 'UNLOCK' | 'UNSUBSCRIBE';
+
+type ErrorType = (
+    'timeout' |
+    'disconnect' |
+    'server' |
+    'protocol' |
+    'ws' |
+    'user'
+);
+
+type ErrorCodes = {
+    1000: 'Normal closure',
+    1001: 'Going away',
+    1002: 'Protocol error',
+    1003: 'Unsupported data',
+    1004: 'Reserved',
+    1005: 'No status received',
+    1006: 'Abnormal closure',
+    1007: 'Invalid frame payload data',
+    1008: 'Policy violation',
+    1009: 'Message too big',
+    1010: 'Mandatory extension',
+    1011: 'Internal server error',
+    1015: 'TLS handshake'
+};
+
+type NesLog = {
+
+    readonly code: keyof ErrorCodes;
+    readonly explanation: ErrorCodes[keyof ErrorCodes] | 'Unknown';
+    readonly reason: string;
+    readonly wasClean: boolean;
+    readonly willReconnect: boolean;
+    readonly wasRequested: boolean;
+}
+
+export interface NesError extends Error {
+
+    type: ErrorType;
+    isNes: true;
+    statusCode?: number;
+    data?: any;
+    headers?: Record<string, string>;
+    path?: string;
+}
+
+export interface ClientConnectOptions {
+
+    /**
+     * sets the credentials used to authenticate.
+     * when the server is configured for
+     *
+     * - `'token'` type authentication, the value
+     * is the token response received from the
+     * authentication endpoint (called manually by
+     * the application). When the server is
+     * configured for `'direct'` type
+     * authentication, the value is the credentials
+     * expected by the server for the specified
+     * authentication strategy used which typically
+     * means an object with headers
+     * (e.g. `{ headers: { authorization: 'Basic am9objpzZWNyZXQ=' } }`).
+     */
+    auth?: string | {
+        headers?: Record<string, string>;
+        payload?: Record<string, string>;
+    };
+
+    /**
+     * A boolean that indicates whether the client
+     * should try to reconnect. Defaults to `true`.
+     */
+    reconnect?: boolean;
+
+    /**
+     * Time in milliseconds to wait between each
+     * reconnection attempt. The delay time is
+     * cumulative, meaning that if the value is set
+     * to `1000` (1 second), the first wait will be
+     * 1 seconds, then 2 seconds, 3 seconds, until
+     * the `maxDelay` value is reached and then
+     * `maxDelay` is used.
+     */
+    delay?: number;
+
+    /**
+     * The maximum delay time in milliseconds
+     * between reconnections.
+     */
+    maxDelay?: number;
+
+    /**
+     * number of reconnection attempts. Defaults to
+     * `Infinity` (unlimited).
+     */
+    retries?: number;
+
+    /**
+     * socket connection timeout in milliseconds.
+     * Defaults to the WebSocket implementation
+     * timeout default.
+     */
+    timeout?: number;
+}
+
+type NesReqRes<R> = {
+    payload: R;
+    statusCode: number;
+    headers: Record<string, string>;
+}
+
+export interface ClientRequestOptions {
+
+    /**
+     * The requested endpoint path or route id.
+     */
+    path: string;
+
+    /**
+     * The requested HTTP method (can also be any
+     * method string supported by the server).
+     * Defaults to `'GET'`.
+     */
+    method?: Omit<HTTP_METHODS | Lowercase<HTTP_METHODS>, 'HEAD' | 'head'>;
+    /**
+     * An object where each key is a request header
+     * and the value the header content. Cannot
+     * include an Authorization header. Defaults to
+     * no headers.
+     */
+    headers?: Record<string, string>;
+
+    /**
+     * The request payload sent to the server.
+     */
+    payload?: any;
+}
+
+export interface NesSubHandler {
+
+    (
+        message: unknown,
+        flags: {
+
+            /**
+             * Set to `true` when the message is the
+             * last update from the server due to a
+             * subscription revocation.
+             */
+            revoked?: boolean;
+
+        }
+    ): void;
+}
+
+/**
+ * Creates a new client object
+ *
+ * https://github.com/hapijs/nes/blob/master/API.md#client-5
+ */
+export class Client {
+
+    /**
+     * https://github.com/hapijs/nes/blob/master/API.md#new-clienturl-options
+     * @param url
+     * @param options
+     */
+    constructor(
+        url: `ws://${string}` | `wss://${string}`,
+        options?: {
+            ws?: ClientOptions | ClientRequestArgs;
+            timeout?: number | boolean;
+        });
+
+    /**
+     * The unique socket identifier assigned by the
+     * server. The value is set after the
+     * connection is established.
+     */
+    readonly id: string | null;
+
+    /**
+     * A property set by the developer to handle
+     * errors. Invoked whenever an error happens
+     * that cannot be associated with a pending
+     * request.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientonerror
+     */
+    onError(err: NesError): void;
+
+    /**
+     * A property set by the developer used to set
+     * a handler for connection events (initial
+     * connection and subsequent reconnections)
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientonconnect
+     */
+    onConnect(): void;
+
+    /**
+     * A property set by the developer used to set
+     * a handler for disconnection events
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientondisconnect
+     *
+     * @param willReconnect A boolean indicating if
+     * the client will automatically attempt to
+     * reconnect
+     * @param log A log object containing
+     * information about the disconnection
+     */
+    onDisconnect(willReconnect: boolean, log: NesLog): void;
+
+    /**
+     * A property set by the developer used to set
+     * a handler for heartbeat timeout events
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientonheartbeattimeout
+     *
+     * @param willReconnect A boolean indicating if
+     * the client will automatically attempt to
+     * reconnect
+     */
+    onHeartbeatTimeout(willReconnect: boolean): void;
+
+    /**
+     * A property set by the developer used to set
+     * a custom message handler. Invoked whenever
+     * the server calls `server.broadcast()` or
+     * `socket.send()`.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientonupdate
+     *
+     * @param message
+     */
+
+    onUpdate(message: unknown): void;
+
+
+    /**
+     * Connects the client to the server
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientconnectoptions
+     */
+    connect(options?: ClientConnectOptions): Promise<void>;
+
+    /**
+     * Disconnects the client from the server and
+     * stops future reconnects.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientdisconnect
+     */
+    disconnect(): Promise<void>;
+
+    /**
+     * Sends an endpoint request to the server.
+     * This overload will perform a `GET` request by
+     * default.
+     *
+     * Rejects with `Error` if the request failed.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientrequestoptions
+     *
+     * @param path The endpoint path
+     */
+    request <R = any>(path: string): Promise<NesReqRes<R>>;
+
+    /**
+     * Sends an endpoint request to the server.
+     *
+     * Rejects with `Error` if the request failed.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientrequestoptions
+     *
+     * @param options The request options
+     */
+    request <R = any>(options: ClientRequestOptions): Promise<NesReqRes<R>>;
+
+
+    /**
+     * Sends a custom message to the server which
+     * is received by the server `onMessage` handler
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientmessagemessage
+     *
+     * @param message The message sent to the
+     * server. Can be any type which can be safely
+     * converted to string using `JSON.stringify()`.
+     */
+    message <R = any>(message: unknown): Promise<R>;
+
+    /**
+     * Subscribes to a server subscription
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientsubscribepath-handler
+     *
+     * @param path The requested subscription path.
+     * Paths are just like HTTP request paths (e.g.
+     * `'/item/5'` or `'/updates'` based on the
+     * paths supported by the server).
+     *
+     * @param handler The function used to receive subscription updates
+     */
+    subscribe(path: string, handler: NesSubHandler): Promise<void>;
+
+    /**
+     * Cancels a subscription
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientunsubscribepath-handler
+     *
+     * @param path the subscription path used to subscribe
+     * @param handler remove a specific handler from a
+     * subscription or `null` to remove all handlers for
+     * the given path
+     */
+    unsubscribe(path: string, handler?: NesSubHandler): Promise<void>;
+
+    /**
+     * Returns an array of the current subscription paths.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientsubscriptions
+     *
+     */
+    subscriptions(): string[];
+
+    /**
+     * Sets or overrides the authentication credentials used
+     * to reconnect the client on disconnect when the client
+     * is configured to automatically reconnect
+     *
+     * Returns `true` if reconnection is enabled, otherwise
+     * `false` (in which case the method was ignored).
+     *
+     * Note: this will not update the credentials on the
+     * server - use `client.reauthenticate()`
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#clientoverridereconnectionauthauth
+     *
+     * @param auth same as the `auth` option passed to
+     * `client.connect()`
+     */
+    overrideReconnectionAuth(auth: ClientConnectOptions['auth']): boolean;
+
+    /**
+     * Will issue the `reauth` message to the server with
+     * updated `auth` details and also override the
+     * reconnection information, if reconnection is enabled.
+     * The server will respond with an error and drop the
+     * connection in case the new `auth` credentials are
+     * invalid.
+     *
+     * Rejects with `Error` if the request failed.
+     *
+     * Resolves with `true` if the request succeeds.
+     *
+     * Note: when authentication has a limited lifetime,
+     * `reauthenticate()` should be called early enough to
+     * avoid the server dropping the connection.
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#await-clientreauthenticateauth
+     *
+     * @param auth same as the `auth` option passed to
+     * `client.connect()`
+     */
+    reauthenticate(auth: ClientConnectOptions['auth']): Promise<unknown>;
+}

package/lib/client.js

@@ -104,7 +104,7 @@
 
         options = options || {};
 
-        this._isBrowser = typeof WebSocket !== 'undefined';
+        this._isBrowser = Client.isBrowser();
 
         if (!this._isBrowser) {
             options.ws = options.ws || {};
@@ -148,6 +148,13 @@
 
     Client.WebSocket = /* $lab:coverage:off$ */ (typeof WebSocket === 'undefined' ? null : WebSocket); /* $lab:coverage:on$ */
 
+    Client.isBrowser = function () {
+
+        // $lab:coverage:off$
+        return typeof WebSocket !== 'undefined' && typeof window !== 'undefined';
+        // $lab:coverage:on$
+    };
+
     Client.prototype.connect = function (options) {
 
         options = options || {};

package/lib/index.d.ts

@@ -0,0 +1,450 @@
+import * as Hapi from '@hapi/hapi';
+
+import * as Iron from '@hapi/iron';
+import { Client } from './client';
+
+import {
+    ClientConnectOptions,
+    ClientRequestOptions,
+    ErrorCodes,
+    ErrorType,
+    NesError,
+    NesLog,
+    NesReqRes,
+    NesSubHandler
+} from './client';
+
+export namespace Nes {
+
+    export {
+        ClientConnectOptions,
+        ClientRequestOptions,
+        ErrorCodes,
+        ErrorType,
+        NesError,
+        NesLog,
+        NesReqRes,
+        NesSubHandler
+    }
+
+    export interface SocketAuthObject<
+        U extends object = Hapi.UserCredentials,
+        A extends object = Hapi.AuthCredentials,
+    > {
+        isAuthenticated: boolean;
+        credentials: Hapi.AuthCredentials<U, A> | null;
+        artifacts: Hapi.AuthArtifacts | null;
+    }
+
+    export interface Socket<
+        App extends object = {},
+        Auth extends SocketAuthObject<any, any> = SocketAuthObject<any, any>
+    > {
+        id: string,
+        app: App,
+        auth: Auth,
+        info: {
+            remoteAddress: string,
+            remotePort: number,
+            'x-forwarded-for'?: string,
+        }
+        server: Hapi.Server,
+        disconnect(): Promise<void>,
+        send(message: unknown): Promise<void>,
+        publish(path: string, message: unknown): Promise<void>,
+        revoke(
+            path: string,
+            message?: unknown | null,
+            options?: {
+                ignoreClose?: boolean,
+            }
+        ): Promise<void>,
+        isOpen(): boolean,
+    }
+
+    export interface ClientOpts {
+        onDisconnect?: (
+            willReconnect: boolean,
+            log: {
+                code: number,
+                explanation: string,
+                reason: string,
+                wasClean: string,
+                willReconnect: boolean,
+                wasRequested: boolean,
+            }
+        ) => void
+    }
+
+    export interface BroadcastOptions {
+
+        /**
+         * Optional user filter. When provided, the
+         * message will be sent only to
+         * authenticated sockets with
+         * `credentials.user` equal to `user`.
+         * Requires the `auth.index` options to be
+         * configured to `true`.
+         */
+        user?: string
+    }
+
+    type FilterReturn = (
+        boolean | {
+            /**
+             * an override `message` to send to this `socket`
+             * instead of the published one. Note that if you
+             * want to modify `message`, you must clone it first
+             * or the changes will apply to all other sockets.
+             */
+            override: unknown
+        }
+    )
+
+    export interface SubscriptionOptions<S extends Socket = Socket<any, any>> {
+        /**
+         * Publishing filter function for making per-client
+         * connection decisions about which matching publication
+         * update should be sent to which client.
+         * @param path The path of the published update. The path
+         * is provided in case the subscription contains path
+         * parameters
+         * @param message The `JSON.stringify()` compliant
+         * message being published
+         * @param options Additional information about the
+         * subscription and client
+         * @returns
+         */
+        filter?: (
+            path: string,
+            message: unknown,
+            options: {
+                socket: S,
+                credentials?: S['auth']['credentials'],
+
+                /**
+                 * The parameters parsed from the publish message
+                 * path if the subscription path contains
+                 * parameters.
+                 */
+                params?: unknown,
+
+                /**
+                 * The internal options data passed to the
+                 * `server.publish()` call, if defined.
+                 */
+                internal: unknown
+            },
+        ) => (FilterReturn | Promise<FilterReturn>),
+
+        /**
+         * A method called when a client subscribes to this
+         * subscription endpoint
+         *
+         * @param socket The `Socket` object of incoming
+         * connection
+         * @param path The path the client subscribed to
+         * @param params The parameters parsed from the
+         * subscription request path if the subscription path
+         * definition contains parameters.
+
+         * @returns
+         */
+        onSubscribe?: (
+            socket: Socket,
+            path: string,
+            params?: unknown
+        ) => void,
+
+        /**
+         * A method called when a client unsubscribes from this subscription endpoint
+         * @param socket The `Socket` object of incoming
+         * connection
+         * @param path The path the client subscribed to
+         * @param params The parameters parsed from the
+         * subscription request path if the subscription path
+         * definition contains parameters.
+         * @returns
+         */
+        onUnsubscribe?: (
+            socket: Socket,
+            path: string,
+            params?: unknown
+        ) => void,
+
+        /**
+         * The subscription authentication options
+         */
+        auth?: boolean | {
+            /**
+             * Same as the ***hapi*** auth modes.
+             */
+            mode?: 'required' | 'optional',
+
+            /**
+             * Same as the ***hapi*** auth scopes.
+             */
+            scope?: string | string[],
+
+            /**
+             * Same as the ***hapi*** auth entities.
+             */
+            entity?: 'user' | 'app' | 'any',
+
+            /**
+             * if `true`, authenticated socket with `user`
+             * property in `credentials` are mapped for usage
+             * in `server.publish()` calls. Defaults to `false`.
+             */
+            index?: boolean,
+        }
+    }
+
+    export interface PublishOptions {
+        /**
+         * Optional user filter. When provided, the message will
+         * be sent only to authenticated sockets with
+         * `credentials.user` equal to `user`. Requires the
+         * subscription `auth.index` options to be configured to
+         * `true`.
+         */
+        user?: string,
+
+        /**
+         * Internal data that is passed to `filter` and may be
+         * used to filter messages on data that is not sent to
+         * the client.
+         */
+        internal?: unknown
+    }
+
+    export interface EachSocketOptions {
+        /**
+         * When set to a string path, limits the results to sockets that are subscribed to that path.
+         */
+        subscription?: string,
+
+        /**
+         * Optional user filter. When provided, the `each` method
+         * will be invoked with authenticated sockets with
+         * `credentials.user` equal to `user`. Requires the
+         * subscription `auth.index` options to be configured to
+         * `true`.
+         */
+        user?: string
+
+    }
+
+    /**
+     * Plugin options
+     *
+     * https://github.com/hapijs/nes/blob/master/API.md#registration
+     */
+    export interface PluginOptions<
+        App extends object = {},
+        Auth extends SocketAuthObject<any, any> = SocketAuthObject<any, any>
+    > {
+        /**
+         * A function invoked for each incoming connection
+         * @param socket  The `Socket` object of incoming
+         * connection
+         */
+        onConnection?: (socket: Socket<App, Auth>) => void
+
+        /**
+         * A function invoked for each disconnection
+         * @param socket The `Socket` object of incoming
+         * connection
+         */
+        onDisconnection?: (socket: Socket<App, Auth>) => void
+
+        /**
+         * A function used to receive custom client messages
+         * @param message The message sent by the client
+         * @returns
+         */
+        onMessage?: (
+            socket: Socket<App, Auth>,
+            message: unknown
+        ) => void
+
+        /**
+         * Optional plugin authentication options. The details of
+         * this object do imply quiet a bit of  logic, so it is
+         * best to see the documentation for more information.
+         *
+         * https://github.com/hapijs/nes/blob/master/API.md#registration
+         */
+        auth?: false | {
+            endpoint?: string
+            id?: string
+            type?: 'cookie' | 'token' | 'direct',
+            route?: Hapi.RouteOptions<any>['auth'],
+            cookie?: string,
+            isSecure?: boolean,
+            isHttpOnly?: boolean,
+            isSameSite?: 'Strict' | 'Lax' | false,
+            path?: string | null,
+            domain?: string | null,
+            ttl?: number | null,
+            iron?: Iron.SealOptions,
+            password?: Iron.Password | Iron.password.Secret,
+            index?: boolean,
+            timeout?: number | false,
+            maxConnectionsPerUser?: number | false,
+            minAuthVerifyInterval?: number | false,
+        },
+
+        /**
+         * An optional array of header field names to include in
+         * server responses to the client. If set to `'*'`
+         * (without an array), allows all headers. Defaults to
+         * `null` (no headers).
+         */
+        headers?: string[] | '*' | null,
+
+        /**
+         * Optional message payload
+         */
+        payload?: {
+
+            /**
+             *  the maximum number of characters (after the full
+             * protocol object is converted to a string using
+             * `JSON.stringify()`) allowed in a single WebSocket
+             * message. This is important when using the protocol
+             * over a slow network (e.g. mobile) with large
+             * updates as the transmission time can exceed the
+             * timeout or heartbeat limits which will cause the
+             * client to disconnect. Defaults to `false`
+             * (no limit).
+             */
+            maxChunkChars?: number | false,
+        },
+
+        /**
+         * Configures connection keep-alive settings.
+         * When set to `false`, the server will not send
+         * heartbeats. Defaults to:
+         *
+         * ```js
+         * {
+         *     interval: 15000,
+         *     timeout: 5000
+         * }
+         * ```
+         */
+        heartbeat?: false | {
+
+            /**
+             * The time interval between heartbeat messages in
+             * milliseconds. Defaults to `15000` (15 seconds).
+             */
+            interval: number,
+
+            /**
+             * timeout in milliseconds after a heartbeat is sent
+             * to the client and before the client is considered
+             * disconnected by the server. Defaults to `5000`
+             * (5 seconds).
+             */
+            timeout?: number,
+        },
+
+        /**
+         * If specified, limits the number of simultaneous client
+         * connections. Defaults to `false`.
+         */
+        maxConnections?: number | false,
+
+        /**
+         * An origin string or an array of origin strings
+         * incoming client requests must match for the connection
+         * to be permitted. Defaults to no origin validation.
+         */
+        origins?: string | string[]
+    }
+}
+
+export { Client }
+
+export const plugin: Hapi.Plugin<Nes.PluginOptions>;
+
+
+declare module '@hapi/hapi' {
+
+    interface Server {
+
+        /**
+         * Sends a message to all connected clients
+         * where:
+         *
+         * https://hapi.dev/module/nes/api/?v=13.0.1#await-serverbroadcastmessage-options
+         *
+         * @param message The message sent to the
+         * clients. Can be any type which can be
+         * safely converted to string using `JSON.
+         * stringify()`.
+         * @param options An optional object
+         */
+        broadcast(message: unknown, options?: Nes.BroadcastOptions): void;
+
+        /**
+         * Declares a subscription path client can
+         * subscribe to where:
+         *
+         * https://hapi.dev/module/nes/api/?v=13.0.1#serversubscriptionpath-options
+         *
+         * @param path An HTTP-like path. The path
+         * must begin with the `'/'` character. The
+         * path may contain path parameters as
+         * supported by the ***hapi*** route path parser.
+
+         * @param options An optional object
+         */
+        subscription(path: string, options?: Nes.SubscriptionOptions): void;
+
+        /**
+         * Sends a message to all the subscribed clients
+         *
+         * https://github.com/hapijs/nes/blob/master/API.md#await-serverpublishpath-message-options
+         *
+         * @param path the subscription path. The path is matched
+         * first against the available subscriptions added via
+         * `server.subscription()` and then against the specific
+         * path provided by each client at the time of
+         * registration (only matter when the subscription path
+         * contains parameters). When a match is found, the
+         * subscription `filter` function is called (if present)
+         * to further filter which client should receive which
+         * update.
+         *
+         * @param message The message sent to the clients. Can be any type which can be safely converted to string using `JSON.stringify()`.
+         * @param options optional object
+         */
+        publish(path: string, message: unknown, options?: Nes.PublishOptions): void;
+
+        /**
+         * Iterates over all connected sockets, optionally
+         * filtering on those that have subscribed to a given
+         * subscription. This operation is synchronous
+         *
+         * @param each Iteration method
+         * @param options Optional options
+         */
+        eachSocket(
+            each: (socket: Nes.Socket) => void,
+            options?: Nes.EachSocketOptions
+        ): void;
+    }
+
+    interface Request {
+
+        /**
+         * Provides access to the `Socket` object of the incoming
+         * connection
+         */
+        socket: Nes.Socket;
+    }
+}
+

package/lib/listener.js

@@ -33,6 +33,7 @@ exports = module.exports = internals.Listener = function (server, settings) {
     // WebSocket listener
 
     const options = { server: this._server.listener };
+
     if (settings.origin) {
         options.verifyClient = (info) => settings.origin.indexOf(info.origin) >= 0;
     }
@@ -103,6 +104,10 @@ internals.Listener.prototype._close = async function () {
     await Promise.all(Object.keys(this._sockets._items).map((id) => this._sockets._items[id].disconnect()));
 
     this._wss.close();
+
+    for (const ws of this._wss.clients) {
+        ws.terminate();
+    }
 };
 
 

package/lib/socket.js

@@ -237,7 +237,7 @@ internals.Socket.prototype._onMessage = async function (message) {
     try {
         var request = JSON.parse(message);
     }
-    catch (err) {
+    catch {
         return this._error(Boom.badRequest('Cannot parse message'));
     }
 
@@ -563,7 +563,7 @@ internals.Socket.prototype._authenticate = async function (request) {
             const auth = await Iron.unseal(request.auth, config.password, config.iron ?? Iron.defaults);
             this._setCredentials(auth);
         }
-        catch (err) {
+        catch {
             throw Boom.unauthorized('Invalid token');
         }
     }
@@ -585,7 +585,7 @@ internals.Socket.prototype._authByCookie = async function () {
     try {
         var { states } = await this.server.states.parse(cookies);
     }
-    catch (err) {
+    catch {
         throw Boom.unauthorized('Invalid nes authentication cookie');
     }
 

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@hapi/nes",
   "description": "WebSocket adapter plugin for hapi routes",
-  "version": "13.0.1",
+  "version": "14.0.1",
   "repository": "git://github.com/hapijs/nes",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "files": [
     "lib"
   ],
@@ -12,30 +16,29 @@
     "plugin",
     "websocket"
   ],
-  "eslintConfig": {
-    "extends": [
-      "plugin:@hapi/module"
-    ]
-  },
   "dependencies": {
     "@hapi/boom": "^10.0.1",
-    "@hapi/bounce": "^3.0.1",
+    "@hapi/bounce": "^3.0.2",
     "@hapi/call": "^9.0.1",
     "@hapi/cryptiles": "^6.0.1",
-    "@hapi/hoek": "^11.0.2",
+    "@hapi/hoek": "^11.0.7",
     "@hapi/iron": "^7.0.1",
     "@hapi/teamwork": "^6.0.0",
     "@hapi/validate": "^2.0.1",
-    "ws": "^7.3.1"
+    "@types/ws": "^8.5.13",
+    "ws": "^8.18.0"
   },
   "devDependencies": {
     "@hapi/code": "^9.0.3",
-    "@hapi/eslint-plugin": "*",
-    "@hapi/hapi": "^21.2.1",
-    "@hapi/lab": "^25.1.2"
+    "@hapi/eslint-plugin": "^7.0.0",
+    "@hapi/hapi": "^21.3.12",
+    "@hapi/lab": "^26.0.0",
+    "@types/node": "^20.17.12",
+    "joi": "^17.13.3",
+    "typescript": "^5.4.5"
   },
   "scripts": {
-    "test": "lab -a @hapi/code -t 100 -L -m 10000",
+    "test": "lab -a @hapi/code -t 100 -L -m 10000 -Y",
     "test-cov-html": "lab -a @hapi/code -r html -o coverage.html -m 10000"
   },
   "license": "BSD-3-Clause"