@23blocks/block-authentication 6.3.5 → 6.4.0
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/index.esm.js +120 -120
- package/dist/src/lib/services/api-keys.service.d.ts +11 -8
- package/dist/src/lib/services/api-keys.service.d.ts.map +1 -1
- package/dist/src/lib/services/apps.service.d.ts +12 -12
- package/dist/src/lib/services/apps.service.d.ts.map +1 -1
- package/dist/src/lib/services/auth.service.d.ts +70 -20
- package/dist/src/lib/services/auth.service.d.ts.map +1 -1
- package/dist/src/lib/services/avatars.service.d.ts +23 -9
- package/dist/src/lib/services/avatars.service.d.ts.map +1 -1
- package/dist/src/lib/services/geography.service.d.ts +14 -14
- package/dist/src/lib/services/geography.service.d.ts.map +1 -1
- package/dist/src/lib/services/guests.service.d.ts +17 -17
- package/dist/src/lib/services/guests.service.d.ts.map +1 -1
- package/dist/src/lib/services/jwks.service.d.ts +1 -1
- package/dist/src/lib/services/mfa.service.d.ts +19 -6
- package/dist/src/lib/services/mfa.service.d.ts.map +1 -1
- package/dist/src/lib/services/oauth.service.d.ts +30 -11
- package/dist/src/lib/services/oauth.service.d.ts.map +1 -1
- package/dist/src/lib/services/oidc.service.d.ts +1 -1
- package/dist/src/lib/services/permissions.service.d.ts +4 -4
- package/dist/src/lib/services/permissions.service.d.ts.map +1 -1
- package/dist/src/lib/services/roles.service.d.ts +9 -9
- package/dist/src/lib/services/roles.service.d.ts.map +1 -1
- package/dist/src/lib/services/subscriptions.service.d.ts +10 -10
- package/dist/src/lib/services/subscriptions.service.d.ts.map +1 -1
- package/dist/src/lib/services/tenants.service.d.ts +1 -1
- package/dist/src/lib/services/users.service.d.ts +111 -44
- package/dist/src/lib/services/users.service.d.ts.map +1 -1
- package/dist/src/lib/types/auth.d.ts +22 -3
- package/dist/src/lib/types/auth.d.ts.map +1 -1
- package/dist/src/lib/types/user.d.ts +27 -2
- package/dist/src/lib/types/user.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
import type { IdentityCore, EntityStatus } from '@23blocks/contracts';
|
|
2
2
|
/**
|
|
3
|
-
* User entity
|
|
3
|
+
* User entity - the central identity object in 23blocks.
|
|
4
|
+
*
|
|
5
|
+
* Relationships (`role`, `avatar`, `profile`) are only populated when explicitly
|
|
6
|
+
* included via the `include` parameter or when using endpoints that include them
|
|
7
|
+
* by default (e.g., `auth.getCurrentUser()`, `users.get()`).
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* // Get user with relationships
|
|
11
|
+
* const user = await auth.auth.getCurrentUser();
|
|
12
|
+
* console.log(user.email); // Always present
|
|
13
|
+
* console.log(user.role?.name); // Only if included
|
|
14
|
+
* console.log(user.avatar?.url); // Only if included
|
|
15
|
+
* console.log(user.profile?.firstName); // Only if included
|
|
16
|
+
* console.log(user.profile?.payload); // Custom JSON object
|
|
4
17
|
*/
|
|
5
18
|
export interface User extends IdentityCore {
|
|
6
19
|
email: string;
|
|
@@ -8,8 +21,11 @@ export interface User extends IdentityCore {
|
|
|
8
21
|
name: string | null;
|
|
9
22
|
nickname: string | null;
|
|
10
23
|
bio: string | null;
|
|
24
|
+
/** Authentication provider (e.g., 'email', 'google', 'facebook') */
|
|
11
25
|
provider: string;
|
|
26
|
+
/** Provider-specific user identifier */
|
|
12
27
|
uid: string;
|
|
28
|
+
/** Role ID (use `role?.name` for the role name when relationship is included) */
|
|
13
29
|
roleId: string | null;
|
|
14
30
|
status: EntityStatus;
|
|
15
31
|
mailStatus: string | null;
|
|
@@ -21,8 +37,11 @@ export interface User extends IdentityCore {
|
|
|
21
37
|
invitationSentAt: Date | null;
|
|
22
38
|
invitationAcceptedAt: Date | null;
|
|
23
39
|
invitationCreatedAt: Date | null;
|
|
40
|
+
/** User's role. Only populated when included (e.g., `include: ['role']`). */
|
|
24
41
|
role?: Role | null;
|
|
42
|
+
/** User's avatar. Only populated when included (e.g., `include: ['user_avatar']`). */
|
|
25
43
|
avatar?: UserAvatar | null;
|
|
44
|
+
/** User's profile. Only populated when included (e.g., `include: ['user_profile']`). */
|
|
26
45
|
profile?: UserProfile | null;
|
|
27
46
|
}
|
|
28
47
|
/**
|
|
@@ -69,7 +88,13 @@ export interface UserAvatar extends IdentityCore {
|
|
|
69
88
|
isPublic: boolean;
|
|
70
89
|
}
|
|
71
90
|
/**
|
|
72
|
-
* User profile
|
|
91
|
+
* User profile - extended demographic and contact information.
|
|
92
|
+
*
|
|
93
|
+
* Accessible via `user.profile` when the relationship is included, or directly
|
|
94
|
+
* via `users.getProfile(userUniqueId)`.
|
|
95
|
+
*
|
|
96
|
+
* @note The `payload` field is a JSON object for storing custom data.
|
|
97
|
+
* When writing, pass an object (not a JSON string).
|
|
73
98
|
*/
|
|
74
99
|
export interface UserProfile extends IdentityCore {
|
|
75
100
|
userUniqueId: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/user.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEtE
|
|
1
|
+
{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../src/lib/types/user.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,IAAK,SAAQ,YAAY;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,iFAAiF;IACjF,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,EAAE,IAAI,GAAG,IAAI,CAAC;IAC9B,oBAAoB,EAAE,IAAI,GAAG,IAAI,CAAC;IAClC,mBAAmB,EAAE,IAAI,GAAG,IAAI,CAAC;IAEjC,6EAA6E;IAC7E,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,sFAAsF;IACtF,MAAM,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC3B,wFAAwF;IACxF,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,IAAK,SAAQ,YAAY;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAGlD,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAI3E"}
|
package/package.json
CHANGED