Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

topgun

TopGunBuild607MIT1.5.17TypeScript support: included

Realtime, offline-first, secure, graph data synchronization engine. Reimplementation of gunDB in TypeScript

graph, realtime, database, typescript, javascript, gun, key-value store, storage, adapter, performance

readme

TopGun Logo

🚀 TopGun

A graph data synchronisation engine for building realtime, offline-first, secure and scalable applications.

Alternate implementation of GunDB in TypeScript

semantic-release npm bundlephobia License: MIT Snyk

Installation

$ npm install topgun --save

Description

Coming Soon.

License

TopGun is MIT licensed.

changelog

1.5.17 (2023-08-13)

Bug Fixes

  • add missing export packages (7bc8051)
  • client: emit 'leave' event if user is logged in (8fd6196)
  • emit event when user logout (340c938)
  • export 'storage' package (d477ff8)
  • sea: disable decrypt error log (f15415b)

1.5.16 (2023-08-09)

Bug Fixes

  • add missing export getSessionStorageKey (3657284)

1.5.15 (2023-08-09)

Bug Fixes

  • add missing export getSessionStorage (9990319)

1.5.14 (2023-08-09)

Bug Fixes

  • destruct client options (40a5393)

1.5.13 (2023-08-09)

Bug Fixes

  • export method for validate credentials (998272b)
  • log decrypt error (63efe5f)

1.5.12 (2023-08-06)

Bug Fixes

1.5.11 (2023-08-02)

Bug Fixes

1.5.10 (2023-07-24)

Bug Fixes

  • add missing options export (4630913)

1.5.9 (2023-07-22)

Bug Fixes

  • remove callback from put and 'set' (05e483d)
  • upgrade TGUserGraph interface (6b2f6cb)

1.5.8 (2023-07-21)

Bug Fixes

  • add missing export for TGLexLink (1c723a3)

1.5.7 (2023-07-21)

Bug Fixes

  • add missing utils package (e86ac58)
  • update streams typings (b7d3f44)

1.5.6 (2023-07-16)

Bug Fixes

1.5.5 (2023-07-16)

Bug Fixes

  • add export for utils package (54d588f)

1.5.4 (2023-07-16)

Bug Fixes

  • add missing utils package (3a45844)

1.5.3 (2023-07-15)

Bug Fixes

  • add type for user graph (bd1740d)
  • client: add state property to graph (3f10f71)
  • client: update user sign graph (ca48f07)
  • improve connectors (07cdd3b)
  • improve direct query reply (170a93d)
  • return user pairs after authorization (1ed920a)
  • sea: export Pair interfaces (bb640dc)
  • update export packages (7ed8c36)
  • update typings (83060a1)

1.5.2 (2023-07-10)

Bug Fixes

  • add stream and sea packages for export (e70a0bb)
  • client: check username in use before create user (2a2239e)
  • upgrade exports (3d3af8d)

1.5.1 (2023-07-08)

Bug Fixes

  • client: improve leave() method (58b43a9)
  • client: update options, add waitForConnect() method (a5c42c0)
  • fix listen once (4acc73c)
  • remove unused export (198ebfb)
  • wait for socket connector auth (6eacb9c)

1.5.0 (2023-07-02)

Bug Fixes

  • client: add on method to listen for system events (b664cea)
  • client: fix link back (1114d9e)
  • client: immutable link after set() (c7c8796)
  • client: rename method userPubExpected -> waitForAuth (5a35600)
  • client: update link after authorization (e103a76)
  • client: upgrade topgun-async-stream-emitter 1.1.0 -> 1.1.1, add stream method (6e21f18)
  • types: rename SystemEvent -> TGSystemEvent (b02bd22)
  • upgrade topgun-typed 1.2.0 -> 1.3.0, throw error when path not valid (cb4c050)

Features

  • client: implement async iterable streams (f44e28d)

1.4.0 (2023-06-26)

Bug Fixes

  • add promise method to lex link (329720e)
  • add path validation (e47718e)
  • add topgun-textencoder, remove shims (c0f5375)
  • authenticate identity with a reference soul (e26bcb3)
  • client: collections query fixed (f7afb07)
  • client: generate soul in method set (ad5be79)
  • client: init get options in constructor (ef2ddb0)
  • client: move set method to lex-link (4e29ca4)
  • client: query multiple nodes (c62fc72)
  • client: remove persistSession from options (6f40894)
  • client: remove credentials when user leave (07525ff)
  • client: remove default timeout in promise method (039221a)
  • client: remove unused code (279ef61)
  • client: renamed local storage options (c9aaaf0)
  • client: resilve promise immediately if there are no active connectors (7c07586)
  • client: return soul from last value (11a3017)
  • client: set default session storage (df26d74)
  • create memory adapter based on the memory storage (e33e3b5)
  • fixed method once when requesting collections (5278d4f)
  • flatten graph data (8f497e9)
  • include soul to prefix query (16a41dc)
  • indexeddb: get keys instead of values (9a3e942)
  • request nodes from an adapter using get options (3c5ad9d)
  • update link soul (547d948)

Features

  • add options for max key/value size (b200d25)

1.3.0 (2023-06-03)

Bug Fixes

  • client: add createClient function (047cc9a)
  • client: add option for max limit for LEX query (882e438)
  • client: add wait for client disconnect (23a7b51)
  • client: create LEX object in constructor (b26dd36)
  • client: get soul from optionsGet (a722755)
  • client: handle optionsGet property in link class (a8c1436)
  • client: make disconnect async (0c3df5d)
  • client: pass optionsGet to subscribe request (ab2e002)
  • upgrade topgun-socket 1.4.2 -> 1.4.3 (a9c8034)
  • upgrade topgun-socket 1.4.4 -> 1.4.7 (329bc58)

Features

  • client: add client method to disconnect (25dbe99)
  • client: add passwordMaxLength option (d78561b)
  • client: the ability to set peer options by an object (0c53350)
  • server: add server methods to stop and check readiness (0f7201f)

1.2.4 (2023-05-29)

Bug Fixes

  • upgrade topgun-socket 1.4.3 -> 1.4.4 (2f1dd51)

1.2.3 (2023-05-29)

Bug Fixes

  • upgrade topgun-socket 1.4.2 -> 1.4.3 (4d0c1dd)

1.2.2 (2023-05-28)

Bug Fixes

1.2.1 (2023-05-28)

Bug Fixes

  • upgrade topgun-socket 1.3.3 -> 1.4.2 (62bbc75)

1.2.0 (2023-05-06)

Bug Fixes

  • client: fix value assignment to persistSession (ad534b6)
  • fix CRDT diff check (042a49a)

Features

  • client: listen data in user space before authorization (a353d6d)

1.1.2 (2023-05-03)

Bug Fixes

  • upgrade topgun-buffer 1.0.5 -> 1.0.6 (0515c23)
  • upgrade topgun-socket 1.3.2 -> 1.3.3 (8d2528a)

1.1.1 (2023-05-03)

Bug Fixes

  • add missing Buffer import (5e308e9)
  • sea: fix Buffer typings (eab2f6a)
  • upgrade topgun-buffer 1.0.3 -> 1.0.5 (2602c7e)
  • upgrade topgun-socket 1.3.1 -> 1.3.2 (e70a35a)

1.1.0 (2023-05-01)

Bug Fixes

  • bump topgun-socket version, update server, add example server (0e944d2)
  • use topgun-typed instead of ajv (1bd3aa0)

Features

  • add port to TGServerOptions (cf5c3ce)

1.0.4 (2023-04-18)

Bug Fixes

  • bump topgun-socket 1.2.2 -> 1.2.3 (95c50f6)
  • export SEA methods from client (4c4d3fb)
  • set splitting to false (76e9d46)

1.0.3 (2023-04-18)

Bug Fixes

  • add topgun-buffer, upgrade deps, add examples folder (2f00aa4)
  • bump topgun-socket 1.1.10 -> 1.1.11 (c6eec0f)
  • update "exports" in package.json (80eaff7)
  • upgrade deps (09daf8d)

1.0.2 (2023-04-13)

Bug Fixes

  • client: return graph key in put callback (f68a810)

1.0.1 (2023-04-13)

Bug Fixes

  • using topgun-webcrypto instead of @peculiar/webcrypto for isomorphic support (b2444e3)

1.0.0 (2023-04-13)

Bug Fixes

  • client: fix options type (dd93706)

Features

  • add simple-git-hooks with "pre-commit" hook (5214f25)