@gatwech/core 0.0.1-beta.1

package/src/types/plugin-client.ts

@@ -0,0 +1,100 @@
+import type {
+  BetterFetch,
+  BetterFetchOption,
+  BetterFetchPlugin,
+} from "@better-fetch/fetch";
+import type { Atom, WritableAtom } from "nanostores";
+import type { LiteralString } from "./helper";
+import type { PayvoAuthOptions } from "./init-options";
+import type { PayvoAuthPlugin } from "./plugin";
+
+export interface ClientStore {
+  notify: (signal: string) => void;
+  listen: (signal: string, listener: () => void) => void;
+  atoms: Record<string, WritableAtom<any>>;
+}
+
+export type ClientAtomListener = {
+  matcher: (path: string) => boolean;
+  signal: "$sessionSignal" | Omit<string, "$sessionSignal">;
+};
+
+export interface RevalidateOptions {
+  /**
+   * A time interval (in seconds) after which the session will be re-fetched.
+   * If set to `0` (default), the session is not polled.
+   *
+   * This helps prevent session expiry during idle periods by periodically
+   * refreshing the session.
+   *
+   * @default 0
+   */
+  refetchInterval?: number | undefined;
+  /**
+   * Automatically refetch the session when the user switches back to the window/tab.
+   * This option activates this behavior if set to `true` (default).
+   *
+   * Prevents expired sessions when users switch tabs and come back later.
+   *
+   * @default true
+   */
+  refetchOnWindowFocus?: boolean | undefined;
+  /**
+   * Set to `false` to stop polling when the device has no internet access
+   * (determined by `navigator.onLine`).
+   *
+   * @default false
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/onLine
+   */
+  refetchWhenOffline?: boolean | undefined;
+}
+
+export interface PayvoAuthClientOptions {
+  fetchOptions?: BetterFetchOption | undefined;
+  plugins?: PayvoAuthClientPlugin[] | undefined;
+  baseURL?: string | undefined;
+  basePath?: string | undefined;
+  disableDefaultFetchPlugins?: boolean | undefined;
+  $InferAuth?: PayvoAuthOptions | undefined;
+  sessionOptions?: RevalidateOptions | undefined;
+}
+
+export interface PayvoAuthClientPlugin {
+  id: LiteralString;
+  /**
+   * only used for type inference. don't pass the
+   * actual plugin
+   */
+  $InferServerPlugin?: PayvoAuthPlugin | undefined;
+  /**
+   * Custom actions
+   */
+  getActions?: (
+    $fetch: BetterFetch,
+    $store: ClientStore,
+    /**
+     * payvo-auth client options
+     */
+    options: PayvoAuthClientOptions | undefined
+  ) => Record<string, any>;
+  /**
+   * State atoms that'll be resolved by each framework
+   * auth store.
+   */
+  getAtoms?: (($fetch: BetterFetch) => Record<string, Atom<any>>) | undefined;
+  /**
+   * specify path methods for server plugin inferred
+   * endpoints to force a specific method.
+   */
+  pathMethods?: Record<string, "POST" | "GET"> | undefined;
+  /**
+   * Better fetch plugins
+   */
+  fetchPlugins?: BetterFetchPlugin[] | undefined;
+  /**
+   * a list of recaller based on a matcher function.
+   * The signal name needs to match a signal in this
+   * plugin or any plugin the user might have added.
+   */
+  atomListeners?: ClientAtomListener[] | undefined;
+}

package/src/types/plugin.ts

@@ -0,0 +1,158 @@
+import type {
+  Endpoint,
+  EndpointContext,
+  InputContext,
+  Middleware,
+} from "better-call";
+import type { Migration } from "kysely";
+import type { AuthMiddleware } from "../api";
+import type { PayvoAuthPluginDBSchema } from "../db";
+import type { AuthContext } from "./context";
+import type { LiteralString } from "./helper";
+import type { PayvoAuthOptions } from "./init-options";
+
+type Awaitable<T> = T | Promise<T>;
+type DeepPartial<T> = T extends Function
+  ? T
+  : T extends object
+    ? { [K in keyof T]?: DeepPartial<T[K]> }
+    : T;
+
+export type HookEndpointContext = Partial<
+  EndpointContext<string, any> & Omit<InputContext<string, any>, "method">
+> & {
+  path: string;
+  context: AuthContext & {
+    returned?: unknown | undefined;
+    responseHeaders?: Headers | undefined;
+  };
+  headers?: Headers | undefined;
+};
+
+export type PayvoAuthPlugin = {
+  id: LiteralString;
+  /**
+   * The init function is called when the plugin is initialized.
+   * You can return a new context or modify the existing context.
+   */
+  init?:
+    | ((ctx: AuthContext) =>
+        | Awaitable<{
+            context?: DeepPartial<Omit<AuthContext, "options">>;
+            options?: Partial<PayvoAuthOptions>;
+          }>
+        | void
+        | Promise<void>)
+    | undefined;
+  endpoints?:
+    | {
+        [key: string]: Endpoint;
+      }
+    | undefined;
+  middlewares?:
+    | {
+        path: string;
+        middleware: Middleware;
+      }[]
+    | undefined;
+  onRequest?:
+    | ((
+        request: Request,
+        ctx: AuthContext
+      ) => Promise<
+        | {
+            response: Response;
+          }
+        | {
+            request: Request;
+          }
+        | void
+      >)
+    | undefined;
+  onResponse?:
+    | ((
+        response: Response,
+        ctx: AuthContext
+      ) => Promise<{
+        response: Response;
+      } | void>)
+    | undefined;
+  hooks?:
+    | {
+        before?: {
+          matcher: (context: HookEndpointContext) => boolean;
+          handler: AuthMiddleware;
+        }[];
+        after?: {
+          matcher: (context: HookEndpointContext) => boolean;
+          handler: AuthMiddleware;
+        }[];
+      }
+    | undefined;
+  /**
+   * Schema the plugin needs
+   *
+   * This will also be used to migrate the database. If the fields are dynamic from the plugins
+   * configuration each time the configuration is changed a new migration will be created.
+   *
+   * NOTE: If you want to create migrations manually using
+   * migrations option or any other way you
+   * can disable migration per table basis.
+   *
+   * @example
+   * ```ts
+   * schema: {
+   * 	user: {
+   * 		fields: {
+   * 			email: {
+   * 				 type: "string",
+   * 			},
+   * 			emailVerified: {
+   * 				type: "boolean",
+   * 				defaultValue: false,
+   * 			},
+   * 		},
+   * 	}
+   * } as AuthPluginSchema
+   * ```
+   */
+  schema?: PayvoAuthPluginDBSchema | undefined;
+  /**
+   * The migrations of the plugin. If you define schema that will automatically create
+   * migrations for you.
+   *
+   * ⚠️ Only uses this if you dont't want to use the schema option and you disabled migrations for
+   * the tables.
+   */
+  migrations?: Record<string, Migration> | undefined;
+  /**
+   * The options of the plugin
+   */
+  options?: Record<string, any> | undefined;
+  /**
+   * types to be inferred
+   */
+  $Infer?: Record<string, any> | undefined;
+  /**
+   * The rate limit rules to apply to specific paths.
+   */
+  rateLimit?:
+    | {
+        window: number;
+        max: number;
+        pathMatcher: (path: string) => boolean;
+      }[]
+    | undefined;
+  /**
+   * The error codes returned by the plugin
+   */
+  $ERROR_CODES?: Record<string, string> | undefined;
+  /**
+   * All database operations that are performed by the plugin
+   *
+   * This will override the default database operations
+   */
+  adapter?: {
+    [key: string]: (...args: any[]) => Promise<any> | any;
+  };
+};

package/src/utils/error-codes.ts

@@ -0,0 +1,51 @@
+type UpperLetter =
+	| "A"
+	| "B"
+	| "C"
+	| "D"
+	| "E"
+	| "F"
+	| "G"
+	| "H"
+	| "I"
+	| "J"
+	| "K"
+	| "L"
+	| "M"
+	| "N"
+	| "O"
+	| "P"
+	| "Q"
+	| "R"
+	| "S"
+	| "T"
+	| "U"
+	| "V"
+	| "W"
+	| "X"
+	| "Y"
+	| "Z";
+type SpecialCharacter = "_";
+
+type IsValidUpperSnakeCase<S extends string> = S extends `${infer F}${infer R}`
+	? F extends UpperLetter | SpecialCharacter
+		? IsValidUpperSnakeCase<R>
+		: false
+	: true;
+
+type InvalidKeyError<K extends string> =
+	`Invalid error code key: "${K}" - must only contain uppercase letters (A-Z) and underscores (_)`;
+
+type ValidateErrorCodes<T> = {
+	[K in keyof T]: K extends string
+		? IsValidUpperSnakeCase<K> extends false
+			? InvalidKeyError<K>
+			: T[K]
+		: T[K];
+};
+
+export function defineErrorCodes<const T extends Record<string, string>>(
+	codes: ValidateErrorCodes<T>,
+): T {
+	return codes as T;
+}

package/src/utils/index.ts

@@ -0,0 +1 @@
+export { defineErrorCodes } from "./error-codes";

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["esnext", "dom", "dom.iterable"],
+    "types": ["node"]
+  }
+}

package/tsdown.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from "tsdown";
+
+export default defineConfig({
+	dts: { build: true, incremental: true },
+	format: ["esm"],
+	entry: [
+		"./src/index.ts",
+		"./src/db/index.ts",
+		"./src/db/adapter/index.ts",
+		"./src/async_hooks/index.ts",
+		"./src/context/index.ts",
+		"./src/env/index.ts",
+		"./src/oauth2/index.ts",
+		"./src/api/index.ts",
+		"./src/social-providers/index.ts",
+		"./src/utils/index.ts",
+		"./src/error/index.ts",
+	],
+	clean: true,
+});