openpond-sdk 0.0.3 → 0.0.4
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/README.md +44 -8
- package/dist/index.js +259 -67
- package/dist/index.js.map +2 -2
- package/dist/types/packages/sdk/src/index.d.ts +1 -1
- package/dist/types/packages/sdk/src/index.d.ts.map +1 -1
- package/dist/types/packages/sdk/src/work.d.ts +50 -0
- package/dist/types/packages/sdk/src/work.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -10,7 +10,7 @@ export declare function createOpenPondClient(options: OpenPondClientOptions): Op
|
|
|
10
10
|
export type { OpenPondClientOptions } from "./types.js";
|
|
11
11
|
export { OpenPondWorkClient } from "./work.js";
|
|
12
12
|
export { OpenPondApiError } from "../../cloud/src/api/core.js";
|
|
13
|
-
export type { OpenPondWorkEvent, OpenPondWorkHistoryMessage, OpenPondWorkOutput, OpenPondWorkRunInput, OpenPondWorkRunResult, } from "./work.js";
|
|
13
|
+
export type { OpenPondWorkEvent, OpenPondWorkCleanup, OpenPondWorkHistoryMessage, OpenPondWorkInputFile, OpenPondWorkLifecycle, OpenPondWorkOutput, OpenPondWorkOutputPersistenceContext, OpenPondWorkRunInput, OpenPondWorkRunResult, } from "./work.js";
|
|
14
14
|
export * from "../../cloud/src/sandbox/client.js";
|
|
15
15
|
export * from "../../cloud/src/sandbox/types/index.js";
|
|
16
16
|
export { getOpChatModel, getOpChatProvider, listOpChatModels, listOpChatProviders, resolveOpChatApiBaseUrl, sendHostedChatTurn, streamHostedChatTurn, } from "../../cloud/src/hosted-chat.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAExD,qBAAa,cAAc;IACzB,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;gBAEtB,OAAO,EAAE,qBAAqB;CAmB3C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,cAAc,CAEnF;AAED,YAAY,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,YAAY,EACV,iBAAiB,EACjB,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,WAAW,CAAC;AAEnB,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,uBAAuB,GACxB,MAAM,gCAAgC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,qBAAqB,EAC3B,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAExD,qBAAa,cAAc;IACzB,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;gBAEtB,OAAO,EAAE,qBAAqB;CAmB3C;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,cAAc,CAEnF;AAED,YAAY,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,YAAY,EACV,iBAAiB,EACjB,mBAAmB,EACnB,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,oCAAoC,EACpC,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,WAAW,CAAC;AAEnB,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,uBAAuB,GACxB,MAAM,gCAAgC,CAAC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { OpenPondSandboxClient } from "../../cloud/src/sandbox/client.js";
|
|
2
2
|
import type { SandboxFileDownloadResponse, SandboxRecord } from "../../cloud/src/sandbox/types/index.js";
|
|
3
|
+
export type OpenPondWorkCleanup = "keep" | "stop" | "delete";
|
|
3
4
|
export type OpenPondWorkHistoryMessage = {
|
|
4
5
|
role: "user" | "assistant";
|
|
5
6
|
content: string;
|
|
@@ -13,6 +14,34 @@ export type OpenPondWorkOutput = {
|
|
|
13
14
|
isBinary: boolean | null;
|
|
14
15
|
previewable: boolean;
|
|
15
16
|
};
|
|
17
|
+
export type OpenPondWorkInputFile = {
|
|
18
|
+
id: string;
|
|
19
|
+
name: string;
|
|
20
|
+
contentsBase64: string;
|
|
21
|
+
mimeType?: string;
|
|
22
|
+
checksumSha256?: string;
|
|
23
|
+
revision?: number;
|
|
24
|
+
metadata?: Record<string, unknown>;
|
|
25
|
+
};
|
|
26
|
+
export type OpenPondWorkOutputPersistenceContext = {
|
|
27
|
+
output: OpenPondWorkOutput;
|
|
28
|
+
/** Downloads and verifies the complete output at most once. */
|
|
29
|
+
download: () => Promise<SandboxFileDownloadResponse>;
|
|
30
|
+
};
|
|
31
|
+
export type OpenPondWorkLifecycle = {
|
|
32
|
+
cleanupPolicy: OpenPondWorkCleanup;
|
|
33
|
+
persistence: {
|
|
34
|
+
status: "not_requested" | "not_needed" | "running" | "complete" | "failed";
|
|
35
|
+
outputCount: number;
|
|
36
|
+
persistedCount: number;
|
|
37
|
+
error?: string;
|
|
38
|
+
};
|
|
39
|
+
cleanup: {
|
|
40
|
+
status: "not_requested" | "running" | "complete" | "pending" | "failed";
|
|
41
|
+
finalSandboxState?: SandboxRecord["state"];
|
|
42
|
+
error?: string;
|
|
43
|
+
};
|
|
44
|
+
};
|
|
16
45
|
export type OpenPondWorkEvent = {
|
|
17
46
|
type: "status";
|
|
18
47
|
message: string;
|
|
@@ -33,12 +62,24 @@ export type OpenPondWorkEvent = {
|
|
|
33
62
|
} | {
|
|
34
63
|
type: "output";
|
|
35
64
|
output: OpenPondWorkOutput;
|
|
65
|
+
} | {
|
|
66
|
+
type: "persistence";
|
|
67
|
+
output: OpenPondWorkOutput;
|
|
68
|
+
status: "started" | "succeeded" | "failed";
|
|
69
|
+
error?: string;
|
|
70
|
+
} | {
|
|
71
|
+
type: "cleanup";
|
|
72
|
+
policy: OpenPondWorkCleanup;
|
|
73
|
+
status: "started" | "complete" | "pending" | "failed";
|
|
74
|
+
sandboxState?: SandboxRecord["state"];
|
|
75
|
+
error?: string;
|
|
36
76
|
} | {
|
|
37
77
|
type: "done";
|
|
38
78
|
sandboxId: string;
|
|
39
79
|
text: string;
|
|
40
80
|
steps: number;
|
|
41
81
|
outputs: OpenPondWorkOutput[];
|
|
82
|
+
lifecycle: OpenPondWorkLifecycle;
|
|
42
83
|
};
|
|
43
84
|
export type OpenPondWorkRunInput = {
|
|
44
85
|
prompt: string;
|
|
@@ -53,6 +94,14 @@ export type OpenPondWorkRunInput = {
|
|
|
53
94
|
timeoutSeconds?: number;
|
|
54
95
|
signal?: AbortSignal;
|
|
55
96
|
metadata?: Record<string, unknown>;
|
|
97
|
+
/** Defaults to keep for backwards compatibility. First-party Work callers use delete. */
|
|
98
|
+
cleanup?: OpenPondWorkCleanup;
|
|
99
|
+
/** Required before delete when a turn creates outputs, unless discardOutputs is true. */
|
|
100
|
+
persistOutput?: (context: OpenPondWorkOutputPersistenceContext) => void | Promise<void>;
|
|
101
|
+
/** Explicitly allows delete to discard detected outputs. */
|
|
102
|
+
discardOutputs?: boolean;
|
|
103
|
+
/** Durable outputs or other caller-owned files to stage into fresh compute. */
|
|
104
|
+
inputs?: OpenPondWorkInputFile[];
|
|
56
105
|
onEvent?: (event: OpenPondWorkEvent) => void | Promise<void>;
|
|
57
106
|
};
|
|
58
107
|
export type OpenPondWorkRunResult = {
|
|
@@ -60,6 +109,7 @@ export type OpenPondWorkRunResult = {
|
|
|
60
109
|
text: string;
|
|
61
110
|
steps: number;
|
|
62
111
|
outputs: OpenPondWorkOutput[];
|
|
112
|
+
lifecycle: OpenPondWorkLifecycle;
|
|
63
113
|
};
|
|
64
114
|
type WorkClientInput = {
|
|
65
115
|
apiKey: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"work.d.ts","sourceRoot":"","sources":["../../../../../src/work.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,KAAK,EACV,2BAA2B,EAE3B,aAAa,EACd,MAAM,wCAAwC,CAAC;
|
|
1
|
+
{"version":3,"file":"work.d.ts","sourceRoot":"","sources":["../../../../../src/work.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,KAAK,EACV,2BAA2B,EAE3B,aAAa,EACd,MAAM,wCAAwC,CAAC;AAYhD,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE7D,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG;IACjD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,OAAO,CAAC,2BAA2B,CAAC,CAAC;CACtD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,aAAa,EAAE,mBAAmB,CAAC;IACnC,WAAW,EAAE;QACX,MAAM,EAAE,eAAe,GAAG,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;QAC3E,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,EAAE,MAAM,CAAC;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACP,MAAM,EAAE,eAAe,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;QACxE,iBAAiB,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;QAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACnC;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CAC/B,GACD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACnC;IACE,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,GACD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GAC9C;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;IACtD,YAAY,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,SAAS,EAAE,qBAAqB,CAAC;CAClC,CAAC;AAEN,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,yFAAyF;IACzF,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,yFAAyF;IACzF,aAAa,CAAC,EAAE,CACd,OAAO,EAAE,oCAAoC,KAC1C,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,4DAA4D;IAC5D,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,SAAS,EAAE,qBAAqB,CAAC;CAClC,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,qBAAqB,CAAC;CAClC,CAAC;AAEF,qBAAa,kBAAkB;;gBAMjB,KAAK,EAAE,eAAe;IAO5B,GAAG,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA2GhE,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8IrD,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,kBAAkB,GAAG,MAAM,GAClC,OAAO,CAAC,2BAA2B,CAAC;CA4IxC"}
|