@veloxts/velox 0.4.14 → 0.6.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +24 -47
  2. package/dist/orm.d.ts +1 -1
  3. package/dist/orm.js +1 -1
  4. package/package.json +7 -7
package/README.md CHANGED
@@ -1,66 +1,43 @@
1
- # @veloxts/velox
1
+ # Velox TS Framework
2
2
 
3
- **Pre-Alpha Notice:** This framework is in early development (v0.4.x). APIs are subject to change. Not recommended for production use. Documentation may be incomplete or out of date.
3
+ > **Early Preview (v0.6.x)** - APIs are stabilizing but may still change. Use with caution in production.
4
4
 
5
- ## What is this?
5
+ ## Type-safe full-stack without the build step
6
6
 
7
- Complete VeloxTS Framework umbrella package - batteries included for building type-safe, full-stack TypeScript applications.
7
+ Full-stack TypeScript framework with end-to-end type safety—no code generation required. Convention-driven APIs that generate both tRPC and REST from a single source.
8
8
 
9
- ## Installation
9
+ ## Quick Start (Recommended)
10
10
 
11
11
  ```bash
12
- npm install @veloxts/velox
12
+ npx create-velox-app my-app
13
+ cd my-app
14
+ npm run db:push
15
+ npm run dev
13
16
  ```
14
17
 
15
- This single package includes everything you need to build VeloxTS applications.
18
+ Your API is running at `http://localhost:3030`.
16
19
 
17
- ## Documentation
20
+ ## Manual Installation
18
21
 
19
- For detailed documentation, usage examples, and API reference, see [GUIDE.md](./GUIDE.md).
22
+ For adding to an existing project:
20
23
 
21
- ## Quick Example
22
-
23
- ```typescript
24
- import { veloxApp, procedure, defineProcedures, rest, z } from '@veloxts/velox';
25
-
26
- const app = await veloxApp({ port: 3000 });
27
-
28
- const greetProcedures = defineProcedures('greet', {
29
- sayHello: procedure()
30
- .input(z.object({ name: z.string() }))
31
- .query(({ input }) => `Hello, ${input.name}!`),
32
- });
33
-
34
- // Register procedures as REST endpoints
35
- app.routes(rest([greetProcedures], { prefix: '/api' }));
36
-
37
- await app.start();
38
- // GET /api/greet/hello?name=World -> "Hello, World!"
24
+ ```bash
25
+ npm install @veloxts/velox zod
26
+ npm install -D @veloxts/cli tsx typescript prisma @prisma/client
39
27
  ```
40
28
 
41
- ## What's Included
42
-
43
- This umbrella package includes:
44
-
45
- - **@veloxts/core** - Application bootstrap, plugins, context, dependency injection
46
- - **@veloxts/validation** - Zod integration and schema utilities
47
- - **@veloxts/orm** - Database plugin and Prisma integration
48
- - **@veloxts/router** - Procedure definitions, REST adapter, tRPC
49
- - **@veloxts/auth** - Authentication and authorization
29
+ Note: Manual setup requires Prisma 7 configuration with driver adapters. See [@veloxts/orm](https://www.npmjs.com/package/@veloxts/orm) for details.
50
30
 
51
- ## Separate Packages
52
-
53
- These packages are installed separately:
54
-
55
- - **@veloxts/client** - Type-safe frontend API client
56
- - **@veloxts/cli** - Developer tooling CLI
57
- - **create-velox-app** - Project scaffolder
31
+ ## What's Included
58
32
 
59
- ## Learn More
33
+ This umbrella package re-exports:
34
+ - `@veloxts/core` - App bootstrap, plugins, DI
35
+ - `@veloxts/validation` - Zod integration
36
+ - `@veloxts/orm` - Prisma database plugin
37
+ - `@veloxts/router` - Procedures, REST adapter, tRPC
38
+ - `@veloxts/auth` - Authentication & authorization
60
39
 
61
- - [Full Documentation](./GUIDE.md)
62
- - [Getting Started Guide](https://github.com/veloxts/velox-ts-framework#getting-started)
63
- - [GitHub Repository](https://github.com/veloxts/velox-ts-framework)
40
+ Separate packages: `@veloxts/cli`, `@veloxts/client`, `create-velox-app`
64
41
 
65
42
  ## License
66
43
 
package/dist/orm.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Use this subpath for better tree-shaking:
5
5
  * @example
6
6
  * ```typescript
7
- * import { createDatabasePlugin } from '@veloxts/velox/orm';
7
+ * import { databasePlugin } from '@veloxts/velox/orm';
8
8
  * ```
9
9
  */
10
10
  export * from '@veloxts/orm';
package/dist/orm.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Use this subpath for better tree-shaking:
5
5
  * @example
6
6
  * ```typescript
7
- * import { createDatabasePlugin } from '@veloxts/velox/orm';
7
+ * import { databasePlugin } from '@veloxts/velox/orm';
8
8
  * ```
9
9
  */
10
10
  export * from '@veloxts/orm';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veloxts/velox",
3
- "version": "0.4.14",
3
+ "version": "0.6.25",
4
4
  "description": "Complete VeloxTS framework - batteries included",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -36,17 +36,17 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@veloxts/core": "0.4.14",
40
- "@veloxts/validation": "0.4.14",
41
- "@veloxts/orm": "0.4.14",
42
- "@veloxts/router": "0.4.14",
43
- "@veloxts/auth": "0.4.14"
39
+ "@veloxts/core": "0.6.25",
40
+ "@veloxts/validation": "0.6.25",
41
+ "@veloxts/orm": "0.6.25",
42
+ "@veloxts/router": "0.6.25",
43
+ "@veloxts/auth": "0.6.25"
44
44
  },
45
45
  "devDependencies": {
46
46
  "typescript": "5.9.3"
47
47
  },
48
48
  "peerDependencies": {
49
- "zod": "^3.24.0"
49
+ "zod": "^3.25.0"
50
50
  },
51
51
  "keywords": [
52
52
  "velox",