@veloxts/core 0.6.25 → 0.6.27

package/CHANGELOG.md

@@ -0,0 +1,363 @@
+# @veloxts/core
+
+## 0.6.27
+
+### Patch Changes
+
+- chore: add GUIDE, LICENSE and CHANGELOG.md to npm files
+
+## 0.6.26
+
+### Patch Changes
+
+- docs(mcp): add README and GUIDE, docs(web): simplify README and create concise GUIDE
+
+## 0.6.25
+
+### Patch Changes
+
+- docs(create): add guide for React Server Components setup
+
+## 0.6.24
+
+### Patch Changes
+
+- clarify installation paths and package contents
+
+## 0.6.23
+
+### Patch Changes
+
+- add defineContract for improved type inference DX
+
+## 0.6.22
+
+### Patch Changes
+
+- support {method, path} route entry format
+
+## 0.6.21
+
+### Patch Changes
+
+- separate schemas from procedures for browser-safe import
+
+## 0.6.20
+
+### Patch Changes
+
+- add Fastify ecosystem stubs and debuglog to util
+
+## 0.6.19
+
+### Patch Changes
+
+- restore dotenv stub for browser compatibility
+
+## 0.6.18
+
+### Patch Changes
+
+- add node:fs/promises stub and fix esbuild plugin
+
+## 0.6.17
+
+### Patch Changes
+
+- remove optimizeDeps.exclude to fix CJS/ESM interop
+
+## 0.6.16
+
+### Patch Changes
+
+- add stubs for Fastify ecosystem packages
+
+## 0.6.15
+
+### Patch Changes
+
+- implement three-layer Node.js stubbing for Vite
+
+## 0.6.14
+
+### Patch Changes
+
+- stub dotenv as virtual module instead of process shims
+
+## 0.6.13
+
+### Patch Changes
+
+- add process.argv stub for dotenv browser compatibility
+
+## 0.6.12
+
+### Patch Changes
+
+- Fixes the "process is not defined" error from dotenv
+
+## 0.6.11
+
+### Patch Changes
+
+- add Vite plugin for Node.js module stubs
+
+## 0.6.10
+
+### Patch Changes
+
+- use import() type syntax for AppRouter
+
+## 0.6.9
+
+### Patch Changes
+
+- isolate auth procedures from database imports
+
+## 0.6.8
+
+### Patch Changes
+
+- prevent dotenv from leaking into browser bundle
+
+## 0.6.7
+
+### Patch Changes
+
+- better-sqlite3 versions mismatch fix
+
+## 0.6.6
+
+### Patch Changes
+
+- ensure the web app never imports server-side code paths
+
+## 0.6.5
+
+### Patch Changes
+
+- move @prisma/client-runtime-utils to root package.json
+
+## 0.6.4
+
+### Patch Changes
+
+- add @prisma/client-runtime-utils dependency
+
+## 0.6.3
+
+### Patch Changes
+
+- Add workspaces field to root package.json template + Fix Prisma ESM/CJS import for Node.js v24
+
+## 0.6.2
+
+### Patch Changes
+
+- add server actions, removed some deprecated and other chore
+
+## 0.6.1
+
+### Patch Changes
+
+- route groups for file-based routing; add dynamic route support with [param] segments
+
+## 0.6.0
+
+### Minor Changes
+
+- RSC streaming, dynamic routes, Vinxi integration
+
+## 0.5.0
+
+### Minor Changes
+
+- Auto-register procedures + inject Prisma models feature
+
+## 0.4.21
+
+### Patch Changes
+
+- format Prisma default values correctly by type
+
+## 0.4.20
+
+### Patch Changes
+
+- import consolidation: update import paths for `@veloxts/velox`
+
+## 0.4.19
+
+### Patch Changes
+
+- update default dev server port to 3030
+
+## 0.4.18
+
+### Patch Changes
+
+- introduce interactive field menu and templates for resource generation
+
+## 0.4.17
+
+### Patch Changes
+
+- add interactive field prompts for resource generation
+
+## 0.4.16
+
+### Patch Changes
+
+- fixed velox procedures list
+
+## 0.4.15
+
+### Patch Changes
+
+- chore lint fixes
+
+## 0.4.14
+
+### Patch Changes
+
+- fixed proxy-type inferance and update proxy hooks for optional input handling
+
+## 0.4.13
+
+### Patch Changes
+
+- add debug mode to dev server
+
+## 0.4.12
+
+### Patch Changes
+
+- preserve type info in trpc template AppRouter export
+
+## 0.4.11
+
+### Patch Changes
+
+- fixed api.health.check.useQuery is not a function issue
+
+## 0.4.10
+
+### Patch Changes
+
+- fixed ReferenceError: styles is not defined in rpc template
+
+## 0.4.7
+
+### Patch Changes
+
+- Add dynamic headers and routes config to client
+
+## 0.4.6
+
+### Patch Changes
+
+- Fix broken npm packages - republish with correct dependencies
+
+## 0.4.5
+
+### Patch Changes
+
+- b06631b: CI CD npm Trusted Publishing setup
+
+## 0.4.4
+
+### Patch Changes
+
+- 05ae1a5: Update to boilerplate, work in progress
+- 9961b52: full-stack React frontend implementation
+
+## 0.4.3
+
+### Patch Changes
+
+- ef8d5d0: Dynamically load VeloxTS version from `package.json` in shared template configuration
+
+## 0.4.2
+
+### Patch Changes
+
+- 5b4f02c: Updated documentations
+- 0d8d775: Updated guides and readme files
+
+## 0.4.1
+
+### Patch Changes
+
+- 0eea918: Completed CLI generators
+
+## 0.4.0
+
+### Minor Changes
+
+- b478fee: Performance Benchmarks | 34k req/s, <1ms p50 latency, 75MB memory, 530ms startup
+
+## 0.3.6
+
+### Patch Changes
+
+- 929f2ab: Interactive CLI setup
+
+## 0.3.5
+
+### Patch Changes
+
+- 658e83f: @veloxts/auth, Full REST Support, Better error messages, Type tests with tsd
+
+## 0.3.4
+
+### Patch Changes
+
+- 65ef3e7: DI container and Auth Guards
+
+## 0.3.3
+
+### Patch Changes
+
+- 4ee103b: Full REST support PUT, PATCH and DELETE
+
+## 0.3.2
+
+### Patch Changes
+
+- abf270e: Dynamically set core `VELOX_VERSION` from package.json
+
+## 0.3.1
+
+### Patch Changes
+
+- cb9806e: Fixed the value for VELOXTS_VERSION in create app template
+
+## 0.3.0
+
+### Minor Changes
+
+- 1adce10: Introduced an umbrella package for server side packages: @veloxts/velox
+
+## 0.2.2
+
+### Patch Changes
+
+- Version bump to sync with create-velox-app native module fix
+
+## 0.2.0
+
+### Minor Changes
+
+- 9404976: fix Prisma client generation. README adjustments
+
+## 0.1.1
+
+### Patch Changes
+
+- Fix Prisma client generation in scaffolder
+
+  - Added automatic Prisma client generation after dependency installation in create-velox-app
+  - Fixed database template to validate DATABASE_URL environment variable
+  - Added alpha release warning to all package READMEs
+  - Fixed TypeScript type for registerTRPCPlugin to accept FastifyInstance
+  - Updated playground app to use Prisma 7.x custom output path

package/GUIDE.md

@@ -0,0 +1,220 @@
+# @veloxts/core
+
+Core foundation for VeloxTS Framework providing application bootstrap, plugin system, and dependency injection.
+
+## Installation
+
+```bash
+npm install @veloxts/core
+```
+
+## Quick Start
+
+```typescript
+import { veloxApp } from '@veloxts/core';
+
+const app = await veloxApp({ port: 3030 });
+await app.start();
+console.log(`Server running at ${app.address}`);
+```
+
+## Application Setup
+
+Create a VeloxTS application with sensible defaults:
+
+```typescript
+const app = await veloxApp({
+  port: 3030,          // Port to listen on
+  host: '0.0.0.0',     // Host to bind to
+  logger: true,        // Enable logging
+});
+```
+
+The `VeloxApp` instance provides lifecycle methods:
+
+- `app.start()` - Start the HTTP server
+- `app.stop()` - Stop the server gracefully
+- `app.register(plugin)` - Register Fastify plugins
+- `app.server` - Access underlying Fastify instance
+
+## Plugin System
+
+Create reusable plugins with `definePlugin()`:
+
+```typescript
+import { definePlugin } from '@veloxts/core';
+import { PrismaClient } from '@prisma/client';
+
+export const databasePlugin = definePlugin({
+  name: '@myapp/database',
+  version: '1.0.0',
+  async register(server, options) {
+    const db = new PrismaClient();
+    server.decorate('db', db);
+    server.addHook('onClose', async () => {
+      await db.$disconnect();
+    });
+  },
+});
+
+await app.register(databasePlugin);
+```
+
+## Context Extension
+
+Extend the base context using TypeScript declaration merging:
+
+```typescript
+import type { PrismaClient } from '@prisma/client';
+
+declare module '@veloxts/core' {
+  interface BaseContext {
+    db: PrismaClient;
+  }
+}
+
+// Now ctx.db is available with full type safety
+```
+
+## Dependency Injection
+
+VeloxTS provides a powerful DI container for managing service dependencies:
+
+```typescript
+import { Injectable, Inject, Scope, singleton, scoped } from '@veloxts/core';
+
+@Injectable()
+class UserService {
+  constructor(private db: PrismaClient) {}
+
+  async getUser(id: string) {
+    return this.db.user.findUnique({ where: { id } });
+  }
+}
+
+// Register services
+app.container.register(singleton(UserService));
+
+// Resolve in procedures
+const userService = app.container.resolve(UserService);
+```
+
+### Lifecycle Scopes
+
+- `Scope.SINGLETON` - One instance for entire application
+- `Scope.REQUEST` - One instance per HTTP request
+- `Scope.TRANSIENT` - New instance every time
+
+### Succinct Helpers
+
+```typescript
+import { singleton, scoped, transient, value, factory } from '@veloxts/core';
+
+// Class services
+app.container.register(singleton(ConfigService));
+app.container.register(scoped(UserContext));
+app.container.register(transient(RequestLogger));
+
+// Values
+app.container.register(value(CONFIG, { port: 3030 }));
+
+// Factories
+app.container.register(
+  factory(DATABASE, (config) => new PrismaClient({ url: config.dbUrl }), [ConfigService])
+);
+```
+
+## Error Handling
+
+Use structured error classes for consistent API responses:
+
+```typescript
+import {
+  VeloxError,
+  ValidationError,
+  NotFoundError,
+  UnauthorizedError,
+  ForbiddenError,
+} from '@veloxts/core';
+
+// Basic error
+throw new VeloxError('Something went wrong', 500);
+
+// Validation error with field details
+throw new ValidationError('Invalid input', {
+  email: 'Must be a valid email',
+  age: 'Must be at least 18',
+});
+
+// Resource not found
+throw new NotFoundError('User', userId);
+
+// Authentication required
+throw new UnauthorizedError('Must be logged in');
+
+// Insufficient permissions
+throw new ForbiddenError('Admin access required');
+```
+
+## Graceful Shutdown
+
+Handle shutdown signals properly:
+
+```typescript
+const shutdown = async () => {
+  await app.stop();
+  process.exit(0);
+};
+
+process.on('SIGTERM', shutdown);
+process.on('SIGINT', shutdown);
+
+await app.start();
+```
+
+## Complete Example
+
+```typescript
+import { veloxApp, definePlugin } from '@veloxts/core';
+import { PrismaClient } from '@prisma/client';
+
+// Database plugin
+const databasePlugin = definePlugin({
+  name: '@myapp/database',
+  async register(server) {
+    const db = new PrismaClient();
+    server.decorate('db', db);
+    server.addHook('onClose', () => db.$disconnect());
+  },
+});
+
+// Create app
+const app = await veloxApp({
+  port: Number(process.env.PORT) || 3030,
+  logger: true,
+});
+
+// Register plugins
+await app.register(databasePlugin);
+
+// Graceful shutdown
+process.on('SIGTERM', async () => {
+  await app.stop();
+  process.exit(0);
+});
+
+// Start server
+await app.start();
+console.log(`Server running at ${app.address}`);
+```
+
+## Learn More
+
+- [@veloxts/router](https://www.npmjs.com/package/@veloxts/router) - Procedure-based routing
+- [@veloxts/validation](https://www.npmjs.com/package/@veloxts/validation) - Schema validation
+- [@veloxts/orm](https://www.npmjs.com/package/@veloxts/orm) - Prisma integration
+- [VeloxTS Framework](https://www.npmjs.com/package/@veloxts/velox) - Complete framework
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/core",
-  "version": "0.6.25",
+  "version": "0.6.27",
   "description": "Fastify wrapper, DI container, and plugin system for VeloxTS framework",
   "type": "module",
   "main": "dist/index.js",
@@ -17,7 +17,10 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "GUIDE.md",
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "tsd": {
     "directory": "src/__type-tests__",