neatlogs 1.0.5 → 1.0.8

package/dist/opencode-plugin.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Neatlogs opencode plugin.
+ *
+ * opencode loads plugins from its config (`opencode.json` → `"plugin": [...]`)
+ * or from local `.opencode/plugin/*.ts` files. A plugin is an async factory that
+ * receives an app context and returns lifecycle hooks. This plugin instruments
+ * opencode automatically — no per-call wiring — translating opencode's run into
+ * a neatlogs span tree:
+ *
+ *   LLM   assistant turn        (from `message.updated` completion events)
+ *   TOOL  tool execution        (tool.execute.before → tool.execute.after)
+ *
+ * Every span carries `neatlogs.conversation.id` = the opencode session ID.
+ *
+ * Setup — either:
+ *   • npm package, in opencode.json: `{ "plugin": ["neatlogs"] }`, OR
+ *   • local file `.opencode/plugin/neatlogs.ts` (project) or
+ *     `~/.config/opencode/plugin/neatlogs.ts` (global):
+ *       export { NeatlogsOpencodePlugin as default } from 'neatlogs/opencode';
+ *
+ * Then set NEATLOGS_API_KEY in the environment. The plugin bootstraps neatlogs
+ * tracing on load (it runs inside opencode's own process, so it initializes the
+ * SDK itself rather than relying on a user `init()` call).
+ *
+ * Optional env:
+ *   NEATLOGS_API_KEY            required to export
+ *   NEATLOGS_WORKFLOW_NAME      logical grouping (default: "opencode")
+ *   NEATLOGS_CAPTURE_SYSTEM_PROMPT=true  capture system prompt text (default off)
+ */
+/**
+ * opencode Plugin factory. opencode calls this with its app context and uses the
+ * returned hook object. Typed loosely to avoid a hard dependency on
+ * `@opencode-ai/plugin`.
+ */
+declare const NeatlogsOpencodePlugin: (_ctx: any) => Promise<Record<string, any>>;
+declare const neatlogsOpencodePlugin: (_ctx: any) => Promise<Record<string, any>>;
+
+export { NeatlogsOpencodePlugin, NeatlogsOpencodePlugin as default, neatlogsOpencodePlugin };