nostr-wot-sdk 0.5.0 → 0.5.2

package/CHANGELOG.md

@@ -5,6 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.2] - 2025-02-05
+
+### Added
+
+- **`getExtensionStatus()` method** - Detailed extension connection status
+  - `'connected'` - Extension enabled and working on this domain
+  - `'not-enabled'` - Extension installed but not enabled for this domain
+  - `'unavailable'` - Not installed (or local dev build)
+  - `'not-browser'` - SSR/Node.js environment
+
+- **`extensionId` option** - Chrome Web Store extension ID for install detection
+  - Enables detecting "installed but not enabled" state via `chrome-extension://` URL check
+  - Pass your extension's ID: `new WoT({ extensionId: 'abcdef...' })`
+
+- New `ExtensionConnectionStatus` type export
+
+## [0.5.1] - 2025-02-05
+
+### Removed
+
+- Removed deprecated extension connection utilities entirely:
+  - `checkExtension`, `connectExtension`, `checkAndConnect`
+  - `ExtensionConnector`, `getDefaultConnector`, `resetDefaultConnector`
+  - `ExtensionConnectionState`, `ExtensionConnectionResult`, `ExtensionConnectionOptions` types
+- Removed `src/extension.ts` file
+
 ## [0.5.0] - 2025-02-05
 
 ### Changed
@@ -24,7 +50,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Removed event-based connection (`nostr-wot-check`, `nostr-wot-connect` events)
 - Removed `ExtensionConnectionOptions` from React exports
-- Extension connection utilities (`checkExtension`, `connectExtension`, `checkAndConnect`, `ExtensionConnector`) are still exported but deprecated
 
 ## [0.4.2] - 2025-02-05
 
@@ -201,6 +226,8 @@ function Profile({ pubkey }) {
 - TypeScript support with full type definitions
 - Error classes: `WoTError`, `NetworkError`, `NotFoundError`, `TimeoutError`, `ValidationError`
 
+[0.5.2]: https://github.com/nostr-wot/nostr-wot-sdk/compare/v0.5.1...v0.5.2
+[0.5.1]: https://github.com/nostr-wot/nostr-wot-sdk/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/nostr-wot/nostr-wot-sdk/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/nostr-wot/nostr-wot-sdk/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/nostr-wot/nostr-wot-sdk/compare/v0.4.0...v0.4.1

package/README.md

@@ -75,6 +75,7 @@ const wot = new WoT(options);
 | `maxHops` | number | `3` | Default max search depth |
 | `timeout` | number | `5000` | Request timeout (ms) |
 | `fallback` | object | — | Fallback config when extension unavailable |
+| `extensionId` | string | — | Chrome Web Store extension ID (for detecting "installed but not enabled" state) |
 
 Trust scores are calculated by the extension and not configurable via the SDK.
 
@@ -147,6 +148,23 @@ const usingExt = await wot.isUsingExtension();
 // Returns: boolean
 ```
 
+#### `getExtensionStatus()`
+
+Get detailed extension connection status. Useful for showing appropriate UI based on why the extension isn't working.
+```javascript
+const status = await wot.getExtensionStatus();
+// Returns: 'connected' | 'not-enabled' | 'unavailable' | 'not-browser'
+```
+
+| Status | Description |
+|--------|-------------|
+| `'connected'` | Extension is enabled and working on this domain |
+| `'not-enabled'` | Extension is installed but not enabled for this domain |
+| `'unavailable'` | Extension is not installed (or using local dev build) |
+| `'not-browser'` | Running in SSR/Node.js environment |
+
+**Note:** Detecting `'not-enabled'` requires providing the `extensionId` option.
+
 #### `getExtensionConfig()`
 
 Get extension's configuration.

package/dist/index.cjs

@@ -86,26 +86,28 @@ function chunk(array, size) {
 }
 
 // src/wot.ts
+var DEFAULT_EXTENSION_ID = "";
 var WoT = class {
   constructor(options = {}) {
     this.extension = null;
     this.extensionPubkey = null;
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
     this.fallbackOptions = (_a = options.fallback) != null ? _a : null;
+    this.extensionId = (_b = options.extensionId) != null ? _b : DEFAULT_EXTENSION_ID;
     if (options.myPubkey && isValidPubkey(options.myPubkey)) {
       this.fallbackPubkey = normalizePubkey(options.myPubkey);
-    } else if ((_b = this.fallbackOptions) == null ? void 0 : _b.myPubkey) {
+    } else if ((_c = this.fallbackOptions) == null ? void 0 : _c.myPubkey) {
       this.fallbackPubkey = normalizePubkey(this.fallbackOptions.myPubkey);
     } else {
       this.fallbackPubkey = null;
     }
-    const oracleUrl = (_e = (_d = options.oracle) != null ? _d : (_c = this.fallbackOptions) == null ? void 0 : _c.oracle) != null ? _e : DEFAULT_ORACLE;
+    const oracleUrl = (_f = (_e = options.oracle) != null ? _e : (_d = this.fallbackOptions) == null ? void 0 : _d.oracle) != null ? _f : DEFAULT_ORACLE;
     if (!isValidOracleUrl(oracleUrl)) {
       throw new ValidationError("oracle must be a valid HTTPS URL", "oracle");
     }
     this.oracle = oracleUrl;
-    this.maxHops = (_h = (_g = options.maxHops) != null ? _g : (_f = this.fallbackOptions) == null ? void 0 : _f.maxHops) != null ? _h : DEFAULT_MAX_HOPS;
-    this.timeout = (_k = (_j = options.timeout) != null ? _j : (_i = this.fallbackOptions) == null ? void 0 : _i.timeout) != null ? _k : DEFAULT_TIMEOUT;
+    this.maxHops = (_i = (_h = options.maxHops) != null ? _h : (_g = this.fallbackOptions) == null ? void 0 : _g.maxHops) != null ? _i : DEFAULT_MAX_HOPS;
+    this.timeout = (_l = (_k = options.timeout) != null ? _k : (_j = this.fallbackOptions) == null ? void 0 : _j.timeout) != null ? _l : DEFAULT_TIMEOUT;
   }
   /**
    * Checks if browser extension is available and returns it
@@ -419,6 +421,33 @@ var WoT = class {
     const ext = await this.getExtension();
     return ext !== null;
   }
+  /**
+   * Get detailed extension connection status
+   * Can detect if extension is installed but not enabled for this domain
+   * @returns Connection status: 'connected' | 'not-enabled' | 'unavailable' | 'not-browser'
+   */
+  async getExtensionStatus() {
+    var _a;
+    if (typeof window === "undefined") {
+      return "not-browser";
+    }
+    if ((_a = window.nostr) == null ? void 0 : _a.wot) {
+      return "connected";
+    }
+    if (this.extensionId) {
+      try {
+        const response = await fetch(
+          `chrome-extension://${this.extensionId}/detect.json`,
+          { method: "HEAD" }
+        );
+        if (response.ok) {
+          return "not-enabled";
+        }
+      } catch (e) {
+      }
+    }
+    return "unavailable";
+  }
   /**
    * Get extension configuration (only available when using extension)
    * @returns Extension config or null if not using extension
@@ -577,235 +606,9 @@ var WoT = class {
   }
 };
 
-// src/extension.ts
-function checkExtension(timeout = 100) {
-  return new Promise((resolve) => {
-    var _a;
-    if (typeof window === "undefined") {
-      resolve(false);
-      return;
-    }
-    const win = window;
-    if ((_a = win.nostr) == null ? void 0 : _a.wot) {
-      resolve(true);
-      return;
-    }
-    const handler = () => {
-      window.removeEventListener("nostr-wot-present", handler);
-      clearTimeout(timer);
-      resolve(true);
-    };
-    window.addEventListener("nostr-wot-present", handler);
-    const timer = setTimeout(() => {
-      window.removeEventListener("nostr-wot-present", handler);
-      resolve(false);
-    }, timeout);
-    window.dispatchEvent(new CustomEvent("nostr-wot-check"));
-  });
-}
-function connectExtension(timeout = 5e3) {
-  return new Promise((resolve, reject) => {
-    var _a;
-    if (typeof window === "undefined") {
-      reject(new Error("Not in browser environment"));
-      return;
-    }
-    const win = window;
-    if ((_a = win.nostr) == null ? void 0 : _a.wot) {
-      resolve(win.nostr.wot);
-      return;
-    }
-    let timer;
-    const onReady = () => {
-      var _a2;
-      cleanup();
-      const ext = (_a2 = window.nostr) == null ? void 0 : _a2.wot;
-      if (ext) {
-        resolve(ext);
-      } else {
-        reject(new Error("Extension ready event fired but API not found"));
-      }
-    };
-    const onError = (e) => {
-      cleanup();
-      const detail = e.detail;
-      reject(new Error((detail == null ? void 0 : detail.error) || "Connection failed"));
-    };
-    const cleanup = () => {
-      clearTimeout(timer);
-      window.removeEventListener("nostr-wot-ready", onReady);
-      window.removeEventListener("nostr-wot-error", onError);
-    };
-    window.addEventListener("nostr-wot-ready", onReady);
-    window.addEventListener("nostr-wot-error", onError);
-    window.dispatchEvent(new CustomEvent("nostr-wot-connect"));
-    timer = setTimeout(() => {
-      cleanup();
-      reject(new Error("Connection timeout"));
-    }, timeout);
-  });
-}
-async function checkAndConnect(options = {}) {
-  var _a;
-  const { checkTimeout = 100, connectTimeout = 5e3, autoConnect = true } = options;
-  if (typeof window === "undefined") {
-    return { state: "not-installed", extension: null };
-  }
-  const win = window;
-  if ((_a = win.nostr) == null ? void 0 : _a.wot) {
-    return { state: "connected", extension: win.nostr.wot };
-  }
-  const isInstalled = await checkExtension(checkTimeout);
-  if (!isInstalled) {
-    return { state: "not-installed", extension: null };
-  }
-  if (!autoConnect) {
-    return { state: "idle", extension: null };
-  }
-  try {
-    const extension = await connectExtension(connectTimeout);
-    return { state: "connected", extension };
-  } catch (error) {
-    return {
-      state: "error",
-      extension: null,
-      error: error instanceof Error ? error.message : "Unknown error"
-    };
-  }
-}
-var ExtensionConnector = class {
-  constructor(options = {}) {
-    this.options = options;
-    this.state = "idle";
-    this.extension = null;
-    this.connectionPromise = null;
-    this.listeners = /* @__PURE__ */ new Set();
-  }
-  /**
-   * Get current state
-   */
-  getState() {
-    return this.state;
-  }
-  /**
-   * Get current extension instance
-   */
-  getExtension() {
-    return this.extension;
-  }
-  /**
-   * Get current error
-   */
-  getError() {
-    return this.error;
-  }
-  /**
-   * Get current result
-   */
-  getResult() {
-    return {
-      state: this.state,
-      extension: this.extension,
-      error: this.error
-    };
-  }
-  /**
-   * Subscribe to state changes
-   */
-  subscribe(listener) {
-    this.listeners.add(listener);
-    return () => {
-      this.listeners.delete(listener);
-    };
-  }
-  notify() {
-    const result = this.getResult();
-    for (const listener of this.listeners) {
-      listener(result);
-    }
-  }
-  setState(state, extension = null, error) {
-    this.state = state;
-    this.extension = extension;
-    this.error = error;
-    this.notify();
-  }
-  /**
-   * Connect to the extension
-   * Returns existing promise if already connecting
-   */
-  async connect() {
-    if (this.state === "connected" && this.extension) {
-      return this.getResult();
-    }
-    if (this.connectionPromise) {
-      return this.connectionPromise;
-    }
-    this.connectionPromise = this.doConnect();
-    const result = await this.connectionPromise;
-    this.connectionPromise = null;
-    return result;
-  }
-  async doConnect() {
-    var _a;
-    const { checkTimeout = 100, connectTimeout = 5e3 } = this.options;
-    if (typeof window === "undefined") {
-      this.setState("not-installed");
-      return this.getResult();
-    }
-    const win = window;
-    if ((_a = win.nostr) == null ? void 0 : _a.wot) {
-      this.setState("connected", win.nostr.wot);
-      return this.getResult();
-    }
-    this.setState("checking");
-    const isInstalled = await checkExtension(checkTimeout);
-    if (!isInstalled) {
-      this.setState("not-installed");
-      return this.getResult();
-    }
-    this.setState("connecting");
-    try {
-      const extension = await connectExtension(connectTimeout);
-      this.setState("connected", extension);
-    } catch (error) {
-      this.setState(
-        "error",
-        null,
-        error instanceof Error ? error.message : "Unknown error"
-      );
-    }
-    return this.getResult();
-  }
-  /**
-   * Reset state and disconnect
-   */
-  reset() {
-    this.state = "idle";
-    this.extension = null;
-    this.error = void 0;
-    this.connectionPromise = null;
-    this.notify();
-  }
-};
-var defaultConnector = null;
-function getDefaultConnector(options) {
-  if (!defaultConnector) {
-    defaultConnector = new ExtensionConnector(options);
-  }
-  return defaultConnector;
-}
-function resetDefaultConnector() {
-  if (defaultConnector) {
-    defaultConnector.reset();
-    defaultConnector = null;
-  }
-}
-
 exports.DEFAULT_MAX_HOPS = DEFAULT_MAX_HOPS;
 exports.DEFAULT_ORACLE = DEFAULT_ORACLE;
 exports.DEFAULT_TIMEOUT = DEFAULT_TIMEOUT;
-exports.ExtensionConnector = ExtensionConnector;
 exports.MAX_BATCH_SIZE = MAX_BATCH_SIZE;
 exports.NetworkError = NetworkError;
 exports.NotFoundError = NotFoundError;
@@ -813,11 +616,6 @@ exports.TimeoutError = TimeoutError;
 exports.ValidationError = ValidationError;
 exports.WoT = WoT;
 exports.WoTError = WoTError;
-exports.checkAndConnect = checkAndConnect;
-exports.checkExtension = checkExtension;
-exports.connectExtension = connectExtension;
-exports.getDefaultConnector = getDefaultConnector;
 exports.isValidOracleUrl = isValidOracleUrl;
 exports.isValidPubkey = isValidPubkey;
 exports.normalizePubkey = normalizePubkey;
-exports.resetDefaultConnector = resetDefaultConnector;

package/dist/index.d.cts

@@ -1,3 +1,7 @@
+/**
+ * Extension connection status
+ */
+type ExtensionConnectionStatus = 'connected' | 'not-enabled' | 'unavailable' | 'not-browser';
 /**
  * Configuration for trust score calculation (used by extension)
  */
@@ -73,6 +77,11 @@ interface WoTOptions {
      * Recommended to provide myPubkey here for oracle fallback.
      */
     fallback?: WoTFallbackOptions;
+    /**
+     * Chrome Web Store extension ID (for install detection)
+     * Only needed if you want to detect "installed but not enabled" state
+     */
+    extensionId?: string;
 }
 /**
  * Options for query methods
@@ -364,6 +373,7 @@ declare class WoT {
     private readonly maxHops;
     private readonly timeout;
     private readonly fallbackOptions;
+    private readonly extensionId;
     private extension;
     private extensionPubkey;
     constructor(options?: WoTOptions);
@@ -443,6 +453,12 @@ declare class WoT {
      * Check if extension is available and being used
      */
     isUsingExtension(): Promise<boolean>;
+    /**
+     * Get detailed extension connection status
+     * Can detect if extension is installed but not enabled for this domain
+     * @returns Connection status: 'connected' | 'not-enabled' | 'unavailable' | 'not-browser'
+     */
+    getExtensionStatus(): Promise<ExtensionConnectionStatus>;
     /**
      * Get extension configuration (only available when using extension)
      * @returns Extension config or null if not using extension
@@ -539,110 +555,6 @@ declare class WoT {
     getTrustScoreBatch(targets: string[]): Promise<Record<string, number | null>>;
 }
 
-/**
- * Extension connection module
- * Handles the event-based communication flow with the nostr-wot browser extension
- */
-
-/**
- * Extension connection state
- */
-type ExtensionConnectionState = 'idle' | 'checking' | 'connecting' | 'connected' | 'not-installed' | 'error';
-/**
- * Extension connection result
- */
-interface ExtensionConnectionResult {
-    state: ExtensionConnectionState;
-    extension: NostrWoTExtension | null;
-    error?: string;
-}
-/**
- * Extension connection options
- */
-interface ExtensionConnectionOptions {
-    /**
-     * Timeout for extension check (ms)
-     * @default 100
-     */
-    checkTimeout?: number;
-    /**
-     * Timeout for connection (ms)
-     * @default 5000
-     */
-    connectTimeout?: number;
-    /**
-     * Auto-connect after checking
-     * @default true
-     */
-    autoConnect?: boolean;
-}
-/**
- * Check if the nostr-wot extension is installed
- * Uses the nostr-wot-check / nostr-wot-present event handshake
- */
-declare function checkExtension(timeout?: number): Promise<boolean>;
-/**
- * Connect to the nostr-wot extension
- * Uses the nostr-wot-connect / nostr-wot-ready event handshake
- */
-declare function connectExtension(timeout?: number): Promise<NostrWoTExtension>;
-/**
- * Check and connect to the extension in one call
- */
-declare function checkAndConnect(options?: ExtensionConnectionOptions): Promise<ExtensionConnectionResult>;
-/**
- * Extension connector class for managing connection state
- */
-declare class ExtensionConnector {
-    private options;
-    private state;
-    private extension;
-    private error;
-    private connectionPromise;
-    private listeners;
-    constructor(options?: ExtensionConnectionOptions);
-    /**
-     * Get current state
-     */
-    getState(): ExtensionConnectionState;
-    /**
-     * Get current extension instance
-     */
-    getExtension(): NostrWoTExtension | null;
-    /**
-     * Get current error
-     */
-    getError(): string | undefined;
-    /**
-     * Get current result
-     */
-    getResult(): ExtensionConnectionResult;
-    /**
-     * Subscribe to state changes
-     */
-    subscribe(listener: (result: ExtensionConnectionResult) => void): () => void;
-    private notify;
-    private setState;
-    /**
-     * Connect to the extension
-     * Returns existing promise if already connecting
-     */
-    connect(): Promise<ExtensionConnectionResult>;
-    private doConnect;
-    /**
-     * Reset state and disconnect
-     */
-    reset(): void;
-}
-/**
- * Get the default extension connector
- */
-declare function getDefaultConnector(options?: ExtensionConnectionOptions): ExtensionConnector;
-/**
- * Reset the default connector (useful for testing)
- */
-declare function resetDefaultConnector(): void;
-
 /**
  * Base error class for WoT SDK errors
  */
@@ -708,4 +620,4 @@ declare const MAX_BATCH_SIZE = 10000;
  */
 declare function normalizePubkey(pubkey: string): string;
 
-export { type BatchResult, DEFAULT_MAX_HOPS, DEFAULT_ORACLE, DEFAULT_TIMEOUT, type DistanceBatchOptions, type DistanceResult, type ExtensionConfig, type ExtensionConnectionOptions, type ExtensionConnectionResult, type ExtensionConnectionState, ExtensionConnector, type ExtensionDistanceResult, type ExtensionStatus, type GraphStats, MAX_BATCH_SIZE, NetworkError, type NostrContactEvent, type NostrWindow, type NostrWoTExtension, NotFoundError, type QueryOptions, type ScoringConfig, TimeoutError, ValidationError, WoT, WoTError, type WoTFallbackOptions, type WoTOptions, checkAndConnect, checkExtension, connectExtension, getDefaultConnector, isValidOracleUrl, isValidPubkey, normalizePubkey, resetDefaultConnector };
+export { type BatchResult, DEFAULT_MAX_HOPS, DEFAULT_ORACLE, DEFAULT_TIMEOUT, type DistanceBatchOptions, type DistanceResult, type ExtensionConfig, type ExtensionConnectionStatus, type ExtensionDistanceResult, type ExtensionStatus, type GraphStats, MAX_BATCH_SIZE, NetworkError, type NostrContactEvent, type NostrWindow, type NostrWoTExtension, NotFoundError, type QueryOptions, type ScoringConfig, TimeoutError, ValidationError, WoT, WoTError, type WoTFallbackOptions, type WoTOptions, isValidOracleUrl, isValidPubkey, normalizePubkey };