@x12i/connectix-docs 0.1.0 → 0.1.2

package/dist/web/use-cases/run-package-simulator.md

@@ -0,0 +1,48 @@
+# Develop against the package simulator
+
+> **Use case id:** `run-package-simulator`
+> **Goal:** Use @x12i/connectix-simulator for deterministic local development and tests without the service, Credorix, or providers.
+> **Audiences:** developers
+> **Tags:** simulator, testing
+
+## Reading path
+
+1. **AI Tools and the Package Simulator** (developers) → chapters: `2-run-the-package-simulator`
+
+## From: AI Tools and the Package Simulator — 2. Run the package simulator
+
+`@x12i/connectix-simulator` is a package simulator built on `@x12i/api-simulator`. It mirrors
+the Connectix HTTP surface with deterministic fixtures so you can develop tools, callers, and
+tests without the service, Credorix, or providers:
+
+```ts
+import { createConnectToolRunner } from "@x12i/connectix-tools";
+import { createSimulatorPipelineCaller, createConnectixSimulator } from "@x12i/connectix-simulator";
+
+// In-process pipeline caller for tool runners:
+const runner = createConnectToolRunner(createSimulatorPipelineCaller());
+
+// Or raw HTTP-shaped dispatch:
+const { simulator } = createConnectixSimulator();
+await simulator.dispatch({ method: "GET", path: "/metadata" });
+```
+
+Simulated fixtures mirror the service foundation: actions `example.echo`,
+`hackernews.get_item`, `hackernews.list_top_stories`, `github.issue.create` and bindings
+`demo-echo`, `demo-hackernews`, `demo-github`.
+
+An optional HTTP entry (`startConnectixSimulatorServer`) binds `127.0.0.1:5524` in the
+api-simulator port zone (5520–5539) when a caller needs a real URL. Prefer in-process
+`dispatch()` for tests.
+
+The simulator supports **stub mode only**. Live requests return
+`ACTION_IMPLEMENTATION_UNAVAILABLE` — switch `baseUrl` to the real service for live execution.
+Because envelopes are identical, no caller code changes.
+
+## Also see
+
+- **call-connect-tools** (`call-connect-tools`) — 
+
+---
+
+_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._

package/dist/web/use-cases.html

@@ -8,6 +8,40 @@
 <link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=IBM+Plex+Mono:wght@400;500;600&display=swap" rel="stylesheet">
 <link rel="stylesheet" href="/assets/site.css">
 <link rel="stylesheet" href="/assets/extras.css">
+<script data-docify-guard="docify:serve-guard">
+(function () {
+  if (window.location.protocol !== "file:") return;
+  var cmd = "npm run docs";
+  var dir = "";
+  function render() {
+    var host = document.createElement("div");
+    host.setAttribute("role", "alert");
+    host.setAttribute("style", "position:fixed;inset:0;z-index:2147483647;display:flex;align-items:center;justify-content:center;padding:24px;margin:0;background:#0b0e14;color:#e6e9ef;font:16px/1.55 ui-sans-serif,system-ui,-apple-system,Segoe UI,Roboto,sans-serif");
+    host.innerHTML =
+      '<div style="max-width:44rem">' +
+      '<p style="margin:0 0 8px;font-size:13px;letter-spacing:.08em;text-transform:uppercase;color:#8b95a7">Docify</p>' +
+      '<h1 style="margin:0 0 12px;font-size:28px;line-height:1.2">Serve this site to view it</h1>' +
+      '<p style="margin:0 0 16px;color:#b6bfcf">This page was opened from the file system, so its stylesheets and scripts ' +
+      'cannot load and the layout you see is not the real design. Docify sites are served over HTTP.</p>' +
+      '<pre style="margin:0 0 16px;padding:14px 16px;border-radius:10px;background:#151a23;border:1px solid #232a36;overflow:auto;font:14px/1.5 ui-monospace,SFMono-Regular,Menlo,monospace;color:#e6e9ef"><code>' +
+      (dir ? "cd " + dir + "\n" : "") + cmd + '</code></pre>' +
+      '<p style="margin:0;color:#8b95a7;font-size:14px">The command builds the bundle, starts the local server, and opens the correct URL.</p>' +
+      "</div>";
+    document.documentElement.style.background = "#0b0e14";
+    if (document.body) {
+      document.body.innerHTML = "";
+      document.body.appendChild(host);
+    } else {
+      document.documentElement.appendChild(host);
+    }
+  }
+  if (document.readyState === "loading") {
+    document.addEventListener("DOMContentLoaded", render);
+  } else {
+    render();
+  }
+})();
+</script>
 </head>
 <body class="page-use-cases" style="--accent:#2f6feb;--accent-alt:#1f6e5c" data-page="use-cases">
 <div class="page-shell">
@@ -37,9 +71,13 @@
     <p class="install-lead">Knowledge SDK — install as a <strong>devDependency</strong> only (not a production runtime).</p>
     <pre class="install-cmd install-cmd-primary"><code>npm i -D @x12i/connectix-docs</code></pre>
     
+    
+    
+    
     <p class="install-more"><a href="/agents">Agents / SDK details →</a> · <a href="/agent-manifest.json">agent-manifest.json</a></p>
   </div>
 </section>
+
 <section class="section" data-hydrate="use-cases"><div id="use-cases-root"></div></section>
 <section class="section prose"><p>Each use case packs the relevant book chapters into one markdown document for humans and agents.</p>
 </section>

package/dist/web/use-cases.json

@@ -24,7 +24,13 @@
       ],
       "alsoSee": [
         "call-connect-tools"
-      ]
+      ],
+      "prerequisites": [],
+      "successCriteria": [],
+      "nextUseCases": [],
+      "scenarioIds": [],
+      "guideIds": [],
+      "troubleshooting": []
     },
     {
       "id": "call-connect-tools",
@@ -49,7 +55,13 @@
       ],
       "alsoSee": [
         "run-package-simulator"
-      ]
+      ],
+      "prerequisites": [],
+      "successCriteria": [],
+      "nextUseCases": [],
+      "scenarioIds": [],
+      "guideIds": [],
+      "troubleshooting": []
     },
     {
       "id": "run-package-simulator",
@@ -73,7 +85,13 @@
       ],
       "alsoSee": [
         "call-connect-tools"
-      ]
+      ],
+      "prerequisites": [],
+      "successCriteria": [],
+      "nextUseCases": [],
+      "scenarioIds": [],
+      "guideIds": [],
+      "troubleshooting": []
     },
     {
       "id": "catalog-extension-overview",
@@ -97,7 +115,13 @@
       ],
       "alsoSee": [
         "orient-connectix"
-      ]
+      ],
+      "prerequisites": [],
+      "successCriteria": [],
+      "nextUseCases": [],
+      "scenarioIds": [],
+      "guideIds": [],
+      "troubleshooting": []
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x12i/connectix-docs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Connectix docs knowledge SDK + deployable dist/web static site. Install the package as a devDependency only; deploy dist/web for humans.",
   "license": "UNLICENSED",
   "type": "module",
@@ -36,14 +36,14 @@
     "node": ">=22.0.0"
   },
   "dependencies": {
-    "@x12i/docify-core": "^1.0.2",
-    "@x12i/docify-sdk": "^1.0.1"
+    "@x12i/docify-core": "^1.1.1",
+    "@x12i/docify-sdk": "^1.1.0"
   },
   "devDependencies": {
-    "@x12i/docify-export": "^1.0.1",
-    "@x12i/docify-render": "^1.0.2",
-    "@x12i/docify-theme": "^1.0.4",
-    "@x12i/docify-web": "^1.0.4"
+    "@x12i/docify-export": "^1.1.2",
+    "@x12i/docify-render": "^1.1.1",
+    "@x12i/docify-theme": "^1.1.0",
+    "@x12i/docify-web": "^1.1.1"
   },
   "publishConfig": {
     "access": "public",