@twin.org/api-auth-entity-storage-service 0.0.1-next.31 → 0.0.1-next.33

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 (7) hide show
  1. package/docs/changelog.md +32 -0
  2. package/docs/reference/classes/AuthHeaderProcessor.md +4 -4
  3. package/docs/reference/classes/AuthenticationUser.md +3 -3
  4. package/docs/reference/classes/EntityStorageAuthenticationService.md +6 -6
  5. package/docs/reference/classes/PasswordHelper.md +3 -3
  6. package/docs/reference/classes/TokenHelper.md +4 -4
  7. package/package.json +4 -4
package/docs/changelog.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # @twin.org/api-auth-entity-storage-service - Changelog
2
2
 
3
+ ## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.32...api-auth-entity-storage-service-v0.0.1-next.33) (2025-04-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
16
+ * @twin.org/api-core bumped from 0.0.1-next.32 to 0.0.1-next.33
17
+ * @twin.org/api-models bumped from 0.0.1-next.32 to 0.0.1-next.33
18
+
19
+ ## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-service-v0.0.1-next.31...api-auth-entity-storage-service-v0.0.1-next.32) (2025-03-28)
20
+
21
+
22
+ ### Miscellaneous Chores
23
+
24
+ * **api-auth-entity-storage-service:** Synchronize repo versions
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/api-auth-entity-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
32
+ * @twin.org/api-core bumped from 0.0.1-next.31 to 0.0.1-next.32
33
+ * @twin.org/api-models bumped from 0.0.1-next.31 to 0.0.1-next.32
34
+
3
35
  ## v0.0.1-next.31
4
36
 
5
37
  - Initial Release
package/docs/reference/classes/AuthHeaderProcessor.md CHANGED
@@ -8,9 +8,9 @@ Handle a JWT token in the authorization header or cookies and validate it to pop
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new AuthHeaderProcessor()
11
+ ### Constructor
12
12
 
13
- > **new AuthHeaderProcessor**(`options`?): [`AuthHeaderProcessor`](AuthHeaderProcessor.md)
13
+ > **new AuthHeaderProcessor**(`options?`): `AuthHeaderProcessor`
14
14
 
15
15
  Create a new instance of AuthCookiePreProcessor.
16
16
 
@@ -24,7 +24,7 @@ Options for the processor.
24
24
 
25
25
  #### Returns
26
26
 
27
- [`AuthHeaderProcessor`](AuthHeaderProcessor.md)
27
+ `AuthHeaderProcessor`
28
28
 
29
29
  ## Properties
30
30
 
@@ -50,7 +50,7 @@ Runtime name for the class.
50
50
 
51
51
  ### start()
52
52
 
53
- > **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
53
+ > **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
54
54
 
55
55
  The service needs to be started when the application is initialized.
56
56
 
package/docs/reference/classes/AuthenticationUser.md CHANGED
@@ -4,13 +4,13 @@ Class defining the storage for user login credentials.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new AuthenticationUser()
7
+ ### Constructor
8
8
 
9
- > **new AuthenticationUser**(): [`AuthenticationUser`](AuthenticationUser.md)
9
+ > **new AuthenticationUser**(): `AuthenticationUser`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`AuthenticationUser`](AuthenticationUser.md)
13
+ `AuthenticationUser`
14
14
 
15
15
  ## Properties
16
16
 
package/docs/reference/classes/EntityStorageAuthenticationService.md CHANGED
@@ -8,9 +8,9 @@ Implementation of the authentication component using entity storage.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new EntityStorageAuthenticationService()
11
+ ### Constructor
12
12
 
13
- > **new EntityStorageAuthenticationService**(`options`?): [`EntityStorageAuthenticationService`](EntityStorageAuthenticationService.md)
13
+ > **new EntityStorageAuthenticationService**(`options?`): `EntityStorageAuthenticationService`
14
14
 
15
15
  Create a new instance of EntityStorageAuthentication.
16
16
 
@@ -24,7 +24,7 @@ The dependencies for the identity connector.
24
24
 
25
25
  #### Returns
26
26
 
27
- [`EntityStorageAuthenticationService`](EntityStorageAuthenticationService.md)
27
+ `EntityStorageAuthenticationService`
28
28
 
29
29
  ## Properties
30
30
 
@@ -50,7 +50,7 @@ Runtime name for the class.
50
50
 
51
51
  ### start()
52
52
 
53
- > **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\>
53
+ > **start**(`nodeIdentity`, `nodeLoggingConnectorType?`): `Promise`\<`void`\>
54
54
 
55
55
  The service needs to be started when the application is initialized.
56
56
 
@@ -114,7 +114,7 @@ The authentication token for the user, if it uses a mechanism with public access
114
114
 
115
115
  ### logout()
116
116
 
117
- > **logout**(`token`?): `Promise`\<`void`\>
117
+ > **logout**(`token?`): `Promise`\<`void`\>
118
118
 
119
119
  Logout the current user.
120
120
 
@@ -140,7 +140,7 @@ Nothing.
140
140
 
141
141
  ### refresh()
142
142
 
143
- > **refresh**(`token`?): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
143
+ > **refresh**(`token?`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
144
144
 
145
145
  Refresh the token.
146
146
 
package/docs/reference/classes/PasswordHelper.md CHANGED
@@ -4,13 +4,13 @@ Helper class for password operations.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new PasswordHelper()
7
+ ### Constructor
8
8
 
9
- > **new PasswordHelper**(): [`PasswordHelper`](PasswordHelper.md)
9
+ > **new PasswordHelper**(): `PasswordHelper`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`PasswordHelper`](PasswordHelper.md)
13
+ `PasswordHelper`
14
14
 
15
15
  ## Methods
16
16
 
package/docs/reference/classes/TokenHelper.md CHANGED
@@ -4,13 +4,13 @@ Helper class for token operations.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new TokenHelper()
7
+ ### Constructor
8
8
 
9
- > **new TokenHelper**(): [`TokenHelper`](TokenHelper.md)
9
+ > **new TokenHelper**(): `TokenHelper`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`TokenHelper`](TokenHelper.md)
13
+ `TokenHelper`
14
14
 
15
15
  ## Methods
16
16
 
@@ -94,7 +94,7 @@ UnauthorizedError if the token is missing, invalid or expired.
94
94
 
95
95
  ### extractTokenFromHeaders()
96
96
 
97
- > `static` **extractTokenFromHeaders**(`headers`?, `cookieName`?): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
97
+ > `static` **extractTokenFromHeaders**(`headers?`, `cookieName?`): `undefined` \| \{ `token`: `string`; `location`: `"authorization"` \| `"cookie"`; \}
98
98
 
99
99
  Extract the auth token from the headers, either from the authorization header or the cookie header.
100
100
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-auth-entity-storage-service",
3
- "version": "0.0.1-next.31",
3
+ "version": "0.0.1-next.33",
4
4
  "description": "Auth Entity Storage contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,9 +14,9 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-auth-entity-storage-models": "0.0.1-next.31",
18
- "@twin.org/api-core": "0.0.1-next.31",
19
- "@twin.org/api-models": "0.0.1-next.31",
17
+ "@twin.org/api-auth-entity-storage-models": "0.0.1-next.33",
18
+ "@twin.org/api-core": "0.0.1-next.33",
19
+ "@twin.org/api-models": "0.0.1-next.33",
20
20
  "@twin.org/core": "next",
21
21
  "@twin.org/crypto": "next",
22
22
  "@twin.org/entity": "next",