@tomradex/inbox 0.0.0-stage → 0.17.0
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 +204 -0
- package/dist/index.d.ts +3 -0
- package/dist/runtime.js +1 -0
- package/dist/service.d.ts +377 -0
- package/dist/words.d.ts +23 -0
- package/package.json +40 -4
- package/README.md +0 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
Copyright 2026 Haoyuan Tang
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
Apache License
|
|
5
|
+
Version 2.0, January 2004
|
|
6
|
+
http://www.apache.org/licenses/
|
|
7
|
+
|
|
8
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
9
|
+
|
|
10
|
+
1. Definitions.
|
|
11
|
+
|
|
12
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
13
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
14
|
+
|
|
15
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
16
|
+
the copyright owner that is granting the License.
|
|
17
|
+
|
|
18
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
19
|
+
other entities that control, are controlled by, or are under common
|
|
20
|
+
control with that entity. For the purposes of this definition,
|
|
21
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
22
|
+
direction or management of such entity, whether by contract or
|
|
23
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
24
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
25
|
+
|
|
26
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
27
|
+
exercising permissions granted by this License.
|
|
28
|
+
|
|
29
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
30
|
+
including but not limited to software source code, documentation
|
|
31
|
+
source, and configuration files.
|
|
32
|
+
|
|
33
|
+
"Object" form shall mean any form resulting from mechanical
|
|
34
|
+
transformation or translation of a Source form, including but
|
|
35
|
+
not limited to compiled object code, generated documentation,
|
|
36
|
+
and conversions to other media types.
|
|
37
|
+
|
|
38
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
39
|
+
Object form, made available under the License, as indicated by a
|
|
40
|
+
copyright notice that is included in or attached to the work
|
|
41
|
+
(an example is provided in the Appendix below).
|
|
42
|
+
|
|
43
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
44
|
+
form, that is based on (or derived from) the Work and for which the
|
|
45
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
46
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
47
|
+
of this License, Derivative Works shall not include works that remain
|
|
48
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
49
|
+
the Work and Derivative Works thereof.
|
|
50
|
+
|
|
51
|
+
"Contribution" shall mean any work of authorship, including
|
|
52
|
+
the original version of the Work and any modifications or additions
|
|
53
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
54
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
55
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
56
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
57
|
+
means any form of electronic, verbal, or written communication sent
|
|
58
|
+
to the Licensor or its representatives, including but not limited to
|
|
59
|
+
communication on electronic mailing lists, source code control systems,
|
|
60
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
61
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
62
|
+
excluding communication that is conspicuously marked or otherwise
|
|
63
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
64
|
+
|
|
65
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
66
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
67
|
+
subsequently incorporated within the Work.
|
|
68
|
+
|
|
69
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
70
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
71
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
72
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
73
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
74
|
+
Work and such Derivative Works in Source or Object form.
|
|
75
|
+
|
|
76
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
77
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
78
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
79
|
+
(except as stated in this section) patent license to make, have made,
|
|
80
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
81
|
+
where such license applies only to those patent claims licensable
|
|
82
|
+
by such Contributor that are necessarily infringed by their
|
|
83
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
84
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
85
|
+
institute patent litigation against any entity (including a
|
|
86
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
87
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
88
|
+
or contributory patent infringement, then any patent licenses
|
|
89
|
+
granted to You under this License for that Work shall terminate
|
|
90
|
+
as of the date such litigation is filed.
|
|
91
|
+
|
|
92
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
93
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
94
|
+
modifications, and in Source or Object form, provided that You
|
|
95
|
+
meet the following conditions:
|
|
96
|
+
|
|
97
|
+
(a) You must give any other recipients of the Work or
|
|
98
|
+
Derivative Works a copy of this License; and
|
|
99
|
+
|
|
100
|
+
(b) You must cause any modified files to carry prominent notices
|
|
101
|
+
stating that You changed the files; and
|
|
102
|
+
|
|
103
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
104
|
+
that You distribute, all copyright, patent, trademark, and
|
|
105
|
+
attribution notices from the Source form of the Work,
|
|
106
|
+
excluding those notices that do not pertain to any part of
|
|
107
|
+
the Derivative Works; and
|
|
108
|
+
|
|
109
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
110
|
+
distribution, then any Derivative Works that You distribute must
|
|
111
|
+
include a readable copy of the attribution notices contained
|
|
112
|
+
within such NOTICE file, excluding those notices that do not
|
|
113
|
+
pertain to any part of the Derivative Works, in at least one
|
|
114
|
+
of the following places: within a NOTICE text file distributed
|
|
115
|
+
as part of the Derivative Works; within the Source form or
|
|
116
|
+
documentation, if provided along with the Derivative Works; or,
|
|
117
|
+
within a display generated by the Derivative Works, if and
|
|
118
|
+
wherever such third-party notices normally appear. The contents
|
|
119
|
+
of the NOTICE file are for informational purposes only and
|
|
120
|
+
do not modify the License. You may add Your own attribution
|
|
121
|
+
notices within Derivative Works that You distribute, alongside
|
|
122
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
123
|
+
that such additional attribution notices cannot be construed
|
|
124
|
+
as modifying the License.
|
|
125
|
+
|
|
126
|
+
You may add Your own copyright statement to Your modifications and
|
|
127
|
+
may provide additional or different license terms and conditions
|
|
128
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
129
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
130
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
131
|
+
the conditions stated in this License.
|
|
132
|
+
|
|
133
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
134
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
135
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
136
|
+
this License, without any additional terms or conditions.
|
|
137
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
138
|
+
the terms of any separate license agreement you may have executed
|
|
139
|
+
with Licensor regarding such Contributions.
|
|
140
|
+
|
|
141
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
142
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
143
|
+
except as required for reasonable and customary use in describing the
|
|
144
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
145
|
+
|
|
146
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
147
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
148
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
149
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
150
|
+
implied, including, without limitation, any warranties or conditions
|
|
151
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
152
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
153
|
+
appropriateness of using or redistributing the Work and assume any
|
|
154
|
+
risks associated with Your exercise of permissions under this License.
|
|
155
|
+
|
|
156
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
157
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
158
|
+
unless required by applicable law (such as deliberate and grossly
|
|
159
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
160
|
+
liable to You for damages, including any direct, indirect, special,
|
|
161
|
+
incidental, or consequential damages of any character arising as a
|
|
162
|
+
result of this License or out of the use or inability to use the
|
|
163
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
164
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
165
|
+
other commercial damages or losses), even if such Contributor
|
|
166
|
+
has been advised of the possibility of such damages.
|
|
167
|
+
|
|
168
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
169
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
170
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
171
|
+
or other liability obligations and/or rights consistent with this
|
|
172
|
+
License. However, in accepting such obligations, You may act only
|
|
173
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
174
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
175
|
+
defend, and hold each Contributor harmless for any liability
|
|
176
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
177
|
+
of your accepting any such warranty or additional liability.
|
|
178
|
+
|
|
179
|
+
END OF TERMS AND CONDITIONS
|
|
180
|
+
|
|
181
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
182
|
+
|
|
183
|
+
To apply the Apache License to your work, attach the following
|
|
184
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
185
|
+
replaced with your own identifying information. (Don't include
|
|
186
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
187
|
+
comment syntax for the file format. We also recommend that a
|
|
188
|
+
file or class name and description of purpose be included on the
|
|
189
|
+
same "printed page" as the copyright notice for easier
|
|
190
|
+
identification within third-party archives.
|
|
191
|
+
|
|
192
|
+
Copyright [yyyy] [name of copyright owner]
|
|
193
|
+
|
|
194
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
195
|
+
you may not use this file except in compliance with the License.
|
|
196
|
+
You may obtain a copy of the License at
|
|
197
|
+
|
|
198
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
199
|
+
|
|
200
|
+
Unless required by applicable law or agreed to in writing, software
|
|
201
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
202
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
203
|
+
See the License for the specific language governing permissions and
|
|
204
|
+
limitations under the License.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { Inbox, InboxConfig, INBOX_KINDS, MIGRATIONS, TABLES, entryId, type InboxKind, type InboxStatus, type CloseReason, type InboxAttachment, type InboxEntryInput, type InboxEntry, type InboxSource, type InboxSourceView, type TriageChange, type InboxActivity, type InboxSourceOption, type InboxListFilter, type AcceptOptions, type TriageSuggestion, type InboxSuggestion, type InboxTriager, type InboxTriagerView, type AdoptOptions, type AdoptResult } from "./service.js";
|
|
2
|
+
export { Inbox as default } from "./service.js";
|
|
3
|
+
//# sourceMappingURL=index.d.ts.map
|
package/dist/runtime.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
throw new Error("@tomradex/inbox is Tomrade's own code: a full-mode plugin gets the running app's copy, so load the plugin in Tomrade");
|
|
@@ -0,0 +1,377 @@
|
|
|
1
|
+
import { Context, Service } from "cordis";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
import type { Author, Item, Priority } from "@tomradex/domain";
|
|
4
|
+
import { type InboxWords } from "./words.js";
|
|
5
|
+
export declare const INBOX_KINDS: readonly ["bug", "feedback", "idea"];
|
|
6
|
+
export type InboxKind = (typeof INBOX_KINDS)[number];
|
|
7
|
+
export type InboxStatus = "new" | "accepted" | "merged" | "closed";
|
|
8
|
+
export type CloseReason = "wontfix" | "duplicate";
|
|
9
|
+
/** A status, everything, or the triaged entries with something new at their source. */
|
|
10
|
+
export type InboxListFilter = InboxStatus | "all" | "activity";
|
|
11
|
+
export interface InboxAttachment {
|
|
12
|
+
name: string;
|
|
13
|
+
url: string;
|
|
14
|
+
}
|
|
15
|
+
/** One piece of feedback as a source hands it over. */
|
|
16
|
+
export interface InboxEntryInput {
|
|
17
|
+
/** The source's own id for it: one entry per (source, externalId), however often it is pulled. */
|
|
18
|
+
externalId: string;
|
|
19
|
+
url?: string | null;
|
|
20
|
+
kind?: InboxKind;
|
|
21
|
+
/** Who sent it, as far as the source shows: a login, a report code. */
|
|
22
|
+
reporter?: string | null;
|
|
23
|
+
title: string;
|
|
24
|
+
body?: string;
|
|
25
|
+
attachments?: InboxAttachment[];
|
|
26
|
+
receivedAt: number;
|
|
27
|
+
}
|
|
28
|
+
export interface InboxEntry {
|
|
29
|
+
id: string;
|
|
30
|
+
projectId: string;
|
|
31
|
+
source: string;
|
|
32
|
+
externalId: string;
|
|
33
|
+
url: string | null;
|
|
34
|
+
kind: InboxKind;
|
|
35
|
+
reporter: string | null;
|
|
36
|
+
title: string;
|
|
37
|
+
body: string;
|
|
38
|
+
attachments: InboxAttachment[];
|
|
39
|
+
receivedAt: number;
|
|
40
|
+
status: InboxStatus;
|
|
41
|
+
/** The ticket it became, or was merged into. */
|
|
42
|
+
itemId: string | null;
|
|
43
|
+
closeReason: CloseReason | null;
|
|
44
|
+
reply: string | null;
|
|
45
|
+
repliedAt: number | null;
|
|
46
|
+
triagedAt: number | null;
|
|
47
|
+
/** When someone wrote or reopened it at the source after it was triaged, until a person looks again; null when nothing new. */
|
|
48
|
+
activityAt: number | null;
|
|
49
|
+
/** The release its ticket shipped in, once the source heard of one. */
|
|
50
|
+
shippedIn: string | null;
|
|
51
|
+
/** Closed as a duplicate of this entry. */
|
|
52
|
+
duplicateOf: string | null;
|
|
53
|
+
/** What the triager proposes; a person confirms it or triages by hand. */
|
|
54
|
+
suggestion: InboxSuggestion | null;
|
|
55
|
+
/** Why the last suggestion could not be made; null when it was, or none was asked. */
|
|
56
|
+
suggestError: string | null;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* A proposed triage: accept as a ticket, merge into a ticket it repeats, or
|
|
60
|
+
* close as a duplicate of another entry — with the kind, priority and title a
|
|
61
|
+
* ticket would get, and a draft answer for whoever wrote.
|
|
62
|
+
*/
|
|
63
|
+
export interface TriageSuggestion {
|
|
64
|
+
action: "accept" | "merge" | "duplicate";
|
|
65
|
+
kind: InboxKind;
|
|
66
|
+
priority: Priority | null;
|
|
67
|
+
title: string;
|
|
68
|
+
/** merge: the ticket it repeats. */
|
|
69
|
+
itemId: string | null;
|
|
70
|
+
/** duplicate: the inbox entry it repeats. */
|
|
71
|
+
duplicateOf: string | null;
|
|
72
|
+
/** Why, in the person's language. */
|
|
73
|
+
reason: string;
|
|
74
|
+
/** Null when the source takes no replies, or nothing needs saying. */
|
|
75
|
+
reply: string | null;
|
|
76
|
+
}
|
|
77
|
+
export interface InboxSuggestion extends TriageSuggestion {
|
|
78
|
+
/** Who suggested it: the triager's title. */
|
|
79
|
+
by: string;
|
|
80
|
+
at: number;
|
|
81
|
+
}
|
|
82
|
+
/** Proposes the triage of an untriaged entry. One is active at a time. */
|
|
83
|
+
export interface InboxTriager {
|
|
84
|
+
id: string;
|
|
85
|
+
title: string | (() => string);
|
|
86
|
+
/** Null when it can suggest now; otherwise why not, in the person's language. */
|
|
87
|
+
available?(): string | null | Promise<string | null>;
|
|
88
|
+
/** `entries` are the project's other untriaged entries, which this one may repeat. */
|
|
89
|
+
suggest(entry: InboxEntry, scope: {
|
|
90
|
+
projectId: string;
|
|
91
|
+
canReply: boolean;
|
|
92
|
+
entries: InboxEntry[];
|
|
93
|
+
}): Promise<TriageSuggestion>;
|
|
94
|
+
}
|
|
95
|
+
export interface InboxTriagerView {
|
|
96
|
+
title: string;
|
|
97
|
+
unavailable: string | null;
|
|
98
|
+
}
|
|
99
|
+
export interface AdoptOptions {
|
|
100
|
+
/** The reply to send instead of the draft; false sends none. */
|
|
101
|
+
reply?: string | false;
|
|
102
|
+
}
|
|
103
|
+
export interface AdoptResult {
|
|
104
|
+
entry: InboxEntry;
|
|
105
|
+
item: Item | null;
|
|
106
|
+
/** The triage went through but the reply did not. */
|
|
107
|
+
replyError: string | null;
|
|
108
|
+
}
|
|
109
|
+
/** What the inbox tells a source after a triage, so whoever wrote sees it where they wrote. */
|
|
110
|
+
export type TriageChange = {
|
|
111
|
+
state: "accepted" | "merged";
|
|
112
|
+
ticket: {
|
|
113
|
+
key: string;
|
|
114
|
+
title: string;
|
|
115
|
+
};
|
|
116
|
+
} | {
|
|
117
|
+
state: "closed";
|
|
118
|
+
reason: CloseReason;
|
|
119
|
+
duplicateOf?: {
|
|
120
|
+
externalId: string;
|
|
121
|
+
url: string | null;
|
|
122
|
+
};
|
|
123
|
+
} | {
|
|
124
|
+
state: "reopened";
|
|
125
|
+
} | {
|
|
126
|
+
state: "shipped";
|
|
127
|
+
version: string;
|
|
128
|
+
ticket: {
|
|
129
|
+
key: string;
|
|
130
|
+
title: string;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
/** Something new at the source on an entry already here: a comment, a reopen. */
|
|
134
|
+
export interface InboxActivity {
|
|
135
|
+
externalId: string;
|
|
136
|
+
at: number;
|
|
137
|
+
}
|
|
138
|
+
/** A per-project switch a source offers, such as whether it may close what it brought in. */
|
|
139
|
+
export interface InboxSourceOption {
|
|
140
|
+
id: string;
|
|
141
|
+
title: string | (() => string);
|
|
142
|
+
description?: string | (() => string);
|
|
143
|
+
default: boolean;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Where feedback comes from: Tomrade's own reports, GitHub issues, later mail.
|
|
147
|
+
* Pull only — the backlog is never mirrored back; a source hears just the
|
|
148
|
+
* triage of what came from it, and a reply when it can carry one.
|
|
149
|
+
*/
|
|
150
|
+
export interface InboxSource {
|
|
151
|
+
id: string;
|
|
152
|
+
title: string | (() => string);
|
|
153
|
+
/** What one of its ids looks like in text ("R-[0-9A-Z]{6}", "#\\d+"), as a regular expression. */
|
|
154
|
+
keyPattern?: string;
|
|
155
|
+
/** Null when it can pull in this project; otherwise why not, in the person's language. */
|
|
156
|
+
available?(projectId: string): string | null | Promise<string | null>;
|
|
157
|
+
/**
|
|
158
|
+
* What arrived since `since` (epoch ms; null: from the start); entries already here are skipped. With
|
|
159
|
+
* `cursor`, the source says where the next pull starts — needed when it leaves some of what it read out.
|
|
160
|
+
* `state` is the source's own bookkeeping from its last pull (such as a cursor per repository), kept as given.
|
|
161
|
+
* `warnings` are what went wrong without failing the pull; the next pull's replace them.
|
|
162
|
+
*/
|
|
163
|
+
pull(scope: {
|
|
164
|
+
projectId: string;
|
|
165
|
+
since: number | null;
|
|
166
|
+
state: unknown;
|
|
167
|
+
}): Promise<InboxEntryInput[] | {
|
|
168
|
+
entries: InboxEntryInput[];
|
|
169
|
+
cursor: number | null;
|
|
170
|
+
activity?: InboxActivity[];
|
|
171
|
+
state?: unknown;
|
|
172
|
+
warnings?: string[];
|
|
173
|
+
}>;
|
|
174
|
+
reply?(entry: InboxEntry, text: string): Promise<void>;
|
|
175
|
+
setStatus?(entry: InboxEntry, change: TriageChange): Promise<void>;
|
|
176
|
+
options?: InboxSourceOption[];
|
|
177
|
+
}
|
|
178
|
+
export interface InboxSourceView {
|
|
179
|
+
id: string;
|
|
180
|
+
title: string;
|
|
181
|
+
enabled: boolean;
|
|
182
|
+
/** Why it can't pull here; null when it can. */
|
|
183
|
+
unavailable: string | null;
|
|
184
|
+
canReply: boolean;
|
|
185
|
+
keyPattern: string | null;
|
|
186
|
+
pulledAt: number | null;
|
|
187
|
+
error: string | null;
|
|
188
|
+
/** What went wrong in the last pull without failing it, such as one repository refusing. */
|
|
189
|
+
warnings: string[];
|
|
190
|
+
/** Triage it has not heard about yet. */
|
|
191
|
+
pending: number;
|
|
192
|
+
options: {
|
|
193
|
+
id: string;
|
|
194
|
+
title: string;
|
|
195
|
+
description: string | null;
|
|
196
|
+
value: boolean;
|
|
197
|
+
}[];
|
|
198
|
+
}
|
|
199
|
+
export interface AcceptOptions {
|
|
200
|
+
title?: string;
|
|
201
|
+
kind?: InboxKind;
|
|
202
|
+
boardId?: string;
|
|
203
|
+
priority?: Priority;
|
|
204
|
+
}
|
|
205
|
+
export declare const InboxConfig: z.ZodPreprocess<z.ZodObject<{
|
|
206
|
+
pullMs: z.ZodDefault<z.ZodNumber>;
|
|
207
|
+
}, z.core.$strip>>;
|
|
208
|
+
export type InboxConfig = z.output<typeof InboxConfig>;
|
|
209
|
+
declare module "cordis" {
|
|
210
|
+
interface Context {
|
|
211
|
+
inbox: Inbox;
|
|
212
|
+
}
|
|
213
|
+
interface Events {
|
|
214
|
+
"inbox/changed"(projectId: string): void;
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
declare module "@tomradex/ipc" {
|
|
218
|
+
interface Channels {
|
|
219
|
+
"inbox.list": (projectId: string, status?: InboxListFilter) => InboxEntry[];
|
|
220
|
+
"inbox.sources": (projectId: string) => InboxSourceView[];
|
|
221
|
+
"inbox.setSource": (projectId: string, sourceId: string, enabled: boolean) => InboxSourceView[];
|
|
222
|
+
"inbox.setSourceOption": (projectId: string, sourceId: string, optionId: string, value: boolean) => InboxSourceView[];
|
|
223
|
+
"inbox.refresh": (projectId: string) => number;
|
|
224
|
+
"inbox.accept": (projectId: string, entryId: string, opts?: AcceptOptions) => {
|
|
225
|
+
entry: InboxEntry;
|
|
226
|
+
item: Item;
|
|
227
|
+
};
|
|
228
|
+
"inbox.merge": (projectId: string, entryId: string, itemId: string) => InboxEntry;
|
|
229
|
+
"inbox.close": (projectId: string, entryId: string, reason: CloseReason, duplicateOf?: string) => InboxEntry;
|
|
230
|
+
"inbox.seen": (projectId: string, entryId: string) => InboxEntry;
|
|
231
|
+
"inbox.reopen": (projectId: string, entryId: string) => InboxEntry;
|
|
232
|
+
"inbox.reply": (projectId: string, entryId: string, text: string) => InboxEntry;
|
|
233
|
+
"inbox.triager": () => InboxTriagerView | null;
|
|
234
|
+
"inbox.suggest": (projectId: string, entryId: string) => InboxEntry;
|
|
235
|
+
"inbox.adopt": (projectId: string, entryId: string, opts?: AdoptOptions) => AdoptResult;
|
|
236
|
+
}
|
|
237
|
+
interface Broadcasts {
|
|
238
|
+
"inbox.changed": (projectId: string) => void;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
export declare const MIGRATIONS: {
|
|
242
|
+
version: number;
|
|
243
|
+
up: string;
|
|
244
|
+
}[];
|
|
245
|
+
/**
|
|
246
|
+
* Entries and their triage travel with the project, so every machine sees the
|
|
247
|
+
* same inbox. Where each source was read up to, and what a source has yet to
|
|
248
|
+
* hear, belong to the machine that pulled and triaged.
|
|
249
|
+
*/
|
|
250
|
+
export declare const TABLES: {
|
|
251
|
+
readonly plugin_inbox_entries: {
|
|
252
|
+
readonly project: "project_id";
|
|
253
|
+
readonly export: {
|
|
254
|
+
readonly order: "id";
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
readonly plugin_inbox_projects: {
|
|
258
|
+
readonly project: "project_id";
|
|
259
|
+
readonly export: {
|
|
260
|
+
readonly order: "project_id";
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
readonly plugin_inbox_pulls: {
|
|
264
|
+
readonly project: "project_id";
|
|
265
|
+
readonly export: false;
|
|
266
|
+
};
|
|
267
|
+
readonly plugin_inbox_outbox: {
|
|
268
|
+
readonly project: {
|
|
269
|
+
readonly via: "entry_id";
|
|
270
|
+
readonly table: "plugin_inbox_entries";
|
|
271
|
+
};
|
|
272
|
+
readonly export: false;
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
/** Stable across machines: two of them pulling the same report make one entry. */
|
|
276
|
+
export declare const entryId: (source: string, externalId: string) => string;
|
|
277
|
+
/**
|
|
278
|
+
* A project's inbox. Feedback and bug reports arrive from the sources the
|
|
279
|
+
* project switched on and wait here; a person triages each one — accepts it as
|
|
280
|
+
* a ticket, merges it into one, replies, or closes it — and only then does it
|
|
281
|
+
* reach the backlog. Tickets that came from here carry Source and Kind fields
|
|
282
|
+
* and a count of how many times the same thing came in.
|
|
283
|
+
*/
|
|
284
|
+
export declare class Inbox extends Service {
|
|
285
|
+
readonly config: InboxConfig;
|
|
286
|
+
static provide: string;
|
|
287
|
+
static inject: string[];
|
|
288
|
+
static Config: z.ZodPreprocess<z.ZodObject<{
|
|
289
|
+
pullMs: z.ZodDefault<z.ZodNumber>;
|
|
290
|
+
}, z.core.$strip>>;
|
|
291
|
+
private readonly home;
|
|
292
|
+
private readonly sourceMap;
|
|
293
|
+
private readonly pulling;
|
|
294
|
+
private readonly flushing;
|
|
295
|
+
private triagerDef;
|
|
296
|
+
private readonly suggesting;
|
|
297
|
+
private readonly suggestQueue;
|
|
298
|
+
constructor(ctx: Context, config: InboxConfig);
|
|
299
|
+
[Service.init](): void;
|
|
300
|
+
/** A source of feedback; every project chooses whether to pull from it. */
|
|
301
|
+
source(def: InboxSource): () => void;
|
|
302
|
+
sources(projectId: string): Promise<InboxSourceView[]>;
|
|
303
|
+
setSource(projectId: string, sourceId: string, enabled: boolean): Promise<InboxSourceView[]>;
|
|
304
|
+
/** A source's per-project switch, or its default while nobody has touched it. */
|
|
305
|
+
option(projectId: string, sourceId: string, optionId: string): boolean;
|
|
306
|
+
setSourceOption(projectId: string, sourceId: string, optionId: string, value: boolean): Promise<InboxSourceView[]>;
|
|
307
|
+
list(projectId: string, status?: InboxListFilter): InboxEntry[];
|
|
308
|
+
get(projectId: string, id: string): InboxEntry | null;
|
|
309
|
+
/** What waits for a person: untriaged entries, and triaged ones with something new at their source. */
|
|
310
|
+
count(projectId: string): number;
|
|
311
|
+
/**
|
|
312
|
+
* Something happened at the source on entries already triaged. Nothing is
|
|
313
|
+
* done about it on its own: the entry is marked until a person looks.
|
|
314
|
+
*/
|
|
315
|
+
noteActivity(projectId: string, sourceId: string, activity: InboxActivity[]): number;
|
|
316
|
+
/** The person saw what was new; it stays triaged as it was. */
|
|
317
|
+
seen(projectId: string, id: string): InboxEntry;
|
|
318
|
+
/** Its ticket went out in a release: the source hears which, once. */
|
|
319
|
+
ship(projectId: string, id: string, version: string): InboxEntry;
|
|
320
|
+
/** New entries from one source; one already here — pulled before, or on another machine — is left as it is. */
|
|
321
|
+
add(projectId: string, sourceId: string, inputs: InboxEntryInput[]): number;
|
|
322
|
+
/** Pull every enabled source now — or one — after telling them what was triaged since. Returns how many arrived. */
|
|
323
|
+
refresh(projectId: string, only?: string): Promise<number>;
|
|
324
|
+
private pullNow;
|
|
325
|
+
private pullAll;
|
|
326
|
+
/** A new ticket from the entry, carrying where it came from; the source hears which ticket. */
|
|
327
|
+
accept(projectId: string, id: string, opts?: AcceptOptions, by?: Author): Promise<{
|
|
328
|
+
entry: InboxEntry;
|
|
329
|
+
item: Item;
|
|
330
|
+
}>;
|
|
331
|
+
/** The same thing came in again: counted on the ticket it already is. */
|
|
332
|
+
merge(projectId: string, id: string, itemId: string, by?: Author): Promise<InboxEntry>;
|
|
333
|
+
/** Not to be done, or the same as another entry — named by `duplicateOf`, so its source can point there. */
|
|
334
|
+
close(projectId: string, id: string, reason: CloseReason, duplicateOf?: string): Promise<InboxEntry>;
|
|
335
|
+
/** Back to untriaged. A ticket it became stays: it may hold work by now. */
|
|
336
|
+
reopen(projectId: string, id: string): Promise<InboxEntry>;
|
|
337
|
+
/** Said through the source, where the person who wrote reads it. */
|
|
338
|
+
reply(projectId: string, id: string, text: string): Promise<InboxEntry>;
|
|
339
|
+
/** What proposes triage for new entries. Suggestions only: a person still confirms each. */
|
|
340
|
+
triager(def: InboxTriager): () => void;
|
|
341
|
+
triagerView(): Promise<InboxTriagerView | null>;
|
|
342
|
+
/** Ask the triager about one untriaged entry now; what it says, or why it could not, is kept on the entry. */
|
|
343
|
+
suggest(projectId: string, id: string): Promise<InboxEntry>;
|
|
344
|
+
private suggestNow;
|
|
345
|
+
/** A suggestion that names a ticket or entry that is not there becomes a plain accept. */
|
|
346
|
+
private checked;
|
|
347
|
+
/** New arrivals are suggested on in the background, one at a time; a failure stays on the entry and blocks nothing. */
|
|
348
|
+
private suggestLater;
|
|
349
|
+
/** Settles once the background suggestions queued so far are done. */
|
|
350
|
+
suggestionsIdle(projectId: string): Promise<void>;
|
|
351
|
+
/** The suggestion, confirmed as it stands: the triage it names, then its reply. */
|
|
352
|
+
adopt(projectId: string, id: string, opts?: AdoptOptions): Promise<AdoptResult>;
|
|
353
|
+
private triagerUnavailable;
|
|
354
|
+
private open;
|
|
355
|
+
/** The entry's new state now; the source hears about it as soon as it can, and again until it has. */
|
|
356
|
+
private triage;
|
|
357
|
+
/** Tell the sources what was triaged here; what fails waits for the next pull. */
|
|
358
|
+
flush(projectId: string): Promise<void>;
|
|
359
|
+
private flushNow;
|
|
360
|
+
private ticketBody;
|
|
361
|
+
/** The Source and Kind fields, made the first time a ticket comes from the inbox; the person may rename them. */
|
|
362
|
+
private ensureFields;
|
|
363
|
+
/** "From feedback": made once, beside the first ticket from the inbox. Deleted, it stays deleted. */
|
|
364
|
+
private ensureView;
|
|
365
|
+
private section;
|
|
366
|
+
private has;
|
|
367
|
+
private db;
|
|
368
|
+
private ensureProject;
|
|
369
|
+
private sourceOptions;
|
|
370
|
+
private enabledSources;
|
|
371
|
+
private pulls;
|
|
372
|
+
private unavailable;
|
|
373
|
+
private titleOf;
|
|
374
|
+
words(): InboxWords;
|
|
375
|
+
private changed;
|
|
376
|
+
}
|
|
377
|
+
//# sourceMappingURL=service.d.ts.map
|
package/dist/words.d.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export declare const INBOX_WORDS: import("@tomradex/domain").WordBook<{
|
|
2
|
+
readonly module: "Inbox";
|
|
3
|
+
readonly sourceField: "Source";
|
|
4
|
+
readonly kindField: "Kind";
|
|
5
|
+
readonly kindBug: "Bug";
|
|
6
|
+
readonly kindFeedback: "Feedback";
|
|
7
|
+
readonly kindIdea: "Idea";
|
|
8
|
+
readonly view: "From feedback";
|
|
9
|
+
/** The derived column counting a ticket's feedback. */
|
|
10
|
+
readonly feedbackField: "Feedback";
|
|
11
|
+
readonly section: "Feedback";
|
|
12
|
+
readonly sectionOnce: "Came in once.";
|
|
13
|
+
readonly sectionTimes: "Came in {{n}} times.";
|
|
14
|
+
readonly received: "Received";
|
|
15
|
+
readonly quoted: "From {{source}}, {{when}}";
|
|
16
|
+
readonly reporter: "Reported by";
|
|
17
|
+
readonly notConfigured: "This source is not set up here";
|
|
18
|
+
readonly noReply: "{{source}} takes no replies";
|
|
19
|
+
readonly noTriager: "Nothing here suggests triage";
|
|
20
|
+
readonly noSuggestion: "There is no suggestion to confirm yet";
|
|
21
|
+
}>;
|
|
22
|
+
export type InboxWords = ReturnType<typeof INBOX_WORDS>;
|
|
23
|
+
//# sourceMappingURL=words.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,42 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tomradex/inbox",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.17.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"author": "Haoyuan Tang",
|
|
6
|
+
"engines": {
|
|
7
|
+
"node": ">=22"
|
|
8
|
+
},
|
|
9
|
+
"publishConfig": {
|
|
10
|
+
"access": "public"
|
|
11
|
+
},
|
|
12
|
+
"license": "Apache-2.0",
|
|
13
|
+
"description": "A project's inbox: feedback and bug reports from its sources wait here until someone triages them into tickets — declarations for full-mode plugins; Tomrade provides the code at run time",
|
|
14
|
+
"keywords": [
|
|
15
|
+
"tomrade",
|
|
16
|
+
"tomrade-plugin",
|
|
17
|
+
"types"
|
|
18
|
+
],
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"default": "./dist/runtime.js"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@tomradex/boards": "0.17.0",
|
|
31
|
+
"@tomradex/contracts": "0.17.0",
|
|
32
|
+
"@tomradex/contributions": "0.17.0",
|
|
33
|
+
"@tomradex/db": "0.17.0",
|
|
34
|
+
"@tomradex/domain": "0.2.24",
|
|
35
|
+
"@tomradex/fields": "0.17.0",
|
|
36
|
+
"@tomradex/ipc": "0.17.0",
|
|
37
|
+
"@tomradex/items": "0.17.0",
|
|
38
|
+
"@tomradex/settings": "0.17.0",
|
|
39
|
+
"cordis": "4.0.0-rc.8",
|
|
40
|
+
"zod": "^4.4.3"
|
|
41
|
+
}
|
|
42
|
+
}
|
package/README.md
DELETED