@twin.org/api-models 0.0.1-next.18 → 0.0.1-next.19

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.
@@ -14,10 +14,18 @@ const MimeTypeProcessorFactory = core.Factory.createFactory("mime-type-processor
14
14
  // Copyright 2024 IOTA Stiftung.
15
15
  // SPDX-License-Identifier: Apache-2.0.
16
16
  /**
17
- * Factory for creating implementation of route processor types.
17
+ * Factory for creating implementation of REST route processor types.
18
18
  */
19
19
  // eslint-disable-next-line @typescript-eslint/naming-convention
20
- const RouteProcessorFactory = core.Factory.createFactory("route-processor");
20
+ const RestRouteProcessorFactory = core.Factory.createFactory("rest-route-processor");
21
+
22
+ // Copyright 2024 IOTA Stiftung.
23
+ // SPDX-License-Identifier: Apache-2.0.
24
+ /**
25
+ * Factory for creating implementation of socket route processor types.
26
+ */
27
+ // eslint-disable-next-line @typescript-eslint/naming-convention
28
+ const SocketRouteProcessorFactory = core.Factory.createFactory("socket-route-processor");
21
29
 
22
30
  // Copyright 2024 IOTA Stiftung.
23
31
  // SPDX-License-Identifier: Apache-2.0.
@@ -146,4 +154,5 @@ exports.HealthStatus = HealthStatus;
146
154
  exports.HttpErrorHelper = HttpErrorHelper;
147
155
  exports.HttpParameterHelper = HttpParameterHelper;
148
156
  exports.MimeTypeProcessorFactory = MimeTypeProcessorFactory;
149
- exports.RouteProcessorFactory = RouteProcessorFactory;
157
+ exports.RestRouteProcessorFactory = RestRouteProcessorFactory;
158
+ exports.SocketRouteProcessorFactory = SocketRouteProcessorFactory;
@@ -12,10 +12,18 @@ const MimeTypeProcessorFactory = Factory.createFactory("mime-type-processor");
12
12
  // Copyright 2024 IOTA Stiftung.
13
13
  // SPDX-License-Identifier: Apache-2.0.
14
14
  /**
15
- * Factory for creating implementation of route processor types.
15
+ * Factory for creating implementation of REST route processor types.
16
16
  */
17
17
  // eslint-disable-next-line @typescript-eslint/naming-convention
18
- const RouteProcessorFactory = Factory.createFactory("route-processor");
18
+ const RestRouteProcessorFactory = Factory.createFactory("rest-route-processor");
19
+
20
+ // Copyright 2024 IOTA Stiftung.
21
+ // SPDX-License-Identifier: Apache-2.0.
22
+ /**
23
+ * Factory for creating implementation of socket route processor types.
24
+ */
25
+ // eslint-disable-next-line @typescript-eslint/naming-convention
26
+ const SocketRouteProcessorFactory = Factory.createFactory("socket-route-processor");
19
27
 
20
28
  // Copyright 2024 IOTA Stiftung.
21
29
  // SPDX-License-Identifier: Apache-2.0.
@@ -140,4 +148,4 @@ const HealthStatus = {
140
148
  Error: "error"
141
149
  };
142
150
 
143
- export { HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RouteProcessorFactory };
151
+ export { HealthStatus, HttpErrorHelper, HttpParameterHelper, MimeTypeProcessorFactory, RestRouteProcessorFactory, SocketRouteProcessorFactory };
@@ -0,0 +1,6 @@
1
+ import { Factory } from "@twin.org/core";
2
+ import type { IRestRouteProcessor } from "../models/server/IRestRouteProcessor";
3
+ /**
4
+ * Factory for creating implementation of REST route processor types.
5
+ */
6
+ export declare const RestRouteProcessorFactory: Factory<IRestRouteProcessor>;
@@ -0,0 +1,6 @@
1
+ import { Factory } from "@twin.org/core";
2
+ import type { ISocketRouteProcessor } from "../models/server/ISocketRouteProcessor";
3
+ /**
4
+ * Factory for creating implementation of socket route processor types.
5
+ */
6
+ export declare const SocketRouteProcessorFactory: Factory<ISocketRouteProcessor>;
@@ -1,5 +1,6 @@
1
1
  export * from "./factories/mimeTypeProcessorFactory";
2
- export * from "./factories/routeProcessorFactory";
2
+ export * from "./factories/restRouteProcessorFactory";
3
+ export * from "./factories/socketRouteProcessorFactory";
3
4
  export * from "./helpers/httpErrorHelper";
4
5
  export * from "./helpers/httpParameterHelper";
5
6
  export * from "./models/api/IServerHealthResponse";
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/api-models - Changelog
2
2
 
3
- ## v0.0.1-next.18
3
+ ## v0.0.1-next.19
4
4
 
5
5
  - Initial Release
@@ -60,5 +60,6 @@
60
60
  ## Variables
61
61
 
62
62
  - [MimeTypeProcessorFactory](variables/MimeTypeProcessorFactory.md)
63
- - [RouteProcessorFactory](variables/RouteProcessorFactory.md)
63
+ - [RestRouteProcessorFactory](variables/RestRouteProcessorFactory.md)
64
+ - [SocketRouteProcessorFactory](variables/SocketRouteProcessorFactory.md)
64
65
  - [HealthStatus](variables/HealthStatus.md)
@@ -0,0 +1,5 @@
1
+ # Variable: RestRouteProcessorFactory
2
+
3
+ > `const` **RestRouteProcessorFactory**: `Factory`\<[`IRestRouteProcessor`](../interfaces/IRestRouteProcessor.md)\>
4
+
5
+ Factory for creating implementation of REST route processor types.
@@ -0,0 +1,5 @@
1
+ # Variable: SocketRouteProcessorFactory
2
+
3
+ > `const` **SocketRouteProcessorFactory**: `Factory`\<[`ISocketRouteProcessor`](../interfaces/ISocketRouteProcessor.md)\>
4
+
5
+ Factory for creating implementation of socket route processor types.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-models",
3
- "version": "0.0.1-next.18",
3
+ "version": "0.0.1-next.19",
4
4
  "description": "Contains models and classes for use with APIs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -1,6 +0,0 @@
1
- import { Factory } from "@twin.org/core";
2
- import type { IBaseRouteProcessor } from "../models/server/IBaseRouteProcessor";
3
- /**
4
- * Factory for creating implementation of route processor types.
5
- */
6
- export declare const RouteProcessorFactory: Factory<IBaseRouteProcessor<import("..").IBaseRoute>>;
@@ -1,5 +0,0 @@
1
- # Variable: RouteProcessorFactory
2
-
3
- > `const` **RouteProcessorFactory**: `Factory`\<[`IBaseRouteProcessor`](../interfaces/IBaseRouteProcessor.md)\<[`IBaseRoute`](../interfaces/IBaseRoute.md)\>\>
4
-
5
- Factory for creating implementation of route processor types.