navis.js 5.3.0 → 5.3.2
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.
- package/README.md +38 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -72,6 +72,24 @@ exports.handler = async (event) => {
|
|
|
72
72
|
};
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
+
### TypeScript
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import { NavisApp, response } from 'navis.js';
|
|
79
|
+
|
|
80
|
+
const app = new NavisApp();
|
|
81
|
+
|
|
82
|
+
app.get('/', (req, res) => {
|
|
83
|
+
response.success(res, {
|
|
84
|
+
message: 'Hello from Navis.js with TypeScript!'
|
|
85
|
+
});
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
app.listen(3000);
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
See `examples/server.ts` and `examples/typescript-features-demo.ts` for complete TypeScript examples.
|
|
92
|
+
|
|
75
93
|
## CLI
|
|
76
94
|
|
|
77
95
|
```bash
|
|
@@ -142,19 +160,25 @@ navis metrics
|
|
|
142
160
|
- ✅ **Health checks** - Liveness and readiness probes
|
|
143
161
|
- ✅ **Graceful shutdown** - Clean shutdown handling
|
|
144
162
|
|
|
145
|
-
### v5.1
|
|
163
|
+
### v5.1
|
|
146
164
|
|
|
147
165
|
- ✅ **OpenAPI/Swagger** - Auto-generate API documentation
|
|
148
166
|
- ✅ **API versioning** - URL-based and header-based versioning
|
|
149
167
|
- ✅ **File upload** - Multipart form data handling
|
|
150
168
|
- ✅ **Testing utilities** - Test helpers for applications
|
|
151
169
|
|
|
152
|
-
### v5.2
|
|
170
|
+
### v5.2
|
|
153
171
|
|
|
154
172
|
- ✅ **WebSocket support** - Real-time bidirectional communication
|
|
155
173
|
- ✅ **Server-Sent Events** - One-way real-time streaming
|
|
156
174
|
- ✅ **Database integration** - Connection pooling for PostgreSQL, MySQL, MongoDB
|
|
157
175
|
|
|
176
|
+
### v5.3 (Current)
|
|
177
|
+
|
|
178
|
+
- ✅ **TypeScript support** - Full type definitions for all features
|
|
179
|
+
- ✅ **Type-safe API** - Complete IntelliSense and type checking
|
|
180
|
+
- ✅ **TypeScript examples** - Ready-to-use TypeScript examples
|
|
181
|
+
|
|
158
182
|
## API Reference
|
|
159
183
|
|
|
160
184
|
### NavisApp
|
|
@@ -337,13 +361,18 @@ exports.handler = async (event, context) => {
|
|
|
337
361
|
See the `examples/` directory:
|
|
338
362
|
|
|
339
363
|
- `server.js` - Node.js HTTP server example
|
|
364
|
+
- `server.ts` - TypeScript HTTP server example (v5.3)
|
|
340
365
|
- `lambda.js` - AWS Lambda handler example
|
|
366
|
+
- `lambda.ts` - TypeScript Lambda handler example (v5.3)
|
|
341
367
|
- `lambda-optimized.js` - Optimized Lambda handler with cold start optimizations (v3.1)
|
|
368
|
+
- `typescript-features-demo.ts` - Complete TypeScript features demonstration (v5.3)
|
|
369
|
+
- `v2-features-demo.js` - v2 features demonstration (retry, circuit breaker, etc.)
|
|
370
|
+
- `v3-features-demo.js` - v3 features demonstration (messaging, observability, etc.)
|
|
342
371
|
- `v4-features-demo.js` - v4 features demonstration (routing, validation, auth, rate limiting, etc.)
|
|
343
372
|
- `v5-features-demo.js` - v5 features demonstration (caching, CORS, security, compression, health checks, etc.)
|
|
373
|
+
- `v5.1-features-demo.js` - v5.1 features demonstration (Swagger, versioning, upload, testing)
|
|
374
|
+
- `v5.2-features-demo.js` - v5.2 features demonstration (WebSocket, SSE, database)
|
|
344
375
|
- `service-client-demo.js` - ServiceClient usage example
|
|
345
|
-
- `v2-features-demo.js` - v2 features demonstration (retry, circuit breaker, etc.)
|
|
346
|
-
- `v3-features-demo.js` - v3 features demonstration (messaging, observability, etc.)
|
|
347
376
|
|
|
348
377
|
## Roadmap
|
|
349
378
|
|
|
@@ -365,9 +394,12 @@ Enterprise-grade: caching, CORS, security headers, compression, health checks, g
|
|
|
365
394
|
### v5.1 ✅
|
|
366
395
|
Developer experience: OpenAPI/Swagger, API versioning, file upload, testing utilities
|
|
367
396
|
|
|
368
|
-
### v5.2 ✅
|
|
397
|
+
### v5.2 ✅
|
|
369
398
|
Real-time features: WebSocket, Server-Sent Events, database integration
|
|
370
399
|
|
|
400
|
+
### v5.3 ✅ (Current)
|
|
401
|
+
TypeScript support: Full type definitions, type-safe API, IntelliSense
|
|
402
|
+
|
|
371
403
|
## What's Next?
|
|
372
404
|
|
|
373
405
|
Future versions may include:
|
|
@@ -385,6 +417,7 @@ Future versions may include:
|
|
|
385
417
|
- [V5 Features Guide](./docs/V5_FEATURES.md) - Complete v5 features documentation
|
|
386
418
|
- [V5.1 Features Guide](./docs/V5.1_FEATURES.md) - Complete v5.1 features documentation
|
|
387
419
|
- [V5.2 Features Guide](./docs/V5.2_FEATURES.md) - Complete v5.2 features documentation
|
|
420
|
+
- [TypeScript Guide](./docs/TYPESCRIPT.md) - Complete TypeScript support documentation (v5.3)
|
|
388
421
|
- [Lambda Optimization Guide](./docs/LAMBDA_OPTIMIZATION.md) - Lambda cold start optimization guide (v3.1)
|
|
389
422
|
- [Verification Guide v2](./docs/VERIFY_V2.md) - How to verify v2 features
|
|
390
423
|
- [Verification Guide v3](./docs/VERIFY_V3.md) - How to verify v3 features
|
package/package.json
CHANGED