@point-seven-studio/jq-deck-server 0.0.0-stage → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/NOTICE +2 -0
- package/README.md +98 -2
- package/dist/index.mjs +447 -0
- package/dist/jq-deck-server.mjs +559 -0
- package/dist/types/cli.d.ts +9 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/main.d.ts +1 -0
- package/dist/types/page.d.ts +9 -0
- package/dist/types/report.d.ts +43 -0
- package/dist/types/send.d.ts +3 -0
- package/dist/types/server.d.ts +34 -0
- package/dist/types/store.d.ts +37 -0
- package/dist/types/team.d.ts +59 -0
- package/package.json +59 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
package/README.md
CHANGED
|
@@ -1,3 +1,99 @@
|
|
|
1
|
-
#
|
|
1
|
+
# JQ Deck Server
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
One page for a team: which Claude Code sessions are waiting on a person, on whose machine, and for how long.
|
|
4
|
+
|
|
5
|
+
Each machine runs [jq-deck](../deck) and reports counts and scores for the repositories it chooses. This server keeps the latest report from each machine and shows them together. You host it yourself.
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+
|
|
9
|
+
*The data in the picture is made up.*
|
|
10
|
+
|
|
11
|
+
## What a machine sends
|
|
12
|
+
|
|
13
|
+
Per repository: its name, its git remote (`host/owner/name`), how many sessions, how many are waiting on a person and since when, the setup score, and the unread mail count.
|
|
14
|
+
|
|
15
|
+
It does not send a folder path, any message, or any file name. The server drops every field it does not know, so a sender cannot put more on the board even by mistake. A machine reports only the repositories it lists.
|
|
16
|
+
|
|
17
|
+
**What a waiting session asked is sent only if that machine opts the folder in,** with `jq-deck --watch --send-questions ~/code/shop`. It is off by default. When on, the text is cut to 400 characters and strings shaped like secrets are removed by jq-agents before it leaves; that removal is a pattern list and can miss one. Opt a folder in only if you would be content for everyone who can see that repository on the board to read the session's last message. The board shows a question only while its machine is current, and only to viewers who may see that repository.
|
|
18
|
+
|
|
19
|
+
## Set it up
|
|
20
|
+
|
|
21
|
+
On the server (Node 18 or later, no dependency):
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
npm install -g @point-seven-studio/jq-deck-server
|
|
25
|
+
jq-deck-server init /var/lib/jq-deck
|
|
26
|
+
export JQ_DECK_SERVER_DIR=/var/lib/jq-deck
|
|
27
|
+
|
|
28
|
+
jq-deck-server add-machine dana-laptop --who "Dana" # prints that machine's token, once
|
|
29
|
+
jq-deck-server add-viewer lee # prints Lee's token, once
|
|
30
|
+
jq-deck-server add-viewer contractor --repos shop,api # sees those repositories only
|
|
31
|
+
|
|
32
|
+
jq-deck-server serve --host 0.0.0.0 --port 4320
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Put HTTPS in front of it (a reverse proxy, or your platform's own). Off this machine, the sign-in cookie is marked `Secure`, so sign-in does not work over plain HTTP unless you pass `--plain-http`, which sends tokens in the clear.
|
|
36
|
+
|
|
37
|
+
On each machine that reports:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
npm install -g @point-seven-studio/jq-deck @point-seven-studio/jq-deck-server
|
|
41
|
+
export JQ_DECK_TOKEN=jqm_... # that machine's token
|
|
42
|
+
jq-deck --watch --repos shop,api --exec "jq-deck-server send --url https://deck.example.com"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`--repos` is required: it is the list of repositories that machine agrees to report. `--all-repos` reports every repository with a session.
|
|
46
|
+
|
|
47
|
+
A viewer opens the server's address and pastes their token into the sign-in page.
|
|
48
|
+
|
|
49
|
+
### As a container
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
docker build -f packages/deck-server/Dockerfile -t jq-deck-server . # from the repository root
|
|
53
|
+
docker run -p 4320:4320 -v jq-deck-data:/data jq-deck-server
|
|
54
|
+
docker exec <container> jq-deck-server add-machine dana-laptop --who "Dana"
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The data folder is `/data`. Mount a volume there, or a restart forgets every token. The port comes from `$PORT` when the platform sets one. `GET /healthz` answers `ok` for a health check.
|
|
58
|
+
|
|
59
|
+
## The page
|
|
60
|
+
|
|
61
|
+
- **The line at the top** says how many sessions are waiting on a person and which has waited longest.
|
|
62
|
+
- **One card per repository,** with a row per machine: sessions, waiting, setup score, unread mail, and when the machine was last heard from. Where a machine opted in, what its waiting sessions asked is under its row. The same repository on two machines is one card when both have the same git remote.
|
|
63
|
+
- **A machine not heard from for 5 minutes is not counted.** Its rows stay, greyed, marked "not current". After a day its rows are hidden and it is listed as silent. Old numbers never look current.
|
|
64
|
+
- The page reloads every minute. It is read-only: there is no way to answer a session from it.
|
|
65
|
+
|
|
66
|
+
`GET /api/team` returns the same as JSON, with `Authorization: Bearer <viewer token>`.
|
|
67
|
+
|
|
68
|
+
## Who can do what
|
|
69
|
+
|
|
70
|
+
- **A machine token** can post that machine's report, and nothing else. It cannot read the board. A report is stored under the name the token belongs to, so one machine cannot report as another.
|
|
71
|
+
- **A viewer token** can read the board, and nothing else. With `--repos`, the viewer sees only those repositories; counts are worked out after that limit, and a machine with nothing they may see is not listed.
|
|
72
|
+
- `jq-deck-server remove NAME` stops a token working at once.
|
|
73
|
+
- Tokens are stored as SHA-256 hashes. A token is shown once, when it is made.
|
|
74
|
+
|
|
75
|
+
## What it stores
|
|
76
|
+
|
|
77
|
+
Plain files in the folder you chose: `config.json` (names and token hashes) and `reports/<machine>.json` (the latest report from each). There is no history. A backup is a copy of the folder. The server calls nothing.
|
|
78
|
+
|
|
79
|
+
## As a library
|
|
80
|
+
|
|
81
|
+
```js
|
|
82
|
+
import { handle, buildTeam, readReports, readConfig, sanitizeReport } from '@point-seven-studio/jq-deck-server'
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
`handle(request, context)` is the whole HTTP side as a function, for mounting inside a server you already run. `buildTeam(reports, now, viewer)` is the board as data.
|
|
86
|
+
|
|
87
|
+
## Limits
|
|
88
|
+
|
|
89
|
+
- **One process, one folder.** It is built for a team, not for many teams on one server. Run one per team.
|
|
90
|
+
- **No history.** It shows now, not how long sessions waited last week.
|
|
91
|
+
- **Access is by token.** There are no accounts, no single sign-on and no audit log. Anyone holding a viewer token can read what that viewer can.
|
|
92
|
+
- **No sign-in throttling.** Tokens are 256 random bits, so guessing is not practical, but put your own rate limit in front if your policy asks for one.
|
|
93
|
+
- **Mail is a count.** A file mailbox lives on one machine; this server does not carry messages.
|
|
94
|
+
- **A repository name is itself information.** That is why a machine must list what it reports.
|
|
95
|
+
- A git remote written with an SSH host alias (`github.com-work:acme/shop`) is sent as written, so that repository will not group with the same one cloned without the alias.
|
|
96
|
+
|
|
97
|
+
## About
|
|
98
|
+
|
|
99
|
+
Made by Point Seven Studio. Licence: Apache-2.0. Unofficial: not affiliated with or endorsed by Anthropic. "Claude" and "Claude Code" are Anthropic's names for their products.
|