Merge pull request #197 from PredicateSystems/rename2

rename sdk to predicatesystems/runtime

Author: rcholic

.github/workflows/release.yml

@@ -170,7 +170,7 @@ jobs:
         npm profile get --registry https://registry.npmjs.org --json || echo "WARN: cannot read npm profile (continuing)"
         echo ""
         echo "=== Sanity: does package already exist? (ok if 404) ==="
-        npm view @predicatesystems/sdk version --registry https://registry.npmjs.org --json || echo "INFO: @predicatesystems/sdk not found yet (expected for first publish)"
+        npm view @predicatesystems/runtime version --registry https://registry.npmjs.org --json || echo "INFO: @predicatesystems/runtime not found yet (expected for first publish)"
         
     - name: Publish to npm
       run: |
@@ -185,14 +185,55 @@ jobs:
         tag_name: v${{ steps.version.outputs.version }}
         name: Release v${{ steps.version.outputs.version }}
         body: |
-          Release v${{ steps.version.outputs.version }} of @predicatesystems/sdk
+          Release v${{ steps.version.outputs.version }} of @predicatesystems/runtime
 
           ## Installation
           ```bash
-          npm install @predicatesystems/sdk@${{ steps.version.outputs.version }}
+          npm install @predicatesystems/runtime@${{ steps.version.outputs.version }}
           ```
         draft: false
         prerelease: false
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  publish-compat-shim:
+    runs-on: ubuntu-latest
+    needs: build-and-publish
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        registry-url: 'https://registry.npmjs.org'
+        scope: '@predicatesystems'
+        always-auth: true
+
+    - name: Extract version from tag or input
+      id: version
+      run: |
+        if [ "${{ github.event_name }}" == "release" ]; then
+          TAG_NAME="${{ github.event.release.tag_name }}"
+          VERSION=${TAG_NAME#v}
+        else
+          VERSION="${{ github.event.inputs.version }}"
+        fi
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+        echo "Version: $VERSION"
+
+    - name: Sync shim version and runtime dependency
+      run: |
+        VERSION="${{ steps.version.outputs.version }}"
+        npm pkg set version=$VERSION --prefix compat/sdk-shim
+        npm pkg set dependencies."@predicatesystems/runtime"=$VERSION --prefix compat/sdk-shim
+
+    - name: Publish compatibility shim to npm
+      run: |
+        cd compat/sdk-shim
+        npm publish --access public
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

.lintstagedrc.json

@@ -1,4 +1,4 @@
 {
-  "*.ts": ["eslint --fix --max-warnings=-1", "prettier --write"],
+  "*.ts": ["eslint --fix --max-warnings=-1 --no-warn-ignored", "prettier --write"],
   "*.{json,md}": ["prettier --write"]
 }

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-All notable changes to `@predicatesystems/sdk` will be documented in this file.
+All notable changes to `@predicatesystems/runtime` will be documented in this file.
 
 ## Unreleased
 
@@ -24,7 +24,7 @@ import {
   PredicateBrowserAgent,
   type RuntimeStep,
   LocalLLMProvider, // or OpenAIProvider / AnthropicProvider / DeepInfraProvider
-} from '@predicatesystems/sdk';
+} from '@predicatesystems/runtime';
 
 const runtime = new AgentRuntime(browserLike, page, tracer);
 const llm = new LocalLLMProvider({ model: 'qwen2.5:7b', baseUrl: 'http://localhost:11434/v1' });
@@ -65,7 +65,7 @@ const agent = new PredicateBrowserAgent({
 If you set `captcha.policy="callback"`, you must provide a handler. The SDK does **not** include a public CAPTCHA solver.
 
 ```ts
-import { HumanHandoffSolver } from '@predicatesystems/sdk';
+import { HumanHandoffSolver } from '@predicatesystems/runtime';
 
 const agent = new PredicateBrowserAgent({
   runtime,

README.md

@@ -28,10 +28,16 @@ The core loop is:
 ## Install
 
 ```bash
-npm install @predicatesystems/sdk
+npm install @predicatesystems/runtime
 npx playwright install chromium
 ```
 
+Legacy install compatibility remains available through the shim package:
+
+```bash
+npm install @predicatesystems/sdk
+```
+
 ## Naming migration (Predicate rebrand)
 
 Use the new `Predicate*` class names for all new code:
@@ -51,9 +57,9 @@ Use the new `Predicate*` class names for all new code:
 ## Quickstart: a verification-first loop
 
 ```ts
-import { PredicateBrowser, AgentRuntime } from '@predicatesystems/sdk';
-import { JsonlTraceSink, Tracer } from '@predicatesystems/sdk';
-import { exists, urlContains } from '@predicatesystems/sdk';
+import { PredicateBrowser, AgentRuntime } from '@predicatesystems/runtime';
+import { JsonlTraceSink, Tracer } from '@predicatesystems/runtime';
+import { exists, urlContains } from '@predicatesystems/runtime';
 import type { Page } from 'playwright';
 
 async function main(): Promise<void> {
@@ -102,7 +108,7 @@ import {
   JsonlTraceSink,
   exists,
   urlContains,
-} from '@predicatesystems/sdk';
+} from '@predicatesystems/runtime';
 
 async function runExistingAgent(page: Page): Promise<void> {
   const tracer = new Tracer('run-123', new JsonlTraceSink('trace.jsonl'));
@@ -129,7 +135,14 @@ async function runExistingAgent(page: Page): Promise<void> {
 If you want Predicate to drive the loop end-to-end, you can use the SDK primitives directly: take a snapshot, select elements, act, then verify.
 
 ```ts
-import { PredicateBrowser, snapshot, find, typeText, click, waitFor } from '@predicatesystems/sdk';
+import {
+  PredicateBrowser,
+  snapshot,
+  find,
+  typeText,
+  click,
+  waitFor,
+} from '@predicatesystems/runtime';
 
 async function loginExample(): Promise<void> {
   const browser = new PredicateBrowser();
@@ -207,7 +220,7 @@ if (!ok) {
 ## ToolRegistry (LLM-callable tools)
 
 ```ts
-import { ToolRegistry, registerDefaultTools } from '@predicatesystems/sdk';
+import { ToolRegistry, registerDefaultTools } from '@predicatesystems/runtime';
 
 const registry = new ToolRegistry();
 registerDefaultTools(registry);
@@ -219,8 +232,8 @@ const toolsForLLM = registry.llmTools();
 Chrome permission prompts are outside the DOM and can be invisible to snapshots. Prefer setting a policy **before navigation**.
 
 ```ts
-import { PredicateBrowser } from '@predicatesystems/sdk';
-import type { PermissionPolicy } from '@predicatesystems/sdk';
+import { PredicateBrowser } from '@predicatesystems/runtime';
+import type { PermissionPolicy } from '@predicatesystems/runtime';
 
 const policy: PermissionPolicy = {
   default: 'clear',
@@ -254,7 +267,7 @@ If your backend supports it, you can also use ToolRegistry permission tools (`gr
 ## Downloads (verification predicate)
 
 ```ts
-import { downloadCompleted } from '@predicatesystems/sdk';
+import { downloadCompleted } from '@predicatesystems/runtime';
 
 runtime.assert(downloadCompleted('report.csv'), 'download_ok', true);
 ```

compat/sdk-shim/README.md

@@ -0,0 +1,10 @@
+# @predicatesystems/sdk compatibility shim
+
+This package preserves install/import compatibility for users still on:
+
+```bash
+npm install @predicatesystems/sdk
+```
+
+It re-exports from `@predicatesystems/runtime`. New code should import from
+`@predicatesystems/runtime` directly.

compat/sdk-shim/index.d.ts

@@ -0,0 +1 @@
+export * from '@predicatesystems/runtime';

compat/sdk-shim/index.js

@@ -0,0 +1,3 @@
+"use strict";
+
+module.exports = require("@predicatesystems/runtime");

compat/sdk-shim/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@predicatesystems/sdk",
+  "version": "1.1.0",
+  "description": "Compatibility shim for @predicatesystems/runtime",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@predicatesystems/runtime": "1.1.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md"
+  ],
+  "license": "(MIT OR Apache-2.0)"
+}

eslint.config.js

@@ -49,6 +49,7 @@ module.exports = tseslint.config(
       'node_modules/**',
       '*.js',
       'src/extension/**',
+      'compat/**',
       'examples/**',
       'tests/**',
     ],

examples/agent-runtime-captcha-strategies.ts

@@ -5,8 +5,8 @@ import {
   HumanHandoffSolver,
   SentienceBrowser,
   VisionSolver,
-} from '@predicatesystems/sdk';
-import { createTracer } from '@predicatesystems/sdk';
+} from '@predicatesystems/runtime';
+import { createTracer } from '@predicatesystems/runtime';
 
 async function notifyWebhook(ctx: any): Promise<void> {
   console.log(`[captcha] external resolver notified: url=${ctx.url} run_id=${ctx.runId}`);