mirror of
https://github.com/garrytan/gbrain.git
synced 2026-07-30 11:22:34 +00:00
d9eb027bdd
Add the OpenClaw-required top-level id to openclaw.plugin.json, export a direct register(api) entrypoint from src/openclaw-context-engine.ts, add a manifest regression test, and document that skillpack harvest must preserve OpenClaw-native manifest fields (id, configSchema, contracts). llms bundles regenerated (bun run build:llms) — no content drift. Co-authored-by: Garry Tan <garrytan@gmail.com> Co-authored-by: Filip <FilipHarald@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
89 lines
3.2 KiB
TypeScript
89 lines
3.2 KiB
TypeScript
/**
|
|
* OpenClaw plugin entry point for gbrain-context engine.
|
|
*
|
|
* Registers a deterministic context engine that injects live temporal/spatial
|
|
* context on every turn. Prevents the "time warp" bug class where compacted
|
|
* sessions lose track of the user's current time, location, and state.
|
|
*
|
|
* Enable in openclaw.json:
|
|
* plugins.slots.contextEngine: "gbrain-context"
|
|
*
|
|
* @module
|
|
*/
|
|
|
|
/**
|
|
* OpenClaw plugin entry — registers gbrain-context engine.
|
|
*
|
|
* This file is discovered via the `openclaw.extensions` field in package.json.
|
|
* It requires the OpenClaw plugin SDK at runtime (available when loaded by the
|
|
* gateway). The core engine logic in `./core/context-engine.ts` is SDK-free
|
|
* and independently testable.
|
|
*/
|
|
|
|
import { createGBrainContextEngine, ENGINE_ID } from './core/context-engine.ts';
|
|
import type { ResolveEntitiesFn } from './core/context/reflex.ts';
|
|
|
|
/**
|
|
* Plugin-entry shape consumed by the OpenClaw host. The host's plugin loader
|
|
* reads `id`, `name`, `description`, and `register` directly off the default
|
|
* export — pre-v0.32.5 we wrapped this in `definePluginEntry` from the
|
|
* OpenClaw plugin SDK, but that created an unnecessary build-time import of
|
|
* a runtime-only package. The wrapper was a type-tag (no behavior), so the
|
|
* bare object is equivalent at the host's consumption point. Codex outside-
|
|
* voice F1 flagged the SDK import as the gate keeping the e2e test brittle;
|
|
* removing it unblocks `mock.module()`-based plugin-shape testing AND removes
|
|
* a class of module-load failures in non-Node-resolving runtimes.
|
|
*/
|
|
interface PluginEntry {
|
|
id: string;
|
|
name: string;
|
|
description: string;
|
|
register(api: PluginApi): void;
|
|
}
|
|
|
|
interface PluginApi {
|
|
registerContextEngine(id: string, factory: (ctx: PluginCtx) => unknown): void;
|
|
}
|
|
|
|
interface PluginCtx {
|
|
workspaceDir: string;
|
|
/**
|
|
* Retrieval Reflex (#1981, D1=A): OPTIONAL host-provided resolve capability.
|
|
* When the OpenClaw host supplies it (backed by the gbrain connection the
|
|
* gateway already holds), the deterministic pointer layer resolves through it
|
|
* — works on every engine, including PGLite where a second connection is
|
|
* impossible. Narrow by contract: candidates in, a pointer block out (no raw
|
|
* SQL crosses the boundary). Absent → the engine falls to the serve-IPC /
|
|
* Postgres-direct ladder. Additive + guarded, so older hosts (which don't
|
|
* provide it) keep working unchanged — no pluginApi floor bump needed.
|
|
*/
|
|
resolveEntities?: ResolveEntitiesFn;
|
|
/** Back-compat alias some hosts may use for the same capability. */
|
|
brainQuery?: ResolveEntitiesFn;
|
|
[key: string]: unknown;
|
|
}
|
|
|
|
export function register(api: PluginApi) {
|
|
api.registerContextEngine(ENGINE_ID, (ctx: PluginCtx) => {
|
|
const hostResolver =
|
|
typeof ctx.resolveEntities === 'function'
|
|
? ctx.resolveEntities
|
|
: typeof ctx.brainQuery === 'function'
|
|
? ctx.brainQuery
|
|
: undefined;
|
|
return createGBrainContextEngine({
|
|
workspaceDir: ctx.workspaceDir,
|
|
resolveEntities: hostResolver,
|
|
});
|
|
});
|
|
}
|
|
|
|
const entry: PluginEntry = {
|
|
id: 'gbrain-context-engine',
|
|
name: 'GBrain Context Engine',
|
|
description: 'Deterministic temporal/spatial context injection on every turn',
|
|
register,
|
|
};
|
|
|
|
export default entry;
|