@capgo/capacitor-passkey 8.2.0

package/dist/docs.json

@@ -0,0 +1,1034 @@
+{
+  "api": {
+    "name": "CapacitorPasskeyPlugin",
+    "slug": "capacitorpasskeyplugin",
+    "docs": "Capacitor Passkey plugin.\n\nUse `autoShimWebAuthn()` or import `@capgo/capacitor-passkey/auto`\nto keep existing `navigator.credentials.create/get` code working\ninside a Capacitor app.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "shimWebAuthn",
+        "signature": "(options?: ShimWebAuthnOptions | undefined) => void",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShimWebAuthnOptions | undefined"
+          }
+        ],
+        "returns": "void",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { CapacitorPasskey } from '@capgo/capacitor-passkey';\n\nCapacitorPasskey.shimWebAuthn({\n  origin: 'https://signin.example.com',\n});\n```"
+          }
+        ],
+        "docs": "Install a browser-style WebAuthn shim on top of the native plugin.\n\nThe shim patches `navigator.credentials.create/get` for `publicKey`\nrequests and returns browser-like credential objects.\n\nUse this when you want to override the auto-loaded config manually.",
+        "complexTypes": [
+          "ShimWebAuthnOptions"
+        ],
+        "slug": "shimwebauthn"
+      },
+      {
+        "name": "getConfiguration",
+        "signature": "() => Promise<PasskeyRuntimeConfiguration>",
+        "parameters": [],
+        "returns": "Promise<PasskeyRuntimeConfiguration>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.1.0"
+          }
+        ],
+        "docs": "Load plugin configuration from the host Capacitor app.\n\nThis reads `plugins.CapacitorPasskey` from `capacitor.config.*`.",
+        "complexTypes": [
+          "PasskeyRuntimeConfiguration"
+        ],
+        "slug": "getconfiguration"
+      },
+      {
+        "name": "autoShimWebAuthn",
+        "signature": "(options?: ShimWebAuthnOptions | undefined) => Promise<PasskeyRuntimeConfiguration>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShimWebAuthnOptions | undefined"
+          }
+        ],
+        "returns": "Promise<PasskeyRuntimeConfiguration>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.1.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nimport { CapacitorPasskey } from '@capgo/capacitor-passkey';\n\nawait CapacitorPasskey.autoShimWebAuthn();\n```"
+          }
+        ],
+        "docs": "Install the browser-style shim using host app configuration.\n\nThis is the easiest way to keep existing browser WebAuthn code working:\nconfigure the plugin in `capacitor.config.*`, then call this once during\napp bootstrap or use the `/auto` entrypoint.",
+        "complexTypes": [
+          "PasskeyRuntimeConfiguration",
+          "ShimWebAuthnOptions"
+        ],
+        "slug": "autoshimwebauthn"
+      },
+      {
+        "name": "createCredential",
+        "signature": "(options: CreateCredentialOptions) => Promise<PasskeyRegistrationCredential>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CreateCredentialOptions"
+          }
+        ],
+        "returns": "Promise<PasskeyRegistrationCredential>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Register a passkey from a JSON-safe WebAuthn request.\n\nThis method is useful when your backend already returns the\n`PublicKeyCredentialCreationOptionsJSON` form.",
+        "complexTypes": [
+          "PasskeyRegistrationCredential",
+          "CreateCredentialOptions"
+        ],
+        "slug": "createcredential"
+      },
+      {
+        "name": "getCredential",
+        "signature": "(options: GetCredentialOptions) => Promise<PasskeyAuthenticationCredential>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetCredentialOptions"
+          }
+        ],
+        "returns": "Promise<PasskeyAuthenticationCredential>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Authenticate with an existing passkey from a JSON-safe WebAuthn request.\n\nThis method is useful when your backend already returns the\n`PublicKeyCredentialRequestOptionsJSON` form.",
+        "complexTypes": [
+          "PasskeyAuthenticationCredential",
+          "GetCredentialOptions"
+        ],
+        "slug": "getcredential"
+      },
+      {
+        "name": "isSupported",
+        "signature": "() => Promise<PasskeySupportResult>",
+        "parameters": [],
+        "returns": "Promise<PasskeySupportResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Report whether passkeys are available in the current runtime.",
+        "complexTypes": [
+          "PasskeySupportResult"
+        ],
+        "slug": "issupported"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Returns the current platform implementation version marker.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ShimWebAuthnOptions",
+      "slug": "shimwebauthnoptions",
+      "docs": "Options used when installing the browser-style shim.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "origin",
+          "tags": [],
+          "docs": "Optional HTTPS origin to encode into iOS 17.4+ clientDataJSON.\n\nUse this when your Capacitor app runs from `capacitor://localhost`\nbut your relying party expects `https://signin.example.com`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "force",
+          "tags": [],
+          "docs": "Force the shim even if the runtime already exposes `navigator.credentials`.\n\nDefaults to `false`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyRuntimeConfiguration",
+      "slug": "passkeyruntimeconfiguration",
+      "docs": "Runtime configuration loaded from the host app's Capacitor config.\n\nThis is the shape returned by `getConfiguration()`.",
+      "tags": [
+        {
+          "text": "1.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "autoShim",
+          "tags": [],
+          "docs": "Whether the `/auto` entrypoint should install the shim automatically.\n\nDefaults to `true`.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "origin",
+          "tags": [],
+          "docs": "Optional HTTPS origin used by the auto-shim.\n\nOn iOS 17.4+ this origin is encoded into `clientDataJSON`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "domains",
+          "tags": [],
+          "docs": "Domains associated with the app for passkey usage.\n\nThese come from `domains` in Capacitor config plus the hostname derived\nfrom `origin` when available.",
+          "complexTypes": [],
+          "type": "string[]"
+        },
+        {
+          "name": "platform",
+          "tags": [],
+          "docs": "Current runtime platform.",
+          "complexTypes": [],
+          "type": "'ios' | 'android' | 'web'"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyRegistrationCredential",
+      "slug": "passkeyregistrationcredential",
+      "docs": "JSON-safe registration credential returned by the plugin.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Base64url-encoded credential identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "rawId",
+          "tags": [],
+          "docs": "Base64url-encoded raw credential identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Credential type. Always `public-key`.",
+          "complexTypes": [
+            "PasskeyCredentialType"
+          ],
+          "type": "PasskeyCredentialType"
+        },
+        {
+          "name": "authenticatorAttachment",
+          "tags": [],
+          "docs": "Optional authenticator attachment reported by the platform.",
+          "complexTypes": [
+            "PasskeyAuthenticatorAttachment"
+          ],
+          "type": "PasskeyAuthenticatorAttachment"
+        },
+        {
+          "name": "clientExtensionResults",
+          "tags": [],
+          "docs": "Client extension results returned by the platform.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        },
+        {
+          "name": "response",
+          "tags": [],
+          "docs": "Registration response payload.",
+          "complexTypes": [
+            "PasskeyAuthenticatorAttestationResponseJSON"
+          ],
+          "type": "PasskeyAuthenticatorAttestationResponseJSON"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAuthenticatorAttestationResponseJSON",
+      "slug": "passkeyauthenticatorattestationresponsejson",
+      "docs": "JSON-safe attestation response payload.\n\nAll binary fields are base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "clientDataJSON",
+          "tags": [],
+          "docs": "Base64url-encoded clientDataJSON.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "attestationObject",
+          "tags": [],
+          "docs": "Base64url-encoded attestation object.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "publicKey",
+          "tags": [],
+          "docs": "Optional base64url-encoded public key when provided by the platform.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "publicKeyAlgorithm",
+          "tags": [],
+          "docs": "Optional public key algorithm when provided by the platform.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "transports",
+          "tags": [],
+          "docs": "Optional transport list when provided by the platform.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "CreateCredentialOptions",
+      "slug": "createcredentialoptions",
+      "docs": "Direct registration request for the plugin transport.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "publicKey",
+          "tags": [],
+          "docs": "JSON-safe registration request.",
+          "complexTypes": [
+            "PasskeyPublicKeyCredentialCreationOptionsJSON"
+          ],
+          "type": "PasskeyPublicKeyCredentialCreationOptionsJSON"
+        },
+        {
+          "name": "origin",
+          "tags": [],
+          "docs": "Optional HTTPS origin to use for iOS 17.4+ browser-style clientDataJSON.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyPublicKeyCredentialCreationOptionsJSON",
+      "slug": "passkeypublickeycredentialcreationoptionsjson",
+      "docs": "JSON-safe registration request options.\n\nAll binary fields must be base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "challenge",
+          "tags": [],
+          "docs": "Base64url-encoded challenge.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "rp",
+          "tags": [],
+          "docs": "Relying party information.",
+          "complexTypes": [
+            "PasskeyRelyingParty"
+          ],
+          "type": "PasskeyRelyingParty"
+        },
+        {
+          "name": "user",
+          "tags": [],
+          "docs": "User information.",
+          "complexTypes": [
+            "PasskeyUserEntity"
+          ],
+          "type": "PasskeyUserEntity"
+        },
+        {
+          "name": "pubKeyCredParams",
+          "tags": [],
+          "docs": "Supported credential algorithms.",
+          "complexTypes": [
+            "PasskeyCredentialParameter"
+          ],
+          "type": "PasskeyCredentialParameter[]"
+        },
+        {
+          "name": "timeout",
+          "tags": [],
+          "docs": "Optional timeout hint in milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "excludeCredentials",
+          "tags": [],
+          "docs": "Optional credentials that must be excluded during registration.",
+          "complexTypes": [
+            "PasskeyCredentialDescriptor"
+          ],
+          "type": "PasskeyCredentialDescriptor[] | undefined"
+        },
+        {
+          "name": "authenticatorSelection",
+          "tags": [],
+          "docs": "Optional authenticator preferences.",
+          "complexTypes": [
+            "PasskeyAuthenticatorSelection"
+          ],
+          "type": "PasskeyAuthenticatorSelection"
+        },
+        {
+          "name": "attestation",
+          "tags": [],
+          "docs": "Optional attestation preference.",
+          "complexTypes": [
+            "PasskeyAttestation"
+          ],
+          "type": "PasskeyAttestation"
+        },
+        {
+          "name": "hints",
+          "tags": [],
+          "docs": "Optional hints copied from the JSON form used by modern WebAuthn toolkits.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "extensions",
+          "tags": [],
+          "docs": "Optional extensions copied as-is into the request JSON.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyRelyingParty",
+      "slug": "passkeyrelyingparty",
+      "docs": "JSON-safe relying party information.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Relying party identifier.\n\nIf omitted, the shim derives it from the configured origin when possible.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "Human-readable relying party name.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyUserEntity",
+      "slug": "passkeyuserentity",
+      "docs": "JSON-safe WebAuthn user entity.\n\nBinary identifiers must be base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Base64url-encoded user handle.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "User name shown by the authenticator.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "displayName",
+          "tags": [],
+          "docs": "Optional display name shown by the authenticator.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyCredentialParameter",
+      "slug": "passkeycredentialparameter",
+      "docs": "JSON-safe credential parameter entry.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Credential type. Only `public-key` is supported.",
+          "complexTypes": [
+            "PasskeyCredentialType"
+          ],
+          "type": "PasskeyCredentialType"
+        },
+        {
+          "name": "alg",
+          "tags": [],
+          "docs": "COSE algorithm identifier.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyCredentialDescriptor",
+      "slug": "passkeycredentialdescriptor",
+      "docs": "JSON-safe representation of a public key credential descriptor.\n\nBinary identifiers must be base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Base64url-encoded credential identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Credential type. Only `public-key` is supported.",
+          "complexTypes": [
+            "PasskeyCredentialType"
+          ],
+          "type": "PasskeyCredentialType"
+        },
+        {
+          "name": "transports",
+          "tags": [],
+          "docs": "Optional transport hints copied from WebAuthn.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAuthenticatorSelection",
+      "slug": "passkeyauthenticatorselection",
+      "docs": "JSON-safe authenticator selection options.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "authenticatorAttachment",
+          "tags": [],
+          "docs": "Optional authenticator attachment hint.",
+          "complexTypes": [
+            "PasskeyAuthenticatorAttachment"
+          ],
+          "type": "PasskeyAuthenticatorAttachment"
+        },
+        {
+          "name": "residentKey",
+          "tags": [],
+          "docs": "Optional resident key preference.",
+          "complexTypes": [
+            "PasskeyResidentKey"
+          ],
+          "type": "PasskeyResidentKey"
+        },
+        {
+          "name": "requireResidentKey",
+          "tags": [],
+          "docs": "Legacy resident key requirement flag.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "userVerification",
+          "tags": [],
+          "docs": "Optional user verification preference.",
+          "complexTypes": [
+            "PasskeyUserVerification"
+          ],
+          "type": "PasskeyUserVerification"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAuthenticationCredential",
+      "slug": "passkeyauthenticationcredential",
+      "docs": "JSON-safe authentication credential returned by the plugin.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Base64url-encoded credential identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "rawId",
+          "tags": [],
+          "docs": "Base64url-encoded raw credential identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Credential type. Always `public-key`.",
+          "complexTypes": [
+            "PasskeyCredentialType"
+          ],
+          "type": "PasskeyCredentialType"
+        },
+        {
+          "name": "authenticatorAttachment",
+          "tags": [],
+          "docs": "Optional authenticator attachment reported by the platform.",
+          "complexTypes": [
+            "PasskeyAuthenticatorAttachment"
+          ],
+          "type": "PasskeyAuthenticatorAttachment"
+        },
+        {
+          "name": "clientExtensionResults",
+          "tags": [],
+          "docs": "Client extension results returned by the platform.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        },
+        {
+          "name": "response",
+          "tags": [],
+          "docs": "Assertion response payload.",
+          "complexTypes": [
+            "PasskeyAuthenticatorAssertionResponseJSON"
+          ],
+          "type": "PasskeyAuthenticatorAssertionResponseJSON"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAuthenticatorAssertionResponseJSON",
+      "slug": "passkeyauthenticatorassertionresponsejson",
+      "docs": "JSON-safe assertion response payload.\n\nAll binary fields are base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "clientDataJSON",
+          "tags": [],
+          "docs": "Base64url-encoded clientDataJSON.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "authenticatorData",
+          "tags": [],
+          "docs": "Base64url-encoded authenticator data.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "signature",
+          "tags": [],
+          "docs": "Base64url-encoded signature.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "userHandle",
+          "tags": [],
+          "docs": "Optional base64url-encoded user handle.",
+          "complexTypes": [],
+          "type": "string | null | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetCredentialOptions",
+      "slug": "getcredentialoptions",
+      "docs": "Direct authentication request for the plugin transport.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "publicKey",
+          "tags": [],
+          "docs": "JSON-safe authentication request.",
+          "complexTypes": [
+            "PasskeyPublicKeyCredentialRequestOptionsJSON"
+          ],
+          "type": "PasskeyPublicKeyCredentialRequestOptionsJSON"
+        },
+        {
+          "name": "mediation",
+          "tags": [],
+          "docs": "Optional mediation hint. `conditional` currently falls back to an explicit prompt.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "origin",
+          "tags": [],
+          "docs": "Optional HTTPS origin to use for iOS 17.4+ browser-style clientDataJSON.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PasskeyPublicKeyCredentialRequestOptionsJSON",
+      "slug": "passkeypublickeycredentialrequestoptionsjson",
+      "docs": "JSON-safe authentication request options.\n\nAll binary fields must be base64url encoded.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "challenge",
+          "tags": [],
+          "docs": "Base64url-encoded challenge.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timeout",
+          "tags": [],
+          "docs": "Optional timeout hint in milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "rpId",
+          "tags": [],
+          "docs": "Optional relying party identifier.\n\nIf omitted, the shim derives it from the configured origin when possible.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "allowCredentials",
+          "tags": [],
+          "docs": "Optional allow list copied from WebAuthn.",
+          "complexTypes": [
+            "PasskeyCredentialDescriptor"
+          ],
+          "type": "PasskeyCredentialDescriptor[] | undefined"
+        },
+        {
+          "name": "userVerification",
+          "tags": [],
+          "docs": "Optional user verification preference.",
+          "complexTypes": [
+            "PasskeyUserVerification"
+          ],
+          "type": "PasskeyUserVerification"
+        },
+        {
+          "name": "hints",
+          "tags": [],
+          "docs": "Optional hints copied from the JSON form used by modern WebAuthn toolkits.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "extensions",
+          "tags": [],
+          "docs": "Optional extensions copied as-is into the request JSON.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "PasskeySupportResult",
+      "slug": "passkeysupportresult",
+      "docs": "Passkey support status for the current runtime.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [],
+          "docs": "Whether passkeys are available on the current runtime.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "conditionalMediation",
+          "tags": [],
+          "docs": "Whether conditional mediation is available.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "platform",
+          "tags": [],
+          "docs": "Current platform identifier.",
+          "complexTypes": [],
+          "type": "'ios' | 'android' | 'web'"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Plugin version payload.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "Version identifier reported by the current platform implementation.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PasskeyCredentialType",
+      "slug": "passkeycredentialtype",
+      "docs": "Supported WebAuthn credential type.",
+      "types": [
+        {
+          "text": "'public-key'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAuthenticatorAttachment",
+      "slug": "passkeyauthenticatorattachment",
+      "docs": "Supported authenticator attachment values.",
+      "types": [
+        {
+          "text": "'platform'",
+          "complexTypes": []
+        },
+        {
+          "text": "'cross-platform'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "PasskeyResidentKey",
+      "slug": "passkeyresidentkey",
+      "docs": "Supported resident key preferences.",
+      "types": [
+        {
+          "text": "'discouraged'",
+          "complexTypes": []
+        },
+        {
+          "text": "'preferred'",
+          "complexTypes": []
+        },
+        {
+          "text": "'required'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PasskeyUserVerification",
+      "slug": "passkeyuserverification",
+      "docs": "Supported user verification preferences.",
+      "types": [
+        {
+          "text": "'discouraged'",
+          "complexTypes": []
+        },
+        {
+          "text": "'preferred'",
+          "complexTypes": []
+        },
+        {
+          "text": "'required'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PasskeyAttestation",
+      "slug": "passkeyattestation",
+      "docs": "Supported attestation preferences.",
+      "types": [
+        {
+          "text": "'none'",
+          "complexTypes": []
+        },
+        {
+          "text": "'indirect'",
+          "complexTypes": []
+        },
+        {
+          "text": "'direct'",
+          "complexTypes": []
+        },
+        {
+          "text": "'enterprise'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}