@openkey/sdk 0.10.2 → 0.11.0

package/dist/index.d.mts

@@ -27,7 +27,8 @@ interface NostrError {
  */
 declare class OpenKeyNostr {
     private host;
-    constructor(host: string);
+    private passkeysSupported;
+    constructor(host: string, passkeysSupported?: boolean);
     /**
      * Get-or-create the user's OpenKey-custodied Nostr identity. Always shows
      * a visible consent card (identity creation, or - when `relayUrl` is
@@ -67,7 +68,19 @@ interface OpenKeyConfig {
     mode?: OpenKeyMode;
     /** App-provided wallet provider for external key signing */
     externalProvider?: EIP1193Provider;
+    /**
+     * Whether the client can use passkeys (WebAuthn). Default: true. Pass
+     * false from clients where WebAuthn does not work (for example an
+     * ad-hoc-signed desktop webview); the OpenKey UI then offers only email
+     * and social sign-in.
+     */
+    passkeysSupported?: boolean;
 }
+/**
+ * Query suffix telling the OpenKey widget that passkeys are unavailable.
+ * Empty when passkeys are supported, so default URLs are unchanged.
+ */
+declare function passkeysQueryFlag(passkeysSupported: boolean): string;
 interface SignMessageRequest {
     message: string;
     keyId?: string;
@@ -325,6 +338,7 @@ declare class OpenKey {
     private oauthHost;
     private appName;
     private mode;
+    private passkeysSupported;
     private config;
     private popup;
     private lastAuth;
@@ -554,4 +568,4 @@ declare class OpenKeyProvider implements EIP1193Provider {
 
 declare function getOpenKey(config?: OpenKeyConfig): OpenKey;
 
-export { type AuthResult, type AuthorizeTinyCloudRouting, type CapabilityPresentationEnvelopeV1, type EIP1193Provider, KeyIdTypeMismatchError, type NostrError, type NostrIdentity, type OAuthConfig, type OAuthResult, type OAuthTokenResponse, OpenKey, type OpenKeyConfig, type OpenKeyError, type OpenKeyMode, OpenKeyNostr, OpenKeyProvider, type SignMessageRequest, type SignOutAcknowledgement, type SignResult, type SignTypedDataRequest, type SignedNostrEvent, type TinyCloudAuthorizationRequestV1, type TinyCloudAuthorizationResultV1, type UnsignedNostrEvent, OpenKey as default, getOpenKey, resolveAuthorizeTinyCloudRouting, shouldRouteAuthorizeTinyCloudExternal, validateIframeResize };
+export { type AuthResult, type AuthorizeTinyCloudRouting, type CapabilityPresentationEnvelopeV1, type EIP1193Provider, KeyIdTypeMismatchError, type NostrError, type NostrIdentity, type OAuthConfig, type OAuthResult, type OAuthTokenResponse, OpenKey, type OpenKeyConfig, type OpenKeyError, type OpenKeyMode, OpenKeyNostr, OpenKeyProvider, type SignMessageRequest, type SignOutAcknowledgement, type SignResult, type SignTypedDataRequest, type SignedNostrEvent, type TinyCloudAuthorizationRequestV1, type TinyCloudAuthorizationResultV1, type UnsignedNostrEvent, OpenKey as default, getOpenKey, passkeysQueryFlag, resolveAuthorizeTinyCloudRouting, shouldRouteAuthorizeTinyCloudExternal, validateIframeResize };

package/dist/index.d.ts

@@ -27,7 +27,8 @@ interface NostrError {
  */
 declare class OpenKeyNostr {
     private host;
-    constructor(host: string);
+    private passkeysSupported;
+    constructor(host: string, passkeysSupported?: boolean);
     /**
      * Get-or-create the user's OpenKey-custodied Nostr identity. Always shows
      * a visible consent card (identity creation, or - when `relayUrl` is
@@ -67,7 +68,19 @@ interface OpenKeyConfig {
     mode?: OpenKeyMode;
     /** App-provided wallet provider for external key signing */
     externalProvider?: EIP1193Provider;
+    /**
+     * Whether the client can use passkeys (WebAuthn). Default: true. Pass
+     * false from clients where WebAuthn does not work (for example an
+     * ad-hoc-signed desktop webview); the OpenKey UI then offers only email
+     * and social sign-in.
+     */
+    passkeysSupported?: boolean;
 }
+/**
+ * Query suffix telling the OpenKey widget that passkeys are unavailable.
+ * Empty when passkeys are supported, so default URLs are unchanged.
+ */
+declare function passkeysQueryFlag(passkeysSupported: boolean): string;
 interface SignMessageRequest {
     message: string;
     keyId?: string;
@@ -325,6 +338,7 @@ declare class OpenKey {
     private oauthHost;
     private appName;
     private mode;
+    private passkeysSupported;
     private config;
     private popup;
     private lastAuth;
@@ -554,4 +568,4 @@ declare class OpenKeyProvider implements EIP1193Provider {
 
 declare function getOpenKey(config?: OpenKeyConfig): OpenKey;
 
-export { type AuthResult, type AuthorizeTinyCloudRouting, type CapabilityPresentationEnvelopeV1, type EIP1193Provider, KeyIdTypeMismatchError, type NostrError, type NostrIdentity, type OAuthConfig, type OAuthResult, type OAuthTokenResponse, OpenKey, type OpenKeyConfig, type OpenKeyError, type OpenKeyMode, OpenKeyNostr, OpenKeyProvider, type SignMessageRequest, type SignOutAcknowledgement, type SignResult, type SignTypedDataRequest, type SignedNostrEvent, type TinyCloudAuthorizationRequestV1, type TinyCloudAuthorizationResultV1, type UnsignedNostrEvent, OpenKey as default, getOpenKey, resolveAuthorizeTinyCloudRouting, shouldRouteAuthorizeTinyCloudExternal, validateIframeResize };
+export { type AuthResult, type AuthorizeTinyCloudRouting, type CapabilityPresentationEnvelopeV1, type EIP1193Provider, KeyIdTypeMismatchError, type NostrError, type NostrIdentity, type OAuthConfig, type OAuthResult, type OAuthTokenResponse, OpenKey, type OpenKeyConfig, type OpenKeyError, type OpenKeyMode, OpenKeyNostr, OpenKeyProvider, type SignMessageRequest, type SignOutAcknowledgement, type SignResult, type SignTypedDataRequest, type SignedNostrEvent, type TinyCloudAuthorizationRequestV1, type TinyCloudAuthorizationResultV1, type UnsignedNostrEvent, OpenKey as default, getOpenKey, passkeysQueryFlag, resolveAuthorizeTinyCloudRouting, shouldRouteAuthorizeTinyCloudExternal, validateIframeResize };

package/dist/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   OpenKeyProvider: () => OpenKeyProvider,
   default: () => index_default,
   getOpenKey: () => getOpenKey,
+  passkeysQueryFlag: () => passkeysQueryFlag,
   resolveAuthorizeTinyCloudRouting: () => resolveAuthorizeTinyCloudRouting,
   shouldRouteAuthorizeTinyCloudExternal: () => shouldRouteAuthorizeTinyCloudExternal,
   validateIframeResize: () => validateIframeResize
@@ -175,8 +176,9 @@ var NostrFrame = class {
   }
 };
 var OpenKeyNostr = class {
-  constructor(host) {
+  constructor(host, passkeysSupported = true) {
     this.host = host;
+    this.passkeysSupported = passkeysSupported;
   }
   /**
    * Get-or-create the user's OpenKey-custodied Nostr identity. Always shows
@@ -219,7 +221,8 @@ var OpenKeyNostr = class {
   }
   widgetUrl() {
     const origin = encodeURIComponent(window.location.origin);
-    return `${this.host}/widget/embed/nostr/approve?origin=${origin}`;
+    const passkeysFlag = this.passkeysSupported ? "" : "&passkeys=false";
+    return `${this.host}/widget/embed/nostr/approve?origin=${origin}${passkeysFlag}`;
   }
   run(url, request, onData) {
     return new Promise((resolve, reject) => {
@@ -263,6 +266,9 @@ var OpenKeyNostr = class {
 };
 
 // src/index.ts
+function passkeysQueryFlag(passkeysSupported) {
+  return passkeysSupported ? "" : "&passkeys=false";
+}
 var DEFAULT_HOST = "https://openkey.so";
 var POPUP_WIDTH = 400;
 var POPUP_HEIGHT = 600;
@@ -582,6 +588,7 @@ var OpenKey = class {
   oauthHost;
   appName;
   mode;
+  passkeysSupported;
   config;
   popup = null;
   lastAuth = null;
@@ -602,7 +609,8 @@ var OpenKey = class {
     this.oauthHost = config.oauthHost || this.deriveOAuthHost(this.host);
     this.appName = config.appName || window.location.hostname;
     this.mode = config.mode ?? "iframe";
-    this.nostr = new OpenKeyNostr(this.host);
+    this.passkeysSupported = config.passkeysSupported ?? true;
+    this.nostr = new OpenKeyNostr(this.host, this.passkeysSupported);
     if (typeof window !== "undefined") {
       this.discoveredProviders = [];
       window.addEventListener("eip6963:announceProvider", (event) => {
@@ -1249,17 +1257,18 @@ var OpenKey = class {
     const mode = this.resolveMode(modeOverride);
     const origin = encodeURIComponent(window.location.origin);
     const eoaFlag = action === "connect" && this.hasDetectedEoa() ? "&hasEoa=true" : "";
+    const passkeysFlag = passkeysQueryFlag(this.passkeysSupported);
     if (mode === "popup") {
-      const url2 = `${this.host}/widget/${action}?origin=${origin}${eoaFlag}`;
+      const url2 = `${this.host}/widget/${action}?origin=${origin}${eoaFlag}${passkeysFlag}`;
       return new Promise((resolve, reject) => this.openPopup(action, url2, message, resolve, reject));
     }
     if (mode === "redirect") {
-      const url2 = `${this.host}/widget/${action}?origin=${origin}${eoaFlag}`;
+      const url2 = `${this.host}/widget/${action}?origin=${origin}${eoaFlag}${passkeysFlag}`;
       window.location.href = url2;
       return new Promise(() => {
       });
     }
-    const url = `${this.host}/widget/embed/${action}?origin=${origin}${eoaFlag}`;
+    const url = `${this.host}/widget/embed/${action}?origin=${origin}${eoaFlag}${passkeysFlag}`;
     return this.openIframeModal(url, action, message, origin);
   }
   openIframeModal(url, action, message, origin) {
@@ -1365,7 +1374,7 @@ var OpenKey = class {
         cleanup();
         console.warn("OpenKey: iframe blocked by CSP, falling back to popup. Add frame-src https://openkey.so to your CSP.");
         showToast();
-        const popupUrl = `${this.host}/widget/${action}?origin=${origin}`;
+        const popupUrl = `${this.host}/widget/${action}?origin=${origin}${passkeysQueryFlag(this.passkeysSupported)}`;
         this.openPopup(action, popupUrl, message, (val) => settle(() => resolve(val)), (err) => settle(() => reject(err)));
       }, IFRAME_READY_TIMEOUT);
       const overallTimeout = setTimeout(() => {
@@ -1669,6 +1678,7 @@ function getOpenKey(config) {
   OpenKeyNostr,
   OpenKeyProvider,
   getOpenKey,
+  passkeysQueryFlag,
   resolveAuthorizeTinyCloudRouting,
   shouldRouteAuthorizeTinyCloudExternal,
   validateIframeResize