vite-plugin-server-actions 0.1.0 → 1.0.0

package/index.d.ts

@@ -0,0 +1,200 @@
+import type { Plugin } from "vite";
+import type { RequestHandler } from "express";
+import type { z } from "zod";
+
+export interface ValidationOptions {
+	/**
+	 * Enable validation for server actions
+	 * @default false
+	 */
+	enabled?: boolean;
+	
+	/**
+	 * Validation adapter to use
+	 * @default "zod"
+	 */
+	adapter?: "zod";
+}
+
+export interface OpenAPIOptions {
+	/**
+	 * Enable OpenAPI documentation generation
+	 * @default false
+	 */
+	enabled?: boolean;
+	
+	/**
+	 * OpenAPI specification info
+	 */
+	info?: {
+		title?: string;
+		version?: string;
+		description?: string;
+	};
+	
+	/**
+	 * Path to serve the Swagger UI documentation
+	 * @default "/api/docs"
+	 */
+	docsPath?: string;
+	
+	/**
+	 * Path to serve the OpenAPI JSON specification
+	 * @default "/api/openapi.json"
+	 */
+	specPath?: string;
+	
+	/**
+	 * Enable Swagger UI
+	 * @default true when OpenAPI is enabled
+	 */
+	swaggerUI?: boolean;
+}
+
+export interface ServerActionOptions {
+	/**
+	 * Custom API prefix for server action endpoints
+	 * @default "/api"
+	 */
+	apiPrefix?: string;
+	
+	/**
+	 * Include patterns for server action files
+	 * @default ["**\/*.server.js"]
+	 */
+	include?: string | string[];
+	
+	/**
+	 * Exclude patterns for server action files
+	 * @default []
+	 */
+	exclude?: string | string[];
+	
+	/**
+	 * Middleware to run before server action handlers
+	 * Can be a single middleware or array of middleware
+	 */
+	middleware?: RequestHandler | RequestHandler[];
+	
+	/**
+	 * Transform function for module names (internal use)
+	 * @param filePath - The file path relative to project root
+	 * @returns The module name to use internally
+	 */
+	moduleNameTransform?: (filePath: string) => string;
+	
+	/**
+	 * Transform function for API routes
+	 * @param filePath - The file path relative to project root
+	 * @param functionName - The exported function name
+	 * @returns The API route path (without prefix)
+	 * @default Clean hierarchical paths (removes src/ and .server.js)
+	 */
+	routeTransform?: (filePath: string, functionName: string) => string;
+	
+	/**
+	 * Validation configuration
+	 */
+	validation?: ValidationOptions;
+	
+	/**
+	 * OpenAPI documentation configuration
+	 */
+	openAPI?: OpenAPIOptions;
+}
+
+export interface ServerActionsPlugin extends Plugin {
+	name: "vite-plugin-server-actions";
+}
+
+/**
+ * Creates a Vite plugin that enables server actions
+ * @param options - Configuration options for the plugin
+ * @returns Vite plugin instance
+ */
+declare function serverActions(options?: ServerActionOptions): ServerActionsPlugin;
+
+/**
+ * Built-in middleware for server actions
+ */
+export declare const middleware: {
+	/**
+	 * Logging middleware that displays server action calls with formatted JSON output
+	 */
+	logging: RequestHandler;
+};
+
+/**
+ * Path transformation utilities
+ */
+export declare const pathUtils: {
+	/**
+	 * Creates clean hierarchical routes: "actions/todo/create"
+	 * @param filePath - The file path relative to project root
+	 * @param functionName - The exported function name
+	 * @returns Clean route path
+	 */
+	createCleanRoute: (filePath: string, functionName: string) => string;
+	
+	/**
+	 * Creates legacy underscore-separated routes: "src_actions_todo/create"
+	 * @param filePath - The file path relative to project root
+	 * @param functionName - The exported function name
+	 * @returns Legacy route path
+	 */
+	createLegacyRoute: (filePath: string, functionName: string) => string;
+	
+	/**
+	 * Creates minimal routes: "actions/todo.server/create"
+	 * @param filePath - The file path relative to project root
+	 * @param functionName - The exported function name
+	 * @returns Minimal route path
+	 */
+	createMinimalRoute: (filePath: string, functionName: string) => string;
+	
+	/**
+	 * Creates module names for internal use
+	 * @param filePath - The file path relative to project root
+	 * @returns Module name
+	 */
+	createModuleName: (filePath: string) => string;
+};
+
+// Validation exports
+export interface ValidationAdapter {
+	validate(schema: any, data: any): Promise<any>;
+	getSchemaType(schema: any): string;
+}
+
+export declare class ZodAdapter implements ValidationAdapter {
+	validate(schema: z.ZodSchema<any>, data: any): Promise<any>;
+	getSchemaType(schema: z.ZodSchema<any>): string;
+}
+
+export declare class SchemaDiscovery {
+	constructor();
+	registerSchema(moduleName: string, functionName: string, schema: any): void;
+	getSchema(moduleName: string, functionName: string): any;
+	getAllSchemas(): Map<string, any>;
+	discoverFromModule(module: any, moduleName: string): void;
+}
+
+export declare const adapters: {
+	zod: ZodAdapter;
+};
+
+export declare function createValidationMiddleware(options: {
+	schemaDiscovery: SchemaDiscovery;
+}): RequestHandler;
+
+// OpenAPI exports
+export declare class OpenAPIGenerator {
+	constructor(options?: { info?: any });
+	generateSpec(serverFunctions: Map<string, any>, schemaDiscovery: SchemaDiscovery, options?: any): any;
+}
+
+export declare function setupOpenAPIEndpoints(app: any, options: any): void;
+
+export declare function createSwaggerMiddleware(spec: any): RequestHandler;
+
+export default serverActions;

package/package.json

@@ -1,39 +1,104 @@
 {
   "name": "vite-plugin-server-actions",
-  "description": "Automatically proxy imported backend functions to a server endpoint in Vite",
-  "version": "0.1.0",
-  "type": "module",
+  "version": "1.0.0",
+  "description": "Server actions for Vite - call backend functions directly from your frontend with automatic API generation, TypeScript support, and zero configuration",
   "keywords": [
+    "vite",
     "vite-plugin",
+    "server-actions",
     "server",
-    "actions"
+    "backend",
+    "api",
+    "rpc",
+    "typescript",
+    "openapi",
+    "swagger",
+    "validation",
+    "zod",
+    "full-stack",
+    "serverless",
+    "functions",
+    "middleware",
+    "express"
   ],
-  "license": "MIT",
   "homepage": "https://github.com/HelgeSverre/vite-plugin-server-actions",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/HelgeSverre/vite-plugin-server-actions"
-  },
   "bugs": {
     "url": "https://github.com/HelgeSverre/vite-plugin-server-actions/issues"
   },
-  "readme": "README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HelgeSverre/vite-plugin-server-actions.git"
+  },
+  "license": "MIT",
   "author": {
     "name": "Helge Sverre",
     "email": "helge.sverre@gmail.com",
     "url": "https://helgesver.re"
   },
+  "type": "module",
   "main": "src/index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "scripts": {
+    "example:svelte:build": "npm run build --prefix examples/svelte-todo-app",
+    "example:svelte:dev": "npm run dev --prefix examples/svelte-todo-app",
+    "example:vue:build": "npm run build --prefix examples/vue-todo-app",
+    "example:vue:dev": "npm run dev --prefix examples/vue-todo-app",
+    "example:react:build": "npm run build --prefix examples/react-todo-app",
+    "example:react:dev": "npm run dev --prefix examples/react-todo-app",
     "format": "npx prettier --write src/ README.md",
-    "sort": "npx sort-package-json"
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "sort": "npx sort-package-json",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:e2e": "playwright test",
+    "test:e2e:ui": "playwright test --ui",
+    "typecheck": "tsc --noEmit",
+    "check": "npm run test:run && npm run lint && npm run typecheck",
+    "prepublishOnly": "npm run check"
   },
-  "devDependencies": {
+  "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^7.3.4",
     "express": "^4.21.0",
-    "prettier": "^3.3.3",
-    "vitest": "^0.34.0"
+    "minimatch": "^10.0.3",
+    "rollup": "^4.0.0",
+    "swagger-ui-express": "^5.0.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@apidevtools/swagger-parser": "^12.0.0",
+    "@eslint/js": "^9.29.0",
+    "@playwright/test": "^1.53.1",
+    "@stoplight/spectral-core": "^1.20.0",
+    "@stoplight/spectral-rulesets": "^1.22.0",
+    "@types/express": "^5.0.3",
+    "@types/node": "^24.0.3",
+    "@types/swagger-ui-express": "^4.1.6",
+    "@vitest/runner": "^3.2.4",
+    "eslint": "^9.29.0",
+    "playwright": "^1.53.1",
+    "prettier": "^3.6.0",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.5",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
-    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0"
-  }
+    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
+  },
+  "readme": "README.md"
 }

package/src/build-utils.js

@@ -0,0 +1,101 @@
+import { createRequire } from "module";
+import { pathToFileURL } from "url";
+
+/**
+ * Extract schemas from server modules during build time
+ */
+export async function extractSchemas(serverFunctions) {
+	const schemas = {};
+
+	for (const [moduleName, { id, functions }] of serverFunctions) {
+		schemas[moduleName] = {};
+
+		try {
+			// Import the module to get schemas
+			const moduleUrl = pathToFileURL(id).href;
+			const module = await import(moduleUrl);
+
+			// Extract schemas from exported functions
+			for (const functionName of functions) {
+				if (module[functionName] && module[functionName].schema) {
+					// We need to serialize the Zod schema
+					// For now, we'll store a reference that can be imported
+					schemas[moduleName][functionName] = {
+						hasSchema: true,
+						// We'll need to generate import statements for these
+					};
+				}
+			}
+		} catch (error) {
+			console.warn(`Failed to extract schemas from ${id}: ${error.message}`);
+		}
+	}
+
+	return schemas;
+}
+
+/**
+ * Generate validation setup code for production
+ */
+export function generateValidationCode(options, serverFunctions) {
+	if (!options.validation?.enabled) {
+		return {
+			imports: "",
+			setup: "",
+			middlewareFactory: "",
+		};
+	}
+
+	// Generate imports
+	const imports = `
+import { createValidationMiddleware, SchemaDiscovery } from '../../../src/validation.js';
+`;
+
+	// Generate schema imports from the bundled actions
+	const schemaImports = Array.from(serverFunctions.entries())
+		.map(([moduleName, { functions }]) => {
+			return functions.map((fn) => `// Import schema for ${moduleName}.${fn} if it exists`).join("\n");
+		})
+		.join("\n");
+
+	// Generate setup code
+	const setup = `
+// Setup validation
+const schemaDiscovery = new SchemaDiscovery();
+const validationMiddleware = createValidationMiddleware({ schemaDiscovery });
+
+// Register schemas from server actions
+${Array.from(serverFunctions.entries())
+		.map(([moduleName, { functions }]) => {
+			return functions
+				.map(
+					(fn) => `
+if (serverActions.${moduleName}.${fn}.schema) {
+  schemaDiscovery.registerSchema('${moduleName}', '${fn}', serverActions.${moduleName}.${fn}.schema);
+}`,
+				)
+				.join("\n");
+		})
+		.join("\n")}
+`;
+
+	// Generate middleware factory
+	const middlewareFactory = `
+function createContextualValidationMiddleware(moduleName, functionName) {
+  return (req, res, next) => {
+    req.validationContext = {
+      moduleName,
+      functionName,
+      schema: serverActions[moduleName]?.[functionName]?.schema
+    };
+    return validationMiddleware(req, res, next);
+  };
+}
+`;
+
+	return {
+		imports: imports + schemaImports,
+		setup,
+		middlewareFactory,
+	};
+}