@bernouy/socle 0.0.1

package/dist/interfaces/AuthInterface.d.ts

@@ -0,0 +1,49 @@
+import type { Middleware } from "./RunnerInterface";
+export interface IBe5_Subject {
+    identifier: string;
+    role: 'admin' | 'user';
+}
+/** A richer account view returned by listAccounts (admin UI). */
+export interface IBe5_AccountSummary extends IBe5_Subject {
+    createdAt?: Date;
+}
+export interface IBe5_Authentication {
+    readonly loginPage: string;
+    readonly registerPage: string;
+    readonly recoverPage: string;
+    readonly resetPage: string;
+    readonly logoutPage: string;
+    readonly setupPage: string;
+    readonly adminAccountsPage: string;
+    /** True when the Authentication was constructed with an IBe5_Mailer. */
+    readonly mailEnabled: boolean;
+    withRedirect(page: string, path: string): string;
+    getSubject(req: Request): Promise<IBe5_Subject | null>;
+    isAuthenticated(req: Request): Promise<boolean>;
+    guardAuthenticated(req: Request): Promise<IBe5_Subject>;
+    guardAdmin(req: Request): Promise<IBe5_Subject>;
+    /** Middleware that 401s unauthenticated requests. */
+    readonly requireAuthenticated: Middleware;
+    /** Middleware that 401s unauthenticated and 403s non-admins. */
+    readonly requireAdmin: Middleware;
+    /** Clears the session cookie. Always safe to call. */
+    logout(): Response;
+    /**
+     * Generates a password reset token and emails it to the user.
+     * No-op (throws) if the Authentication has no mailer configured.
+     * Never reveals whether the email exists.
+     */
+    requestPasswordReset(email: string): Promise<void>;
+    /** Consumes a reset token and applies a new password. */
+    resetPassword(token: string, newPassword: string): Promise<void>;
+    /** Updates the password of the currently-authenticated subject. */
+    changePassword(req: Request, currentPassword: string, newPassword: string): Promise<void>;
+    /** Admin-only: list every registered account. */
+    listAccounts(): Promise<IBe5_AccountSummary[]>;
+    /** Admin-only: create a new account with an explicit role. */
+    createAccount(identifier: string, password: string, role: 'admin' | 'user'): Promise<IBe5_Subject>;
+    /** Admin-only: delete an account by identifier (email). */
+    deleteAccount(identifier: string): Promise<void>;
+    /** Admin-only: change the role of an account. */
+    setAccountRole(identifier: string, role: 'admin' | 'user'): Promise<void>;
+}

package/dist/interfaces/MailerInterface.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A single outbound email message.
+ */
+export type Be5_MailMessage = {
+    to: string;
+    subject: string;
+    html: string;
+    text?: string;
+    /** Overrides the provider's default "from" address. */
+    from?: string;
+};
+/**
+ * Contract for sending transactional email on behalf of the Be5 platform.
+ *
+ * The Authentication provider consumes this optionally: features that need
+ * to email the user (password reset, etc.) are disabled when no mailer is
+ * supplied.
+ */
+export interface IBe5_Mailer {
+    send(message: Be5_MailMessage): Promise<void>;
+}

package/dist/interfaces/RunnerInterface.d.ts

@@ -0,0 +1,40 @@
+/** * Represents the handler function for an endpoint.
+ * It can return a standard Response or a Promise of a Response.
+ */
+export type RouteHandler = (req: Request) => Response | Promise<Response>;
+/**
+ * Middleware function that can transform a request or intercept a response.
+ */
+export type Middleware = (req: Request, next: () => Promise<Response>) => Promise<Response>;
+export interface IBe5_Runner {
+    /** * Registers a new HTTP endpoint.
+     * @param method HTTP verb (GET, POST, PUT, DELETE, etc.)
+     * @param path The URL path (can include dynamic segments like /article/:id)
+     * @param handler The function to execute when the route is matched
+     */
+    addEndpoint(method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH', path: string, handler: RouteHandler, middleware?: Middleware[]): void;
+    /** * Adds a global middleware that runs before every request.
+     * Useful for logging, CORS, or global security headers.
+     */
+    use(middleware: Middleware): void;
+    /** * Groups routes under a common prefix and/or middleware.
+     * Useful for plugins that provide multiple endpoints (e.g., /api/v1/auth/*)
+     */
+    group(prefix: string, callback: (runner: IBe5_Runner) => void, middlewares?: Middleware[]): void;
+    /** * Helper for quick GET route registration
+     */
+    get(path: string, handler: RouteHandler, middlewares?: Middleware[]): void;
+    /** * Helper for quick POST route registration
+     */
+    post(path: string, handler: RouteHandler, middlewares?: Middleware[]): void;
+    /** * Helper for quick Patch route registration
+     */
+    patch(path: string, handler: RouteHandler, middlewares?: Middleware[]): void;
+    /** * Helper for quick Delete route registration
+     */
+    delete(path: string, handler: RouteHandler, middlewares?: Middleware[]): void;
+    /** * Helper for quick Put route registration
+     */
+    put(path: string, handler: RouteHandler, middlewares?: Middleware[]): void;
+    start(): void;
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "@bernouy/socle",
+    "version": "0.0.1",
+    "description": "",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "scripts": {
+        "bun:build": "bun build.ts"
+    },
+    "devDependencies": {
+        "@types/bun": "latest",
+        "bun-types": "^1.3.6"
+    },
+    "peerDependencies": {
+        "typescript": "^5.9.3"
+    },
+    "dependencies": {
+        "bcryptjs": "^3.0.3",
+        "file-type": "^21.3.3",
+        "jose": "^6.2.1",
+        "mongodb": "7.1",
+        "nodemailer": "^6.9.16",
+        "sharp": "^0.34.5"
+    }
+}