weifuwu 0.23.2 → 0.23.4

package/dist/user/types.d.ts

@@ -1,6 +1,7 @@
 import type { Middleware, Context } from '../types.ts';
 import type { Router } from '../router.ts';
 import type { PostgresClient } from '../postgres/types.ts';
+/** A user record from the database. */
 export interface UserData {
     id: number;
     email: string;
@@ -9,10 +10,14 @@ export interface UserData {
     created_at: Date;
     updated_at: Date;
 }
+/** Result of a successful register or login. */
 export interface AuthResult {
+    /** User data (excluding password hash). */
     user: Omit<UserData, 'password'>;
+    /** Signed JWT token. */
     token: string;
 }
+/** An OAuth2 client application registered with the server. */
 export interface OAuth2Client {
     id: number;
     name: string;
@@ -21,12 +26,17 @@ export interface OAuth2Client {
     redirectUris: string[];
     scopes: string;
 }
+/** Enable OAuth2 server mode (authorization code flow). */
 export interface OAuth2ServerOptions {
     server: true;
 }
+/** Configuration for an OAuth login provider (e.g. GitHub, Google). */
 export interface OAuthProviderConfig {
+    /** OAuth app client ID. */
     clientId: string;
+    /** OAuth app client secret. */
     clientSecret: string;
+    /** Scopes to request (default: `'openid profile email'`). */
     scope?: string;
     /** Custom auth URL (overrides built-in provider default). */
     authUrl?: string;
@@ -36,8 +46,8 @@ export interface OAuthProviderConfig {
     userUrl?: string;
     /**
      * Custom user parser.
-     * Required when any of authUrl/tokenUrl/userUrl is custom.
-     * Receives the raw response from userUrl + the access token.
+     * Required when any of `authUrl`/`tokenUrl`/`userUrl` is custom.
+     * Receives the raw response from `userUrl` + the access token.
      */
     parseUser?: (data: any, accessToken: string) => {
         id: string;
@@ -46,43 +56,87 @@ export interface OAuthProviderConfig {
         avatarUrl?: string;
     };
 }
+/** Options for {@link user}. */
 export interface UserOptions {
+    /** PostgreSQL client for user storage. */
     pg: PostgresClient;
+    /** Secret key for JWT signing. */
     jwtSecret: string;
+    /** Custom table name for users (default: `'users'`). */
     table?: string;
+    /** JWT expiration time (default: `'7d'`). */
     expiresIn?: string | number;
+    /** Enable OAuth2 server mode (authorization code flow). */
     oauth2?: OAuth2ServerOptions;
     /**
      * OAuth login providers (login with GitHub/Google).
-     * Registers GET /auth/:provider and GET /auth/:provider/callback routes.
+     * Registers `GET /auth/:provider` and `GET /auth/:provider/callback` routes.
      */
     oauthLogin?: {
+        /** Map of provider name to config (e.g. `{ github: {...}, google: {...} }`). */
         providers: Record<string, OAuthProviderConfig>;
-        /** Where to redirect after successful login (default: '/'). */
+        /** Redirect URL after successful login (default: `'/'`). */
         redirectUrl?: string;
     };
 }
+/** The shape of `ctx.user` when the user middleware is active. */
 export interface UserInjected {
     user: UserData;
 }
+/**
+ * User module returned by {@link user}. Provides auth routes, middleware, and programmatic API.
+ *
+ * ```ts
+ * const auth = user({ pg, jwtSecret: process.env.JWT_SECRET })
+ * app.use(auth.middleware())   // injects ctx.user on every request
+ * app.use('/', auth)           // mounts routes: /register, /login
+ * ```
+ */
 export interface UserModule extends Router {
+    /**
+     * Strict auth middleware. Reads JWT from `Authorization: Bearer` header.
+     * Returns 401 if no valid token is found.
+     * Use for routes that require authentication.
+     */
     middleware: () => Middleware<Context, Context & UserInjected>;
+    /**
+     * Optional auth middleware. Reads JWT from `Authorization` header or `token` cookie.
+     * Sets `ctx.user` if a valid token is present, but does **not** block unauthenticated requests.
+     * Use as a global middleware when some routes are public and some are protected.
+     *
+     * ```ts
+     * app.use(auth.middlewareOptional({ cookie: 'token' }))
+     * app.get('/profile', auth.middleware(), handler)  // protected
+     * app.get('/', handler)                              // public
+     * ```
+     */
+    middlewareOptional: (opts?: {
+        cookie?: string;
+    }) => Middleware;
+    /** Create the users table. */
     migrate: () => Promise<void>;
+    /** Register a new user. Returns user data + JWT. */
     register: (data: {
         email: string;
         password: string;
         name: string;
     }) => Promise<AuthResult>;
+    /** Authenticate by email + password. Returns user data + JWT. */
     login: (data: {
         email: string;
         password: string;
     }) => Promise<AuthResult>;
+    /** Verify a JWT and return the user data (or null if invalid). */
     verify: (token: string) => Promise<Omit<UserData, 'password'> | null>;
+    /** Register a new OAuth2 client application. */
     registerClient: (data: {
         name: string;
         redirectUris: string[];
     }) => Promise<OAuth2Client>;
+    /** Look up an OAuth2 client by clientId. */
     getClient: (clientId: string) => Promise<OAuth2Client | null>;
+    /** Revoke an OAuth2 client. */
     revokeClient: (clientId: string) => Promise<void>;
+    /** Close the underlying DB connection. */
     close: () => Promise<void>;
 }

package/dist/webhook.d.ts

@@ -1,54 +1,79 @@
 import type { Context } from './types.ts';
 import { Router } from './router.ts';
+/** A parsed webhook event delivered to handlers. */
 export interface WebhookEvent {
-    /** Raw event name from the provider (e.g. 'checkout.session.completed') */
+    /** Raw event name from the provider (e.g. 'checkout.session.completed'). */
     event: string;
-    /** Parsed event payload */
+    /** Parsed event payload (body after verification). */
     payload: unknown;
-    /** Provider name (e.g. 'stripe', 'github') */
+    /** Provider name (e.g. 'stripe', 'github'). */
     provider: string;
-    /** Unique event ID for replay protection */
+    /** Unique event ID for replay protection. */
     id?: string;
 }
+/** Handler function for a webhook event. */
 export interface WebhookHandler {
     (event: WebhookEvent, ctx: Context): void | Promise<void>;
 }
+/** Configuration for a built-in platform webhook verifier (Stripe, GitHub, Slack). */
 export interface PlatformConfig {
-    /** HMAC-SHA256 secret */
+    /** HMAC-SHA256 signing secret. */
     secret: string;
-    /** Optional custom event prefix (default: platform name) */
+    /** Optional event prefix (default: platform name, e.g. 'stripe'). */
     prefix?: string;
 }
+/** Configuration for a custom webhook verifier. */
 export interface CustomVerifierConfig {
-    /** Name for this verifier */
+    /** Name for this verifier. */
     name: string;
     /** Verify function. Return true if signature is valid. */
     verify: (body: string, headers: Record<string, string>) => boolean | Promise<boolean>;
     /** Extract event name from body and headers */
     event: (body: unknown, headers: Record<string, string>) => string;
 }
+/** Options for {@link webhook}. */
 export interface WebhookOptions {
-    /** Stripe webhook config (enables Stripe signature verification) */
+    /** Stripe webhook config (enables Stripe signature verification). */
     stripe?: PlatformConfig;
-    /** GitHub webhook config */
+    /** GitHub webhook config. */
     github?: PlatformConfig;
-    /** Slack webhook config */
+    /** Slack webhook config. */
     slack?: PlatformConfig;
-    /** Custom verifiers */
+    /** Custom verifiers. */
     custom?: CustomVerifierConfig[];
-    /** Global prefix for all event types (default: none) */
+    /** Global prefix for all event types (default: none). */
     prefix?: string;
-    /** Path to mount the webhook receiver. Default: '/'. */
+    /** Path to mount the webhook receiver. Default: `'/'`. */
     path?: string;
     /** Enable replay protection (requires provider to send unique event IDs). Default: true. */
     replayProtection?: boolean;
     /** Idempotency key TTL in ms. Default: 3600000 (1 hour). */
     idempotencyTTL?: number;
 }
+/** Webhook module instance returned by {@link webhook}. */
 export interface WebhookModule extends Router {
-    /** Register an event handler */
+    /** Register an event handler. */
     on(event: string, handler: WebhookHandler): this;
-    /** Remove an event handler */
+    /** Remove an event handler. */
     off(event: string, handler: WebhookHandler): this;
 }
+/**
+ * Webhook receiver module. Validates signatures and dispatches events.
+ *
+ * Supports built-in verifiers for Stripe, GitHub, and Slack, plus custom verifiers.
+ *
+ * ```ts
+ * import { webhook } from 'weifuwu'
+ *
+ * const wh = webhook({
+ *   stripe: { secret: process.env.STRIPE_WEBHOOK_SECRET },
+ * })
+ *
+ * wh.on('checkout.session.completed', async (event, ctx) => {
+ *   // event.payload contains the parsed Stripe event
+ * })
+ *
+ * app.use('/', wh)
+ * ```
+ */
 export declare function webhook(options?: WebhookOptions): WebhookModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "weifuwu",
-  "version": "0.23.2",
+  "version": "0.23.4",
   "description": "Web-standard HTTP framework for Node.js — (req, ctx) => Response",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -22,9 +22,11 @@
   "scripts": {
     "dev": "cd cli/template && NODE_ENV=development node --watch index.ts",
     "start": "cd cli/template && node index.ts",
-    "build": "esbuild index.ts --bundle --format=esm --platform=node --outfile=dist/index.js --packages=external && esbuild cli.ts --bundle --format=esm --platform=node --outfile=dist/cli.js --packages=external && esbuild react.ts --bundle --format=esm --outfile=dist/react.js --external:react --external:react-dom",
+    "build": "esbuild index.ts --bundle --format=esm --platform=node --outfile=dist/index.js --packages=external --define:__WFW_BUNDLED__=true && esbuild cli.ts --bundle --format=esm --platform=node --outfile=dist/cli.js --packages=external && esbuild react.ts --bundle --format=esm --outfile=dist/react.js --external:react --external:react-dom",
     "prepublishOnly": "npm run build && tsc --emitDeclarationOnly --outdir dist",
-    "test": "node --test 'test/**/*.test.ts'"
+    "test": "node --test 'test/**/*.test.ts'",
+    "test:unit": "bash scripts/test-unit.sh",
+    "test:ci": "node --test 'test/**/*.test.ts'"
   },
   "dependencies": {
     "@ai-sdk/openai": "^3.0.66",

package/cli/template/.weifuwu/ssr/560568d7.js

@@ -1,14 +0,0 @@
-// ui/app/layout.tsx
-import { jsx, jsxs } from "react/jsx-runtime";
-function RootLayout({ children }) {
-  return /* @__PURE__ */ jsxs("html", { lang: "en", children: [
-    /* @__PURE__ */ jsxs("head", { children: [
-      /* @__PURE__ */ jsx("meta", { charSet: "utf-8" }),
-      /* @__PURE__ */ jsx("meta", { name: "viewport", content: "width=device-width, initial-scale=1" })
-    ] }),
-    /* @__PURE__ */ jsx("body", { children: /* @__PURE__ */ jsx("main", { children }) })
-  ] });
-}
-export {
-  RootLayout as default
-};

package/dist/kb.d.ts

@@ -1,70 +0,0 @@
-import type { Sql } from './vendor.ts';
-import type { Middleware } from './types.ts';
-export interface KBOptions {
-    /** Postgres SQL client (with pgvector extension enabled). */
-    sql: Sql<{}>;
-    /**
-     * Embedding function.
-     * Takes a text string, returns a vector of numbers.
-     * Example: (text) => embed({ model: openai.embedding('text-embedding-3-small'), value: text }).then(r => r.embedding)
-     */
-    embedding: (text: string) => Promise<number[]>;
-    /** Vector dimensions (default: 1536 for text-embedding-3-small). */
-    dimensions?: number;
-    /** Table name (default: '_kb_docs'). */
-    table?: string;
-    /** Default chunk size in characters (default: 512). */
-    chunkSize?: number;
-    /** Default chunk overlap in characters (default: 64). */
-    chunkOverlap?: number;
-    /** Default search limit (default: 5). */
-    searchLimit?: number;
-    /** Minimum similarity score threshold (0–1, default: 0). Set higher for stricter matches. */
-    searchThreshold?: number;
-}
-export interface KBIngestOptions {
-    title?: string;
-    metadata?: Record<string, unknown>;
-    chunkSize?: number;
-    chunkOverlap?: number;
-}
-export interface KBSearchResult {
-    id: number;
-    key: string;
-    title: string;
-    content: string;
-    score: number;
-    metadata: Record<string, unknown>;
-}
-export interface KBSearchOptions {
-    limit?: number;
-    /** Minimum cosine similarity score (0–1). Results below this are excluded. */
-    threshold?: number;
-}
-export interface KBListEntry {
-    key: string;
-    title: string;
-    chunks: number;
-}
-export interface KBModule {
-    /**
-     * Ingest a document: chunk → embed → store.
-     * If a document with the same key exists, it is replaced (delete + re-insert).
-     * Returns the number of chunks created.
-     */
-    ingest(key: string, content: string, options?: KBIngestOptions): Promise<number>;
-    /**
-     * Search the knowledge base by semantic similarity.
-     * Query is embedded, then vector similarity search returns top results.
-     */
-    search(query: string, searchOptions?: KBSearchOptions): Promise<KBSearchResult[]>;
-    /** Delete all chunks for a document key. */
-    delete(key: string): Promise<void>;
-    /** List all document keys with title and chunk count. */
-    list(): Promise<KBListEntry[]>;
-    /** Create the table and HNSW index. Safe to call multiple times. */
-    migrate(): Promise<void>;
-    /** Middleware that injects `ctx.kb` with `.search()` method. */
-    middleware(): Middleware;
-}
-export declare function knowledgeBase(options: KBOptions): KBModule;

package/dist/oauth-client.d.ts

@@ -1,41 +0,0 @@
-import type { PostgresClient } from './postgres/types.ts';
-import { Router } from './router.ts';
-export interface OAuthProviderConfig {
-    clientId: string;
-    clientSecret: string;
-    scope?: string;
-    /** Custom auth URL (overrides built-in provider default). */
-    authUrl?: string;
-    /** Custom token URL (overrides built-in provider default). */
-    tokenUrl?: string;
-    /** Custom user info URL (overrides built-in provider default). */
-    userUrl?: string;
-    /**
-     * Custom user parser.
-     * Required when any of authUrl/tokenUrl/userUrl is custom.
-     * Receives the raw response from userUrl + the access token.
-     */
-    parseUser?: (data: any, accessToken: string) => ProviderUser;
-}
-export interface OAuthClientOptions {
-    /** Postgres client (required). */
-    pg: PostgresClient;
-    /** JWT secret — must match user() module's jwtSecret. */
-    jwtSecret: string;
-    /** JWT expiry (default: '24h'). */
-    expiresIn?: string | number;
-    /** Where to redirect after successful login (default: '/'). */
-    redirectUrl?: string;
-    /** Provider configurations. */
-    providers: Record<string, OAuthProviderConfig>;
-    /** Table name for provider-user links (default: '_auth_providers'). */
-    table?: string;
-}
-interface ProviderUser {
-    id: string;
-    email: string;
-    name: string;
-    avatarUrl?: string;
-}
-export declare function oauthClient(options: OAuthClientOptions): Router;
-export {};

package/dist/preferences.d.ts

@@ -1,18 +0,0 @@
-import type { Context, Middleware } from './types.ts';
-export interface PrefOptions {
-    dir?: string;
-    locale?: {
-        default?: string;
-        cookie?: string;
-        fromAcceptLanguage?: boolean;
-    };
-    theme?: {
-        default?: string;
-        cookie?: string;
-    };
-}
-export declare function preferences(options: PrefOptions): Middleware<Context, Context & {
-    prefs: Record<string, string>;
-    t: NonNullable<Context['t']>;
-    setPref: NonNullable<Context['setPref']>;
-}>;

package/dist/server.d.ts

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