@sponsio/sdk 0.1.0-alpha.3 → 0.2.0-alpha.4

package/dist/cli/onboard.d.ts

@@ -0,0 +1,88 @@
+/**
+ * ``sponsio onboard`` — TypeScript-first onboarding for
+ * Node.js agent codebases.
+ *
+ * 1. Static-scan the tree for tool definitions (same engine as
+ *    ``scan``).
+ * 2. Write a temp ``.json`` inventory and, when the Python ``sponsio``
+ *    CLI is on ``PATH``, run
+ *    ``sponsio scan <inventory.json> -o <sponsio.yaml>`` for the
+ *    same inference / starter-pack / pack behaviour as
+ *    ``sponsio onboard .`` in a Python project.
+ * 3. If ``sponsio`` is missing, write a *minimal* ``sponsio.yaml``
+ *    (observe mode + name-heuristic NL ``E:`` strings that the TS
+ *    runtime can parse) so ``new Sponsio({ config: ... })`` works
+ *    without a Python install.
+ *
+ * The TS SDK has no LTL / pack / sto runtime — the conservative NL
+ * fallback is intentionally det-only. Users who install ``sponsio``
+ * get the full Python output (including includes / structured rules)
+ * and the same file still loads in TS (unsupported entries are
+ * skipped with a one-time warning in ``@sponsio/sdk``).
+ */
+export type TsOnboardFramework = "langgraph" | "vercel" | "openai" | "mcp" | "claude" | "google_adk" | "none";
+export interface OnboardOptions {
+    /** Project root; ``sponsio.yaml`` is written under this path (unless a ``.yaml`` file path is given as target). */
+    target: string;
+    /** Agent id; default ``"agent"`` to match ``sponsio scan --agent`` / ``sponsio onboard``. */
+    agent: string;
+    mode: "observe" | "enforce";
+    /** Overwrite an existing ``sponsio.yaml`` at the same path. */
+    force: boolean;
+    /** Pass ``--llm`` through to ``sponsio scan`` (requires a provider from env; see ``docs/cli.md``). */
+    llm: boolean;
+    /**
+     * Never shell out to Python; always use the det-only NL fallback
+     * (for CI, or to guarantee zero Python in the build graph).
+     */
+    pyNever: boolean;
+    /**
+     * After writing ``sponsio.yaml``, push it to the local dashboard at
+     * ``--push-url`` so it surfaces on the Scan page + Contract Library.
+     * Passed through to ``sponsio scan --push`` when Python is
+     * available; silently skipped by the fallback path (no dashboard
+     * client in the TS scanner).
+     */
+    push?: boolean;
+    pushUrl?: string;
+}
+export interface OnboardResult {
+    outPath: string;
+    root: string;
+    agent: string;
+    /** ``python`` = ``sponsio scan <json>`` succeeded. ``fallback`` = wrote minimal yaml without ``sponsio``. */
+    method: "python" | "fallback";
+    toolCount: number;
+    /** Single-line user-facing message (for stderr in the CLI). */
+    message: string;
+    wrapSnippet: string;
+}
+/**
+ * Suggest 1–3 deterministic ``E:`` strings that the TS ``parseNl`` can
+ * compile — conservative defaults when the Python CLI is missing.
+ */
+export declare function suggestDetNlContracts(names: string[]): {
+    E: string;
+}[];
+/**
+ * Heuristic framework id from the nearest ``package.json`` in
+ * ``root`` — used for the printed TypeScript wrap snippet only.
+ */
+export declare function detectFramework(root: string): TsOnboardFramework;
+/**
+ * Assemble a minimal, TS-runtime-friendly ``sponsio.yaml`` when the
+ * ``sponsio`` CLI is unavailable.
+ */
+export declare function buildFallbackPayload(toolNames: string[], inv: {
+    tools: unknown[];
+}, agent: string, mode: "observe" | "enforce"): Record<string, unknown>;
+/**
+ * The full ``onboard`` operation — used by the CLI and (optionally)
+ * library callers.
+ */
+export declare function runOnboard(opts: OnboardOptions): Promise<OnboardResult>;
+/**
+ * ``main`` for ``sponsio onboard ...`` — *sync entry from cli.ts*.
+ */
+export declare function runOnboardCli(argv: string[]): Promise<void>;
+//# sourceMappingURL=onboard.d.ts.map

package/dist/cli/onboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboard.d.ts","sourceRoot":"","sources":["../../src/cli/onboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAaH,MAAM,MAAM,kBAAkB,GAC1B,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,YAAY,GACZ,MAAM,CAAC;AAEX,MAAM,WAAW,cAAc;IAC7B,mHAAmH;IACnH,MAAM,EAAE,MAAM,CAAC;IACf,6FAA6F;IAC7F,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,SAAS,GAAG,SAAS,CAAC;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,OAAO,CAAC;IACf,sGAAsG;IACtG,GAAG,EAAE,OAAO,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,6GAA6G;IAC7G,MAAM,EAAE,QAAQ,GAAG,UAAU,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG;IAAE,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAuBtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAoBhE;AAoGD;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EAAE,EACnB,GAAG,EAAE;IAAE,KAAK,EAAE,OAAO,EAAE,CAAA;CAAE,EACzB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,SAAS,GAAG,SAAS,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUzB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAyJ7E;AA2SD;;GAEG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6EjE"}