@capawesome/capacitor-passkeys 0.0.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,567 @@
+export interface PasskeysPlugin {
+    /**
+     * Create (register) a new passkey.
+     *
+     * The options mirror the WebAuthn `PublicKeyCredentialCreationOptions` JSON
+     * serialization so that the values provided by any WebAuthn server library
+     * can be passed through unchanged.
+     *
+     * @since 0.1.0
+     */
+    createPasskey(options: CreatePasskeyOptions): Promise<CreatePasskeyResult>;
+    /**
+     * Get (authenticate with) an existing passkey.
+     *
+     * The options mirror the WebAuthn `PublicKeyCredentialRequestOptions` JSON
+     * serialization so that the values provided by any WebAuthn server library
+     * can be passed through unchanged.
+     *
+     * @since 0.1.0
+     */
+    getPasskey(options: GetPasskeyOptions): Promise<GetPasskeyResult>;
+    /**
+     * Check if passkeys are available on this device.
+     *
+     * On **Android**, this returns `true` if the device runs Android 9 (API level 28) or higher.
+     * On **iOS**, this always returns `true`.
+     * On **Web**, this returns `true` if the browser supports WebAuthn and
+     * a user-verifying platform authenticator is available.
+     *
+     * @since 0.1.0
+     */
+    isAvailable(): Promise<IsAvailableResult>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface CreatePasskeyOptions {
+    /**
+     * The attestation conveyance preference.
+     *
+     * @since 0.1.0
+     * @default 'none'
+     * @example 'none'
+     */
+    attestation?: PasskeyAttestation;
+    /**
+     * Criteria that the authenticator must meet.
+     *
+     * @since 0.1.0
+     */
+    authenticatorSelection?: PasskeyAuthenticatorSelection;
+    /**
+     * The challenge provided by the relying party server as a
+     * base64url-encoded string.
+     *
+     * @since 0.1.0
+     * @example 'dGhpc2lzYWNoYWxsZW5nZQ'
+     */
+    challenge: string;
+    /**
+     * Credentials that already exist for the user, so that the authenticator
+     * does not create a second passkey for the same account.
+     *
+     * On **iOS**, this option is only applied on iOS 17.4 and later.
+     *
+     * @since 0.1.0
+     */
+    excludeCredentials?: PasskeyCredentialDescriptor[];
+    /**
+     * The public key credential types and algorithms that the relying
+     * party server supports, ordered from most to least preferred.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example [{ alg: -7, type: 'public-key' }, { alg: -257, type: 'public-key' }]
+     */
+    pubKeyCredParams: PasskeyCredentialParameter[];
+    /**
+     * The relying party for which the passkey is created.
+     *
+     * @since 0.1.0
+     */
+    rp: PasskeyRelyingParty;
+    /**
+     * The time in milliseconds that the caller is willing to wait for the
+     * operation to complete.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example 60000
+     */
+    timeout?: number;
+    /**
+     * The user account for which the passkey is created.
+     *
+     * @since 0.1.0
+     */
+    user: PasskeyUser;
+}
+/**
+ * The response of the authenticator for the registration of a new passkey.
+ *
+ * This mirrors the WebAuthn `AuthenticatorAttestationResponse` JSON
+ * serialization.
+ *
+ * @since 0.1.0
+ */
+export interface CreatePasskeyResponse {
+    /**
+     * The attestation object as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    attestationObject: string;
+    /**
+     * The authenticator data as a base64url-encoded string.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     */
+    authenticatorData?: string;
+    /**
+     * The client data as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    clientDataJSON: string;
+    /**
+     * The DER-encoded public key as a base64url-encoded string.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     */
+    publicKey?: string;
+    /**
+     * The COSE algorithm identifier of the public key.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example -7
+     */
+    publicKeyAlgorithm?: number;
+    /**
+     * The transports that the authenticator supports.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example ['internal', 'hybrid']
+     */
+    transports?: PasskeyTransport[];
+}
+/**
+ * The result of the passkey creation.
+ *
+ * This mirrors the WebAuthn `RegistrationResponseJSON` so it can be
+ * passed to any WebAuthn server library for verification.
+ *
+ * @since 0.1.0
+ */
+export interface CreatePasskeyResult {
+    /**
+     * The attachment of the authenticator that created the passkey.
+     *
+     * @since 0.1.0
+     * @example 'platform'
+     */
+    authenticatorAttachment?: PasskeyAuthenticatorAttachment;
+    /**
+     * The credential identifier as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    id: string;
+    /**
+     * The raw credential identifier as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    rawId: string;
+    /**
+     * The response of the authenticator.
+     *
+     * @since 0.1.0
+     */
+    response: CreatePasskeyResponse;
+    /**
+     * The credential type.
+     *
+     * @since 0.1.0
+     * @example 'public-key'
+     */
+    type: 'public-key';
+}
+/**
+ * @since 0.1.0
+ */
+export interface GetPasskeyOptions {
+    /**
+     * The credentials that are acceptable to the relying party server.
+     *
+     * If not provided, the user can select from any discoverable
+     * credential (passkey) of the relying party.
+     *
+     * @since 0.1.0
+     */
+    allowCredentials?: PasskeyCredentialDescriptor[];
+    /**
+     * The challenge provided by the relying party server as a
+     * base64url-encoded string.
+     *
+     * @since 0.1.0
+     * @example 'dGhpc2lzYWNoYWxsZW5nZQ'
+     */
+    challenge: string;
+    /**
+     * The identifier of the relying party.
+     *
+     * @since 0.1.0
+     * @example 'example.com'
+     */
+    rpId: string;
+    /**
+     * The time in milliseconds that the caller is willing to wait for the
+     * operation to complete.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example 60000
+     */
+    timeout?: number;
+    /**
+     * The user verification requirement.
+     *
+     * @since 0.1.0
+     * @default 'preferred'
+     * @example 'required'
+     */
+    userVerification?: PasskeyUserVerification;
+}
+/**
+ * The response of the authenticator for the authentication with an
+ * existing passkey.
+ *
+ * This mirrors the WebAuthn `AuthenticatorAssertionResponse` JSON
+ * serialization.
+ *
+ * @since 0.1.0
+ */
+export interface GetPasskeyResponse {
+    /**
+     * The authenticator data as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    authenticatorData: string;
+    /**
+     * The client data as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    clientDataJSON: string;
+    /**
+     * The signature as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    signature: string;
+    /**
+     * The user handle (the `user.id` provided during creation) as a
+     * base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    userHandle?: string;
+}
+/**
+ * The result of the passkey authentication.
+ *
+ * This mirrors the WebAuthn `AuthenticationResponseJSON` so it can be
+ * passed to any WebAuthn server library for verification.
+ *
+ * @since 0.1.0
+ */
+export interface GetPasskeyResult {
+    /**
+     * The attachment of the authenticator that provided the passkey.
+     *
+     * @since 0.1.0
+     * @example 'platform'
+     */
+    authenticatorAttachment?: PasskeyAuthenticatorAttachment;
+    /**
+     * The credential identifier as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    id: string;
+    /**
+     * The raw credential identifier as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    rawId: string;
+    /**
+     * The response of the authenticator.
+     *
+     * @since 0.1.0
+     */
+    response: GetPasskeyResponse;
+    /**
+     * The credential type.
+     *
+     * @since 0.1.0
+     * @example 'public-key'
+     */
+    type: 'public-key';
+}
+/**
+ * @since 0.1.0
+ */
+export interface IsAvailableResult {
+    /**
+     * Whether or not passkeys are available on this device.
+     *
+     * @since 0.1.0
+     * @example true
+     */
+    available: boolean;
+}
+/**
+ * Criteria that the authenticator must meet to create a passkey.
+ *
+ * @since 0.1.0
+ */
+export interface PasskeyAuthenticatorSelection {
+    /**
+     * The authenticator attachment modality.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example 'platform'
+     */
+    authenticatorAttachment?: PasskeyAuthenticatorAttachment;
+    /**
+     * Whether or not a discoverable credential (passkey) is required.
+     *
+     * This property is retained for backwards compatibility with
+     * WebAuthn Level 1. Prefer `residentKey`.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example true
+     */
+    requireResidentKey?: boolean;
+    /**
+     * The extent to which the relying party desires to create a
+     * discoverable credential (passkey).
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example 'required'
+     */
+    residentKey?: PasskeyResidentKey;
+    /**
+     * The user verification requirement.
+     *
+     * @since 0.1.0
+     * @default 'preferred'
+     * @example 'required'
+     */
+    userVerification?: PasskeyUserVerification;
+}
+/**
+ * A descriptor that identifies a specific credential.
+ *
+ * @since 0.1.0
+ */
+export interface PasskeyCredentialDescriptor {
+    /**
+     * The credential identifier as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     */
+    id: string;
+    /**
+     * The transports that the authenticator of the credential supports.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example ['internal', 'hybrid']
+     */
+    transports?: PasskeyTransport[];
+    /**
+     * The credential type.
+     *
+     * @since 0.1.0
+     * @example 'public-key'
+     */
+    type: 'public-key';
+}
+/**
+ * A public key credential type and algorithm that the relying party
+ * server supports.
+ *
+ * @since 0.1.0
+ */
+export interface PasskeyCredentialParameter {
+    /**
+     * The COSE algorithm identifier, e.g. `-7` for ES256 or `-257` for RS256.
+     *
+     * @since 0.1.0
+     * @example -7
+     */
+    alg: number;
+    /**
+     * The credential type.
+     *
+     * @since 0.1.0
+     * @example 'public-key'
+     */
+    type: 'public-key';
+}
+/**
+ * The relying party for which a passkey is created.
+ *
+ * @since 0.1.0
+ */
+export interface PasskeyRelyingParty {
+    /**
+     * The identifier of the relying party.
+     *
+     * This must be a registrable domain suffix of (or equal to) the
+     * domain that the app is associated with.
+     *
+     * @since 0.1.0
+     * @example 'example.com'
+     */
+    id: string;
+    /**
+     * The human-readable name of the relying party.
+     *
+     * @since 0.1.0
+     * @example 'Example Inc.'
+     */
+    name: string;
+}
+/**
+ * The user account for which a passkey is created.
+ *
+ * @since 0.1.0
+ */
+export interface PasskeyUser {
+    /**
+     * The human-readable display name of the user account.
+     *
+     * @since 0.1.0
+     * @example 'Jane Doe'
+     */
+    displayName: string;
+    /**
+     * The user handle of the user account as a base64url-encoded string.
+     *
+     * @since 0.1.0
+     * @example 'anVzdGFyYW5kb21pZA'
+     */
+    id: string;
+    /**
+     * The human-readable name of the user account, e.g. a username
+     * or email address.
+     *
+     * @since 0.1.0
+     * @example 'jane.doe@example.com'
+     */
+    name: string;
+}
+/**
+ * The attestation conveyance preference.
+ *
+ * @since 0.1.0
+ */
+export type PasskeyAttestation = 'direct' | 'enterprise' | 'indirect' | 'none';
+/**
+ * The authenticator attachment modality.
+ *
+ * @since 0.1.0
+ */
+export type PasskeyAuthenticatorAttachment = 'cross-platform' | 'platform';
+/**
+ * The extent to which the relying party desires to create a
+ * discoverable credential (passkey).
+ *
+ * @since 0.1.0
+ */
+export type PasskeyResidentKey = 'discouraged' | 'preferred' | 'required';
+/**
+ * A transport that an authenticator supports.
+ *
+ * @since 0.1.0
+ */
+export type PasskeyTransport = 'ble' | 'hybrid' | 'internal' | 'nfc' | 'smart-card' | 'usb';
+/**
+ * The user verification requirement.
+ *
+ * - `discouraged`: The relying party prefers no user verification.
+ * - `preferred`: The relying party prefers user verification but will
+ *   not fail the operation without it.
+ * - `required`: The relying party requires user verification.
+ *
+ * @since 0.1.0
+ */
+export type PasskeyUserVerification = 'discouraged' | 'preferred' | 'required';
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The operation was canceled by the user.
+     *
+     * @since 0.1.0
+     */
+    Canceled = "CANCELED",
+    /**
+     * The passkey could not be created.
+     *
+     * @since 0.1.0
+     */
+    CreateFailed = "CREATE_FAILED",
+    /**
+     * The app is not associated with the relying party domain.
+     *
+     * On **Android**, make sure that the Digital Asset Links file is set up
+     * correctly. On **iOS**, make sure that the Associated Domains
+     * entitlement is set up correctly.
+     *
+     * @since 0.1.0
+     */
+    DomainNotAssociated = "DOMAIN_NOT_ASSOCIATED",
+    /**
+     * The passkey could not be retrieved.
+     *
+     * @since 0.1.0
+     */
+    GetFailed = "GET_FAILED",
+    /**
+     * No matching passkey was found.
+     *
+     * @since 0.1.0
+     */
+    NoCredential = "NO_CREDENTIAL",
+    /**
+     * Passkeys are not supported on this device.
+     *
+     * @since 0.1.0
+     */
+    NotSupported = "NOT_SUPPORTED"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,47 @@
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The operation was canceled by the user.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["Canceled"] = "CANCELED";
+    /**
+     * The passkey could not be created.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["CreateFailed"] = "CREATE_FAILED";
+    /**
+     * The app is not associated with the relying party domain.
+     *
+     * On **Android**, make sure that the Digital Asset Links file is set up
+     * correctly. On **iOS**, make sure that the Associated Domains
+     * entitlement is set up correctly.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["DomainNotAssociated"] = "DOMAIN_NOT_ASSOCIATED";
+    /**
+     * The passkey could not be retrieved.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["GetFailed"] = "GET_FAILED";
+    /**
+     * No matching passkey was found.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["NoCredential"] = "NO_CREDENTIAL";
+    /**
+     * Passkeys are not supported on this device.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["NotSupported"] = "NOT_SUPPORTED";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAkiBA;;GAEG;AACH,MAAM,CAAN,IAAY,SAyCX;AAzCD,WAAY,SAAS;IACnB;;;;OAIG;IACH,kCAAqB,CAAA;IACrB;;;;OAIG;IACH,2CAA8B,CAAA;IAC9B;;;;;;;;OAQG;IACH,0DAA6C,CAAA;IAC7C;;;;OAIG;IACH,qCAAwB,CAAA;IACxB;;;;OAIG;IACH,2CAA8B,CAAA;IAC9B;;;;OAIG;IACH,2CAA8B,CAAA;AAChC,CAAC,EAzCW,SAAS,KAAT,SAAS,QAyCpB","sourcesContent":["export interface PasskeysPlugin {\n  /**\n   * Create (register) a new passkey.\n   *\n   * The options mirror the WebAuthn `PublicKeyCredentialCreationOptions` JSON\n   * serialization so that the values provided by any WebAuthn server library\n   * can be passed through unchanged.\n   *\n   * @since 0.1.0\n   */\n  createPasskey(options: CreatePasskeyOptions): Promise<CreatePasskeyResult>;\n  /**\n   * Get (authenticate with) an existing passkey.\n   *\n   * The options mirror the WebAuthn `PublicKeyCredentialRequestOptions` JSON\n   * serialization so that the values provided by any WebAuthn server library\n   * can be passed through unchanged.\n   *\n   * @since 0.1.0\n   */\n  getPasskey(options: GetPasskeyOptions): Promise<GetPasskeyResult>;\n  /**\n   * Check if passkeys are available on this device.\n   *\n   * On **Android**, this returns `true` if the device runs Android 9 (API level 28) or higher.\n   * On **iOS**, this always returns `true`.\n   * On **Web**, this returns `true` if the browser supports WebAuthn and\n   * a user-verifying platform authenticator is available.\n   *\n   * @since 0.1.0\n   */\n  isAvailable(): Promise<IsAvailableResult>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface CreatePasskeyOptions {\n  /**\n   * The attestation conveyance preference.\n   *\n   * @since 0.1.0\n   * @default 'none'\n   * @example 'none'\n   */\n  attestation?: PasskeyAttestation;\n  /**\n   * Criteria that the authenticator must meet.\n   *\n   * @since 0.1.0\n   */\n  authenticatorSelection?: PasskeyAuthenticatorSelection;\n  /**\n   * The challenge provided by the relying party server as a\n   * base64url-encoded string.\n   *\n   * @since 0.1.0\n   * @example 'dGhpc2lzYWNoYWxsZW5nZQ'\n   */\n  challenge: string;\n  /**\n   * Credentials that already exist for the user, so that the authenticator\n   * does not create a second passkey for the same account.\n   *\n   * On **iOS**, this option is only applied on iOS 17.4 and later.\n   *\n   * @since 0.1.0\n   */\n  excludeCredentials?: PasskeyCredentialDescriptor[];\n  /**\n   * The public key credential types and algorithms that the relying\n   * party server supports, ordered from most to least preferred.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example [{ alg: -7, type: 'public-key' }, { alg: -257, type: 'public-key' }]\n   */\n  pubKeyCredParams: PasskeyCredentialParameter[];\n  /**\n   * The relying party for which the passkey is created.\n   *\n   * @since 0.1.0\n   */\n  rp: PasskeyRelyingParty;\n  /**\n   * The time in milliseconds that the caller is willing to wait for the\n   * operation to complete.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example 60000\n   */\n  timeout?: number;\n  /**\n   * The user account for which the passkey is created.\n   *\n   * @since 0.1.0\n   */\n  user: PasskeyUser;\n}\n\n/**\n * The response of the authenticator for the registration of a new passkey.\n *\n * This mirrors the WebAuthn `AuthenticatorAttestationResponse` JSON\n * serialization.\n *\n * @since 0.1.0\n */\nexport interface CreatePasskeyResponse {\n  /**\n   * The attestation object as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  attestationObject: string;\n  /**\n   * The authenticator data as a base64url-encoded string.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   */\n  authenticatorData?: string;\n  /**\n   * The client data as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  clientDataJSON: string;\n  /**\n   * The DER-encoded public key as a base64url-encoded string.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   */\n  publicKey?: string;\n  /**\n   * The COSE algorithm identifier of the public key.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example -7\n   */\n  publicKeyAlgorithm?: number;\n  /**\n   * The transports that the authenticator supports.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example ['internal', 'hybrid']\n   */\n  transports?: PasskeyTransport[];\n}\n\n/**\n * The result of the passkey creation.\n *\n * This mirrors the WebAuthn `RegistrationResponseJSON` so it can be\n * passed to any WebAuthn server library for verification.\n *\n * @since 0.1.0\n */\nexport interface CreatePasskeyResult {\n  /**\n   * The attachment of the authenticator that created the passkey.\n   *\n   * @since 0.1.0\n   * @example 'platform'\n   */\n  authenticatorAttachment?: PasskeyAuthenticatorAttachment;\n  /**\n   * The credential identifier as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  id: string;\n  /**\n   * The raw credential identifier as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  rawId: string;\n  /**\n   * The response of the authenticator.\n   *\n   * @since 0.1.0\n   */\n  response: CreatePasskeyResponse;\n  /**\n   * The credential type.\n   *\n   * @since 0.1.0\n   * @example 'public-key'\n   */\n  type: 'public-key';\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GetPasskeyOptions {\n  /**\n   * The credentials that are acceptable to the relying party server.\n   *\n   * If not provided, the user can select from any discoverable\n   * credential (passkey) of the relying party.\n   *\n   * @since 0.1.0\n   */\n  allowCredentials?: PasskeyCredentialDescriptor[];\n  /**\n   * The challenge provided by the relying party server as a\n   * base64url-encoded string.\n   *\n   * @since 0.1.0\n   * @example 'dGhpc2lzYWNoYWxsZW5nZQ'\n   */\n  challenge: string;\n  /**\n   * The identifier of the relying party.\n   *\n   * @since 0.1.0\n   * @example 'example.com'\n   */\n  rpId: string;\n  /**\n   * The time in milliseconds that the caller is willing to wait for the\n   * operation to complete.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example 60000\n   */\n  timeout?: number;\n  /**\n   * The user verification requirement.\n   *\n   * @since 0.1.0\n   * @default 'preferred'\n   * @example 'required'\n   */\n  userVerification?: PasskeyUserVerification;\n}\n\n/**\n * The response of the authenticator for the authentication with an\n * existing passkey.\n *\n * This mirrors the WebAuthn `AuthenticatorAssertionResponse` JSON\n * serialization.\n *\n * @since 0.1.0\n */\nexport interface GetPasskeyResponse {\n  /**\n   * The authenticator data as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  authenticatorData: string;\n  /**\n   * The client data as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  clientDataJSON: string;\n  /**\n   * The signature as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  signature: string;\n  /**\n   * The user handle (the `user.id` provided during creation) as a\n   * base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  userHandle?: string;\n}\n\n/**\n * The result of the passkey authentication.\n *\n * This mirrors the WebAuthn `AuthenticationResponseJSON` so it can be\n * passed to any WebAuthn server library for verification.\n *\n * @since 0.1.0\n */\nexport interface GetPasskeyResult {\n  /**\n   * The attachment of the authenticator that provided the passkey.\n   *\n   * @since 0.1.0\n   * @example 'platform'\n   */\n  authenticatorAttachment?: PasskeyAuthenticatorAttachment;\n  /**\n   * The credential identifier as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  id: string;\n  /**\n   * The raw credential identifier as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  rawId: string;\n  /**\n   * The response of the authenticator.\n   *\n   * @since 0.1.0\n   */\n  response: GetPasskeyResponse;\n  /**\n   * The credential type.\n   *\n   * @since 0.1.0\n   * @example 'public-key'\n   */\n  type: 'public-key';\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IsAvailableResult {\n  /**\n   * Whether or not passkeys are available on this device.\n   *\n   * @since 0.1.0\n   * @example true\n   */\n  available: boolean;\n}\n\n/**\n * Criteria that the authenticator must meet to create a passkey.\n *\n * @since 0.1.0\n */\nexport interface PasskeyAuthenticatorSelection {\n  /**\n   * The authenticator attachment modality.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example 'platform'\n   */\n  authenticatorAttachment?: PasskeyAuthenticatorAttachment;\n  /**\n   * Whether or not a discoverable credential (passkey) is required.\n   *\n   * This property is retained for backwards compatibility with\n   * WebAuthn Level 1. Prefer `residentKey`.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example true\n   */\n  requireResidentKey?: boolean;\n  /**\n   * The extent to which the relying party desires to create a\n   * discoverable credential (passkey).\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example 'required'\n   */\n  residentKey?: PasskeyResidentKey;\n  /**\n   * The user verification requirement.\n   *\n   * @since 0.1.0\n   * @default 'preferred'\n   * @example 'required'\n   */\n  userVerification?: PasskeyUserVerification;\n}\n\n/**\n * A descriptor that identifies a specific credential.\n *\n * @since 0.1.0\n */\nexport interface PasskeyCredentialDescriptor {\n  /**\n   * The credential identifier as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   */\n  id: string;\n  /**\n   * The transports that the authenticator of the credential supports.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example ['internal', 'hybrid']\n   */\n  transports?: PasskeyTransport[];\n  /**\n   * The credential type.\n   *\n   * @since 0.1.0\n   * @example 'public-key'\n   */\n  type: 'public-key';\n}\n\n/**\n * A public key credential type and algorithm that the relying party\n * server supports.\n *\n * @since 0.1.0\n */\nexport interface PasskeyCredentialParameter {\n  /**\n   * The COSE algorithm identifier, e.g. `-7` for ES256 or `-257` for RS256.\n   *\n   * @since 0.1.0\n   * @example -7\n   */\n  alg: number;\n  /**\n   * The credential type.\n   *\n   * @since 0.1.0\n   * @example 'public-key'\n   */\n  type: 'public-key';\n}\n\n/**\n * The relying party for which a passkey is created.\n *\n * @since 0.1.0\n */\nexport interface PasskeyRelyingParty {\n  /**\n   * The identifier of the relying party.\n   *\n   * This must be a registrable domain suffix of (or equal to) the\n   * domain that the app is associated with.\n   *\n   * @since 0.1.0\n   * @example 'example.com'\n   */\n  id: string;\n  /**\n   * The human-readable name of the relying party.\n   *\n   * @since 0.1.0\n   * @example 'Example Inc.'\n   */\n  name: string;\n}\n\n/**\n * The user account for which a passkey is created.\n *\n * @since 0.1.0\n */\nexport interface PasskeyUser {\n  /**\n   * The human-readable display name of the user account.\n   *\n   * @since 0.1.0\n   * @example 'Jane Doe'\n   */\n  displayName: string;\n  /**\n   * The user handle of the user account as a base64url-encoded string.\n   *\n   * @since 0.1.0\n   * @example 'anVzdGFyYW5kb21pZA'\n   */\n  id: string;\n  /**\n   * The human-readable name of the user account, e.g. a username\n   * or email address.\n   *\n   * @since 0.1.0\n   * @example 'jane.doe@example.com'\n   */\n  name: string;\n}\n\n/**\n * The attestation conveyance preference.\n *\n * @since 0.1.0\n */\nexport type PasskeyAttestation = 'direct' | 'enterprise' | 'indirect' | 'none';\n\n/**\n * The authenticator attachment modality.\n *\n * @since 0.1.0\n */\nexport type PasskeyAuthenticatorAttachment = 'cross-platform' | 'platform';\n\n/**\n * The extent to which the relying party desires to create a\n * discoverable credential (passkey).\n *\n * @since 0.1.0\n */\nexport type PasskeyResidentKey = 'discouraged' | 'preferred' | 'required';\n\n/**\n * A transport that an authenticator supports.\n *\n * @since 0.1.0\n */\nexport type PasskeyTransport =\n  | 'ble'\n  | 'hybrid'\n  | 'internal'\n  | 'nfc'\n  | 'smart-card'\n  | 'usb';\n\n/**\n * The user verification requirement.\n *\n * - `discouraged`: The relying party prefers no user verification.\n * - `preferred`: The relying party prefers user verification but will\n *   not fail the operation without it.\n * - `required`: The relying party requires user verification.\n *\n * @since 0.1.0\n */\nexport type PasskeyUserVerification = 'discouraged' | 'preferred' | 'required';\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The operation was canceled by the user.\n   *\n   * @since 0.1.0\n   */\n  Canceled = 'CANCELED',\n  /**\n   * The passkey could not be created.\n   *\n   * @since 0.1.0\n   */\n  CreateFailed = 'CREATE_FAILED',\n  /**\n   * The app is not associated with the relying party domain.\n   *\n   * On **Android**, make sure that the Digital Asset Links file is set up\n   * correctly. On **iOS**, make sure that the Associated Domains\n   * entitlement is set up correctly.\n   *\n   * @since 0.1.0\n   */\n  DomainNotAssociated = 'DOMAIN_NOT_ASSOCIATED',\n  /**\n   * The passkey could not be retrieved.\n   *\n   * @since 0.1.0\n   */\n  GetFailed = 'GET_FAILED',\n  /**\n   * No matching passkey was found.\n   *\n   * @since 0.1.0\n   */\n  NoCredential = 'NO_CREDENTIAL',\n  /**\n   * Passkeys are not supported on this device.\n   *\n   * @since 0.1.0\n   */\n  NotSupported = 'NOT_SUPPORTED',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { PasskeysPlugin } from './definitions';
+declare const Passkeys: PasskeysPlugin;
+export * from './definitions';
+export { Passkeys };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Passkeys = registerPlugin('Passkeys', {
+    web: () => import('./web').then(m => new m.PasskeysWeb()),
+});
+export * from './definitions';
+export { Passkeys };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,QAAQ,GAAG,cAAc,CAAiB,UAAU,EAAE;IAC1D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;CAC1D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { PasskeysPlugin } from './definitions';\n\nconst Passkeys = registerPlugin<PasskeysPlugin>('Passkeys', {\n  web: () => import('./web').then(m => new m.PasskeysWeb()),\n});\n\nexport * from './definitions';\nexport { Passkeys };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,18 @@
+import { WebPlugin } from '@capacitor/core';
+import type { CreatePasskeyOptions, CreatePasskeyResult, GetPasskeyOptions, GetPasskeyResult, IsAvailableResult, PasskeysPlugin } from './definitions';
+export declare class PasskeysWeb extends WebPlugin implements PasskeysPlugin {
+    private static readonly errorCreateFailed;
+    private static readonly errorGetFailed;
+    private static readonly errorNotSupported;
+    createPasskey(options: CreatePasskeyOptions): Promise<CreatePasskeyResult>;
+    getPasskey(options: GetPasskeyOptions): Promise<GetPasskeyResult>;
+    isAvailable(): Promise<IsAvailableResult>;
+    private static arrayBufferToBase64Url;
+    private static base64UrlToArrayBuffer;
+    private static createException;
+    private static createNotSupportedException;
+    private static isWebAuthnSupported;
+    private static parseCreationOptions;
+    private static parseRequestOptions;
+    private static serializeCredential;
+}