@twin.org/api-auth-entity-storage-service 0.0.3-next.43 → 0.0.3-next.45

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 (36) hide show
  1. package/dist/es/models/IAuthHeaderProcessorConstructorOptions.js.map +1 -1
  2. package/dist/es/models/IEntityStorageAuthenticationServiceConstructorOptions.js.map +1 -1
  3. package/dist/es/processors/authHeaderProcessor.js +35 -26
  4. package/dist/es/processors/authHeaderProcessor.js.map +1 -1
  5. package/dist/es/restEntryPoints.js +3 -0
  6. package/dist/es/restEntryPoints.js.map +1 -1
  7. package/dist/es/services/entityStorageAuthenticationAdminService.js +4 -4
  8. package/dist/es/services/entityStorageAuthenticationAdminService.js.map +1 -1
  9. package/dist/es/services/entityStorageAuthenticationRateService.js +6 -6
  10. package/dist/es/services/entityStorageAuthenticationRateService.js.map +1 -1
  11. package/dist/es/services/entityStorageAuthenticationService.js +27 -33
  12. package/dist/es/services/entityStorageAuthenticationService.js.map +1 -1
  13. package/dist/es/utils/passwordHelper.js +1 -1
  14. package/dist/es/utils/passwordHelper.js.map +1 -1
  15. package/dist/es/utils/tokenHelper.js +7 -8
  16. package/dist/es/utils/tokenHelper.js.map +1 -1
  17. package/dist/types/models/IAuthHeaderProcessorConstructorOptions.d.ts +0 -4
  18. package/dist/types/models/IEntityStorageAuthenticationServiceConstructorOptions.d.ts +0 -4
  19. package/dist/types/processors/authHeaderProcessor.d.ts +3 -1
  20. package/dist/types/restEntryPoints.d.ts +3 -0
  21. package/dist/types/services/entityStorageAuthenticationAdminService.d.ts +4 -4
  22. package/dist/types/services/entityStorageAuthenticationRateService.d.ts +5 -5
  23. package/dist/types/services/entityStorageAuthenticationService.d.ts +4 -4
  24. package/dist/types/utils/passwordHelper.d.ts +1 -1
  25. package/dist/types/utils/tokenHelper.d.ts +2 -4
  26. package/docs/changelog.md +32 -0
  27. package/docs/reference/classes/AuthHeaderProcessor.md +5 -1
  28. package/docs/reference/classes/EntityStorageAuthenticationAdminService.md +4 -4
  29. package/docs/reference/classes/EntityStorageAuthenticationRateService.md +5 -5
  30. package/docs/reference/classes/EntityStorageAuthenticationService.md +4 -4
  31. package/docs/reference/classes/PasswordHelper.md +1 -1
  32. package/docs/reference/classes/TokenHelper.md +2 -8
  33. package/docs/reference/interfaces/IAuthHeaderProcessorConstructorOptions.md +0 -8
  34. package/docs/reference/interfaces/IEntityStorageAuthenticationServiceConstructorOptions.md +0 -8
  35. package/docs/reference/variables/restEntryPoints.md +2 -0
  36. package/package.json +4 -4
package/docs/changelog.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.0.3-next.45](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.0.3-next.44...api-auth-entity-storage-service-v0.0.3-next.45) (2026-06-15)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **api-auth-entity-storage-service:** Synchronize repo versions
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.3-next.44 to 0.0.3-next.45
16
+ * @twin.org/api-core bumped from 0.0.3-next.44 to 0.0.3-next.45
17
+ * @twin.org/api-models bumped from 0.0.3-next.44 to 0.0.3-next.45
18
+
19
+ ## [0.0.3-next.44](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.0.3-next.43...api-auth-entity-storage-service-v0.0.3-next.44) (2026-06-11)
20
+
21
+
22
+ ### Features
23
+
24
+ * organization identifiers ([#158](https://github.com/iotaledger/twin-api/issues/158)) ([ce13244](https://github.com/iotaledger/twin-api/commit/ce13244aaacbf82d9e5f87d905e283b36ad63bbf))
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.3-next.43 to 0.0.3-next.44
32
+ * @twin.org/api-core bumped from 0.0.3-next.43 to 0.0.3-next.44
33
+ * @twin.org/api-models bumped from 0.0.3-next.43 to 0.0.3-next.44
34
+
3
35
  ## [0.0.3-next.43](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-service-v0.0.3-next.42...api-auth-entity-storage-service-v0.0.3-next.43) (2026-06-10)
4
36
 
5
37
 
@@ -72,7 +72,7 @@ The node logging component type.
72
72
 
73
73
  `Promise`\<`void`\>
74
74
 
75
- Nothing.
75
+ A promise that resolves when the node identity and organization ID have been cached.
76
76
 
77
77
  #### Implementation of
78
78
 
@@ -120,6 +120,8 @@ The state handed through the processors.
120
120
 
121
121
  `Promise`\<`void`\>
122
122
 
123
+ A promise that resolves when the JWT has been verified and the context populated, or an error response set.
124
+
123
125
  #### Implementation of
124
126
 
125
127
  `IBaseRouteProcessor.pre`
@@ -166,6 +168,8 @@ The state handed through the processors.
166
168
 
167
169
  `Promise`\<`void`\>
168
170
 
171
+ A promise that resolves when the Set-Cookie header has been applied to the response if required.
172
+
169
173
  #### Implementation of
170
174
 
171
175
  `IBaseRouteProcessor.post`
@@ -72,7 +72,7 @@ The user to create.
72
72
 
73
73
  `Promise`\<`void`\>
74
74
 
75
- Nothing.
75
+ A promise that resolves when the user account has been created and the audit entry recorded.
76
76
 
77
77
  #### Implementation of
78
78
 
@@ -98,7 +98,7 @@ The user to update.
98
98
 
99
99
  `Promise`\<`void`\>
100
100
 
101
- Nothing.
101
+ A promise that resolves when the user account has been updated and the audit entry recorded.
102
102
 
103
103
  #### Implementation of
104
104
 
@@ -176,7 +176,7 @@ The email address of the user to remove.
176
176
 
177
177
  `Promise`\<`void`\>
178
178
 
179
- Nothing.
179
+ A promise that resolves when the user account has been removed and the audit entry recorded.
180
180
 
181
181
  #### Implementation of
182
182
 
@@ -214,7 +214,7 @@ The current password, optional, if supplied will check against existing.
214
214
 
215
215
  `Promise`\<`void`\>
216
216
 
217
- Nothing.
217
+ A promise that resolves when the password has been updated.
218
218
 
219
219
  #### Implementation of
220
220
 
@@ -60,7 +60,7 @@ The action configuration.
60
60
 
61
61
  `Promise`\<`void`\>
62
62
 
63
- Nothing.
63
+ A promise that resolves when the action configuration has been stored.
64
64
 
65
65
  #### Implementation of
66
66
 
@@ -86,7 +86,7 @@ The action name.
86
86
 
87
87
  `Promise`\<`void`\>
88
88
 
89
- Nothing.
89
+ A promise that resolves when the action configuration has been removed.
90
90
 
91
91
  #### Implementation of
92
92
 
@@ -130,7 +130,7 @@ The node logging component type.
130
130
 
131
131
  `Promise`\<`void`\>
132
132
 
133
- Nothing.
133
+ A promise that resolves when the periodic cleanup task has been registered.
134
134
 
135
135
  #### Implementation of
136
136
 
@@ -156,7 +156,7 @@ The node logging component type.
156
156
 
157
157
  `Promise`\<`void`\>
158
158
 
159
- Nothing.
159
+ A promise that resolves when the periodic cleanup task has been removed.
160
160
 
161
161
  #### Implementation of
162
162
 
@@ -220,7 +220,7 @@ The identifier to clear.
220
220
 
221
221
  `Promise`\<`void`\>
222
222
 
223
- Nothing.
223
+ A promise that resolves when the rate entry has been removed.
224
224
 
225
225
  #### Implementation of
226
226
 
@@ -72,7 +72,7 @@ The node logging component type.
72
72
 
73
73
  `Promise`\<`void`\>
74
74
 
75
- Nothing.
75
+ A promise that resolves when rate-limit actions have been registered and the node identity cached.
76
76
 
77
77
  #### Implementation of
78
78
 
@@ -98,7 +98,7 @@ The node logging component type.
98
98
 
99
99
  `Promise`\<`void`\>
100
100
 
101
- Nothing.
101
+ A promise that resolves when all rate-limit actions have been unregistered.
102
102
 
103
103
  #### Implementation of
104
104
 
@@ -156,7 +156,7 @@ The token to logout, if it uses a mechanism with public access.
156
156
 
157
157
  `Promise`\<`void`\>
158
158
 
159
- Nothing.
159
+ A promise that resolves when the logout audit entry has been recorded.
160
160
 
161
161
  #### Implementation of
162
162
 
@@ -214,7 +214,7 @@ The new password for the user.
214
214
 
215
215
  `Promise`\<`void`\>
216
216
 
217
- Nothing.
217
+ A promise that resolves when the password has been updated and the rate limit cleared.
218
218
 
219
219
  #### Implementation of
220
220
 
@@ -71,4 +71,4 @@ Optional minimum password length for validation.
71
71
 
72
72
  `Promise`\<`void`\>
73
73
 
74
- Nothing.
74
+ A promise that resolves when the new password has been stored and the audit entry recorded.
@@ -24,7 +24,7 @@ Runtime name for the class.
24
24
 
25
25
  ### createToken() {#createtoken}
26
26
 
27
- > `static` **createToken**(`vaultConnector`, `urlTransformerComponent`, `signingKeyName`, `userIdentity`, `organizationIdentity`, `tenantId`, `ttlMinutes`, `scope?`, `passwordVersion?`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
27
+ > `static` **createToken**(`vaultConnector`, `signingKeyName`, `userIdentity`, `organizationIdentity`, `tenantId`, `ttlMinutes`, `scope?`, `passwordVersion?`): `Promise`\<\{ `token`: `string`; `expiry`: `number`; \}\>
28
28
 
29
29
  Create a new token.
30
30
 
@@ -36,12 +36,6 @@ Create a new token.
36
36
 
37
37
  The vault connector.
38
38
 
39
- ##### urlTransformerComponent
40
-
41
- `IUrlTransformerComponent`
42
-
43
- The URL transformer component, used to encrypt the tenant ID for inclusion in the token.
44
-
45
39
  ##### signingKeyName
46
40
 
47
41
  `string`
@@ -126,7 +120,7 @@ The required scopes.
126
120
 
127
121
  ##### verifyUser?
128
122
 
129
- (`userIdentity`, `organizationIdentity`, `encryptedTenantId`, `passwordVersion`) => `Promise`\<`string`[]\>
123
+ (`sub`, `org`, `tid`, `passwordVersion`) => `Promise`\<`string`[]\>
130
124
 
131
125
  A function to verify the user identity and organization. The password version counter embedded in the token (pver claim) is passed so callers can detect if the password has changed since the token was issued.
132
126
 
@@ -32,14 +32,6 @@ vault
32
32
 
33
33
  ***
34
34
 
35
- ### urlTransformerComponentType? {#urltransformercomponenttype}
36
-
37
- > `optional` **urlTransformerComponentType?**: `string`
38
-
39
- The URL transformer component for the tenants.
40
-
41
- ***
42
-
43
35
  ### tenantAdminComponentType? {#tenantadmincomponenttype}
44
36
 
45
37
  > `optional` **tenantAdminComponentType?**: `string`
@@ -32,14 +32,6 @@ vault
32
32
 
33
33
  ***
34
34
 
35
- ### urlTransformerComponentType? {#urltransformercomponenttype}
36
-
37
- > `optional` **urlTransformerComponentType?**: `string`
38
-
39
- The URL transformer component for the tenants.
40
-
41
- ***
42
-
43
35
  ### authenticationAuditServiceType? {#authenticationauditservicetype}
44
36
 
45
37
  > `optional` **authenticationAuditServiceType?**: `string`
@@ -1,3 +1,5 @@
1
1
  # Variable: restEntryPoints
2
2
 
3
3
  > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
4
+
5
+ REST entry points for the authentication, authentication admin, and authentication audit services.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/api-auth-entity-storage-service",
3
- "version": "0.0.3-next.43",
3
+ "version": "0.0.3-next.45",
4
4
  "description": "Authentication service implementation and REST routes backed by entity storage.",
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.3-next.43",
18
- "@twin.org/api-core": "0.0.3-next.43",
19
- "@twin.org/api-models": "0.0.3-next.43",
17
+ "@twin.org/api-auth-entity-storage-models": "0.0.3-next.45",
18
+ "@twin.org/api-core": "0.0.3-next.45",
19
+ "@twin.org/api-models": "0.0.3-next.45",
20
20
  "@twin.org/background-task-models": "next",
21
21
  "@twin.org/context": "next",
22
22
  "@twin.org/core": "next",