@better-auth/electron 1.5.0-beta.12

package/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2024 - present, Bereket Engida
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# Better Auth Electron Plugin
+
+This plugin integrates Better Auth with Electron, allowing you to easily add
+authentication to your Electron applications.
+
+- **Main Better Auth Installation:** [Installation Guide][]
+- **Electron Integration Guide:** [Electron Integration Guide][]
+
+## License
+
+MIT
+
+[electron integration guide]: https://www.better-auth.com/docs/integrations/electron
+[installation guide]: https://www.better-auth.com/docs/installation

package/dist/authenticate-CWAVJ4W8.d.mts

@@ -0,0 +1,129 @@
+import * as z from "zod";
+import { BetterFetch } from "@better-fetch/fetch";
+
+//#region src/types/client.d.ts
+interface Storage {
+  getItem: (name: string) => unknown | null;
+  setItem: (name: string, value: unknown) => void;
+}
+interface ElectronClientOptions {
+  /**
+   * The URL to redirect to for authentication.
+   *
+   * @example "http://localhost:3000/sign-in"
+   */
+  signInURL: string | URL;
+  /**
+   * The protocol scheme to use for deep linking in Electron.
+   *
+   * Should follow the reverse domain name notation to ensure uniqueness.
+   *
+   * @see {@link https://datatracker.ietf.org/doc/html/rfc8252#section-7.1}
+   * @example "com.example.app"
+   */
+  protocol: string | {
+    scheme: string;
+    privileges?: Electron.Privileges | undefined;
+  };
+  /**
+   * The callback path to use for authentication redirects.
+   *
+   * @default "/auth/callback"
+   */
+  callbackPath?: string;
+  /**
+   * An instance of a storage solution (e.g., `electron-store`)
+   * to store session and cookie data.
+   *
+   * @example
+   * ```ts
+   * electronClient({
+   *   storage: window.localStorage,
+   * });
+   * ```
+   */
+  storage: Storage;
+  /**
+   * Prefix for local storage keys (e.g., "my-app_cookie", "my-app_session_data")
+   * @default "better-auth"
+   */
+  storagePrefix?: string | undefined;
+  /**
+   * Prefix(es) for server cookie names to filter (e.g., "better-auth.session_token")
+   * This is used to identify which cookies belong to better-auth to prevent
+   * infinite refetching when third-party cookies are set.
+   *
+   * Can be a single string or an array of strings to match multiple prefixes.
+   *
+   * @default "better-auth"
+   * @example "better-auth"
+   * @example ["better-auth", "my-app"]
+   */
+  cookiePrefix?: string | string[] | undefined;
+  /**
+   * Channel prefix for IPC bridges (e.g., "better-auth:request-auth")
+   *
+   * @default "better-auth"
+   */
+  channelPrefix?: string | undefined;
+  /**
+   * Client ID to use for identifying the Electron client during authorization.
+   *
+   * @default "electron"
+   */
+  clientID?: string | undefined;
+  /**
+   * Whether to disable caching the session data locally.
+   *
+   * @default false
+   */
+  disableCache?: boolean | undefined;
+}
+interface ElectronProxyClientOptions {
+  /**
+   * The protocol scheme to use for deep linking in Electron.
+   *
+   * Should follow the reverse domain name notation to ensure uniqueness.
+   *
+   * Note that this must match the protocol scheme registered in the server plugin.
+   *
+   * @see {@link https://datatracker.ietf.org/doc/html/rfc8252#section-7.1}
+   * @example "com.example.app"
+   */
+  protocol: string | {
+    scheme: string;
+  };
+  /**
+   * The callback path to use for authentication redirects.
+   *
+   * @default "/auth/callback"
+   */
+  callbackPath?: string;
+  /**
+   * Client ID to use for identifying the Electron client during authorization.
+   *
+   * @default "electron"
+   */
+  clientID?: string | undefined;
+  /**
+   * The prefix to use for cookies set by the plugin.
+   *
+   * @default "better-auth"
+   */
+  cookiePrefix?: string | undefined;
+}
+//#endregion
+//#region src/authenticate.d.ts
+declare const requestAuthOptionsSchema: z.ZodObject<{
+  provider: z.ZodOptional<z.ZodString>;
+  callbackURL: z.ZodOptional<z.ZodString>;
+  newUserCallbackURL: z.ZodOptional<z.ZodString>;
+  errorCallbackURL: z.ZodOptional<z.ZodString>;
+  disableRedirect: z.ZodOptional<z.ZodBoolean>;
+  scopes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  requestSignUp: z.ZodOptional<z.ZodBoolean>;
+  additionalData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+type ElectronRequestAuthOptions = z.infer<typeof requestAuthOptionsSchema>;
+//#endregion
+export { Storage as i, ElectronClientOptions as n, ElectronProxyClientOptions as r, ElectronRequestAuthOptions as t };

package/dist/client-BBp9yCmE.d.mts

@@ -0,0 +1,224 @@
+import { n as ElectronClientOptions, t as ElectronRequestAuthOptions } from "./authenticate-CWAVJ4W8.mjs";
+import * as better_auth27 from "better-auth";
+import { ClientStore, User } from "better-auth";
+import * as _better_fetch_fetch0 from "@better-fetch/fetch";
+import { BetterFetch, BetterFetchError } from "@better-fetch/fetch";
+import electron from "electron";
+
+//#region src/bridges.d.ts
+/**
+ * Exposes IPC bridges to the renderer process.
+ */
+declare function exposeBridges(opts: ElectronClientOptions): {
+  $InferBridges: {
+    getUser: () => Promise<{
+      id: string;
+      createdAt: Date;
+      updatedAt: Date;
+      email: string;
+      emailVerified: boolean;
+      name: string;
+      image?: string | null | undefined;
+    } & Record<string, any>>;
+    requestAuth: (options?: ElectronRequestAuthOptions) => Promise<void>;
+    signOut: () => Promise<void>;
+    onAuthenticated: (callback: (user: User & Record<string, any>) => unknown) => () => void;
+    onUserUpdated: (callback: (user: (User & Record<string, any>) | null) => unknown) => () => void;
+    onAuthError: (callback: (context: BetterFetchError & {
+      path: string;
+    }) => unknown) => () => void;
+  };
+};
+//#endregion
+//#region src/setup.d.ts
+type SetupMainConfig = {
+  getWindow?: () => electron.BrowserWindow | null | undefined;
+  csp?: boolean | undefined;
+  bridges?: boolean | undefined;
+  scheme?: boolean | undefined;
+};
+/**
+ * Handles the deep link URL for authentication.
+ */
+declare function handleDeepLink({
+  $fetch,
+  options,
+  url,
+  getWindow
+}: {
+  $fetch: BetterFetch;
+  options: ElectronClientOptions;
+  url: string;
+  getWindow?: SetupMainConfig["getWindow"] | undefined;
+}): Promise<void>;
+//#endregion
+//#region src/client.d.ts
+declare const electronClient: (options: ElectronClientOptions) => {
+  id: "electron";
+  fetchPlugins: {
+    id: string;
+    name: string;
+    init(url: string, options: ({
+      headers?: (HeadersInit & (HeadersInit | {
+        accept: "application/json" | "text/plain" | "application/octet-stream";
+        "content-type": "application/json" | "text/plain" | "application/x-www-form-urlencoded" | "multipart/form-data" | "application/octet-stream";
+        authorization: "Bearer" | "Basic";
+      })) | undefined;
+      method?: string | undefined;
+      redirect?: RequestRedirect | undefined;
+      cache?: RequestCache | undefined;
+      credentials?: RequestCredentials | undefined;
+      integrity?: string | undefined;
+      keepalive?: boolean | undefined;
+      mode?: RequestMode | undefined;
+      priority?: RequestPriority | undefined;
+      referrer?: string | undefined;
+      referrerPolicy?: ReferrerPolicy | undefined;
+      signal?: (AbortSignal | null) | undefined;
+      window?: null | undefined;
+      onRequest?: (<T extends Record<string, any>>(context: _better_fetch_fetch0.RequestContext<T>) => Promise<_better_fetch_fetch0.RequestContext | void> | _better_fetch_fetch0.RequestContext | void) | undefined;
+      onResponse?: ((context: _better_fetch_fetch0.ResponseContext) => Promise<Response | void | _better_fetch_fetch0.ResponseContext> | Response | _better_fetch_fetch0.ResponseContext | void) | undefined;
+      onSuccess?: ((context: _better_fetch_fetch0.SuccessContext<any>) => Promise<void> | void) | undefined;
+      onError?: ((context: _better_fetch_fetch0.ErrorContext) => Promise<void> | void) | undefined;
+      onRetry?: ((response: _better_fetch_fetch0.ResponseContext) => Promise<void> | void) | undefined;
+      hookOptions?: {
+        cloneResponse?: boolean;
+      } | undefined;
+      timeout?: number | undefined;
+      customFetchImpl?: _better_fetch_fetch0.FetchEsque | undefined;
+      plugins?: _better_fetch_fetch0.BetterFetchPlugin[] | undefined;
+      baseURL?: string | undefined;
+      throw?: boolean | undefined;
+      auth?: ({
+        type: "Bearer";
+        token: string | Promise<string | undefined> | (() => string | Promise<string | undefined> | undefined) | undefined;
+      } | {
+        type: "Basic";
+        username: string | (() => string | undefined) | undefined;
+        password: string | (() => string | undefined) | undefined;
+      } | {
+        type: "Custom";
+        prefix: string | (() => string | undefined) | undefined;
+        value: string | (() => string | undefined) | undefined;
+      }) | undefined;
+      body?: any;
+      query?: any;
+      params?: any;
+      duplex?: "full" | "half" | undefined;
+      jsonParser?: ((text: string) => Promise<any> | any) | undefined;
+      retry?: _better_fetch_fetch0.RetryOptions | undefined;
+      retryAttempt?: number | undefined;
+      output?: (_better_fetch_fetch0.StandardSchemaV1 | typeof Blob | typeof File) | undefined;
+      errorSchema?: _better_fetch_fetch0.StandardSchemaV1 | undefined;
+      disableValidation?: boolean | undefined;
+    } & Record<string, any>) | undefined): Promise<{
+      url: string;
+      options: {
+        headers?: (HeadersInit & (HeadersInit | {
+          accept: "application/json" | "text/plain" | "application/octet-stream";
+          "content-type": "application/json" | "text/plain" | "application/x-www-form-urlencoded" | "multipart/form-data" | "application/octet-stream";
+          authorization: "Bearer" | "Basic";
+        })) | undefined;
+        method?: string | undefined;
+        redirect?: RequestRedirect | undefined;
+        cache?: RequestCache | undefined;
+        credentials?: RequestCredentials | undefined;
+        integrity?: string | undefined;
+        keepalive?: boolean | undefined;
+        mode?: RequestMode | undefined;
+        priority?: RequestPriority | undefined;
+        referrer?: string | undefined;
+        referrerPolicy?: ReferrerPolicy | undefined;
+        signal?: (AbortSignal | null) | undefined;
+        window?: null | undefined;
+        onRequest?: (<T extends Record<string, any>>(context: _better_fetch_fetch0.RequestContext<T>) => Promise<_better_fetch_fetch0.RequestContext | void> | _better_fetch_fetch0.RequestContext | void) | undefined;
+        onResponse?: ((context: _better_fetch_fetch0.ResponseContext) => Promise<Response | void | _better_fetch_fetch0.ResponseContext> | Response | _better_fetch_fetch0.ResponseContext | void) | undefined;
+        onSuccess?: ((context: _better_fetch_fetch0.SuccessContext<any>) => Promise<void> | void) | undefined;
+        onError?: ((context: _better_fetch_fetch0.ErrorContext) => Promise<void> | void) | undefined;
+        onRetry?: ((response: _better_fetch_fetch0.ResponseContext) => Promise<void> | void) | undefined;
+        hookOptions?: {
+          cloneResponse?: boolean;
+        } | undefined;
+        timeout?: number | undefined;
+        customFetchImpl?: _better_fetch_fetch0.FetchEsque | undefined;
+        plugins?: _better_fetch_fetch0.BetterFetchPlugin[] | undefined;
+        baseURL?: string | undefined;
+        throw?: boolean | undefined;
+        auth?: ({
+          type: "Bearer";
+          token: string | Promise<string | undefined> | (() => string | Promise<string | undefined> | undefined) | undefined;
+        } | {
+          type: "Basic";
+          username: string | (() => string | undefined) | undefined;
+          password: string | (() => string | undefined) | undefined;
+        } | {
+          type: "Custom";
+          prefix: string | (() => string | undefined) | undefined;
+          value: string | (() => string | undefined) | undefined;
+        }) | undefined;
+        body?: any;
+        query?: any;
+        params?: any;
+        duplex?: "full" | "half" | undefined;
+        jsonParser?: ((text: string) => Promise<any> | any) | undefined;
+        retry?: _better_fetch_fetch0.RetryOptions | undefined;
+        retryAttempt?: number | undefined;
+        output?: (_better_fetch_fetch0.StandardSchemaV1 | typeof Blob | typeof File) | undefined;
+        errorSchema?: _better_fetch_fetch0.StandardSchemaV1 | undefined;
+        disableValidation?: boolean | undefined;
+      } & Record<string, any>;
+    }>;
+    hooks: {
+      onSuccess: (context: _better_fetch_fetch0.SuccessContext<any>) => Promise<void>;
+      onError: (context: _better_fetch_fetch0.ErrorContext) => Promise<void>;
+    };
+  }[];
+  getActions: ($fetch: _better_fetch_fetch0.BetterFetch, $store: ClientStore, clientOptions: better_auth27.BetterAuthClientOptions | undefined) => {
+    /**
+     * Gets the stored cookie.
+     *
+     * You can use this to get the cookie stored in
+     * the device and use it in your fetch requests.
+     *
+     * @example
+     * ```ts
+     * const cookie = client.getCookie();
+     * await fetch("https://api.example.com", {
+     *   headers: {
+     *    cookie,
+     *   },
+     * });
+     * ```
+     */
+    getCookie: () => string;
+    /**
+     * Initiates the authentication process.
+     * Opens the system's default browser for user authentication.
+     */
+    requestAuth: (options?: ElectronRequestAuthOptions | undefined) => Promise<void>;
+    /**
+     * Sets up the renderer process.
+     *
+     * - Exposes IPC bridges to the renderer process.
+     */
+    setupRenderer: () => void;
+    /**
+     * Sets up the main process.
+     *
+     * - Registers custom protocol scheme.
+     * - Registers IPC bridge handlers.
+     * - Handles content security policy if needed.
+     */
+    setupMain: (cfg?: {
+      csp?: boolean | undefined;
+      bridges?: boolean | undefined;
+      scheme?: boolean | undefined;
+      getWindow?: () => electron.BrowserWindow | null | undefined;
+    }) => void;
+    $Infer: {
+      Bridges: ReturnType<typeof exposeBridges>["$InferBridges"];
+    };
+  };
+};
+//#endregion
+export { handleDeepLink as n, electronClient as t };

package/dist/client.d.mts

@@ -0,0 +1,3 @@
+import { i as Storage, n as ElectronClientOptions, r as ElectronProxyClientOptions, t as ElectronRequestAuthOptions } from "./authenticate-CWAVJ4W8.mjs";
+import { n as handleDeepLink, t as electronClient } from "./client-BBp9yCmE.mjs";
+export { ElectronClientOptions, ElectronProxyClientOptions, ElectronRequestAuthOptions, Storage, electronClient, handleDeepLink };