@meshpoint/sdk 0.0.0-stage → 1.0.0-rc.2
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/README.md +48 -2
- package/dist/client.d.ts +59 -0
- package/dist/client.js +184 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +4 -0
- package/dist/project.d.ts +2 -0
- package/dist/project.js +32 -0
- package/dist/redact.d.ts +2 -0
- package/dist/redact.js +36 -0
- package/dist/types.d.ts +60 -0
- package/dist/types.js +2 -0
- package/package.json +42 -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/README.md
CHANGED
|
@@ -1,3 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @meshpoint/sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TypeScript client for the Meshpoint platform (`meshpoint-dev/platform`). Fetch-based, no Node-only dependencies, so it runs in Node 22+, Bun, Deno and Workers.
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
import { MeshpointClient, projectIdFromRemote } from "@meshpoint/sdk";
|
|
7
|
+
|
|
8
|
+
const client = new MeshpointClient({
|
|
9
|
+
baseUrl: "https://api.meshpoint.dev",
|
|
10
|
+
token: process.env.MESHPOINT_TOKEN!,
|
|
11
|
+
project: projectIdFromRemote("git@github.com:acme/web.git"), // github.com--acme--web
|
|
12
|
+
branch: "master",
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
// Session start: items now, teammates in the background.
|
|
16
|
+
const { recall, presence } = await client.sessionStart({ budget: 3000 });
|
|
17
|
+
inject(recall.items, recall.checkpoint);
|
|
18
|
+
presence.then(showTeammates);
|
|
19
|
+
|
|
20
|
+
// During the session: buffered, sent every 60s and on close.
|
|
21
|
+
client.capture({ body: turnText, paths: ["src/app.ts"] });
|
|
22
|
+
client.checkpoint("what we are doing and why");
|
|
23
|
+
|
|
24
|
+
// Distilled knowledge, written directly.
|
|
25
|
+
await client.putItems([{ id: "dec-1", kind: "decision", title: "Use KV for recall", body: "..." }]);
|
|
26
|
+
|
|
27
|
+
await client.close();
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Behaviour
|
|
31
|
+
|
|
32
|
+
- `capture()` never sends by itself. Turns go out every `flushIntervalMs` (default 60s), when the buffer reaches `flushMaxTurns` (default 200), on `flush()`, and on `close()`.
|
|
33
|
+
- A failed flush keeps the turns, in order, for the next attempt and reports to `onError`. After ten intervals of failure the oldest turns are dropped.
|
|
34
|
+
- `recall()` is served from the edge and can be up to 60s stale at a far region. `recall({ fresh: true })` reads the origin.
|
|
35
|
+
- `sessionStart()` returns recall and a presence promise that never rejects.
|
|
36
|
+
- Credentials are masked before they leave the process: `capture()`, `checkpoint()` and `putItems()` run every body through `redact()`, which replaces known token shapes (AWS, GitHub, Slack, Stripe, Google, `sk-` API keys, JWTs, Meshpoint tokens), private key blocks, passwords in URLs, bearer headers and values assigned to secret-looking names with `[REDACTED:<kind>]`. Git SHAs and prose are left alone. `redact()` is exported for callers that store text elsewhere first.
|
|
37
|
+
- `projectIdFromRemote()` flattens any clone URL of one repo to one id: `host--owner--repo`.
|
|
38
|
+
|
|
39
|
+
## Develop
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
npm install
|
|
43
|
+
npm run check # typecheck + tests
|
|
44
|
+
npm run build # dist/
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
Apache-2.0. See [LICENSE](LICENSE).
|
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import type { ForkResult, ItemInput, Presence, RecallResponse, Stats, TurnInput } from "./types.js";
|
|
2
|
+
export interface ClientOptions {
|
|
3
|
+
baseUrl: string;
|
|
4
|
+
token: string;
|
|
5
|
+
project: string;
|
|
6
|
+
branch: string;
|
|
7
|
+
flushIntervalMs?: number;
|
|
8
|
+
flushMaxTurns?: number;
|
|
9
|
+
fetch?: typeof fetch;
|
|
10
|
+
onError?: (err: Error) => void;
|
|
11
|
+
}
|
|
12
|
+
export declare class MeshpointError extends Error {
|
|
13
|
+
readonly status: number;
|
|
14
|
+
constructor(status: number, message: string);
|
|
15
|
+
}
|
|
16
|
+
export declare class MeshpointClient {
|
|
17
|
+
private readonly baseUrl;
|
|
18
|
+
private readonly token;
|
|
19
|
+
readonly project: string;
|
|
20
|
+
readonly branch: string;
|
|
21
|
+
private readonly flushIntervalMs;
|
|
22
|
+
private readonly flushMaxTurns;
|
|
23
|
+
private readonly fetchImpl;
|
|
24
|
+
private readonly onError;
|
|
25
|
+
private buffer;
|
|
26
|
+
private pendingCheckpoint;
|
|
27
|
+
private timer;
|
|
28
|
+
private inflight;
|
|
29
|
+
private closed;
|
|
30
|
+
constructor(opts: ClientOptions);
|
|
31
|
+
recall(opts?: {
|
|
32
|
+
budget?: number;
|
|
33
|
+
fresh?: boolean;
|
|
34
|
+
}): Promise<RecallResponse>;
|
|
35
|
+
presence(): Promise<Presence[]>;
|
|
36
|
+
sessionStart(opts?: {
|
|
37
|
+
budget?: number;
|
|
38
|
+
}): Promise<{
|
|
39
|
+
recall: RecallResponse;
|
|
40
|
+
presence: Promise<Presence[]>;
|
|
41
|
+
}>;
|
|
42
|
+
capture(turn: TurnInput): void;
|
|
43
|
+
checkpoint(body: string): void;
|
|
44
|
+
flush(): Promise<void>;
|
|
45
|
+
setPresence(paths: string[]): Promise<void>;
|
|
46
|
+
putItems(items: ItemInput[]): Promise<{
|
|
47
|
+
count: number;
|
|
48
|
+
}>;
|
|
49
|
+
retract(id: string): Promise<{
|
|
50
|
+
found: boolean;
|
|
51
|
+
}>;
|
|
52
|
+
fork(target: string, mode?: "items" | "full"): Promise<ForkResult>;
|
|
53
|
+
stats(): Promise<Stats>;
|
|
54
|
+
close(): Promise<void>;
|
|
55
|
+
private armTimer;
|
|
56
|
+
private disarmTimer;
|
|
57
|
+
private sendBuffer;
|
|
58
|
+
private request;
|
|
59
|
+
}
|
package/dist/client.js
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { redact } from "./redact.js";
|
|
2
|
+
export class MeshpointError extends Error {
|
|
3
|
+
status;
|
|
4
|
+
constructor(status, message) {
|
|
5
|
+
super(message);
|
|
6
|
+
this.status = status;
|
|
7
|
+
this.name = "MeshpointError";
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
const DEFAULT_FLUSH_INTERVAL_MS = 60_000;
|
|
11
|
+
const DEFAULT_FLUSH_MAX_TURNS = 200;
|
|
12
|
+
const BUFFER_HARD_CAP_MULTIPLIER = 10;
|
|
13
|
+
export class MeshpointClient {
|
|
14
|
+
baseUrl;
|
|
15
|
+
token;
|
|
16
|
+
project;
|
|
17
|
+
branch;
|
|
18
|
+
flushIntervalMs;
|
|
19
|
+
flushMaxTurns;
|
|
20
|
+
fetchImpl;
|
|
21
|
+
onError;
|
|
22
|
+
buffer = [];
|
|
23
|
+
pendingCheckpoint;
|
|
24
|
+
timer;
|
|
25
|
+
inflight;
|
|
26
|
+
closed = false;
|
|
27
|
+
constructor(opts) {
|
|
28
|
+
this.baseUrl = opts.baseUrl.replace(/\/+$/, "");
|
|
29
|
+
this.token = opts.token;
|
|
30
|
+
this.project = opts.project;
|
|
31
|
+
this.branch = opts.branch;
|
|
32
|
+
this.flushIntervalMs = opts.flushIntervalMs ?? DEFAULT_FLUSH_INTERVAL_MS;
|
|
33
|
+
this.flushMaxTurns = opts.flushMaxTurns ?? DEFAULT_FLUSH_MAX_TURNS;
|
|
34
|
+
this.fetchImpl = opts.fetch ?? globalThis.fetch;
|
|
35
|
+
this.onError = opts.onError ?? (() => undefined);
|
|
36
|
+
}
|
|
37
|
+
// Items for the session-start inject. Served from the edge unless `fresh` is set.
|
|
38
|
+
recall(opts = {}) {
|
|
39
|
+
const q = new URLSearchParams({ project: this.project, branch: this.branch });
|
|
40
|
+
if (opts.budget !== undefined)
|
|
41
|
+
q.set("budget", String(opts.budget));
|
|
42
|
+
if (opts.fresh)
|
|
43
|
+
q.set("fresh", "1");
|
|
44
|
+
return this.request("GET", `/v1/recall?${q}`);
|
|
45
|
+
}
|
|
46
|
+
async presence() {
|
|
47
|
+
const q = new URLSearchParams({ project: this.project, branch: this.branch });
|
|
48
|
+
const out = await this.request("GET", `/v1/presence?${q}`);
|
|
49
|
+
return out.presence;
|
|
50
|
+
}
|
|
51
|
+
// Recall is awaited; presence comes from the origin and is fetched in the background so a far
|
|
52
|
+
// origin never delays the inject. The presence promise never rejects: failures go to onError.
|
|
53
|
+
async sessionStart(opts = {}) {
|
|
54
|
+
const presence = this.presence().catch((err) => {
|
|
55
|
+
this.onError(toError(err));
|
|
56
|
+
return [];
|
|
57
|
+
});
|
|
58
|
+
const recall = await this.recall(opts);
|
|
59
|
+
return { recall, presence };
|
|
60
|
+
}
|
|
61
|
+
// Buffers a turn; nothing is sent until the interval, the size cap, flush() or close().
|
|
62
|
+
// Credentials are masked here, before the turn is buffered; see redact.ts.
|
|
63
|
+
capture(turn) {
|
|
64
|
+
if (this.closed)
|
|
65
|
+
throw new Error("client is closed");
|
|
66
|
+
this.buffer.push({ ...turn, body: redact(turn.body) });
|
|
67
|
+
if (this.buffer.length >= this.flushMaxTurns) {
|
|
68
|
+
void this.flush();
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
this.armTimer();
|
|
72
|
+
}
|
|
73
|
+
// Attached to the next flush; a later call before the flush replaces it.
|
|
74
|
+
checkpoint(body) {
|
|
75
|
+
if (this.closed)
|
|
76
|
+
throw new Error("client is closed");
|
|
77
|
+
this.pendingCheckpoint = redact(body);
|
|
78
|
+
this.armTimer();
|
|
79
|
+
}
|
|
80
|
+
// Sends buffered turns and any pending checkpoint. Flushes never overlap. On failure the turns
|
|
81
|
+
// go back to the front of the buffer for the next attempt and the error is reported to onError.
|
|
82
|
+
flush() {
|
|
83
|
+
if (this.inflight)
|
|
84
|
+
return this.inflight;
|
|
85
|
+
this.inflight = this.sendBuffer().finally(() => {
|
|
86
|
+
this.inflight = undefined;
|
|
87
|
+
});
|
|
88
|
+
return this.inflight;
|
|
89
|
+
}
|
|
90
|
+
setPresence(paths) {
|
|
91
|
+
return this.request("POST", "/v1/presence", { project: this.project, branch: this.branch, paths }).then(() => undefined);
|
|
92
|
+
}
|
|
93
|
+
putItems(items) {
|
|
94
|
+
const clean = items.map((i) => ({ ...i, title: redact(i.title), body: redact(i.body) }));
|
|
95
|
+
return this.request("POST", "/v1/items", { project: this.project, branch: this.branch, items: clean });
|
|
96
|
+
}
|
|
97
|
+
retract(id) {
|
|
98
|
+
return this.request("POST", "/v1/retract", { project: this.project, id }, [202, 404]);
|
|
99
|
+
}
|
|
100
|
+
fork(target, mode = "items") {
|
|
101
|
+
return this.request("POST", "/v1/fork", { project: this.project, target, mode });
|
|
102
|
+
}
|
|
103
|
+
stats() {
|
|
104
|
+
return this.request("GET", `/v1/stats?${new URLSearchParams({ project: this.project })}`);
|
|
105
|
+
}
|
|
106
|
+
// Final flush, then no more captures. Safe to call more than once.
|
|
107
|
+
async close() {
|
|
108
|
+
this.closed = true;
|
|
109
|
+
this.disarmTimer();
|
|
110
|
+
await this.flush();
|
|
111
|
+
}
|
|
112
|
+
armTimer() {
|
|
113
|
+
if (this.timer)
|
|
114
|
+
return;
|
|
115
|
+
this.timer = setTimeout(() => {
|
|
116
|
+
this.timer = undefined;
|
|
117
|
+
void this.flush();
|
|
118
|
+
}, this.flushIntervalMs);
|
|
119
|
+
this.timer.unref?.();
|
|
120
|
+
}
|
|
121
|
+
disarmTimer() {
|
|
122
|
+
if (!this.timer)
|
|
123
|
+
return;
|
|
124
|
+
clearTimeout(this.timer);
|
|
125
|
+
this.timer = undefined;
|
|
126
|
+
}
|
|
127
|
+
async sendBuffer() {
|
|
128
|
+
this.disarmTimer();
|
|
129
|
+
if (this.buffer.length === 0 && this.pendingCheckpoint === undefined)
|
|
130
|
+
return;
|
|
131
|
+
const turns = this.buffer;
|
|
132
|
+
const checkpoint = this.pendingCheckpoint;
|
|
133
|
+
this.buffer = [];
|
|
134
|
+
this.pendingCheckpoint = undefined;
|
|
135
|
+
try {
|
|
136
|
+
await this.request("POST", "/v1/capture", {
|
|
137
|
+
project: this.project,
|
|
138
|
+
branch: this.branch,
|
|
139
|
+
turns,
|
|
140
|
+
...(checkpoint === undefined ? {} : { checkpoint }),
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
catch (err) {
|
|
144
|
+
this.buffer = [...turns, ...this.buffer];
|
|
145
|
+
if (checkpoint !== undefined && this.pendingCheckpoint === undefined)
|
|
146
|
+
this.pendingCheckpoint = checkpoint;
|
|
147
|
+
const cap = this.flushMaxTurns * BUFFER_HARD_CAP_MULTIPLIER;
|
|
148
|
+
if (this.buffer.length > cap) {
|
|
149
|
+
const dropped = this.buffer.length - cap;
|
|
150
|
+
this.buffer = this.buffer.slice(dropped);
|
|
151
|
+
this.onError(new Error(`dropped ${dropped} oldest buffered turns after repeated flush failures`));
|
|
152
|
+
}
|
|
153
|
+
this.onError(toError(err));
|
|
154
|
+
if (!this.closed)
|
|
155
|
+
this.armTimer();
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
async request(method, path, body, okStatuses = [200, 201, 202]) {
|
|
159
|
+
const res = await this.fetchImpl(`${this.baseUrl}${path}`, {
|
|
160
|
+
method,
|
|
161
|
+
headers: {
|
|
162
|
+
authorization: `Bearer ${this.token}`,
|
|
163
|
+
...(body === undefined ? {} : { "content-type": "application/json" }),
|
|
164
|
+
},
|
|
165
|
+
...(body === undefined ? {} : { body: JSON.stringify(body) }),
|
|
166
|
+
});
|
|
167
|
+
const text = await res.text();
|
|
168
|
+
let parsed = undefined;
|
|
169
|
+
try {
|
|
170
|
+
parsed = text ? JSON.parse(text) : undefined;
|
|
171
|
+
}
|
|
172
|
+
catch {
|
|
173
|
+
parsed = undefined;
|
|
174
|
+
}
|
|
175
|
+
if (!okStatuses.includes(res.status)) {
|
|
176
|
+
const message = parsed?.error ?? text ?? res.statusText;
|
|
177
|
+
throw new MeshpointError(res.status, `${method} ${path} -> ${res.status}: ${message}`);
|
|
178
|
+
}
|
|
179
|
+
return parsed;
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
function toError(err) {
|
|
183
|
+
return err instanceof Error ? err : new Error(String(err));
|
|
184
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { MeshpointClient, MeshpointError, type ClientOptions } from "./client.js";
|
|
2
|
+
export { ID_RE, projectIdFromRemote } from "./project.js";
|
|
3
|
+
export type { Checkpoint, ForkResult, Item, ItemInput, Kind, Presence, RecallResponse, Stats, TurnInput } from "./types.js";
|
|
4
|
+
export { KINDS } from "./types.js";
|
|
5
|
+
export { redact, REDACTED_PREFIX } from "./redact.js";
|
package/dist/index.js
ADDED
package/dist/project.js
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
// Platform ids allow [A-Za-z0-9._-] only, so a git remote is flattened to host--owner--repo.
|
|
2
|
+
export const ID_RE = /^[A-Za-z0-9._-]{1,128}$/;
|
|
3
|
+
const SSH_SCP_RE = /^(?:[\w.-]+@)?([\w.-]+):(.+)$/;
|
|
4
|
+
// Derives the project id from a git remote URL. Accepts scp-style ssh, ssh://, https:// and git://
|
|
5
|
+
// forms. Case is folded and a trailing ".git" dropped so every clone of one repo maps to one project.
|
|
6
|
+
export function projectIdFromRemote(remote) {
|
|
7
|
+
const trimmed = remote.trim();
|
|
8
|
+
let host;
|
|
9
|
+
let path;
|
|
10
|
+
if (/^[a-z+]+:\/\//i.test(trimmed)) {
|
|
11
|
+
const url = new URL(trimmed);
|
|
12
|
+
host = url.hostname;
|
|
13
|
+
path = url.pathname;
|
|
14
|
+
}
|
|
15
|
+
else {
|
|
16
|
+
const m = SSH_SCP_RE.exec(trimmed);
|
|
17
|
+
if (!m)
|
|
18
|
+
throw new Error(`unrecognised git remote: ${remote}`);
|
|
19
|
+
host = m[1];
|
|
20
|
+
path = m[2];
|
|
21
|
+
}
|
|
22
|
+
const parts = path
|
|
23
|
+
.replace(/\.git\/?$/, "")
|
|
24
|
+
.split("/")
|
|
25
|
+
.filter(Boolean);
|
|
26
|
+
if (parts.length < 2)
|
|
27
|
+
throw new Error(`git remote has no owner/repo path: ${remote}`);
|
|
28
|
+
const id = [host, ...parts].join("--").toLowerCase().replace(/[^a-z0-9._-]/g, "-");
|
|
29
|
+
if (!ID_RE.test(id))
|
|
30
|
+
throw new Error(`derived project id is not valid: ${id}`);
|
|
31
|
+
return id;
|
|
32
|
+
}
|
package/dist/redact.d.ts
ADDED
package/dist/redact.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// Credential scrubbing before anything leaves the machine. Patterns are chosen for precision: a
|
|
2
|
+
// known token prefix, a key block, a password inside a URL, a bearer header, or a value assigned
|
|
3
|
+
// to a secret-looking name. Plain hex (git SHAs) and long words are left alone. The platform only
|
|
4
|
+
// ever receives the masked text, so a leaked prompt stays on the machine it was typed on.
|
|
5
|
+
export const REDACTED_PREFIX = "[REDACTED:";
|
|
6
|
+
const mask = (label) => `${REDACTED_PREFIX}${label}]`;
|
|
7
|
+
const RULES = [
|
|
8
|
+
{ label: "private-key", re: /-----BEGIN [A-Z ]*PRIVATE KEY-----[\s\S]*?-----END [A-Z ]*PRIVATE KEY-----/g },
|
|
9
|
+
{ label: "aws-key", re: /\b(?:AKIA|ASIA)[0-9A-Z]{16}\b/g },
|
|
10
|
+
{ label: "github-token", re: /\b(?:gh[pousr]_[A-Za-z0-9]{36,}|github_pat_[A-Za-z0-9_]{22,})\b/g },
|
|
11
|
+
{ label: "slack-token", re: /\bxox[abprs]-[A-Za-z0-9-]{10,}\b/g },
|
|
12
|
+
{ label: "stripe-key", re: /\b(?:[sr]k_(?:live|test)_[A-Za-z0-9]{10,}|whsec_[A-Za-z0-9]{10,})\b/g },
|
|
13
|
+
{ label: "google-key", re: /\bAIza[0-9A-Za-z_-]{35}\b/g },
|
|
14
|
+
{ label: "api-key", re: /\bsk-[A-Za-z0-9_-]{20,}\b/g },
|
|
15
|
+
{ label: "jwt", re: /\beyJ[A-Za-z0-9_-]{10,}\.(?:eyJ)?[A-Za-z0-9_-]{10,}\.[A-Za-z0-9_-]{10,}\b/g },
|
|
16
|
+
// Meshpoint's own tokens: base64url JSON claims, a dot, a base64url signature.
|
|
17
|
+
{ label: "token", re: /\beyJ[A-Za-z0-9_-]{20,}\.[A-Za-z0-9_-]{40,}\b/g },
|
|
18
|
+
{ label: "url-password", re: /(\b[a-z][a-z0-9+.-]*:\/\/[^\s/:@]+:)([^\s/@]+)@/gi, keep: (m) => `${m[1]}${mask("url-password")}@` },
|
|
19
|
+
{ label: "bearer", re: /(\bauthorization\s*[:=]\s*["']?bearer\s+)[A-Za-z0-9._~+/=-]{16,}/gi, keep: (m) => `${m[1]}${mask("bearer")}` },
|
|
20
|
+
{
|
|
21
|
+
label: "secret",
|
|
22
|
+
re: /(\b[A-Za-z0-9_.-]*(?:api[_-]?key|secret|token|passw(?:or)?d|pwd|private[_-]?key|access[_-]?key|credential)s?\b\s*[=:]\s*["']?)([^\s"'`,;]{8,})/gi,
|
|
23
|
+
keep: (m) => `${m[1]}${mask("secret")}`,
|
|
24
|
+
},
|
|
25
|
+
];
|
|
26
|
+
// Masks credentials in free text. Returns the input unchanged when nothing matches.
|
|
27
|
+
export function redact(text) {
|
|
28
|
+
let out = text;
|
|
29
|
+
for (const rule of RULES) {
|
|
30
|
+
out = out.replace(rule.re, (...args) => {
|
|
31
|
+
const m = args;
|
|
32
|
+
return rule.keep ? rule.keep(m) : mask(rule.label);
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
return out;
|
|
36
|
+
}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
export type Kind = "fact" | "decision" | "gotcha" | "convention" | "status" | "todo";
|
|
2
|
+
export declare const KINDS: readonly Kind[];
|
|
3
|
+
export interface Item {
|
|
4
|
+
id: string;
|
|
5
|
+
branch: string;
|
|
6
|
+
kind: Kind;
|
|
7
|
+
title: string;
|
|
8
|
+
body: string;
|
|
9
|
+
created_at: number;
|
|
10
|
+
confirmations: number;
|
|
11
|
+
retracted: number;
|
|
12
|
+
provenance: string;
|
|
13
|
+
}
|
|
14
|
+
export interface ItemInput {
|
|
15
|
+
id: string;
|
|
16
|
+
kind: Kind;
|
|
17
|
+
title: string;
|
|
18
|
+
body: string;
|
|
19
|
+
created_at?: number;
|
|
20
|
+
confirmations?: number;
|
|
21
|
+
provenance?: string;
|
|
22
|
+
}
|
|
23
|
+
export interface Checkpoint {
|
|
24
|
+
body: string;
|
|
25
|
+
created_at: number;
|
|
26
|
+
}
|
|
27
|
+
export interface Presence {
|
|
28
|
+
agent: string;
|
|
29
|
+
user: string;
|
|
30
|
+
branch: string;
|
|
31
|
+
paths: string[];
|
|
32
|
+
updated_at: number;
|
|
33
|
+
}
|
|
34
|
+
export interface RecallResponse {
|
|
35
|
+
project: string;
|
|
36
|
+
branch: string;
|
|
37
|
+
checkpoint: Checkpoint | null;
|
|
38
|
+
items: Item[];
|
|
39
|
+
generated_at: number;
|
|
40
|
+
source: "kv" | "do";
|
|
41
|
+
}
|
|
42
|
+
export interface TurnInput {
|
|
43
|
+
body: string;
|
|
44
|
+
paths?: string[];
|
|
45
|
+
at?: number;
|
|
46
|
+
}
|
|
47
|
+
export interface Stats {
|
|
48
|
+
items: number;
|
|
49
|
+
checkpoints: number;
|
|
50
|
+
turn_batches: number;
|
|
51
|
+
buffered: number;
|
|
52
|
+
presence: number;
|
|
53
|
+
bytes: number;
|
|
54
|
+
}
|
|
55
|
+
export interface ForkResult {
|
|
56
|
+
project: string;
|
|
57
|
+
items: number;
|
|
58
|
+
turn_batches: number;
|
|
59
|
+
ms: number;
|
|
60
|
+
}
|
package/dist/types.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,44 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meshpoint/sdk",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "1.0.0-rc.2",
|
|
4
|
+
"description": "Client for the Meshpoint platform: shared project context and memory for agent teams",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"meshpoint",
|
|
7
|
+
"coding-agents",
|
|
8
|
+
"memory"
|
|
9
|
+
],
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
|
+
"homepage": "https://meshpoint.dev",
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "git+https://github.com/meshpoint-dev/sdk.git"
|
|
15
|
+
},
|
|
16
|
+
"type": "module",
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=22"
|
|
19
|
+
},
|
|
20
|
+
"exports": {
|
|
21
|
+
".": {
|
|
22
|
+
"types": "./dist/index.d.ts",
|
|
23
|
+
"import": "./dist/index.js"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"files": [
|
|
27
|
+
"dist"
|
|
28
|
+
],
|
|
29
|
+
"publishConfig": {
|
|
30
|
+
"access": "public",
|
|
31
|
+
"tag": "next"
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"build": "tsc -p tsconfig.build.json",
|
|
35
|
+
"typecheck": "tsc --noEmit -p .",
|
|
36
|
+
"test": "vitest run",
|
|
37
|
+
"check": "npm run typecheck && npm test",
|
|
38
|
+
"prepublishOnly": "npm run check && npm run build"
|
|
39
|
+
},
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"typescript": "^5.6.0",
|
|
42
|
+
"vitest": "4.1.12"
|
|
43
|
+
}
|
|
44
|
+
}
|