@furystack/rest-service 13.0.0 → 14.0.0

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 (224) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +47 -28
  3. package/esm/actions/get-current-user.spec.js +10 -6
  4. package/esm/actions/get-current-user.spec.js.map +1 -1
  5. package/esm/actions/is-authenticated.spec.js +10 -6
  6. package/esm/actions/is-authenticated.spec.js.map +1 -1
  7. package/esm/actions/logout-action.spec.js +11 -9
  8. package/esm/actions/logout-action.spec.js.map +1 -1
  9. package/esm/actions/logout.js +1 -1
  10. package/esm/actions/logout.js.map +1 -1
  11. package/esm/actions/password-login-action.js +1 -1
  12. package/esm/actions/password-login-action.js.map +1 -1
  13. package/esm/actions/password-login-action.spec.js +23 -28
  14. package/esm/actions/password-login-action.spec.js.map +1 -1
  15. package/esm/authenticate.js +1 -1
  16. package/esm/authenticate.js.map +1 -1
  17. package/esm/authenticate.spec.js +41 -33
  18. package/esm/authenticate.spec.js.map +1 -1
  19. package/esm/authorize.spec.js +34 -29
  20. package/esm/authorize.spec.js.map +1 -1
  21. package/esm/endpoint-generators/create-delete-endpoint.d.ts +6 -11
  22. package/esm/endpoint-generators/create-delete-endpoint.d.ts.map +1 -1
  23. package/esm/endpoint-generators/create-delete-endpoint.js +7 -11
  24. package/esm/endpoint-generators/create-delete-endpoint.js.map +1 -1
  25. package/esm/endpoint-generators/create-delete-endpoint.spec.js +14 -21
  26. package/esm/endpoint-generators/create-delete-endpoint.spec.js.map +1 -1
  27. package/esm/endpoint-generators/create-get-collection-endpoint.d.ts +11 -11
  28. package/esm/endpoint-generators/create-get-collection-endpoint.d.ts.map +1 -1
  29. package/esm/endpoint-generators/create-get-collection-endpoint.js +13 -12
  30. package/esm/endpoint-generators/create-get-collection-endpoint.js.map +1 -1
  31. package/esm/endpoint-generators/create-get-collection-endpoint.spec.js +43 -70
  32. package/esm/endpoint-generators/create-get-collection-endpoint.spec.js.map +1 -1
  33. package/esm/endpoint-generators/create-get-entity-endpoint.d.ts +6 -11
  34. package/esm/endpoint-generators/create-get-entity-endpoint.d.ts.map +1 -1
  35. package/esm/endpoint-generators/create-get-entity-endpoint.js +7 -11
  36. package/esm/endpoint-generators/create-get-entity-endpoint.js.map +1 -1
  37. package/esm/endpoint-generators/create-get-entity-endpoint.spec.js +16 -33
  38. package/esm/endpoint-generators/create-get-entity-endpoint.spec.js.map +1 -1
  39. package/esm/endpoint-generators/create-get-openapi-document-action.d.ts +1 -1
  40. package/esm/endpoint-generators/create-get-openapi-document-action.d.ts.map +1 -1
  41. package/esm/endpoint-generators/create-get-openapi-document-action.js +1 -1
  42. package/esm/endpoint-generators/create-get-openapi-document-action.js.map +1 -1
  43. package/esm/endpoint-generators/create-get-schema-action.d.ts +1 -1
  44. package/esm/endpoint-generators/create-get-schema-action.d.ts.map +1 -1
  45. package/esm/endpoint-generators/create-get-schema-action.js.map +1 -1
  46. package/esm/endpoint-generators/create-patch-endpoint.d.ts +7 -13
  47. package/esm/endpoint-generators/create-patch-endpoint.d.ts.map +1 -1
  48. package/esm/endpoint-generators/create-patch-endpoint.js +8 -13
  49. package/esm/endpoint-generators/create-patch-endpoint.js.map +1 -1
  50. package/esm/endpoint-generators/create-patch-endpoint.spec.js +10 -17
  51. package/esm/endpoint-generators/create-patch-endpoint.spec.js.map +1 -1
  52. package/esm/endpoint-generators/create-post-endpoint.d.ts +7 -13
  53. package/esm/endpoint-generators/create-post-endpoint.d.ts.map +1 -1
  54. package/esm/endpoint-generators/create-post-endpoint.js +8 -13
  55. package/esm/endpoint-generators/create-post-endpoint.js.map +1 -1
  56. package/esm/endpoint-generators/create-post-endpoint.spec.js +41 -14
  57. package/esm/endpoint-generators/create-post-endpoint.spec.js.map +1 -1
  58. package/esm/endpoint-generators/utils.d.ts +17 -2
  59. package/esm/endpoint-generators/utils.d.ts.map +1 -1
  60. package/esm/endpoint-generators/utils.js +33 -20
  61. package/esm/endpoint-generators/utils.js.map +1 -1
  62. package/esm/get-schema-from-api.d.ts +1 -1
  63. package/esm/get-schema-from-api.d.ts.map +1 -1
  64. package/esm/get-schema-from-api.spec.js.map +1 -1
  65. package/esm/helpers.d.ts +53 -87
  66. package/esm/helpers.d.ts.map +1 -1
  67. package/esm/helpers.js +91 -92
  68. package/esm/helpers.js.map +1 -1
  69. package/esm/helpers.spec.d.ts +2 -1
  70. package/esm/helpers.spec.d.ts.map +1 -1
  71. package/esm/helpers.spec.js +41 -38
  72. package/esm/helpers.spec.js.map +1 -1
  73. package/esm/http-authentication-settings.d.ts +35 -12
  74. package/esm/http-authentication-settings.d.ts.map +1 -1
  75. package/esm/http-authentication-settings.js +21 -29
  76. package/esm/http-authentication-settings.js.map +1 -1
  77. package/esm/http-server-pool.d.ts +64 -0
  78. package/esm/http-server-pool.d.ts.map +1 -0
  79. package/esm/http-server-pool.js +95 -0
  80. package/esm/http-server-pool.js.map +1 -0
  81. package/esm/http-server-pool.spec.d.ts +2 -0
  82. package/esm/http-server-pool.spec.d.ts.map +1 -0
  83. package/esm/http-server-pool.spec.js +193 -0
  84. package/esm/http-server-pool.spec.js.map +1 -0
  85. package/esm/http-user-context.d.ts +31 -44
  86. package/esm/http-user-context.d.ts.map +1 -1
  87. package/esm/http-user-context.js +76 -95
  88. package/esm/http-user-context.js.map +1 -1
  89. package/esm/http-user-context.spec.d.ts +8 -2
  90. package/esm/http-user-context.spec.d.ts.map +1 -1
  91. package/esm/http-user-context.spec.js +189 -337
  92. package/esm/http-user-context.spec.js.map +1 -1
  93. package/esm/index.d.ts +6 -4
  94. package/esm/index.d.ts.map +1 -1
  95. package/esm/index.js +6 -4
  96. package/esm/index.js.map +1 -1
  97. package/esm/login-response-strategy.d.ts +11 -10
  98. package/esm/login-response-strategy.d.ts.map +1 -1
  99. package/esm/login-response-strategy.js +7 -6
  100. package/esm/login-response-strategy.js.map +1 -1
  101. package/esm/login-response-strategy.spec.js +25 -29
  102. package/esm/login-response-strategy.spec.js.map +1 -1
  103. package/esm/proxy-manager.spec.js +152 -176
  104. package/esm/proxy-manager.spec.js.map +1 -1
  105. package/esm/proxy-runtime.d.ts +27 -0
  106. package/esm/proxy-runtime.d.ts.map +1 -0
  107. package/esm/proxy-runtime.js +45 -0
  108. package/esm/proxy-runtime.js.map +1 -0
  109. package/esm/proxy-runtime.spec.d.ts +2 -0
  110. package/esm/proxy-runtime.spec.d.ts.map +1 -0
  111. package/esm/proxy-runtime.spec.js +39 -0
  112. package/esm/proxy-runtime.spec.js.map +1 -0
  113. package/esm/rest-api-runtime.d.ts +76 -0
  114. package/esm/rest-api-runtime.d.ts.map +1 -0
  115. package/esm/rest-api-runtime.js +131 -0
  116. package/esm/rest-api-runtime.js.map +1 -0
  117. package/esm/rest-api-runtime.spec.d.ts +2 -0
  118. package/esm/rest-api-runtime.spec.d.ts.map +1 -0
  119. package/esm/rest-api-runtime.spec.js +58 -0
  120. package/esm/rest-api-runtime.spec.js.map +1 -0
  121. package/esm/rest-service.integration.spec.d.ts +1 -1
  122. package/esm/rest-service.integration.spec.d.ts.map +1 -1
  123. package/esm/rest-service.integration.spec.js +57 -80
  124. package/esm/rest-service.integration.spec.js.map +1 -1
  125. package/esm/rest.integration.test.js +26 -84
  126. package/esm/rest.integration.test.js.map +1 -1
  127. package/esm/server-telemetry.d.ts +57 -0
  128. package/esm/server-telemetry.d.ts.map +1 -0
  129. package/esm/server-telemetry.js +26 -0
  130. package/esm/server-telemetry.js.map +1 -0
  131. package/esm/server-telemetry.spec.d.ts +2 -0
  132. package/esm/server-telemetry.spec.d.ts.map +1 -0
  133. package/esm/server-telemetry.spec.js +52 -0
  134. package/esm/server-telemetry.spec.js.map +1 -0
  135. package/esm/static-server-manager.spec.js +60 -125
  136. package/esm/static-server-manager.spec.js.map +1 -1
  137. package/esm/static-site-runtime.d.ts +21 -0
  138. package/esm/static-site-runtime.d.ts.map +1 -0
  139. package/esm/static-site-runtime.js +48 -0
  140. package/esm/static-site-runtime.js.map +1 -0
  141. package/esm/static-site-runtime.spec.d.ts +2 -0
  142. package/esm/static-site-runtime.spec.d.ts.map +1 -0
  143. package/esm/static-site-runtime.spec.js +30 -0
  144. package/esm/static-site-runtime.spec.js.map +1 -0
  145. package/esm/user-store.d.ts +39 -0
  146. package/esm/user-store.d.ts.map +1 -0
  147. package/esm/user-store.js +62 -0
  148. package/esm/user-store.js.map +1 -0
  149. package/esm/user-store.spec.d.ts +2 -0
  150. package/esm/user-store.spec.d.ts.map +1 -0
  151. package/esm/user-store.spec.js +72 -0
  152. package/esm/user-store.spec.js.map +1 -0
  153. package/esm/validate.integration.spec.js +26 -28
  154. package/esm/validate.integration.spec.js.map +1 -1
  155. package/package.json +8 -8
  156. package/src/actions/get-current-user.spec.ts +11 -10
  157. package/src/actions/is-authenticated.spec.ts +12 -7
  158. package/src/actions/logout-action.spec.ts +12 -12
  159. package/src/actions/logout.ts +1 -1
  160. package/src/actions/password-login-action.spec.ts +30 -30
  161. package/src/actions/password-login-action.ts +1 -1
  162. package/src/authenticate.spec.ts +45 -51
  163. package/src/authenticate.ts +1 -1
  164. package/src/authorize.spec.ts +37 -39
  165. package/src/endpoint-generators/create-delete-endpoint.spec.ts +16 -24
  166. package/src/endpoint-generators/create-delete-endpoint.ts +11 -17
  167. package/src/endpoint-generators/create-get-collection-endpoint.spec.ts +45 -78
  168. package/src/endpoint-generators/create-get-collection-endpoint.ts +17 -19
  169. package/src/endpoint-generators/create-get-entity-endpoint.spec.ts +17 -33
  170. package/src/endpoint-generators/create-get-entity-endpoint.ts +11 -17
  171. package/src/endpoint-generators/create-get-openapi-document-action.ts +2 -2
  172. package/src/endpoint-generators/create-get-schema-action.ts +1 -1
  173. package/src/endpoint-generators/create-patch-endpoint.spec.ts +11 -18
  174. package/src/endpoint-generators/create-patch-endpoint.ts +12 -23
  175. package/src/endpoint-generators/create-post-endpoint.spec.ts +45 -14
  176. package/src/endpoint-generators/create-post-endpoint.ts +13 -23
  177. package/src/endpoint-generators/utils.ts +36 -28
  178. package/src/get-schema-from-api.spec.ts +1 -1
  179. package/src/get-schema-from-api.ts +1 -1
  180. package/src/helpers.spec.ts +51 -41
  181. package/src/helpers.ts +140 -109
  182. package/src/http-authentication-settings.ts +51 -25
  183. package/src/http-server-pool.spec.ts +220 -0
  184. package/src/http-server-pool.ts +169 -0
  185. package/src/http-user-context.spec.ts +203 -383
  186. package/src/http-user-context.ts +114 -91
  187. package/src/index.ts +6 -4
  188. package/src/login-response-strategy.spec.ts +32 -31
  189. package/src/login-response-strategy.ts +13 -12
  190. package/src/proxy-manager.spec.ts +152 -182
  191. package/src/proxy-runtime.spec.ts +50 -0
  192. package/src/proxy-runtime.ts +75 -0
  193. package/src/rest-api-runtime.spec.ts +77 -0
  194. package/src/rest-api-runtime.ts +204 -0
  195. package/src/rest-service.integration.spec.ts +65 -85
  196. package/src/rest.integration.test.ts +27 -87
  197. package/src/server-telemetry.spec.ts +56 -0
  198. package/src/server-telemetry.ts +51 -0
  199. package/src/static-server-manager.spec.ts +63 -151
  200. package/src/static-site-runtime.spec.ts +39 -0
  201. package/src/static-site-runtime.ts +75 -0
  202. package/src/user-store.spec.ts +86 -0
  203. package/src/user-store.ts +68 -0
  204. package/src/validate.integration.spec.ts +39 -35
  205. package/esm/api-manager.d.ts +0 -104
  206. package/esm/api-manager.d.ts.map +0 -1
  207. package/esm/api-manager.js +0 -179
  208. package/esm/api-manager.js.map +0 -1
  209. package/esm/proxy-manager.d.ts +0 -53
  210. package/esm/proxy-manager.d.ts.map +0 -1
  211. package/esm/proxy-manager.js +0 -84
  212. package/esm/proxy-manager.js.map +0 -1
  213. package/esm/server-manager.d.ts +0 -48
  214. package/esm/server-manager.d.ts.map +0 -1
  215. package/esm/server-manager.js +0 -100
  216. package/esm/server-manager.js.map +0 -1
  217. package/esm/static-server-manager.d.ts +0 -19
  218. package/esm/static-server-manager.d.ts.map +0 -1
  219. package/esm/static-server-manager.js +0 -65
  220. package/esm/static-server-manager.js.map +0 -1
  221. package/src/api-manager.ts +0 -304
  222. package/src/proxy-manager.ts +0 -102
  223. package/src/server-manager.ts +0 -135
  224. package/src/static-server-manager.ts +0 -90
@@ -1,135 +0,0 @@
1
- import { Injectable } from '@furystack/inject'
2
- import { EventHub, type ListenerErrorPayload } from '@furystack/utils'
3
- import type { IncomingMessage, Server, ServerResponse } from 'http'
4
- import { createServer } from 'http'
5
- import type { Socket } from 'net'
6
- import type { Duplex } from 'stream'
7
-
8
- export interface ServerOptions {
9
- hostName?: string
10
- port: number
11
- }
12
-
13
- export interface OnRequest {
14
- req: IncomingMessage
15
- res: ServerResponse
16
- }
17
-
18
- export interface OnUpgrade {
19
- req: IncomingMessage
20
- socket: Duplex
21
- head: Buffer
22
- }
23
-
24
- export interface ServerApi {
25
- shouldExec: (options: OnRequest) => boolean
26
- onRequest: (options: OnRequest) => Promise<void>
27
- onUpgrade?: (options: OnUpgrade) => Promise<void>
28
- }
29
-
30
- export interface ServerRecord {
31
- server: Server
32
- apis: ServerApi[]
33
- }
34
-
35
- @Injectable({ lifetime: 'singleton' })
36
- export class ServerManager
37
- extends EventHub<{
38
- onRequestFailed: [unknown, IncomingMessage, ServerResponse<IncomingMessage>]
39
- onServerListening: { url: string; port: number; hostName?: string }
40
- onServerClosed: { url: string }
41
- onListenerError: ListenerErrorPayload
42
- }>
43
- implements AsyncDisposable
44
- {
45
- public static DEFAULT_HOST = 'localhost'
46
- public servers = new Map<string, ServerRecord>()
47
- private openedSockets = new Set<Socket>()
48
- private readonly pendingCreates = new Map<string, Promise<ServerRecord>>()
49
- private getHostUrl = (options: ServerOptions) =>
50
- `http://${options.hostName || ServerManager.DEFAULT_HOST}:${options.port}`
51
-
52
- private onConnection = (socket: Socket) => {
53
- this.openedSockets.add(socket)
54
- socket.once('close', () => this.openedSockets.delete(socket))
55
- }
56
- public async [Symbol.asyncDispose]() {
57
- await Promise.allSettled([...this.pendingCreates.values()])
58
- this.openedSockets.forEach((s) => s.destroy())
59
- await Promise.allSettled(
60
- [...this.servers.entries()].map(
61
- ([url, s]) =>
62
- new Promise<void>((resolve, reject) => {
63
- s.server.close((err) => {
64
- if (err) {
65
- reject(err)
66
- } else {
67
- this.emit('onServerClosed', { url })
68
- resolve()
69
- }
70
- })
71
- s.server.off('connection', this.onConnection)
72
- }),
73
- ),
74
- )
75
- this.servers.clear()
76
- super[Symbol.dispose]?.()
77
- }
78
-
79
- public async getOrCreate(options: ServerOptions): Promise<ServerRecord> {
80
- const url = this.getHostUrl(options)
81
-
82
- const existing = this.servers.get(url)
83
- if (existing) {
84
- return existing
85
- }
86
-
87
- const pending = this.pendingCreates.get(url)
88
- if (pending) {
89
- return pending
90
- }
91
-
92
- const createPromise = this.createServer(url, options)
93
- this.pendingCreates.set(url, createPromise)
94
- return createPromise
95
- }
96
-
97
- private async createServer(url: string, options: ServerOptions): Promise<ServerRecord> {
98
- const apis: ServerRecord['apis'] = []
99
- const server = createServer((req, res) => {
100
- const apiMatch = apis.find((api) => api.shouldExec({ req, res }))
101
- if (apiMatch) {
102
- apiMatch.onRequest({ req, res }).catch((error) => {
103
- this.emit('onRequestFailed', [error, req, res])
104
- })
105
- } else {
106
- res.destroy()
107
- }
108
- })
109
- server.on('upgrade', (req, socket, head) => {
110
- const apiMatch = apis.find((api) => api.shouldExec({ req, res: {} as ServerResponse }))
111
- if (apiMatch?.onUpgrade) {
112
- apiMatch.onUpgrade({ req, socket, head }).catch((error) => {
113
- this.emit('onRequestFailed', [error, req, {} as ServerResponse])
114
- socket.destroy()
115
- })
116
- } else {
117
- socket.destroy()
118
- }
119
- })
120
- server.on('connection', this.onConnection)
121
- try {
122
- await new Promise<void>((resolve, reject) => {
123
- server.on('listening', () => resolve())
124
- server.on('error', (err) => reject(err))
125
- server.listen(options.port, options.hostName)
126
- })
127
- const record: ServerRecord = { server, apis }
128
- this.servers.set(url, record)
129
- this.emit('onServerListening', { url, port: options.port, hostName: options.hostName })
130
- return record
131
- } finally {
132
- this.pendingCreates.delete(url)
133
- }
134
- }
135
- }
@@ -1,90 +0,0 @@
1
- import { Injectable, Injected } from '@furystack/inject'
2
- import { PathHelper } from '@furystack/utils'
3
- import { createReadStream } from 'fs'
4
- import { access, stat } from 'fs/promises'
5
- import type { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from 'http'
6
- import { join, normalize, sep } from 'path'
7
- import { getMimeForFile } from './mime-types.js'
8
- import { ServerManager } from './server-manager.js'
9
-
10
- export interface StaticServerOptions {
11
- baseUrl: string
12
- path: string
13
- hostName?: string
14
- port: number
15
- fallback?: string
16
- headers?: OutgoingHttpHeaders
17
- }
18
-
19
- @Injectable({ lifetime: 'singleton' })
20
- export class StaticServerManager {
21
- @Injected(ServerManager)
22
- declare private readonly serverManager: ServerManager
23
-
24
- private async sendFile({
25
- fullPath,
26
- headers,
27
- res,
28
- }: {
29
- fullPath: string
30
- res: ServerResponse
31
- headers?: OutgoingHttpHeaders
32
- }) {
33
- const { size } = await stat(fullPath)
34
-
35
- await access(fullPath)
36
-
37
- const head = {
38
- ...headers,
39
- 'Content-Length': size,
40
- 'Content-Type': getMimeForFile(fullPath),
41
- }
42
- Object.entries(head).map(([key, value]) => res.setHeader(key, value))
43
- await new Promise<void>((resolve, reject) =>
44
- createReadStream(fullPath, { autoClose: true }).once('finish', resolve).once('error', reject).pipe(res),
45
- )
46
- }
47
-
48
- public shouldExec =
49
- (baseUrl: string) =>
50
- ({ req }: { req: Pick<IncomingMessage, 'url' | 'method'> }) =>
51
- req.url && req.method?.toUpperCase() === 'GET' && PathHelper.matchesBaseUrl(req.url, baseUrl) ? true : false
52
-
53
- private onRequest = ({
54
- path,
55
- baseUrl,
56
- fallback,
57
- headers,
58
- }: {
59
- path: string
60
- baseUrl: string
61
- fallback?: string
62
- headers?: OutgoingHttpHeaders
63
- }) => {
64
- return async ({ req, res }: { req: IncomingMessage; res: ServerResponse }) => {
65
- const extractedPath = PathHelper.extractPath(req.url as string, baseUrl)
66
- const filePath = (extractedPath || '/').replaceAll('/', sep)
67
- const fullPath = normalize(join(path, filePath))
68
-
69
- try {
70
- await this.sendFile({ fullPath, res, headers })
71
- } catch (error) {
72
- if (fallback) {
73
- await this.sendFile({ fullPath: normalize(join(path, fallback)), res, headers })
74
- } else {
75
- res.writeHead(404, { 'Content-Type': 'text/plain' })
76
- res.end('Not found')
77
- }
78
- }
79
- }
80
- }
81
-
82
- public async addStaticSite(options: StaticServerOptions) {
83
- const server = await this.serverManager.getOrCreate({ hostName: options.hostName, port: options.port })
84
-
85
- server.apis.push({
86
- shouldExec: this.shouldExec(options.baseUrl),
87
- onRequest: this.onRequest({ ...options }),
88
- })
89
- }
90
- }