@vestcards/server-types 0.1.0

package/dist/apps/server/src/modules/auth/lib.d.ts

@@ -0,0 +1,324 @@
+import { type BetterAuthOptions } from 'better-auth';
+import { UserRole } from '../../db';
+import { generateId } from '../../utils/uuid';
+export declare const auth: import("better-auth").Auth<{
+    plugins: [{
+        id: "open-api";
+        endpoints: {
+            generateOpenAPISchema: import("better-call").StrictEndpoint<"/open-api/generate-schema", {
+                method: "GET";
+            }, {
+                openapi: string;
+                info: {
+                    title: string;
+                    description: string;
+                    version: string;
+                };
+                components: {
+                    securitySchemes: {
+                        apiKeyCookie: {
+                            type: string;
+                            in: string;
+                            name: string;
+                            description: string;
+                        };
+                        bearerAuth: {
+                            type: string;
+                            scheme: string;
+                            description: string;
+                        };
+                    };
+                    schemas: {
+                        [x: string]: import("better-auth/plugins").OpenAPIModelSchema;
+                    };
+                };
+                security: {
+                    apiKeyCookie: never[];
+                    bearerAuth: never[];
+                }[];
+                servers: {
+                    url: string;
+                }[];
+                tags: {
+                    name: string;
+                    description: string;
+                }[];
+                paths: Record<string, import("better-auth/plugins").Path>;
+            }>;
+            openAPIReference: import("better-call").StrictEndpoint<"/reference", {
+                method: "GET";
+                metadata: {
+                    readonly scope: "server";
+                };
+            }, Response>;
+        };
+        options: NoInfer<import("better-auth/plugins").OpenAPIOptions>;
+    }, {
+        id: "expo";
+        init: (ctx: import("better-auth").AuthContext) => {
+            options: {
+                trustedOrigins: string[];
+            };
+        };
+        onRequest(request: Request, ctx: import("better-auth").AuthContext): Promise<{
+            request: Request;
+        } | undefined>;
+        hooks: {
+            after: {
+                matcher(context: import("better-auth").HookEndpointContext): boolean;
+                handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+            }[];
+        };
+        endpoints: {
+            expoAuthorizationProxy: import("better-call").StrictEndpoint<"/expo-authorization-proxy", {
+                method: "GET";
+                query: import("better-auth").ZodObject<{
+                    authorizationURL: import("better-auth").ZodString;
+                    oauthState: import("better-auth").ZodOptional<import("better-auth").ZodString>;
+                }, import("better-auth").$strip>;
+                metadata: {
+                    readonly scope: "server";
+                };
+            }, {
+                status: ("OK" | "CREATED" | "ACCEPTED" | "NO_CONTENT" | "MULTIPLE_CHOICES" | "MOVED_PERMANENTLY" | "FOUND" | "SEE_OTHER" | "NOT_MODIFIED" | "TEMPORARY_REDIRECT" | "BAD_REQUEST" | "UNAUTHORIZED" | "PAYMENT_REQUIRED" | "FORBIDDEN" | "NOT_FOUND" | "METHOD_NOT_ALLOWED" | "NOT_ACCEPTABLE" | "PROXY_AUTHENTICATION_REQUIRED" | "REQUEST_TIMEOUT" | "CONFLICT" | "GONE" | "LENGTH_REQUIRED" | "PRECONDITION_FAILED" | "PAYLOAD_TOO_LARGE" | "URI_TOO_LONG" | "UNSUPPORTED_MEDIA_TYPE" | "RANGE_NOT_SATISFIABLE" | "EXPECTATION_FAILED" | "I'M_A_TEAPOT" | "MISDIRECTED_REQUEST" | "UNPROCESSABLE_ENTITY" | "LOCKED" | "FAILED_DEPENDENCY" | "TOO_EARLY" | "UPGRADE_REQUIRED" | "PRECONDITION_REQUIRED" | "TOO_MANY_REQUESTS" | "REQUEST_HEADER_FIELDS_TOO_LARGE" | "UNAVAILABLE_FOR_LEGAL_REASONS" | "INTERNAL_SERVER_ERROR" | "NOT_IMPLEMENTED" | "BAD_GATEWAY" | "SERVICE_UNAVAILABLE" | "GATEWAY_TIMEOUT" | "HTTP_VERSION_NOT_SUPPORTED" | "VARIANT_ALSO_NEGOTIATES" | "INSUFFICIENT_STORAGE" | "LOOP_DETECTED" | "NOT_EXTENDED" | "NETWORK_AUTHENTICATION_REQUIRED") | import("better-call").Status;
+                body: ({
+                    message?: string;
+                    code?: string;
+                    cause?: unknown;
+                } & Record<string, any>) | undefined;
+                headers: HeadersInit;
+                statusCode: number;
+                name: string;
+                message: string;
+                stack?: string;
+                cause?: unknown;
+            }>;
+        };
+        options: import("@better-auth/expo").ExpoOptions | undefined;
+    }, {
+        id: "custom-session";
+        hooks: {
+            after: {
+                matcher: (ctx: import("better-auth").HookEndpointContext) => boolean;
+                handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<{
+                    user: {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                        role: UserRole;
+                        entityId?: string | null | undefined;
+                        surname?: string | null | undefined;
+                    };
+                    session: {
+                        entitlements: import("@vestcards/shared").Entitlement[];
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        userId: string;
+                        expiresAt: Date;
+                        token: string;
+                        ipAddress?: string | null | undefined;
+                        userAgent?: string | null | undefined;
+                    };
+                }[] | undefined>;
+            }[];
+        };
+        endpoints: {
+            getSession: import("better-call").StrictEndpoint<"/get-session", {
+                method: "GET";
+                query: import("better-auth").ZodOptional<import("better-auth").ZodObject<{
+                    disableCookieCache: import("better-auth").ZodOptional<import("better-auth").ZodUnion<[import("better-auth").ZodBoolean, import("better-auth").ZodPipe<import("better-auth").ZodString, import("better-auth").ZodTransform<boolean, string>>]>>;
+                    disableRefresh: import("better-auth").ZodOptional<import("better-auth").ZodBoolean>;
+                }, import("better-auth").$strip>>;
+                metadata: {
+                    CUSTOM_SESSION: boolean;
+                    openapi: {
+                        description: string;
+                        responses: {
+                            "200": {
+                                description: string;
+                                content: {
+                                    "application/json": {
+                                        schema: {
+                                            type: "array";
+                                            nullable: boolean;
+                                            items: {
+                                                $ref: string;
+                                            };
+                                        };
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+                requireHeaders: true;
+            }, {
+                user: {
+                    id: string;
+                    createdAt: Date;
+                    updatedAt: Date;
+                    email: string;
+                    emailVerified: boolean;
+                    name: string;
+                    image?: string | null | undefined;
+                    role: UserRole;
+                    entityId?: string | null | undefined;
+                    surname?: string | null | undefined;
+                };
+                session: {
+                    entitlements: import("@vestcards/shared").Entitlement[];
+                    id: string;
+                    createdAt: Date;
+                    updatedAt: Date;
+                    userId: string;
+                    expiresAt: Date;
+                    token: string;
+                    ipAddress?: string | null | undefined;
+                    userAgent?: string | null | undefined;
+                };
+            } | null>;
+        };
+        $Infer: {
+            Session: {
+                user: {
+                    id: string;
+                    createdAt: Date;
+                    updatedAt: Date;
+                    email: string;
+                    emailVerified: boolean;
+                    name: string;
+                    image?: string | null | undefined;
+                    role: UserRole;
+                    entityId?: string | null | undefined;
+                    surname?: string | null | undefined;
+                };
+                session: {
+                    entitlements: import("@vestcards/shared").Entitlement[];
+                    id: string;
+                    createdAt: Date;
+                    updatedAt: Date;
+                    userId: string;
+                    expiresAt: Date;
+                    token: string;
+                    ipAddress?: string | null | undefined;
+                    userAgent?: string | null | undefined;
+                };
+            };
+        };
+        options: import("better-auth/plugins").CustomSessionPluginOptions | undefined;
+    }];
+    baseURL: string;
+    basePath: string;
+    database: (options: BetterAuthOptions) => import("better-auth").DBAdapter<BetterAuthOptions>;
+    secondaryStorage: import("better-auth").SecondaryStorage;
+    emailAndPassword: {
+        enabled: true;
+        autoSignIn: true;
+        requireEmailVerification: boolean;
+        minPasswordLength: number;
+        maxPasswordLength: number;
+        password: {
+            hash: (p: string) => Promise<string>;
+            verify: ({ password: p, hash }: {
+                hash: string;
+                password: string;
+            }) => Promise<boolean>;
+        };
+        sendResetPassword: ((data: {
+            user: import("better-auth").User;
+            url: string;
+            token: string;
+        }, request?: Request) => Promise<void>) | undefined;
+    };
+    emailVerification: {
+        sendOnSignUp: boolean;
+        sendVerificationEmail: ((data: {
+            user: import("better-auth").User;
+            url: string;
+            token: string;
+        }, request?: Request) => Promise<void>) | undefined;
+    };
+    session: {
+        expiresIn: number;
+        cookieCache: {
+            enabled: true;
+            maxAge: number;
+        };
+        additionalFields: {
+            entitlements: {
+                type: "string[]";
+                required: false;
+                defaultValue: never[];
+            };
+        };
+    };
+    socialProviders: {
+        google: {
+            clientId: string;
+            clientSecret: string;
+        };
+    };
+    user: {
+        additionalFields: {
+            surname: {
+                type: "string";
+                required: false;
+                input: true;
+            };
+            role: {
+                type: UserRole[];
+                required: true;
+                defaultValue: UserRole;
+            };
+            entityId: {
+                type: "string";
+                required: false;
+                input: true;
+            };
+        };
+    };
+    databaseHooks: {
+        user: {
+            create: {
+                before: (user: {
+                    id: string;
+                    createdAt: Date;
+                    updatedAt: Date;
+                    email: string;
+                    emailVerified: boolean;
+                    name: string;
+                    image?: string | null | undefined;
+                } & Record<string, unknown>) => Promise<{
+                    data: {
+                        entityId: string;
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    };
+                }>;
+            };
+        };
+    };
+    logger: {
+        log(level: "error" | "warn" | "info" | "debug", message: string, ...args: any[]): void;
+    };
+    advanced: {
+        useSecureCookies: boolean;
+        disableOriginCheck: true;
+        cookiePrefix: string;
+        database: {
+            generateId: typeof generateId;
+        };
+    };
+    trustedOrigins: string[];
+}>;
+export type Auth = typeof auth;

package/dist/apps/server/src/modules/auth/permissions/entitlements.d.ts

@@ -0,0 +1,2 @@
+import { Entitlement } from '../../../db/types';
+export declare function getUserEntitlements(userId: string): Promise<Entitlement[]>;

package/dist/apps/server/src/modules/auth/permissions/permissions.d.ts

@@ -0,0 +1,60 @@
+import { Entitlement, UserRole } from '@vestcards-server/db';
+declare const PERMISSIONS: {
+    readonly DECK: {
+        readonly CREATE_OWN: "deck:create:own";
+        readonly CREATE_PUBLIC: "deck:create:public";
+        readonly READ_OWN: "deck:read:own";
+        readonly READ_FREE: "deck:read:free";
+        readonly READ_PREMIUM: "deck:read:premium";
+        readonly UPDATE_OWN: "deck:update:own";
+        readonly UPDATE_PUBLIC: "deck:update:public";
+        readonly DELETE_OWN: "deck:delete:own";
+        readonly DELETE_PUBLIC: "deck:delete:public";
+    };
+    readonly CARD_DEMAND: {
+        readonly READ: "card-demand:read";
+        readonly CREATE: "card-demand:create";
+        readonly ACTION: "card-demand:action";
+    };
+    readonly USER: {
+        readonly UPDATE_OWN: "user:update:own";
+        readonly UPDATE_ALL: "user:update:*";
+        readonly DELETE_OWN: "user:delete:own";
+        readonly DELETE_ALL: "user:delete:*";
+        readonly READ_OWN: "user:read:own";
+        readonly READ_ALL: "user:read:*";
+    };
+    readonly STATS: {
+        readonly VIEW: "stats:view";
+    };
+    readonly MEMBERSHIP: {
+        readonly MANAGE: "membership:manage";
+    };
+    readonly PLAN: {
+        readonly CREATE: "plan:create";
+        readonly UPDATE: "plan:update";
+        readonly DELETE: "plan:delete";
+    };
+    readonly BLOGPOST: {
+        readonly CREATE: "blogpost:create";
+        readonly UPDATE: "blogpost:update";
+        readonly DELETE: "blogpost:delete";
+    };
+    readonly VESTY: {
+        readonly CHAT: "vesty:chat";
+    };
+    readonly STUDY: {
+        readonly READ: "study:read";
+        readonly WRITE: "study:write";
+    };
+};
+declare const ALL_PERMISSIONS: ("deck:create:own" | "deck:create:public" | "deck:read:own" | "deck:read:free" | "deck:read:premium" | "deck:update:own" | "deck:update:public" | "deck:delete:own" | "deck:delete:public" | "card-demand:read" | "card-demand:create" | "card-demand:action" | "user:update:own" | "user:update:*" | "user:delete:own" | "user:delete:*" | "user:read:own" | "user:read:*" | "stats:view" | "membership:manage" | "plan:create" | "plan:update" | "plan:delete" | "blogpost:create" | "blogpost:update" | "blogpost:delete" | "vesty:chat" | "study:read" | "study:write")[];
+declare const ROLE_PERMISSIONS: Record<UserRole, Permission[]>;
+declare const ENTITLEMENT_PERMISSIONS: Record<Entitlement, Permission[]>;
+type ValueOf<T> = T[keyof T];
+type Permission = ValueOf<{
+    [K in keyof typeof PERMISSIONS]: ValueOf<(typeof PERMISSIONS)[K]>;
+}>;
+declare const hasPermission: (required: Permission, userRole: UserRole, userEntitlements?: Entitlement[]) => boolean;
+export { ALL_PERMISSIONS, ENTITLEMENT_PERMISSIONS, hasPermission, PERMISSIONS, ROLE_PERMISSIONS };
+export type { Permission };

package/dist/apps/server/src/modules/auth/utils.d.ts

@@ -0,0 +1,8 @@
+import type { BetterAuthOptions } from 'better-auth';
+type SendVerificationEmail = NonNullable<BetterAuthOptions['emailVerification']>['sendVerificationEmail'];
+export declare const sendVerificationEmail: SendVerificationEmail;
+type SendResetPassword = NonNullable<BetterAuthOptions['emailAndPassword']>['sendResetPassword'];
+export declare const sendForgotPasswordEmail: SendResetPassword;
+type SecondaryStorage = NonNullable<BetterAuthOptions['secondaryStorage']>;
+export declare const secondaryStorage: SecondaryStorage;
+export {};

package/dist/apps/server/src/modules/deck/deck.test.d.ts

@@ -0,0 +1 @@
+export {};