@superfunctions/http-fastify 0.1.0 → 0.1.1
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 +18 -18
- package/dist/adapter.d.ts +2 -2
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +2 -2
- package/dist/adapter.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ npm install @superfunctions/http @superfunctions/http-fastify fastify
|
|
|
13
13
|
```typescript
|
|
14
14
|
import Fastify from 'fastify';
|
|
15
15
|
import { createRouter } from '@superfunctions/http';
|
|
16
|
-
import {
|
|
16
|
+
import { toFastify } from '@superfunctions/http-fastify';
|
|
17
17
|
|
|
18
18
|
// Define your router (framework-agnostic)
|
|
19
19
|
const apiRouter = createRouter({
|
|
@@ -30,13 +30,13 @@ const apiRouter = createRouter({
|
|
|
30
30
|
|
|
31
31
|
// Use with Fastify
|
|
32
32
|
const fastify = Fastify();
|
|
33
|
-
await fastify.register(
|
|
33
|
+
await fastify.register(toFastify(apiRouter), { prefix: '/api' });
|
|
34
34
|
await fastify.listen({ port: 3000 });
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
## API
|
|
38
38
|
|
|
39
|
-
### `
|
|
39
|
+
### `toFastify(router)`
|
|
40
40
|
|
|
41
41
|
Converts a `@superfunctions/http` router to a Fastify plugin.
|
|
42
42
|
|
|
@@ -47,9 +47,9 @@ Converts a `@superfunctions/http` router to a Fastify plugin.
|
|
|
47
47
|
|
|
48
48
|
**Example:**
|
|
49
49
|
```typescript
|
|
50
|
-
import {
|
|
50
|
+
import { toFastify } from '@superfunctions/http-fastify';
|
|
51
51
|
|
|
52
|
-
await fastify.register(
|
|
52
|
+
await fastify.register(toFastify(myRouter), {
|
|
53
53
|
prefix: '/api'
|
|
54
54
|
});
|
|
55
55
|
```
|
|
@@ -61,12 +61,12 @@ await fastify.register(toFastifyPlugin(myRouter), {
|
|
|
61
61
|
|
|
62
62
|
```typescript
|
|
63
63
|
import Fastify from 'fastify';
|
|
64
|
-
import {
|
|
64
|
+
import { toFastify } from '@superfunctions/http-fastify';
|
|
65
65
|
|
|
66
66
|
const fastify = Fastify();
|
|
67
67
|
|
|
68
68
|
// Register with prefix
|
|
69
|
-
await fastify.register(
|
|
69
|
+
await fastify.register(toFastify(apiRouter), {
|
|
70
70
|
prefix: '/api/v1'
|
|
71
71
|
});
|
|
72
72
|
|
|
@@ -78,7 +78,7 @@ await fastify.listen({ port: 3000 });
|
|
|
78
78
|
|
|
79
79
|
```typescript
|
|
80
80
|
import { createRouter } from '@superfunctions/http';
|
|
81
|
-
import {
|
|
81
|
+
import { toFastify } from '@superfunctions/http-fastify';
|
|
82
82
|
|
|
83
83
|
const router = createRouter({
|
|
84
84
|
middleware: [
|
|
@@ -100,7 +100,7 @@ const router = createRouter({
|
|
|
100
100
|
],
|
|
101
101
|
});
|
|
102
102
|
|
|
103
|
-
await fastify.register(
|
|
103
|
+
await fastify.register(toFastify(router), { prefix: '/api' });
|
|
104
104
|
```
|
|
105
105
|
|
|
106
106
|
### With Custom Context
|
|
@@ -124,7 +124,7 @@ const router = createRouter<AppContext>({
|
|
|
124
124
|
],
|
|
125
125
|
});
|
|
126
126
|
|
|
127
|
-
await fastify.register(
|
|
127
|
+
await fastify.register(toFastify(router), { prefix: '/api' });
|
|
128
128
|
```
|
|
129
129
|
|
|
130
130
|
### Multiple Routers
|
|
@@ -133,8 +133,8 @@ await fastify.register(toFastifyPlugin(router), { prefix: '/api' });
|
|
|
133
133
|
const usersRouter = createRouter({ routes: [/* user routes */] });
|
|
134
134
|
const postsRouter = createRouter({ routes: [/* post routes */] });
|
|
135
135
|
|
|
136
|
-
await fastify.register(
|
|
137
|
-
await fastify.register(
|
|
136
|
+
await fastify.register(toFastify(usersRouter), { prefix: '/api/users' });
|
|
137
|
+
await fastify.register(toFastify(postsRouter), { prefix: '/api/posts' });
|
|
138
138
|
```
|
|
139
139
|
|
|
140
140
|
### With Fastify Decorators
|
|
@@ -144,7 +144,7 @@ You can combine with other Fastify plugins:
|
|
|
144
144
|
```typescript
|
|
145
145
|
import Fastify from 'fastify';
|
|
146
146
|
import fastifyCors from '@fastify/cors';
|
|
147
|
-
import {
|
|
147
|
+
import { toFastify } from '@superfunctions/http-fastify';
|
|
148
148
|
|
|
149
149
|
const fastify = Fastify();
|
|
150
150
|
|
|
@@ -154,7 +154,7 @@ await fastify.register(fastifyCors, {
|
|
|
154
154
|
});
|
|
155
155
|
|
|
156
156
|
// Register your router
|
|
157
|
-
await fastify.register(
|
|
157
|
+
await fastify.register(toFastify(apiRouter), { prefix: '/api' });
|
|
158
158
|
|
|
159
159
|
await fastify.listen({ port: 3000 });
|
|
160
160
|
```
|
|
@@ -167,10 +167,10 @@ The adapter returns a Fastify plugin that must be registered with `await fastify
|
|
|
167
167
|
|
|
168
168
|
```typescript
|
|
169
169
|
// ✅ Correct - await registration
|
|
170
|
-
await fastify.register(
|
|
170
|
+
await fastify.register(toFastify(router));
|
|
171
171
|
|
|
172
172
|
// ❌ Incorrect - missing await
|
|
173
|
-
fastify.register(
|
|
173
|
+
fastify.register(toFastify(router));
|
|
174
174
|
```
|
|
175
175
|
|
|
176
176
|
### Prefix Handling
|
|
@@ -185,7 +185,7 @@ const router = createRouter({
|
|
|
185
185
|
});
|
|
186
186
|
|
|
187
187
|
// Route accessible at: /api/hello
|
|
188
|
-
await fastify.register(
|
|
188
|
+
await fastify.register(toFastify(router), { prefix: '/api' });
|
|
189
189
|
```
|
|
190
190
|
|
|
191
191
|
### JSON Serialization
|
|
@@ -222,7 +222,7 @@ import type { Router } from '@superfunctions/http';
|
|
|
222
222
|
import type { FastifyPluginAsync } from 'fastify';
|
|
223
223
|
|
|
224
224
|
const myRouter: Router = createRouter({ routes: [...] });
|
|
225
|
-
const plugin: FastifyPluginAsync =
|
|
225
|
+
const plugin: FastifyPluginAsync = toFastify(myRouter);
|
|
226
226
|
|
|
227
227
|
await fastify.register(plugin, { prefix: '/api' });
|
|
228
228
|
```
|
package/dist/adapter.d.ts
CHANGED
|
@@ -8,8 +8,8 @@ import type { FastifyPluginAsync } from 'fastify';
|
|
|
8
8
|
*
|
|
9
9
|
* Usage:
|
|
10
10
|
* ```typescript
|
|
11
|
-
* fastify.register(
|
|
11
|
+
* fastify.register(toFastify(router), { prefix: '/api' });
|
|
12
12
|
* ```
|
|
13
13
|
*/
|
|
14
|
-
export declare function
|
|
14
|
+
export declare function toFastify(router: Router): FastifyPluginAsync;
|
|
15
15
|
//# sourceMappingURL=adapter.d.ts.map
|
package/dist/adapter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAmB,kBAAkB,EAAgC,MAAM,SAAS,CAAC;AAEjG;;;;;;;GAOG;AACH,wBAAgB,
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAmB,kBAAkB,EAAgC,MAAM,SAAS,CAAC;AAEjG;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAmB5D"}
|
package/dist/adapter.js
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Usage:
|
|
8
8
|
* ```typescript
|
|
9
|
-
* fastify.register(
|
|
9
|
+
* fastify.register(toFastify(router), { prefix: '/api' });
|
|
10
10
|
* ```
|
|
11
11
|
*/
|
|
12
|
-
export function
|
|
12
|
+
export function toFastify(router) {
|
|
13
13
|
const plugin = async (fastify, opts) => {
|
|
14
14
|
const prefix = opts.prefix || '';
|
|
15
15
|
// Catch all route that delegates to the router
|
package/dist/adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH;;;;;;;GAOG;AACH,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,MAAM,MAAM,GAAuB,KAAK,EAAE,OAAwB,EAAE,IAAS,EAAE,EAAE;QAC/E,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;QAEjC,+CAA+C;QAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;YACvE,kDAAkD;YAClD,8DAA8D;YAC9D,MAAM,UAAU,GAAG,MAAM,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAE9D,kDAAkD;YAClD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAEpD,wCAAwC;YACxC,MAAM,qBAAqB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,mBAAmB,CAAC,OAAuB,EAAE,SAAiB,EAAE;IAC7E,iBAAiB;IACjB,6DAA6D;IAC7D,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC;IACvB,IAAI,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC;IAC1C,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC;IAC9B,MAAM,GAAG,GAAG,GAAG,QAAQ,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC;IAE3C,kBAAkB;IAClB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3D,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;IAED,cAAc;IACd,IAAI,IAAI,GAAoB,IAAI,CAAC;IACjC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;QAC1D,yEAAyE;QACzE,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChE,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;gBACjC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO;QACP,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,qBAAqB,CAClC,WAAqB,EACrB,KAAmB;IAEnB,aAAa;IACb,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEjC,cAAc;IACd,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACzC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,YAAY;IACZ,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;QAEtC,kEAAkE;QAClE,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5D,IAAI,WAAW,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC9C,IAAI,CAAC;gBACH,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/B,CAAC;YAAC,MAAM,CAAC;gBACP,iCAAiC;gBACjC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,EAAE,CAAC;IACf,CAAC;AACH,CAAC"}
|
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC"}
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC"}
|