@twin.org/api-models 0.0.2-next.11 → 0.0.2-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/docs/changelog.md +14 -0
- package/docs/reference/interfaces/IAuthenticationGenerator.md +8 -0
- package/docs/reference/interfaces/IBaseRouteProcessor.md +8 -0
- package/docs/reference/interfaces/IInformationComponent.md +8 -0
- package/docs/reference/interfaces/IMimeTypeProcessor.md +8 -0
- package/docs/reference/interfaces/IRestRouteProcessor.md +8 -0
- package/docs/reference/interfaces/ISocketRouteProcessor.md +8 -0
- package/locales/en.json +1 -9
- package/package.json +18 -2
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/api-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.12...api-models-v0.0.2-next.13) (2025-10-09)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **api-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.11...api-models-v0.0.2-next.12) (2025-10-09)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
|
|
16
|
+
|
|
3
17
|
## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-models-v0.0.2-next.10...api-models-v0.0.2-next.11) (2025-09-29)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -6,6 +6,14 @@ Definition for the authentication generator component.
|
|
|
6
6
|
|
|
7
7
|
- `IComponent`
|
|
8
8
|
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
\[`key`: `string`\]: `any`
|
|
12
|
+
|
|
13
|
+
All methods are optional, so we introduce an index signature to allow
|
|
14
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
15
|
+
the class has no properties in common with the type.
|
|
16
|
+
|
|
9
17
|
## Methods
|
|
10
18
|
|
|
11
19
|
### addAuthentication()
|
|
@@ -21,6 +21,14 @@ The definition for a base processor for handling REST routes.
|
|
|
21
21
|
|
|
22
22
|
`R` = [`IHttpServerRequest`](IHttpServerRequest.md)
|
|
23
23
|
|
|
24
|
+
## Indexable
|
|
25
|
+
|
|
26
|
+
\[`key`: `string`\]: `any`
|
|
27
|
+
|
|
28
|
+
All methods are optional, so we introduce an index signature to allow
|
|
29
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
30
|
+
the class has no properties in common with the type.
|
|
31
|
+
|
|
24
32
|
## Methods
|
|
25
33
|
|
|
26
34
|
### features()?
|
|
@@ -6,6 +6,14 @@ The information component for the server.
|
|
|
6
6
|
|
|
7
7
|
- `IComponent`
|
|
8
8
|
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
\[`key`: `string`\]: `any`
|
|
12
|
+
|
|
13
|
+
All methods are optional, so we introduce an index signature to allow
|
|
14
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
15
|
+
the class has no properties in common with the type.
|
|
16
|
+
|
|
9
17
|
## Methods
|
|
10
18
|
|
|
11
19
|
### root()
|
|
@@ -6,6 +6,14 @@ The definition for a handler for a specific MIME type.
|
|
|
6
6
|
|
|
7
7
|
- `IComponent`
|
|
8
8
|
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
\[`key`: `string`\]: `any`
|
|
12
|
+
|
|
13
|
+
All methods are optional, so we introduce an index signature to allow
|
|
14
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
15
|
+
the class has no properties in common with the type.
|
|
16
|
+
|
|
9
17
|
## Methods
|
|
10
18
|
|
|
11
19
|
### getTypes()
|
|
@@ -6,6 +6,14 @@ The definition for a processor for handling REST routes.
|
|
|
6
6
|
|
|
7
7
|
- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`IRestRoute`](IRestRoute.md)\>
|
|
8
8
|
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
\[`key`: `string`\]: `any`
|
|
12
|
+
|
|
13
|
+
All methods are optional, so we introduce an index signature to allow
|
|
14
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
15
|
+
the class has no properties in common with the type.
|
|
16
|
+
|
|
9
17
|
## Methods
|
|
10
18
|
|
|
11
19
|
### features()?
|
|
@@ -6,6 +6,14 @@ The definition for a processor for handling socket routes.
|
|
|
6
6
|
|
|
7
7
|
- [`IBaseRouteProcessor`](IBaseRouteProcessor.md)\<[`ISocketRoute`](ISocketRoute.md), [`ISocketServerRequest`](ISocketServerRequest.md)\>
|
|
8
8
|
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
\[`key`: `string`\]: `any`
|
|
12
|
+
|
|
13
|
+
All methods are optional, so we introduce an index signature to allow
|
|
14
|
+
any additional properties or methods, which removes the TypeScript error where
|
|
15
|
+
the class has no properties in common with the type.
|
|
16
|
+
|
|
9
17
|
## Methods
|
|
10
18
|
|
|
11
19
|
### features()?
|
package/locales/en.json
CHANGED
|
@@ -1,9 +1 @@
|
|
|
1
|
-
{
|
|
2
|
-
"error": {
|
|
3
|
-
"baseRestClient": {
|
|
4
|
-
"missingRouteProp": "Missing route parameter in data \"{routeProp}\" for route \"{route}\"",
|
|
5
|
-
"decodingFailed": "Decoding JSON failed for route \"{route}\"",
|
|
6
|
-
"failureStatusText": "The request to the API failed: \"{statusText}\""
|
|
7
|
-
}
|
|
8
|
-
}
|
|
9
|
-
}
|
|
1
|
+
{}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/api-models",
|
|
3
|
-
"version": "0.0.2-next.
|
|
3
|
+
"version": "0.0.2-next.13",
|
|
4
4
|
"description": "Contains models and classes for use with APIs",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -34,5 +34,21 @@
|
|
|
34
34
|
"dist/types",
|
|
35
35
|
"locales",
|
|
36
36
|
"docs"
|
|
37
|
-
]
|
|
37
|
+
],
|
|
38
|
+
"keywords": [
|
|
39
|
+
"twin",
|
|
40
|
+
"trade",
|
|
41
|
+
"iota",
|
|
42
|
+
"framework",
|
|
43
|
+
"blockchain",
|
|
44
|
+
"api",
|
|
45
|
+
"models",
|
|
46
|
+
"types",
|
|
47
|
+
"interfaces",
|
|
48
|
+
"schemas"
|
|
49
|
+
],
|
|
50
|
+
"bugs": {
|
|
51
|
+
"url": "git+https://github.com/twinfoundation/api/issues"
|
|
52
|
+
},
|
|
53
|
+
"homepage": "https://twindev.org"
|
|
38
54
|
}
|