new: [opencode-greenpt-usage] add GreenPT credit balance plugin
Show the remaining GreenPT API credit balance in the OpenCode TUI sidebar. The key is resolved from the ``apiKey`` option, the ``GREENPT_API_KEY`` environment variable, or the active OpenCode ``auth.json`` (provider ``greenpt``); the section is hidden when no key is present, so the plugin stays portable across machines and profiles. The balance is read from the ``x-credits-remaining`` header returned by a free ``HEAD /v1/chat/completions`` probe (HTTP 400 before any credit is consumed), which avoids a billable call per refresh. Tests cover the credential resolution, the header parsing and the live API. Distribute via git clone; there is no npm publish.
This commit is contained in:
Stéphan Sainléger
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
node_modules/
|
||||||
|
dist/
|
||||||
|
*.log
|
||||||
|
.DS_Store
|
||||||
30
AGENTS.md
Normal file
30
AGENTS.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
## Project
|
||||||
|
|
||||||
|
`opencode-greenpt-usage` — an OpenCode **TUI** plugin (Solid + OpenTUI) that
|
||||||
|
shows the remaining GreenPT API credit balance in the sidebar. Distributed by
|
||||||
|
`git clone`; there is no npm publish.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install # install dev dependencies
|
||||||
|
npm test # unit tests (vitest)
|
||||||
|
npm run typecheck # tsc --noEmit
|
||||||
|
GREENPT_API_KEY=... npm run test:integration # live API test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- The plugin entry is the `default export { id, tui }` in `src/index.tsx`.
|
||||||
|
Types come from `@opencode-ai/plugin/tui` as **type-only** imports; the
|
||||||
|
host provides `solid-js` and `@opentui/solid` at runtime.
|
||||||
|
- The section is registered on the `sidebar_content` slot and is hidden when
|
||||||
|
no GreenPT credential is present (`showWhenUnavailable` opts into a hint).
|
||||||
|
- Balance probing must stay **free**: `HEAD /v1/chat/completions` returns
|
||||||
|
`400` plus `x-credits-remaining`. Never replace it with a billable call.
|
||||||
|
- Credential resolution order: `apiKey` option, `GREENPT_API_KEY`, active
|
||||||
|
OpenCode `auth.json` (`greenpt`, `type: "api"`). No profile-switching
|
||||||
|
command may leak into this logic.
|
||||||
|
- No code comments unless functionally required.
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -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/>.
|
||||||
102
README.md
Normal file
102
README.md
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
# opencode-greenpt-usage
|
||||||
|
|
||||||
|
An [OpenCode](https://opencode.ai) TUI plugin that shows the remaining
|
||||||
|
**GreenPT API credit balance** in the sidebar.
|
||||||
|
|
||||||
|
```
|
||||||
|
▼ GreenPT
|
||||||
|
Balance 5.31 € updated 21:35
|
||||||
|
```
|
||||||
|
|
||||||
|
## How it works
|
||||||
|
|
||||||
|
- The API key is resolved in this order:
|
||||||
|
1. the plugin `apiKey` option;
|
||||||
|
2. the `GREENPT_API_KEY` environment variable;
|
||||||
|
3. the **active** OpenCode auth store (`auth.json`, provider `greenpt`,
|
||||||
|
entry `type: "api"`) — i.e. exactly what a plain `opencode auth login`
|
||||||
|
produces.
|
||||||
|
- The balance is read with a **free** `HEAD /v1/chat/completions` probe:
|
||||||
|
the API answers `400 Bad Request` before any billing, yet the response
|
||||||
|
still carries the `x-credits-remaining` header. No credit is consumed
|
||||||
|
and no generation is triggered.
|
||||||
|
- The section is **hidden while no GreenPT key is present**.
|
||||||
|
- Refresh happens on startup, at the end of a session, on server
|
||||||
|
reconnection, on a timer (300 s by default) and on demand through the
|
||||||
|
`greenpt.refresh` command.
|
||||||
|
|
||||||
|
There is no dependency on any local profile or command: the plugin only
|
||||||
|
looks for a key.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- OpenCode `>= 1.18.0` (TUI plugin system).
|
||||||
|
- A GreenPT account and API key.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. **Clone this repository** wherever you keep your projects.
|
||||||
|
|
||||||
|
2. **Connect GreenPT to OpenCode**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode auth login
|
||||||
|
```
|
||||||
|
|
||||||
|
Pick **GreenPT** from the list, then paste the API key.
|
||||||
|
|
||||||
|
(Alternative: export `GREENPT_API_KEY` in your environment.)
|
||||||
|
|
||||||
|
3. **Register the plugin** in `~/.config/opencode/tui.json`, setting the
|
||||||
|
**absolute path to your clone**:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"$schema": "https://opencode.ai/tui.json",
|
||||||
|
"plugin": [
|
||||||
|
["file:///ABSOLUTE/PATH/TO/opencode-greenpt-usage/src/index.tsx", { "order": 700 }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> Use a `file://` URL pointing at the source file `src/index.tsx`
|
||||||
|
> (OpenCode compiles the TSX itself). Do not point at a bundle: that
|
||||||
|
> would embed a second copy of `solid-js` and the section would stay
|
||||||
|
> blank.
|
||||||
|
|
||||||
|
4. **Fully quit OpenCode and relaunch it** (plugins are not hot-reloaded).
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
All options are optional and go in the plugin entry of `tui.json`:
|
||||||
|
|
||||||
|
| Option | Type | Default | Description |
|
||||||
|
| --------------------- | ------- | --------------------------- | ------------------------------------------------------- |
|
||||||
|
| `apiKey` | string | resolved automatically | Explicit GreenPT key. |
|
||||||
|
| `baseUrl` | string | `https://api.greenpt.ai/v1` | GreenPT API base URL. |
|
||||||
|
| `refreshInterval` | number | `300` | Refresh interval in seconds (`0` disables the timer). |
|
||||||
|
| `order` | number | `700` | Sidebar section position. |
|
||||||
|
| `showWhenUnavailable` | boolean | `false` | Show a hint when no GreenPT key exists. |
|
||||||
|
| `unit` | string | `€` | Unit appended after the amount. |
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- **The section does not appear**: make sure `opencode auth login` stored a
|
||||||
|
`greenpt` key (or that `GREENPT_API_KEY` is set), and that the `file://`
|
||||||
|
URL in `tui.json` points at the right path.
|
||||||
|
- **"invalid GreenPT key"**: the API key was rejected (HTTP 401).
|
||||||
|
- **"balance unavailable"**: GreenPT did not return the balance header; try
|
||||||
|
again later.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm test # unit tests
|
||||||
|
npm run typecheck # type check
|
||||||
|
GREENPT_API_KEY=... npm run test:integration # test against the live API
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AGPL-3.0-or-later. See [LICENSE](LICENSE).
|
||||||
3497
package-lock.json
generated
Normal file
3497
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
36
package.json
Normal file
36
package.json
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
{
|
||||||
|
"name": "opencode-greenpt-usage",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "OpenCode TUI plugin that shows the remaining GreenPT API credit balance in the sidebar.",
|
||||||
|
"type": "module",
|
||||||
|
"license": "AGPL-3.0-or-later",
|
||||||
|
"keywords": [
|
||||||
|
"opencode",
|
||||||
|
"opencode-plugin",
|
||||||
|
"tui",
|
||||||
|
"greenpt",
|
||||||
|
"credits",
|
||||||
|
"balance"
|
||||||
|
],
|
||||||
|
"engines": {
|
||||||
|
"opencode": ">=1.18.0"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"test": "vitest run",
|
||||||
|
"test:integration": "GREENPT_INTEGRATION=1 vitest run test/integration.greenpt.test.ts",
|
||||||
|
"typecheck": "tsc --noEmit"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@opencode-ai/plugin": "*",
|
||||||
|
"@opentui/solid": "*",
|
||||||
|
"solid-js": "*"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@opencode-ai/plugin": "^1.18.33",
|
||||||
|
"@opentui/solid": "^0.5.12",
|
||||||
|
"@types/node": "^24.0.0",
|
||||||
|
"solid-js": "^1.9.0",
|
||||||
|
"typescript": "^5.6.0",
|
||||||
|
"vitest": "^3.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
162
src/balance.ts
Normal file
162
src/balance.ts
Normal file
@@ -0,0 +1,162 @@
|
|||||||
|
import { request as httpRequest } from "node:http"
|
||||||
|
import { request as httpsRequest } from "node:https"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Response header carrying the remaining credit balance.
|
||||||
|
*
|
||||||
|
* The public documentation mentions `x-credit-balance`, but the live API
|
||||||
|
* actually returns `x-credits-remaining`; both are accepted, the live one
|
||||||
|
* taking precedence.
|
||||||
|
*/
|
||||||
|
export const CREDIT_HEADERS = ["x-credits-remaining", "x-credit-balance"] as const
|
||||||
|
|
||||||
|
export type Balance = {
|
||||||
|
credits: number
|
||||||
|
raw: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type BalanceError =
|
||||||
|
| { kind: "unauthorized" }
|
||||||
|
| { kind: "missing-header"; status: number }
|
||||||
|
| { kind: "network"; cause?: unknown }
|
||||||
|
|
||||||
|
export type BalanceResult = Balance | BalanceError
|
||||||
|
|
||||||
|
export type FetchLike = (input: string, init?: RequestInit) => Promise<Response>
|
||||||
|
|
||||||
|
function headerMap(headers: HeadersInit | undefined): Record<string, string> {
|
||||||
|
const out: Record<string, string> = {}
|
||||||
|
if (!headers) return out
|
||||||
|
new Headers(headers).forEach((value, key) => {
|
||||||
|
out[key] = value
|
||||||
|
})
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Direct Node HTTP(S) request, bypassing OpenCode's local-server fetch
|
||||||
|
* wrapper (which would otherwise intercept the call).
|
||||||
|
*
|
||||||
|
* @param input Absolute URL to request.
|
||||||
|
* @param init Optional method, headers and abort signal.
|
||||||
|
* @returns A standard `Response`, with the body buffered in memory.
|
||||||
|
*/
|
||||||
|
export function nativeFetch(input: string, init?: RequestInit): Promise<Response> {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const url = new URL(input)
|
||||||
|
const lib = url.protocol === "http:" ? httpRequest : httpsRequest
|
||||||
|
const req = lib(
|
||||||
|
{
|
||||||
|
hostname: url.hostname,
|
||||||
|
port: url.port || undefined,
|
||||||
|
path: `${url.pathname}${url.search}`,
|
||||||
|
method: init?.method ?? "GET",
|
||||||
|
headers: headerMap(init?.headers),
|
||||||
|
},
|
||||||
|
(res) => {
|
||||||
|
const chunks: Uint8Array[] = []
|
||||||
|
res.on("data", (chunk) => {
|
||||||
|
chunks.push(chunk instanceof Uint8Array ? chunk : Uint8Array.from(chunk))
|
||||||
|
})
|
||||||
|
res.on("end", () => {
|
||||||
|
const headers = new Headers()
|
||||||
|
for (const [key, value] of Object.entries(res.headers)) {
|
||||||
|
if (typeof value === "string") headers.set(key, value)
|
||||||
|
else if (Array.isArray(value)) headers.set(key, value.join(", "))
|
||||||
|
}
|
||||||
|
const body = new Uint8Array(chunks.reduce((sum, c) => sum + c.byteLength, 0))
|
||||||
|
let offset = 0
|
||||||
|
for (const chunk of chunks) {
|
||||||
|
body.set(chunk, offset)
|
||||||
|
offset += chunk.byteLength
|
||||||
|
}
|
||||||
|
resolve(new Response(body, { status: res.statusCode ?? 0, headers }))
|
||||||
|
})
|
||||||
|
},
|
||||||
|
)
|
||||||
|
const abort = () => {
|
||||||
|
req.destroy()
|
||||||
|
reject(Object.assign(new Error("Aborted"), { name: "AbortError" }))
|
||||||
|
}
|
||||||
|
if (init?.signal?.aborted) {
|
||||||
|
abort()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
init?.signal?.addEventListener("abort", abort, { once: true })
|
||||||
|
req.on("error", reject)
|
||||||
|
req.end()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract the credit balance from response headers.
|
||||||
|
*
|
||||||
|
* @param headers Response headers to inspect.
|
||||||
|
* @returns The parsed balance, or `null` when no known header is present or
|
||||||
|
* its value is not a finite number (the latter is treated as
|
||||||
|
* absent to keep the display resilient).
|
||||||
|
*/
|
||||||
|
export function parseCreditHeader(headers: HeadersInit | undefined): Balance | null {
|
||||||
|
if (!headers) return null
|
||||||
|
const map = new Headers(headers)
|
||||||
|
for (const name of CREDIT_HEADERS) {
|
||||||
|
const raw = map.get(name)
|
||||||
|
if (raw === null) continue
|
||||||
|
const trimmed = raw.trim()
|
||||||
|
const credits = Number.parseFloat(trimmed)
|
||||||
|
if (!Number.isFinite(credits)) return null
|
||||||
|
return { credits, raw: trimmed }
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch the remaining GreenPT credit balance.
|
||||||
|
*
|
||||||
|
* The balance is only exposed on the (billable) chat-completions route. A
|
||||||
|
* `HEAD` request without a body is rejected by the API with `400 Bad
|
||||||
|
* Request` **before** any credit is consumed, yet the response still
|
||||||
|
* carries the credit header. This makes the probe free and side-effect
|
||||||
|
* free.
|
||||||
|
*
|
||||||
|
* A `GET` fallback is attempted if `HEAD` yields no header, and any
|
||||||
|
* `401`/`403` is reported as an authentication failure.
|
||||||
|
*
|
||||||
|
* @param baseUrl GreenPT API base URL (e.g. `https://api.greenpt.ai/v1`).
|
||||||
|
* @param apiKey Bearer API key.
|
||||||
|
* @param signal Optional abort signal.
|
||||||
|
* @param fetchImpl Injectable fetch implementation (tests / native fallback).
|
||||||
|
* @returns The balance on success, or a typed `BalanceError`.
|
||||||
|
*/
|
||||||
|
export async function fetchBalance(
|
||||||
|
baseUrl: string,
|
||||||
|
apiKey: string,
|
||||||
|
signal?: AbortSignal,
|
||||||
|
fetchImpl: FetchLike = nativeFetch,
|
||||||
|
): Promise<BalanceResult> {
|
||||||
|
const endpoint = `${baseUrl.replace(/\/+$/, "")}/chat/completions`
|
||||||
|
const headers: Record<string, string> = {
|
||||||
|
Authorization: `Bearer ${apiKey}`,
|
||||||
|
Accept: "application/json",
|
||||||
|
"User-Agent": "opencode-greenpt-usage",
|
||||||
|
}
|
||||||
|
|
||||||
|
let lastStatus = 0
|
||||||
|
for (const method of ["HEAD", "GET"] as const) {
|
||||||
|
let response: Response
|
||||||
|
try {
|
||||||
|
response = await fetchImpl(endpoint, { method, headers, signal })
|
||||||
|
} catch (cause) {
|
||||||
|
if (signal?.aborted) throw cause
|
||||||
|
return { kind: "network", cause }
|
||||||
|
}
|
||||||
|
|
||||||
|
if (response.status === 401 || response.status === 403) return { kind: "unauthorized" }
|
||||||
|
|
||||||
|
const parsed = parseCreditHeader(response.headers)
|
||||||
|
if (parsed) return parsed
|
||||||
|
lastStatus = response.status
|
||||||
|
}
|
||||||
|
|
||||||
|
return { kind: "missing-header", status: lastStatus }
|
||||||
|
}
|
||||||
116
src/credential.ts
Normal file
116
src/credential.ts
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
import { existsSync, readFileSync } from "node:fs"
|
||||||
|
import { homedir } from "node:os"
|
||||||
|
import { join } from "node:path"
|
||||||
|
|
||||||
|
/** Provider id OpenCode uses for GreenPT in its auth store. */
|
||||||
|
export const GREENPT_PROVIDER_ID = "greenpt"
|
||||||
|
|
||||||
|
/** Environment variable documented by GreenPT / models.dev for the API key. */
|
||||||
|
export const GREENPT_API_KEY_ENV = "GREENPT_API_KEY"
|
||||||
|
|
||||||
|
export type CredentialOptions = {
|
||||||
|
apiKey?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CredentialEnv = NodeJS.Dict<string>
|
||||||
|
|
||||||
|
export type CredentialResult =
|
||||||
|
| { ok: true; key: string }
|
||||||
|
| { ok: false; reason: "missing" }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolve the GreenPT API key.
|
||||||
|
*
|
||||||
|
* Resolution order (first match wins):
|
||||||
|
* 1. the explicit `apiKey` plugin option;
|
||||||
|
* 2. the `GREENPT_API_KEY` environment variable;
|
||||||
|
* 3. the active OpenCode auth store (`auth.json`, provider `greenpt`,
|
||||||
|
* entry `type: "api"`).
|
||||||
|
*
|
||||||
|
* No dependency on any local profile-switching command: the store that is
|
||||||
|
* active at runtime is the one read, which is what a plain `opencode auth
|
||||||
|
* login` produces.
|
||||||
|
*
|
||||||
|
* @param options Plugin options, possibly carrying an explicit key.
|
||||||
|
* @param stateDir OpenCode state directory (from `api.state.path.state`).
|
||||||
|
* @param env Environment mapping, injectable for tests.
|
||||||
|
* @returns `{ ok: true, key }` when a key is found, otherwise
|
||||||
|
* `{ ok: false, reason: "missing" }`.
|
||||||
|
*/
|
||||||
|
export function resolveGreenptKey(
|
||||||
|
options: CredentialOptions,
|
||||||
|
stateDir: string | undefined,
|
||||||
|
env: CredentialEnv = process.env as CredentialEnv,
|
||||||
|
): CredentialResult {
|
||||||
|
const fromOption = options.apiKey?.trim()
|
||||||
|
if (fromOption) return { ok: true, key: fromOption }
|
||||||
|
|
||||||
|
const fromEnv = env[GREENPT_API_KEY_ENV]?.trim()
|
||||||
|
if (fromEnv) return { ok: true, key: fromEnv }
|
||||||
|
|
||||||
|
for (const dir of credentialSearchDirs(stateDir, env)) {
|
||||||
|
const fromAuthFile = readAuthJsonKey(dir)
|
||||||
|
if (fromAuthFile) return { ok: true, key: fromAuthFile }
|
||||||
|
}
|
||||||
|
|
||||||
|
return { ok: false, reason: "missing" }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Compute the candidate directories that may hold an OpenCode `auth.json`,
|
||||||
|
* in priority order and without duplicates.
|
||||||
|
*
|
||||||
|
* @param stateDir Directory reported by the TUI plugin API, if available.
|
||||||
|
* @param env Environment mapping used to honour `OPENCODE_DATA_DIR` and
|
||||||
|
* `XDG_DATA_HOME` / `$HOME`.
|
||||||
|
* @returns An ordered, de-duplicated list of directories.
|
||||||
|
*/
|
||||||
|
export function credentialSearchDirs(
|
||||||
|
stateDir: string | undefined,
|
||||||
|
env: CredentialEnv = process.env as CredentialEnv,
|
||||||
|
): string[] {
|
||||||
|
const dirs: string[] = []
|
||||||
|
|
||||||
|
const extra = stateDir?.trim()
|
||||||
|
if (extra) dirs.push(extra)
|
||||||
|
|
||||||
|
const explicit = env.OPENCODE_DATA_DIR?.trim()
|
||||||
|
if (explicit) dirs.push(explicit)
|
||||||
|
|
||||||
|
const xdg = env.XDG_DATA_HOME?.trim()
|
||||||
|
if (xdg) {
|
||||||
|
dirs.push(join(xdg, "opencode"))
|
||||||
|
} else {
|
||||||
|
const home = env.HOME?.trim() || (env === process.env ? homedir() : undefined)
|
||||||
|
if (home) dirs.push(join(home, ".local", "share", "opencode"))
|
||||||
|
}
|
||||||
|
|
||||||
|
return [...new Set(dirs)]
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read the GreenPT API key from an OpenCode `auth.json` file.
|
||||||
|
*
|
||||||
|
* Only `type: "api"` entries with a non-empty `key` field are accepted;
|
||||||
|
* OAuth entries are ignored because the GreenPT API is API-key based.
|
||||||
|
*
|
||||||
|
* @param stateDir Directory containing `auth.json`.
|
||||||
|
* @returns The key, or `undefined` when absent or unreadable.
|
||||||
|
*/
|
||||||
|
function readAuthJsonKey(stateDir: string): string | undefined {
|
||||||
|
const authPath = join(stateDir, "auth.json")
|
||||||
|
if (!existsSync(authPath)) return undefined
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(readFileSync(authPath, "utf8")) as Record<
|
||||||
|
string,
|
||||||
|
{ type?: string; key?: string } | undefined
|
||||||
|
>
|
||||||
|
const entry = parsed[GREENPT_PROVIDER_ID]
|
||||||
|
if (entry && entry.type === "api" && typeof entry.key === "string" && entry.key) {
|
||||||
|
return entry.key
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// Unreadable or malformed auth store: treat as no credential.
|
||||||
|
}
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
60
src/format.ts
Normal file
60
src/format.ts
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
import type { BalanceError } from "./balance"
|
||||||
|
|
||||||
|
/** Key used to persist the section fold state in the shared KV store. */
|
||||||
|
export const BALANCE_OPEN_KV = "greenpt.usage.open"
|
||||||
|
|
||||||
|
/** Default unit appended to the balance (GreenPT credits are euro-denominated). */
|
||||||
|
export const DEFAULT_UNIT = "€"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Format a credit amount for display with two decimals.
|
||||||
|
*
|
||||||
|
* @param credits Numeric balance.
|
||||||
|
* @returns The formatted amount (without unit), or `"-"` when not finite.
|
||||||
|
*/
|
||||||
|
export function formatCredits(credits: number): string {
|
||||||
|
if (!Number.isFinite(credits)) return "-"
|
||||||
|
return credits.toFixed(2)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Human-readable message for a balance error.
|
||||||
|
*
|
||||||
|
* @param error Typed error returned by the balance client.
|
||||||
|
* @returns A short, single-line description.
|
||||||
|
*/
|
||||||
|
export function formatBalanceError(
|
||||||
|
error: BalanceError | { kind: "no-credential"; reason: "missing" },
|
||||||
|
): string {
|
||||||
|
switch (error.kind) {
|
||||||
|
case "unauthorized":
|
||||||
|
return "invalid GreenPT key"
|
||||||
|
case "missing-header":
|
||||||
|
return `balance unavailable (http ${error.status})`
|
||||||
|
case "network":
|
||||||
|
return "network error"
|
||||||
|
case "no-credential":
|
||||||
|
return "no GreenPT key (/connect)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read the persisted fold state, tolerating a missing or broken KV store.
|
||||||
|
*
|
||||||
|
* @param kv KV store exposing `get`, if available.
|
||||||
|
* @param fallback Value returned when the state is absent or invalid.
|
||||||
|
* @returns Whether the section should start expanded.
|
||||||
|
*/
|
||||||
|
export function readFoldOpen(
|
||||||
|
kv: { get: (key: string, fallback?: boolean) => unknown } | undefined,
|
||||||
|
fallback = true,
|
||||||
|
): boolean {
|
||||||
|
if (!kv) return fallback
|
||||||
|
try {
|
||||||
|
const value = kv.get(BALANCE_OPEN_KV, fallback)
|
||||||
|
if (typeof value !== "boolean") return fallback
|
||||||
|
return value
|
||||||
|
} catch {
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
|
}
|
||||||
51
src/index.tsx
Normal file
51
src/index.tsx
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
/** @jsxImportSource @opentui/solid */
|
||||||
|
import type { TuiPlugin, TuiPluginModule } from "@opencode-ai/plugin/tui"
|
||||||
|
import { createBalanceStore, type BalanceOptions } from "./store"
|
||||||
|
import { GreenptWidget } from "./widget"
|
||||||
|
|
||||||
|
/** Sidebar slot order; the OpenCode Go widget uses 600. */
|
||||||
|
const DEFAULT_ORDER = 700
|
||||||
|
|
||||||
|
const tui: TuiPlugin = async (api, options) => {
|
||||||
|
const opts = (options ?? {}) as BalanceOptions
|
||||||
|
const store = createBalanceStore(api, opts)
|
||||||
|
|
||||||
|
api.slots.register({
|
||||||
|
order:
|
||||||
|
typeof opts.order === "number" && Number.isFinite(opts.order) ? opts.order : DEFAULT_ORDER,
|
||||||
|
slots: {
|
||||||
|
sidebar_content() {
|
||||||
|
return (
|
||||||
|
<GreenptWidget
|
||||||
|
api={api}
|
||||||
|
store={store}
|
||||||
|
showWhenUnavailable={opts.showWhenUnavailable === true}
|
||||||
|
unit={opts.unit}
|
||||||
|
/>
|
||||||
|
)
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
api.command?.register(() => [
|
||||||
|
{
|
||||||
|
value: "greenpt.refresh",
|
||||||
|
title: "Refresh GreenPT balance",
|
||||||
|
category: "Plugin",
|
||||||
|
onSelect() {
|
||||||
|
void store.refresh()
|
||||||
|
},
|
||||||
|
},
|
||||||
|
])
|
||||||
|
|
||||||
|
api.lifecycle.onDispose(() => store.dispose())
|
||||||
|
|
||||||
|
void store.refresh()
|
||||||
|
}
|
||||||
|
|
||||||
|
const plugin: TuiPluginModule & { id: string } = {
|
||||||
|
id: "greenpt.usage",
|
||||||
|
tui,
|
||||||
|
}
|
||||||
|
|
||||||
|
export default plugin
|
||||||
147
src/store.ts
Normal file
147
src/store.ts
Normal file
@@ -0,0 +1,147 @@
|
|||||||
|
import { createSignal } from "solid-js"
|
||||||
|
import type { TuiPluginApi } from "@opencode-ai/plugin/tui"
|
||||||
|
import { fetchBalance, nativeFetch, type Balance, type BalanceError, type FetchLike } from "./balance"
|
||||||
|
import { resolveGreenptKey, type CredentialEnv } from "./credential"
|
||||||
|
|
||||||
|
/** Default GreenPT API base URL. */
|
||||||
|
export const DEFAULT_BASE_URL = "https://api.greenpt.ai/v1"
|
||||||
|
|
||||||
|
/** Default refresh interval, in seconds. The probe is free but should stay gentle. */
|
||||||
|
export const DEFAULT_REFRESH_SECONDS = 300
|
||||||
|
|
||||||
|
export type BalanceOptions = {
|
||||||
|
apiKey?: string
|
||||||
|
baseUrl?: string
|
||||||
|
refreshInterval?: number
|
||||||
|
order?: number
|
||||||
|
showWhenUnavailable?: boolean
|
||||||
|
unit?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type BalanceState =
|
||||||
|
| { status: "loading" }
|
||||||
|
| { status: "ready"; data: Balance; fetchedAt: number }
|
||||||
|
| {
|
||||||
|
status: "error"
|
||||||
|
error: BalanceError | { kind: "no-credential"; reason: "missing" }
|
||||||
|
}
|
||||||
|
|
||||||
|
export type BalanceStore = {
|
||||||
|
state: () => BalanceState
|
||||||
|
now: () => number
|
||||||
|
refresh: () => Promise<void>
|
||||||
|
dispose: () => void
|
||||||
|
}
|
||||||
|
|
||||||
|
const BACKOFF_BASE_MS = 60_000
|
||||||
|
const BACKOFF_MAX_MS = 10 * 60_000
|
||||||
|
const STATE_RETRY_MS = 5_000
|
||||||
|
const TICK_MS = 30_000
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create the reactive store backing the sidebar widget.
|
||||||
|
*
|
||||||
|
* Refreshes on creation, on `session.idle`, on `server.connected`, on a
|
||||||
|
* timer, and on demand via `refresh()`. Errors are retried with an
|
||||||
|
* exponential backoff so a transient outage does not hammer the API.
|
||||||
|
*
|
||||||
|
* @param api TUI plugin API (used for the auth store path and events).
|
||||||
|
* @param options Plugin options.
|
||||||
|
* @param env Environment mapping, injectable for tests.
|
||||||
|
* @param fetchImpl Fetch implementation, injectable for tests.
|
||||||
|
* @returns The store.
|
||||||
|
*/
|
||||||
|
export function createBalanceStore(
|
||||||
|
api: TuiPluginApi,
|
||||||
|
options: BalanceOptions = {},
|
||||||
|
env: CredentialEnv = process.env as CredentialEnv,
|
||||||
|
fetchImpl: FetchLike = nativeFetch,
|
||||||
|
): BalanceStore {
|
||||||
|
const [state, setState] = createSignal<BalanceState>({ status: "loading" })
|
||||||
|
const [now, setNow] = createSignal(Date.now())
|
||||||
|
|
||||||
|
const baseUrl = options.baseUrl ?? DEFAULT_BASE_URL
|
||||||
|
const interval = options.refreshInterval ?? DEFAULT_REFRESH_SECONDS
|
||||||
|
|
||||||
|
let refreshTimer: ReturnType<typeof setTimeout> | undefined
|
||||||
|
let tickTimer: ReturnType<typeof setTimeout> | undefined
|
||||||
|
let stateRetryTimer: ReturnType<typeof setTimeout> | undefined
|
||||||
|
let backoff = BACKOFF_BASE_MS
|
||||||
|
let inFlight = false
|
||||||
|
let disposed = false
|
||||||
|
let retriedState = false
|
||||||
|
const controller = new AbortController()
|
||||||
|
|
||||||
|
const unsubscribeIdle = api.event.on("session.idle", () => void refresh())
|
||||||
|
const unsubscribeConnected = api.event.on("server.connected", () => void refresh())
|
||||||
|
|
||||||
|
function scheduleNext() {
|
||||||
|
if (disposed) return
|
||||||
|
if (refreshTimer) clearTimeout(refreshTimer)
|
||||||
|
refreshTimer = undefined
|
||||||
|
const intervalMs = interval * 1000
|
||||||
|
if (intervalMs <= 0) return
|
||||||
|
const delay = state().status === "error" ? backoff : intervalMs
|
||||||
|
refreshTimer = setTimeout(() => {
|
||||||
|
refreshTimer = undefined
|
||||||
|
void refresh()
|
||||||
|
}, delay)
|
||||||
|
}
|
||||||
|
|
||||||
|
function tick() {
|
||||||
|
if (disposed) return
|
||||||
|
setNow(Date.now())
|
||||||
|
tickTimer = setTimeout(tick, TICK_MS)
|
||||||
|
}
|
||||||
|
|
||||||
|
async function refresh(): Promise<void> {
|
||||||
|
if (disposed || inFlight) return
|
||||||
|
inFlight = true
|
||||||
|
try {
|
||||||
|
const credential = resolveGreenptKey(options, api.state.path.state, env)
|
||||||
|
if (!credential.ok) {
|
||||||
|
setState({ status: "error", error: { kind: "no-credential", reason: credential.reason } })
|
||||||
|
if (api.state.path.state === undefined && !retriedState) {
|
||||||
|
retriedState = true
|
||||||
|
stateRetryTimer = setTimeout(() => void refresh(), STATE_RETRY_MS)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
let result
|
||||||
|
try {
|
||||||
|
result = await fetchBalance(baseUrl, credential.key, controller.signal, fetchImpl)
|
||||||
|
} catch {
|
||||||
|
if (disposed) return
|
||||||
|
result = { kind: "network", cause: undefined } as BalanceError
|
||||||
|
}
|
||||||
|
if (disposed) return
|
||||||
|
|
||||||
|
if ("credits" in result) {
|
||||||
|
backoff = BACKOFF_BASE_MS
|
||||||
|
setState({ status: "ready", data: result, fetchedAt: Date.now() })
|
||||||
|
} else {
|
||||||
|
backoff = Math.min(backoff * 2, BACKOFF_MAX_MS)
|
||||||
|
setState({ status: "error", error: result })
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
inFlight = false
|
||||||
|
}
|
||||||
|
if (disposed) return
|
||||||
|
scheduleNext()
|
||||||
|
}
|
||||||
|
|
||||||
|
tickTimer = setTimeout(tick, TICK_MS)
|
||||||
|
|
||||||
|
function dispose() {
|
||||||
|
disposed = true
|
||||||
|
controller.abort()
|
||||||
|
if (refreshTimer) clearTimeout(refreshTimer)
|
||||||
|
if (tickTimer) clearTimeout(tickTimer)
|
||||||
|
if (stateRetryTimer) clearTimeout(stateRetryTimer)
|
||||||
|
unsubscribeIdle()
|
||||||
|
unsubscribeConnected()
|
||||||
|
}
|
||||||
|
|
||||||
|
return { state, now, refresh, dispose }
|
||||||
|
}
|
||||||
111
src/widget.tsx
Normal file
111
src/widget.tsx
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
/** @jsxImportSource @opentui/solid */
|
||||||
|
import { createSignal, Match, Show, Switch } from "solid-js"
|
||||||
|
import type { TuiPluginApi, TuiThemeCurrent } from "@opencode-ai/plugin/tui"
|
||||||
|
import { formatBalanceError, formatCredits, readFoldOpen, BALANCE_OPEN_KV, DEFAULT_UNIT } from "./format"
|
||||||
|
import type { BalanceStore } from "./store"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sidebar section showing the remaining GreenPT credit balance.
|
||||||
|
*
|
||||||
|
* The section is hidden entirely when no GreenPT credential is available
|
||||||
|
* and `showWhenUnavailable` is false, so a colleague who does not use
|
||||||
|
* GreenPT never sees an empty or misleading block.
|
||||||
|
*/
|
||||||
|
export function GreenptWidget(props: {
|
||||||
|
api: TuiPluginApi
|
||||||
|
store: BalanceStore
|
||||||
|
showWhenUnavailable: boolean
|
||||||
|
unit?: string
|
||||||
|
}) {
|
||||||
|
const theme = () => props.api.theme.current
|
||||||
|
const state = () => props.store.state()
|
||||||
|
const status = () => state().status
|
||||||
|
const [open, setOpen] = createSignal(readFoldOpen(props.api.kv))
|
||||||
|
|
||||||
|
const toggle = () => {
|
||||||
|
const next = !open()
|
||||||
|
setOpen(next)
|
||||||
|
try {
|
||||||
|
props.api.kv.set(BALANCE_OPEN_KV, next)
|
||||||
|
} catch {
|
||||||
|
// KV persistence is optional; the local toggle still applies.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const error = () => {
|
||||||
|
const s = state()
|
||||||
|
return s.status === "error" ? s.error : undefined
|
||||||
|
}
|
||||||
|
const credentialReason = () => {
|
||||||
|
const e = error()
|
||||||
|
return e?.kind === "no-credential" ? e.reason : undefined
|
||||||
|
}
|
||||||
|
const hidden = () => credentialReason() !== undefined && !props.showWhenUnavailable
|
||||||
|
|
||||||
|
const unit = () => props.unit ?? DEFAULT_UNIT
|
||||||
|
const balanceText = () => {
|
||||||
|
const s = state()
|
||||||
|
if (s.status !== "ready") return undefined
|
||||||
|
return `${formatCredits(s.data.credits)} ${unit()}`
|
||||||
|
}
|
||||||
|
const balanceColor = () => {
|
||||||
|
const s = state()
|
||||||
|
return s.status === "ready" && s.data.credits > 0 ? "success" : "error"
|
||||||
|
}
|
||||||
|
const updatedAt = () => {
|
||||||
|
const s = state()
|
||||||
|
if (s.status !== "ready") return ""
|
||||||
|
const d = new Date(s.fetchedAt)
|
||||||
|
const hh = String(d.getHours()).padStart(2, "0")
|
||||||
|
const mm = String(d.getMinutes()).padStart(2, "0")
|
||||||
|
return `updated ${hh}:${mm}`
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Show when={!hidden()} fallback={<box />}>
|
||||||
|
<box flexDirection="column" gap={1}>
|
||||||
|
<text fg={theme().text} onMouseUp={toggle}>
|
||||||
|
<span style={{ fg: theme().textMuted }}>{open() ? "▼ " : "▶ "}</span>
|
||||||
|
<b>GreenPT</b>
|
||||||
|
<Show when={!open() && balanceText()}>
|
||||||
|
{(text) => <span style={{ fg: theme()[balanceColor()] }}> {text()}</span>}
|
||||||
|
</Show>
|
||||||
|
</text>
|
||||||
|
<Show when={open()}>
|
||||||
|
<Switch>
|
||||||
|
<Match when={status() === "ready"}>
|
||||||
|
<box flexDirection="row" gap={1} justifyContent="space-between">
|
||||||
|
<text fg={theme().textMuted}>Balance</text>
|
||||||
|
<box flexDirection="row" gap={1}>
|
||||||
|
<text fg={theme()[balanceColor()]}>{balanceText()}</text>
|
||||||
|
<text fg={theme().textMuted}>{updatedAt()}</text>
|
||||||
|
</box>
|
||||||
|
</box>
|
||||||
|
</Match>
|
||||||
|
<Match when={status() === "loading"}>
|
||||||
|
<text fg={theme().textMuted}>loading…</text>
|
||||||
|
</Match>
|
||||||
|
<Match when={credentialReason() !== undefined && props.showWhenUnavailable}>
|
||||||
|
<CredentialHint reason={credentialReason()!} theme={theme()} />
|
||||||
|
</Match>
|
||||||
|
<Match when={status() === "error"}>
|
||||||
|
<text fg={theme().textMuted}>{formatBalanceError(error()!)}</text>
|
||||||
|
</Match>
|
||||||
|
</Switch>
|
||||||
|
</Show>
|
||||||
|
</box>
|
||||||
|
</Show>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hint shown when the credential is missing and the section is explicitly
|
||||||
|
* kept visible.
|
||||||
|
*/
|
||||||
|
function CredentialHint(props: { reason: "missing"; theme: TuiThemeCurrent }) {
|
||||||
|
return (
|
||||||
|
<text fg={props.theme.textMuted}>
|
||||||
|
{props.reason === "missing" ? "no GreenPT key (/connect)" : "no GreenPT key"}
|
||||||
|
</text>
|
||||||
|
)
|
||||||
|
}
|
||||||
108
test/balance.test.ts
Normal file
108
test/balance.test.ts
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
import { describe, expect, it } from "vitest"
|
||||||
|
import { fetchBalance, parseCreditHeader, type FetchLike } from "../src/balance"
|
||||||
|
|
||||||
|
const API_KEY = "test-key"
|
||||||
|
|
||||||
|
function headers(init: Record<string, string>): Headers {
|
||||||
|
return new Headers(init)
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("parseCreditHeader", () => {
|
||||||
|
it("reads the live x-credits-remaining header", () => {
|
||||||
|
expect(parseCreditHeader(headers({ "x-credits-remaining": "5.309411174" }))).toEqual({
|
||||||
|
credits: 5.309411174,
|
||||||
|
raw: "5.309411174",
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it("accepts the documented x-credit-balance fallback", () => {
|
||||||
|
expect(parseCreditHeader(headers({ "x-credit-balance": "12.5" }))).toEqual({
|
||||||
|
credits: 12.5,
|
||||||
|
raw: "12.5",
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it("prefers the live header when both are present", () => {
|
||||||
|
const result = parseCreditHeader(
|
||||||
|
headers({ "x-credits-remaining": "1", "x-credit-balance": "2" }),
|
||||||
|
)
|
||||||
|
expect(result?.credits).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns null when neither header is present", () => {
|
||||||
|
expect(parseCreditHeader(headers({ "content-type": "application/json" }))).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns null for a malformed value", () => {
|
||||||
|
expect(parseCreditHeader(headers({ "x-credits-remaining": "not-a-number" }))).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns null for undefined headers", () => {
|
||||||
|
expect(parseCreditHeader(undefined)).toBeNull()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("fetchBalance", () => {
|
||||||
|
it("returns the balance from a free 400 probe", async () => {
|
||||||
|
const fetchImpl: FetchLike = async () =>
|
||||||
|
new Response(null, {
|
||||||
|
status: 400,
|
||||||
|
headers: { "x-credits-remaining": "5.309411174" },
|
||||||
|
})
|
||||||
|
const result = await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(result).toEqual({ credits: 5.309411174, raw: "5.309411174" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("uses HEAD first, without a body", async () => {
|
||||||
|
let method: string | undefined
|
||||||
|
const fetchImpl: FetchLike = async (_input, init) => {
|
||||||
|
method = init?.method
|
||||||
|
return new Response(null, { status: 400, headers: { "x-credits-remaining": "1" } })
|
||||||
|
}
|
||||||
|
await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(method).toBe("HEAD")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("normalises a trailing slash on the base URL", async () => {
|
||||||
|
let url: string | undefined
|
||||||
|
const fetchImpl: FetchLike = async (input) => {
|
||||||
|
url = input
|
||||||
|
return new Response(null, { status: 400, headers: { "x-credits-remaining": "1" } })
|
||||||
|
}
|
||||||
|
await fetchBalance("https://api.greenpt.ai/v1/", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(url).toBe("https://api.greenpt.ai/v1/chat/completions")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reports unauthorized on 401", async () => {
|
||||||
|
const fetchImpl: FetchLike = async () => new Response(null, { status: 401 })
|
||||||
|
const result = await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(result).toEqual({ kind: "unauthorized" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("falls back to GET when HEAD carries no header", async () => {
|
||||||
|
const methods: string[] = []
|
||||||
|
const fetchImpl: FetchLike = async (_input, init) => {
|
||||||
|
methods.push(init?.method ?? "GET")
|
||||||
|
if (init?.method === "HEAD") return new Response(null, { status: 400 })
|
||||||
|
return new Response(null, { status: 400, headers: { "x-credits-remaining": "7.5" } })
|
||||||
|
}
|
||||||
|
const result = await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(methods).toEqual(["HEAD", "GET"])
|
||||||
|
expect(result).toEqual({ credits: 7.5, raw: "7.5" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reports a missing header when none is present", async () => {
|
||||||
|
const fetchImpl: FetchLike = async () => new Response(null, { status: 400 })
|
||||||
|
const result = await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
expect(result).toEqual({ kind: "missing-header", status: 400 })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reports a network error", async () => {
|
||||||
|
const fetchImpl: FetchLike = async () => {
|
||||||
|
throw new Error("boom")
|
||||||
|
}
|
||||||
|
const result = await fetchBalance("https://api.greenpt.ai/v1", API_KEY, undefined, fetchImpl)
|
||||||
|
if (!("kind" in result)) throw new Error("expected an error result")
|
||||||
|
expect(result.kind).toBe("network")
|
||||||
|
})
|
||||||
|
})
|
||||||
93
test/credential.test.ts
Normal file
93
test/credential.test.ts
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
import { afterEach, describe, expect, it } from "vitest"
|
||||||
|
import { mkdtempSync, mkdirSync, rmSync, writeFileSync } from "node:fs"
|
||||||
|
import { tmpdir } from "node:os"
|
||||||
|
import { join } from "node:path"
|
||||||
|
import { credentialSearchDirs, resolveGreenptKey } from "../src/credential"
|
||||||
|
|
||||||
|
const created: string[] = []
|
||||||
|
|
||||||
|
function tempDir(): string {
|
||||||
|
const dir = mkdtempSync(join(tmpdir(), "greenpt-cred-"))
|
||||||
|
created.push(dir)
|
||||||
|
return dir
|
||||||
|
}
|
||||||
|
|
||||||
|
function writeAuth(dir: string, content: unknown): void {
|
||||||
|
writeFileSync(join(dir, "auth.json"), JSON.stringify(content))
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
while (created.length > 0) {
|
||||||
|
const dir = created.pop()
|
||||||
|
if (dir) rmSync(dir, { recursive: true, force: true })
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("resolveGreenptKey", () => {
|
||||||
|
it("prefers the explicit apiKey option", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
writeAuth(dir, { greenpt: { type: "api", key: "from-auth" } })
|
||||||
|
const result = resolveGreenptKey({ apiKey: "from-option" }, dir, { GREENPT_API_KEY: "from-env" })
|
||||||
|
expect(result).toEqual({ ok: true, key: "from-option" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("prefers the environment variable over the auth store", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
writeAuth(dir, { greenpt: { type: "api", key: "from-auth" } })
|
||||||
|
const result = resolveGreenptKey({}, dir, { GREENPT_API_KEY: "from-env" })
|
||||||
|
expect(result).toEqual({ ok: true, key: "from-env" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reads the active auth store when nothing else is set", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
writeAuth(dir, { greenpt: { type: "api", key: "from-auth" } })
|
||||||
|
const result = resolveGreenptKey({}, dir, {})
|
||||||
|
expect(result).toEqual({ ok: true, key: "from-auth" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("ignores OAuth entries", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
writeAuth(dir, { greenpt: { type: "oauth", access: "token" } })
|
||||||
|
const result = resolveGreenptKey({}, dir, {})
|
||||||
|
expect(result).toEqual({ ok: false, reason: "missing" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("ignores empty keys", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
writeAuth(dir, { greenpt: { type: "api", key: "" } })
|
||||||
|
const result = resolveGreenptKey({}, dir, {})
|
||||||
|
expect(result).toEqual({ ok: false, reason: "missing" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns missing when no credential is available", () => {
|
||||||
|
const dir = tempDir()
|
||||||
|
const result = resolveGreenptKey({}, dir, {})
|
||||||
|
expect(result).toEqual({ ok: false, reason: "missing" })
|
||||||
|
})
|
||||||
|
|
||||||
|
it("falls back to XDG data home", () => {
|
||||||
|
const xdg = tempDir()
|
||||||
|
const stateDir = join(xdg, "opencode")
|
||||||
|
mkdirSync(stateDir)
|
||||||
|
writeAuth(stateDir, { greenpt: { type: "api", key: "from-xdg" } })
|
||||||
|
const result = resolveGreenptKey({}, undefined, { XDG_DATA_HOME: xdg })
|
||||||
|
expect(result).toEqual({ ok: true, key: "from-xdg" })
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("credentialSearchDirs", () => {
|
||||||
|
it("puts the state dir first and de-duplicates", () => {
|
||||||
|
const dirs = credentialSearchDirs("/state", {
|
||||||
|
XDG_DATA_HOME: "/xdg",
|
||||||
|
OPENCODE_DATA_DIR: "/state",
|
||||||
|
})
|
||||||
|
expect(dirs[0]).toBe("/state")
|
||||||
|
expect(dirs).toContain(join("/xdg", "opencode"))
|
||||||
|
expect(new Set(dirs).size).toBe(dirs.length)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("falls back to ~/.local/share/opencode", () => {
|
||||||
|
const dirs = credentialSearchDirs(undefined, { HOME: "/home/tester" })
|
||||||
|
expect(dirs).toContain(join("/home/tester", ".local", "share", "opencode"))
|
||||||
|
})
|
||||||
|
})
|
||||||
49
test/format.test.ts
Normal file
49
test/format.test.ts
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
import { describe, expect, it } from "vitest"
|
||||||
|
import { formatBalanceError, formatCredits, readFoldOpen } from "../src/format"
|
||||||
|
|
||||||
|
describe("formatCredits", () => {
|
||||||
|
it("formats with two decimals", () => {
|
||||||
|
expect(formatCredits(5.309411174)).toBe("5.31")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("formats zero", () => {
|
||||||
|
expect(formatCredits(0)).toBe("0.00")
|
||||||
|
})
|
||||||
|
|
||||||
|
it("returns a dash for non-finite input", () => {
|
||||||
|
expect(formatCredits(Number.NaN)).toBe("-")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("formatBalanceError", () => {
|
||||||
|
it("renders each error kind", () => {
|
||||||
|
expect(formatBalanceError({ kind: "unauthorized" })).toContain("invalid")
|
||||||
|
expect(formatBalanceError({ kind: "network" })).toContain("network")
|
||||||
|
expect(formatBalanceError({ kind: "missing-header", status: 400 })).toContain("400")
|
||||||
|
expect(formatBalanceError({ kind: "no-credential", reason: "missing" })).toContain("GreenPT")
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe("readFoldOpen", () => {
|
||||||
|
it("defaults to open when the KV store is absent", () => {
|
||||||
|
expect(readFoldOpen(undefined)).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reads a persisted boolean", () => {
|
||||||
|
expect(readFoldOpen({ get: () => false })).toBe(false)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("falls back when the stored value is not a boolean", () => {
|
||||||
|
expect(readFoldOpen({ get: () => "nope" })).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("survives a throwing KV store", () => {
|
||||||
|
expect(
|
||||||
|
readFoldOpen({
|
||||||
|
get: () => {
|
||||||
|
throw new Error("kv down")
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
).toBe(true)
|
||||||
|
})
|
||||||
|
})
|
||||||
24
test/integration.greenpt.test.ts
Normal file
24
test/integration.greenpt.test.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import { describe, expect, it } from "vitest"
|
||||||
|
import { fetchBalance } from "../src/balance"
|
||||||
|
import { DEFAULT_BASE_URL } from "../src/store"
|
||||||
|
|
||||||
|
const apiKey = process.env.GREENPT_API_KEY
|
||||||
|
const enabled = process.env.GREENPT_INTEGRATION === "1" && typeof apiKey === "string" && apiKey.length > 0
|
||||||
|
|
||||||
|
const suite = enabled ? describe : describe.skip
|
||||||
|
|
||||||
|
suite("GreenPT live API", () => {
|
||||||
|
it("returns a finite balance from the free HEAD probe", async () => {
|
||||||
|
const result = await fetchBalance(DEFAULT_BASE_URL, apiKey as string)
|
||||||
|
if ("kind" in result) {
|
||||||
|
throw new Error(`expected a balance, got error: ${result.kind}`)
|
||||||
|
}
|
||||||
|
expect(Number.isFinite(result.credits)).toBe(true)
|
||||||
|
expect(result.credits).toBeGreaterThanOrEqual(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("reports unauthorized for an invalid key", async () => {
|
||||||
|
const result = await fetchBalance(DEFAULT_BASE_URL, "sk-definitely-invalid")
|
||||||
|
expect(result).toEqual({ kind: "unauthorized" })
|
||||||
|
})
|
||||||
|
})
|
||||||
16
tsconfig.json
Normal file
16
tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ESNext",
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"jsx": "react-jsx",
|
||||||
|
"jsxImportSource": "@opentui/solid",
|
||||||
|
"strict": true,
|
||||||
|
"noEmit": true,
|
||||||
|
"noUncheckedIndexedAccess": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
"types": ["node"]
|
||||||
|
},
|
||||||
|
"include": ["src", "test"]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user