@logux/server 0.12.2 → 0.12.4

package/filter-meta/index.d.ts

@@ -1,4 +1,4 @@
-import { ServerMeta } from '../base-server/index.js'
+import type { ServerMeta } from '../base-server/index.js'
 
 /**
  * Remove all non-allowed keys from meta.

package/human-formatter/index.js

@@ -1,11 +1,11 @@
-import stripAnsi from 'strip-ansi'
-import yyyymmdd from 'yyyy-mm-dd'
-import pico from 'picocolors'
+import { once } from 'events'
 import os from 'os'
+import pico from 'picocolors'
+import pino from 'pino'
 import abstractTransport from 'pino-abstract-transport'
 import { Transform } from 'stream'
-import pino from 'pino'
-import { once } from 'events'
+import stripAnsi from 'strip-ansi'
+import yyyymmdd from 'yyyy-mm-dd'
 
 import { mulberry32, onceXmur3 } from './utils.js'
 
@@ -15,19 +15,19 @@ const SEPARATOR = os.EOL + os.EOL
 const NEXT_LINE = os.EOL === '\n' ? '\r\v' : os.EOL
 
 const PARAMS_BLACKLIST = {
-  v: true,
-  msg: true,
+  component: true,
   err: true,
-  pid: true,
   hint: true,
-  note: true,
-  name: true,
-  time: true,
+  hostname: true,
   level: true,
   listen: true,
+  msg: true,
+  name: true,
+  note: true,
+  pid: true,
   server: true,
-  hostname: true,
-  component: true
+  time: true,
+  v: true
 }
 
 const LABELS = {

package/index.d.ts

@@ -1,35 +1,35 @@
-export { Action } from '@logux/core'
-
 export {
+  addSyncMap,
+  addSyncMapFilter,
+  ChangedAt,
+  NoConflictResolution,
+  SyncMapData,
+  WithoutTime,
+  WithTime
+} from './add-sync-map/index.js'
+export { ALLOWED_META } from './allowed-meta/index.js'
+export {
+  BaseServer,
   BaseServerOptions,
+  Logger,
   SendBackActions,
-  BaseServer,
   ServerMeta,
-  wasNot403,
-  Logger
+  wasNot403
 } from './base-server/index.js'
+export { ChannelContext, Context } from './context/index.js'
+export { filterMeta } from './filter-meta/index.js'
 export {
-  ResponseError,
-  request,
+  del,
+  get,
   patch,
   post,
-  get,
   put,
-  del
+  request,
+  ResponseError
 } from './request/index.js'
-export {
-  NoConflictResolution,
-  addSyncMapFilter,
-  WithoutTime,
-  SyncMapData,
-  addSyncMap,
-  ChangedAt,
-  WithTime
-} from './add-sync-map/index.js'
-export { TestServer, TestServerOptions } from './test-server/index.js'
-export { TestClient, LoguxActionError } from './test-client/index.js'
-export { Context, ChannelContext } from './context/index.js'
-export { Server, ServerOptions } from './server/index.js'
 export { ServerClient } from './server-client/index.js'
-export { ALLOWED_META } from './allowed-meta/index.js'
-export { filterMeta } from './filter-meta/index.js'
+export { Server, ServerOptions } from './server/index.js'
+export { LoguxActionError, TestClient } from './test-client/index.js'
+export { TestServer, TestServerOptions } from './test-server/index.js'
+
+export { Action } from '@logux/core'

package/index.js

@@ -1,22 +1,22 @@
 export {
-  ResponseError,
-  request,
-  patch,
-  post,
-  get,
-  put,
-  del
-} from './request/index.js'
-export {
-  NoConflictResolution,
-  addSyncMapFilter,
   addSyncMap,
-  ChangedAt
+  addSyncMapFilter,
+  ChangedAt,
+  NoConflictResolution
 } from './add-sync-map/index.js'
-export { BaseServer, wasNot403 } from './base-server/index.js'
 export { ALLOWED_META } from './allowed-meta/index.js'
-export { TestServer } from './test-server/index.js'
-export { TestClient } from './test-client/index.js'
-export { filterMeta } from './filter-meta/index.js'
+export { BaseServer, wasNot403 } from './base-server/index.js'
 export { Context } from './context/index.js'
+export { filterMeta } from './filter-meta/index.js'
+export {
+  del,
+  get,
+  patch,
+  post,
+  put,
+  request,
+  ResponseError
+} from './request/index.js'
 export { Server } from './server/index.js'
+export { TestClient } from './test-client/index.js'
+export { TestServer } from './test-server/index.js'

package/options-loader/index.js

@@ -99,9 +99,9 @@ function mapArgs(parsedCliArgs, argsSpec) {
 function composeHelp(spec, argv) {
   let options = Object.entries(spec.options).map(([name, option]) => ({
     alias: option.alias ? composeCliAliasName(option.alias) : '',
-    full: composeCliFullName(name),
+    description: option.description,
     env: spec.envPrefix ? composeEnvName(spec.envPrefix, name) : '',
-    description: option.description
+    full: composeCliFullName(name)
   }))
   let nameColumnLength = Math.max(...options.map(it => it.full.length))
   let envColumnLength = Math.max(...options.map(it => it.env.length))

package/options-loader/index.test.js

@@ -1,6 +1,7 @@
 import { resolve } from 'path'
+import { describe, expect, it } from 'vitest'
 
-import { loadOptions, oneOf, number } from './index.js'
+import { loadOptions, number, oneOf } from './index.js'
 
 function fakeProcess(argv, env = {}) {
   return { argv, env }
@@ -10,13 +11,13 @@ describe('loadOptions', () => {
   it('returns help', () => {
     let [help, options] = loadOptions(
       {
+        examples: ['$0'],
         options: {
           port: {
             description: 'port',
             parse: number
           }
-        },
-        examples: ['$0']
+        }
       },
       fakeProcess(['node', 'test/test.js', '--help'])
     )
@@ -43,13 +44,13 @@ describe('loadOptions', () => {
   it('uses env for options', () => {
     let [, options] = loadOptions(
       {
+        envPrefix: 'LOGUX',
         options: {
           port: {
             description: 'port',
             parse: number
           }
-        },
-        envPrefix: 'LOGUX'
+        }
       },
       fakeProcess([], {
         LOGUX_PORT: '31337'
@@ -63,13 +64,13 @@ describe('loadOptions', () => {
   it('uses dotenv file for options', () => {
     let [, options] = loadOptions(
       {
+        envPrefix: 'LOGUX',
         options: {
           port: {
             description: 'port',
             parse: number
           }
-        },
-        envPrefix: 'LOGUX'
+        }
       },
       fakeProcess([], {}),
       {
@@ -83,13 +84,13 @@ describe('loadOptions', () => {
   it('composes correct env and CLI names for argument with complex name', () => {
     let [, options] = loadOptions(
       {
+        envPrefix: 'LOGUX',
         options: {
           somePort: {
             description: 'port',
             parse: number
           }
-        },
-        envPrefix: 'LOGUX'
+        }
       },
       fakeProcess(['--some-port', '1'], {
         LOGUX_SOME_PORT: '1'
@@ -103,15 +104,15 @@ describe('loadOptions', () => {
   it('uses combined options', () => {
     let [, options] = loadOptions(
       {
+        envPrefix: 'LOGUX',
         options: {
-          key: {
-            description: 'port'
-          },
           cert: {
             description: 'cert'
+          },
+          key: {
+            description: 'port'
           }
-        },
-        envPrefix: 'LOGUX'
+        }
       },
       fakeProcess(['', '--key', './key.pem'], { LOGUX_CERT: './cert.pem' })
     )
@@ -122,19 +123,19 @@ describe('loadOptions', () => {
 
   it('uses arg and env in given priority', () => {
     let optionsSpec = {
+      envPrefix: 'LOGUX',
       options: {
-        port: {
-          description: 'port',
-          parse: number
+        cert: {
+          description: 'cert'
         },
         key: {
           description: 'key'
         },
-        cert: {
-          description: 'cert'
+        port: {
+          description: 'port',
+          parse: number
         }
-      },
-      envPrefix: 'LOGUX'
+      }
     }
 
     let [, options1] = loadOptions(
@@ -171,12 +172,12 @@ describe('loadOptions', () => {
     let [, options] = loadOptions(
       {
         options: {
+          key: {
+            description: 'key'
+          },
           port: {
             alias: 'p',
             description: 'port'
-          },
-          key: {
-            description: 'key'
           }
         }
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logux/server",
-  "version": "0.12.2",
+  "version": "0.12.4",
   "description": "Build own Logux server or make proxy between WebSocket and HTTP backend on any language",
   "keywords": [
     "logux",
@@ -15,7 +15,7 @@
   ],
   "author": "Andrey Sitnik <andrey@sitnik.ru>",
   "license": "MIT",
-  "homepage": "https://logux.io/",
+  "homepage": "https://logux.org/",
   "repository": "logux/server",
   "engines": {
     "node": "^14.0.0 || ^16.0.0 || >=18.0.0"
@@ -27,24 +27,24 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@logux/actions": "^0.3.0",
-    "@logux/core": "^0.8.0",
+    "@logux/actions": "^0.3.1",
+    "@logux/core": "^0.8.4",
     "JSONStream": "^1.3.5",
     "cookie": "^0.5.0",
-    "dotenv": "^16.0.2",
-    "fast-glob": "^3.2.11",
+    "dotenv": "^16.3.1",
+    "fast-glob": "^3.3.1",
     "ip": "^1.1.8",
     "nanodelay": "^2.0.2",
-    "nanoevents": "^7.0.1",
-    "nanoid": "^4.0.0",
-    "node-fetch": "^2.6.7",
+    "nanoevents": "^8.0.0",
+    "nanoid": "^4.0.2",
+    "node-fetch": "^3.3.2",
     "picocolors": "^1.0.0",
-    "pino": "8.5.0",
+    "pino": "8.15.0",
     "pino-abstract-transport": "^1.0.0",
-    "semver": "^7.3.7",
-    "strip-ansi": "^7.0.1",
+    "semver": "^7.5.4",
+    "strip-ansi": "^7.1.0",
     "url-pattern": "^1.0.3",
-    "ws": "^8.8.1",
+    "ws": "^8.13.0",
     "yyyy-mm-dd": "^1.0.2"
   }
 }

package/request/index.d.ts

@@ -1,4 +1,5 @@
-import fetch, { RequestInit } from 'node-fetch'
+import type { RequestInit } from 'node-fetch'
+import type fetch from 'node-fetch'
 
 /**
  * Throwing this error in `accessAndProcess` or `accessAndLoad`

package/request/test.test.js

@@ -1,12 +1,13 @@
-import { jest } from '@jest/globals'
+import { spy } from 'nanospy'
+import { expect, it } from 'vitest'
 
-import { ResponseError, request, patch, post, get, put, del } from '../index.js'
+import { del, get, patch, post, put, request, ResponseError } from '../index.js'
 
 it('has error', () => {
   let error = new ResponseError(
     403,
     '/a',
-    { method: 'GET', body: 'body' },
+    { body: 'body', method: 'GET' },
     'answer'
   )
   expect(error.name).toEqual('ResponseError')
@@ -24,73 +25,98 @@ it('throws an error on non-2xx response', async () => {
     }
   }
   await expect(
-    request('/a', { method: 'GET', body: 'body' }, fetch)
+    request('/a', { body: 'body', method: 'GET' }, fetch)
   ).rejects.toThrow(
-    new ResponseError(403, '/a', { method: 'GET', body: 'body' }, 'answer')
+    new ResponseError(403, '/a', { body: 'body', method: 'GET' }, 'answer')
   )
 })
 
 it('parses JSON body', async () => {
   async function fetch() {
     return {
-      status: 200,
       async json() {
         return { answer: '1' }
-      }
+      },
+      status: 200
     }
   }
   expect(await request('/a', { method: 'GET' }, fetch)).toEqual({ answer: '1' })
 })
 
 it('has shortcut for GET', async () => {
-  let fetch = jest.fn(async () => ({
-    status: 200,
+  let fetch = spy(async () => ({
     async json() {
       return { answer: '1' }
-    }
+    },
+    status: 200
   }))
 
   expect(await get('/a', { headers: { a: 1 } }, fetch)).toEqual({ answer: '1' })
-  expect(fetch).toHaveBeenCalledWith('/a', {
-    method: 'GET',
-    headers: { a: 1 }
-  })
+  expect(fetch.calls).toEqual([
+    [
+      '/a',
+      {
+        headers: { a: 1 },
+        method: 'GET'
+      }
+    ]
+  ])
 })
 
 it('has shortcut for POST', async () => {
-  let fetch = jest.fn(async () => ({ status: 204 }))
+  let fetch = spy(async () => ({ status: 204 }))
   await post('/a', { headers: { a: 1 } }, fetch)
-  expect(fetch).toHaveBeenCalledWith('/a', {
-    method: 'POST',
-    headers: { a: 1 }
-  })
+  expect(fetch.calls).toEqual([
+    [
+      '/a',
+      {
+        headers: { a: 1 },
+        method: 'POST'
+      }
+    ]
+  ])
 })
 
 it('has shortcut for PUT', async () => {
-  let fetch = jest.fn(async () => ({ status: 204 }))
+  let fetch = spy(async () => ({ status: 204 }))
   await put('/a', { headers: { a: 1 } }, fetch)
-  expect(fetch).toHaveBeenCalledWith('/a', {
-    method: 'PUT',
-    headers: { a: 1 }
-  })
+  expect(fetch.calls).toEqual([
+    [
+      '/a',
+      {
+        headers: { a: 1 },
+        method: 'PUT'
+      }
+    ]
+  ])
 })
 
 it('has shortcut for PATCH', async () => {
-  let fetch = jest.fn(async () => ({ status: 204 }))
+  let fetch = spy(async () => ({ status: 204 }))
   await patch('/a', { headers: { a: 1 } }, fetch)
-  expect(fetch).toHaveBeenCalledWith('/a', {
-    method: 'PATCH',
-    headers: { a: 1 }
-  })
+  expect(fetch.calls).toEqual([
+    [
+      '/a',
+      {
+        headers: { a: 1 },
+        method: 'PATCH'
+      }
+    ]
+  ])
 })
 
 it('has shortcut for DELETE', async () => {
-  let fetch = jest.fn(async () => ({ status: 204 }))
+  let fetch = spy(async () => ({ status: 204 }))
   await del('/a', { headers: { a: 1 } }, fetch)
-  expect(fetch).toHaveBeenCalledWith('/a', {
-    method: 'DELETE',
-    headers: { a: 1 }
-  })
+  expect(fetch.calls).toEqual([
+    [
+      '/a',
+      {
+        headers: { a: 1 },
+        method: 'DELETE'
+      }
+    ]
+  ])
 })
 
 it('works without option object', async () => {

package/server/index.d.ts

@@ -1,22 +1,26 @@
-import { BaseServer, Logger, BaseServerOptions } from '../base-server/index.js'
+import {
+  BaseServer,
+  type BaseServerOptions,
+  type Logger
+} from '../base-server/index.js'
 
 export interface LoggerOptions {
-  /**
-   * Logger message format.
-   */
-  type?: 'human' | 'json'
-
   /**
    * Stream to be used by logger to write log.
    */
   stream?: {
-    write(str: string): void
-
     /**
      * Used by pino to synchronously write log messages on application failure.
      */
     flushSync?(): void
+
+    write(str: string): void
   }
+
+  /**
+   * Logger message format.
+   */
+  type?: 'human' | 'json'
 }
 
 export interface ServerOptions extends BaseServerOptions {
@@ -73,6 +77,20 @@ export interface ServerOptions extends BaseServerOptions {
  * ```
  */
 export class Server<Headers extends object = {}> extends BaseServer<Headers> {
+  /**
+   * Server options.
+   *
+   * ```js
+   * console.log('Server options', server.options.subprotocol)
+   * ```
+   */
+  options: ServerOptions
+
+  /**
+   * @param opts Server options.
+   */
+  constructor(opts: ServerOptions)
+
   /**
    * Load options from command-line arguments and/or environment.
    *
@@ -95,20 +113,6 @@ export class Server<Headers extends object = {}> extends BaseServer<Headers> {
     defaults: ServerOptions
   ): ServerOptions
 
-  /**
-   * @param opts Server options.
-   */
-  constructor(opts: ServerOptions)
-
-  /**
-   * Server options.
-   *
-   * ```js
-   * console.log('Server options', server.options.subprotocol)
-   * ```
-   */
-  options: ServerOptions
-
   /**
    * Load module creators and apply to the server. By default, it will load
    * files from `modules/*`.
@@ -119,5 +123,5 @@ export class Server<Headers extends object = {}> extends BaseServer<Headers> {
    *
    * @param files Pattern for module files.
    */
-  autoloadModules(files?: string[] | string): Promise<void>
+  autoloadModules(files?: string | string[]): Promise<void>
 }