@byokit/openclaw 0.1.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.
Files changed (64) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/LICENSE +202 -0
  3. package/README.md +174 -0
  4. package/dist/approvals.d.ts +29 -0
  5. package/dist/approvals.js +200 -0
  6. package/dist/bridge.d.ts +78 -0
  7. package/dist/bridge.js +345 -0
  8. package/dist/classify.d.ts +4 -0
  9. package/dist/classify.js +14 -0
  10. package/dist/config.d.ts +13 -0
  11. package/dist/config.js +74 -0
  12. package/dist/constants.d.ts +3 -0
  13. package/dist/constants.js +13 -0
  14. package/dist/device.d.ts +63 -0
  15. package/dist/device.js +192 -0
  16. package/dist/engine.d.ts +43 -0
  17. package/dist/engine.js +212 -0
  18. package/dist/generated/events.d.ts +61 -0
  19. package/dist/generated/events.js +1 -0
  20. package/dist/generated/methods.d.ts +2368 -0
  21. package/dist/generated/methods.js +1 -0
  22. package/dist/generated/params.d.ts +1717 -0
  23. package/dist/generated/params.js +5 -0
  24. package/dist/generated/report.json +1356 -0
  25. package/dist/index.d.ts +4 -0
  26. package/dist/index.js +5 -0
  27. package/dist/kit.d.ts +108 -0
  28. package/dist/kit.js +655 -0
  29. package/dist/link.d.ts +24 -0
  30. package/dist/link.js +273 -0
  31. package/dist/members.d.ts +11 -0
  32. package/dist/members.js +23 -0
  33. package/dist/migrate.d.ts +22 -0
  34. package/dist/migrate.js +118 -0
  35. package/dist/notices.d.ts +9 -0
  36. package/dist/notices.js +75 -0
  37. package/dist/routes.d.ts +9 -0
  38. package/dist/routes.js +15 -0
  39. package/dist/routes.json +398 -0
  40. package/dist/runs.d.ts +14 -0
  41. package/dist/runs.js +110 -0
  42. package/dist/signin.d.ts +24 -0
  43. package/dist/signin.js +251 -0
  44. package/dist/testing/contract.d.ts +12 -0
  45. package/dist/testing/contract.js +250 -0
  46. package/dist/testing/fake-gateway.d.ts +19 -0
  47. package/dist/testing/fake-gateway.js +378 -0
  48. package/dist/testing/index.d.ts +3 -0
  49. package/dist/testing/index.js +4 -0
  50. package/dist/testing/model-stub.d.ts +29 -0
  51. package/dist/testing/model-stub.js +182 -0
  52. package/dist/transport.d.ts +22 -0
  53. package/dist/transport.js +94 -0
  54. package/dist/types.d.ts +125 -0
  55. package/dist/types.js +2 -0
  56. package/dist/words.d.ts +12 -0
  57. package/dist/words.js +26 -0
  58. package/dist/words.json +20 -0
  59. package/engine/package-lock.json +4680 -0
  60. package/engine/package.json +1 -0
  61. package/package.json +68 -0
  62. package/plugin/index.js +183 -0
  63. package/plugin/package.json +1 -0
  64. package/policy/policy.mjs +197 -0
@@ -0,0 +1,4 @@
1
+ export { ENGINE_VERSION, OPERATOR_SCOPES, PROTOCOL_VERSION } from './constants.ts';
2
+ export type { Approval, CallOptions, Decision, GatewayEventName, GatewayEventPayload, GatewayMethod, GatewayParams, GatewayResult, GatewayTransport, GateResult, Hello, KitState, Member, Route, RunEnd, RunEvent, RunRef, RunSpec, SignInView, ToolHost, ToolSpec, } from './types.ts';
3
+ export { OpenClawKit, type KitOptions, type RetainedLogin } from './kit.ts';
4
+ export { stateWords, toAccountView, words, type AccountView, type WordKey } from './words.ts';
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ // @byokit/openclaw — the OpenClaw runtime kit, host side (docs/runtime-kits.md 5.3). Entries: `.` (this),
2
+ // `./device` (portable), `./link` (Node host-side adapter), `./testing` (fakes and contract suite).
3
+ export { ENGINE_VERSION, OPERATOR_SCOPES, PROTOCOL_VERSION } from "./constants.js";
4
+ export { OpenClawKit } from "./kit.js";
5
+ export { stateWords, toAccountView, words } from "./words.js";
package/dist/kit.d.ts ADDED
@@ -0,0 +1,108 @@
1
+ import type { Approval, CallOptions, Decision, GatewayEventName, GatewayEventPayload, GatewayMethod, GatewayParams, GatewayResult, GatewayTransport, Hello, KitState, Member, Route, RunEnd, RunEvent, RunSpec, SignInView, ToolHost, ToolSpec } from './types.ts';
2
+ export type KitOptions = {
3
+ stateDir: string;
4
+ engineDir?: string;
5
+ npmPath?: string;
6
+ enginePath?: string[];
7
+ plugin?: {
8
+ id?: string;
9
+ };
10
+ bridge?: {
11
+ socketName?: string;
12
+ paramPrefix?: string;
13
+ };
14
+ tools?: ToolSpec[];
15
+ host?: ToolHost;
16
+ permitted?: (tool: string) => boolean;
17
+ gateBuiltins?: boolean;
18
+ config?: object;
19
+ installPolicy?: {
20
+ trustedSkills: string;
21
+ ownRoots: string[];
22
+ };
23
+ callbackPort?: number;
24
+ approvalTimeoutMs?: number;
25
+ transport?: (ctx: {
26
+ port: number;
27
+ token: string;
28
+ identityPath: string;
29
+ bridgeSock: string;
30
+ }) => GatewayTransport;
31
+ spawnEngine?: boolean;
32
+ onState?: (s: KitState) => void;
33
+ log?: (line: string) => void;
34
+ };
35
+ export type RetainedLogin = {
36
+ path: string;
37
+ } | {
38
+ record: Record<string, unknown>;
39
+ };
40
+ export declare class OpenClawKit {
41
+ private readonly engine;
42
+ private readonly o;
43
+ private current;
44
+ private transport?;
45
+ private greeting?;
46
+ private members?;
47
+ private readonly bridge;
48
+ private readonly approvalsCtl;
49
+ private listeners;
50
+ private off;
51
+ private starting?;
52
+ private stopping;
53
+ private failures;
54
+ constructor(o: KitOptions);
55
+ private setState;
56
+ get state(): KitState;
57
+ prepare(): Promise<void>;
58
+ start(): Promise<void>;
59
+ private connect;
60
+ private disconnect;
61
+ private closed;
62
+ stop(): Promise<void>;
63
+ private request;
64
+ call<M extends GatewayMethod>(method: M, params: GatewayParams<M>, o?: CallOptions): Promise<GatewayResult<M>>;
65
+ callDynamic(method: string, params?: unknown, o?: CallOptions): Promise<unknown>;
66
+ get hello(): Hello | undefined;
67
+ onEvent<E extends GatewayEventName>(event: E | '*', fn: (payload: GatewayEventPayload<E>, event: E) => void): () => void;
68
+ ensureMember(member: Member): Promise<{
69
+ agentId: string;
70
+ workspace: string;
71
+ }>;
72
+ private signInCtx;
73
+ routes(): Route[];
74
+ providers(member: Member): Promise<string[]>;
75
+ signedIn(member: Member, provider: string): Promise<boolean>;
76
+ signIn(member: Member, o: {
77
+ authChoice: string;
78
+ via?: 'browser' | 'code';
79
+ }, on: (v: SignInView) => void): {
80
+ paste(text: string): void;
81
+ cancel(): void;
82
+ done: Promise<SignInView>;
83
+ };
84
+ signOut(member: Member, provider: string): Promise<void>;
85
+ migrateRetainedLogin(member: Member, source: RetainedLogin): Promise<'staged' | 'nothing' | 'failed'>;
86
+ confirmRetainedLogin(member: Member, source: RetainedLogin): Promise<boolean>;
87
+ private runs;
88
+ run(spec: RunSpec, on?: (e: RunEvent) => void): Promise<RunEnd>;
89
+ steer(sessionKey: string, text: string): Promise<void>;
90
+ abort(sessionKey: string): Promise<void>;
91
+ approvals(member?: Member): Approval[];
92
+ onApproval(fn: (a: Approval, change: 'added' | 'resolved') => void): () => void;
93
+ decide(id: string, d: Decision): Promise<void>;
94
+ allowOnce(rule: {
95
+ keyPrefix: string;
96
+ tool: string;
97
+ input?: (i: Record<string, unknown>) => boolean;
98
+ }, ms: number): void;
99
+ disallowOnce(): void;
100
+ patchConfig(patch: object, o?: {
101
+ agentId?: string;
102
+ }): Promise<void>;
103
+ memoryLimited(member: Member): boolean;
104
+ doctorContext(): {
105
+ entry: string;
106
+ env: Record<string, string>;
107
+ };
108
+ }