@furystack/rest-service 12.2.1 → 12.3.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/CHANGELOG.md +44 -0
- package/esm/api-manager.d.ts +1 -1
- package/esm/api-manager.d.ts.map +1 -1
- package/esm/api-manager.js +3 -2
- package/esm/api-manager.js.map +1 -1
- package/esm/authenticate.spec.js +1 -2
- package/esm/authenticate.spec.js.map +1 -1
- package/esm/endpoint-generators/create-get-openapi-document-action.d.ts +29 -0
- package/esm/endpoint-generators/create-get-openapi-document-action.d.ts.map +1 -0
- package/esm/endpoint-generators/create-get-openapi-document-action.js +61 -0
- package/esm/endpoint-generators/create-get-openapi-document-action.js.map +1 -0
- package/esm/endpoint-generators/index.d.ts +2 -0
- package/esm/endpoint-generators/index.d.ts.map +1 -1
- package/esm/endpoint-generators/index.js +2 -0
- package/esm/endpoint-generators/index.js.map +1 -1
- package/esm/endpoint-generators/with-schema-and-openapi-action.d.ts +23 -0
- package/esm/endpoint-generators/with-schema-and-openapi-action.d.ts.map +1 -0
- package/esm/endpoint-generators/with-schema-and-openapi-action.js +2 -0
- package/esm/endpoint-generators/with-schema-and-openapi-action.js.map +1 -0
- package/esm/openapi/auth-provider-to-security-scheme.d.ts +14 -0
- package/esm/openapi/auth-provider-to-security-scheme.d.ts.map +1 -0
- package/esm/openapi/auth-provider-to-security-scheme.js +35 -0
- package/esm/openapi/auth-provider-to-security-scheme.js.map +1 -0
- package/esm/openapi/auth-provider-to-security-scheme.spec.d.ts +2 -0
- package/esm/openapi/auth-provider-to-security-scheme.spec.d.ts.map +1 -0
- package/esm/openapi/auth-provider-to-security-scheme.spec.js +42 -0
- package/esm/openapi/auth-provider-to-security-scheme.spec.js.map +1 -0
- package/esm/openapi/generate-openapi-document.d.ts +21 -0
- package/esm/openapi/generate-openapi-document.d.ts.map +1 -0
- package/esm/openapi/generate-openapi-document.js +144 -0
- package/esm/openapi/generate-openapi-document.js.map +1 -0
- package/esm/openapi/generate-openapi-document.spec.d.ts +2 -0
- package/esm/openapi/generate-openapi-document.spec.d.ts.map +1 -0
- package/esm/openapi/generate-openapi-document.spec.js +643 -0
- package/esm/openapi/generate-openapi-document.spec.js.map +1 -0
- package/esm/openapi/openapi-round-trip.advanced-api.json +363 -0
- package/esm/openapi/openapi-round-trip.crud-api.json +115 -0
- package/esm/openapi/openapi-round-trip.example-api.json +71 -0
- package/esm/openapi/openapi-round-trip.spec.d.ts +2 -0
- package/esm/openapi/openapi-round-trip.spec.d.ts.map +1 -0
- package/esm/openapi/openapi-round-trip.spec.js +525 -0
- package/esm/openapi/openapi-round-trip.spec.js.map +1 -0
- package/esm/swagger/generate-swagger-json.spec.js +1 -1
- package/esm/swagger/generate-swagger-json.spec.js.map +1 -1
- package/esm/validate.integration.spec.js +153 -32
- package/esm/validate.integration.spec.js.map +1 -1
- package/package.json +7 -7
- package/src/api-manager.ts +7 -3
- package/src/authenticate.spec.ts +6 -2
- package/src/endpoint-generators/create-get-openapi-document-action.ts +96 -0
- package/src/endpoint-generators/index.ts +2 -0
- package/src/endpoint-generators/with-schema-and-openapi-action.ts +14 -0
- package/src/openapi/auth-provider-to-security-scheme.spec.ts +50 -0
- package/src/openapi/auth-provider-to-security-scheme.ts +41 -0
- package/src/openapi/generate-openapi-document.spec.ts +733 -0
- package/src/openapi/generate-openapi-document.ts +198 -0
- package/src/openapi/openapi-round-trip.advanced-api.json +363 -0
- package/src/openapi/openapi-round-trip.crud-api.json +115 -0
- package/src/openapi/openapi-round-trip.example-api.json +71 -0
- package/src/openapi/openapi-round-trip.spec.ts +621 -0
- package/src/swagger/generate-swagger-json.spec.ts +1 -1
- package/src/validate.integration.spec.ts +184 -33
- package/esm/endpoint-generators/create-get-swagger-json-action.d.ts +0 -14
- package/esm/endpoint-generators/create-get-swagger-json-action.d.ts.map +0 -1
- package/esm/endpoint-generators/create-get-swagger-json-action.js +0 -18
- package/esm/endpoint-generators/create-get-swagger-json-action.js.map +0 -1
- package/esm/endpoint-generators/with-schema-and-swagger-action.d.ts +0 -21
- package/esm/endpoint-generators/with-schema-and-swagger-action.d.ts.map +0 -1
- package/esm/endpoint-generators/with-schema-and-swagger-action.js +0 -2
- package/esm/endpoint-generators/with-schema-and-swagger-action.js.map +0 -1
- package/esm/swagger/generate-swagger-json.d.ts +0 -14
- package/esm/swagger/generate-swagger-json.d.ts.map +0 -1
- package/esm/swagger/generate-swagger-json.js +0 -108
- package/esm/swagger/generate-swagger-json.js.map +0 -1
- package/src/endpoint-generators/create-get-swagger-json-action.ts +0 -26
- package/src/endpoint-generators/with-schema-and-swagger-action.ts +0 -11
- package/src/swagger/generate-swagger-json.ts +0 -132
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import type { SecuritySchemeObject } from '@furystack/rest'
|
|
2
|
+
|
|
3
|
+
import type { AuthenticationProvider } from '../authentication-providers/authentication-provider.js'
|
|
4
|
+
|
|
5
|
+
const PROVIDER_SCHEME_MAP: Record<string, { schemeName: string; scheme: SecuritySchemeObject }> = {
|
|
6
|
+
'basic-auth': {
|
|
7
|
+
schemeName: 'basicAuth',
|
|
8
|
+
scheme: { type: 'http', scheme: 'basic' },
|
|
9
|
+
},
|
|
10
|
+
'cookie-auth': {
|
|
11
|
+
schemeName: 'cookieAuth',
|
|
12
|
+
scheme: { type: 'apiKey', in: 'cookie', name: 'session' },
|
|
13
|
+
},
|
|
14
|
+
'jwt-bearer': {
|
|
15
|
+
schemeName: 'bearerAuth',
|
|
16
|
+
scheme: { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' },
|
|
17
|
+
},
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Maps FuryStack authentication providers to their corresponding OpenAPI security scheme objects.
|
|
22
|
+
* Known provider names (`basic-auth`, `cookie-auth`, `jwt-bearer`) are mapped to standard OpenAPI
|
|
23
|
+
* security schemes. Unknown provider names are silently ignored.
|
|
24
|
+
*
|
|
25
|
+
* Falls back to a default `cookieAuth` scheme if no known providers are found.
|
|
26
|
+
*
|
|
27
|
+
* @param providers - The list of active authentication providers
|
|
28
|
+
* @returns A record of OpenAPI security scheme name to SecuritySchemeObject
|
|
29
|
+
*/
|
|
30
|
+
export const mapProvidersToSecuritySchemes = (
|
|
31
|
+
providers: AuthenticationProvider[],
|
|
32
|
+
): Record<string, SecuritySchemeObject> => {
|
|
33
|
+
const schemes: Record<string, SecuritySchemeObject> = {}
|
|
34
|
+
for (const provider of providers) {
|
|
35
|
+
const mapping = PROVIDER_SCHEME_MAP[provider.name]
|
|
36
|
+
if (mapping) {
|
|
37
|
+
schemes[mapping.schemeName] = mapping.scheme
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
return Object.keys(schemes).length > 0 ? schemes : { cookieAuth: PROVIDER_SCHEME_MAP['cookie-auth'].scheme }
|
|
41
|
+
}
|