@gatwech/auth 1.0.0-beta.18

package/dist/src/plugins/passkey/client.d.ts

@@ -0,0 +1,190 @@
+import type { ClientStore } from "@gatwech/core";
+import type { BetterFetch, BetterFetchOption } from "@better-fetch/fetch";
+import type { Session, User } from "../../types";
+import { atom } from "nanostores";
+import type { passkey } from ".";
+import type { Passkey } from "./types";
+export declare const getPasskeyActions: ($fetch: BetterFetch, { $listPasskeys, $store, }: {
+    $listPasskeys: ReturnType<typeof atom<any>>;
+    $store: ClientStore;
+}) => {
+    signIn: {
+        /**
+         * Sign in with a registered passkey
+         */
+        passkey: (opts?: {
+            autoFill?: boolean;
+            fetchOptions?: BetterFetchOption;
+        } | undefined, options?: BetterFetchOption | undefined) => Promise<{
+            data: null;
+            error: {
+                message?: string | undefined;
+                status: number;
+                statusText: string;
+            };
+        } | {
+            data: {
+                session: Session;
+                user: User;
+            };
+            error: null;
+        } | {
+            data: null;
+            error: {
+                code: string;
+                message: string;
+                status: number;
+                statusText: string;
+            };
+        }>;
+    };
+    passkey: {
+        /**
+         * Add a passkey to the user account
+         */
+        addPasskey: (opts?: {
+            fetchOptions?: BetterFetchOption;
+            /**
+             * The name of the passkey. This is used to
+             * identify the passkey in the UI.
+             */
+            name?: string;
+            /**
+             * The type of attachment for the passkey. Defaults to both
+             * platform and cross-platform allowed, with platform preferred.
+             */
+            authenticatorAttachment?: "platform" | "cross-platform";
+            /**
+             * Try to silently create a passkey with the password manager that the user just signed
+             * in with.
+             * @default false
+             */
+            useAutoRegister?: boolean;
+        } | undefined, fetchOpts?: BetterFetchOption | undefined) => Promise<{
+            data: null;
+            error: {
+                message?: string | undefined;
+                status: number;
+                statusText: string;
+            };
+        } | {
+            data: null;
+            error: {
+                code: string;
+                message: string;
+                status: number;
+                statusText: string;
+            };
+        } | undefined>;
+    };
+    /**
+     * Inferred Internal Types
+     */
+    $Infer: {
+        Passkey: Passkey;
+    };
+};
+export declare const passkeyClient: () => {
+    id: "passkey";
+    $InferServerPlugin: ReturnType<typeof passkey>;
+    getActions: ($fetch: BetterFetch, $store: ClientStore) => {
+        signIn: {
+            /**
+             * Sign in with a registered passkey
+             */
+            passkey: (opts?: {
+                autoFill?: boolean;
+                fetchOptions?: BetterFetchOption;
+            } | undefined, options?: BetterFetchOption | undefined) => Promise<{
+                data: null;
+                error: {
+                    message?: string | undefined;
+                    status: number;
+                    statusText: string;
+                };
+            } | {
+                data: {
+                    session: Session;
+                    user: User;
+                };
+                error: null;
+            } | {
+                data: null;
+                error: {
+                    code: string;
+                    message: string;
+                    status: number;
+                    statusText: string;
+                };
+            }>;
+        };
+        passkey: {
+            /**
+             * Add a passkey to the user account
+             */
+            addPasskey: (opts?: {
+                fetchOptions?: BetterFetchOption;
+                /**
+                 * The name of the passkey. This is used to
+                 * identify the passkey in the UI.
+                 */
+                name?: string;
+                /**
+                 * The type of attachment for the passkey. Defaults to both
+                 * platform and cross-platform allowed, with platform preferred.
+                 */
+                authenticatorAttachment?: "platform" | "cross-platform";
+                /**
+                 * Try to silently create a passkey with the password manager that the user just signed
+                 * in with.
+                 * @default false
+                 */
+                useAutoRegister?: boolean;
+            } | undefined, fetchOpts?: BetterFetchOption | undefined) => Promise<{
+                data: null;
+                error: {
+                    message?: string | undefined;
+                    status: number;
+                    statusText: string;
+                };
+            } | {
+                data: null;
+                error: {
+                    code: string;
+                    message: string;
+                    status: number;
+                    statusText: string;
+                };
+            } | undefined>;
+        };
+        /**
+         * Inferred Internal Types
+         */
+        $Infer: {
+            Passkey: Passkey;
+        };
+    };
+    getAtoms($fetch: BetterFetch): {
+        listPasskeys: import("nanostores").PreinitializedWritableAtom<{
+            data: Passkey[] | null;
+            error: null | import("@better-fetch/fetch").BetterFetchError;
+            isPending: boolean;
+            isRefetching: boolean;
+            refetch: (queryParams?: {
+                query?: import("../..").SessionQueryParams;
+            } | undefined) => void;
+        }> & object;
+        $listPasskeys: import("nanostores").PreinitializedWritableAtom<any> & object;
+    };
+    pathMethods: {
+        "/passkey/register": "POST";
+        "/passkey/authenticate": "POST";
+    };
+    atomListeners: ({
+        matcher(path: string): path is "/sign-out" | "/passkey/verify-registration" | "/passkey/delete-passkey" | "/passkey/update-passkey";
+        signal: "$listPasskeys";
+    } | {
+        matcher: (path: string) => path is "/passkey/verify-authentication";
+        signal: "$sessionSignal";
+    })[];
+};

package/dist/src/plugins/passkey/error-codes.d.ts

@@ -0,0 +1,9 @@
+export declare const PASSKEY_ERROR_CODES: {
+    readonly CHALLENGE_NOT_FOUND: "Challenge not found";
+    readonly YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY: "You are not allowed to register this passkey";
+    readonly FAILED_TO_VERIFY_REGISTRATION: "Failed to verify registration";
+    readonly PASSKEY_NOT_FOUND: "Passkey not found";
+    readonly AUTHENTICATION_FAILED: "Authentication failed";
+    readonly UNABLE_TO_CREATE_SESSION: "Unable to create session";
+    readonly FAILED_TO_UPDATE_PASSKEY: "Failed to update passkey";
+};