mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-07-28 16:29:49 +00:00
simplex-chat-python: add python library (#6954)
* docs: simplex-chat-python design and implementation plan * bots: Python wire types codegen * simplex-chat-python: package scaffold * simplex-chat-python: native libsimplex loader * simplex-chat-python: async FFI wrappers * simplex-chat-python: ChatApi with 49 api methods * simplex-chat-python: Bot class with decorators and dispatch * simplex-chat-python: install CLI, example bot, README * simplex-chat-python: audit fixes * bots: regenerate API docs and types Catches up the markdown, TypeScript and Python codegen outputs with two upstream schema changes: - APIConnectPlan.connectionLink became optional (from sh/python-lib audit fixes); cmdString and EBNF syntax now reflect optional parameter. - APIAddGroupRelays command and CRGroupRelaysAdded/CRGroupRelaysAddFailed responses added in #6917 (relay management). The TS and markdown outputs were regenerated when #6917 landed but the Python types module only got the new entries with this regeneration. * core: refresh SQLite query plans after relay_inactive_at migration The M20260507_relay_inactive_at migration (#6917 / #6952) shifted the query plans that 'Save query plans' verifies. Regenerated via the test that owns those snapshots; no behavioral change. * bots: keep APIConnectPlan connectionLink as required parameter The prior audit-fixes commit changed the syntax expression to `Optional ...` because the Haskell field is `connectionLink :: Maybe AConnectionLink`. That misrepresents the API contract: the `Maybe` is purely an internal signal for link-parsing failure (the handler returns `CEInvalidConnReq` on `Nothing`), not API-level optionality. Callers MUST always pass a connection link. Revert the syntax expression to `Param "connectionLink"` and add a comment so the intent is preserved next time someone audits. Regenerates COMMANDS.md, commands.ts and _commands.py to match.
This commit is contained in:
sh
@@ -0,0 +1,22 @@
|
||||
# Python build / cache artifacts — never commit these
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
*.egg-info/
|
||||
build/
|
||||
dist/
|
||||
.pytest_cache/
|
||||
.ruff_cache/
|
||||
.mypy_cache/
|
||||
.pyright_cache/
|
||||
|
||||
# Virtual environments
|
||||
.venv/
|
||||
.venv-*/
|
||||
venv/
|
||||
|
||||
# Lazy-downloaded native libs (handled at runtime by _native._resolve_libs_dir)
|
||||
libs/
|
||||
|
||||
# Local override for SIMPLEX_LIBS_DIR work, etc.
|
||||
.env
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <https://www.gnu.org/licenses/>.
|
||||
|
||||
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
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,70 @@
|
||||
# SimpleX Chat Python library
|
||||
|
||||
Python 3.11+ client for [SimpleX Chat](https://simplex.chat) bots. Equivalent to the [Node.js library](https://www.npmjs.com/package/simplex-chat).
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pip install simplex-chat
|
||||
```
|
||||
|
||||
The native `libsimplex` is downloaded lazily on first use. To pre-fetch:
|
||||
|
||||
```bash
|
||||
python -m simplex_chat install # sqlite (default)
|
||||
python -m simplex_chat install --backend postgres # linux-x86_64 only
|
||||
```
|
||||
|
||||
## Quick start
|
||||
|
||||
```python
|
||||
import re
|
||||
from simplex_chat import Bot, BotProfile, Message, SqliteDb, TextMessage
|
||||
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="Squaring bot"),
|
||||
db=SqliteDb(file_prefix="./squaring_bot"),
|
||||
welcome="Send me a number, I'll square it.",
|
||||
)
|
||||
|
||||
@bot.on_message(content_type="text", text=re.compile(r"^-?\d+(\.\d+)?$"))
|
||||
async def square(msg: TextMessage) -> None:
|
||||
n = float(msg.text or "0")
|
||||
await msg.reply(f"{n} * {n} = {n * n}")
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(msg: Message) -> None:
|
||||
await msg.reply("Send me a number, like 7 or 3.14.")
|
||||
|
||||
if __name__ == "__main__":
|
||||
bot.run()
|
||||
```
|
||||
|
||||
`bot.run()` blocks. The connection address is logged on startup — paste it into a SimpleX client to talk to the bot. `Ctrl+C` to stop.
|
||||
|
||||
Three decorators: `@bot.on_message(...)`, `@bot.on_command(name)`, `@bot.on_event(tag)`. Message handlers are first-match-wins in registration order, so register specific filters first and catch-alls last.
|
||||
|
||||
See [`examples/squaring_bot.py`](./examples/squaring_bot.py) for the full example.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
uv venv && source .venv/bin/activate
|
||||
uv pip install -e '.[dev]'
|
||||
ruff check && pyright && pytest tests/
|
||||
```
|
||||
|
||||
Wire types under `src/simplex_chat/types/_*.py` are generated. Regenerate with `cabal test simplex-chat-test --test-options='--match Python'`.
|
||||
|
||||
## Release
|
||||
|
||||
Manual for now. Bump `_version.py:__version__`, build a wheel, upload to PyPI:
|
||||
|
||||
```bash
|
||||
uv build --wheel
|
||||
uv publish --token "$PYPI_TOKEN"
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[AGPL-3.0](./LICENSE)
|
||||
@@ -0,0 +1,52 @@
|
||||
"""Squaring bot — replies to every number with its square.
|
||||
|
||||
Run with the simplex-chat package installed:
|
||||
|
||||
python examples/squaring_bot.py
|
||||
|
||||
Sends `n * n = ...` for any text message that parses as a number; falls
|
||||
back to a hint for non-number messages; responds to `/help` with usage.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
|
||||
from simplex_chat import (
|
||||
Bot,
|
||||
BotCommand,
|
||||
BotProfile,
|
||||
Message,
|
||||
ParsedCommand,
|
||||
SqliteDb,
|
||||
TextMessage,
|
||||
)
|
||||
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="Squaring bot"),
|
||||
db=SqliteDb(file_prefix="./squaring_bot"),
|
||||
welcome="Send me a number, I'll square it.",
|
||||
commands=[BotCommand(keyword="help", label="Show help")],
|
||||
)
|
||||
|
||||
NUMBER_RE = re.compile(r"^-?\d+(\.\d+)?$")
|
||||
|
||||
|
||||
@bot.on_message(content_type="text", text=NUMBER_RE)
|
||||
async def square(msg: TextMessage) -> None:
|
||||
n = float(msg.text or "0")
|
||||
await msg.reply(f"{n} * {n} = {n * n}")
|
||||
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(msg: Message) -> None:
|
||||
await msg.reply("Send me a number, like 7 or 3.14.")
|
||||
|
||||
|
||||
@bot.on_command("help")
|
||||
async def help_cmd(msg: Message, _cmd: ParsedCommand) -> None:
|
||||
await msg.reply("Send a number, I'll square it.")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
bot.run()
|
||||
@@ -0,0 +1,58 @@
|
||||
[build-system]
|
||||
requires = ["hatchling>=1.24"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "simplex-chat"
|
||||
description = "SimpleX Chat Python library for chat bots"
|
||||
readme = "README.md"
|
||||
license = "AGPL-3.0-only"
|
||||
authors = [{name = "SimpleX Chat"}]
|
||||
requires-python = ">=3.11"
|
||||
keywords = ["simplex", "messenger", "chat", "privacy", "security", "bots"]
|
||||
classifiers = [
|
||||
"Development Status :: 4 - Beta",
|
||||
"License :: OSI Approved :: GNU Affero General Public License v3",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Topic :: Communications :: Chat",
|
||||
]
|
||||
dynamic = ["version"]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-python"
|
||||
Issues = "https://github.com/simplex-chat/simplex-chat/issues"
|
||||
|
||||
[project.optional-dependencies]
|
||||
test = ["pytest>=8", "pytest-asyncio>=0.23"]
|
||||
dev = ["pytest>=8", "pytest-asyncio>=0.23", "pyright>=1.1.380", "ruff>=0.6"]
|
||||
|
||||
[tool.hatch.version]
|
||||
path = "src/simplex_chat/_version.py"
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["src/simplex_chat"]
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
asyncio_mode = "auto"
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
target-version = "py311"
|
||||
|
||||
[tool.ruff.format]
|
||||
# `src/simplex_chat/types/*.py` are generated by the Haskell codegen
|
||||
# (bots/src/API/Docs/Generate/Python.hs). Re-formatting them locally
|
||||
# would diverge from the generator's output and break `cabal test
|
||||
# simplex-chat-test --match Python`. Lint still applies — only format
|
||||
# is suppressed.
|
||||
exclude = ["src/simplex_chat/types/_*.py"]
|
||||
|
||||
[tool.pyright]
|
||||
# Same rationale: the generated cmd_string helpers use `self.get('x')`
|
||||
# call pairs that pyright cannot narrow across (`is not None` followed
|
||||
# by re-access). Hand-written code is still strictly checked.
|
||||
include = ["src/simplex_chat"]
|
||||
exclude = ["src/simplex_chat/types/_*.py", "**/__pycache__", "**/.venv*"]
|
||||
@@ -0,0 +1,59 @@
|
||||
"""SimpleX Chat — Python client library for chat bots."""
|
||||
|
||||
from ._version import __version__
|
||||
from .api import ChatApi, ChatCommandError, ConnReqType, Db, PostgresDb, SqliteDb
|
||||
from .bot import (
|
||||
Bot,
|
||||
BotCommand,
|
||||
BotProfile,
|
||||
ChatMessage,
|
||||
CommandHandler,
|
||||
EventHandler,
|
||||
FileMessage,
|
||||
ImageMessage,
|
||||
LinkMessage,
|
||||
Message,
|
||||
MessageHandler,
|
||||
Middleware,
|
||||
ParsedCommand,
|
||||
ReportMessage,
|
||||
TextMessage,
|
||||
UnknownMessage,
|
||||
VideoMessage,
|
||||
VoiceMessage,
|
||||
)
|
||||
from .core import ChatAPIError, ChatInitError, CryptoArgs, MigrationConfirmation
|
||||
from . import util as util # re-export the util namespace
|
||||
|
||||
__all__ = [
|
||||
"__version__",
|
||||
"Bot",
|
||||
"BotCommand",
|
||||
"BotProfile",
|
||||
"ChatAPIError",
|
||||
"ChatApi",
|
||||
"ChatCommandError",
|
||||
"ChatInitError",
|
||||
"ChatMessage",
|
||||
"CommandHandler",
|
||||
"ConnReqType",
|
||||
"CryptoArgs",
|
||||
"Db",
|
||||
"EventHandler",
|
||||
"FileMessage",
|
||||
"ImageMessage",
|
||||
"LinkMessage",
|
||||
"Message",
|
||||
"MessageHandler",
|
||||
"Middleware",
|
||||
"MigrationConfirmation",
|
||||
"ParsedCommand",
|
||||
"PostgresDb",
|
||||
"ReportMessage",
|
||||
"SqliteDb",
|
||||
"TextMessage",
|
||||
"UnknownMessage",
|
||||
"VideoMessage",
|
||||
"VoiceMessage",
|
||||
"util",
|
||||
]
|
||||
@@ -0,0 +1,35 @@
|
||||
"""CLI: ``python -m simplex_chat install [--backend=sqlite|postgres]``."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import sys
|
||||
|
||||
from . import _native
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
p = argparse.ArgumentParser(prog="simplex_chat")
|
||||
sub = p.add_subparsers(dest="command", required=True)
|
||||
install = sub.add_parser("install", help="Pre-fetch libsimplex into the user cache")
|
||||
install.add_argument(
|
||||
"--backend",
|
||||
choices=["sqlite", "postgres"],
|
||||
default="sqlite",
|
||||
help="which libsimplex variant to download (default: sqlite)",
|
||||
)
|
||||
args = p.parse_args(argv)
|
||||
# `args.command` is always set: `add_subparsers(required=True)` makes
|
||||
# argparse exit before reaching this point if no subcommand is given.
|
||||
assert args.command == "install"
|
||||
try:
|
||||
path = _native._resolve_libs_dir(args.backend)
|
||||
print(f"libsimplex installed at: {path}")
|
||||
return 0
|
||||
except Exception as e:
|
||||
print(f"install failed: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,257 @@
|
||||
"""Native libsimplex loader: platform detection, lazy download, ctypes setup.
|
||||
|
||||
Internal — users interact with `Bot` / `ChatApi`, never with this module.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import ctypes
|
||||
import errno
|
||||
import os
|
||||
import platform
|
||||
import sys
|
||||
import tempfile
|
||||
import threading
|
||||
import urllib.request
|
||||
import zipfile
|
||||
from ctypes import POINTER, c_char_p, c_int, c_uint8, c_void_p
|
||||
from pathlib import Path
|
||||
from typing import Literal
|
||||
|
||||
from ._version import LIBS_VERSION
|
||||
|
||||
Backend = Literal["sqlite", "postgres"]
|
||||
|
||||
_GITHUB_REPO = "simplex-chat/simplex-chat-libs"
|
||||
|
||||
_PLATFORM_MAP = {
|
||||
"linux": ("linux", {"x86_64": "x86_64", "aarch64": "aarch64"}),
|
||||
"darwin": ("macos", {"x86_64": "x86_64", "arm64": "aarch64"}),
|
||||
"win32": ("windows", {"AMD64": "x86_64", "x86_64": "x86_64"}),
|
||||
}
|
||||
|
||||
_LIBNAME = {"linux": "libsimplex.so", "darwin": "libsimplex.dylib", "win32": "libsimplex.dll"}
|
||||
|
||||
SUPPORTED = (
|
||||
"linux-x86_64",
|
||||
"linux-aarch64",
|
||||
"macos-x86_64",
|
||||
"macos-aarch64",
|
||||
"windows-x86_64",
|
||||
)
|
||||
|
||||
|
||||
def _platform_tag() -> str:
|
||||
info = _PLATFORM_MAP.get(sys.platform)
|
||||
if not info:
|
||||
raise RuntimeError(f"Unsupported platform: {sys.platform}")
|
||||
sysname, archs = info
|
||||
arch = archs.get(platform.machine())
|
||||
if not arch:
|
||||
raise RuntimeError(f"Unsupported architecture: {sys.platform}/{platform.machine()}")
|
||||
tag = f"{sysname}-{arch}"
|
||||
if tag not in SUPPORTED:
|
||||
raise RuntimeError(f"Unsupported combination: {tag}; supported: {SUPPORTED}")
|
||||
return tag
|
||||
|
||||
|
||||
def _libname() -> str:
|
||||
return _LIBNAME[sys.platform]
|
||||
|
||||
|
||||
def _libs_url(backend: Backend) -> str:
|
||||
suffix = "-postgres" if backend == "postgres" else ""
|
||||
return (
|
||||
f"https://github.com/{_GITHUB_REPO}/releases/download/"
|
||||
f"v{LIBS_VERSION}/simplex-chat-libs-{_platform_tag()}{suffix}.zip"
|
||||
)
|
||||
|
||||
|
||||
def _cache_root() -> Path:
|
||||
if sys.platform == "darwin":
|
||||
return Path.home() / "Library" / "Caches" / "simplex-chat"
|
||||
if sys.platform == "win32":
|
||||
return Path(os.environ["LOCALAPPDATA"]) / "simplex-chat"
|
||||
base = os.environ.get("XDG_CACHE_HOME") or str(Path.home() / ".cache")
|
||||
return Path(base) / "simplex-chat"
|
||||
|
||||
|
||||
def _resolve_libs_dir(backend: Backend) -> Path:
|
||||
if override := os.environ.get("SIMPLEX_LIBS_DIR"):
|
||||
return Path(override)
|
||||
if backend == "postgres" and _platform_tag() != "linux-x86_64":
|
||||
raise RuntimeError(
|
||||
"postgres backend is only supported on linux-x86_64; "
|
||||
f"current platform is {_platform_tag()}"
|
||||
)
|
||||
target = _cache_root() / f"v{LIBS_VERSION}" / backend
|
||||
if not (target / _libname()).exists():
|
||||
_download(target, backend)
|
||||
return target
|
||||
|
||||
|
||||
_DOWNLOAD_CHUNK = 1 << 16 # 64 KiB
|
||||
|
||||
|
||||
def _stream_to_file(url: str, dest: Path, *, timeout: float = 60.0) -> None:
|
||||
"""Stream `url` → `dest`, printing a carriage-return progress bar.
|
||||
|
||||
`timeout` is per-request; we don't touch `socket.setdefaulttimeout`
|
||||
so other socket users in the same process aren't affected.
|
||||
"""
|
||||
with urllib.request.urlopen(url, timeout=timeout) as resp: # noqa: S310 - https://github.com/...
|
||||
total = int(resp.headers.get("Content-Length") or 0)
|
||||
received = 0
|
||||
with dest.open("wb") as out:
|
||||
while chunk := resp.read(_DOWNLOAD_CHUNK):
|
||||
out.write(chunk)
|
||||
received += len(chunk)
|
||||
if total > 0:
|
||||
pct = min(100, received * 100 // total)
|
||||
msg = f"\r download: {received >> 20} / {total >> 20} MiB ({pct}%)"
|
||||
else:
|
||||
msg = f"\r download: {received >> 20} MiB"
|
||||
print(msg, end="", file=sys.stderr, flush=True)
|
||||
print("", file=sys.stderr, flush=True) # newline after final progress line
|
||||
|
||||
|
||||
def _download(target: Path, backend: Backend) -> None:
|
||||
"""Download libs zip → atomic rename into `target`. Concurrent processes safe.
|
||||
|
||||
Atomicity strategy: each process extracts to its own sibling tempdir on the same
|
||||
filesystem, then `os.rename` the `libs/` subdir to `target`. POSIX `os.rename`
|
||||
onto a NON-EXISTENT path is atomic; if the target exists (another process won
|
||||
the race), `os.rename` fails on most platforms — we then verify the winner has
|
||||
what we need and proceed. NEVER rmtree the target: that creates a TOCTOU
|
||||
window where another process is reading/loading the file we're deleting.
|
||||
"""
|
||||
target.parent.mkdir(parents=True, exist_ok=True)
|
||||
url = _libs_url(backend)
|
||||
print(
|
||||
f"Downloading libsimplex ({_platform_tag()}, {backend}) v{LIBS_VERSION} from {url} ...",
|
||||
file=sys.stderr,
|
||||
flush=True,
|
||||
)
|
||||
with tempfile.TemporaryDirectory(dir=target.parent) as tmp:
|
||||
zip_path = Path(tmp) / "libs.zip"
|
||||
_stream_to_file(url, zip_path, timeout=60.0)
|
||||
with zipfile.ZipFile(zip_path) as zf:
|
||||
zf.extractall(tmp)
|
||||
# zip layout: <tmp>/libs/libsimplex.* + libHS*.*
|
||||
extracted_libs = Path(tmp) / "libs"
|
||||
if not extracted_libs.is_dir():
|
||||
raise RuntimeError(f"libs/ missing from {_libs_url(backend)}")
|
||||
try:
|
||||
os.rename(extracted_libs, target)
|
||||
except OSError as e:
|
||||
# EEXIST / ENOTEMPTY mean another process won the race — fall through
|
||||
# and check that the winner left a usable libsimplex behind. Anything
|
||||
# else (ENOSPC, EACCES, EROFS, Windows codes mapped to None) is a real
|
||||
# failure and must propagate. Same VERSION cached → same content →
|
||||
# safe to proceed once we've confirmed the file is there.
|
||||
if e.errno not in (errno.EEXIST, errno.ENOTEMPTY):
|
||||
raise
|
||||
if not (target / _libname()).exists():
|
||||
raise RuntimeError(
|
||||
f"another process partially populated {target} but libsimplex "
|
||||
f"is missing; remove the directory manually and retry"
|
||||
) from e
|
||||
|
||||
|
||||
_lock = threading.Lock()
|
||||
_lib: ctypes.CDLL | None = None
|
||||
_libc: ctypes.CDLL | None = None
|
||||
_backend: Backend | None = None
|
||||
|
||||
|
||||
def _load_libc() -> ctypes.CDLL:
|
||||
if sys.platform == "win32":
|
||||
return ctypes.CDLL("msvcrt")
|
||||
return ctypes.CDLL(None) # libc on POSIX is the process's own symbol table
|
||||
|
||||
|
||||
def _setup_signatures(lib: ctypes.CDLL) -> None:
|
||||
"""Declare argtypes/restype for the 8 chat_* functions exported by libsimplex.
|
||||
|
||||
All result strings come back as raw c_void_p so the caller can free them
|
||||
after copying — matches HandleCResult in cpp/simplex.cc:157-165.
|
||||
"""
|
||||
lib.chat_migrate_init.argtypes = [c_char_p, c_char_p, c_char_p, POINTER(c_void_p)]
|
||||
lib.chat_migrate_init.restype = c_void_p
|
||||
lib.chat_close_store.argtypes = [c_void_p]
|
||||
lib.chat_close_store.restype = c_void_p
|
||||
lib.chat_send_cmd.argtypes = [c_void_p, c_char_p]
|
||||
lib.chat_send_cmd.restype = c_void_p
|
||||
lib.chat_recv_msg_wait.argtypes = [c_void_p, c_int]
|
||||
lib.chat_recv_msg_wait.restype = c_void_p
|
||||
# chat_write_file's payload is treated read-only by libsimplex; passing
|
||||
# `bytes` via c_char_p avoids the from_buffer_copy doubling. ctypes pins
|
||||
# the bytes buffer for the duration of the call.
|
||||
lib.chat_write_file.argtypes = [c_void_p, c_char_p, c_char_p, c_int]
|
||||
lib.chat_write_file.restype = c_void_p
|
||||
lib.chat_read_file.argtypes = [c_char_p, c_char_p, c_char_p]
|
||||
lib.chat_read_file.restype = POINTER(c_uint8)
|
||||
lib.chat_encrypt_file.argtypes = [c_void_p, c_char_p, c_char_p]
|
||||
lib.chat_encrypt_file.restype = c_void_p
|
||||
lib.chat_decrypt_file.argtypes = [c_char_p, c_char_p, c_char_p, c_char_p]
|
||||
lib.chat_decrypt_file.restype = c_void_p
|
||||
|
||||
|
||||
def _hs_init(lib: ctypes.CDLL) -> None:
|
||||
"""Initialize the Haskell runtime exactly once. Mirrors cpp/simplex.cc:13-32."""
|
||||
if sys.platform == "win32":
|
||||
argv_strs = [b"simplex", b"+RTS", b"-A64m", b"-H64m", b"--install-signal-handlers=no"]
|
||||
else:
|
||||
argv_strs = [
|
||||
b"simplex",
|
||||
b"+RTS",
|
||||
b"-A64m",
|
||||
b"-H64m",
|
||||
b"-xn",
|
||||
b"--install-signal-handlers=no",
|
||||
]
|
||||
argc = c_int(len(argv_strs))
|
||||
arr = (c_char_p * (len(argv_strs) + 1))(*argv_strs, None)
|
||||
arr_ptr = ctypes.byref(ctypes.cast(arr, POINTER(c_char_p)))
|
||||
lib.hs_init_with_rtsopts.argtypes = [POINTER(c_int), POINTER(POINTER(c_char_p))]
|
||||
lib.hs_init_with_rtsopts.restype = None
|
||||
lib.hs_init_with_rtsopts(ctypes.byref(argc), arr_ptr)
|
||||
|
||||
|
||||
def lib_for(backend: Backend) -> ctypes.CDLL:
|
||||
"""Resolve, load, and initialize libsimplex for the given backend.
|
||||
|
||||
Idempotent for the same backend; raises if called with a different backend.
|
||||
Concurrent calls serialize on the module-level lock.
|
||||
"""
|
||||
global _lib, _libc, _backend
|
||||
with _lock:
|
||||
if _lib is not None:
|
||||
if _backend != backend:
|
||||
raise RuntimeError(
|
||||
f"libsimplex already loaded with backend={_backend!r}; "
|
||||
f"cannot switch to {backend!r} in the same process"
|
||||
)
|
||||
return _lib
|
||||
libs_dir = _resolve_libs_dir(backend)
|
||||
lib = ctypes.CDLL(str(libs_dir / _libname()))
|
||||
_setup_signatures(lib)
|
||||
_hs_init(lib)
|
||||
_libc = _load_libc()
|
||||
_lib = lib
|
||||
_backend = backend
|
||||
return lib
|
||||
|
||||
|
||||
def libc() -> ctypes.CDLL:
|
||||
"""libc — needed by `core` to free Haskell-allocated result strings."""
|
||||
if _libc is None:
|
||||
raise RuntimeError("lib_for() must be called before libc()")
|
||||
return _libc
|
||||
|
||||
|
||||
def lib() -> ctypes.CDLL:
|
||||
"""Loaded libsimplex handle. Raises if `lib_for()` has not been called."""
|
||||
if _lib is None:
|
||||
raise RuntimeError("lib_for() must be called before lib()")
|
||||
return _lib
|
||||
@@ -0,0 +1,9 @@
|
||||
"""Single source of truth for both the Python package version and the
|
||||
simplex-chat-libs release tag we depend on.
|
||||
|
||||
Bump both together for normal releases. For wrapper-only fixes use a PEP 440
|
||||
post-release: __version__ = "6.5.1.post1", LIBS_VERSION unchanged.
|
||||
"""
|
||||
|
||||
__version__ = "6.5.1" # PEP 440 — read by hatchling for wheel metadata
|
||||
LIBS_VERSION = "6.5.1" # simplex-chat-libs release tag (no 'v' prefix)
|
||||
@@ -0,0 +1,704 @@
|
||||
"""Low-level escape-hatch API. Most users go through `Bot` instead."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
from dataclasses import dataclass
|
||||
from typing import Any, Literal
|
||||
|
||||
from . import _native, core, util
|
||||
from .core import MigrationConfirmation
|
||||
from .types import CC, CEvt, CR, T
|
||||
|
||||
# Mirrors Node `ConnReqType` enum (api.ts:15-18) — the two possible outcomes
|
||||
# of `api_connect` / `api_connect_active_user` depending on the link kind.
|
||||
ConnReqType = Literal["invitation", "contact"]
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class SqliteDb:
|
||||
file_prefix: str
|
||||
encryption_key: str | None = None
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class PostgresDb:
|
||||
connection_string: str
|
||||
schema_prefix: str | None = None
|
||||
|
||||
|
||||
Db = SqliteDb | PostgresDb
|
||||
|
||||
|
||||
def _db_to_migrate_args(db: Db) -> tuple[str, str, _native.Backend]:
|
||||
"""Returns (path-or-prefix, key-or-conn, backend)."""
|
||||
if isinstance(db, SqliteDb):
|
||||
return (db.file_prefix, db.encryption_key or "", "sqlite")
|
||||
if isinstance(db, PostgresDb):
|
||||
return (db.schema_prefix or "", db.connection_string, "postgres")
|
||||
raise TypeError(f"Unknown db: {db!r}")
|
||||
|
||||
|
||||
class ChatCommandError(Exception):
|
||||
def __init__(self, message: str, response: CR.ChatResponse):
|
||||
super().__init__(message)
|
||||
self.response = response
|
||||
|
||||
|
||||
class ChatApi:
|
||||
def __init__(self, ctrl: int):
|
||||
self._ctrl: int | None = ctrl
|
||||
self._started = False
|
||||
|
||||
@classmethod
|
||||
async def init(
|
||||
cls,
|
||||
db: Db,
|
||||
confirm: MigrationConfirmation = MigrationConfirmation.YES_UP,
|
||||
) -> "ChatApi":
|
||||
path_or_prefix, key_or_conn, backend = _db_to_migrate_args(db)
|
||||
# Trigger lazy lib load with the right backend BEFORE chat_migrate_init.
|
||||
_native.lib_for(backend)
|
||||
ctrl = await core.chat_migrate_init(path_or_prefix, key_or_conn, confirm)
|
||||
return cls(ctrl)
|
||||
|
||||
@property
|
||||
def ctrl(self) -> int:
|
||||
"""Opaque controller pointer. Raises if `close()` has been called."""
|
||||
if self._ctrl is None:
|
||||
raise RuntimeError("ChatApi controller not initialized (close() called?)")
|
||||
return self._ctrl
|
||||
|
||||
@property
|
||||
def initialized(self) -> bool:
|
||||
"""True until `close()` is called. Mirrors Node `ChatApi.initialized`."""
|
||||
return self._ctrl is not None
|
||||
|
||||
@property
|
||||
def started(self) -> bool:
|
||||
"""True between `start_chat()` and the next `stop_chat()` / `close()`."""
|
||||
return self._started
|
||||
|
||||
async def start_chat(self) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.StartChat_cmd_string({"mainApp": True, "enableSndFiles": True})
|
||||
)
|
||||
if r.get("type") not in ("chatStarted", "chatRunning"):
|
||||
raise ChatCommandError("error starting chat", r)
|
||||
self._started = True
|
||||
|
||||
async def stop_chat(self) -> None:
|
||||
r = await self.send_chat_cmd("/_stop")
|
||||
if r.get("type") != "chatStopped":
|
||||
raise ChatCommandError("error stopping chat", r)
|
||||
self._started = False
|
||||
|
||||
async def close(self) -> None:
|
||||
await core.chat_close_store(self.ctrl)
|
||||
self._ctrl = None
|
||||
self._started = False
|
||||
|
||||
async def send_chat_cmd(self, cmd: str) -> CR.ChatResponse:
|
||||
return await core.chat_send_cmd(self.ctrl, cmd)
|
||||
|
||||
async def recv_chat_event(self, wait_us: int = 500_000) -> CEvt.ChatEvent | None:
|
||||
return await core.chat_recv_msg_wait(self.ctrl, wait_us)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Address commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_create_user_address(self, user_id: int) -> T.CreatedConnLink:
|
||||
r = await self.send_chat_cmd(CC.APICreateMyAddress_cmd_string({"userId": user_id}))
|
||||
if r["type"] == "userContactLinkCreated":
|
||||
return r["connLinkContact"]
|
||||
raise ChatCommandError("error creating user address", r)
|
||||
|
||||
async def api_delete_user_address(self, user_id: int) -> None:
|
||||
r = await self.send_chat_cmd(CC.APIDeleteMyAddress_cmd_string({"userId": user_id}))
|
||||
if r["type"] != "userContactLinkDeleted":
|
||||
raise ChatCommandError("error deleting user address", r)
|
||||
|
||||
async def api_get_user_address(self, user_id: int) -> T.UserContactLink | None:
|
||||
try:
|
||||
r = await self.send_chat_cmd(CC.APIShowMyAddress_cmd_string({"userId": user_id}))
|
||||
if r["type"] == "userContactLink":
|
||||
return r["contactLink"]
|
||||
raise ChatCommandError("error loading user address", r)
|
||||
except core.ChatAPIError as e:
|
||||
ce = e.chat_error
|
||||
if (
|
||||
ce is not None
|
||||
and ce.get("type") == "errorStore"
|
||||
and ce.get("storeError", {}).get("type") == "userContactLinkNotFound"
|
||||
):
|
||||
return None
|
||||
raise
|
||||
|
||||
async def api_set_profile_address(
|
||||
self, user_id: int, enable: bool
|
||||
) -> T.UserProfileUpdateSummary:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APISetProfileAddress_cmd_string({"userId": user_id, "enable": enable})
|
||||
)
|
||||
if r["type"] == "userProfileUpdated":
|
||||
return r["updateSummary"]
|
||||
raise ChatCommandError("error setting profile address", r)
|
||||
|
||||
async def api_set_address_settings(self, user_id: int, settings: T.AddressSettings) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APISetAddressSettings_cmd_string({"userId": user_id, "settings": settings})
|
||||
)
|
||||
if r["type"] != "userContactLinkUpdated":
|
||||
raise ChatCommandError("error changing user contact address settings", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Message commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_send_messages(
|
||||
self,
|
||||
chat: list | T.ChatRef | T.ChatInfo,
|
||||
messages: list[T.ComposedMessage],
|
||||
live_message: bool = False,
|
||||
) -> list[T.AChatItem]:
|
||||
if isinstance(chat, list):
|
||||
send_ref: T.ChatRef = {"chatType": chat[0], "chatId": chat[1]}
|
||||
elif "chatType" in chat and "chatId" in chat:
|
||||
send_ref = chat
|
||||
else:
|
||||
ref = util.chat_info_ref(chat)
|
||||
if ref is None:
|
||||
raise ValueError("api_send_messages: can't send messages to this chat")
|
||||
send_ref = ref
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APISendMessages_cmd_string(
|
||||
{
|
||||
"sendRef": send_ref,
|
||||
"composedMessages": messages,
|
||||
"liveMessage": live_message,
|
||||
}
|
||||
)
|
||||
)
|
||||
if r["type"] == "newChatItems":
|
||||
return r["chatItems"]
|
||||
raise ChatCommandError("unexpected response", r)
|
||||
|
||||
async def api_send_text_message(
|
||||
self,
|
||||
chat: list | T.ChatRef | T.ChatInfo,
|
||||
text: str,
|
||||
in_reply_to: int | None = None,
|
||||
) -> list[T.AChatItem]:
|
||||
msg: T.ComposedMessage = {"msgContent": {"type": "text", "text": text}, "mentions": {}}
|
||||
if in_reply_to is not None:
|
||||
msg["quotedItemId"] = in_reply_to
|
||||
return await self.api_send_messages(chat, [msg])
|
||||
|
||||
async def api_send_text_reply(self, chat_item: T.AChatItem, text: str) -> list[T.AChatItem]:
|
||||
return await self.api_send_text_message(
|
||||
chat_item["chatInfo"], text, chat_item["chatItem"]["meta"]["itemId"]
|
||||
)
|
||||
|
||||
async def api_update_chat_item(
|
||||
self,
|
||||
chat_type: T.ChatType,
|
||||
chat_id: int,
|
||||
chat_item_id: int,
|
||||
msg_content: T.MsgContent,
|
||||
live_message: bool = False,
|
||||
) -> T.ChatItem:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIUpdateChatItem_cmd_string(
|
||||
{
|
||||
"chatRef": {"chatType": chat_type, "chatId": chat_id},
|
||||
"chatItemId": chat_item_id,
|
||||
"liveMessage": live_message,
|
||||
"updatedMessage": {"msgContent": msg_content, "mentions": {}},
|
||||
}
|
||||
)
|
||||
)
|
||||
if r["type"] == "chatItemUpdated":
|
||||
return r["chatItem"]["chatItem"]
|
||||
raise ChatCommandError("error updating chat item", r)
|
||||
|
||||
async def api_delete_chat_items(
|
||||
self,
|
||||
chat_type: T.ChatType,
|
||||
chat_id: int,
|
||||
chat_item_ids: list[int],
|
||||
delete_mode: T.CIDeleteMode,
|
||||
) -> list[T.ChatItemDeletion]:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIDeleteChatItem_cmd_string(
|
||||
{
|
||||
"chatRef": {"chatType": chat_type, "chatId": chat_id},
|
||||
"chatItemIds": chat_item_ids,
|
||||
"deleteMode": delete_mode,
|
||||
}
|
||||
)
|
||||
)
|
||||
if r["type"] == "chatItemsDeleted":
|
||||
return r["chatItemDeletions"]
|
||||
raise ChatCommandError("error deleting chat item", r)
|
||||
|
||||
async def api_delete_member_chat_item(
|
||||
self, group_id: int, chat_item_ids: list[int]
|
||||
) -> list[T.ChatItemDeletion]:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIDeleteMemberChatItem_cmd_string(
|
||||
{"groupId": group_id, "chatItemIds": chat_item_ids}
|
||||
)
|
||||
)
|
||||
if r["type"] == "chatItemsDeleted":
|
||||
return r["chatItemDeletions"]
|
||||
raise ChatCommandError("error deleting member chat item", r)
|
||||
|
||||
async def api_chat_item_reaction(
|
||||
self,
|
||||
chat_type: T.ChatType,
|
||||
chat_id: int,
|
||||
chat_item_id: int,
|
||||
add: bool,
|
||||
reaction: T.MsgReaction,
|
||||
) -> T.ACIReaction:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIChatItemReaction_cmd_string(
|
||||
{
|
||||
"chatRef": {"chatType": chat_type, "chatId": chat_id},
|
||||
"chatItemId": chat_item_id,
|
||||
"add": add,
|
||||
"reaction": reaction,
|
||||
}
|
||||
)
|
||||
)
|
||||
if r["type"] == "chatItemReaction":
|
||||
return r["reaction"]
|
||||
raise ChatCommandError("error setting item reaction", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# File commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_receive_file(self, file_id: int) -> T.AChatItem:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.ReceiveFile_cmd_string({"fileId": file_id, "userApprovedRelays": True})
|
||||
)
|
||||
if r["type"] == "rcvFileAccepted":
|
||||
return r["chatItem"]
|
||||
raise ChatCommandError("error receiving file", r)
|
||||
|
||||
async def api_cancel_file(self, file_id: int) -> None:
|
||||
r = await self.send_chat_cmd(CC.CancelFile_cmd_string({"fileId": file_id}))
|
||||
if r["type"] not in ("sndFileCancelled", "rcvFileCancelled"):
|
||||
raise ChatCommandError("error canceling file", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Group commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_add_member(
|
||||
self, group_id: int, contact_id: int, member_role: T.GroupMemberRole
|
||||
) -> T.GroupMember:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIAddMember_cmd_string(
|
||||
{"groupId": group_id, "contactId": contact_id, "memberRole": member_role}
|
||||
)
|
||||
)
|
||||
if r["type"] == "sentGroupInvitation":
|
||||
return r["member"]
|
||||
raise ChatCommandError("error adding member", r)
|
||||
|
||||
async def api_join_group(self, group_id: int) -> T.GroupInfo:
|
||||
r = await self.send_chat_cmd(CC.APIJoinGroup_cmd_string({"groupId": group_id}))
|
||||
if r["type"] == "userAcceptedGroupSent":
|
||||
return r["groupInfo"]
|
||||
raise ChatCommandError("error joining group", r)
|
||||
|
||||
async def api_accept_member(
|
||||
self, group_id: int, group_member_id: int, member_role: T.GroupMemberRole
|
||||
) -> T.GroupMember:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIAcceptMember_cmd_string(
|
||||
{"groupId": group_id, "groupMemberId": group_member_id, "memberRole": member_role}
|
||||
)
|
||||
)
|
||||
if r["type"] == "memberAccepted":
|
||||
return r["member"]
|
||||
raise ChatCommandError("error accepting member", r)
|
||||
|
||||
async def api_set_members_role(
|
||||
self, group_id: int, group_member_ids: list[int], member_role: T.GroupMemberRole
|
||||
) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIMembersRole_cmd_string(
|
||||
{"groupId": group_id, "groupMemberIds": group_member_ids, "memberRole": member_role}
|
||||
)
|
||||
)
|
||||
if r["type"] != "membersRoleUser":
|
||||
raise ChatCommandError("error setting members role", r)
|
||||
|
||||
async def api_block_members_for_all(
|
||||
self, group_id: int, group_member_ids: list[int], blocked: bool
|
||||
) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIBlockMembersForAll_cmd_string(
|
||||
{"groupId": group_id, "groupMemberIds": group_member_ids, "blocked": blocked}
|
||||
)
|
||||
)
|
||||
if r["type"] != "membersBlockedForAllUser":
|
||||
raise ChatCommandError("error blocking members", r)
|
||||
|
||||
async def api_remove_members(
|
||||
self, group_id: int, member_ids: list[int], with_messages: bool = False
|
||||
) -> list[T.GroupMember]:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIRemoveMembers_cmd_string(
|
||||
{"groupId": group_id, "groupMemberIds": member_ids, "withMessages": with_messages}
|
||||
)
|
||||
)
|
||||
if r["type"] == "userDeletedMembers":
|
||||
return r["members"]
|
||||
raise ChatCommandError("error removing member", r)
|
||||
|
||||
async def api_leave_group(self, group_id: int) -> T.GroupInfo:
|
||||
r = await self.send_chat_cmd(CC.APILeaveGroup_cmd_string({"groupId": group_id}))
|
||||
if r["type"] == "leftMemberUser":
|
||||
return r["groupInfo"]
|
||||
raise ChatCommandError("error leaving group", r)
|
||||
|
||||
async def api_list_members(self, group_id: int) -> list[T.GroupMember]:
|
||||
r = await self.send_chat_cmd(CC.APIListMembers_cmd_string({"groupId": group_id}))
|
||||
if r["type"] == "groupMembers":
|
||||
return r["group"]["members"]
|
||||
raise ChatCommandError("error getting group members", r)
|
||||
|
||||
async def api_new_group(self, user_id: int, group_profile: T.GroupProfile) -> T.GroupInfo:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APINewGroup_cmd_string(
|
||||
{"userId": user_id, "groupProfile": group_profile, "incognito": False}
|
||||
)
|
||||
)
|
||||
if r["type"] == "groupCreated":
|
||||
return r["groupInfo"]
|
||||
raise ChatCommandError("error creating group", r)
|
||||
|
||||
async def api_update_group_profile(
|
||||
self, group_id: int, group_profile: T.GroupProfile
|
||||
) -> T.GroupInfo:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIUpdateGroupProfile_cmd_string(
|
||||
{"groupId": group_id, "groupProfile": group_profile}
|
||||
)
|
||||
)
|
||||
if r["type"] == "groupUpdated":
|
||||
return r["toGroup"]
|
||||
raise ChatCommandError("error updating group", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Group link commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_create_group_link(self, group_id: int, member_role: T.GroupMemberRole) -> str:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APICreateGroupLink_cmd_string({"groupId": group_id, "memberRole": member_role})
|
||||
)
|
||||
if r["type"] == "groupLinkCreated":
|
||||
link = r["groupLink"]["connLinkContact"]
|
||||
return link.get("connShortLink") or link["connFullLink"]
|
||||
raise ChatCommandError("error creating group link", r)
|
||||
|
||||
async def api_set_group_link_member_role(
|
||||
self, group_id: int, member_role: T.GroupMemberRole
|
||||
) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIGroupLinkMemberRole_cmd_string({"groupId": group_id, "memberRole": member_role})
|
||||
)
|
||||
if r["type"] != "groupLink":
|
||||
raise ChatCommandError("error setting group link member role", r)
|
||||
|
||||
async def api_delete_group_link(self, group_id: int) -> None:
|
||||
r = await self.send_chat_cmd(CC.APIDeleteGroupLink_cmd_string({"groupId": group_id}))
|
||||
if r["type"] != "groupLinkDeleted":
|
||||
raise ChatCommandError("error deleting group link", r)
|
||||
|
||||
async def api_get_group_link(self, group_id: int) -> T.GroupLink:
|
||||
r = await self.send_chat_cmd(CC.APIGetGroupLink_cmd_string({"groupId": group_id}))
|
||||
if r["type"] == "groupLink":
|
||||
return r["groupLink"]
|
||||
raise ChatCommandError("error getting group link", r)
|
||||
|
||||
async def api_get_group_link_str(self, group_id: int) -> str:
|
||||
link = (await self.api_get_group_link(group_id))["connLinkContact"]
|
||||
return link.get("connShortLink") or link["connFullLink"]
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Connection commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_create_link(self, user_id: int) -> str:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIAddContact_cmd_string({"userId": user_id, "incognito": False})
|
||||
)
|
||||
if r["type"] == "invitation":
|
||||
link = r["connLinkInvitation"]
|
||||
return link.get("connShortLink") or link["connFullLink"]
|
||||
raise ChatCommandError("error creating link", r)
|
||||
|
||||
async def api_connect_plan(
|
||||
self, user_id: int, connection_link: str
|
||||
) -> tuple[T.ConnectionPlan, T.CreatedConnLink]:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIConnectPlan_cmd_string(
|
||||
{"userId": user_id, "connectionLink": connection_link, "resolveKnown": False}
|
||||
)
|
||||
)
|
||||
if r["type"] == "connectionPlan":
|
||||
return (r["connectionPlan"], r["connLink"])
|
||||
raise ChatCommandError("error getting connect plan", r)
|
||||
|
||||
async def api_connect(
|
||||
self,
|
||||
user_id: int,
|
||||
incognito: bool,
|
||||
prepared_link: T.CreatedConnLink | None = None,
|
||||
) -> ConnReqType:
|
||||
args: CC.APIConnect = {"userId": user_id, "incognito": incognito}
|
||||
if prepared_link is not None:
|
||||
args["preparedLink_"] = prepared_link
|
||||
r = await self.send_chat_cmd(CC.APIConnect_cmd_string(args))
|
||||
return self._handle_connect_result(r)
|
||||
|
||||
async def api_connect_active_user(self, conn_link: str) -> ConnReqType:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.Connect_cmd_string({"incognito": False, "connLink_": conn_link})
|
||||
)
|
||||
return self._handle_connect_result(r)
|
||||
|
||||
def _handle_connect_result(self, r: CR.ChatResponse) -> ConnReqType:
|
||||
if r["type"] == "sentConfirmation":
|
||||
return "invitation"
|
||||
if r["type"] == "sentInvitation":
|
||||
return "contact"
|
||||
if r["type"] == "contactAlreadyExists":
|
||||
raise ChatCommandError("contact already exists", r)
|
||||
raise ChatCommandError("connection error", r)
|
||||
|
||||
async def api_accept_contact_request(self, contact_req_id: int) -> T.Contact:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIAcceptContact_cmd_string({"contactReqId": contact_req_id})
|
||||
)
|
||||
if r["type"] == "acceptingContactRequest":
|
||||
return r["contact"]
|
||||
raise ChatCommandError("error accepting contact request", r)
|
||||
|
||||
async def api_reject_contact_request(self, contact_req_id: int) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIRejectContact_cmd_string({"contactReqId": contact_req_id})
|
||||
)
|
||||
if r["type"] != "contactRequestRejected":
|
||||
raise ChatCommandError("error rejecting contact request", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Chat commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_list_contacts(self, user_id: int) -> list[T.Contact]:
|
||||
r = await self.send_chat_cmd(CC.APIListContacts_cmd_string({"userId": user_id}))
|
||||
if r["type"] == "contactsList":
|
||||
return r["contacts"]
|
||||
raise ChatCommandError("error listing contacts", r)
|
||||
|
||||
async def api_list_groups(
|
||||
self,
|
||||
user_id: int,
|
||||
contact_id: int | None = None,
|
||||
search: str | None = None,
|
||||
) -> list[T.GroupInfo]:
|
||||
args: CC.APIListGroups = {"userId": user_id}
|
||||
if contact_id is not None:
|
||||
args["contactId_"] = contact_id
|
||||
if search is not None:
|
||||
args["search"] = search
|
||||
r = await self.send_chat_cmd(CC.APIListGroups_cmd_string(args))
|
||||
if r["type"] == "groupsList":
|
||||
return r["groups"]
|
||||
raise ChatCommandError("error listing groups", r)
|
||||
|
||||
async def api_get_chats(
|
||||
self,
|
||||
user_id: int,
|
||||
pagination: T.PaginationByTime,
|
||||
query: T.ChatListQuery | None = None,
|
||||
pending_connections: bool = False,
|
||||
) -> list[T.AChat]:
|
||||
if query is None:
|
||||
query = {"type": "filters", "favorite": False, "unread": False}
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIGetChats_cmd_string(
|
||||
{
|
||||
"userId": user_id,
|
||||
"pendingConnections": pending_connections,
|
||||
"pagination": pagination,
|
||||
"query": query,
|
||||
}
|
||||
)
|
||||
)
|
||||
if r["type"] == "apiChats":
|
||||
return r["chats"]
|
||||
raise ChatCommandError("error getting chats", r)
|
||||
|
||||
async def api_delete_chat(
|
||||
self,
|
||||
chat_type: T.ChatType,
|
||||
chat_id: int,
|
||||
delete_mode: T.ChatDeleteMode | None = None,
|
||||
) -> None:
|
||||
if delete_mode is None:
|
||||
delete_mode = {"type": "full", "notify": True}
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIDeleteChat_cmd_string(
|
||||
{
|
||||
"chatRef": {"chatType": chat_type, "chatId": chat_id},
|
||||
"chatDeleteMode": delete_mode,
|
||||
}
|
||||
)
|
||||
)
|
||||
if chat_type == "direct" and r["type"] == "contactDeleted":
|
||||
return
|
||||
if chat_type == "group" and r["type"] == "groupDeletedUser":
|
||||
return
|
||||
raise ChatCommandError("error deleting chat", r)
|
||||
|
||||
async def api_set_group_custom_data(
|
||||
self, group_id: int, custom_data: dict[str, object] | None = None
|
||||
) -> None:
|
||||
args: CC.APISetGroupCustomData = {"groupId": group_id}
|
||||
if custom_data is not None:
|
||||
args["customData"] = custom_data
|
||||
r = await self.send_chat_cmd(CC.APISetGroupCustomData_cmd_string(args))
|
||||
if r["type"] != "cmdOk":
|
||||
raise ChatCommandError("error setting group custom data", r)
|
||||
|
||||
async def api_set_contact_custom_data(
|
||||
self, contact_id: int, custom_data: dict[str, object] | None = None
|
||||
) -> None:
|
||||
args: CC.APISetContactCustomData = {"contactId": contact_id}
|
||||
if custom_data is not None:
|
||||
args["customData"] = custom_data
|
||||
r = await self.send_chat_cmd(CC.APISetContactCustomData_cmd_string(args))
|
||||
if r["type"] != "cmdOk":
|
||||
raise ChatCommandError("error setting contact custom data", r)
|
||||
|
||||
async def api_set_auto_accept_member_contacts(self, user_id: int, on_off: bool) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APISetUserAutoAcceptMemberContacts_cmd_string({"userId": user_id, "onOff": on_off})
|
||||
)
|
||||
if r["type"] != "cmdOk":
|
||||
raise ChatCommandError("error setting auto-accept member contacts", r)
|
||||
|
||||
async def api_get_chat(self, chat_type: T.ChatType, chat_id: int, count: int) -> dict[str, Any]:
|
||||
ref = T.ChatType_cmd_string(chat_type) + str(chat_id)
|
||||
r = await self.send_chat_cmd(f"/_get chat {ref} count={count}")
|
||||
if r["type"] == "apiChat":
|
||||
return r["chat"]
|
||||
raise ChatCommandError("error getting chat", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# User profile commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_get_active_user(self) -> T.User | None:
|
||||
try:
|
||||
r = await self.send_chat_cmd(CC.ShowActiveUser_cmd_string({}))
|
||||
if r["type"] == "activeUser":
|
||||
return r["user"]
|
||||
raise ChatCommandError("unexpected response", r)
|
||||
except core.ChatAPIError as e:
|
||||
ce = e.chat_error
|
||||
if (
|
||||
ce is not None
|
||||
and ce.get("type") == "error"
|
||||
and ce.get("errorType", {}).get("type") == "noActiveUser"
|
||||
):
|
||||
return None
|
||||
raise
|
||||
|
||||
async def api_create_active_user(self, profile: T.Profile | None = None) -> T.User:
|
||||
new_user: T.NewUser = {"pastTimestamp": False, "userChatRelay": False}
|
||||
if profile is not None:
|
||||
new_user["profile"] = profile
|
||||
r = await self.send_chat_cmd(CC.CreateActiveUser_cmd_string({"newUser": new_user}))
|
||||
if r["type"] == "activeUser":
|
||||
return r["user"]
|
||||
raise ChatCommandError("unexpected response", r)
|
||||
|
||||
async def api_list_users(self) -> list[T.UserInfo]:
|
||||
r = await self.send_chat_cmd(CC.ListUsers_cmd_string({}))
|
||||
if r["type"] == "usersList":
|
||||
return r["users"]
|
||||
raise ChatCommandError("error listing users", r)
|
||||
|
||||
async def api_set_active_user(self, user_id: int, view_pwd: str | None = None) -> T.User:
|
||||
args: CC.APISetActiveUser = {"userId": user_id}
|
||||
if view_pwd is not None:
|
||||
args["viewPwd"] = view_pwd
|
||||
r = await self.send_chat_cmd(CC.APISetActiveUser_cmd_string(args))
|
||||
if r["type"] == "activeUser":
|
||||
return r["user"]
|
||||
raise ChatCommandError("error setting active user", r)
|
||||
|
||||
async def api_delete_user(
|
||||
self, user_id: int, del_smp_queues: bool, view_pwd: str | None = None
|
||||
) -> None:
|
||||
args: CC.APIDeleteUser = {"userId": user_id, "delSMPQueues": del_smp_queues}
|
||||
if view_pwd is not None:
|
||||
args["viewPwd"] = view_pwd
|
||||
r = await self.send_chat_cmd(CC.APIDeleteUser_cmd_string(args))
|
||||
if r["type"] != "cmdOk":
|
||||
raise ChatCommandError("error deleting user", r)
|
||||
|
||||
async def api_update_profile(
|
||||
self, user_id: int, profile: T.Profile
|
||||
) -> T.UserProfileUpdateSummary | None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APIUpdateProfile_cmd_string({"userId": user_id, "profile": profile})
|
||||
)
|
||||
if r["type"] == "userProfileNoChange":
|
||||
return None
|
||||
if r["type"] == "userProfileUpdated":
|
||||
return r["updateSummary"]
|
||||
raise ChatCommandError("error updating profile", r)
|
||||
|
||||
async def api_set_contact_prefs(self, contact_id: int, preferences: T.Preferences) -> None:
|
||||
r = await self.send_chat_cmd(
|
||||
CC.APISetContactPrefs_cmd_string({"contactId": contact_id, "preferences": preferences})
|
||||
)
|
||||
if r["type"] != "contactPrefsUpdated":
|
||||
raise ChatCommandError("error setting contact prefs", r)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Member contact commands
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def api_create_member_contact(self, group_id: int, group_member_id: int) -> T.Contact:
|
||||
r = await self.send_chat_cmd(f"/_create member contact #{group_id} {group_member_id}")
|
||||
if r["type"] == "newMemberContact":
|
||||
return r["contact"]
|
||||
raise ChatCommandError("error creating member contact", r)
|
||||
|
||||
async def api_send_member_contact_invitation(
|
||||
self,
|
||||
contact_id: int,
|
||||
message: T.MsgContent | str | None = None,
|
||||
) -> T.Contact:
|
||||
cmd = f"/_invite member contact @{contact_id}"
|
||||
if message is not None:
|
||||
if isinstance(message, str):
|
||||
cmd += f" text {message}"
|
||||
else:
|
||||
cmd += f" json {json.dumps(message)}"
|
||||
r = await self.send_chat_cmd(cmd)
|
||||
if r["type"] == "newMemberContactSentInv":
|
||||
return r["contact"]
|
||||
raise ChatCommandError("error sending member contact invitation", r)
|
||||
@@ -0,0 +1,707 @@
|
||||
"""User-facing `Bot` API: decorators, filters, Message wrapper, lifecycle."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import os
|
||||
import signal as _signal
|
||||
from collections.abc import Awaitable, Callable
|
||||
from dataclasses import dataclass
|
||||
from typing import Any, Generic, Literal, TypeVar, overload
|
||||
|
||||
from . import util
|
||||
from .api import ChatApi, Db
|
||||
from .core import MigrationConfirmation
|
||||
from .filters import compile_message_filter
|
||||
from .types import CEvt, T
|
||||
|
||||
log = logging.getLogger("simplex_chat")
|
||||
|
||||
C = TypeVar("C", bound="T.MsgContent")
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class BotProfile:
|
||||
display_name: str
|
||||
full_name: str = ""
|
||||
short_descr: str | None = None
|
||||
image: str | None = None
|
||||
|
||||
|
||||
@dataclass(slots=True)
|
||||
class BotCommand:
|
||||
keyword: str
|
||||
label: str
|
||||
|
||||
|
||||
@dataclass(slots=True, frozen=True)
|
||||
class ParsedCommand:
|
||||
keyword: str
|
||||
args: str
|
||||
|
||||
|
||||
@dataclass(slots=True, frozen=True)
|
||||
class Message(Generic[C]):
|
||||
chat_item: T.AChatItem
|
||||
content: C
|
||||
bot: "Bot"
|
||||
|
||||
@property
|
||||
def chat_info(self) -> T.ChatInfo:
|
||||
return self.chat_item["chatInfo"]
|
||||
|
||||
@property
|
||||
def text(self) -> str | None:
|
||||
c = self.content
|
||||
if isinstance(c, dict):
|
||||
return c.get("text") # type: ignore[return-value]
|
||||
return None
|
||||
|
||||
async def reply(self, text: str) -> "Message[T.MsgContent]":
|
||||
items = await self.bot.api.api_send_text_reply(self.chat_item, text)
|
||||
ci = items[0]
|
||||
content = ci["chatItem"]["content"]
|
||||
# content is CIContent — snd variant has msgContent; cast for type safety.
|
||||
msg_content: T.MsgContent = content["msgContent"] # type: ignore[index]
|
||||
return Message(chat_item=ci, content=msg_content, bot=self.bot)
|
||||
|
||||
async def reply_content(self, content: T.MsgContent) -> "Message[T.MsgContent]":
|
||||
items = await self.bot.api.api_send_messages(
|
||||
self.chat_info, [{"msgContent": content, "mentions": {}}]
|
||||
)
|
||||
ci = items[0]
|
||||
ci_content = ci["chatItem"]["content"]
|
||||
msg_content: T.MsgContent = ci_content["msgContent"] # type: ignore[index]
|
||||
return Message(chat_item=ci, content=msg_content, bot=self.bot)
|
||||
|
||||
|
||||
# Concrete narrowed aliases — one per MsgContent_<tag> variant in _types.py.
|
||||
TextMessage = Message[T.MsgContent_text]
|
||||
LinkMessage = Message[T.MsgContent_link]
|
||||
ImageMessage = Message[T.MsgContent_image]
|
||||
VideoMessage = Message[T.MsgContent_video]
|
||||
VoiceMessage = Message[T.MsgContent_voice]
|
||||
FileMessage = Message[T.MsgContent_file]
|
||||
ReportMessage = Message[T.MsgContent_report]
|
||||
ChatMessage = Message[T.MsgContent_chat]
|
||||
UnknownMessage = Message[T.MsgContent_unknown]
|
||||
|
||||
MessageHandler = Callable[[Message[Any]], Awaitable[None]]
|
||||
CommandHandler = Callable[[Message[Any], ParsedCommand], Awaitable[None]]
|
||||
EventHandler = Callable[[CEvt.ChatEvent], Awaitable[None]]
|
||||
|
||||
|
||||
class Middleware:
|
||||
"""Override `__call__` to wrap message handlers with cross-cutting logic.
|
||||
|
||||
`handler` is the next stage in the chain — call it with `(message, data)`
|
||||
to continue, or skip the call to short-circuit. `data` is a per-dispatch
|
||||
dict that middleware can use to pass values down the chain.
|
||||
"""
|
||||
|
||||
async def __call__(
|
||||
self,
|
||||
handler: Callable[[Message[Any], dict[str, object]], Awaitable[None]],
|
||||
message: Message[Any],
|
||||
data: dict[str, object],
|
||||
) -> None:
|
||||
await handler(message, data)
|
||||
|
||||
|
||||
class Bot:
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
profile: BotProfile,
|
||||
db: Db,
|
||||
welcome: str | T.MsgContent | None = None,
|
||||
commands: list[BotCommand] | None = None,
|
||||
confirm_migrations: MigrationConfirmation = MigrationConfirmation.YES_UP,
|
||||
create_address: bool = True,
|
||||
update_address: bool = True,
|
||||
update_profile: bool = True,
|
||||
auto_accept: bool = True,
|
||||
business_address: bool = False,
|
||||
allow_files: bool = False,
|
||||
use_bot_profile: bool = True,
|
||||
log_contacts: bool = True,
|
||||
log_network: bool = False,
|
||||
) -> None:
|
||||
self._profile = profile
|
||||
self._db = db
|
||||
self._welcome = welcome
|
||||
self._commands = commands or []
|
||||
self._confirm_migrations = confirm_migrations
|
||||
self._opts = {
|
||||
"create_address": create_address,
|
||||
"update_address": update_address,
|
||||
"update_profile": update_profile,
|
||||
"auto_accept": auto_accept,
|
||||
"business_address": business_address,
|
||||
"allow_files": allow_files,
|
||||
"use_bot_profile": use_bot_profile,
|
||||
"log_contacts": log_contacts,
|
||||
"log_network": log_network,
|
||||
}
|
||||
self._api: ChatApi | None = None
|
||||
self._serving = False
|
||||
self._stop_event = asyncio.Event()
|
||||
self._message_handlers: list[tuple[Callable[[Message[Any]], bool], MessageHandler]] = []
|
||||
self._command_handlers: list[
|
||||
tuple[tuple[str, ...], Callable[[Message[Any]], bool], CommandHandler]
|
||||
] = []
|
||||
self._event_handlers: dict[str, list[EventHandler]] = {}
|
||||
self._middleware: list[Middleware] = []
|
||||
# Track default-handler registration so __aenter__ on a re-used bot
|
||||
# doesn't accumulate duplicate log/error handlers.
|
||||
self._defaults_registered = False
|
||||
|
||||
@property
|
||||
def api(self) -> ChatApi:
|
||||
if self._api is None:
|
||||
raise RuntimeError("Bot not initialized — call bot.run() or use `async with bot:`")
|
||||
return self._api
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Decorators
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["text"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[TextMessage], Awaitable[None]]],
|
||||
Callable[[TextMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["link"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[LinkMessage], Awaitable[None]]],
|
||||
Callable[[LinkMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["image"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[ImageMessage], Awaitable[None]]],
|
||||
Callable[[ImageMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["video"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[VideoMessage], Awaitable[None]]],
|
||||
Callable[[VideoMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["voice"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[VoiceMessage], Awaitable[None]]],
|
||||
Callable[[VoiceMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["file"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[FileMessage], Awaitable[None]]],
|
||||
Callable[[FileMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["report"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[ReportMessage], Awaitable[None]]],
|
||||
Callable[[ReportMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["chat"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[ChatMessage], Awaitable[None]]],
|
||||
Callable[[ChatMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(
|
||||
self, *, content_type: Literal["unknown"], **rest: Any
|
||||
) -> Callable[
|
||||
[Callable[[UnknownMessage], Awaitable[None]]],
|
||||
Callable[[UnknownMessage], Awaitable[None]],
|
||||
]: ...
|
||||
|
||||
@overload
|
||||
def on_message(self, **rest: Any) -> Callable[[MessageHandler], MessageHandler]: ...
|
||||
|
||||
def on_message(self, **filter_kw: Any) -> Callable[[MessageHandler], MessageHandler]:
|
||||
predicate = compile_message_filter(filter_kw)
|
||||
|
||||
def deco(fn: MessageHandler) -> MessageHandler:
|
||||
self._message_handlers.append((predicate, fn))
|
||||
return fn
|
||||
|
||||
return deco
|
||||
|
||||
def on_command(
|
||||
self, name: str | tuple[str, ...], **filter_kw: Any
|
||||
) -> Callable[[CommandHandler], CommandHandler]:
|
||||
names = (name,) if isinstance(name, str) else tuple(name)
|
||||
predicate = compile_message_filter(filter_kw)
|
||||
|
||||
def deco(fn: CommandHandler) -> CommandHandler:
|
||||
self._command_handlers.append((names, predicate, fn))
|
||||
return fn
|
||||
|
||||
return deco
|
||||
|
||||
def on_event(self, event: CEvt.ChatEvent_Tag, /) -> Callable[[EventHandler], EventHandler]:
|
||||
def deco(fn: EventHandler) -> EventHandler:
|
||||
self._event_handlers.setdefault(event, []).append(fn)
|
||||
return fn
|
||||
|
||||
return deco
|
||||
|
||||
def use(self, middleware: Middleware) -> None:
|
||||
self._middleware.append(middleware)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Lifecycle
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def __aenter__(self) -> "Bot":
|
||||
# Order matters: libsimplex `/_start` requires an active user, so
|
||||
# ensure (or create) the user first, THEN start the chat, THEN
|
||||
# do address + profile sync. Mirrors Node bot.ts:48-64.
|
||||
self._api = await ChatApi.init(self._db, self._confirm_migrations)
|
||||
user = await self._ensure_active_user()
|
||||
await self._api.start_chat()
|
||||
await self._sync_address_and_profile(user)
|
||||
self._register_log_handlers()
|
||||
return self
|
||||
|
||||
async def __aexit__(self, *exc_info: object) -> None:
|
||||
self.stop()
|
||||
if self._api is not None:
|
||||
try:
|
||||
await self._api.stop_chat()
|
||||
finally:
|
||||
await self._api.close()
|
||||
self._api = None
|
||||
|
||||
def run(self) -> None:
|
||||
"""Blocking entry: runs serve_forever() with SIGINT/SIGTERM handlers installed.
|
||||
|
||||
Configures `logging.basicConfig(level=INFO)` if the root logger has no
|
||||
handlers yet, so the bot's startup messages and the announced address
|
||||
are visible without callers having to set up logging. Embedders that
|
||||
manage logging themselves are unaffected (basicConfig is a no-op when
|
||||
handlers already exist).
|
||||
"""
|
||||
if not logging.getLogger().handlers:
|
||||
logging.basicConfig(
|
||||
level=logging.INFO,
|
||||
format="%(asctime)s %(levelname)s %(name)s %(message)s",
|
||||
)
|
||||
|
||||
async def _main() -> None:
|
||||
async with self:
|
||||
loop = asyncio.get_running_loop()
|
||||
# First Ctrl+C → graceful stop (~500ms, bounded by the
|
||||
# receive-loop poll interval). Second Ctrl+C → force-exit
|
||||
# immediately (in case stop_chat / close hang on a wedged
|
||||
# FFI call). Standard CLI UX (jupyter, ipython, …).
|
||||
sigint_count = 0
|
||||
|
||||
def on_interrupt() -> None:
|
||||
nonlocal sigint_count
|
||||
sigint_count += 1
|
||||
if sigint_count == 1:
|
||||
log.info("stopping bot... (press Ctrl+C again to force exit)")
|
||||
self.stop()
|
||||
else:
|
||||
os._exit(130) # 128 + SIGINT
|
||||
|
||||
if hasattr(_signal, "SIGINT"):
|
||||
try:
|
||||
loop.add_signal_handler(_signal.SIGINT, on_interrupt)
|
||||
loop.add_signal_handler(_signal.SIGTERM, self.stop)
|
||||
except NotImplementedError: # Windows
|
||||
_signal.signal(_signal.SIGINT, lambda *_: on_interrupt())
|
||||
await self.serve_forever()
|
||||
|
||||
asyncio.run(_main())
|
||||
|
||||
async def serve_forever(self) -> None:
|
||||
if self._serving:
|
||||
raise RuntimeError("already serving")
|
||||
self._serving = True
|
||||
self._stop_event.clear()
|
||||
try:
|
||||
await self._receive_loop()
|
||||
finally:
|
||||
self._serving = False
|
||||
|
||||
def stop(self) -> None:
|
||||
self._stop_event.set()
|
||||
|
||||
async def _receive_loop(self) -> None:
|
||||
# Catch broad Exception so a single malformed event or transient
|
||||
# native error doesn't crash the whole bot. CancelledError must
|
||||
# always re-raise so `bot.stop()` and asyncio cancellation work.
|
||||
# `wait_us=500_000` (500ms) bounds the worst-case Ctrl+C latency:
|
||||
# the C call blocks the worker thread until timeout, and the loop
|
||||
# only checks `_stop_event` between polls.
|
||||
while not self._stop_event.is_set():
|
||||
try:
|
||||
event = await self.api.recv_chat_event(wait_us=500_000)
|
||||
except asyncio.CancelledError:
|
||||
raise
|
||||
except Exception:
|
||||
log.exception("recv_chat_event failed")
|
||||
# Bound the spin rate when the FFI is wedged on a persistent
|
||||
# error (vs the timeout path, which already paces itself).
|
||||
await asyncio.sleep(0.5)
|
||||
continue
|
||||
if event is None:
|
||||
continue
|
||||
try:
|
||||
await self._dispatch_event(event)
|
||||
except asyncio.CancelledError:
|
||||
raise
|
||||
except Exception:
|
||||
log.exception("dispatch_event failed for tag=%s", event.get("type"))
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Dispatch
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def _dispatch_event(self, event: CEvt.ChatEvent) -> None:
|
||||
tag = event["type"]
|
||||
for h in self._event_handlers.get(tag, []):
|
||||
try:
|
||||
await h(event)
|
||||
except Exception:
|
||||
log.exception("on_event handler failed")
|
||||
if tag == "newChatItems":
|
||||
evt: CEvt.NewChatItems = event # type: ignore[assignment]
|
||||
for ci in evt["chatItems"]:
|
||||
content = ci["chatItem"]["content"]
|
||||
if content["type"] != "rcvMsgContent":
|
||||
continue
|
||||
msg_content = content["msgContent"] # type: ignore[index]
|
||||
msg: Message[T.MsgContent] = Message(chat_item=ci, content=msg_content, bot=self)
|
||||
await self._dispatch_message(msg)
|
||||
|
||||
async def _dispatch_message(self, msg: Message[Any]) -> None:
|
||||
# First-match-wins. The squaring bot's `@on_message(text=NUMBER_RE)`
|
||||
# and catch-all `@on_message(content_type="text")` both match a number
|
||||
# like "1"; we want only the first to fire. Registration order is the
|
||||
# priority order — register the most-specific filters first.
|
||||
#
|
||||
# Slash-commands are tried first against command handlers; if no
|
||||
# command handler matches, fall through to message handlers (so
|
||||
# `@on_message` can still catch unknown slash-commands).
|
||||
cmd = self._parse_command(msg)
|
||||
if cmd is not None:
|
||||
for names, predicate, handler in self._command_handlers:
|
||||
if cmd.keyword in names and predicate(msg):
|
||||
await self._invoke_command_with_middleware(handler, msg, cmd)
|
||||
return
|
||||
for predicate, handler in self._message_handlers:
|
||||
if predicate(msg):
|
||||
await self._invoke_with_middleware(handler, msg)
|
||||
return
|
||||
|
||||
async def _invoke_with_middleware(self, handler: MessageHandler, message: Message[Any]) -> None:
|
||||
# Fast path: most bots register no middleware. Skip the closure-chain
|
||||
# construction and the empty-data dict on every dispatch.
|
||||
if not self._middleware:
|
||||
try:
|
||||
await handler(message)
|
||||
except Exception:
|
||||
log.exception("message handler failed")
|
||||
return
|
||||
|
||||
async def call(m: Message[Any], _data: dict[str, object]) -> None:
|
||||
await handler(m)
|
||||
|
||||
chain: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = call
|
||||
for mw in reversed(self._middleware):
|
||||
inner = chain
|
||||
|
||||
async def _wrapped(
|
||||
m: Message[Any],
|
||||
d: dict[str, object],
|
||||
mw: Middleware = mw,
|
||||
inner: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = inner,
|
||||
) -> None:
|
||||
await mw(inner, m, d)
|
||||
|
||||
chain = _wrapped
|
||||
|
||||
try:
|
||||
await chain(message, {})
|
||||
except Exception:
|
||||
log.exception("message handler failed")
|
||||
|
||||
async def _invoke_command_with_middleware(
|
||||
self, handler: CommandHandler, message: Message[Any], cmd: ParsedCommand
|
||||
) -> None:
|
||||
if not self._middleware:
|
||||
try:
|
||||
await handler(message, cmd)
|
||||
except Exception:
|
||||
log.exception("command handler failed")
|
||||
return
|
||||
|
||||
async def call(m: Message[Any], _data: dict[str, object]) -> None:
|
||||
await handler(m, cmd)
|
||||
|
||||
chain: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = call
|
||||
for mw in reversed(self._middleware):
|
||||
inner = chain
|
||||
|
||||
async def _wrapped(
|
||||
m: Message[Any],
|
||||
d: dict[str, object],
|
||||
mw: Middleware = mw,
|
||||
inner: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = inner,
|
||||
) -> None:
|
||||
await mw(inner, m, d)
|
||||
|
||||
chain = _wrapped
|
||||
|
||||
try:
|
||||
await chain(message, {})
|
||||
except Exception:
|
||||
log.exception("command handler failed")
|
||||
|
||||
@staticmethod
|
||||
def _parse_command(msg: Message[Any]) -> ParsedCommand | None:
|
||||
parsed = util.ci_bot_command(msg.chat_item["chatItem"])
|
||||
if parsed is None:
|
||||
return None
|
||||
keyword, args = parsed
|
||||
return ParsedCommand(keyword=keyword, args=args)
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Profile + address sync
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
async def _ensure_active_user(self) -> T.User:
|
||||
"""Get or create the active user. Must run before `start_chat`.
|
||||
|
||||
Mirrors Node `createBotUser` (bot.ts:158-166). The chat controller
|
||||
won't accept `/_start` without a user, so this phase has to land
|
||||
before lifecycle proceeds.
|
||||
"""
|
||||
api = self.api
|
||||
user = await api.api_get_active_user()
|
||||
if user is None:
|
||||
log.info("No active user in database, creating...")
|
||||
user = await api.api_create_active_user(self._bot_profile_to_wire())
|
||||
log.info("Bot user: %s", user["profile"]["displayName"])
|
||||
return user
|
||||
|
||||
async def _sync_address_and_profile(self, user: T.User) -> None:
|
||||
"""Address + profile sync. Runs after `start_chat` (mirrors bot.ts:57-63)."""
|
||||
api = self.api
|
||||
user_id = user["userId"]
|
||||
|
||||
# 2. Address (numbered to match bot.ts comments — phase 1 was user creation).
|
||||
address = await api.api_get_user_address(user_id)
|
||||
if address is None:
|
||||
if self._opts["create_address"]:
|
||||
log.info("Bot has no address, creating...")
|
||||
await api.api_create_user_address(user_id)
|
||||
address = await api.api_get_user_address(user_id)
|
||||
if address is None:
|
||||
raise RuntimeError("Failed reading newly created user address")
|
||||
else:
|
||||
log.warning("Bot has no address")
|
||||
|
||||
# Always announce the address — matches Node bot.ts:60.
|
||||
link: str | None = None
|
||||
if address is not None:
|
||||
link = util.contact_address_str(address["connLinkContact"])
|
||||
log.info("Bot address: %s", link)
|
||||
|
||||
# 3. Address settings (auto-accept + welcome message). Mirrors bot.ts:185-194.
|
||||
# autoAccept present → accept; absent → no auto-accept (mirrors Node bot.ts).
|
||||
if address is not None and self._opts["update_address"]:
|
||||
desired: T.AddressSettings = {"businessAddress": self._opts["business_address"]}
|
||||
if self._opts["auto_accept"]:
|
||||
desired["autoAccept"] = {"acceptIncognito": False}
|
||||
if self._welcome is not None:
|
||||
desired["autoReply"] = (
|
||||
{"type": "text", "text": self._welcome}
|
||||
if isinstance(self._welcome, str)
|
||||
else self._welcome
|
||||
)
|
||||
if address["addressSettings"] != desired:
|
||||
log.info("Bot address settings changed, updating...")
|
||||
await api.api_set_address_settings(user_id, desired)
|
||||
|
||||
# 4. Profile update. Mirrors Node `updateBotUserProfile` (bot.ts:199-214).
|
||||
# Field-by-field comparison: user["profile"] is LocalProfile (has extra
|
||||
# fields profileId, localAlias, preferences, peerType) so a full-dict
|
||||
# equality would always differ.
|
||||
new_profile = self._bot_profile_to_wire()
|
||||
if link is not None and self._opts["use_bot_profile"]:
|
||||
# Mirrors bot.ts:62 — embed the connection link in the bot's profile
|
||||
# so contacts that resolve the bot via stored profile data see the
|
||||
# current address.
|
||||
new_profile["contactLink"] = link
|
||||
cur = user["profile"]
|
||||
changed = (
|
||||
cur["displayName"] != new_profile["displayName"]
|
||||
or cur.get("fullName", "") != new_profile.get("fullName", "")
|
||||
or cur.get("shortDescr") != new_profile.get("shortDescr")
|
||||
or cur.get("image") != new_profile.get("image")
|
||||
or cur.get("preferences") != new_profile.get("preferences")
|
||||
or cur.get("peerType") != new_profile.get("peerType")
|
||||
or cur.get("contactLink") != new_profile.get("contactLink")
|
||||
)
|
||||
if changed and self._opts["update_profile"]:
|
||||
log.info("Bot profile changed, updating...")
|
||||
await api.api_update_profile(user_id, new_profile)
|
||||
|
||||
def _bot_profile_to_wire(self) -> T.Profile:
|
||||
"""Construct wire-format Profile, applying bot conventions when use_bot_profile=True.
|
||||
|
||||
Mirrors Node mkBotProfile (bot.ts:88-102): bots get peerType="bot",
|
||||
calls/voice prefs disabled, files gated on `allow_files`, and any
|
||||
registered `commands` embedded in the profile preferences.
|
||||
"""
|
||||
p: T.Profile = {
|
||||
"displayName": self._profile.display_name,
|
||||
"fullName": self._profile.full_name,
|
||||
}
|
||||
if self._profile.short_descr is not None:
|
||||
p["shortDescr"] = self._profile.short_descr
|
||||
if self._profile.image is not None:
|
||||
p["image"] = self._profile.image
|
||||
if self._opts["use_bot_profile"]:
|
||||
prefs: T.Preferences = {
|
||||
"calls": {"allow": "no"},
|
||||
"voice": {"allow": "no"},
|
||||
"files": {"allow": "yes" if self._opts["allow_files"] else "no"},
|
||||
}
|
||||
if self._commands:
|
||||
prefs["commands"] = [
|
||||
{"type": "command", "keyword": c.keyword, "label": c.label}
|
||||
for c in self._commands
|
||||
]
|
||||
p["preferences"] = prefs
|
||||
p["peerType"] = "bot"
|
||||
elif self._commands:
|
||||
raise ValueError(
|
||||
"use_bot_profile=False but commands were passed; commands are "
|
||||
"only sent when use_bot_profile=True (they're embedded in the "
|
||||
"user profile preferences)."
|
||||
)
|
||||
return p
|
||||
|
||||
# ------------------------------------------------------------------ #
|
||||
# Log subscriptions (mirror Node subscribeLogEvents bot.ts:142-156)
|
||||
# ------------------------------------------------------------------ #
|
||||
|
||||
def _register_log_handlers(self) -> None:
|
||||
# Idempotent: a Bot reused across multiple `__aenter__` cycles must
|
||||
# not stack duplicate log handlers. Always-on error handlers run
|
||||
# regardless of log_contacts/log_network so messageError/chatError/
|
||||
# chatErrors don't disappear into the void.
|
||||
if self._defaults_registered:
|
||||
return
|
||||
self._defaults_registered = True
|
||||
self._event_handlers.setdefault("messageError", []).append(self._log_message_error)
|
||||
self._event_handlers.setdefault("chatError", []).append(self._log_chat_error)
|
||||
self._event_handlers.setdefault("chatErrors", []).append(self._log_chat_errors)
|
||||
if self._opts["log_contacts"]:
|
||||
self._event_handlers.setdefault("contactConnected", []).append(
|
||||
self._log_contact_connected
|
||||
)
|
||||
self._event_handlers.setdefault("contactDeletedByContact", []).append(
|
||||
self._log_contact_deleted
|
||||
)
|
||||
if self._opts["log_network"]:
|
||||
self._event_handlers.setdefault("hostConnected", []).append(self._log_host_connected)
|
||||
self._event_handlers.setdefault("hostDisconnected", []).append(
|
||||
self._log_host_disconnected
|
||||
)
|
||||
self._event_handlers.setdefault("subscriptionStatus", []).append(
|
||||
self._log_subscription_status
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
async def _log_contact_connected(evt: CEvt.ChatEvent) -> None:
|
||||
log.info("%s connected", evt["contact"]["profile"]["displayName"]) # type: ignore[index]
|
||||
|
||||
@staticmethod
|
||||
async def _log_contact_deleted(evt: CEvt.ChatEvent) -> None:
|
||||
log.info(
|
||||
"%s deleted connection with bot",
|
||||
evt["contact"]["profile"]["displayName"], # type: ignore[index]
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
async def _log_host_connected(evt: CEvt.ChatEvent) -> None:
|
||||
log.info("connected server %s", evt["transportHost"]) # type: ignore[index]
|
||||
|
||||
@staticmethod
|
||||
async def _log_host_disconnected(evt: CEvt.ChatEvent) -> None:
|
||||
log.info("disconnected server %s", evt["transportHost"]) # type: ignore[index]
|
||||
|
||||
@staticmethod
|
||||
async def _log_subscription_status(evt: CEvt.ChatEvent) -> None:
|
||||
log.info(
|
||||
"%d subscription(s) %s",
|
||||
len(evt["connections"]), # type: ignore[index]
|
||||
evt["subscriptionStatus"]["type"], # type: ignore[index]
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
async def _log_message_error(evt: CEvt.ChatEvent) -> None:
|
||||
log.warning("messageError: %s", evt.get("severity", "?")) # type: ignore[union-attr]
|
||||
|
||||
@staticmethod
|
||||
async def _log_chat_error(evt: CEvt.ChatEvent) -> None:
|
||||
err = evt.get("chatError") # type: ignore[union-attr]
|
||||
log.error("chatError: %s", err.get("type") if isinstance(err, dict) else err)
|
||||
|
||||
@staticmethod
|
||||
async def _log_chat_errors(evt: CEvt.ChatEvent) -> None:
|
||||
errs = evt.get("chatErrors") or [] # type: ignore[union-attr]
|
||||
log.error("chatErrors: %d errors", len(errs))
|
||||
|
||||
|
||||
# Suppress unused-import warnings for re-exported names used only at type-check time.
|
||||
__all__ = [
|
||||
"Bot",
|
||||
"BotCommand",
|
||||
"BotProfile",
|
||||
"ChatMessage",
|
||||
"FileMessage",
|
||||
"ImageMessage",
|
||||
"LinkMessage",
|
||||
"Message",
|
||||
"MessageHandler",
|
||||
"CommandHandler",
|
||||
"EventHandler",
|
||||
"Middleware",
|
||||
"ParsedCommand",
|
||||
"ReportMessage",
|
||||
"TextMessage",
|
||||
"UnknownMessage",
|
||||
"VideoMessage",
|
||||
"VoiceMessage",
|
||||
]
|
||||
@@ -0,0 +1,200 @@
|
||||
"""Internal typed async wrapper around libsimplex's 8 C ABI functions.
|
||||
|
||||
Users interact with `Bot` / `ChatApi`. This module is exposed as
|
||||
`simplex_chat.core` for tests and the api.ChatApi class only.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import ctypes
|
||||
import json
|
||||
from enum import StrEnum
|
||||
from typing import Any, TypedDict
|
||||
|
||||
from . import _native
|
||||
from .types import T, CR, CEvt
|
||||
|
||||
|
||||
class ChatAPIError(Exception):
|
||||
"""Raised when chat_send_cmd / chat_recv_msg_wait returns a chat error."""
|
||||
|
||||
def __init__(self, message: str, chat_error: T.ChatError | None = None):
|
||||
super().__init__(message)
|
||||
self.chat_error = chat_error
|
||||
|
||||
|
||||
class ChatInitError(Exception):
|
||||
"""Raised when chat_migrate_init returns a DBMigrationResult error."""
|
||||
|
||||
def __init__(self, message: str, db_migration_error: dict[str, Any]):
|
||||
super().__init__(message)
|
||||
self.db_migration_error = db_migration_error
|
||||
|
||||
|
||||
class MigrationConfirmation(StrEnum):
|
||||
YES_UP = "yesUp"
|
||||
YES_UP_DOWN = "yesUpDown"
|
||||
CONSOLE = "console"
|
||||
ERROR = "error"
|
||||
|
||||
|
||||
class CryptoArgs(TypedDict): # wire-format JSON; camelCase fields
|
||||
fileKey: str
|
||||
fileNonce: str
|
||||
|
||||
|
||||
def _read_and_free(ptr: int | None) -> str:
|
||||
"""Copy a Haskell-allocated null-terminated UTF-8 string and free its buffer.
|
||||
|
||||
Mirrors HandleCResult in packages/simplex-chat-nodejs/cpp/simplex.cc:157-165.
|
||||
"""
|
||||
if not ptr:
|
||||
raise RuntimeError("null pointer returned from libsimplex")
|
||||
try:
|
||||
return ctypes.string_at(ptr).decode("utf-8")
|
||||
finally:
|
||||
_native.libc().free(ctypes.c_void_p(ptr))
|
||||
|
||||
|
||||
async def chat_send_cmd(ctrl: int, cmd: str) -> CR.ChatResponse:
|
||||
def _call() -> str:
|
||||
ptr = _native.lib().chat_send_cmd(ctrl, cmd.encode("utf-8"))
|
||||
return _read_and_free(ptr)
|
||||
|
||||
raw = await asyncio.to_thread(_call)
|
||||
parsed = json.loads(raw)
|
||||
if "result" in parsed and isinstance(parsed["result"], dict):
|
||||
return parsed["result"] # type: ignore[return-value]
|
||||
err = parsed.get("error")
|
||||
if isinstance(err, dict):
|
||||
raise ChatAPIError(f"chat command error: {err.get('type')}", err) # type: ignore[arg-type]
|
||||
raise ChatAPIError(f"invalid chat command result: {raw[:200]}")
|
||||
|
||||
|
||||
async def chat_recv_msg_wait(ctrl: int, wait_us: int = 500_000) -> CEvt.ChatEvent | None:
|
||||
def _call() -> str:
|
||||
# On timeout, the C side returns a non-NULL pointer to a single NUL byte
|
||||
# (see Mobile.hs `fromMaybe ""`), so `_read_and_free` returns "" — no
|
||||
# NULL-pointer guard is needed here.
|
||||
ptr = _native.lib().chat_recv_msg_wait(ctrl, wait_us)
|
||||
return _read_and_free(ptr)
|
||||
|
||||
raw = await asyncio.to_thread(_call)
|
||||
if not raw:
|
||||
return None
|
||||
parsed = json.loads(raw)
|
||||
if "result" in parsed and isinstance(parsed["result"], dict):
|
||||
return parsed["result"] # type: ignore[return-value]
|
||||
err = parsed.get("error")
|
||||
if isinstance(err, dict):
|
||||
raise ChatAPIError(f"chat event error: {err.get('type')}", err) # type: ignore[arg-type]
|
||||
raise ChatAPIError(f"invalid chat event: {raw[:200]}")
|
||||
|
||||
|
||||
async def chat_migrate_init(db_path: str, db_key: str, confirm: MigrationConfirmation) -> int:
|
||||
"""Initialize chat controller. Returns opaque ctrl pointer as Python int."""
|
||||
|
||||
def _call() -> tuple[int, str]:
|
||||
ctrl = ctypes.c_void_p()
|
||||
ptr = _native.lib().chat_migrate_init(
|
||||
db_path.encode("utf-8"),
|
||||
db_key.encode("utf-8"),
|
||||
confirm.encode("utf-8"),
|
||||
ctypes.byref(ctrl),
|
||||
)
|
||||
return (ctrl.value or 0, _read_and_free(ptr))
|
||||
|
||||
ctrl_val, raw = await asyncio.to_thread(_call)
|
||||
parsed = json.loads(raw)
|
||||
if parsed.get("type") == "ok":
|
||||
if not ctrl_val:
|
||||
# ABI invariant: type=="ok" → out-param written. Defensive guard so a
|
||||
# broken libsimplex doesn't hand us a NULL controller that would only
|
||||
# crash on first use much later.
|
||||
raise RuntimeError("chat_migrate_init returned ok but did not set ctrl pointer")
|
||||
return ctrl_val
|
||||
raise ChatInitError(
|
||||
"Database or migration error (see db_migration_error)",
|
||||
parsed,
|
||||
)
|
||||
|
||||
|
||||
async def chat_close_store(ctrl: int) -> None:
|
||||
def _call() -> str:
|
||||
ptr = _native.lib().chat_close_store(ctrl)
|
||||
return _read_and_free(ptr)
|
||||
|
||||
res = await asyncio.to_thread(_call)
|
||||
if res:
|
||||
raise RuntimeError(res)
|
||||
|
||||
|
||||
async def chat_write_file(ctrl: int, path: str, data: bytes) -> CryptoArgs:
|
||||
def _call() -> str:
|
||||
ptr = _native.lib().chat_write_file(ctrl, path.encode("utf-8"), data, len(data))
|
||||
return _read_and_free(ptr)
|
||||
|
||||
raw = await asyncio.to_thread(_call)
|
||||
return _crypto_args_result(raw)
|
||||
|
||||
|
||||
async def chat_read_file(path: str, args: CryptoArgs) -> bytes:
|
||||
def _call() -> bytes:
|
||||
ptr = _native.lib().chat_read_file(
|
||||
path.encode("utf-8"),
|
||||
args["fileKey"].encode("utf-8"),
|
||||
args["fileNonce"].encode("utf-8"),
|
||||
)
|
||||
if not ptr:
|
||||
raise RuntimeError("chat_read_file returned null")
|
||||
addr = ctypes.cast(ptr, ctypes.c_void_p).value
|
||||
assert addr is not None # `if not ptr` above already filtered NULL
|
||||
try:
|
||||
status = ctypes.cast(addr, ctypes.POINTER(ctypes.c_uint8))[0]
|
||||
if status == 1:
|
||||
msg = ctypes.string_at(addr + 1).decode("utf-8")
|
||||
raise RuntimeError(msg)
|
||||
if status != 0:
|
||||
raise RuntimeError(f"unexpected status {status} from chat_read_file")
|
||||
# `addr + 1` is unaligned for a uint32 read. On the supported platforms
|
||||
# (linux-x86_64, linux-aarch64, macos-aarch64, windows-x86_64) this is
|
||||
# silently handled; matches the Node.js binding (cpp/simplex.cc:344).
|
||||
length = ctypes.cast(addr + 1, ctypes.POINTER(ctypes.c_uint32))[0]
|
||||
return ctypes.string_at(addr + 5, length)
|
||||
finally:
|
||||
_native.libc().free(ctypes.c_void_p(addr))
|
||||
|
||||
return await asyncio.to_thread(_call)
|
||||
|
||||
|
||||
async def chat_encrypt_file(ctrl: int, src: str, dst: str) -> CryptoArgs:
|
||||
def _call() -> str:
|
||||
ptr = _native.lib().chat_encrypt_file(ctrl, src.encode("utf-8"), dst.encode("utf-8"))
|
||||
return _read_and_free(ptr)
|
||||
|
||||
return _crypto_args_result(await asyncio.to_thread(_call))
|
||||
|
||||
|
||||
async def chat_decrypt_file(src: str, args: CryptoArgs, dst: str) -> None:
|
||||
def _call() -> str:
|
||||
ptr = _native.lib().chat_decrypt_file(
|
||||
src.encode("utf-8"),
|
||||
args["fileKey"].encode("utf-8"),
|
||||
args["fileNonce"].encode("utf-8"),
|
||||
dst.encode("utf-8"),
|
||||
)
|
||||
return _read_and_free(ptr)
|
||||
|
||||
res = await asyncio.to_thread(_call)
|
||||
if res:
|
||||
raise RuntimeError(res)
|
||||
|
||||
|
||||
def _crypto_args_result(raw: str) -> CryptoArgs:
|
||||
parsed = json.loads(raw)
|
||||
if parsed.get("type") == "result":
|
||||
return parsed["cryptoArgs"]
|
||||
if parsed.get("type") == "error":
|
||||
raise RuntimeError(parsed.get("writeError", "unknown write error"))
|
||||
raise RuntimeError(f"unexpected result: {raw[:200]}")
|
||||
@@ -0,0 +1,45 @@
|
||||
"""Compile kwarg-based message filters into a single predicate."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from typing import Any, Callable
|
||||
|
||||
|
||||
def compile_message_filter(kw: dict[str, Any]) -> Callable[[Any], bool]:
|
||||
"""Compile filter kwargs into a single predicate function.
|
||||
|
||||
Multiple kwargs combine with AND; tuples within a kwarg combine with OR.
|
||||
`when` is the last predicate evaluated.
|
||||
"""
|
||||
predicates: list[Callable[[Any], bool]] = []
|
||||
|
||||
if (ct := kw.get("content_type")) is not None:
|
||||
ct_set = (ct,) if isinstance(ct, str) else tuple(ct)
|
||||
predicates.append(lambda m: m.content.get("type") in ct_set)
|
||||
|
||||
if (t := kw.get("text")) is not None:
|
||||
if isinstance(t, re.Pattern):
|
||||
predicates.append(lambda m: bool(t.search(m.content.get("text", "") or "")))
|
||||
else:
|
||||
predicates.append(lambda m: m.content.get("text") == t)
|
||||
|
||||
if (cht := kw.get("chat_type")) is not None:
|
||||
cht_set = (cht,) if isinstance(cht, str) else tuple(cht)
|
||||
predicates.append(lambda m: m.chat_item["chatInfo"]["type"] in cht_set)
|
||||
|
||||
if (gid := kw.get("group_id")) is not None:
|
||||
gid_set: tuple[int, ...] = (gid,) if isinstance(gid, int) else tuple(gid)
|
||||
|
||||
def gid_match(m: Any) -> bool:
|
||||
ci = m.chat_item["chatInfo"]
|
||||
return ci["type"] == "group" and ci["groupInfo"]["groupId"] in gid_set
|
||||
|
||||
predicates.append(gid_match)
|
||||
|
||||
if (when := kw.get("when")) is not None:
|
||||
predicates.append(when)
|
||||
|
||||
if not predicates:
|
||||
return lambda _m: True
|
||||
return lambda m: all(p(m) for p in predicates)
|
||||
@@ -0,0 +1,16 @@
|
||||
"""SimpleX Chat wire types — auto-generated from Haskell.
|
||||
|
||||
Re-exports the four generated modules as namespaces:
|
||||
|
||||
- ``T`` — :mod:`._types` (records, enums, discriminated unions)
|
||||
- ``CC`` — :mod:`._commands` (command TypedDicts + ``<Cmd>_cmd_string`` helpers)
|
||||
- ``CR`` — :mod:`._responses` (``ChatResponse`` and member TypedDicts)
|
||||
- ``CEvt`` — :mod:`._events` (``ChatEvent`` and member TypedDicts)
|
||||
"""
|
||||
|
||||
from . import _commands as CC
|
||||
from . import _events as CEvt
|
||||
from . import _responses as CR
|
||||
from . import _types as T
|
||||
|
||||
__all__ = ["T", "CC", "CR", "CEvt"]
|
||||
@@ -0,0 +1,705 @@
|
||||
# API Commands
|
||||
# This file is generated automatically.
|
||||
from __future__ import annotations
|
||||
import json
|
||||
from typing import NotRequired, TypedDict
|
||||
from . import _types as T
|
||||
from . import _responses as CR
|
||||
|
||||
# Address commands
|
||||
# Bots can use these commands to automatically check and create address when initialized
|
||||
|
||||
# Create bot address.
|
||||
# Network usage: interactive.
|
||||
class APICreateMyAddress(TypedDict):
|
||||
userId: int # int64
|
||||
|
||||
|
||||
def APICreateMyAddress_cmd_string(self: APICreateMyAddress) -> str:
|
||||
return '/_address ' + str(self['userId'])
|
||||
|
||||
APICreateMyAddress_Response = CR.UserContactLinkCreated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Delete bot address.
|
||||
# Network usage: background.
|
||||
class APIDeleteMyAddress(TypedDict):
|
||||
userId: int # int64
|
||||
|
||||
|
||||
def APIDeleteMyAddress_cmd_string(self: APIDeleteMyAddress) -> str:
|
||||
return '/_delete_address ' + str(self['userId'])
|
||||
|
||||
APIDeleteMyAddress_Response = CR.UserContactLinkDeleted | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get bot address and settings.
|
||||
# Network usage: no.
|
||||
class APIShowMyAddress(TypedDict):
|
||||
userId: int # int64
|
||||
|
||||
|
||||
def APIShowMyAddress_cmd_string(self: APIShowMyAddress) -> str:
|
||||
return '/_show_address ' + str(self['userId'])
|
||||
|
||||
APIShowMyAddress_Response = CR.UserContactLink | CR.ChatCmdError
|
||||
|
||||
|
||||
# Add address to bot profile.
|
||||
# Network usage: interactive.
|
||||
class APISetProfileAddress(TypedDict):
|
||||
userId: int # int64
|
||||
enable: bool
|
||||
|
||||
|
||||
def APISetProfileAddress_cmd_string(self: APISetProfileAddress) -> str:
|
||||
return '/_profile_address ' + str(self['userId']) + ' ' + ('on' if self['enable'] else 'off')
|
||||
|
||||
APISetProfileAddress_Response = CR.UserProfileUpdated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set bot address settings.
|
||||
# Network usage: interactive.
|
||||
class APISetAddressSettings(TypedDict):
|
||||
userId: int # int64
|
||||
settings: "T.AddressSettings"
|
||||
|
||||
|
||||
def APISetAddressSettings_cmd_string(self: APISetAddressSettings) -> str:
|
||||
return '/_address_settings ' + str(self['userId']) + ' ' + json.dumps(self['settings'])
|
||||
|
||||
APISetAddressSettings_Response = CR.UserContactLinkUpdated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Message commands
|
||||
# Commands to send, update, delete, moderate messages and set message reactions
|
||||
|
||||
# Send messages.
|
||||
# Network usage: background.
|
||||
class APISendMessages(TypedDict):
|
||||
sendRef: "T.ChatRef"
|
||||
liveMessage: bool
|
||||
ttl: NotRequired[int] # int
|
||||
composedMessages: list["T.ComposedMessage"] # non-empty
|
||||
|
||||
|
||||
def APISendMessages_cmd_string(self: APISendMessages) -> str:
|
||||
return '/_send ' + T.ChatRef_cmd_string(self['sendRef']) + (' live=on' if self['liveMessage'] else '') + ((' ttl=' + str(self.get('ttl'))) if self.get('ttl') is not None else '') + ' json ' + json.dumps(self['composedMessages'])
|
||||
|
||||
APISendMessages_Response = CR.NewChatItems | CR.ChatCmdError
|
||||
|
||||
|
||||
# Update message.
|
||||
# Network usage: background.
|
||||
class APIUpdateChatItem(TypedDict):
|
||||
chatRef: "T.ChatRef"
|
||||
chatItemId: int # int64
|
||||
liveMessage: bool
|
||||
updatedMessage: "T.UpdatedMessage"
|
||||
|
||||
|
||||
def APIUpdateChatItem_cmd_string(self: APIUpdateChatItem) -> str:
|
||||
return '/_update item ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + str(self['chatItemId']) + (' live=on' if self['liveMessage'] else '') + ' json ' + json.dumps(self['updatedMessage'])
|
||||
|
||||
APIUpdateChatItem_Response = CR.ChatItemUpdated | CR.ChatItemNotChanged | CR.ChatCmdError
|
||||
|
||||
|
||||
# Delete message.
|
||||
# Network usage: background.
|
||||
class APIDeleteChatItem(TypedDict):
|
||||
chatRef: "T.ChatRef"
|
||||
chatItemIds: list[int] # int64, non-empty
|
||||
deleteMode: "T.CIDeleteMode"
|
||||
|
||||
|
||||
def APIDeleteChatItem_cmd_string(self: APIDeleteChatItem) -> str:
|
||||
return '/_delete item ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + ','.join(map(str, self['chatItemIds'])) + ' ' + str(self['deleteMode'])
|
||||
|
||||
APIDeleteChatItem_Response = CR.ChatItemsDeleted | CR.ChatCmdError
|
||||
|
||||
|
||||
# Moderate message. Requires Moderator role (and higher than message author's).
|
||||
# Network usage: background.
|
||||
class APIDeleteMemberChatItem(TypedDict):
|
||||
groupId: int # int64
|
||||
chatItemIds: list[int] # int64, non-empty
|
||||
|
||||
|
||||
def APIDeleteMemberChatItem_cmd_string(self: APIDeleteMemberChatItem) -> str:
|
||||
return '/_delete member item #' + str(self['groupId']) + ' ' + ','.join(map(str, self['chatItemIds']))
|
||||
|
||||
APIDeleteMemberChatItem_Response = CR.ChatItemsDeleted | CR.ChatCmdError
|
||||
|
||||
|
||||
# Add/remove message reaction.
|
||||
# Network usage: background.
|
||||
class APIChatItemReaction(TypedDict):
|
||||
chatRef: "T.ChatRef"
|
||||
chatItemId: int # int64
|
||||
add: bool
|
||||
reaction: "T.MsgReaction"
|
||||
|
||||
|
||||
def APIChatItemReaction_cmd_string(self: APIChatItemReaction) -> str:
|
||||
return '/_reaction ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + str(self['chatItemId']) + ' ' + ('on' if self['add'] else 'off') + ' ' + json.dumps(self['reaction'])
|
||||
|
||||
APIChatItemReaction_Response = CR.ChatItemReaction | CR.ChatCmdError
|
||||
|
||||
|
||||
# File commands
|
||||
# Commands to receive and to cancel files. Files are sent as part of the message, there are no separate commands to send files.
|
||||
|
||||
# Receive file.
|
||||
# Network usage: no.
|
||||
class ReceiveFile(TypedDict):
|
||||
fileId: int # int64
|
||||
userApprovedRelays: bool
|
||||
storeEncrypted: NotRequired[bool]
|
||||
fileInline: NotRequired[bool]
|
||||
filePath: NotRequired[str]
|
||||
|
||||
|
||||
def ReceiveFile_cmd_string(self: ReceiveFile) -> str:
|
||||
return '/freceive ' + str(self['fileId']) + (' approved_relays=on' if self['userApprovedRelays'] else '') + ((' encrypt=' + ('on' if self.get('storeEncrypted') else 'off')) if self.get('storeEncrypted') is not None else '') + ((' inline=' + ('on' if self.get('fileInline') else 'off')) if self.get('fileInline') is not None else '') + ((' ' + self.get('filePath')) if self.get('filePath') is not None else '')
|
||||
|
||||
ReceiveFile_Response = CR.RcvFileAccepted | CR.RcvFileAcceptedSndCancelled | CR.ChatCmdError
|
||||
|
||||
|
||||
# Cancel file.
|
||||
# Network usage: background.
|
||||
class CancelFile(TypedDict):
|
||||
fileId: int # int64
|
||||
|
||||
|
||||
def CancelFile_cmd_string(self: CancelFile) -> str:
|
||||
return '/fcancel ' + str(self['fileId'])
|
||||
|
||||
CancelFile_Response = CR.SndFileCancelled | CR.RcvFileCancelled | CR.ChatCmdError
|
||||
|
||||
|
||||
# Group commands
|
||||
# Commands to manage and moderate groups. These commands can be used with business chats as well - they are groups. E.g., a common scenario would be to add human agents to business chat with the customer who connected via business address.
|
||||
|
||||
# Add contact to group. Requires bot to have Admin role.
|
||||
# Network usage: interactive.
|
||||
class APIAddMember(TypedDict):
|
||||
groupId: int # int64
|
||||
contactId: int # int64
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
|
||||
def APIAddMember_cmd_string(self: APIAddMember) -> str:
|
||||
return '/_add #' + str(self['groupId']) + ' ' + str(self['contactId']) + ' ' + str(self['memberRole'])
|
||||
|
||||
APIAddMember_Response = CR.SentGroupInvitation | CR.ChatCmdError
|
||||
|
||||
|
||||
# Join group.
|
||||
# Network usage: interactive.
|
||||
class APIJoinGroup(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APIJoinGroup_cmd_string(self: APIJoinGroup) -> str:
|
||||
return '/_join #' + str(self['groupId'])
|
||||
|
||||
APIJoinGroup_Response = CR.UserAcceptedGroupSent | CR.ChatCmdError
|
||||
|
||||
|
||||
# Accept group member. Requires Admin role.
|
||||
# Network usage: background.
|
||||
class APIAcceptMember(TypedDict):
|
||||
groupId: int # int64
|
||||
groupMemberId: int # int64
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
|
||||
def APIAcceptMember_cmd_string(self: APIAcceptMember) -> str:
|
||||
return '/_accept member #' + str(self['groupId']) + ' ' + str(self['groupMemberId']) + ' ' + str(self['memberRole'])
|
||||
|
||||
APIAcceptMember_Response = CR.MemberAccepted | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set members role. Requires Admin role.
|
||||
# Network usage: background.
|
||||
class APIMembersRole(TypedDict):
|
||||
groupId: int # int64
|
||||
groupMemberIds: list[int] # int64, non-empty
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
|
||||
def APIMembersRole_cmd_string(self: APIMembersRole) -> str:
|
||||
return '/_member role #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + ' ' + str(self['memberRole'])
|
||||
|
||||
APIMembersRole_Response = CR.MembersRoleUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Block members. Requires Moderator role.
|
||||
# Network usage: background.
|
||||
class APIBlockMembersForAll(TypedDict):
|
||||
groupId: int # int64
|
||||
groupMemberIds: list[int] # int64, non-empty
|
||||
blocked: bool
|
||||
|
||||
|
||||
def APIBlockMembersForAll_cmd_string(self: APIBlockMembersForAll) -> str:
|
||||
return '/_block #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + ' blocked=' + ('on' if self['blocked'] else 'off')
|
||||
|
||||
APIBlockMembersForAll_Response = CR.MembersBlockedForAllUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Remove members. Requires Admin role.
|
||||
# Network usage: background.
|
||||
class APIRemoveMembers(TypedDict):
|
||||
groupId: int # int64
|
||||
groupMemberIds: list[int] # int64, non-empty
|
||||
withMessages: bool
|
||||
|
||||
|
||||
def APIRemoveMembers_cmd_string(self: APIRemoveMembers) -> str:
|
||||
return '/_remove #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + (' messages=on' if self['withMessages'] else '')
|
||||
|
||||
APIRemoveMembers_Response = CR.UserDeletedMembers | CR.ChatCmdError
|
||||
|
||||
|
||||
# Leave group.
|
||||
# Network usage: background.
|
||||
class APILeaveGroup(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APILeaveGroup_cmd_string(self: APILeaveGroup) -> str:
|
||||
return '/_leave #' + str(self['groupId'])
|
||||
|
||||
APILeaveGroup_Response = CR.LeftMemberUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get group members.
|
||||
# Network usage: no.
|
||||
class APIListMembers(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APIListMembers_cmd_string(self: APIListMembers) -> str:
|
||||
return '/_members #' + str(self['groupId'])
|
||||
|
||||
APIListMembers_Response = CR.GroupMembers | CR.ChatCmdError
|
||||
|
||||
|
||||
# Create group.
|
||||
# Network usage: no.
|
||||
class APINewGroup(TypedDict):
|
||||
userId: int # int64
|
||||
incognito: bool
|
||||
groupProfile: "T.GroupProfile"
|
||||
|
||||
|
||||
def APINewGroup_cmd_string(self: APINewGroup) -> str:
|
||||
return '/_group ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '') + ' ' + json.dumps(self['groupProfile'])
|
||||
|
||||
APINewGroup_Response = CR.GroupCreated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Create public group.
|
||||
# Network usage: interactive.
|
||||
class APINewPublicGroup(TypedDict):
|
||||
userId: int # int64
|
||||
incognito: bool
|
||||
relayIds: list[int] # int64, non-empty
|
||||
groupProfile: "T.GroupProfile"
|
||||
|
||||
|
||||
def APINewPublicGroup_cmd_string(self: APINewPublicGroup) -> str:
|
||||
return '/_public group ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '') + ' ' + ','.join(map(str, self['relayIds'])) + ' ' + json.dumps(self['groupProfile'])
|
||||
|
||||
APINewPublicGroup_Response = CR.PublicGroupCreated | CR.PublicGroupCreationFailed | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get group relays.
|
||||
# Network usage: no.
|
||||
class APIGetGroupRelays(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APIGetGroupRelays_cmd_string(self: APIGetGroupRelays) -> str:
|
||||
return '/_get relays #' + str(self['groupId'])
|
||||
|
||||
APIGetGroupRelays_Response = CR.GroupRelays | CR.ChatCmdError
|
||||
|
||||
|
||||
# Add relays to group.
|
||||
# Network usage: interactive.
|
||||
class APIAddGroupRelays(TypedDict):
|
||||
groupId: int # int64
|
||||
relayIds: list[int] # int64, non-empty
|
||||
|
||||
|
||||
def APIAddGroupRelays_cmd_string(self: APIAddGroupRelays) -> str:
|
||||
return '/_add relays #' + str(self['groupId']) + ' ' + ','.join(map(str, self['relayIds']))
|
||||
|
||||
APIAddGroupRelays_Response = CR.GroupRelaysAdded | CR.GroupRelaysAddFailed | CR.ChatCmdError
|
||||
|
||||
|
||||
# Update group profile.
|
||||
# Network usage: background.
|
||||
class APIUpdateGroupProfile(TypedDict):
|
||||
groupId: int # int64
|
||||
groupProfile: "T.GroupProfile"
|
||||
|
||||
|
||||
def APIUpdateGroupProfile_cmd_string(self: APIUpdateGroupProfile) -> str:
|
||||
return '/_group_profile #' + str(self['groupId']) + ' ' + json.dumps(self['groupProfile'])
|
||||
|
||||
APIUpdateGroupProfile_Response = CR.GroupUpdated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Group link commands
|
||||
# These commands can be used by bots that manage multiple public groups
|
||||
|
||||
# Create group link.
|
||||
# Network usage: interactive.
|
||||
class APICreateGroupLink(TypedDict):
|
||||
groupId: int # int64
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
|
||||
def APICreateGroupLink_cmd_string(self: APICreateGroupLink) -> str:
|
||||
return '/_create link #' + str(self['groupId']) + ' ' + str(self['memberRole'])
|
||||
|
||||
APICreateGroupLink_Response = CR.GroupLinkCreated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set member role for group link.
|
||||
# Network usage: no.
|
||||
class APIGroupLinkMemberRole(TypedDict):
|
||||
groupId: int # int64
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
|
||||
def APIGroupLinkMemberRole_cmd_string(self: APIGroupLinkMemberRole) -> str:
|
||||
return '/_set link role #' + str(self['groupId']) + ' ' + str(self['memberRole'])
|
||||
|
||||
APIGroupLinkMemberRole_Response = CR.GroupLink | CR.ChatCmdError
|
||||
|
||||
|
||||
# Delete group link.
|
||||
# Network usage: background.
|
||||
class APIDeleteGroupLink(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APIDeleteGroupLink_cmd_string(self: APIDeleteGroupLink) -> str:
|
||||
return '/_delete link #' + str(self['groupId'])
|
||||
|
||||
APIDeleteGroupLink_Response = CR.GroupLinkDeleted | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get group link.
|
||||
# Network usage: no.
|
||||
class APIGetGroupLink(TypedDict):
|
||||
groupId: int # int64
|
||||
|
||||
|
||||
def APIGetGroupLink_cmd_string(self: APIGetGroupLink) -> str:
|
||||
return '/_get link #' + str(self['groupId'])
|
||||
|
||||
APIGetGroupLink_Response = CR.GroupLink | CR.ChatCmdError
|
||||
|
||||
|
||||
# Connection commands
|
||||
# These commands may be used to create connections. Most bots do not need to use them - bot users will connect via bot address with auto-accept enabled.
|
||||
|
||||
# Create 1-time invitation link.
|
||||
# Network usage: interactive.
|
||||
class APIAddContact(TypedDict):
|
||||
userId: int # int64
|
||||
incognito: bool
|
||||
|
||||
|
||||
def APIAddContact_cmd_string(self: APIAddContact) -> str:
|
||||
return '/_connect ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '')
|
||||
|
||||
APIAddContact_Response = CR.Invitation | CR.ChatCmdError
|
||||
|
||||
|
||||
# Determine SimpleX link type and if the bot is already connected via this link.
|
||||
# Network usage: interactive.
|
||||
class APIConnectPlan(TypedDict):
|
||||
userId: int # int64
|
||||
connectionLink: NotRequired[str]
|
||||
resolveKnown: bool
|
||||
linkOwnerSig: NotRequired["T.LinkOwnerSig"]
|
||||
|
||||
|
||||
def APIConnectPlan_cmd_string(self: APIConnectPlan) -> str:
|
||||
return '/_connect plan ' + str(self['userId']) + ' ' + self.get('connectionLink')
|
||||
|
||||
APIConnectPlan_Response = CR.ConnectionPlan | CR.ChatCmdError
|
||||
|
||||
|
||||
# Connect via prepared SimpleX link. The link can be 1-time invitation link, contact address or group link.
|
||||
# Network usage: interactive.
|
||||
class APIConnect(TypedDict):
|
||||
userId: int # int64
|
||||
incognito: bool
|
||||
preparedLink_: NotRequired["T.CreatedConnLink"]
|
||||
|
||||
|
||||
def APIConnect_cmd_string(self: APIConnect) -> str:
|
||||
return '/_connect ' + str(self['userId']) + ((' ' + T.CreatedConnLink_cmd_string(self.get('preparedLink_'))) if self.get('preparedLink_') is not None else '')
|
||||
|
||||
APIConnect_Response = CR.SentConfirmation | CR.ContactAlreadyExists | CR.SentInvitation | CR.ChatCmdError
|
||||
|
||||
|
||||
# Connect via SimpleX link as string in the active user profile.
|
||||
# Network usage: interactive.
|
||||
class Connect(TypedDict):
|
||||
incognito: bool
|
||||
connLink_: NotRequired[str]
|
||||
|
||||
|
||||
def Connect_cmd_string(self: Connect) -> str:
|
||||
return '/connect' + ((' ' + self.get('connLink_')) if self.get('connLink_') is not None else '')
|
||||
|
||||
Connect_Response = CR.SentConfirmation | CR.ContactAlreadyExists | CR.SentInvitation | CR.ChatCmdError
|
||||
|
||||
|
||||
# Accept contact request.
|
||||
# Network usage: interactive.
|
||||
class APIAcceptContact(TypedDict):
|
||||
contactReqId: int # int64
|
||||
|
||||
|
||||
def APIAcceptContact_cmd_string(self: APIAcceptContact) -> str:
|
||||
return '/_accept ' + str(self['contactReqId'])
|
||||
|
||||
APIAcceptContact_Response = CR.AcceptingContactRequest | CR.ChatCmdError
|
||||
|
||||
|
||||
# Reject contact request. The user who sent the request is **not notified**.
|
||||
# Network usage: no.
|
||||
class APIRejectContact(TypedDict):
|
||||
contactReqId: int # int64
|
||||
|
||||
|
||||
def APIRejectContact_cmd_string(self: APIRejectContact) -> str:
|
||||
return '/_reject ' + str(self['contactReqId'])
|
||||
|
||||
APIRejectContact_Response = CR.ContactRequestRejected | CR.ChatCmdError
|
||||
|
||||
|
||||
# Chat commands
|
||||
# Commands to list and delete conversations.
|
||||
|
||||
# Get contacts.
|
||||
# Network usage: no.
|
||||
class APIListContacts(TypedDict):
|
||||
userId: int # int64
|
||||
|
||||
|
||||
def APIListContacts_cmd_string(self: APIListContacts) -> str:
|
||||
return '/_contacts ' + str(self['userId'])
|
||||
|
||||
APIListContacts_Response = CR.ContactsList | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get groups.
|
||||
# Network usage: no.
|
||||
class APIListGroups(TypedDict):
|
||||
userId: int # int64
|
||||
contactId_: NotRequired[int] # int64
|
||||
search: NotRequired[str]
|
||||
|
||||
|
||||
def APIListGroups_cmd_string(self: APIListGroups) -> str:
|
||||
return '/_groups ' + str(self['userId']) + ((' @' + str(self.get('contactId_'))) if self.get('contactId_') is not None else '') + ((' ' + self.get('search')) if self.get('search') is not None else '')
|
||||
|
||||
APIListGroups_Response = CR.GroupsList | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get chat previews. Supports time-based pagination — use this instead of APIListContacts / APIListGroups when scanning at scale (those load every record into memory and fail on large databases).
|
||||
# Network usage: no.
|
||||
class APIGetChats(TypedDict):
|
||||
userId: int # int64
|
||||
pendingConnections: bool
|
||||
pagination: "T.PaginationByTime"
|
||||
query: "T.ChatListQuery"
|
||||
|
||||
|
||||
def APIGetChats_cmd_string(self: APIGetChats) -> str:
|
||||
return '/_get chats ' + str(self['userId']) + (' pcc=on' if self['pendingConnections'] else '') + ' ' + T.PaginationByTime_cmd_string(self['pagination']) + ' ' + json.dumps(self['query'])
|
||||
|
||||
APIGetChats_Response = CR.ApiChats | CR.ChatCmdError
|
||||
|
||||
|
||||
# Delete chat.
|
||||
# Network usage: background.
|
||||
class APIDeleteChat(TypedDict):
|
||||
chatRef: "T.ChatRef"
|
||||
chatDeleteMode: "T.ChatDeleteMode"
|
||||
|
||||
|
||||
def APIDeleteChat_cmd_string(self: APIDeleteChat) -> str:
|
||||
return '/_delete ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + T.ChatDeleteMode_cmd_string(self['chatDeleteMode'])
|
||||
|
||||
APIDeleteChat_Response = CR.ContactDeleted | CR.ContactConnectionDeleted | CR.GroupDeletedUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set group custom data.
|
||||
# Network usage: no.
|
||||
class APISetGroupCustomData(TypedDict):
|
||||
groupId: int # int64
|
||||
customData: NotRequired[dict[str, object]]
|
||||
|
||||
|
||||
def APISetGroupCustomData_cmd_string(self: APISetGroupCustomData) -> str:
|
||||
return '/_set custom #' + str(self['groupId']) + ((' ' + json.dumps(self.get('customData'))) if self.get('customData') is not None else '')
|
||||
|
||||
APISetGroupCustomData_Response = CR.CmdOk | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set contact custom data.
|
||||
# Network usage: no.
|
||||
class APISetContactCustomData(TypedDict):
|
||||
contactId: int # int64
|
||||
customData: NotRequired[dict[str, object]]
|
||||
|
||||
|
||||
def APISetContactCustomData_cmd_string(self: APISetContactCustomData) -> str:
|
||||
return '/_set custom @' + str(self['contactId']) + ((' ' + json.dumps(self.get('customData'))) if self.get('customData') is not None else '')
|
||||
|
||||
APISetContactCustomData_Response = CR.CmdOk | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set auto-accept member contacts.
|
||||
# Network usage: no.
|
||||
class APISetUserAutoAcceptMemberContacts(TypedDict):
|
||||
userId: int # int64
|
||||
onOff: bool
|
||||
|
||||
|
||||
def APISetUserAutoAcceptMemberContacts_cmd_string(self: APISetUserAutoAcceptMemberContacts) -> str:
|
||||
return '/_set accept member contacts ' + str(self['userId']) + ' ' + ('on' if self['onOff'] else 'off')
|
||||
|
||||
APISetUserAutoAcceptMemberContacts_Response = CR.CmdOk | CR.ChatCmdError
|
||||
|
||||
|
||||
# User profile commands
|
||||
# Most bots don't need to use these commands, as bot profile can be configured manually via CLI or desktop client. These commands can be used by bots that need to manage multiple user profiles (e.g., the profiles of support agents).
|
||||
|
||||
# Get active user profile.
|
||||
# Network usage: no.
|
||||
class ShowActiveUser(TypedDict):
|
||||
pass
|
||||
|
||||
|
||||
def ShowActiveUser_cmd_string(self: ShowActiveUser) -> str:
|
||||
return '/user'
|
||||
|
||||
ShowActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Create new user profile.
|
||||
# Network usage: no.
|
||||
class CreateActiveUser(TypedDict):
|
||||
newUser: "T.NewUser"
|
||||
|
||||
|
||||
def CreateActiveUser_cmd_string(self: CreateActiveUser) -> str:
|
||||
return '/_create user ' + json.dumps(self['newUser'])
|
||||
|
||||
CreateActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Get all user profiles.
|
||||
# Network usage: no.
|
||||
class ListUsers(TypedDict):
|
||||
pass
|
||||
|
||||
|
||||
def ListUsers_cmd_string(self: ListUsers) -> str:
|
||||
return '/users'
|
||||
|
||||
ListUsers_Response = CR.UsersList | CR.ChatCmdError
|
||||
|
||||
|
||||
# Set active user profile.
|
||||
# Network usage: no.
|
||||
class APISetActiveUser(TypedDict):
|
||||
userId: int # int64
|
||||
viewPwd: NotRequired[str]
|
||||
|
||||
|
||||
def APISetActiveUser_cmd_string(self: APISetActiveUser) -> str:
|
||||
return '/_user ' + str(self['userId']) + ((' ' + json.dumps(self.get('viewPwd'))) if self.get('viewPwd') is not None else '')
|
||||
|
||||
APISetActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
|
||||
|
||||
|
||||
# Delete user profile.
|
||||
# Network usage: background.
|
||||
class APIDeleteUser(TypedDict):
|
||||
userId: int # int64
|
||||
delSMPQueues: bool
|
||||
viewPwd: NotRequired[str]
|
||||
|
||||
|
||||
def APIDeleteUser_cmd_string(self: APIDeleteUser) -> str:
|
||||
return '/_delete user ' + str(self['userId']) + ' del_smp=' + ('on' if self['delSMPQueues'] else 'off') + ((' ' + json.dumps(self.get('viewPwd'))) if self.get('viewPwd') is not None else '')
|
||||
|
||||
APIDeleteUser_Response = CR.CmdOk | CR.ChatCmdError
|
||||
|
||||
|
||||
# Update user profile.
|
||||
# Network usage: background.
|
||||
class APIUpdateProfile(TypedDict):
|
||||
userId: int # int64
|
||||
profile: "T.Profile"
|
||||
|
||||
|
||||
def APIUpdateProfile_cmd_string(self: APIUpdateProfile) -> str:
|
||||
return '/_profile ' + str(self['userId']) + ' ' + json.dumps(self['profile'])
|
||||
|
||||
APIUpdateProfile_Response = CR.UserProfileUpdated | CR.UserProfileNoChange | CR.ChatCmdError
|
||||
|
||||
|
||||
# Configure chat preference overrides for the contact.
|
||||
# Network usage: background.
|
||||
class APISetContactPrefs(TypedDict):
|
||||
contactId: int # int64
|
||||
preferences: "T.Preferences"
|
||||
|
||||
|
||||
def APISetContactPrefs_cmd_string(self: APISetContactPrefs) -> str:
|
||||
return '/_set prefs @' + str(self['contactId']) + ' ' + json.dumps(self['preferences'])
|
||||
|
||||
APISetContactPrefs_Response = CR.ContactPrefsUpdated | CR.ChatCmdError
|
||||
|
||||
|
||||
# Chat management
|
||||
# These commands should not be used with CLI-based bots
|
||||
|
||||
# Start chat controller.
|
||||
# Network usage: no.
|
||||
class StartChat(TypedDict):
|
||||
mainApp: bool
|
||||
enableSndFiles: bool
|
||||
|
||||
|
||||
def StartChat_cmd_string(self: StartChat) -> str:
|
||||
return '/_start'
|
||||
|
||||
StartChat_Response = CR.ChatStarted | CR.ChatRunning
|
||||
|
||||
|
||||
# Stop chat controller.
|
||||
# Network usage: no.
|
||||
class APIStopChat(TypedDict):
|
||||
pass
|
||||
|
||||
|
||||
def APIStopChat_cmd_string(self: APIStopChat) -> str:
|
||||
return '/_stop'
|
||||
|
||||
APIStopChat_Response = CR.ChatStopped
|
||||
|
||||
@@ -0,0 +1,379 @@
|
||||
# API Events
|
||||
# This file is generated automatically.
|
||||
from __future__ import annotations
|
||||
from typing import Literal, NotRequired, TypedDict
|
||||
from . import _types as T
|
||||
|
||||
class ContactConnected(TypedDict):
|
||||
type: Literal["contactConnected"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
userCustomProfile: NotRequired["T.Profile"]
|
||||
|
||||
class ContactUpdated(TypedDict):
|
||||
type: Literal["contactUpdated"]
|
||||
user: "T.User"
|
||||
fromContact: "T.Contact"
|
||||
toContact: "T.Contact"
|
||||
|
||||
class ContactDeletedByContact(TypedDict):
|
||||
type: Literal["contactDeletedByContact"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class ReceivedContactRequest(TypedDict):
|
||||
type: Literal["receivedContactRequest"]
|
||||
user: "T.User"
|
||||
contactRequest: "T.UserContactRequest"
|
||||
chat_: NotRequired["T.AChat"]
|
||||
|
||||
class NewMemberContactReceivedInv(TypedDict):
|
||||
type: Literal["newMemberContactReceivedInv"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class ContactSndReady(TypedDict):
|
||||
type: Literal["contactSndReady"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class NewChatItems(TypedDict):
|
||||
type: Literal["newChatItems"]
|
||||
user: "T.User"
|
||||
chatItems: list["T.AChatItem"]
|
||||
|
||||
class ChatItemReaction(TypedDict):
|
||||
type: Literal["chatItemReaction"]
|
||||
user: "T.User"
|
||||
added: bool
|
||||
reaction: "T.ACIReaction"
|
||||
|
||||
class ChatItemsDeleted(TypedDict):
|
||||
type: Literal["chatItemsDeleted"]
|
||||
user: "T.User"
|
||||
chatItemDeletions: list["T.ChatItemDeletion"]
|
||||
byUser: bool
|
||||
timed: bool
|
||||
|
||||
class ChatItemUpdated(TypedDict):
|
||||
type: Literal["chatItemUpdated"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class GroupChatItemsDeleted(TypedDict):
|
||||
type: Literal["groupChatItemsDeleted"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
chatItemIDs: list[int] # int64
|
||||
byUser: bool
|
||||
member_: NotRequired["T.GroupMember"]
|
||||
|
||||
class ChatItemsStatusesUpdated(TypedDict):
|
||||
type: Literal["chatItemsStatusesUpdated"]
|
||||
user: "T.User"
|
||||
chatItems: list["T.AChatItem"]
|
||||
|
||||
class ReceivedGroupInvitation(TypedDict):
|
||||
type: Literal["receivedGroupInvitation"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
contact: "T.Contact"
|
||||
fromMemberRole: "T.GroupMemberRole"
|
||||
memberRole: "T.GroupMemberRole"
|
||||
|
||||
class UserJoinedGroup(TypedDict):
|
||||
type: Literal["userJoinedGroup"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
hostMember: "T.GroupMember"
|
||||
|
||||
class GroupUpdated(TypedDict):
|
||||
type: Literal["groupUpdated"]
|
||||
user: "T.User"
|
||||
fromGroup: "T.GroupInfo"
|
||||
toGroup: "T.GroupInfo"
|
||||
member_: NotRequired["T.GroupMember"]
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class JoinedGroupMember(TypedDict):
|
||||
type: Literal["joinedGroupMember"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class MemberRole(TypedDict):
|
||||
type: Literal["memberRole"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
byMember: "T.GroupMember"
|
||||
member: "T.GroupMember"
|
||||
fromRole: "T.GroupMemberRole"
|
||||
toRole: "T.GroupMemberRole"
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class DeletedMember(TypedDict):
|
||||
type: Literal["deletedMember"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
byMember: "T.GroupMember"
|
||||
deletedMember: "T.GroupMember"
|
||||
withMessages: bool
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class LeftMember(TypedDict):
|
||||
type: Literal["leftMember"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class DeletedMemberUser(TypedDict):
|
||||
type: Literal["deletedMemberUser"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
withMessages: bool
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class GroupDeleted(TypedDict):
|
||||
type: Literal["groupDeleted"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class ConnectedToGroupMember(TypedDict):
|
||||
type: Literal["connectedToGroupMember"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
memberContact: NotRequired["T.Contact"]
|
||||
|
||||
class MemberAcceptedByOther(TypedDict):
|
||||
type: Literal["memberAcceptedByOther"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
acceptingMember: "T.GroupMember"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class MemberBlockedForAll(TypedDict):
|
||||
type: Literal["memberBlockedForAll"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
byMember: "T.GroupMember"
|
||||
member: "T.GroupMember"
|
||||
blocked: bool
|
||||
msgSigned: NotRequired["T.MsgSigStatus"]
|
||||
|
||||
class GroupMemberUpdated(TypedDict):
|
||||
type: Literal["groupMemberUpdated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
fromMember: "T.GroupMember"
|
||||
toMember: "T.GroupMember"
|
||||
|
||||
class GroupLinkDataUpdated(TypedDict):
|
||||
type: Literal["groupLinkDataUpdated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupLink: "T.GroupLink"
|
||||
groupRelays: list["T.GroupRelay"]
|
||||
relaysChanged: bool
|
||||
|
||||
class GroupRelayUpdated(TypedDict):
|
||||
type: Literal["groupRelayUpdated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
groupRelay: "T.GroupRelay"
|
||||
|
||||
class RcvFileDescrReady(TypedDict):
|
||||
type: Literal["rcvFileDescrReady"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
rcvFileDescr: "T.RcvFileDescr"
|
||||
|
||||
class RcvFileComplete(TypedDict):
|
||||
type: Literal["rcvFileComplete"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class SndFileCompleteXFTP(TypedDict):
|
||||
type: Literal["sndFileCompleteXFTP"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
fileTransferMeta: "T.FileTransferMeta"
|
||||
|
||||
class RcvFileStart(TypedDict):
|
||||
type: Literal["rcvFileStart"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class RcvFileSndCancelled(TypedDict):
|
||||
type: Literal["rcvFileSndCancelled"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
|
||||
class RcvFileAccepted(TypedDict):
|
||||
type: Literal["rcvFileAccepted"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class RcvFileError(TypedDict):
|
||||
type: Literal["rcvFileError"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
agentError: "T.AgentErrorType"
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
|
||||
class RcvFileWarning(TypedDict):
|
||||
type: Literal["rcvFileWarning"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
agentError: "T.AgentErrorType"
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
|
||||
class SndFileError(TypedDict):
|
||||
type: Literal["sndFileError"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
fileTransferMeta: "T.FileTransferMeta"
|
||||
errorMessage: str
|
||||
|
||||
class SndFileWarning(TypedDict):
|
||||
type: Literal["sndFileWarning"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
fileTransferMeta: "T.FileTransferMeta"
|
||||
errorMessage: str
|
||||
|
||||
class AcceptingContactRequest(TypedDict):
|
||||
type: Literal["acceptingContactRequest"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class AcceptingBusinessRequest(TypedDict):
|
||||
type: Literal["acceptingBusinessRequest"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
|
||||
class ContactConnecting(TypedDict):
|
||||
type: Literal["contactConnecting"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class BusinessLinkConnecting(TypedDict):
|
||||
type: Literal["businessLinkConnecting"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
hostMember: "T.GroupMember"
|
||||
fromContact: "T.Contact"
|
||||
|
||||
class JoinedGroupMemberConnecting(TypedDict):
|
||||
type: Literal["joinedGroupMemberConnecting"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
hostMember: "T.GroupMember"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class SentGroupInvitation(TypedDict):
|
||||
type: Literal["sentGroupInvitation"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
contact: "T.Contact"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class GroupLinkConnecting(TypedDict):
|
||||
type: Literal["groupLinkConnecting"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
hostMember: "T.GroupMember"
|
||||
|
||||
class HostConnected(TypedDict):
|
||||
type: Literal["hostConnected"]
|
||||
protocol: str
|
||||
transportHost: str
|
||||
|
||||
class HostDisconnected(TypedDict):
|
||||
type: Literal["hostDisconnected"]
|
||||
protocol: str
|
||||
transportHost: str
|
||||
|
||||
class SubscriptionStatus(TypedDict):
|
||||
type: Literal["subscriptionStatus"]
|
||||
server: str
|
||||
subscriptionStatus: "T.SubscriptionStatus"
|
||||
connections: list[str]
|
||||
|
||||
class MessageError(TypedDict):
|
||||
type: Literal["messageError"]
|
||||
user: "T.User"
|
||||
severity: str
|
||||
errorMessage: str
|
||||
|
||||
class ChatError(TypedDict):
|
||||
type: Literal["chatError"]
|
||||
chatError: "T.ChatError"
|
||||
|
||||
class ChatErrors(TypedDict):
|
||||
type: Literal["chatErrors"]
|
||||
chatErrors: list["T.ChatError"]
|
||||
|
||||
ChatEvent = (
|
||||
ContactConnected
|
||||
| ContactUpdated
|
||||
| ContactDeletedByContact
|
||||
| ReceivedContactRequest
|
||||
| NewMemberContactReceivedInv
|
||||
| ContactSndReady
|
||||
| NewChatItems
|
||||
| ChatItemReaction
|
||||
| ChatItemsDeleted
|
||||
| ChatItemUpdated
|
||||
| GroupChatItemsDeleted
|
||||
| ChatItemsStatusesUpdated
|
||||
| ReceivedGroupInvitation
|
||||
| UserJoinedGroup
|
||||
| GroupUpdated
|
||||
| JoinedGroupMember
|
||||
| MemberRole
|
||||
| DeletedMember
|
||||
| LeftMember
|
||||
| DeletedMemberUser
|
||||
| GroupDeleted
|
||||
| ConnectedToGroupMember
|
||||
| MemberAcceptedByOther
|
||||
| MemberBlockedForAll
|
||||
| GroupMemberUpdated
|
||||
| GroupLinkDataUpdated
|
||||
| GroupRelayUpdated
|
||||
| RcvFileDescrReady
|
||||
| RcvFileComplete
|
||||
| SndFileCompleteXFTP
|
||||
| RcvFileStart
|
||||
| RcvFileSndCancelled
|
||||
| RcvFileAccepted
|
||||
| RcvFileError
|
||||
| RcvFileWarning
|
||||
| SndFileError
|
||||
| SndFileWarning
|
||||
| AcceptingContactRequest
|
||||
| AcceptingBusinessRequest
|
||||
| ContactConnecting
|
||||
| BusinessLinkConnecting
|
||||
| JoinedGroupMemberConnecting
|
||||
| SentGroupInvitation
|
||||
| GroupLinkConnecting
|
||||
| HostConnected
|
||||
| HostDisconnected
|
||||
| SubscriptionStatus
|
||||
| MessageError
|
||||
| ChatError
|
||||
| ChatErrors
|
||||
)
|
||||
|
||||
ChatEvent_Tag = Literal["contactConnected", "contactUpdated", "contactDeletedByContact", "receivedContactRequest", "newMemberContactReceivedInv", "contactSndReady", "newChatItems", "chatItemReaction", "chatItemsDeleted", "chatItemUpdated", "groupChatItemsDeleted", "chatItemsStatusesUpdated", "receivedGroupInvitation", "userJoinedGroup", "groupUpdated", "joinedGroupMember", "memberRole", "deletedMember", "leftMember", "deletedMemberUser", "groupDeleted", "connectedToGroupMember", "memberAcceptedByOther", "memberBlockedForAll", "groupMemberUpdated", "groupLinkDataUpdated", "groupRelayUpdated", "rcvFileDescrReady", "rcvFileComplete", "sndFileCompleteXFTP", "rcvFileStart", "rcvFileSndCancelled", "rcvFileAccepted", "rcvFileError", "rcvFileWarning", "sndFileError", "sndFileWarning", "acceptingContactRequest", "acceptingBusinessRequest", "contactConnecting", "businessLinkConnecting", "joinedGroupMemberConnecting", "sentGroupInvitation", "groupLinkConnecting", "hostConnected", "hostDisconnected", "subscriptionStatus", "messageError", "chatError", "chatErrors"]
|
||||
@@ -0,0 +1,360 @@
|
||||
# API Responses
|
||||
# This file is generated automatically.
|
||||
from __future__ import annotations
|
||||
from typing import Literal, NotRequired, TypedDict
|
||||
from . import _types as T
|
||||
|
||||
class AcceptingContactRequest(TypedDict):
|
||||
type: Literal["acceptingContactRequest"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class ActiveUser(TypedDict):
|
||||
type: Literal["activeUser"]
|
||||
user: "T.User"
|
||||
|
||||
class ChatItemNotChanged(TypedDict):
|
||||
type: Literal["chatItemNotChanged"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class ChatItemReaction(TypedDict):
|
||||
type: Literal["chatItemReaction"]
|
||||
user: "T.User"
|
||||
added: bool
|
||||
reaction: "T.ACIReaction"
|
||||
|
||||
class ChatItemUpdated(TypedDict):
|
||||
type: Literal["chatItemUpdated"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class ChatItemsDeleted(TypedDict):
|
||||
type: Literal["chatItemsDeleted"]
|
||||
user: "T.User"
|
||||
chatItemDeletions: list["T.ChatItemDeletion"]
|
||||
byUser: bool
|
||||
timed: bool
|
||||
|
||||
class ChatRunning(TypedDict):
|
||||
type: Literal["chatRunning"]
|
||||
|
||||
class ChatStarted(TypedDict):
|
||||
type: Literal["chatStarted"]
|
||||
|
||||
class ChatStopped(TypedDict):
|
||||
type: Literal["chatStopped"]
|
||||
|
||||
class CmdOk(TypedDict):
|
||||
type: Literal["cmdOk"]
|
||||
user_: NotRequired["T.User"]
|
||||
|
||||
class ChatCmdError(TypedDict):
|
||||
type: Literal["chatCmdError"]
|
||||
chatError: "T.ChatError"
|
||||
|
||||
class ConnectionPlan(TypedDict):
|
||||
type: Literal["connectionPlan"]
|
||||
user: "T.User"
|
||||
connLink: "T.CreatedConnLink"
|
||||
connectionPlan: "T.ConnectionPlan"
|
||||
|
||||
class ContactAlreadyExists(TypedDict):
|
||||
type: Literal["contactAlreadyExists"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class ContactConnectionDeleted(TypedDict):
|
||||
type: Literal["contactConnectionDeleted"]
|
||||
user: "T.User"
|
||||
connection: "T.PendingContactConnection"
|
||||
|
||||
class ContactDeleted(TypedDict):
|
||||
type: Literal["contactDeleted"]
|
||||
user: "T.User"
|
||||
contact: "T.Contact"
|
||||
|
||||
class ContactPrefsUpdated(TypedDict):
|
||||
type: Literal["contactPrefsUpdated"]
|
||||
user: "T.User"
|
||||
fromContact: "T.Contact"
|
||||
toContact: "T.Contact"
|
||||
|
||||
class ContactRequestRejected(TypedDict):
|
||||
type: Literal["contactRequestRejected"]
|
||||
user: "T.User"
|
||||
contactRequest: "T.UserContactRequest"
|
||||
contact_: NotRequired["T.Contact"]
|
||||
|
||||
class ContactsList(TypedDict):
|
||||
type: Literal["contactsList"]
|
||||
user: "T.User"
|
||||
contacts: list["T.Contact"]
|
||||
|
||||
class GroupDeletedUser(TypedDict):
|
||||
type: Literal["groupDeletedUser"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
msgSigned: bool
|
||||
|
||||
class GroupLink(TypedDict):
|
||||
type: Literal["groupLink"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupLink: "T.GroupLink"
|
||||
|
||||
class GroupLinkCreated(TypedDict):
|
||||
type: Literal["groupLinkCreated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupLink: "T.GroupLink"
|
||||
|
||||
class GroupLinkDeleted(TypedDict):
|
||||
type: Literal["groupLinkDeleted"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
|
||||
class GroupCreated(TypedDict):
|
||||
type: Literal["groupCreated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
|
||||
class PublicGroupCreated(TypedDict):
|
||||
type: Literal["publicGroupCreated"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupLink: "T.GroupLink"
|
||||
groupRelays: list["T.GroupRelay"]
|
||||
|
||||
class PublicGroupCreationFailed(TypedDict):
|
||||
type: Literal["publicGroupCreationFailed"]
|
||||
user: "T.User"
|
||||
addRelayResults: list["T.AddRelayResult"]
|
||||
|
||||
class GroupRelays(TypedDict):
|
||||
type: Literal["groupRelays"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupRelays: list["T.GroupRelay"]
|
||||
|
||||
class GroupRelaysAdded(TypedDict):
|
||||
type: Literal["groupRelaysAdded"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
groupLink: "T.GroupLink"
|
||||
groupRelays: list["T.GroupRelay"]
|
||||
|
||||
class GroupRelaysAddFailed(TypedDict):
|
||||
type: Literal["groupRelaysAddFailed"]
|
||||
user: "T.User"
|
||||
addRelayResults: list["T.AddRelayResult"]
|
||||
|
||||
class GroupMembers(TypedDict):
|
||||
type: Literal["groupMembers"]
|
||||
user: "T.User"
|
||||
group: "T.Group"
|
||||
|
||||
class GroupUpdated(TypedDict):
|
||||
type: Literal["groupUpdated"]
|
||||
user: "T.User"
|
||||
fromGroup: "T.GroupInfo"
|
||||
toGroup: "T.GroupInfo"
|
||||
member_: NotRequired["T.GroupMember"]
|
||||
msgSigned: bool
|
||||
|
||||
class GroupsList(TypedDict):
|
||||
type: Literal["groupsList"]
|
||||
user: "T.User"
|
||||
groups: list["T.GroupInfo"]
|
||||
|
||||
class Invitation(TypedDict):
|
||||
type: Literal["invitation"]
|
||||
user: "T.User"
|
||||
connLinkInvitation: "T.CreatedConnLink"
|
||||
connection: "T.PendingContactConnection"
|
||||
|
||||
class LeftMemberUser(TypedDict):
|
||||
type: Literal["leftMemberUser"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
|
||||
class MemberAccepted(TypedDict):
|
||||
type: Literal["memberAccepted"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class MembersBlockedForAllUser(TypedDict):
|
||||
type: Literal["membersBlockedForAllUser"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
members: list["T.GroupMember"]
|
||||
blocked: bool
|
||||
msgSigned: bool
|
||||
|
||||
class MembersRoleUser(TypedDict):
|
||||
type: Literal["membersRoleUser"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
members: list["T.GroupMember"]
|
||||
toRole: "T.GroupMemberRole"
|
||||
msgSigned: bool
|
||||
|
||||
class NewChatItems(TypedDict):
|
||||
type: Literal["newChatItems"]
|
||||
user: "T.User"
|
||||
chatItems: list["T.AChatItem"]
|
||||
|
||||
class RcvFileAccepted(TypedDict):
|
||||
type: Literal["rcvFileAccepted"]
|
||||
user: "T.User"
|
||||
chatItem: "T.AChatItem"
|
||||
|
||||
class RcvFileAcceptedSndCancelled(TypedDict):
|
||||
type: Literal["rcvFileAcceptedSndCancelled"]
|
||||
user: "T.User"
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
|
||||
class RcvFileCancelled(TypedDict):
|
||||
type: Literal["rcvFileCancelled"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
rcvFileTransfer: "T.RcvFileTransfer"
|
||||
|
||||
class SentConfirmation(TypedDict):
|
||||
type: Literal["sentConfirmation"]
|
||||
user: "T.User"
|
||||
connection: "T.PendingContactConnection"
|
||||
customUserProfile: NotRequired["T.Profile"]
|
||||
|
||||
class SentGroupInvitation(TypedDict):
|
||||
type: Literal["sentGroupInvitation"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
contact: "T.Contact"
|
||||
member: "T.GroupMember"
|
||||
|
||||
class SentInvitation(TypedDict):
|
||||
type: Literal["sentInvitation"]
|
||||
user: "T.User"
|
||||
connection: "T.PendingContactConnection"
|
||||
customUserProfile: NotRequired["T.Profile"]
|
||||
|
||||
class SndFileCancelled(TypedDict):
|
||||
type: Literal["sndFileCancelled"]
|
||||
user: "T.User"
|
||||
chatItem_: NotRequired["T.AChatItem"]
|
||||
fileTransferMeta: "T.FileTransferMeta"
|
||||
sndFileTransfers: list["T.SndFileTransfer"]
|
||||
|
||||
class UserAcceptedGroupSent(TypedDict):
|
||||
type: Literal["userAcceptedGroupSent"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
hostContact: NotRequired["T.Contact"]
|
||||
|
||||
class UserContactLink(TypedDict):
|
||||
type: Literal["userContactLink"]
|
||||
user: "T.User"
|
||||
contactLink: "T.UserContactLink"
|
||||
|
||||
class UserContactLinkCreated(TypedDict):
|
||||
type: Literal["userContactLinkCreated"]
|
||||
user: "T.User"
|
||||
connLinkContact: "T.CreatedConnLink"
|
||||
|
||||
class UserContactLinkDeleted(TypedDict):
|
||||
type: Literal["userContactLinkDeleted"]
|
||||
user: "T.User"
|
||||
|
||||
class UserContactLinkUpdated(TypedDict):
|
||||
type: Literal["userContactLinkUpdated"]
|
||||
user: "T.User"
|
||||
contactLink: "T.UserContactLink"
|
||||
|
||||
class UserDeletedMembers(TypedDict):
|
||||
type: Literal["userDeletedMembers"]
|
||||
user: "T.User"
|
||||
groupInfo: "T.GroupInfo"
|
||||
members: list["T.GroupMember"]
|
||||
withMessages: bool
|
||||
msgSigned: bool
|
||||
|
||||
class UserProfileUpdated(TypedDict):
|
||||
type: Literal["userProfileUpdated"]
|
||||
user: "T.User"
|
||||
fromProfile: "T.Profile"
|
||||
toProfile: "T.Profile"
|
||||
updateSummary: "T.UserProfileUpdateSummary"
|
||||
|
||||
class UserProfileNoChange(TypedDict):
|
||||
type: Literal["userProfileNoChange"]
|
||||
user: "T.User"
|
||||
|
||||
class UsersList(TypedDict):
|
||||
type: Literal["usersList"]
|
||||
users: list["T.UserInfo"]
|
||||
|
||||
class ApiChats(TypedDict):
|
||||
type: Literal["apiChats"]
|
||||
user: "T.User"
|
||||
chats: list["T.AChat"]
|
||||
|
||||
ChatResponse = (
|
||||
AcceptingContactRequest
|
||||
| ActiveUser
|
||||
| ChatItemNotChanged
|
||||
| ChatItemReaction
|
||||
| ChatItemUpdated
|
||||
| ChatItemsDeleted
|
||||
| ChatRunning
|
||||
| ChatStarted
|
||||
| ChatStopped
|
||||
| CmdOk
|
||||
| ChatCmdError
|
||||
| ConnectionPlan
|
||||
| ContactAlreadyExists
|
||||
| ContactConnectionDeleted
|
||||
| ContactDeleted
|
||||
| ContactPrefsUpdated
|
||||
| ContactRequestRejected
|
||||
| ContactsList
|
||||
| GroupDeletedUser
|
||||
| GroupLink
|
||||
| GroupLinkCreated
|
||||
| GroupLinkDeleted
|
||||
| GroupCreated
|
||||
| PublicGroupCreated
|
||||
| PublicGroupCreationFailed
|
||||
| GroupRelays
|
||||
| GroupRelaysAdded
|
||||
| GroupRelaysAddFailed
|
||||
| GroupMembers
|
||||
| GroupUpdated
|
||||
| GroupsList
|
||||
| Invitation
|
||||
| LeftMemberUser
|
||||
| MemberAccepted
|
||||
| MembersBlockedForAllUser
|
||||
| MembersRoleUser
|
||||
| NewChatItems
|
||||
| RcvFileAccepted
|
||||
| RcvFileAcceptedSndCancelled
|
||||
| RcvFileCancelled
|
||||
| SentConfirmation
|
||||
| SentGroupInvitation
|
||||
| SentInvitation
|
||||
| SndFileCancelled
|
||||
| UserAcceptedGroupSent
|
||||
| UserContactLink
|
||||
| UserContactLinkCreated
|
||||
| UserContactLinkDeleted
|
||||
| UserContactLinkUpdated
|
||||
| UserDeletedMembers
|
||||
| UserProfileUpdated
|
||||
| UserProfileNoChange
|
||||
| UsersList
|
||||
| ApiChats
|
||||
)
|
||||
|
||||
ChatResponse_Tag = Literal["acceptingContactRequest", "activeUser", "chatItemNotChanged", "chatItemReaction", "chatItemUpdated", "chatItemsDeleted", "chatRunning", "chatStarted", "chatStopped", "cmdOk", "chatCmdError", "connectionPlan", "contactAlreadyExists", "contactConnectionDeleted", "contactDeleted", "contactPrefsUpdated", "contactRequestRejected", "contactsList", "groupDeletedUser", "groupLink", "groupLinkCreated", "groupLinkDeleted", "groupCreated", "publicGroupCreated", "publicGroupCreationFailed", "groupRelays", "groupRelaysAdded", "groupRelaysAddFailed", "groupMembers", "groupUpdated", "groupsList", "invitation", "leftMemberUser", "memberAccepted", "membersBlockedForAllUser", "membersRoleUser", "newChatItems", "rcvFileAccepted", "rcvFileAcceptedSndCancelled", "rcvFileCancelled", "sentConfirmation", "sentGroupInvitation", "sentInvitation", "sndFileCancelled", "userAcceptedGroupSent", "userContactLink", "userContactLinkCreated", "userContactLinkDeleted", "userContactLinkUpdated", "userDeletedMembers", "userProfileUpdated", "userProfileNoChange", "usersList", "apiChats"]
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,128 @@
|
||||
"""Reusable helpers for working with chat events, types, and message content.
|
||||
|
||||
Mirrors the Node `util.ts` exports — provides the same primitives bot
|
||||
authors typically reach for: command parsing, sender display strings,
|
||||
message-content extraction, profile field cleanup, and ChatRef extraction
|
||||
from a ChatInfo (handy when echoing into a different chat).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from typing import Any
|
||||
|
||||
from .types import T
|
||||
|
||||
|
||||
def chat_info_ref(c_info: T.ChatInfo) -> T.ChatRef | None:
|
||||
"""Extract a wire-format `ChatRef` from a `ChatInfo`.
|
||||
|
||||
Returns `None` for non-chat infos (contactRequest, contactConnection)
|
||||
that can't be the target of `api_send_messages`. For groups, the
|
||||
`memberSupport` scope is forwarded so messages land in the right
|
||||
thread; other scopes are dropped (matches Node `util.chatInfoRef`).
|
||||
"""
|
||||
t = c_info["type"]
|
||||
if t == "direct":
|
||||
return {"chatType": "direct", "chatId": c_info["contact"]["contactId"]} # type: ignore[index]
|
||||
if t == "group":
|
||||
ref: T.ChatRef = {"chatType": "group", "chatId": c_info["groupInfo"]["groupId"]} # type: ignore[index]
|
||||
scope = c_info.get("groupChatScope") # type: ignore[union-attr]
|
||||
if scope and scope.get("type") == "memberSupport":
|
||||
member = scope.get("groupMember_")
|
||||
ms_scope: T.GroupChatScope_memberSupport = {"type": "memberSupport"}
|
||||
if member is not None:
|
||||
ms_scope["groupMemberId_"] = member["groupMemberId"]
|
||||
ref["chatScope"] = ms_scope
|
||||
return ref
|
||||
return None
|
||||
|
||||
|
||||
def chat_info_name(c_info: T.ChatInfo) -> str:
|
||||
"""Display string for a chat: `@Alice`, `#GroupName`, `private notes`, etc."""
|
||||
t = c_info["type"]
|
||||
if t == "direct":
|
||||
return f"@{c_info['contact']['profile']['displayName']}" # type: ignore[index]
|
||||
if t == "group":
|
||||
scope = c_info.get("groupChatScope") # type: ignore[union-attr]
|
||||
if scope and scope.get("type") == "memberSupport":
|
||||
member = scope.get("groupMember_")
|
||||
scope_name = f" {member['memberProfile']['displayName']}" if member else ""
|
||||
return f"#{c_info['groupInfo']['groupProfile']['displayName']}(support{scope_name})" # type: ignore[index]
|
||||
return f"#{c_info['groupInfo']['groupProfile']['displayName']}" # type: ignore[index]
|
||||
if t == "local":
|
||||
return "private notes"
|
||||
if t == "contactRequest":
|
||||
return f"request from @{c_info['contactRequest']['profile']['displayName']}" # type: ignore[index]
|
||||
if t == "contactConnection":
|
||||
alias = c_info["contactConnection"].get("localAlias") # type: ignore[index]
|
||||
return f"pending connection ({alias})" if alias else "pending connection"
|
||||
return f"<{t}>"
|
||||
|
||||
|
||||
def sender_name(c_info: T.ChatInfo, chat_dir: T.CIDirection) -> str:
|
||||
"""Sender display: chat name plus group sender suffix when applicable."""
|
||||
base = chat_info_name(c_info)
|
||||
if chat_dir["type"] == "groupRcv":
|
||||
sender = chat_dir["groupMember"]["memberProfile"]["displayName"] # type: ignore[index]
|
||||
return f"{base} @{sender}"
|
||||
return base
|
||||
|
||||
|
||||
def contact_address_str(link: T.CreatedConnLink) -> str:
|
||||
"""Prefer the short link, fall back to the full link."""
|
||||
return link.get("connShortLink") or link["connFullLink"]
|
||||
|
||||
|
||||
def from_local_profile(local: T.LocalProfile) -> T.Profile:
|
||||
"""Strip extra LocalProfile fields (profileId, localAlias) and undefined values."""
|
||||
p: dict[str, Any] = {}
|
||||
for key in (
|
||||
"displayName",
|
||||
"fullName",
|
||||
"shortDescr",
|
||||
"image",
|
||||
"contactLink",
|
||||
"preferences",
|
||||
"peerType",
|
||||
):
|
||||
v = local.get(key) # type: ignore[misc]
|
||||
if v is not None:
|
||||
p[key] = v
|
||||
return p # type: ignore[return-value]
|
||||
|
||||
|
||||
def ci_content_text(chat_item: T.ChatItem) -> str | None:
|
||||
"""Extract the message text from a sent or received message item, if any."""
|
||||
content = chat_item["content"]
|
||||
if content["type"] in ("sndMsgContent", "rcvMsgContent"):
|
||||
msg = content.get("msgContent", {}) # type: ignore[union-attr]
|
||||
return msg.get("text")
|
||||
return None
|
||||
|
||||
|
||||
_BOT_COMMAND_RE = re.compile(r"^/([^\s]+)(.*)$")
|
||||
|
||||
|
||||
def ci_bot_command(chat_item: T.ChatItem) -> tuple[str, str] | None:
|
||||
"""Parse a `/keyword args...` slash-command from a chat item.
|
||||
|
||||
Returns `(keyword, trimmed_params)` or `None` if the message isn't a
|
||||
slash command. Mirrors Node `util.ciBotCommand` semantics.
|
||||
"""
|
||||
text = ci_content_text(chat_item)
|
||||
if not text:
|
||||
return None
|
||||
text = text.strip()
|
||||
m = _BOT_COMMAND_RE.match(text)
|
||||
if not m:
|
||||
return None
|
||||
return m.group(1), m.group(2).strip()
|
||||
|
||||
|
||||
def reaction_text(reaction: T.ACIReaction) -> str:
|
||||
"""Format an `ACIReaction` as the emoji character or tag string."""
|
||||
r = reaction["chatReaction"]["reaction"] # type: ignore[index]
|
||||
if r["type"] == "emoji":
|
||||
return r["emoji"] # type: ignore[index]
|
||||
return r.get("tag", "") # type: ignore[union-attr]
|
||||
@@ -0,0 +1,357 @@
|
||||
import pytest
|
||||
|
||||
from simplex_chat import Bot, BotCommand, BotProfile, Middleware, SqliteDb
|
||||
from simplex_chat.api import ChatApi
|
||||
|
||||
|
||||
def _bot() -> Bot:
|
||||
return Bot(profile=BotProfile(display_name="x"), db=SqliteDb(file_prefix="/tmp/test"))
|
||||
|
||||
|
||||
def test_decorator_registers_message_handler():
|
||||
bot = _bot()
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def h(msg):
|
||||
pass
|
||||
|
||||
assert len(bot._message_handlers) == 1
|
||||
|
||||
|
||||
def test_decorator_registers_command_handler():
|
||||
bot = _bot()
|
||||
|
||||
@bot.on_command("ping")
|
||||
async def h(msg, cmd):
|
||||
pass
|
||||
|
||||
assert len(bot._command_handlers) == 1
|
||||
assert bot._command_handlers[0][0] == ("ping",)
|
||||
|
||||
|
||||
def test_decorator_registers_event_handler():
|
||||
bot = _bot()
|
||||
|
||||
@bot.on_event("newChatItems")
|
||||
async def h(evt):
|
||||
pass
|
||||
|
||||
assert "newChatItems" in bot._event_handlers
|
||||
assert len(bot._event_handlers["newChatItems"]) == 1
|
||||
|
||||
|
||||
def test_api_property_raises_before_init():
|
||||
bot = _bot()
|
||||
with pytest.raises(RuntimeError, match="not initialized"):
|
||||
_ = bot.api
|
||||
|
||||
|
||||
def test_command_keyword_tuple():
|
||||
bot = _bot()
|
||||
|
||||
@bot.on_command(("p", "ping"))
|
||||
async def h(msg, cmd):
|
||||
pass
|
||||
|
||||
assert bot._command_handlers[0][0] == ("p", "ping")
|
||||
|
||||
|
||||
def test_bot_profile_to_wire_default():
|
||||
"""use_bot_profile=True (default) sets peerType=bot and disables calls/voice."""
|
||||
bot = _bot()
|
||||
p = bot._bot_profile_to_wire()
|
||||
assert p["displayName"] == "x"
|
||||
assert p.get("peerType") == "bot"
|
||||
prefs = p.get("preferences") or {}
|
||||
assert prefs.get("calls", {}).get("allow") == "no"
|
||||
assert prefs.get("voice", {}).get("allow") == "no"
|
||||
assert prefs.get("files", {}).get("allow") == "no" # allow_files defaults to False
|
||||
|
||||
|
||||
def test_bot_profile_to_wire_allow_files():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
allow_files=True,
|
||||
)
|
||||
prefs = bot._bot_profile_to_wire().get("preferences") or {}
|
||||
assert prefs.get("files", {}).get("allow") == "yes"
|
||||
|
||||
|
||||
def test_bot_profile_to_wire_with_commands():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
commands=[BotCommand(keyword="ping", label="Ping bot"), BotCommand("help", "Show help")],
|
||||
)
|
||||
cmds = bot._bot_profile_to_wire().get("preferences", {}).get("commands") or []
|
||||
assert len(cmds) == 2
|
||||
assert cmds[0] == {"type": "command", "keyword": "ping", "label": "Ping bot"}
|
||||
assert cmds[1] == {"type": "command", "keyword": "help", "label": "Show help"}
|
||||
|
||||
|
||||
def test_bot_profile_to_wire_no_bot_profile():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
use_bot_profile=False,
|
||||
)
|
||||
p = bot._bot_profile_to_wire()
|
||||
assert "peerType" not in p
|
||||
assert "preferences" not in p
|
||||
|
||||
|
||||
def test_commands_without_bot_profile_raises():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
use_bot_profile=False,
|
||||
commands=[BotCommand("ping", "Ping bot")],
|
||||
)
|
||||
with pytest.raises(ValueError, match="use_bot_profile=False"):
|
||||
bot._bot_profile_to_wire()
|
||||
|
||||
|
||||
def test_dispatch_message_first_match_wins():
|
||||
"""Two matching message handlers — only the first registered fires."""
|
||||
import asyncio
|
||||
import re
|
||||
|
||||
bot = _bot()
|
||||
calls: list[str] = []
|
||||
|
||||
@bot.on_message(content_type="text", text=re.compile(r"^\d+$"))
|
||||
async def number(_msg):
|
||||
calls.append("number")
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(_msg):
|
||||
calls.append("fallback")
|
||||
|
||||
class M:
|
||||
pass
|
||||
|
||||
m = M()
|
||||
m.content = {"type": "text", "text": "42"}
|
||||
m.chat_item = {
|
||||
"chatItem": {
|
||||
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "42"}}
|
||||
},
|
||||
"chatInfo": {"type": "direct"},
|
||||
}
|
||||
m.text = "42"
|
||||
|
||||
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
|
||||
assert calls == ["number"], f"expected only 'number' for '42', got {calls}"
|
||||
|
||||
|
||||
def test_dispatch_message_falls_to_second_when_first_doesnt_match():
|
||||
"""If the first handler's filter doesn't match, the second one fires."""
|
||||
import asyncio
|
||||
import re
|
||||
|
||||
bot = _bot()
|
||||
calls: list[str] = []
|
||||
|
||||
@bot.on_message(content_type="text", text=re.compile(r"^\d+$"))
|
||||
async def number(_msg):
|
||||
calls.append("number")
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(_msg):
|
||||
calls.append("fallback")
|
||||
|
||||
class M:
|
||||
pass
|
||||
|
||||
m = M()
|
||||
m.content = {"type": "text", "text": "hello"}
|
||||
m.chat_item = {
|
||||
"chatItem": {
|
||||
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}
|
||||
},
|
||||
"chatInfo": {"type": "direct"},
|
||||
}
|
||||
m.text = "hello"
|
||||
|
||||
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
|
||||
assert calls == ["fallback"], f"expected 'fallback' for 'hello', got {calls}"
|
||||
|
||||
|
||||
def test_register_log_handlers_idempotent():
|
||||
"""Calling _register_log_handlers twice doesn't duplicate handlers."""
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
log_contacts=True,
|
||||
log_network=True,
|
||||
)
|
||||
bot._register_log_handlers()
|
||||
counts1 = {tag: len(hs) for tag, hs in bot._event_handlers.items()}
|
||||
bot._register_log_handlers()
|
||||
counts2 = {tag: len(hs) for tag, hs in bot._event_handlers.items()}
|
||||
assert counts1 == counts2, f"handler count changed across calls: {counts1} -> {counts2}"
|
||||
|
||||
|
||||
def test_default_error_handlers_always_registered():
|
||||
"""messageError/chatError/chatErrors get default loggers regardless of opts."""
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
log_contacts=False,
|
||||
log_network=False,
|
||||
)
|
||||
bot._register_log_handlers()
|
||||
assert "messageError" in bot._event_handlers
|
||||
assert "chatError" in bot._event_handlers
|
||||
assert "chatErrors" in bot._event_handlers
|
||||
|
||||
|
||||
def test_dispatch_command_suppresses_matching_message_handlers():
|
||||
"""A `/help` message routed to a command handler must NOT also fire the
|
||||
generic on_message text handler."""
|
||||
import asyncio
|
||||
|
||||
bot = _bot()
|
||||
calls: list[str] = []
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(_msg):
|
||||
calls.append("message")
|
||||
|
||||
@bot.on_command("help")
|
||||
async def help_cmd(_msg, _cmd):
|
||||
calls.append("command")
|
||||
|
||||
# Build a minimal Message-shaped object (handlers only inspect chat_item / text).
|
||||
class M:
|
||||
pass
|
||||
|
||||
m = M()
|
||||
m.content = {"type": "text", "text": "/help"}
|
||||
m.chat_item = {
|
||||
"chatItem": {
|
||||
"content": {
|
||||
"type": "rcvMsgContent",
|
||||
"msgContent": {"type": "text", "text": "/help"},
|
||||
}
|
||||
},
|
||||
"chatInfo": {"type": "direct"},
|
||||
}
|
||||
m.text = "/help"
|
||||
|
||||
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
|
||||
assert calls == ["command"], f"expected only 'command' to fire for /help, got {calls}"
|
||||
|
||||
|
||||
def test_dispatch_unknown_command_falls_through_to_message_handlers():
|
||||
"""A `/unknown` slash-command with no handler should still fire on_message."""
|
||||
import asyncio
|
||||
|
||||
bot = _bot()
|
||||
calls: list[str] = []
|
||||
|
||||
@bot.on_message(content_type="text")
|
||||
async def fallback(_msg):
|
||||
calls.append("message")
|
||||
|
||||
@bot.on_command("help")
|
||||
async def help_cmd(_msg, _cmd):
|
||||
calls.append("command")
|
||||
|
||||
class M:
|
||||
pass
|
||||
|
||||
m = M()
|
||||
m.content = {"type": "text", "text": "/unknown"}
|
||||
m.chat_item = {
|
||||
"chatItem": {
|
||||
"content": {
|
||||
"type": "rcvMsgContent",
|
||||
"msgContent": {"type": "text", "text": "/unknown"},
|
||||
}
|
||||
},
|
||||
"chatInfo": {"type": "direct"},
|
||||
}
|
||||
m.text = "/unknown"
|
||||
|
||||
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
|
||||
assert calls == ["message"], f"expected message fallback to fire for /unknown, got {calls}"
|
||||
|
||||
|
||||
def test_chat_api_status_properties():
|
||||
"""`initialized` and `started` reflect lifecycle state without invoking the FFI."""
|
||||
api = ChatApi(ctrl=12345)
|
||||
assert api.initialized is True
|
||||
assert api.started is False
|
||||
assert api.ctrl == 12345
|
||||
# Simulate close: ctrl wiped, both properties false.
|
||||
api._ctrl = None
|
||||
api._started = False
|
||||
assert api.initialized is False
|
||||
assert api.started is False
|
||||
with pytest.raises(RuntimeError, match="not initialized"):
|
||||
_ = api.ctrl
|
||||
|
||||
|
||||
def test_log_contacts_registers_handlers():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
log_contacts=True,
|
||||
log_network=False,
|
||||
)
|
||||
bot._register_log_handlers()
|
||||
assert "contactConnected" in bot._event_handlers
|
||||
assert "contactDeletedByContact" in bot._event_handlers
|
||||
assert "hostConnected" not in bot._event_handlers
|
||||
|
||||
|
||||
def test_log_network_registers_handlers():
|
||||
bot = Bot(
|
||||
profile=BotProfile(display_name="x"),
|
||||
db=SqliteDb(file_prefix="/tmp/test"),
|
||||
log_contacts=False,
|
||||
log_network=True,
|
||||
)
|
||||
bot._register_log_handlers()
|
||||
assert "hostConnected" in bot._event_handlers
|
||||
assert "hostDisconnected" in bot._event_handlers
|
||||
assert "subscriptionStatus" in bot._event_handlers
|
||||
assert "contactConnected" not in bot._event_handlers
|
||||
|
||||
|
||||
def test_middleware_registration_and_invocation_order():
|
||||
"""Middleware registered first wraps middleware registered later (outer first)."""
|
||||
bot = _bot()
|
||||
calls: list[str] = []
|
||||
|
||||
class Outer(Middleware):
|
||||
async def __call__(self, handler, message, data):
|
||||
calls.append("outer-before")
|
||||
await handler(message, data)
|
||||
calls.append("outer-after")
|
||||
|
||||
class Inner(Middleware):
|
||||
async def __call__(self, handler, message, data):
|
||||
calls.append("inner-before")
|
||||
await handler(message, data)
|
||||
calls.append("inner-after")
|
||||
|
||||
bot.use(Outer())
|
||||
bot.use(Inner())
|
||||
assert len(bot._middleware) == 2
|
||||
|
||||
async def handler(msg):
|
||||
calls.append("handler")
|
||||
|
||||
import asyncio
|
||||
|
||||
asyncio.run(bot._invoke_with_middleware(handler, message=object())) # type: ignore[arg-type]
|
||||
assert calls == [
|
||||
"outer-before",
|
||||
"inner-before",
|
||||
"handler",
|
||||
"inner-after",
|
||||
"outer-after",
|
||||
]
|
||||
@@ -0,0 +1,41 @@
|
||||
"""Sanity checks on auto-generated wire types — catches generator regressions."""
|
||||
|
||||
import typing
|
||||
|
||||
from simplex_chat.types import CC, CEvt, CR, T
|
||||
|
||||
|
||||
def test_types_module_imports():
|
||||
"""Every generated module imports cleanly with no SyntaxError."""
|
||||
assert T is not None and CC is not None and CR is not None and CEvt is not None
|
||||
|
||||
|
||||
def test_chat_type_is_literal_enum():
|
||||
"""ChatType should be a Literal of expected member set."""
|
||||
args = typing.get_args(T.ChatType)
|
||||
assert "direct" in args
|
||||
assert "group" in args
|
||||
assert "local" in args
|
||||
|
||||
|
||||
def test_known_command_has_cmd_string():
|
||||
s = CC.APICreateMyAddress_cmd_string({"userId": 1})
|
||||
assert s == "/_address 1"
|
||||
|
||||
|
||||
def test_chat_response_tag_alias_present():
|
||||
"""ChatResponse_Tag union of literals exists."""
|
||||
assert hasattr(CR, "ChatResponse_Tag")
|
||||
|
||||
|
||||
def test_chat_event_tag_alias_present():
|
||||
"""ChatEvent_Tag exists; covers the on_event Literal annotation."""
|
||||
assert hasattr(CEvt, "ChatEvent_Tag")
|
||||
args = typing.get_args(CEvt.ChatEvent_Tag)
|
||||
assert "newChatItems" in args
|
||||
|
||||
|
||||
def test_chat_ref_cmd_string_direct():
|
||||
"""Sanity check the codegen fix for ChatRef-bearing commands."""
|
||||
assert T.ChatRef_cmd_string({"chatType": "direct", "chatId": 7}) == "@7"
|
||||
assert T.ChatRef_cmd_string({"chatType": "group", "chatId": 42}) == "#42"
|
||||
@@ -0,0 +1,83 @@
|
||||
import re
|
||||
|
||||
from simplex_chat.filters import compile_message_filter
|
||||
|
||||
|
||||
def _msg(content_type="text", text=None, chat_type="direct", group_id=None):
|
||||
"""Build a minimal mock Message-like object for filter testing."""
|
||||
|
||||
class M:
|
||||
pass
|
||||
|
||||
m = M()
|
||||
m.content = {"type": content_type, "text": text} if text is not None else {"type": content_type}
|
||||
m.chat_item = {
|
||||
"chatInfo": {
|
||||
"type": chat_type,
|
||||
**({"groupInfo": {"groupId": group_id}} if chat_type == "group" else {}),
|
||||
}
|
||||
}
|
||||
return m
|
||||
|
||||
|
||||
def test_no_filters_matches_all():
|
||||
f = compile_message_filter({})
|
||||
assert f(_msg(content_type="text"))
|
||||
assert f(_msg(content_type="image"))
|
||||
|
||||
|
||||
def test_content_type_singular():
|
||||
f = compile_message_filter({"content_type": "text"})
|
||||
assert f(_msg(content_type="text"))
|
||||
assert not f(_msg(content_type="image"))
|
||||
|
||||
|
||||
def test_content_type_tuple_or():
|
||||
f = compile_message_filter({"content_type": ("text", "image")})
|
||||
assert f(_msg(content_type="text"))
|
||||
assert f(_msg(content_type="image"))
|
||||
assert not f(_msg(content_type="voice"))
|
||||
|
||||
|
||||
def test_text_exact():
|
||||
f = compile_message_filter({"text": "hello"})
|
||||
assert f(_msg(text="hello"))
|
||||
assert not f(_msg(text="world"))
|
||||
|
||||
|
||||
def test_text_regex():
|
||||
f = compile_message_filter({"text": re.compile(r"^\d+$")})
|
||||
assert f(_msg(text="123"))
|
||||
assert not f(_msg(text="abc"))
|
||||
|
||||
|
||||
def test_when_callable():
|
||||
f = compile_message_filter({"when": lambda m: m.content["type"] == "voice"})
|
||||
assert f(_msg(content_type="voice"))
|
||||
assert not f(_msg(content_type="text"))
|
||||
|
||||
|
||||
def test_combined_and():
|
||||
f = compile_message_filter({"content_type": "text", "text": re.compile(r"\d")})
|
||||
assert f(_msg(content_type="text", text="abc123"))
|
||||
assert not f(_msg(content_type="text", text="abc"))
|
||||
assert not f(_msg(content_type="image"))
|
||||
|
||||
|
||||
def test_chat_type_filter():
|
||||
f = compile_message_filter({"chat_type": "group"})
|
||||
assert f(_msg(chat_type="group", group_id=1))
|
||||
assert not f(_msg(chat_type="direct"))
|
||||
|
||||
|
||||
def test_group_id_filter():
|
||||
f = compile_message_filter({"group_id": 42})
|
||||
assert f(_msg(chat_type="group", group_id=42))
|
||||
assert not f(_msg(chat_type="group", group_id=99))
|
||||
assert not f(_msg(chat_type="direct"))
|
||||
|
||||
|
||||
def test_group_id_tuple_or():
|
||||
f = compile_message_filter({"group_id": (1, 2, 3)})
|
||||
assert f(_msg(chat_type="group", group_id=2))
|
||||
assert not f(_msg(chat_type="group", group_id=99))
|
||||
@@ -0,0 +1,92 @@
|
||||
import zipfile
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from simplex_chat._native import _cache_root, _resolve_libs_dir, _download
|
||||
|
||||
|
||||
def test_cache_root_linux(tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
|
||||
monkeypatch.setattr("sys.platform", "linux")
|
||||
assert _cache_root() == tmp_path / "simplex-chat"
|
||||
|
||||
|
||||
def test_cache_root_macos(tmp_path, monkeypatch):
|
||||
monkeypatch.setattr("sys.platform", "darwin")
|
||||
monkeypatch.setattr("pathlib.Path.home", lambda: tmp_path)
|
||||
assert _cache_root() == tmp_path / "Library" / "Caches" / "simplex-chat"
|
||||
|
||||
|
||||
def test_override_via_env(tmp_path, monkeypatch):
|
||||
# _resolve_libs_dir intentionally does not validate the override directory —
|
||||
# it returns it verbatim; the eventual ctypes.CDLL call surfaces any mistake.
|
||||
monkeypatch.setenv("SIMPLEX_LIBS_DIR", str(tmp_path))
|
||||
monkeypatch.setattr("sys.platform", "linux")
|
||||
assert _resolve_libs_dir("sqlite") == tmp_path
|
||||
|
||||
|
||||
def test_resolve_downloads_when_missing(tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
|
||||
monkeypatch.setattr("sys.platform", "linux")
|
||||
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "linux-x86_64")
|
||||
|
||||
called = {}
|
||||
|
||||
def fake_download(target_root: Path, backend: str) -> None:
|
||||
called["target"] = target_root
|
||||
called["backend"] = backend
|
||||
target_root.mkdir(parents=True, exist_ok=True)
|
||||
(target_root / "libsimplex.so").touch()
|
||||
|
||||
monkeypatch.setattr("simplex_chat._native._download", fake_download)
|
||||
libs_dir = _resolve_libs_dir("sqlite")
|
||||
assert libs_dir == tmp_path / "simplex-chat" / "v6.5.1" / "sqlite"
|
||||
assert called["backend"] == "sqlite"
|
||||
assert (libs_dir / "libsimplex.so").exists()
|
||||
|
||||
|
||||
def test_resolve_uses_cache_on_second_call(tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
|
||||
monkeypatch.setattr("sys.platform", "linux")
|
||||
cached = tmp_path / "simplex-chat" / "v6.5.1" / "sqlite"
|
||||
cached.mkdir(parents=True)
|
||||
(cached / "libsimplex.so").touch()
|
||||
# Should NOT call _download — use the cached file.
|
||||
monkeypatch.setattr(
|
||||
"simplex_chat._native._download", lambda *a: pytest.fail("download should not be called")
|
||||
)
|
||||
assert _resolve_libs_dir("sqlite") == cached
|
||||
|
||||
|
||||
def test_postgres_on_macos_rejected(monkeypatch):
|
||||
monkeypatch.setattr("sys.platform", "darwin")
|
||||
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "macos-aarch64")
|
||||
with pytest.raises(RuntimeError, match="postgres.*linux-x86_64"):
|
||||
_resolve_libs_dir("postgres")
|
||||
|
||||
|
||||
def test_atomic_install(tmp_path, monkeypatch):
|
||||
"""Build a fake libs zip, mock _stream_to_file, verify extraction + atomic rename."""
|
||||
# Build zip: libs/libsimplex.so + libs/libHS-stub.so
|
||||
src = tmp_path / "src" / "libs"
|
||||
src.mkdir(parents=True)
|
||||
(src / "libsimplex.so").write_text("fake-so")
|
||||
(src / "libHS-stub.so").write_text("fake-hs")
|
||||
zip_path = tmp_path / "fake-libs.zip"
|
||||
with zipfile.ZipFile(zip_path, "w") as zf:
|
||||
for f in src.iterdir():
|
||||
zf.write(f, f"libs/{f.name}")
|
||||
|
||||
def fake_stream(url, dest, *, timeout=60.0):
|
||||
import shutil
|
||||
|
||||
shutil.copy(zip_path, dest)
|
||||
|
||||
monkeypatch.setattr("simplex_chat._native._stream_to_file", fake_stream)
|
||||
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "linux-x86_64")
|
||||
|
||||
target = tmp_path / "out"
|
||||
_download(target, "sqlite")
|
||||
assert (target / "libsimplex.so").read_text() == "fake-so"
|
||||
assert (target / "libHS-stub.so").read_text() == "fake-hs"
|
||||
@@ -0,0 +1,55 @@
|
||||
from unittest.mock import patch
|
||||
import pytest
|
||||
from simplex_chat._native import _platform_tag, _libs_url, _libname
|
||||
|
||||
|
||||
@patch("sys.platform", "linux")
|
||||
@patch("platform.machine", return_value="x86_64")
|
||||
def test_platform_linux_x64(_):
|
||||
assert _platform_tag() == "linux-x86_64"
|
||||
|
||||
|
||||
@patch("sys.platform", "darwin")
|
||||
@patch("platform.machine", return_value="arm64")
|
||||
def test_platform_macos_arm64(_):
|
||||
assert _platform_tag() == "macos-aarch64"
|
||||
|
||||
|
||||
@patch("sys.platform", "win32")
|
||||
@patch("platform.machine", return_value="AMD64")
|
||||
def test_platform_windows_x64(_):
|
||||
assert _platform_tag() == "windows-x86_64"
|
||||
|
||||
|
||||
@patch("sys.platform", "freebsd")
|
||||
@patch("platform.machine", return_value="x86_64")
|
||||
def test_platform_unsupported(_):
|
||||
with pytest.raises(RuntimeError, match="Unsupported"):
|
||||
_platform_tag()
|
||||
|
||||
|
||||
def test_libname_per_platform():
|
||||
with patch("sys.platform", "linux"):
|
||||
assert _libname() == "libsimplex.so"
|
||||
with patch("sys.platform", "darwin"):
|
||||
assert _libname() == "libsimplex.dylib"
|
||||
with patch("sys.platform", "win32"):
|
||||
assert _libname() == "libsimplex.dll"
|
||||
|
||||
|
||||
@patch("simplex_chat._native._platform_tag", return_value="linux-x86_64")
|
||||
def test_url_sqlite(_):
|
||||
assert (
|
||||
_libs_url("sqlite")
|
||||
== "https://github.com/simplex-chat/simplex-chat-libs/releases/download/"
|
||||
"v6.5.1/simplex-chat-libs-linux-x86_64.zip"
|
||||
)
|
||||
|
||||
|
||||
@patch("simplex_chat._native._platform_tag", return_value="linux-x86_64")
|
||||
def test_url_postgres(_):
|
||||
assert (
|
||||
_libs_url("postgres")
|
||||
== "https://github.com/simplex-chat/simplex-chat-libs/releases/download/"
|
||||
"v6.5.1/simplex-chat-libs-linux-x86_64-postgres.zip"
|
||||
)
|
||||
@@ -0,0 +1,175 @@
|
||||
from simplex_chat import util
|
||||
|
||||
|
||||
def test_chat_info_ref_direct():
|
||||
ci = {"type": "direct", "contact": {"contactId": 7}}
|
||||
assert util.chat_info_ref(ci) == {"chatType": "direct", "chatId": 7}
|
||||
|
||||
|
||||
def test_chat_info_ref_group():
|
||||
ci = {"type": "group", "groupInfo": {"groupId": 42}}
|
||||
assert util.chat_info_ref(ci) == {"chatType": "group", "chatId": 42}
|
||||
|
||||
|
||||
def test_chat_info_ref_group_with_member_support_scope():
|
||||
ci = {
|
||||
"type": "group",
|
||||
"groupInfo": {"groupId": 42},
|
||||
"groupChatScope": {"type": "memberSupport", "groupMember_": {"groupMemberId": 99}},
|
||||
}
|
||||
ref = util.chat_info_ref(ci)
|
||||
assert ref == {
|
||||
"chatType": "group",
|
||||
"chatId": 42,
|
||||
"chatScope": {"type": "memberSupport", "groupMemberId_": 99},
|
||||
}
|
||||
|
||||
|
||||
def test_chat_info_ref_group_with_member_support_scope_no_member():
|
||||
ci = {
|
||||
"type": "group",
|
||||
"groupInfo": {"groupId": 42},
|
||||
"groupChatScope": {"type": "memberSupport"},
|
||||
}
|
||||
ref = util.chat_info_ref(ci)
|
||||
# No groupMember_ → no groupMemberId_ in the wire scope.
|
||||
assert ref == {
|
||||
"chatType": "group",
|
||||
"chatId": 42,
|
||||
"chatScope": {"type": "memberSupport"},
|
||||
}
|
||||
|
||||
|
||||
def test_chat_info_ref_returns_none_for_non_targets():
|
||||
assert util.chat_info_ref({"type": "contactRequest"}) is None
|
||||
assert util.chat_info_ref({"type": "contactConnection"}) is None
|
||||
|
||||
|
||||
def test_chat_info_name_direct():
|
||||
ci = {"type": "direct", "contact": {"profile": {"displayName": "Alice"}}}
|
||||
assert util.chat_info_name(ci) == "@Alice"
|
||||
|
||||
|
||||
def test_chat_info_name_group():
|
||||
ci = {"type": "group", "groupInfo": {"groupProfile": {"displayName": "MyGroup"}}}
|
||||
assert util.chat_info_name(ci) == "#MyGroup"
|
||||
|
||||
|
||||
def test_chat_info_name_group_with_member_support():
|
||||
ci = {
|
||||
"type": "group",
|
||||
"groupInfo": {"groupProfile": {"displayName": "MyGroup"}},
|
||||
"groupChatScope": {
|
||||
"type": "memberSupport",
|
||||
"groupMember_": {"memberProfile": {"displayName": "Carol"}},
|
||||
},
|
||||
}
|
||||
assert util.chat_info_name(ci) == "#MyGroup(support Carol)"
|
||||
|
||||
|
||||
def test_chat_info_name_local():
|
||||
assert util.chat_info_name({"type": "local"}) == "private notes"
|
||||
|
||||
|
||||
def test_chat_info_name_contact_request():
|
||||
ci = {"type": "contactRequest", "contactRequest": {"profile": {"displayName": "Eve"}}}
|
||||
assert util.chat_info_name(ci) == "request from @Eve"
|
||||
|
||||
|
||||
def test_chat_info_name_contact_connection():
|
||||
assert util.chat_info_name({"type": "contactConnection", "contactConnection": {}}) == (
|
||||
"pending connection"
|
||||
)
|
||||
assert (
|
||||
util.chat_info_name({"type": "contactConnection", "contactConnection": {"localAlias": "X"}})
|
||||
== "pending connection (X)"
|
||||
)
|
||||
|
||||
|
||||
def test_sender_name_direct_uses_chat_name():
|
||||
ci = {"type": "direct", "contact": {"profile": {"displayName": "Alice"}}}
|
||||
chat_dir = {"type": "directRcv"}
|
||||
assert util.sender_name(ci, chat_dir) == "@Alice"
|
||||
|
||||
|
||||
def test_sender_name_group_appends_member():
|
||||
ci = {"type": "group", "groupInfo": {"groupProfile": {"displayName": "MyGroup"}}}
|
||||
chat_dir = {"type": "groupRcv", "groupMember": {"memberProfile": {"displayName": "Bob"}}}
|
||||
assert util.sender_name(ci, chat_dir) == "#MyGroup @Bob"
|
||||
|
||||
|
||||
def test_contact_address_str_prefers_short():
|
||||
assert util.contact_address_str({"connFullLink": "full", "connShortLink": "short"}) == "short"
|
||||
|
||||
|
||||
def test_contact_address_str_falls_back_to_full():
|
||||
assert util.contact_address_str({"connFullLink": "full"}) == "full"
|
||||
|
||||
|
||||
def test_from_local_profile_strips_extras_and_undefined():
|
||||
local = {
|
||||
"displayName": "x",
|
||||
"fullName": "X Y",
|
||||
"shortDescr": None,
|
||||
"image": "data:image/png;base64,...",
|
||||
"contactLink": None,
|
||||
"preferences": {},
|
||||
"peerType": "bot",
|
||||
"profileId": 99, # extra LocalProfile field
|
||||
"localAlias": "alias", # extra LocalProfile field
|
||||
}
|
||||
p = util.from_local_profile(local)
|
||||
assert p == {
|
||||
"displayName": "x",
|
||||
"fullName": "X Y",
|
||||
"image": "data:image/png;base64,...",
|
||||
"preferences": {},
|
||||
"peerType": "bot",
|
||||
}
|
||||
|
||||
|
||||
def test_ci_content_text_rcv():
|
||||
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}}
|
||||
assert util.ci_content_text(ci) == "hello"
|
||||
|
||||
|
||||
def test_ci_content_text_snd():
|
||||
ci = {"content": {"type": "sndMsgContent", "msgContent": {"type": "text", "text": "world"}}}
|
||||
assert util.ci_content_text(ci) == "world"
|
||||
|
||||
|
||||
def test_ci_content_text_other():
|
||||
ci = {"content": {"type": "rcvGroupEvent"}}
|
||||
assert util.ci_content_text(ci) is None
|
||||
|
||||
|
||||
def test_ci_bot_command_match():
|
||||
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "/ping"}}}
|
||||
assert util.ci_bot_command(ci) == ("ping", "")
|
||||
|
||||
|
||||
def test_ci_bot_command_with_args():
|
||||
ci = {
|
||||
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "/echo hi "}}
|
||||
}
|
||||
assert util.ci_bot_command(ci) == ("echo", "hi")
|
||||
|
||||
|
||||
def test_ci_bot_command_not_a_command():
|
||||
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}}
|
||||
assert util.ci_bot_command(ci) is None
|
||||
|
||||
|
||||
def test_ci_bot_command_no_text():
|
||||
ci = {"content": {"type": "rcvGroupEvent"}}
|
||||
assert util.ci_bot_command(ci) is None
|
||||
|
||||
|
||||
def test_reaction_text_emoji():
|
||||
r = {"chatReaction": {"reaction": {"type": "emoji", "emoji": "🎉"}}}
|
||||
assert util.reaction_text(r) == "🎉"
|
||||
|
||||
|
||||
def test_reaction_text_tag():
|
||||
r = {"chatReaction": {"reaction": {"type": "unknown", "tag": "thumbs_up"}}}
|
||||
assert util.reaction_text(r) == "thumbs_up"
|
||||
Reference in New Issue
Block a user