Logux Core

Logux is a new way to connect client and server. Instead of sending HTTP requests (e.g., AJAX and GraphQL) it synchronizes log of operations between client, server, and other clients.

• Guide, recipes, and API
• Issues and roadmap
• Projects inside Logux ecosystem

This repository contains Logux core components for JavaScript:

• Log to store node’s actions.
• MemoryStore to store log in the memory.
• BaseNode, ClientNode, and ServerNode to synchronize actions from Log with other node.
• isFirstOlder to compare creation time of different actions.
• WsConnection, Reconnect, and ServerConnection to connect nodes via WebSocket.
• TestLog, TestPair, TestTime, and eachStoreCheck to test Logux application.

Install

npm install @logux/core

Usage

See documentation for Logux API.

import { ClientNode, TestTime, TestLog, TestPair } from '@logux/core'

let time = new TestTime()
let pair = new TestPair()
let node = new ClientNode('client:test', time.nextLog(), pair.left)

import { isFirstOlder } from '@logux/core'

let lastRename
log.type('RENAME', (action, meta) => {
  if (isFirstOlder(lastRename, meta)) {
    changeName(action.name)
    lastRename = meta
  }
})

Change Log

This project adheres to Semantic Versioning.

0.9 L·L

• Removed Node.js 16 support.
• Replaced inMap and inFilter with onReceive.
• Replaced outMap and outFilter to onSend.
• Fixed synchronization.
• Added Criteria and ReadonlyListener types to exports (by @nichoth).

0.8.5

• Fixed frozen pages support (by @erictheswift).

0.8.4

• Fixed docs.

0.8.3

• Fixed disconnecting TestPair during connection process.

0.8.2

• Fixed undefined options (by @erictheswift).

0.8.1

• Removed Node.js dependencies to simplify bundling.

0.8 Ա

• Dropped Node.js 12 support.
• Add string-based time to isFirstOlder().
• Fixed action syncing order (by Tyler Han).
• Fixed behavior on disconnection in the middle of syncing (by Tyler Han).

0.7.3

• Increased ping timeout to solve Chrome background tab issue.

0.7.2

• Marked meta as read-only in non-preadd callbacks.

0.7.1

• Fixed re-connection delay to avoid backoff better.

0.7 क

• Moved project to ESM-only type. Applications must use ESM too.
• Dropped Node.js 10 support.
• Added Log#type().
• Added index to log entries (by Eduard Aksamitov).
• Added TestLog#keepActions().
• Allowed to specify action type in Log#add() call.
• Made destroy as mandatory method of Connection.
• Fixed types performance by replacing type to interface.

0.6.2

• Allow to call MemoryStore#get() without options (by Eduard Aksamitov).

0.6.1

• Fix counters comparison in isFirstOlder.

0.6 ᐁ

• Use WebSocket Protocol version 4.
• Remove reasons: string support. It must be always an array.
• Add parseId() helper.
• Add headers (by Ivan Menshykov).
• Add MemoryStore#entries.
• Allow to pass undefined to isFirstOlder().
• Return unbind function from Node#catch.
• Rename WsConnection#WS to WsConnection#Class.
• Rename Store type to LogStore.
• Fix WebSocket connectivity.
• Improve types (by Nikolay Govorov).

0.5.3

• Fix types.

0.5.2

• Fix Reconnect at changeUser from Logux Client.

0.5.1

• Fix protocol version.

0.5 ö

• Use WebSocket Protocol version 3.
• Change auth callback signature.
• Rename credentials option to token.
• User ID must be always a string.
• Add support for dynamic tokens.

0.4.2

• Fix types.

0.4.1

• Fix private API for Logux Server.

0.4 ñ

• Add ES modules support.
• Add TypeScript definitions.
• Move API docs from JSDoc to TypeDoc.
• Mark package as side effect free.

0.3.5

• Fix actions double sending to the server.

0.3.4

• Fix React Native and React Server-Side Rendering support (by Can Rau).

0.3.3

• Fix JSDoc.

0.3.2

• Fix read-only meta keys.

0.3.1

• Fix using old added in sync message.

0.3 Ω

• Rename project from logux-core to @logux/core.
• Remove Node.js 6 and 8 support.
• Merge with logux-sync.
• Merge with logux-store-tests.
• Use sting-based meta.id.
• Rename BaseSync, ClientSync, ServerSync to *Node.
• Rename SyncError to LoguxError.
• Remove missed-auth error.
• Rename BrowserConnection to WsConnection.
• Run input map before filter.
• Add Store#clean() (by Arthur Kushka).
• Add criteria.id to Store#removeReason.
• Add TestTime#lastId.
• Add TestLog#entries and TestLog#actions.
• Use more events for Reconnect.
• Do not throw on wrong-subprotocol, wrong-protocol, and timeout.
• Allow to send debug before authentication.
• Move all Logux docs to singe place.

0.2.2

• Allow to set meta.keepLast in preadd event listener.

0.2.1

• Fix removing action with different time from memory store.

0.2 Ѣ

• Rename meta.created to meta.id.
• Rename event event to add.
• Use reasons of life API to clean log.
• Return new action meta in Log#add.
• Deny tab symbol in Node ID.
• Add preadd event.
• Add TestTime.
• Add keepLast option to Log#add (by Igor Deryabin).
• Add meta.time for fixTime feature.
• Add isFirstOlder() helper.
• Add changeMeta, removeReason and byId to store.
• Add getLastAdded, getLastSynced and setLastSynced method to store.
• Fix leap second problem.
• Move store tests to separated project (by Konstantin Mamaev).
• Fix docs (by Grigoriy Beziuk, Andrew Romanov and Alexey Gaziev).

0.1 𐤀

• Initial release.