@chatbridge/provider 0.2.2 → 0.3.0

package/README.md

@@ -1,3 +1,20 @@
 # @chatbridge/provider
 
 The provider contract for [chatbridge](https://github.com/7milch/chatbridge-cli): the interface service-specific browser behaviour implements.
+
+## Optional: `detectBlock`
+
+`detectBlock(page)` lets a provider tell a bot challenge or an IdP refusing
+the automated browser apart from an expired login. The core calls it only
+after `isLoggedIn` returned `false`. Return a short description to raise
+`BlockedError` (CLI exit 6, message suggests `--headful`); return
+`undefined` for an ordinary logged-out page. Example for a Cloudflare
+interstitial:
+
+```typescript
+async detectBlock(page) {
+  return (await page.title()) === "Just a moment..." ? "challenge page" : undefined;
+}
+```
+
+Detecting a block is all the framework does; evading it is out of scope.

package/dist/index.d.ts

@@ -22,6 +22,12 @@ export interface Provider {
      * return the response to the most recent `sendMessage` only, never an
      * earlier turn's. */
     waitForResponse(page: Page): Promise<string>;
+    /** Optional. When the page shows a block that logging in again would not
+     * clear (a bot challenge interstitial, an IdP refusing the automated
+     * browser), return a short description of it; otherwise undefined. The
+     * core calls this only after `isLoggedIn` returned false. Must not throw
+     * on an ordinary logged-out page. */
+    detectBlock?(page: Page): Promise<string | undefined>;
 }
 /** Identity helper: gives provider authors type inference and a future
  * validation hook without any runtime cost today. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatbridge/provider",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Provider contract for chatbridge: service-specific browser behaviour behind one interface",
   "license": "MIT",
   "repository": {