diff --git a/apps/simplex-chat/Main.hs b/apps/simplex-chat/Main.hs
index 821bc2a270..246c95e28f 100644
--- a/apps/simplex-chat/Main.hs
+++ b/apps/simplex-chat/Main.hs
@@ -3,6 +3,7 @@
module Main where
import Control.Concurrent (threadDelay)
+import Server
import Simplex.Chat.Controller (versionNumber)
import Simplex.Chat.Core
import Simplex.Chat.Options
@@ -14,12 +15,15 @@ import System.Terminal (withTerminal)
main :: IO ()
main = do
appDir <- getAppUserDataDirectory "simplex"
- opts@ChatOpts {chatCmd} <- getChatOpts appDir "simplex_v1"
+ opts@ChatOpts {chatCmd, chatServerPort} <- getChatOpts appDir "simplex_v1"
if null chatCmd
- then do
- welcome opts
- t <- withTerminal pure
- simplexChatTerminal terminalChatConfig opts t
+ then case chatServerPort of
+ Just chatPort ->
+ simplexChatServer defaultChatServerConfig {chatPort} terminalChatConfig opts
+ _ -> do
+ welcome opts
+ t <- withTerminal pure
+ simplexChatTerminal terminalChatConfig opts t
else simplexChatCore terminalChatConfig opts Nothing $ \_ cc -> do
r <- sendChatCmd cc chatCmd
putStrLn $ serializeChatResponse r
diff --git a/apps/simplex-chat/Server.hs b/apps/simplex-chat/Server.hs
new file mode 100644
index 0000000000..481e03b01e
--- /dev/null
+++ b/apps/simplex-chat/Server.hs
@@ -0,0 +1,105 @@
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE NamedFieldPuns #-}
+{-# LANGUAGE OverloadedStrings #-}
+
+module Server where
+
+import Control.Monad.Except
+import Control.Monad.Reader
+import Data.Aeson (FromJSON, ToJSON)
+import qualified Data.Aeson as J
+import Data.Text (Text)
+import Data.Text.Encoding (encodeUtf8)
+import GHC.Generics (Generic)
+import Network.Socket
+import qualified Network.WebSockets as WS
+import Numeric.Natural (Natural)
+import Simplex.Chat
+import Simplex.Chat.Controller
+import Simplex.Chat.Core
+import Simplex.Chat.Options
+import Simplex.Messaging.Transport.Server (runTCPServer)
+import Simplex.Messaging.Util (raceAny_)
+import UnliftIO.Exception
+import UnliftIO.STM
+
+simplexChatServer :: ChatServerConfig -> ChatConfig -> ChatOpts -> IO ()
+simplexChatServer srvCfg cfg opts =
+ simplexChatCore cfg opts Nothing . const $ runChatServer srvCfg
+
+data ChatServerConfig = ChatServerConfig
+ { chatPort :: ServiceName,
+ clientQSize :: Natural
+ }
+
+defaultChatServerConfig :: ChatServerConfig
+defaultChatServerConfig =
+ ChatServerConfig
+ { chatPort = "5225",
+ clientQSize = 1
+ }
+
+data ChatSrvRequest = ChatSrvRequest {corrId :: Text, cmd :: Text}
+ deriving (Generic, FromJSON)
+
+data ChatSrvResponse = ChatSrvResponse {corrId :: Maybe Text, resp :: ChatResponse}
+ deriving (Generic)
+
+instance ToJSON ChatSrvResponse where
+ toEncoding = J.genericToEncoding J.defaultOptions {J.omitNothingFields = True}
+ toJSON = J.genericToJSON J.defaultOptions {J.omitNothingFields = True}
+
+data ChatClient = ChatClient
+ { rcvQ :: TBQueue (Text, ChatCommand),
+ sndQ :: TBQueue ChatSrvResponse
+ }
+
+newChatServerClient :: Natural -> STM ChatClient
+newChatServerClient qSize = do
+ rcvQ <- newTBQueue qSize
+ sndQ <- newTBQueue qSize
+ pure ChatClient {rcvQ, sndQ}
+
+runChatServer :: ChatServerConfig -> ChatController -> IO ()
+runChatServer ChatServerConfig {chatPort, clientQSize} cc = do
+ started <- newEmptyTMVarIO
+ runTCPServer started chatPort $ \sock -> do
+ ws <- liftIO $ getConnection sock
+ c <- atomically $ newChatServerClient clientQSize
+ putStrLn "client connected"
+ raceAny_ [send ws c, client c, output c, receive ws c]
+ `finally` clientDisconnected c
+ where
+ getConnection sock = WS.makePendingConnection sock WS.defaultConnectionOptions >>= WS.acceptRequest
+ send ws ChatClient {sndQ} =
+ forever $
+ atomically (readTBQueue sndQ) >>= WS.sendTextData ws . J.encode
+ client ChatClient {rcvQ, sndQ} = forever $ do
+ atomically (readTBQueue rcvQ)
+ >>= processCommand
+ >>= atomically . writeTBQueue sndQ
+ output ChatClient {sndQ} = forever $ do
+ (_, resp) <- atomically . readTBQueue $ outputQ cc
+ atomically $ writeTBQueue sndQ ChatSrvResponse {corrId = Nothing, resp}
+ receive ws ChatClient {rcvQ, sndQ} = forever $ do
+ s <- WS.receiveData ws
+ case J.decodeStrict' s of
+ Just ChatSrvRequest {corrId, cmd} -> do
+ putStrLn $ "received command " <> show corrId <> " : " <> show cmd
+ case parseChatCommand $ encodeUtf8 cmd of
+ Right command -> atomically $ writeTBQueue rcvQ (corrId, command)
+ Left e -> sendError (Just corrId) e
+ Nothing -> sendError Nothing "invalid request"
+ where
+ sendError corrId e = atomically $ writeTBQueue sndQ ChatSrvResponse {corrId, resp = chatCmdError e}
+ processCommand (corrId, cmd) =
+ runReaderT (runExceptT $ processChatCommand cmd) cc >>= \case
+ Right resp -> response resp
+ Left e -> response $ CRChatCmdError e
+ where
+ response resp = pure ChatSrvResponse {corrId = Just corrId, resp}
+ clientDisconnected _ = pure ()
diff --git a/package.yaml b/package.yaml
index f9a05bfc5c..784ba532af 100644
--- a/package.yaml
+++ b/package.yaml
@@ -48,6 +48,8 @@ executables:
main: Main.hs
dependencies:
- simplex-chat
+ - network == 3.1.*
+ - websockets == 0.12.*
ghc-options:
- -threaded
diff --git a/packages/simplex-chat-client/typescript/.eslintrc.yml b/packages/simplex-chat-client/typescript/.eslintrc.yml
new file mode 100644
index 0000000000..535594da02
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/.eslintrc.yml
@@ -0,0 +1,71 @@
+env:
+ node: true
+parser: "@typescript-eslint/parser"
+parserOptions:
+ project: [./tsconfig.json]
+plugins: ["@typescript-eslint"]
+extends:
+ - eslint:recommended
+ - plugin:@typescript-eslint/recommended
+ - plugin:@typescript-eslint/recommended-requiring-type-checking
+ - prettier
+rules:
+ block-scoped-var: error
+ callback-return: error
+ curly: [error, multi-line, consistent]
+ dot-location: [error, property]
+ eqeqeq: [error, smart]
+ id-match: error
+ linebreak-style: [error, unix]
+ new-cap: error
+ no-console: off
+ no-debugger: error
+ no-else-return: error
+ no-eq-null: error
+ no-eval: error
+ no-fallthrough: error
+ no-new-wrappers: error
+ no-path-concat: error
+ no-redeclare: error
+ no-return-assign: error
+ no-sequences: error
+ no-template-curly-in-string: error
+ no-trailing-spaces: error
+ no-undef-init: error
+ prefer-arrow-callback: error
+ prefer-const: error
+ prefer-destructuring: [warn, VariableDeclarator: {object: true}]
+ radix: error
+ semi: off
+ valid-jsdoc: [error, requireReturn: false]
+ no-useless-escape: error
+ no-void: error
+ no-var: error
+ "@typescript-eslint/array-type": error
+ "@typescript-eslint/consistent-type-assertions": error
+ "@typescript-eslint/consistent-type-definitions": error
+ no-duplicate-imports: off
+ # "@typescript-eslint/consistent-type-imports": error # temporarily removed from eslint
+ "@typescript-eslint/default-param-last": error
+ dot-notation: off
+ "@typescript-eslint/dot-notation": error
+ "@typescript-eslint/no-empty-function": off
+ "@typescript-eslint/no-empty-interface": off
+ "@typescript-eslint/explicit-function-return-type": [error, allowExpressions: true]
+ "@typescript-eslint/explicit-member-accessibility": [error, accessibility: no-public]
+ "@typescript-eslint/no-extraneous-class": error
+ no-invalid-this: off
+ "@typescript-eslint/no-invalid-this": error
+ "@typescript-eslint/no-misused-new": error
+ "@typescript-eslint/no-shadow": warn
+ "@typescript-eslint/no-unused-expressions": error
+ "@typescript-eslint/no-unused-vars": [error, argsIgnorePattern: ^_]
+ "@typescript-eslint/prefer-function-type": error
+ "@typescript-eslint/prefer-includes": error
+ "@typescript-eslint/prefer-readonly": error
+ "@typescript-eslint/require-array-sort-compare": [error, ignoreStringArrays: true]
+ "@typescript-eslint/unified-signatures": error
+ "@typescript-eslint/no-unnecessary-condition": [error, allowConstantLoopConditions: true]
+ "@typescript-eslint/no-var-requires": off
+ "@typescript-eslint/restrict-template-expressions": off
+ "@typescript-eslint/no-explicit-any": off
diff --git a/packages/simplex-chat-client/typescript/.gitignore b/packages/simplex-chat-client/typescript/.gitignore
new file mode 100644
index 0000000000..7481e30d5a
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+package-lock.json
+dist
+coverage
diff --git a/packages/simplex-chat-client/typescript/.prettierignore b/packages/simplex-chat-client/typescript/.prettierignore
new file mode 100644
index 0000000000..009af5438f
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/.prettierignore
@@ -0,0 +1,2 @@
+dist
+coverage
diff --git a/packages/simplex-chat-client/typescript/.prettierrc.json b/packages/simplex-chat-client/typescript/.prettierrc.json
new file mode 100644
index 0000000000..cadbab25e3
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/.prettierrc.json
@@ -0,0 +1,5 @@
+{
+ "bracketSpacing": false,
+ "semi": false,
+ "printWidth": 140
+}
diff --git a/packages/simplex-chat-client/typescript/LICENSE b/packages/simplex-chat-client/typescript/LICENSE
new file mode 100644
index 0000000000..0ad25db4bd
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/LICENSE
@@ -0,0 +1,661 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+.
diff --git a/packages/simplex-chat-client/typescript/README.md b/packages/simplex-chat-client/typescript/README.md
new file mode 100644
index 0000000000..2aacf3ba01
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/README.md
@@ -0,0 +1,23 @@
+# SimpleX Chat JavaScript client
+
+## Quick start
+
+```
+npm i simplex-chat
+```
+
+See example of chat bot in [squaring-bot.js](./examples/squaring-bot.js)
+
+## Documentation
+
+Please refer to:
+
+- available client API - [client.ts](./src/client.ts).
+- available commands - `ChatCommand` type in [command.ts](./src/command.ts) - if some command is not created as a ChatClient method, you can pass any command object to `sendChatCommand` method, or if the type for some command is not available you can pass command string (same strings as supported in terminal/mobile API) to `sendChatCmdStr` method.
+- available chat messages - `ChatResponse` type in [response.ts](./src/command.ts).
+
+**Please note**: you should NOT use local display names that are supported in terminal app, as they can change when contact profile is updated and you can have race conditions - use commands that use chat IDs.
+
+## Lisense
+
+[AGPL v3](./LICENSE)
diff --git a/packages/simplex-chat-client/typescript/copy b/packages/simplex-chat-client/typescript/copy
new file mode 100755
index 0000000000..0af4fb3376
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/copy
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# it can be tested in the browser from dist folder
+cp ./src/test.html ./dist/test.html
diff --git a/packages/simplex-chat-client/typescript/examples/squaring-bot.js b/packages/simplex-chat-client/typescript/examples/squaring-bot.js
new file mode 100644
index 0000000000..79b6dae709
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/examples/squaring-bot.js
@@ -0,0 +1,50 @@
+const {ChatClient} = require("..")
+const {ChatType} = require("../dist/command")
+const {ciContentText, ChatInfoType} = require("../dist/response")
+
+run()
+
+async function run() {
+ const chat = await ChatClient.create("ws://localhost:5225")
+ const user = await chat.apiGetActiveUser()
+ if (!user) {
+ console.log("no user profile")
+ return
+ }
+ console.log(`Bot profile: ${user.profile.displayName} (${user.profile.fullName})`)
+ const address = (await chat.apiGetUserAddress()) || (await chat.apiCreateUserAddress())
+ console.log(`Bot address: ${address}`)
+ await chat.sendChatCmdStr("/auto_accept on")
+ await processMessages(chat)
+
+ async function processMessages(chat) {
+ for await (const r of chat.msgQ) {
+ const resp = r instanceof Promise ? await r : r
+ switch (resp.type) {
+ case "contactConnected": {
+ const {contact} = resp
+ console.log(`${contact.profile.displayName} connected`)
+ await chat.apiSendTextMessage(
+ ChatType.Direct,
+ contact.contactId,
+ "Hello! I am a simple squaring bot - if you send me a number, I will calculate its square"
+ )
+ continue
+ }
+ case "newChatItem": {
+ const {chatInfo} = resp.chatItem
+ if (chatInfo.type !== ChatInfoType.Direct) continue
+ const msg = ciContentText(resp.chatItem.chatItem.content)
+ let reply
+ if (msg) {
+ const n = +msg
+ reply = typeof n === "number" ? `${n} * ${n} = ${n * n}` : `${n} is not a number`
+ } else {
+ reply = "no message text"
+ }
+ await chat.apiSendTextMessage(ChatType.Direct, chatInfo.contact.contactId, reply)
+ }
+ }
+ }
+ }
+}
diff --git a/packages/simplex-chat-client/typescript/jest.config.js b/packages/simplex-chat-client/typescript/jest.config.js
new file mode 100644
index 0000000000..f2c133f29d
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/jest.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+ preset: "ts-jest",
+ testEnvironment: "node",
+}
diff --git a/packages/simplex-chat-client/typescript/package.json b/packages/simplex-chat-client/typescript/package.json
new file mode 100644
index 0000000000..c93f46ef6f
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/package.json
@@ -0,0 +1,61 @@
+{
+ "name": "simplex-chat",
+ "version": "0.1.0",
+ "description": "SimpleX Chat client",
+ "main": "dist/index.js",
+ "types": "dist/index.d.ts",
+ "files": [
+ "dist"
+ ],
+ "scripts": {
+ "test": "npm run prettier:check && npm run eslint && jest --coverage",
+ "build": "npm run prettier:write && npm run eslint && tsc && ./copy && npm run bundle",
+ "bundle": "rollup dist/index-web.js --file dist/index.bundle.js --format umd --name simplex",
+ "eslint": "eslint --ext .ts ./src/**/*.ts",
+ "prettier:write": "prettier --write './**/*.{json,yaml,js,ts}'",
+ "prettier:check": "prettier --list-different './**/*.{json,yaml,js,ts}'"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/simplex-chat/simplex-chat.git"
+ },
+ "keywords": [
+ "messenger",
+ "chat",
+ "privacy",
+ "security"
+ ],
+ "author": "SimpleX Chat",
+ "license": "AGPL-3.0",
+ "bugs": {
+ "url": "https://github.com/simplex-chat/simplex-chat/issues"
+ },
+ "homepage": "https://github.com/simplex-chat/simplex-chat/packages/simplex-chat-client/typescript#readme",
+ "dependencies": {
+ "isomorphic-ws": "^4.0.1"
+ },
+ "devDependencies": {
+ "@types/jest": "^27.5.1",
+ "@types/node": "^17.0.24",
+ "@typescript-eslint/eslint-plugin": "^5.23.0",
+ "@typescript-eslint/parser": "^5.23.0",
+ "eslint": "^8.15.0",
+ "eslint-config-prettier": "^8.5.0",
+ "husky": "^7.0.4",
+ "jest": "^28.1.0",
+ "lint-staged": "^12.3.8",
+ "prettier": "^2.6.2",
+ "rollup": "^2.72.1",
+ "ts-jest": "^28.0.2",
+ "ts-node": "^10.7.0",
+ "typescript": "^4.6.3"
+ },
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged"
+ }
+ },
+ "lint-staged": {
+ "**/*": "prettier --write --ignore-unknown"
+ }
+}
diff --git a/packages/simplex-chat-client/typescript/src/client.ts b/packages/simplex-chat-client/typescript/src/client.ts
new file mode 100644
index 0000000000..825a081429
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/client.ts
@@ -0,0 +1,257 @@
+import {ABQueue} from "./queue"
+import {ChatTransport, ChatServer, ChatSrvRequest, ChatSrvResponse, ChatResponseError, localServer, noop} from "./transport"
+import {ChatCommand, ChatType} from "./command"
+import {ChatResponse} from "./response"
+import * as CC from "./command"
+import * as CR from "./response"
+
+export interface ChatClientConfig {
+ readonly qSize: number
+ readonly tcpTimeout: number
+}
+
+export interface Request {
+ readonly resolve: (resp: ChatResponse) => void
+ readonly reject: (err?: ChatResponseError | CR.CRChatCmdError) => void
+}
+
+export class ChatCommandError extends Error {
+ constructor(public message: string, public response: ChatResponse) {
+ super(message)
+ }
+}
+
+export enum ConnReqType {
+ Invitation = "invitation",
+ Contact = "contact",
+}
+
+export class ChatClient {
+ private _connected = true
+ private clientCorrId = 0
+ private readonly sentCommands = new Map()
+
+ static defaultConfig: ChatClientConfig = {
+ qSize: 16,
+ tcpTimeout: 4000,
+ }
+
+ private constructor(
+ readonly server: ChatServer | string,
+ readonly config: ChatClientConfig,
+ readonly msgQ: ABQueue,
+ readonly client: Promise,
+ private readonly transport: ChatTransport
+ ) {}
+
+ static async create(server: ChatServer | string = localServer, cfg: ChatClientConfig = ChatClient.defaultConfig): Promise {
+ const transport = await ChatTransport.connect(server, cfg.tcpTimeout, cfg.qSize)
+ const msgQ = new ABQueue(cfg.qSize)
+ const client = runClient().then(noop, noop)
+ const c = new ChatClient(server, cfg, msgQ, client, transport)
+ return c
+
+ async function runClient(): Promise {
+ for await (const t of transport) {
+ const apiResp = (t instanceof Promise ? await t : t) as ChatSrvResponse | ChatResponseError
+ if (apiResp instanceof ChatResponseError) {
+ console.log("chat response error: ", apiResp)
+ } else {
+ const {corrId, resp} = apiResp
+ if (corrId) {
+ const req = c.sentCommands.get(corrId)
+ if (req) {
+ c.sentCommands.delete(corrId)
+ req.resolve(resp)
+ } else {
+ // TODO send error to errQ?
+ console.log("no command sent for chat response: ", apiResp)
+ }
+ } else {
+ await msgQ.enqueue(resp)
+ }
+ }
+ }
+ c._connected = false
+ }
+ }
+
+ sendChatCmdStr(cmd: string): Promise {
+ const corrId = `${++this.clientCorrId}`
+ const t: ChatSrvRequest = {corrId, cmd}
+ this.transport.write(t).then(noop, noop)
+ return new Promise((resolve, reject) => this.sentCommands.set(corrId, {resolve, reject}))
+ }
+
+ sendChatCommand(command: ChatCommand): Promise {
+ return this.sendChatCmdStr(CC.cmdString(command))
+ }
+
+ async disconnect(): Promise {
+ await this.transport.close()
+ await this.client
+ }
+
+ async apiGetActiveUser(): Promise {
+ const r = await this.sendChatCommand({type: "showActiveUser"})
+ switch (r.type) {
+ case "activeUser":
+ return r.user
+ case "chatCmdError":
+ if (r.chatError.type === "error" && r.chatError.errorType.type === "noActiveUser") return undefined
+ throw new ChatCommandError("unexpected response error", r)
+ default:
+ throw new ChatCommandError("unexpected response", r)
+ }
+ }
+
+ async apiCreateActiveUser(profile: CC.Profile): Promise {
+ const r = await this.sendChatCommand({type: "createActiveUser", profile})
+ if (r.type === "activeUser") return r.user
+ throw new ChatCommandError("unexpected response", r)
+ }
+
+ async apiStartChat(): Promise {
+ const r = await this.sendChatCommand({type: "startChat"})
+ if (r.type !== "chatStarted" && r.type !== "chatRunning") {
+ throw new ChatCommandError("error starting chat", r)
+ }
+ }
+
+ async apiGetChats(): Promise {
+ const r = await this.sendChatCommand({type: "apiGetChats"})
+ if (r.type === "apiChats") return r.chats
+ throw new ChatCommandError("error loading chats", r)
+ }
+
+ async apiGetChat(chatType: ChatType, chatId: number, pagination: CC.ChatPagination = {count: 100}): Promise {
+ const r = await this.sendChatCommand({type: "apiGetChat", chatType, chatId, pagination})
+ if (r.type === "apiChat") return r.chat
+ throw new ChatCommandError("error loading chat", r)
+ }
+
+ async apiSendMessage(chatType: ChatType, chatId: number, message: CC.ComposedMessage): Promise {
+ const r = await this.sendChatCommand({type: "apiSendMessage", chatType, chatId, message})
+ if (r.type === "newChatItem") return r.chatItem
+ throw new ChatCommandError("unexpected response", r)
+ }
+
+ apiSendTextMessage(chatType: ChatType, chatId: number, text: string): Promise {
+ return this.apiSendMessage(chatType, chatId, {msgContent: {type: "text", text}})
+ }
+
+ async apiUpdateChatItem(chatType: ChatType, chatId: number, chatItemId: CC.ChatItemId, msgContent: CC.MsgContent): Promise {
+ const r = await this.sendChatCommand({type: "apiUpdateChatItem", chatType, chatId, chatItemId, msgContent})
+ if (r.type === "chatItemUpdated") return r.chatItem.chatItem
+ throw new ChatCommandError("error updating chat item", r)
+ }
+
+ async apiDeleteChatItem(chatType: ChatType, chatId: number, chatItemId: number, deleteMode: CC.DeleteMode): Promise {
+ const r = await this.sendChatCommand({type: "apiDeleteChatItem", chatType, chatId, chatItemId, deleteMode})
+ if (r.type === "chatItemDeleted") return r.toChatItem.chatItem
+ throw new ChatCommandError("error deleting chat item", r)
+ }
+
+ // func getUserSMPServers() throws -> [String] {
+ // let r = chatSendCmdSync(.getUserSMPServers)
+ // if case let .userSMPServers(smpServers) = r { return smpServers }
+ // throw r
+ // }
+
+ // func setUserSMPServers(smpServers: [String]) async throws {
+ // let r = await chatSendCmd(.setUserSMPServers(smpServers: smpServers))
+ // if case .cmdOk = r { return }
+ // throw r
+ // }
+
+ async apiCreateLink(): Promise {
+ const r = await this.sendChatCommand({type: "addContact"})
+ if (r.type === "invitation") return r.connReqInvitation
+ throw new ChatCommandError("error creating link", r)
+ }
+
+ async apiConnect(connReq: string): Promise {
+ const r = await this.sendChatCommand({type: "connect", connReq})
+ switch (r.type) {
+ case "sentConfirmation":
+ return ConnReqType.Invitation
+ case "sentInvitation":
+ return ConnReqType.Contact
+ default:
+ throw new ChatCommandError("connection error", r)
+ }
+ }
+
+ async apiDeleteChat(chatType: ChatType, chatId: number): Promise {
+ const r = await this.sendChatCommand({type: "apiDeleteChat", chatType, chatId})
+ if (r.type !== "contactDeleted") throw new ChatCommandError("error deleting chat", r)
+ }
+
+ async apiUpdateProfile(profile: CC.Profile): Promise {
+ const r = await this.sendChatCommand({type: "apiUpdateProfile", profile})
+ switch (r.type) {
+ case "userProfileNoChange":
+ return undefined
+ case "userProfileUpdated":
+ return r.toProfile
+ default:
+ throw new ChatCommandError("error updating profile", r)
+ }
+ }
+
+ // func apiParseMarkdown(text: String) throws -> [FormattedText]? {
+ // let r = chatSendCmdSync(.apiParseMarkdown(text: text))
+ // if case let .apiParsedMarkdown(formattedText) = r { return formattedText }
+ // throw r
+ // }
+
+ async apiCreateUserAddress(): Promise {
+ const r = await this.sendChatCommand({type: "createMyAddress"})
+ if (r.type === "userContactLinkCreated") return r.connReqContact
+ throw new ChatCommandError("error creating user address", r)
+ }
+
+ async apiDeleteUserAddress(): Promise {
+ const r = await this.sendChatCommand({type: "deleteMyAddress"})
+ if (r.type === "userContactLinkDeleted") return
+ throw new ChatCommandError("error deleting user address", r)
+ }
+
+ async apiGetUserAddress(): Promise {
+ const r = await this.sendChatCommand({type: "showMyAddress"})
+ switch (r.type) {
+ case "userContactLink":
+ return r.connReqContact
+ default:
+ if (r.type === "chatCmdError" && r.chatError.type === "errorStore" && r.chatError.storeError.type === "userContactLinkNotFound") {
+ return undefined
+ }
+ throw new ChatCommandError("error loading user address", r)
+ }
+ }
+
+ async apiAcceptContactRequest(contactReqId: number): Promise {
+ const r = await this.sendChatCommand({type: "apiAcceptContact", contactReqId})
+ if (r.type === "acceptingContactRequest") return r.contact
+ throw new ChatCommandError("error accepting contact request", r)
+ }
+
+ async apiRejectContactRequest(contactReqId: number): Promise {
+ const r = await this.sendChatCommand({type: "apiRejectContact", contactReqId})
+ if (r.type === "contactRequestRejected") return
+ throw new ChatCommandError("error rejecting contact request", r)
+ }
+
+ apiChatRead(chatType: ChatType, chatId: number, itemRange?: CC.ItemRange): Promise {
+ return this.okChatCommand({type: "apiChatRead", chatType, chatId, itemRange})
+ }
+
+ private async okChatCommand(command: ChatCommand): Promise {
+ const r = await this.sendChatCommand(command)
+ if (r.type !== "cmdOk") throw new ChatCommandError(`${command.type} command error`, r)
+ }
+
+ get connected(): boolean {
+ return this._connected
+ }
+}
diff --git a/packages/simplex-chat-client/typescript/src/command.ts b/packages/simplex-chat-client/typescript/src/command.ts
new file mode 100644
index 0000000000..3266bf3456
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/command.ts
@@ -0,0 +1,292 @@
+export type ChatCommand =
+ | ShowActiveUser
+ | CreateActiveUser
+ | StartChat
+ | SetFilesFolder
+ | APIGetChats
+ | APIGetChat
+ | APISendMessage
+ | APIUpdateChatItem
+ | APIDeleteChatItem
+ | APIChatRead
+ | APIDeleteChat
+ | APIAcceptContact
+ | APIRejectContact
+ | APIUpdateProfile
+ | APIParseMarkdown
+ | GetUserSMPServers
+ | SetUserSMPServers
+ | AddContact
+ | Connect
+ | ConnectSimplex
+ | CreateMyAddress
+ | DeleteMyAddress
+ | ShowMyAddress
+ | AddressAutoAccept
+
+type ChatCommandTag =
+ | "showActiveUser"
+ | "createActiveUser"
+ | "startChat"
+ | "setFilesFolder"
+ | "apiGetChats"
+ | "apiGetChat"
+ | "apiSendMessage"
+ | "apiUpdateChatItem"
+ | "apiDeleteChatItem"
+ | "apiChatRead"
+ | "apiDeleteChat"
+ | "apiAcceptContact"
+ | "apiRejectContact"
+ | "apiUpdateProfile"
+ | "apiParseMarkdown"
+ | "getUserSMPServers"
+ | "setUserSMPServers"
+ | "addContact"
+ | "connect"
+ | "connectSimplex"
+ | "createMyAddress"
+ | "deleteMyAddress"
+ | "showMyAddress"
+ | "addressAutoAccept"
+
+interface IChatCommand {
+ type: ChatCommandTag
+}
+
+export interface ShowActiveUser extends IChatCommand {
+ type: "showActiveUser"
+}
+
+export interface CreateActiveUser extends IChatCommand {
+ type: "createActiveUser"
+ profile: Profile
+}
+
+export interface StartChat extends IChatCommand {
+ type: "startChat"
+}
+
+export interface SetFilesFolder extends IChatCommand {
+ type: "setFilesFolder"
+ filePath: string
+}
+
+export interface APIGetChats extends IChatCommand {
+ type: "apiGetChats"
+}
+
+export interface APIGetChat extends IChatCommand {
+ type: "apiGetChat"
+ chatType: ChatType
+ chatId: number
+ pagination: ChatPagination
+}
+
+export interface APISendMessage extends IChatCommand {
+ type: "apiSendMessage"
+ chatType: ChatType
+ chatId: number
+ message: ComposedMessage
+}
+
+export interface ComposedMessage {
+ filePath?: string
+ quotedItemId?: ChatItemId
+ msgContent: MsgContent
+}
+
+export interface APIUpdateChatItem extends IChatCommand {
+ type: "apiUpdateChatItem"
+ chatType: ChatType
+ chatId: number
+ chatItemId: ChatItemId
+ msgContent: MsgContent
+}
+
+export interface APIDeleteChatItem extends IChatCommand {
+ type: "apiDeleteChatItem"
+ chatType: ChatType
+ chatId: number
+ chatItemId: ChatItemId
+ deleteMode: DeleteMode
+}
+
+export interface APIChatRead extends IChatCommand {
+ type: "apiChatRead"
+ chatType: ChatType
+ chatId: number
+ itemRange?: ItemRange
+}
+
+export interface ItemRange {
+ fromItem: ChatItemId
+ toItem: ChatItemId
+}
+
+export interface APIDeleteChat extends IChatCommand {
+ type: "apiDeleteChat"
+ chatType: ChatType
+ chatId: number
+}
+
+export interface APIAcceptContact extends IChatCommand {
+ type: "apiAcceptContact"
+ contactReqId: number
+}
+
+export interface APIRejectContact extends IChatCommand {
+ type: "apiRejectContact"
+ contactReqId: number
+}
+
+export interface APIUpdateProfile extends IChatCommand {
+ type: "apiUpdateProfile"
+ profile: Profile
+}
+
+export interface APIParseMarkdown extends IChatCommand {
+ type: "apiParseMarkdown"
+ text: string
+}
+
+export interface GetUserSMPServers extends IChatCommand {
+ type: "getUserSMPServers"
+}
+
+export interface SetUserSMPServers extends IChatCommand {
+ type: "setUserSMPServers"
+ servers: [string]
+}
+
+export interface AddContact extends IChatCommand {
+ type: "addContact"
+}
+
+export interface Connect extends IChatCommand {
+ type: "connect"
+ connReq: string
+}
+
+export interface ConnectSimplex extends IChatCommand {
+ type: "connectSimplex"
+}
+
+export interface CreateMyAddress extends IChatCommand {
+ type: "createMyAddress"
+}
+
+export interface DeleteMyAddress extends IChatCommand {
+ type: "deleteMyAddress"
+}
+
+export interface ShowMyAddress extends IChatCommand {
+ type: "showMyAddress"
+}
+
+export interface AddressAutoAccept extends IChatCommand {
+ type: "addressAutoAccept"
+ enable: boolean
+}
+
+export interface Profile {
+ displayName: string
+ fullName: string // can be empty string
+ image?: string
+}
+
+export enum ChatType {
+ Direct = "@",
+ Group = "#",
+ ContactRequest = "<@",
+}
+
+export type ChatPagination =
+ | {count: number} // count from the last item in case neither after nor before specified
+ | {count: number; after: ChatItemId}
+ | {count: number; before: ChatItemId}
+
+export type ChatItemId = number
+
+type MsgContentTag = "text" | "link" | "images"
+
+export type MsgContent = MCText | MCUnknown
+
+interface MC {
+ type: MsgContentTag
+}
+
+interface MCText extends MC {
+ type: "text"
+ text: string
+}
+
+interface MCUnknown {
+ type: string
+ text?: string
+}
+
+export enum DeleteMode {
+ Broadcast = "broadcast",
+ Internal = "internal",
+}
+
+export function cmdString(cmd: ChatCommand): string {
+ switch (cmd.type) {
+ case "showActiveUser":
+ return "/u"
+ case "createActiveUser":
+ return `/u ${JSON.stringify(cmd.profile)}`
+ case "startChat":
+ return "/_start"
+ case "setFilesFolder":
+ return `/_files_folder ${cmd.filePath}`
+ case "apiGetChats":
+ return "/_get chats"
+ case "apiGetChat":
+ return `/_get chat ${cmd.chatType}${cmd.chatId}${paginationStr(cmd.pagination)}`
+ case "apiSendMessage":
+ return `/_send ${cmd.chatType}${cmd.chatId} json ${JSON.stringify(cmd.message)}`
+ case "apiUpdateChatItem":
+ return `/_update item ${cmd.chatType}${cmd.chatId} ${cmd.chatItemId} json ${JSON.stringify(cmd.msgContent)}`
+ case "apiDeleteChatItem":
+ return `/_delete item ${cmd.chatType}${cmd.chatId} ${cmd.chatItemId} ${cmd.deleteMode}`
+ case "apiChatRead": {
+ const itemRange = cmd.itemRange ? ` from=${cmd.itemRange.fromItem} to=${cmd.itemRange.toItem}` : ""
+ return `/_read chat ${cmd.chatType}${cmd.chatId}${itemRange}`
+ }
+ case "apiDeleteChat":
+ return `/_delete ${cmd.chatType}${cmd.chatId}`
+ case "apiAcceptContact":
+ return `/_accept ${cmd.contactReqId}`
+ case "apiRejectContact":
+ return `/_reject ${cmd.contactReqId}`
+ case "apiUpdateProfile":
+ return `/_profile ${JSON.stringify(cmd.profile)}`
+ case "apiParseMarkdown":
+ return `/_parse ${cmd.text}`
+ case "getUserSMPServers":
+ return "/smp_servers"
+ case "setUserSMPServers":
+ return `/smp_servers ${cmd.servers.join(",") || "default"}`
+ case "addContact":
+ return "/connect"
+ case "connect":
+ return `/connect ${cmd.connReq}`
+ case "connectSimplex":
+ return "/simplex"
+ case "createMyAddress":
+ return "/address"
+ case "deleteMyAddress":
+ return "/delete_address"
+ case "showMyAddress":
+ return "/show_address"
+ case "addressAutoAccept":
+ return `/auto_accept ${cmd.enable ? "on" : "off"}`
+ }
+}
+
+function paginationStr(cp: ChatPagination): string {
+ const base = "after" in cp ? ` after=${cp.after}` : "before" in cp ? ` before=${cp.before}` : ""
+ return base + ` count=${cp.count}`
+}
diff --git a/packages/simplex-chat-client/typescript/src/index-web.ts b/packages/simplex-chat-client/typescript/src/index-web.ts
new file mode 100644
index 0000000000..33cf2525d3
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/index-web.ts
@@ -0,0 +1 @@
+export {ChatClient} from "./client"
diff --git a/packages/simplex-chat-client/typescript/src/index.ts b/packages/simplex-chat-client/typescript/src/index.ts
new file mode 100644
index 0000000000..cb70f602dc
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/index.ts
@@ -0,0 +1,2 @@
+import "./websocket"
+export {ChatClient} from "./client"
diff --git a/packages/simplex-chat-client/typescript/src/queue.ts b/packages/simplex-chat-client/typescript/src/queue.ts
new file mode 100644
index 0000000000..f685876aed
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/queue.ts
@@ -0,0 +1,80 @@
+class Sem {
+ private readonly promises: ((x: unknown) => void)[] = []
+
+ constructor(private permits: number) {}
+
+ signal(): void {
+ this.permits += 1
+ if (this.promises.length > 0) (this.promises.pop() as () => void)()
+ }
+
+ async wait(): Promise {
+ if (this.permits === 0 || this.promises.length > 0) {
+ await new Promise((r) => this.promises.unshift(r))
+ }
+ this.permits -= 1
+ }
+}
+
+export type NextIter = {value: T | Promise; done?: false} | {value?: undefined; done: true}
+
+const queueClosed = Symbol()
+
+type QueueItem = T | typeof queueClosed
+
+export class ABQueueError extends Error {}
+
+export class ABQueue {
+ private readonly queue: QueueItem[] = []
+ private readonly enq: Sem
+ private readonly deq: Sem
+ private enqClosed = false
+ private deqClosed = false
+
+ constructor(readonly maxSize: number) {
+ this.enq = new Sem(0)
+ this.deq = new Sem(maxSize)
+ }
+
+ [Symbol.asyncIterator](): ABQueue {
+ return this
+ }
+
+ enqueue(x: T): Promise {
+ return this._enqueue(x)
+ }
+
+ private async _enqueue(x: QueueItem): Promise {
+ if (this.enqClosed) throw new ABQueueError("enqueue: queue closed")
+ await this.deq.wait()
+ this.queue.push(x)
+ this.enq.signal()
+ }
+
+ async dequeue(): Promise {
+ if (this.deqClosed) throw new ABQueueError("dequeue: queue closed")
+ this.deq.signal()
+ await this.enq.wait()
+ const x = this.queue.shift() as QueueItem
+ if (x === queueClosed) {
+ this.deqClosed = true
+ throw new ABQueueError("dequeue: queue closed")
+ }
+ return x
+ }
+
+ async close(): Promise {
+ await this._enqueue(queueClosed)
+ this.enqClosed = true
+ }
+
+ async next(): Promise> {
+ if (this.deqClosed) return {done: true}
+ try {
+ return {value: await this.dequeue()}
+ } catch (e) {
+ if (e instanceof ABQueueError) return {done: true}
+ throw e
+ }
+ }
+}
diff --git a/packages/simplex-chat-client/typescript/src/response.ts b/packages/simplex-chat-client/typescript/src/response.ts
new file mode 100644
index 0000000000..6b10e865bb
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/response.ts
@@ -0,0 +1,591 @@
+import {ChatItemId, MsgContent, DeleteMode, Profile} from "./command"
+
+export type ChatResponse =
+ | CRActiveUser
+ | CRChatStarted
+ | CRChatRunning
+ | CRApiChats
+ | CRApiChat
+ | CRApiParsedMarkdown
+ | CRUserSMPServers
+ | CRNewChatItem
+ | CRChatItemStatusUpdated
+ | CRChatItemUpdated
+ | CRChatItemDeleted
+ | CRMsgIntegrityError
+ | CRCmdOk
+ | CRUserContactLink
+ | CRUserContactLinkUpdated
+ | CRContactRequestRejected
+ | CRUserProfile
+ | CRUserProfileNoChange
+ | CRUserProfileUpdated
+ | CRInvitation
+ | CRSentConfirmation
+ | CRSentInvitation
+ | CRContactUpdated
+ | CRContactDeleted
+ | CRUserContactLinkCreated
+ | CRUserContactLinkDeleted
+ | CRReceivedContactRequest
+ | CRAcceptingContactRequest
+ | CRContactAlreadyExists
+ | CRContactRequestAlreadyAccepted
+ | CRContactConnecting
+ | CRContactConnected
+ | CRContactAnotherClient
+ | CRContactDisconnected
+ | CRContactSubscribed
+ | CRContactSubError
+ | CRContactSubSummary
+ | CRGroupEmpty
+ | CRPendingSubSummary
+ | CRUserContactLinkSubscribed
+ | CRUserContactLinkSubError
+ | CRMessageError
+ | CRChatCmdError
+ | CRChatError
+
+type ChatResponseTag =
+ | "activeUser"
+ | "chatStarted"
+ | "chatRunning"
+ | "apiChats"
+ | "apiChat"
+ | "apiParsedMarkdown"
+ | "userSMPServers"
+ | "newChatItem"
+ | "chatItemStatusUpdated"
+ | "chatItemUpdated"
+ | "chatItemDeleted"
+ | "msgIntegrityError"
+ | "cmdOk"
+ | "userContactLink"
+ | "userContactLinkUpdated"
+ | "userContactLinkCreated"
+ | "userContactLinkDeleted"
+ | "contactRequestRejected"
+ | "userProfile"
+ | "userProfileNoChange"
+ | "userProfileUpdated"
+ | "invitation"
+ | "sentConfirmation"
+ | "sentInvitation"
+ | "contactUpdated"
+ | "contactDeleted"
+ | "receivedContactRequest"
+ | "acceptingContactRequest"
+ | "contactAlreadyExists"
+ | "contactRequestAlreadyAccepted"
+ | "contactConnecting"
+ | "contactConnected"
+ | "contactAnotherClient"
+ | "contactDisconnected"
+ | "contactSubscribed"
+ | "contactSubError"
+ | "contactSubSummary"
+ | "groupEmpty"
+ | "pendingSubSummary"
+ | "userContactLinkSubscribed"
+ | "userContactLinkSubError"
+ | "messageError"
+ | "chatCmdError"
+ | "chatError"
+
+interface CR {
+ type: ChatResponseTag
+}
+
+export interface CRActiveUser extends CR {
+ type: "activeUser"
+ user: User
+}
+
+export interface CRChatStarted extends CR {
+ type: "chatStarted"
+}
+
+export interface CRChatRunning extends CR {
+ type: "chatRunning"
+}
+
+export interface CRApiChats extends CR {
+ type: "apiChats"
+ chats: Chat[]
+}
+
+export interface CRApiChat extends CR {
+ type: "apiChat"
+ chat: Chat
+}
+
+export interface CRApiParsedMarkdown extends CR {
+ type: "apiParsedMarkdown"
+ formattedText?: FormattedText[]
+}
+
+export interface CRUserSMPServers extends CR {
+ type: "userSMPServers"
+ smpServers: string[]
+}
+
+export interface CRNewChatItem extends CR {
+ type: "newChatItem"
+ chatItem: AChatItem
+}
+
+export interface CRChatItemStatusUpdated extends CR {
+ type: "chatItemStatusUpdated"
+ chatItem: AChatItem
+}
+
+export interface CRChatItemUpdated extends CR {
+ type: "chatItemUpdated"
+ chatItem: AChatItem
+}
+
+export interface CRChatItemDeleted extends CR {
+ type: "chatItemDeleted"
+ deletedChatItem: AChatItem
+ toChatItem: AChatItem
+}
+
+export interface CRMsgIntegrityError extends CR {
+ type: "msgIntegrityError"
+ msgError: MsgErrorType
+}
+
+export interface CRCmdOk extends CR {
+ type: "cmdOk"
+}
+
+export interface CRUserContactLink extends CR {
+ type: "userContactLink"
+ connReqContact: string
+ autoAccept: boolean
+}
+
+export interface CRUserContactLinkUpdated extends CR {
+ type: "userContactLinkUpdated"
+ connReqContact: string
+ autoAccept: boolean
+}
+
+export interface CRContactRequestRejected extends CR {
+ type: "contactRequestRejected"
+ contactRequest: UserContactRequest
+}
+
+export interface CRUserProfile extends CR {
+ type: "userProfile"
+ profile: Profile
+}
+
+export interface CRUserProfileNoChange extends CR {
+ type: "userProfileNoChange"
+}
+
+export interface CRUserProfileUpdated extends CR {
+ type: "userProfileUpdated"
+ fromProfile: Profile
+ toProfile: Profile
+}
+
+export interface CRInvitation extends CR {
+ type: "invitation"
+ connReqInvitation: string
+}
+
+export interface CRSentConfirmation extends CR {
+ type: "sentConfirmation"
+}
+
+export interface CRSentInvitation extends CR {
+ type: "sentInvitation"
+}
+
+export interface CRContactUpdated extends CR {
+ type: "contactUpdated"
+ fromContact: Contact
+ toContact: Contact
+}
+
+export interface CRContactDeleted extends CR {
+ type: "contactDeleted"
+ contact: Contact
+}
+
+export interface CRUserContactLinkCreated extends CR {
+ type: "userContactLinkCreated"
+ connReqContact: string
+}
+
+export interface CRUserContactLinkDeleted extends CR {
+ type: "userContactLinkDeleted"
+}
+
+export interface CRReceivedContactRequest extends CR {
+ type: "receivedContactRequest"
+ contactRequest: UserContactRequest
+}
+
+export interface CRAcceptingContactRequest extends CR {
+ type: "acceptingContactRequest"
+ contact: Contact
+}
+
+export interface CRContactAlreadyExists extends CR {
+ type: "contactAlreadyExists"
+ contact: Contact
+}
+
+export interface CRContactRequestAlreadyAccepted extends CR {
+ type: "contactRequestAlreadyAccepted"
+ contact: Contact
+}
+
+export interface CRContactConnecting extends CR {
+ type: "contactConnecting"
+ contact: Contact
+}
+
+export interface CRContactConnected extends CR {
+ type: "contactConnected"
+ contact: Contact
+}
+
+export interface CRContactAnotherClient extends CR {
+ type: "contactAnotherClient"
+ contact: Contact
+}
+
+export interface CRContactDisconnected extends CR {
+ type: "contactDisconnected"
+ contact: Contact
+}
+
+export interface CRContactSubscribed extends CR {
+ type: "contactSubscribed"
+ contact: Contact
+}
+
+export interface CRContactSubError extends CR {
+ type: "contactSubError"
+ contact: Contact
+ chatError: ChatError
+}
+
+export interface CRContactSubSummary extends CR {
+ type: "contactSubSummary"
+ contactSubscriptions: ContactSubStatus[]
+}
+
+export interface CRGroupEmpty extends CR {
+ type: "groupEmpty"
+ groupInfo: GroupInfo
+}
+
+export interface CRPendingSubSummary extends CR {
+ type: "pendingSubSummary"
+ pendingSubStatus: PendingSubStatus[]
+}
+
+export interface CRUserContactLinkSubscribed extends CR {
+ type: "userContactLinkSubscribed"
+}
+
+export interface CRUserContactLinkSubError extends CR {
+ type: "userContactLinkSubError"
+ chatError: ChatError
+}
+
+export interface CRMessageError extends CR {
+ type: "messageError"
+ severity: string
+ errorMessage: string
+}
+
+export interface CRChatCmdError extends CR {
+ type: "chatCmdError"
+ chatError: ChatError
+}
+
+export interface CRChatError extends CR {
+ type: "chatError"
+ chatError: ChatError
+}
+
+export interface User {
+ userId: number
+ userContactId: number
+ localDisplayName: string
+ profile: Profile
+ activeUser: boolean
+}
+
+export interface Chat {
+ chatInfo: ChatInfo
+ chatItems: [ChatItem]
+ chatStats: ChatStats
+}
+
+export type ChatInfo = CInfoDirect | CInfoGroup | CInfoContactRequest
+
+export enum ChatInfoType {
+ Direct = "direct",
+ Group = "group",
+ ContactRequest = "contactRequest",
+}
+
+interface IChatInfo {
+ type: ChatInfoType
+}
+
+interface CInfoDirect extends IChatInfo {
+ type: ChatInfoType.Direct
+ contact: Contact
+}
+
+interface CInfoGroup extends IChatInfo {
+ type: ChatInfoType.Group
+ groupInfo: GroupInfo
+}
+
+interface CInfoContactRequest extends IChatInfo {
+ type: ChatInfoType.ContactRequest
+ contactRequest: UserContactRequest
+}
+
+export interface Contact {
+ contactId: number
+ localDisplayName: string
+ profile: Profile
+ activeConn: Connection
+ viaGroup?: number
+ createdAt: Date
+}
+
+export interface GroupInfo {
+ groupId: number
+ localDisplayName: string
+ groupProfile: GroupProfile
+ membership: GroupMember
+ createdAt: Date
+}
+
+export interface GroupProfile {
+ displayName: string
+ fullName: string
+ image?: string // web-compatible data/base64 string for the image
+}
+
+export interface GroupMember {
+ groupMemberId: number
+ memberId: string
+ // memberRole: GroupMemberRole
+ // memberCategory: GroupMemberCategory
+ // memberStatus: GroupMemberStatus
+ // invitedBy: InvitedBy
+ localDisplayName: string
+ memberProfile: Profile
+ memberContactId?: number
+ activeConn?: Connection
+}
+
+export interface UserContactRequest {
+ contactRequestId: number
+ localDisplayName: string
+ profile: Profile
+ createdAt: Date
+}
+
+interface Connection {
+ connId: number
+}
+
+export interface AChatItem {
+ chatInfo: ChatInfo
+ chatItem: ChatItem
+}
+
+export interface ChatItem {
+ chatDir: CIDirection
+ meta: CIMeta
+ content: CIContent
+ formattedText?: FormattedText[]
+ quotedItem?: CIQuote
+}
+
+export type CIDirection = CIDirectSnd | CIDirectRcv | CIGroupSnd | CIGroupRcv
+
+interface ICIDirection {
+ type: "directSnd" | "directRcv" | "groupSnd" | "groupRcv"
+}
+
+interface CIDirectSnd extends ICIDirection {
+ type: "directSnd"
+}
+
+interface CIDirectRcv extends ICIDirection {
+ type: "directRcv"
+}
+
+interface CIGroupSnd extends ICIDirection {
+ type: "groupSnd"
+}
+
+interface CIGroupRcv extends ICIDirection {
+ type: "groupRcv"
+ groupMember: GroupMember
+}
+
+export interface CIMeta {
+ itemId: ChatItemId
+ itemTs: Date
+ itemText: string
+ itemStatus: CIStatus
+ createdAt: Date
+ itemDeleted: boolean
+ itemEdited: boolean
+ editable: boolean
+}
+
+export type CIContent = CISndMsgContent | CIRcvMsgContent | CISndDeleted | CIRcvDeleted | CISndFileInvitation | CIRcvFileInvitation
+
+interface ICIContent {
+ type: "sndMsgContent" | "rcvMsgContent" | "sndDeleted" | "rcvDeleted" | "sndFileInvitation" | "rcvFileInvitation"
+}
+
+interface CISndMsgContent extends ICIContent {
+ type: "sndMsgContent"
+ msgContent: MsgContent
+}
+
+interface CIRcvMsgContent extends ICIContent {
+ type: "rcvMsgContent"
+ msgContent: MsgContent
+}
+
+interface CISndDeleted extends ICIContent {
+ type: "sndDeleted"
+ deleteMode: DeleteMode
+}
+
+interface CIRcvDeleted extends ICIContent {
+ type: "rcvDeleted"
+ deleteMode: DeleteMode
+}
+
+interface CISndFileInvitation extends ICIContent {
+ type: "sndFileInvitation"
+ fileId: number
+ filePath: string
+}
+
+interface CIRcvFileInvitation extends ICIContent {
+ type: "rcvFileInvitation"
+ rcvFileTransfer: RcvFileTransfer
+}
+
+export function ciContentText(content: CIContent): string | undefined {
+ switch (content.type) {
+ case "sndMsgContent":
+ return content.msgContent.text
+ case "rcvMsgContent":
+ return content.msgContent.text
+ default:
+ return undefined
+ }
+}
+
+interface RcvFileTransfer {}
+
+export interface ChatStats {
+ unreadCount: number
+ minUnreadItemId: number
+}
+
+export interface CIQuote {
+ chatDir?: CIDirection
+ itemId?: number
+ sharedMsgId?: string
+ sentAt: Date
+ content: MsgContent
+ formattedText?: FormattedText[]
+}
+
+export type CIStatus = CISndNew | CISndSent | CISndErrorAuth | CISndError | CIRcvNew | CIRcvRead
+
+interface ICIStatus {
+ type: "sndNew" | "sndSent" | "sndErrorAuth" | "sndError" | "rcvNew" | "rcvRead"
+}
+
+interface CISndNew extends ICIStatus {
+ type: "sndNew"
+}
+
+interface CISndSent extends ICIStatus {
+ type: "sndSent"
+}
+
+interface CISndErrorAuth extends ICIStatus {
+ type: "sndErrorAuth"
+}
+
+interface CISndError extends ICIStatus {
+ type: "sndError"
+ agentError: AgentErrorType
+}
+
+interface CIRcvNew extends ICIStatus {
+ type: "rcvNew"
+}
+
+interface CIRcvRead extends ICIStatus {
+ type: "rcvRead"
+}
+
+interface FormattedText {}
+
+interface MsgErrorType {}
+
+export type ChatError = ChatErrorChat | ChatErrorAgent | ChatErrorStore
+
+interface ChatErrorChat {
+ type: "error"
+ errorType: ChatErrorType
+}
+
+interface ChatErrorAgent {
+ type: "errorAgent"
+ agentError: AgentErrorType
+}
+
+interface ChatErrorStore {
+ type: "errorStore"
+ storeError: StoreErrorType
+}
+
+type ChatErrorType = CENoActiveUser | CEActiveUserExists
+
+interface CENoActiveUser {
+ type: "noActiveUser"
+}
+
+interface CEActiveUserExists {
+ type: "activeUserExists"
+}
+
+interface ContactSubStatus {}
+
+interface PendingSubStatus {}
+
+interface AgentErrorType {
+ type: string
+ [x: string]: any
+}
+
+interface StoreErrorType {
+ type: string
+ [x: string]: any
+}
diff --git a/packages/simplex-chat-client/typescript/src/test.html b/packages/simplex-chat-client/typescript/src/test.html
new file mode 100644
index 0000000000..0732ad9213
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/test.html
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/packages/simplex-chat-client/typescript/src/transport.ts b/packages/simplex-chat-client/typescript/src/transport.ts
new file mode 100644
index 0000000000..7ac4673ca1
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/transport.ts
@@ -0,0 +1,157 @@
+import {ABQueue, NextIter} from "./queue"
+import {ChatResponse} from "./response"
+
+export class TransportError extends Error {}
+
+export abstract class Transport {
+ readonly queue: ABQueue
+
+ protected constructor(qSize: number) {
+ this.queue = new ABQueue(qSize)
+ }
+
+ [Symbol.asyncIterator](): Transport {
+ return this
+ }
+
+ abstract close(): Promise
+
+ abstract write(bytes: W): Promise
+
+ async read(): Promise {
+ return this.queue.dequeue()
+ }
+
+ async next(): Promise> {
+ return this.queue.next()
+ }
+}
+
+type WSData = Uint8Array | string
+
+export class WSTransport extends Transport {
+ private constructor(private readonly sock: WebSocket, readonly timeout: number, qSize: number) {
+ super(qSize)
+ }
+
+ static connect(url: string, timeout: number, qSize: number): Promise {
+ const sock = new WebSocket(url)
+ const t = new WSTransport(sock, timeout, qSize)
+ sock.onmessage = async ({data}: MessageEvent) => await t.queue.enqueue(data)
+ sock.onclose = async () => await t.queue.close()
+ sock.onerror = () => sock.close()
+ return withTimeout(timeout, () => new Promise((r) => (sock.onopen = () => r(t))))
+ }
+
+ close(): Promise {
+ this.sock.close()
+ return Promise.resolve()
+ }
+
+ write(data: WSData): Promise {
+ const buffered = this.sock.bufferedAmount
+ this.sock.send(data)
+ return withTimeout(this.timeout, async () => {
+ while (this.sock.bufferedAmount > buffered) await delay()
+ })
+ }
+
+ async readBinary(size: number): Promise {
+ const data = await this.read()
+ if (typeof data == "string") throw new TransportError("invalid text block: expected binary")
+ if (data.byteLength !== size) throw new TransportError("invalid block size")
+ return data
+ }
+}
+
+function withTimeout(ms: number, action: () => Promise): Promise {
+ return Promise.race([
+ action(),
+ (async () => {
+ await delay(ms)
+ throw new Error("timeout")
+ })(),
+ ])
+}
+
+export interface ChatServer {
+ readonly host: string
+ readonly port?: string
+}
+
+export const localServer: ChatServer = {
+ host: "localhost",
+ port: "5225",
+}
+
+export interface ChatSrvRequest {
+ corrId: string
+ cmd: string
+}
+
+export interface ChatSrvResponse {
+ corrId?: string
+ resp: ChatResponse
+}
+
+interface ParsedChatSrvResponse {
+ corrId?: string
+ resp?: ChatResponse
+}
+
+export class ChatResponseError extends Error {
+ constructor(public message: string, public data?: string) {
+ super(message)
+ }
+}
+
+export class ChatTransport extends Transport {
+ private constructor(private readonly ws: WSTransport, readonly timeout: number, qSize: number) {
+ super(qSize)
+ }
+
+ static async connect(srv: ChatServer | string, timeout: number, qSize: number): Promise {
+ const uri = typeof srv == "string" ? srv : `ws://${srv.host}:${srv.port || "5225"}`
+ const ws = await WSTransport.connect(uri, timeout, qSize)
+ const c = new ChatTransport(ws, timeout, qSize)
+ processWSQueue(c, ws).then(noop, noop)
+ return c
+ }
+
+ async close(): Promise {
+ await this.ws.close()
+ }
+
+ async write(cmd: ChatSrvRequest): Promise {
+ return this.ws.write(JSON.stringify(cmd))
+ }
+}
+
+export function noop(): void {}
+
+async function processWSQueue(c: ChatTransport, ws: WSTransport): Promise {
+ for await (const data of ws) {
+ const str = (data instanceof Promise ? await data : data) as WSData
+ if (typeof str != "string") {
+ await c.queue.enqueue(new ChatResponseError("websocket data is not a string"))
+ continue
+ }
+ let resp: ChatSrvResponse | ChatResponseError
+ try {
+ const json = JSON.parse(str) as ParsedChatSrvResponse | undefined
+ if (typeof json?.resp?.type == "string") {
+ resp = json as ChatSrvResponse
+ } else {
+ resp = new ChatResponseError("invalid response format", str)
+ }
+ } catch (err) {
+ resp = new ChatResponseError((err as Error).message, str)
+ }
+ await c.queue.enqueue(resp)
+ }
+ await c.queue.close()
+}
+
+function delay(ms?: number): Promise {
+ return new Promise((r) => setTimeout(r, ms))
+}
diff --git a/packages/simplex-chat-client/typescript/src/websocket.ts b/packages/simplex-chat-client/typescript/src/websocket.ts
new file mode 100644
index 0000000000..8b1bdb0fb2
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/src/websocket.ts
@@ -0,0 +1,3 @@
+const Ws = require("isomorphic-ws") as typeof WebSocket
+
+Object.defineProperty(global, "WebSocket", {value: Ws})
diff --git a/packages/simplex-chat-client/typescript/tests/client.test.ts b/packages/simplex-chat-client/typescript/tests/client.test.ts
new file mode 100644
index 0000000000..2c44406c3d
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/tests/client.test.ts
@@ -0,0 +1,47 @@
+import * as assert from "assert"
+import {ChatClient} from "../src/index"
+import {ConnReqType} from "../src/client"
+import * as CC from "../src/command"
+import * as CR from "../src/response"
+
+describe.skip("ChatClient (expects SimpleX Chat server with a user, without contacts, on localhost:5225)", () => {
+ test("connect, send message to themselves, delete contact", async () => {
+ const c = await ChatClient.create("ws://localhost:5225")
+ assert.strictEqual((await c.msgQ.dequeue()).type, "contactSubSummary")
+ assert.strictEqual((await c.msgQ.dequeue()).type, "memberSubErrors")
+ assert.strictEqual((await c.msgQ.dequeue()).type, "pendingSubSummary")
+ const user = await c.apiGetActiveUser()
+ assert.strictEqual(typeof user?.localDisplayName, "string")
+ const connReq = await c.apiCreateLink()
+ assert.strictEqual(typeof connReq, "string")
+ assert.strictEqual((await c.msgQ.dequeue()).type, "newContactConnection") // TODO add to response types
+ const connReqType = await c.apiConnect(connReq)
+ assert.strictEqual((await c.msgQ.dequeue()).type, "newContactConnection") // TODO add to response types
+ assert((await c.msgQ.dequeue()).type === "contactConnecting")
+ assert((await c.msgQ.dequeue()).type === "contactConnecting")
+ assert(connReqType === ConnReqType.Invitation || connReqType === ConnReqType.Contact)
+ const r1 = await c.msgQ.dequeue()
+ const r2 = await c.msgQ.dequeue()
+ assert(r1.type === "contactConnected")
+ assert(r2.type === "contactConnected")
+ const contact1 = (r1 as CR.CRContactConnected).contact
+ // const contact2 = (r2 as C.CRContactConnected).contact
+ const r3 = await c.apiSendTextMessage(CC.ChatType.CTDirect, contact1.contactId, "hello")
+ assert(r3.chatItem.content.type === "sndMsgContent" && r3.chatItem.content.msgContent.text === "hello")
+ const r4 = await c.msgQ.dequeue()
+ assert(isItemSent(r4) || isNewRcvItem(r4))
+ await c.disconnect()
+
+ function isItemSent(r: CR.ChatResponse): boolean {
+ return r.type === "chatItemStatusUpdated" && r.chatItem.chatItem.meta.itemStatus.type === "sndSent"
+ }
+
+ function isNewRcvItem(r: CR.ChatResponse): boolean {
+ return (
+ r.type === "newChatItem" &&
+ r.chatItem.chatItem.content.type === "rcvMsgContent" &&
+ r.chatItem.chatItem.content.msgContent.text === "hello"
+ )
+ }
+ }, 20000)
+})
diff --git a/packages/simplex-chat-client/typescript/tests/queue.test.ts b/packages/simplex-chat-client/typescript/tests/queue.test.ts
new file mode 100644
index 0000000000..6e343ea61b
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/tests/queue.test.ts
@@ -0,0 +1,77 @@
+import * as assert from "assert"
+import {ABQueue, ABQueueError} from "../src/queue"
+
+describe("ABQueue", () => {
+ test("async queue API", async () => {
+ const arr = makeArr(100)
+ await testQueue(10)
+ await testQueue(1)
+ await testQueue(0)
+
+ async function testQueue(maxSize: number): Promise {
+ const q = new ABQueue(maxSize)
+ const res = await Promise.all([enqueueArr(q, arr), dequeueArr(q)])
+ assert.deepStrictEqual(arr, res[1])
+ }
+ })
+
+ test("async queue iterator API", async () => {
+ const arr = makeArr(100)
+ await testQueueIterator(10)
+ await testQueueIterator(1)
+ await testQueueIterator(0)
+
+ async function testQueueIterator(maxSize: number): Promise {
+ const q = new ABQueue(maxSize)
+ const res = await Promise.all([enqueueArr(q, arr), iterQueue(q)])
+ assert.deepStrictEqual(arr, res[1])
+ }
+ })
+
+ test("enqueue / dequeue with closed queue throws exception", async () => {
+ const q = new ABQueue(10)
+ await q.enqueue(1)
+ await q.enqueue(2)
+ await q.close()
+ await assert.rejects(q.enqueue(3))
+ assert.strictEqual(await q.dequeue(), 1)
+ assert.strictEqual(await q.dequeue(), 2)
+ await assert.rejects(q.dequeue())
+ await assert.rejects(q.enqueue(3))
+ await assert.rejects(q.dequeue())
+ assert.deepStrictEqual(await q.next(), {done: true})
+ })
+})
+
+function makeArr(size: number): number[] {
+ return Array(size)
+ .fill(0)
+ .map((_, i) => i)
+}
+
+async function enqueueArr(q: ABQueue, xs: number[]): Promise {
+ for (const x of xs) {
+ await q.enqueue(x)
+ }
+ await q.close()
+}
+
+async function dequeueArr(q: ABQueue): Promise {
+ const xs: number[] = []
+ // eslint-disable-next-line no-constant-condition
+ while (true) {
+ try {
+ xs.push(await q.dequeue())
+ } catch (e) {
+ assert.ok(e instanceof ABQueueError)
+ break
+ }
+ }
+ return xs
+}
+
+async function iterQueue(q: ABQueue): Promise {
+ const xs: number[] = []
+ for await (const x of q) xs.push(await x)
+ return xs
+}
diff --git a/packages/simplex-chat-client/typescript/tsconfig.json b/packages/simplex-chat-client/typescript/tsconfig.json
new file mode 100644
index 0000000000..cc64321ef6
--- /dev/null
+++ b/packages/simplex-chat-client/typescript/tsconfig.json
@@ -0,0 +1,23 @@
+{
+ "include": ["src"],
+ "compilerOptions": {
+ "declaration": true,
+ "forceConsistentCasingInFileNames": true,
+ "lib": ["ES2018", "DOM"],
+ "module": "CommonJS",
+ "moduleResolution": "Node",
+ "noFallthroughCasesInSwitch": true,
+ "noImplicitAny": true,
+ "noImplicitReturns": true,
+ "noImplicitThis": true,
+ "noUnusedLocals": true,
+ "noUnusedParameters": true,
+ "noEmitOnError": true,
+ "outDir": "dist",
+ "sourceMap": true,
+ "strict": true,
+ "strictNullChecks": true,
+ "target": "ES2018",
+ "types": ["node", "jest"]
+ }
+}
diff --git a/simplex-chat.cabal b/simplex-chat.cabal
index e1c5c46cf7..3039ea3ad5 100644
--- a/simplex-chat.cabal
+++ b/simplex-chat.cabal
@@ -160,6 +160,7 @@ executable simplex-bot-advanced
executable simplex-chat
main-is: Main.hs
other-modules:
+ Server
Paths_simplex_chat
hs-source-dirs:
apps/simplex-chat
@@ -180,6 +181,7 @@ executable simplex-chat
, exceptions ==0.10.*
, filepath ==1.4.*
, mtl ==2.2.*
+ , network ==3.1.*
, optparse-applicative >=0.15 && <0.17
, process ==1.6.*
, simple-logger ==0.1.*
@@ -192,6 +194,7 @@ executable simplex-chat
, time ==1.9.*
, unliftio ==0.2.*
, unliftio-core ==0.2.*
+ , websockets ==0.12.*
default-language: Haskell2010
test-suite simplex-chat-test
diff --git a/src/Simplex/Chat/Mobile.hs b/src/Simplex/Chat/Mobile.hs
index b830860ef5..a83fc67f0d 100644
--- a/src/Simplex/Chat/Mobile.hs
+++ b/src/Simplex/Chat/Mobile.hs
@@ -53,7 +53,8 @@ mobileChatOpts =
logConnections = False,
logAgent = False,
chatCmd = "",
- chatCmdDelay = 3
+ chatCmdDelay = 3,
+ chatServerPort = Nothing
}
defaultMobileConfig :: ChatConfig
diff --git a/src/Simplex/Chat/Options.hs b/src/Simplex/Chat/Options.hs
index 9c55d1b614..ad7cb97e12 100644
--- a/src/Simplex/Chat/Options.hs
+++ b/src/Simplex/Chat/Options.hs
@@ -24,7 +24,8 @@ data ChatOpts = ChatOpts
logConnections :: Bool,
logAgent :: Bool,
chatCmd :: String,
- chatCmdDelay :: Int
+ chatCmdDelay :: Int,
+ chatServerPort :: Maybe String
}
chatOpts :: FilePath -> FilePath -> Parser ChatOpts
@@ -78,13 +79,28 @@ chatOpts appDir defaultDbFileName = do
<> value 3
<> showDefault
)
- pure ChatOpts {dbFilePrefix, smpServers, logConnections, logAgent, chatCmd, chatCmdDelay}
+ chatServerPort <-
+ option
+ parseServerPort
+ ( long "chat-server-port"
+ <> short 'p'
+ <> metavar "PORT"
+ <> help "Run chat server on specified port"
+ <> value Nothing
+ )
+ pure ChatOpts {dbFilePrefix, smpServers, logConnections, logAgent, chatCmd, chatCmdDelay, chatServerPort}
where
defaultDbFilePath = combine appDir defaultDbFileName
parseSMPServers :: ReadM [SMPServer]
parseSMPServers = eitherReader $ parseAll smpServersP . B.pack
+parseServerPort :: ReadM (Maybe String)
+parseServerPort = eitherReader $ parseAll serverPortP . B.pack
+
+serverPortP :: A.Parser (Maybe String)
+serverPortP = Just . B.unpack <$> A.takeWhile A.isDigit
+
smpServersP :: A.Parser [SMPServer]
smpServersP = strP `A.sepBy1` A.char ','
diff --git a/tests/ChatClient.hs b/tests/ChatClient.hs
index b5a598bbcd..2aba3feb20 100644
--- a/tests/ChatClient.hs
+++ b/tests/ChatClient.hs
@@ -50,7 +50,8 @@ opts =
logConnections = False,
logAgent = False,
chatCmd = "",
- chatCmdDelay = 3
+ chatCmdDelay = 3,
+ chatServerPort = Nothing
}
termSettings :: VirtualTerminalSettings