ovrule-lab 0.2.1 → 0.2.2

package/README.md

@@ -8,7 +8,7 @@ TypeScript client for Ovrule case-file classification, guardrails, and receipt v
 npm install ovrule-lab
 ```
 
-On the first successful `classify()` or `guard()` call in a process, the SDK prints a one-line ready message plus a permalink to the created case. Later successful audits print only the case permalink. Set `OVRULE_QUIET=1` to suppress those logs.
+On the first successful `classify()` or `guard()` call in a process, the SDK prints the full Ovrule ASCII banner plus a permalink to the created case. Later successful audits print only the case permalink. Set `OVRULE_QUIET=1` to suppress all SDK logs. You can also run `npx ovrule-lab` at any time to print the banner manually.
 
 ## 1. Simple classify
 

package/bin/ovrule-lab

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "./welcome.js";

package/bin/welcome.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { logBanner } from "../dist/banner.js";
+
+logBanner();

package/dist/banner.d.ts

@@ -0,0 +1,5 @@
+export declare const SDK_VERSION = "0.2.2";
+export declare function isQuietModeEnabled(): boolean;
+export declare function renderBanner(): string;
+export declare function logBanner(): void;
+export declare function getDefaultBaseUrl(): string;

package/dist/banner.js

@@ -0,0 +1,47 @@
+const DEFAULT_OVRULE_BASE_URL = "https://decision-receipt-lab.vercel.app";
+export const SDK_VERSION = "0.2.2";
+export function isQuietModeEnabled() {
+    return (typeof process !== "undefined" &&
+        typeof process.env === "object" &&
+        typeof process.env.OVRULE_QUIET !== "undefined" &&
+        process.env.OVRULE_QUIET !== "");
+}
+export function renderBanner() {
+    const reset = "\x1b[0m";
+    const dim = "\x1b[2m";
+    const bold = "\x1b[1m";
+    const cyan = "\x1b[36m";
+    const magenta = "\x1b[35m";
+    const yellow = "\x1b[33m";
+    return [
+        "",
+        `${bold}${cyan}   ╔═══════════════════════════════════════════════╗${reset}`,
+        `${bold}${cyan}   ║${reset}   ${bold}O${reset}${magenta}━━${reset}${bold}V${reset}   ${bold}Ovrule${reset} · SDK v${SDK_VERSION}                  ${bold}${cyan}║${reset}`,
+        `${bold}${cyan}   ║${reset}         ${dim}Auditable receipts for AI agents${reset}      ${bold}${cyan}║${reset}`,
+        `${bold}${cyan}   ╚═══════════════════════════════════════════════╝${reset}`,
+        "",
+        `   ${bold}Quickstart${reset}`,
+        `   ${dim}import { classify } from "ovrule-lab";${reset}`,
+        `   ${dim}const receipt = await classify("your agent action", {${reset}`,
+        `   ${dim}  baseUrl: "${DEFAULT_OVRULE_BASE_URL}"${reset}`,
+        `   ${dim}});${reset}`,
+        "",
+        `   ${bold}Methods${reset}`,
+        `   ${dim}classify(action, opts)${reset}   — full case file audit`,
+        `   ${dim}guard(action, opts)${reset}      — returns { allowed, decision, ... }`,
+        `   ${dim}verify(receipt, sig, opts)${reset} — verify a signed receipt`,
+        "",
+        `   ${bold}Docs${reset}     ${yellow}${DEFAULT_OVRULE_BASE_URL}/docs${reset}`,
+        `   ${bold}GitHub${reset}   ${yellow}https://github.com/elakumuk/decision-receipt-lab${reset}`,
+        "",
+    ].join("\n");
+}
+export function logBanner() {
+    if (isQuietModeEnabled()) {
+        return;
+    }
+    console.info(renderBanner());
+}
+export function getDefaultBaseUrl() {
+    return DEFAULT_OVRULE_BASE_URL;
+}

package/dist/index.js

@@ -1,12 +1,5 @@
-const DEFAULT_OVRULE_BASE_URL = "https://decision-receipt-lab.vercel.app";
-const SDK_VERSION = "0.2.1";
+import { getDefaultBaseUrl, isQuietModeEnabled, logBanner } from "./banner.js";
 let hasShownReadyMessage = false;
-function isQuietModeEnabled() {
-    return (typeof process !== "undefined" &&
-        typeof process.env === "object" &&
-        typeof process.env.OVRULE_QUIET !== "undefined" &&
-        process.env.OVRULE_QUIET !== "");
-}
 function getConsoleBaseUrl(baseUrl) {
     if (baseUrl) {
         return baseUrl;
@@ -14,7 +7,7 @@ function getConsoleBaseUrl(baseUrl) {
     if (typeof window !== "undefined" && window.location?.origin) {
         return window.location.origin;
     }
-    return DEFAULT_OVRULE_BASE_URL;
+    return getDefaultBaseUrl();
 }
 function logSuccessfulAudit(receipt, baseUrl) {
     if (isQuietModeEnabled()) {
@@ -22,7 +15,7 @@ function logSuccessfulAudit(receipt, baseUrl) {
     }
     const caseUrl = `${getConsoleBaseUrl(baseUrl)}/case/${receipt.receiptId}`;
     if (!hasShownReadyMessage) {
-        console.info(`[ovrule-lab v${SDK_VERSION}] ready · docs: ${DEFAULT_OVRULE_BASE_URL}/docs`);
+        logBanner();
         hasShownReadyMessage = true;
     }
     console.info(`[ovrule-lab] ✓ audited via ${caseUrl}`);
@@ -77,7 +70,7 @@ export class OvruleClient {
     baseUrl;
     fetchImpl;
     constructor(options = {}) {
-        this.baseUrl = options.baseUrl?.replace(/\/$/, "") ?? DEFAULT_OVRULE_BASE_URL;
+        this.baseUrl = options.baseUrl?.replace(/\/$/, "") ?? getDefaultBaseUrl();
         this.fetchImpl = options.fetch ?? globalThis.fetch;
         if (!this.fetchImpl) {
             throw new Error("No fetch implementation available. Pass one in OvruleClient options.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ovrule-lab",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "TypeScript SDK for Ovrule case-file classification, guardrails, and receipt verification.",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,8 +14,13 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "bin/ovrule-lab",
+    "bin/welcome.js"
   ],
+  "bin": {
+    "ovrule-lab": "bin/ovrule-lab"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "clean": "rm -rf dist",
@@ -33,5 +38,6 @@
   "sideEffects": false,
   "devDependencies": {
     "typescript": "^5.8.3"
-  }
+  },
+  "author": ""
 }