nostr-wot-sdk 0.5.1 → 0.5.3

package/CHANGELOG.md

@@ -5,6 +5,22 @@ 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
@@ -210,6 +226,7 @@ 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

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 = "gfmefgdkmjpjinecjchlangpamhclhdo";
 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

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
@@ -604,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 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 };
+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 };

package/dist/index.d.ts

@@ -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
@@ -604,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 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 };
+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 };

package/dist/index.js

@@ -84,26 +84,28 @@ function chunk(array, size) {
 }
 
 // src/wot.ts
+var DEFAULT_EXTENSION_ID = "gfmefgdkmjpjinecjchlangpamhclhdo";
 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
@@ -417,6 +419,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

package/dist/react/index.cjs

@@ -91,26 +91,28 @@ function chunk(array, size) {
 }
 
 // src/wot.ts
+var DEFAULT_EXTENSION_ID = "gfmefgdkmjpjinecjchlangpamhclhdo";
 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
@@ -424,6 +426,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
@@ -600,8 +629,30 @@ function WoTProvider({
     setIsReady(true);
   }, []);
   react.useEffect(() => {
-    checkExtension();
-  }, [checkExtension]);
+    if (checkExtensionAvailable()) {
+      setExtensionState("connected");
+      setIsReady(true);
+      return;
+    }
+    let attempts = 0;
+    const maxAttempts = 15;
+    const intervalMs = 100;
+    const intervalId = setInterval(() => {
+      attempts++;
+      if (checkExtensionAvailable()) {
+        setExtensionState("connected");
+        setIsReady(true);
+        clearInterval(intervalId);
+        return;
+      }
+      if (attempts >= maxAttempts) {
+        setExtensionState("not-available");
+        setIsReady(true);
+        clearInterval(intervalId);
+      }
+    }, intervalMs);
+    return () => clearInterval(intervalId);
+  }, []);
   const wot = react.useMemo(() => {
     if (!isReady) {
       return null;