@twin.org/api-models 0.0.3-next.12 → 0.0.3-next.13
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/dist/es/index.js +0 -2
- package/dist/es/index.js.map +1 -1
- package/dist/types/index.d.ts +0 -2
- package/docs/changelog.md +7 -0
- package/docs/reference/index.md +0 -2
- package/package.json +1 -1
- package/dist/es/factories/authenticationGeneratorFactory.js +0 -9
- package/dist/es/factories/authenticationGeneratorFactory.js.map +0 -1
- package/dist/es/models/client/IAuthenticationGenerator.js +0 -2
- package/dist/es/models/client/IAuthenticationGenerator.js.map +0 -1
- package/dist/types/factories/authenticationGeneratorFactory.d.ts +0 -6
- package/dist/types/models/client/IAuthenticationGenerator.d.ts +0 -14
- package/docs/reference/interfaces/IAuthenticationGenerator.md +0 -35
- package/docs/reference/variables/AuthenticationGeneratorFactory.md +0 -5
package/dist/es/index.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
// Copyright 2024 IOTA Stiftung.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
-
export * from "./factories/authenticationGeneratorFactory.js";
|
|
4
3
|
export * from "./factories/mimeTypeProcessorFactory.js";
|
|
5
4
|
export * from "./factories/restRouteProcessorFactory.js";
|
|
6
5
|
export * from "./factories/socketRouteProcessorFactory.js";
|
|
@@ -12,7 +11,6 @@ export * from "./models/api/IServerInfoResponse.js";
|
|
|
12
11
|
export * from "./models/api/IServerLivezResponse.js";
|
|
13
12
|
export * from "./models/api/IServerRootResponse.js";
|
|
14
13
|
export * from "./models/api/IServerSpecResponse.js";
|
|
15
|
-
export * from "./models/client/IAuthenticationGenerator.js";
|
|
16
14
|
export * from "./models/config/IBaseRestClientConfig.js";
|
|
17
15
|
export * from "./models/config/IBaseSocketClientConfig.js";
|
|
18
16
|
export * from "./models/protocol/IHttpRequest.js";
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AACzD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,oDAAoD,CAAC;AACnE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,iDAAiD,CAAC;AAChE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wDAAwD,CAAC;AACvE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,mCAAmC,CAAC;AAClD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/mimeTypeProcessorFactory.js\";\nexport * from \"./factories/restRouteProcessorFactory.js\";\nexport * from \"./factories/socketRouteProcessorFactory.js\";\nexport * from \"./helpers/httpErrorHelper.js\";\nexport * from \"./helpers/httpParameterHelper.js\";\nexport * from \"./models/api/IServerFavIconResponse.js\";\nexport * from \"./models/api/IServerHealthResponse.js\";\nexport * from \"./models/api/IServerInfoResponse.js\";\nexport * from \"./models/api/IServerLivezResponse.js\";\nexport * from \"./models/api/IServerRootResponse.js\";\nexport * from \"./models/api/IServerSpecResponse.js\";\nexport * from \"./models/config/IBaseRestClientConfig.js\";\nexport * from \"./models/config/IBaseSocketClientConfig.js\";\nexport * from \"./models/protocol/IHttpRequest.js\";\nexport * from \"./models/protocol/IHttpRequestContext.js\";\nexport * from \"./models/protocol/IHttpRequestPathParams.js\";\nexport * from \"./models/protocol/IHttpRequestQuery.js\";\nexport * from \"./models/protocol/IHttpResponse.js\";\nexport * from \"./models/protocol/IHttpServerRequest.js\";\nexport * from \"./models/protocol/ISocketRequestContext.js\";\nexport * from \"./models/protocol/ISocketServerRequest.js\";\nexport * from \"./models/requests/INoContentRequest.js\";\nexport * from \"./models/responses/errors/IBadRequestResponse.js\";\nexport * from \"./models/responses/errors/IConflictResponse.js\";\nexport * from \"./models/responses/errors/IForbiddenResponse.js\";\nexport * from \"./models/responses/errors/IInternalServerErrorResponse.js\";\nexport * from \"./models/responses/errors/INotFoundResponse.js\";\nexport * from \"./models/responses/errors/IUnauthorizedResponse.js\";\nexport * from \"./models/responses/errors/IUnprocessableEntityResponse.js\";\nexport * from \"./models/responses/success/IAcceptedResponse.js\";\nexport * from \"./models/responses/success/ICreatedResponse.js\";\nexport * from \"./models/responses/success/INoContentResponse.js\";\nexport * from \"./models/responses/success/IOkResponse.js\";\nexport * from \"./models/routes/IBaseRoute.js\";\nexport * from \"./models/routes/IBaseRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRoute.js\";\nexport * from \"./models/routes/IRestRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRouteExample.js\";\nexport * from \"./models/routes/IRestRouteRequestExample.js\";\nexport * from \"./models/routes/IRestRouteResponseAttachmentOptions.js\";\nexport * from \"./models/routes/IRestRouteResponseExample.js\";\nexport * from \"./models/routes/IRestRouteResponseOptions.js\";\nexport * from \"./models/routes/ISocketRoute.js\";\nexport * from \"./models/routes/ISocketRouteEntryPoint.js\";\nexport * from \"./models/routes/ITag.js\";\nexport * from \"./models/server/IBaseRouteProcessor.js\";\nexport * from \"./models/server/IMimeTypeProcessor.js\";\nexport * from \"./models/server/IRestRouteProcessor.js\";\nexport * from \"./models/server/ISocketRouteProcessor.js\";\nexport * from \"./models/server/IWebServer.js\";\nexport * from \"./models/server/IWebServerOptions.js\";\nexport * from \"./models/services/healthStatus.js\";\nexport * from \"./models/services/IHealthComponentInfo.js\";\nexport * from \"./models/services/IHealthInfo.js\";\nexport * from \"./models/services/IInformationComponent.js\";\nexport * from \"./models/services/IServerInfo.js\";\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export * from "./factories/authenticationGeneratorFactory.js";
|
|
2
1
|
export * from "./factories/mimeTypeProcessorFactory.js";
|
|
3
2
|
export * from "./factories/restRouteProcessorFactory.js";
|
|
4
3
|
export * from "./factories/socketRouteProcessorFactory.js";
|
|
@@ -10,7 +9,6 @@ export * from "./models/api/IServerInfoResponse.js";
|
|
|
10
9
|
export * from "./models/api/IServerLivezResponse.js";
|
|
11
10
|
export * from "./models/api/IServerRootResponse.js";
|
|
12
11
|
export * from "./models/api/IServerSpecResponse.js";
|
|
13
|
-
export * from "./models/client/IAuthenticationGenerator.js";
|
|
14
12
|
export * from "./models/config/IBaseRestClientConfig.js";
|
|
15
13
|
export * from "./models/config/IBaseSocketClientConfig.js";
|
|
16
14
|
export * from "./models/protocol/IHttpRequest.js";
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @twin.org/api-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.13](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.12...api-models-v0.0.3-next.13) (2026-01-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* remove authentication generators ([#66](https://github.com/twinfoundation/api/issues/66)) ([adaa169](https://github.com/twinfoundation/api/commit/adaa1698df1c5ccb0ad645a7a7c0d3ef82ef6ac1))
|
|
9
|
+
|
|
3
10
|
## [0.0.3-next.12](https://github.com/twinfoundation/api/compare/api-models-v0.0.3-next.11...api-models-v0.0.3-next.12) (2026-01-12)
|
|
4
11
|
|
|
5
12
|
|
package/docs/reference/index.md
CHANGED
|
@@ -13,7 +13,6 @@
|
|
|
13
13
|
- [IServerLivezResponse](interfaces/IServerLivezResponse.md)
|
|
14
14
|
- [IServerRootResponse](interfaces/IServerRootResponse.md)
|
|
15
15
|
- [IServerSpecResponse](interfaces/IServerSpecResponse.md)
|
|
16
|
-
- [IAuthenticationGenerator](interfaces/IAuthenticationGenerator.md)
|
|
17
16
|
- [IBaseRestClientConfig](interfaces/IBaseRestClientConfig.md)
|
|
18
17
|
- [IBaseSocketClientConfig](interfaces/IBaseSocketClientConfig.md)
|
|
19
18
|
- [IHttpRequest](interfaces/IHttpRequest.md)
|
|
@@ -65,7 +64,6 @@
|
|
|
65
64
|
|
|
66
65
|
## Variables
|
|
67
66
|
|
|
68
|
-
- [AuthenticationGeneratorFactory](variables/AuthenticationGeneratorFactory.md)
|
|
69
67
|
- [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
|
|
70
68
|
- [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
|
|
71
69
|
- [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)
|
package/package.json
CHANGED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
// Copyright 2024 IOTA Stiftung.
|
|
2
|
-
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
-
import { Factory } from "@twin.org/core";
|
|
4
|
-
/**
|
|
5
|
-
* Factory for creating implementation of authentication generator types.
|
|
6
|
-
*/
|
|
7
|
-
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
8
|
-
export const AuthenticationGeneratorFactory = Factory.createFactory("authentication-generator");
|
|
9
|
-
//# sourceMappingURL=authenticationGeneratorFactory.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"authenticationGeneratorFactory.js","sourceRoot":"","sources":["../../../src/factories/authenticationGeneratorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG,OAAO,CAAC,aAAa,CAClE,0BAA0B,CAC1B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IAuthenticationGenerator } from \"../models/client/IAuthenticationGenerator.js\";\n\n/**\n * Factory for creating implementation of authentication generator types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuthenticationGeneratorFactory = Factory.createFactory<IAuthenticationGenerator>(\n\t\"authentication-generator\"\n);\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IAuthenticationGenerator.js","sourceRoot":"","sources":["../../../../src/models/client/IAuthenticationGenerator.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IHttpHeaders } from \"@twin.org/web\";\n\n/**\n * Definition for the authentication generator component.\n */\nexport interface IAuthenticationGenerator extends IComponent {\n\t/**\n\t * Adds authentication information to the request headers.\n\t * @param requestHeaders The request headers to add authentication information to.\n\t * @param authData Optional authentication data passed from the request.\n\t * @returns A promise that resolves when the authentication information has been added.\n\t */\n\taddAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;\n}\n"]}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { Factory } from "@twin.org/core";
|
|
2
|
-
import type { IAuthenticationGenerator } from "../models/client/IAuthenticationGenerator.js";
|
|
3
|
-
/**
|
|
4
|
-
* Factory for creating implementation of authentication generator types.
|
|
5
|
-
*/
|
|
6
|
-
export declare const AuthenticationGeneratorFactory: Factory<IAuthenticationGenerator>;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { IComponent } from "@twin.org/core";
|
|
2
|
-
import type { IHttpHeaders } from "@twin.org/web";
|
|
3
|
-
/**
|
|
4
|
-
* Definition for the authentication generator component.
|
|
5
|
-
*/
|
|
6
|
-
export interface IAuthenticationGenerator extends IComponent {
|
|
7
|
-
/**
|
|
8
|
-
* Adds authentication information to the request headers.
|
|
9
|
-
* @param requestHeaders The request headers to add authentication information to.
|
|
10
|
-
* @param authData Optional authentication data passed from the request.
|
|
11
|
-
* @returns A promise that resolves when the authentication information has been added.
|
|
12
|
-
*/
|
|
13
|
-
addAuthentication(requestHeaders: IHttpHeaders, authData?: unknown): Promise<void>;
|
|
14
|
-
}
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
# Interface: IAuthenticationGenerator
|
|
2
|
-
|
|
3
|
-
Definition for the authentication generator component.
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- `IComponent`
|
|
8
|
-
|
|
9
|
-
## Methods
|
|
10
|
-
|
|
11
|
-
### addAuthentication()
|
|
12
|
-
|
|
13
|
-
> **addAuthentication**(`requestHeaders`, `authData?`): `Promise`\<`void`\>
|
|
14
|
-
|
|
15
|
-
Adds authentication information to the request headers.
|
|
16
|
-
|
|
17
|
-
#### Parameters
|
|
18
|
-
|
|
19
|
-
##### requestHeaders
|
|
20
|
-
|
|
21
|
-
`IHttpHeaders`
|
|
22
|
-
|
|
23
|
-
The request headers to add authentication information to.
|
|
24
|
-
|
|
25
|
-
##### authData?
|
|
26
|
-
|
|
27
|
-
`unknown`
|
|
28
|
-
|
|
29
|
-
Optional authentication data passed from the request.
|
|
30
|
-
|
|
31
|
-
#### Returns
|
|
32
|
-
|
|
33
|
-
`Promise`\<`void`\>
|
|
34
|
-
|
|
35
|
-
A promise that resolves when the authentication information has been added.
|