@gatwech/core 0.0.11 → 1.0.0-beta.18

package/dist/src/types/plugin-client.d.ts

@@ -0,0 +1,88 @@
+import type { BetterFetch, BetterFetchOption, BetterFetchPlugin } from "@better-fetch/fetch";
+import type { LiteralString } from "./helper";
+import type { PayvoAuthPlugin } from "./plugin";
+import type { Atom, WritableAtom } from "nanostores";
+import type { PayvoAuthOptions } from "./init-options";
+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/dist/src/types/plugin.d.ts

@@ -0,0 +1,120 @@
+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;
+    };
+};
+export {};

package/dist/src/utils/error-codes.d.ts

@@ -0,0 +1,9 @@
+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 declare function defineErrorCodes<const T extends Record<string, string>>(codes: ValidateErrorCodes<T>): T;
+export {};

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@gatwech/core",
-  "version": "0.0.11",
+  "version": "1.0.0-beta.18",
   "description": "",
   "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "exports": {
@@ -100,13 +103,13 @@
     }
   },
   "devDependencies": {
-    "@gatwech/utils": "0.5.3",
     "@better-fetch/fetch": "1.1.18",
+    "@gatwech/utils": "0.5.3",
     "@types/better-sqlite3": "^7.6.13",
     "better-call": "1.0.19",
     "better-sqlite3": "^12.4.1",
     "jose": "^6.1.0",
-    "kysely": "^0.28.5",
+    "kysely": "^0.28.8",
     "nanostores": "^1.0.1",
     "tsdown": "0.16.1"
   },
@@ -115,15 +118,18 @@
     "zod": "^4.1.5"
   },
   "peerDependencies": {
-    "@gatwech/utils": "0.5.3",
     "@better-fetch/fetch": "1.1.18",
+    "@gatwech/utils": "0.5.3",
     "better-call": "1.0.19",
     "jose": "^6.1.0",
     "kysely": "^0.28.5",
     "nanostores": "^1.0.1"
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "build": "tsdown",
+    "build": "tsdown --tsconfig tsconfig.build.json",
     "dev": "tsdown --watch",
     "typecheck": "tsc --project tsconfig.json",
     "test": "vitest"

package/.turbo/turbo-build.log

@@ -1,42 +0,0 @@
-
-> @gatwech/core@0.0.11 build /home/runner/work/payvo-auth/payvo-auth/packages/core
-> tsdown
-
-ℹ tsdown v0.16.1 powered by rolldown v1.0.0-beta.47
-ℹ Using tsdown config: /home/runner/work/payvo-auth/payvo-auth/packages/core/tsdown.config.ts
-ℹ entry: src/index.ts, src/api/index.ts, src/async_hooks/index.ts, src/context/index.ts, src/db/index.ts, src/env/index.ts, src/error/index.ts, src/oauth2/index.ts, src/social-providers/index.ts, src/utils/index.ts, src/db/adapter/index.ts
-ℹ tsconfig: tsconfig.json
-ℹ Build start
-ℹ dist/social-providers/index.mjs     77.58 kB │ gzip: 10.13 kB
-ℹ dist/db/index.mjs                    1.64 kB │ gzip:  0.50 kB
-ℹ dist/api/index.mjs                   0.83 kB │ gzip:  0.40 kB
-ℹ dist/context/index.mjs               0.74 kB │ gzip:  0.27 kB
-ℹ dist/oauth2/index.mjs                0.61 kB │ gzip:  0.24 kB
-ℹ dist/env/index.mjs                   0.44 kB │ gzip:  0.25 kB
-ℹ dist/error/index.mjs                 0.16 kB │ gzip:  0.13 kB
-ℹ dist/async_hooks/index.mjs           0.11 kB │ gzip:  0.10 kB
-ℹ dist/utils/index.mjs                 0.09 kB │ gzip:  0.09 kB
-ℹ dist/db/adapter/index.mjs            0.01 kB │ gzip:  0.03 kB
-ℹ dist/index.mjs                       0.01 kB │ gzip:  0.03 kB
-ℹ dist/oauth2-DyI7_CNv.mjs             9.16 kB │ gzip:  2.13 kB
-ℹ dist/env-JMSMESs1.mjs                7.67 kB │ gzip:  2.55 kB
-ℹ dist/context-DxzHfoWW.mjs            3.91 kB │ gzip:  1.03 kB
-ℹ dist/error-41YsFQ8b.mjs              1.76 kB │ gzip:  0.79 kB
-ℹ dist/async_hooks-BrLqUNsE.mjs        0.86 kB │ gzip:  0.46 kB
-ℹ dist/utils-BFQCAfNW.mjs              0.13 kB │ gzip:  0.12 kB
-ℹ dist/social-providers/index.d.mts    3.78 kB │ gzip:  1.17 kB
-ℹ dist/context/index.d.mts             2.74 kB │ gzip:  0.78 kB
-ℹ dist/error/index.d.mts               1.84 kB │ gzip:  0.72 kB
-ℹ dist/db/index.d.mts                  1.00 kB │ gzip:  0.38 kB
-ℹ dist/utils/index.d.mts               0.84 kB │ gzip:  0.43 kB
-ℹ dist/index.d.mts                     0.81 kB │ gzip:  0.32 kB
-ℹ dist/oauth2/index.d.mts              0.79 kB │ gzip:  0.29 kB
-ℹ dist/env/index.d.mts                 0.59 kB │ gzip:  0.30 kB
-ℹ dist/db/adapter/index.d.mts          0.47 kB │ gzip:  0.22 kB
-ℹ dist/api/index.d.mts                 0.29 kB │ gzip:  0.15 kB
-ℹ dist/async_hooks/index.d.mts         0.14 kB │ gzip:  0.10 kB
-ℹ dist/index-DjrJweYn.d.mts          204.61 kB │ gzip: 31.91 kB
-ℹ dist/index-DLP-K0uY.d.mts            3.31 kB │ gzip:  1.12 kB
-ℹ dist/index-CRg-E-VF.d.mts            0.24 kB │ gzip:  0.16 kB
-ℹ 31 files, total: 327.18 kB
-✔ Build complete in 6544ms