@nest-boot/auth 8.0.2 → 9.0.0-beta.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.
Files changed (231) hide show
  1. package/README.md +48 -0
  2. package/dist/abilities/index.d.ts +2 -0
  3. package/dist/abilities/index.js +3 -0
  4. package/dist/abilities/index.js.map +1 -0
  5. package/dist/abilities/user.ability.d.ts +5 -0
  6. package/dist/abilities/user.ability.js +11 -0
  7. package/dist/abilities/user.ability.js.map +1 -0
  8. package/dist/abilities/workspace.ability.d.ts +5 -0
  9. package/dist/abilities/workspace.ability.js +11 -0
  10. package/dist/abilities/workspace.ability.js.map +1 -0
  11. package/dist/access-control.service.d.ts +18 -0
  12. package/dist/access-control.service.js +153 -0
  13. package/dist/access-control.service.js.map +1 -0
  14. package/dist/adapters/mikro-orm/adapter-config.d.ts +13 -0
  15. package/dist/adapters/mikro-orm/adapter-config.js +15 -0
  16. package/dist/adapters/mikro-orm/adapter-config.js.map +1 -0
  17. package/dist/adapters/mikro-orm/create-custom-adapter.d.ts +10 -0
  18. package/dist/adapters/mikro-orm/create-custom-adapter.js +106 -0
  19. package/dist/adapters/mikro-orm/create-custom-adapter.js.map +1 -0
  20. package/dist/adapters/mikro-orm/entity-metadata-resolver.d.ts +14 -0
  21. package/dist/adapters/mikro-orm/entity-metadata-resolver.js +68 -0
  22. package/dist/adapters/mikro-orm/entity-metadata-resolver.js.map +1 -0
  23. package/dist/adapters/mikro-orm/where-compiler.d.ts +156 -0
  24. package/dist/adapters/mikro-orm/where-compiler.js +69 -0
  25. package/dist/adapters/mikro-orm/where-compiler.js.map +1 -0
  26. package/dist/adapters/mikro-orm-adapter.d.ts +8 -11
  27. package/dist/adapters/mikro-orm-adapter.js +32 -162
  28. package/dist/adapters/mikro-orm-adapter.js.map +1 -1
  29. package/dist/api-key-usage.interceptor.d.ts +8 -0
  30. package/dist/api-key-usage.interceptor.js +35 -0
  31. package/dist/api-key-usage.interceptor.js.map +1 -0
  32. package/dist/api-key.service.d.ts +75 -0
  33. package/dist/api-key.service.js +336 -0
  34. package/dist/api-key.service.js.map +1 -0
  35. package/dist/auth-handler.middleware.d.ts +7 -0
  36. package/dist/auth-handler.middleware.js +31 -0
  37. package/dist/auth-handler.middleware.js.map +1 -0
  38. package/dist/auth-module-options.interface.d.ts +341 -6
  39. package/dist/auth.guard.d.ts +36 -4
  40. package/dist/auth.guard.js +297 -7
  41. package/dist/auth.guard.js.map +1 -1
  42. package/dist/auth.middleware.d.ts +16 -6
  43. package/dist/auth.middleware.js +97 -42
  44. package/dist/auth.middleware.js.map +1 -1
  45. package/dist/auth.module-definition.d.ts +1 -1
  46. package/dist/auth.module.d.ts +10 -7
  47. package/dist/auth.module.js +157 -44
  48. package/dist/auth.module.js.map +1 -1
  49. package/dist/auth.service.d.ts +24 -1857
  50. package/dist/auth.service.js +174 -4
  51. package/dist/auth.service.js.map +1 -1
  52. package/dist/decorators/can.decorator.d.ts +6 -0
  53. package/dist/decorators/can.decorator.js +8 -0
  54. package/dist/decorators/can.decorator.js.map +1 -0
  55. package/dist/decorators/current-api-key.decorator.d.ts +1 -0
  56. package/dist/decorators/current-api-key.decorator.js +5 -0
  57. package/dist/decorators/current-api-key.decorator.js.map +1 -0
  58. package/dist/decorators/current-workspace-member.decorator.d.ts +1 -0
  59. package/dist/decorators/current-workspace-member.decorator.js +5 -0
  60. package/dist/decorators/current-workspace-member.decorator.js.map +1 -0
  61. package/dist/decorators/current-workspace.decorator.d.ts +1 -0
  62. package/dist/decorators/current-workspace.decorator.js +5 -0
  63. package/dist/decorators/current-workspace.decorator.js.map +1 -0
  64. package/dist/decorators/index.d.ts +6 -0
  65. package/dist/decorators/index.js +6 -0
  66. package/dist/decorators/index.js.map +1 -1
  67. package/dist/decorators/user-can.decorator.d.ts +5 -0
  68. package/dist/decorators/user-can.decorator.js +13 -0
  69. package/dist/decorators/user-can.decorator.js.map +1 -0
  70. package/dist/decorators/workspace-can.decorator.d.ts +5 -0
  71. package/dist/decorators/workspace-can.decorator.js +13 -0
  72. package/dist/decorators/workspace-can.decorator.js.map +1 -0
  73. package/dist/entities/account.entity.d.ts +1 -0
  74. package/dist/entities/account.entity.js +12 -3
  75. package/dist/entities/account.entity.js.map +1 -1
  76. package/dist/entities/api-key.entity.d.ts +17 -0
  77. package/dist/entities/api-key.entity.js +92 -0
  78. package/dist/entities/api-key.entity.js.map +1 -0
  79. package/dist/entities/index.d.ts +4 -0
  80. package/dist/entities/index.js +4 -0
  81. package/dist/entities/index.js.map +1 -1
  82. package/dist/entities/resolve-auth-relation-target.d.ts +3 -0
  83. package/dist/entities/resolve-auth-relation-target.js +30 -0
  84. package/dist/entities/resolve-auth-relation-target.js.map +1 -0
  85. package/dist/entities/session.entity.d.ts +3 -1
  86. package/dist/entities/session.entity.js +15 -2
  87. package/dist/entities/session.entity.js.map +1 -1
  88. package/dist/entities/user.entity.d.ts +5 -0
  89. package/dist/entities/user.entity.js +25 -0
  90. package/dist/entities/user.entity.js.map +1 -1
  91. package/dist/entities/verification.entity.js +2 -1
  92. package/dist/entities/verification.entity.js.map +1 -1
  93. package/dist/entities/workspace-invitation.entity.d.ts +14 -0
  94. package/dist/entities/workspace-invitation.entity.js +74 -0
  95. package/dist/entities/workspace-invitation.entity.js.map +1 -0
  96. package/dist/entities/workspace-member.entity.d.ts +16 -0
  97. package/dist/entities/workspace-member.entity.js +86 -0
  98. package/dist/entities/workspace-member.entity.js.map +1 -0
  99. package/dist/entities/workspace.entity.d.ts +8 -0
  100. package/dist/entities/workspace.entity.js +48 -0
  101. package/dist/entities/workspace.entity.js.map +1 -0
  102. package/dist/index.d.ts +32 -2
  103. package/dist/index.js +32 -2
  104. package/dist/index.js.map +1 -1
  105. package/dist/interfaces/auth-role.interface.d.ts +4 -0
  106. package/dist/interfaces/auth-role.interface.js +2 -0
  107. package/dist/interfaces/auth-role.interface.js.map +1 -0
  108. package/dist/interfaces/auth-service.interface.d.ts +160 -0
  109. package/dist/interfaces/auth-service.interface.js +2 -0
  110. package/dist/interfaces/auth-service.interface.js.map +1 -0
  111. package/dist/interfaces/can-options.interface.d.ts +3 -0
  112. package/dist/interfaces/can-options.interface.js +2 -0
  113. package/dist/interfaces/can-options.interface.js.map +1 -0
  114. package/dist/interfaces/route-argument-metadata-value.interface.d.ts +6 -0
  115. package/dist/interfaces/route-argument-metadata-value.interface.js +2 -0
  116. package/dist/interfaces/route-argument-metadata-value.interface.js.map +1 -0
  117. package/dist/interfaces/serialized-ability-rule.interface.d.ts +9 -0
  118. package/dist/interfaces/serialized-ability-rule.interface.js +2 -0
  119. package/dist/interfaces/serialized-ability-rule.interface.js.map +1 -0
  120. package/dist/interfaces/session-service.interface.d.ts +5 -0
  121. package/dist/interfaces/session-service.interface.js +2 -0
  122. package/dist/interfaces/session-service.interface.js.map +1 -0
  123. package/dist/interfaces/user-can-metadata.interface.d.ts +6 -0
  124. package/dist/interfaces/user-can-metadata.interface.js +2 -0
  125. package/dist/interfaces/user-can-metadata.interface.js.map +1 -0
  126. package/dist/interfaces/user-service.interface.d.ts +44 -0
  127. package/dist/interfaces/user-service.interface.js +2 -0
  128. package/dist/interfaces/user-service.interface.js.map +1 -0
  129. package/dist/interfaces/workspace-can-metadata.interface.d.ts +6 -0
  130. package/dist/interfaces/workspace-can-metadata.interface.js +2 -0
  131. package/dist/interfaces/workspace-can-metadata.interface.js.map +1 -0
  132. package/dist/interfaces/workspace-service.interface.d.ts +37 -0
  133. package/dist/interfaces/workspace-service.interface.js +2 -0
  134. package/dist/interfaces/workspace-service.interface.js.map +1 -0
  135. package/dist/permission.constants.d.ts +25 -0
  136. package/dist/permission.constants.js +26 -0
  137. package/dist/permission.constants.js.map +1 -0
  138. package/dist/session.service.d.ts +18 -0
  139. package/dist/session.service.js +171 -0
  140. package/dist/session.service.js.map +1 -0
  141. package/dist/tsconfig.tsbuildinfo +1 -0
  142. package/dist/types/auth-module-roles.type.d.ts +1 -0
  143. package/dist/types/auth-module-roles.type.js +2 -0
  144. package/dist/types/auth-module-roles.type.js.map +1 -0
  145. package/dist/types/build-user-ability-callback.type.d.ts +4 -0
  146. package/dist/types/build-user-ability-callback.type.js +2 -0
  147. package/dist/types/build-user-ability-callback.type.js.map +1 -0
  148. package/dist/types/build-workspace-ability-callback.type.d.ts +4 -0
  149. package/dist/types/build-workspace-ability-callback.type.js +2 -0
  150. package/dist/types/build-workspace-ability-callback.type.js.map +1 -0
  151. package/dist/types/can-subject-factory.type.d.ts +2 -0
  152. package/dist/types/can-subject-factory.type.js +2 -0
  153. package/dist/types/can-subject-factory.type.js.map +1 -0
  154. package/dist/types/can-subject.type.d.ts +4 -0
  155. package/dist/types/can-subject.type.js +2 -0
  156. package/dist/types/can-subject.type.js.map +1 -0
  157. package/dist/types/route-argument-metadata.type.d.ts +2 -0
  158. package/dist/types/route-argument-metadata.type.js +2 -0
  159. package/dist/types/route-argument-metadata.type.js.map +1 -0
  160. package/dist/user-deletion.service.d.ts +19 -0
  161. package/dist/user-deletion.service.js +103 -0
  162. package/dist/user-deletion.service.js.map +1 -0
  163. package/dist/user.constants.d.ts +7 -0
  164. package/dist/user.constants.js +23 -0
  165. package/dist/user.constants.js.map +1 -0
  166. package/dist/user.service.d.ts +54 -0
  167. package/dist/user.service.js +386 -0
  168. package/dist/user.service.js.map +1 -0
  169. package/dist/utils/append-metadata.util.d.ts +3 -0
  170. package/dist/utils/append-metadata.util.js +12 -0
  171. package/dist/utils/append-metadata.util.js.map +1 -0
  172. package/dist/utils/apply-auth-response-cookies.util.d.ts +1 -0
  173. package/dist/utils/apply-auth-response-cookies.util.js +13 -0
  174. package/dist/utils/apply-auth-response-cookies.util.js.map +1 -0
  175. package/dist/utils/auth-role.util.d.ts +11 -0
  176. package/dist/utils/auth-role.util.js +88 -0
  177. package/dist/utils/auth-role.util.js.map +1 -0
  178. package/dist/utils/can.util.d.ts +3 -0
  179. package/dist/utils/can.util.js +8 -0
  180. package/dist/utils/can.util.js.map +1 -0
  181. package/dist/utils/create-email-and-password-config.d.ts +7 -3
  182. package/dist/utils/create-email-and-password-config.js +22 -1
  183. package/dist/utils/create-email-and-password-config.js.map +1 -1
  184. package/dist/utils/create-email-verification-config.d.ts +7 -0
  185. package/dist/utils/create-email-verification-config.js +14 -0
  186. package/dist/utils/create-email-verification-config.js.map +1 -0
  187. package/dist/utils/create-generic-oauth-config.d.ts +2 -0
  188. package/dist/utils/create-generic-oauth-config.js +15 -0
  189. package/dist/utils/create-generic-oauth-config.js.map +1 -0
  190. package/dist/utils/create-social-provider-config.d.ts +2 -2
  191. package/dist/utils/create-social-provider-config.js +6 -0
  192. package/dist/utils/create-social-provider-config.js.map +1 -1
  193. package/dist/utils/create-social-providers-config.d.ts +2 -2
  194. package/dist/utils/create-social-providers-config.js.map +1 -1
  195. package/dist/utils/create-user-config.d.ts +7 -0
  196. package/dist/utils/create-user-config.js +48 -0
  197. package/dist/utils/create-user-config.js.map +1 -0
  198. package/dist/utils/extract-api-key.util.d.ts +2 -0
  199. package/dist/utils/extract-api-key.util.js +14 -0
  200. package/dist/utils/extract-api-key.util.js.map +1 -0
  201. package/dist/utils/get-user-ability.util.d.ts +2 -0
  202. package/dist/utils/get-user-ability.util.js +11 -0
  203. package/dist/utils/get-user-ability.util.js.map +1 -0
  204. package/dist/utils/get-workspace-ability.util.d.ts +2 -0
  205. package/dist/utils/get-workspace-ability.util.js +11 -0
  206. package/dist/utils/get-workspace-ability.util.js.map +1 -0
  207. package/dist/utils/serialize-ability-rules.util.d.ts +3 -0
  208. package/dist/utils/serialize-ability-rules.util.js +23 -0
  209. package/dist/utils/serialize-ability-rules.util.js.map +1 -0
  210. package/dist/utils/split-auth-providers.d.ts +10 -0
  211. package/dist/utils/split-auth-providers.js +34 -0
  212. package/dist/utils/split-auth-providers.js.map +1 -0
  213. package/dist/utils/user-can.util.d.ts +2 -0
  214. package/dist/utils/user-can.util.js +18 -0
  215. package/dist/utils/user-can.util.js.map +1 -0
  216. package/dist/utils/workspace-can.util.d.ts +2 -0
  217. package/dist/utils/workspace-can.util.js +18 -0
  218. package/dist/utils/workspace-can.util.js.map +1 -0
  219. package/dist/workspace.constants.d.ts +8 -0
  220. package/dist/workspace.constants.js +24 -0
  221. package/dist/workspace.constants.js.map +1 -0
  222. package/dist/workspace.service.d.ts +59 -0
  223. package/dist/workspace.service.js +611 -0
  224. package/dist/workspace.service.js.map +1 -0
  225. package/package.json +26 -14
  226. package/dist/auth.transaction-context.d.ts +0 -10
  227. package/dist/auth.transaction-context.js +0 -22
  228. package/dist/auth.transaction-context.js.map +0 -1
  229. package/dist/utils/assert-no-duplicate-generic-oauth-plugin.d.ts +0 -2
  230. package/dist/utils/assert-no-duplicate-generic-oauth-plugin.js +0 -8
  231. package/dist/utils/assert-no-duplicate-generic-oauth-plugin.js.map +0 -1
@@ -1,15 +1,350 @@
1
- import { Type } from "@nestjs/common";
1
+ import type { EntityClass } from "@mikro-orm/core";
2
+ import type { Type } from "@nestjs/common";
2
3
  import type { RouteInfo } from "@nestjs/common/interfaces/middleware/middleware-configuration.interface.js";
3
- import { BetterAuthOptions } from "better-auth";
4
- import { MikroOrmAdapterConfig } from "./adapters/mikro-orm-adapter.js";
4
+ import type { BaseAccount, BaseApiKey, BaseSession, BaseUser, BaseVerification, BaseWorkspace, BaseWorkspaceInvitation, BaseWorkspaceMember } from "./entities/index.js";
5
+ import type { AuthUser } from "./interfaces/auth-service.interface.js";
6
+ import type { AuthModuleRoles } from "./types/auth-module-roles.type.js";
7
+ import type { BuildUserAbilityCallback } from "./types/build-user-ability-callback.type.js";
8
+ import type { BuildWorkspaceAbilityCallback } from "./types/build-workspace-ability-callback.type.js";
9
+ export type AuthMaybePromise<T> = T | Promise<T>;
10
+ export interface AuthEmailVerificationData {
11
+ user: AuthUser;
12
+ url: string;
13
+ token: string;
14
+ }
15
+ export type AuthSendVerificationEmail = (data: AuthEmailVerificationData, request?: Request) => Promise<void>;
16
+ export interface AuthResetPasswordData {
17
+ user: AuthUser;
18
+ url: string;
19
+ token: string;
20
+ }
21
+ export type AuthSendResetPassword = (data: AuthResetPasswordData, request?: Request) => Promise<void>;
22
+ export type AuthWorkspaceInvitationEmailInviter = Omit<BaseWorkspaceMember, "user"> & {
23
+ user: BaseUser;
24
+ };
25
+ export interface AuthWorkspaceInvitationEmailData {
26
+ id: string;
27
+ roles: string[];
28
+ email: string;
29
+ workspace: BaseWorkspace;
30
+ invitation: BaseWorkspaceInvitation;
31
+ inviter: AuthWorkspaceInvitationEmailInviter;
32
+ }
33
+ export type AuthSendWorkspaceInvitationEmail = (data: AuthWorkspaceInvitationEmailData, request?: Request) => Promise<void>;
34
+ export interface AuthModulePasswordOptions {
35
+ hash?: (password: string) => Promise<string>;
36
+ verify?: (data: {
37
+ hash: string;
38
+ password: string;
39
+ }) => Promise<boolean>;
40
+ }
41
+ export interface AuthModuleEmailAndPasswordOptions {
42
+ enabled?: boolean;
43
+ disableSignUp?: boolean;
44
+ requireEmailVerification?: boolean;
45
+ maxPasswordLength?: number;
46
+ minPasswordLength?: number;
47
+ sendResetPassword?: AuthSendResetPassword;
48
+ resetPasswordTokenExpiresIn?: number;
49
+ onPasswordReset?: (data: {
50
+ user: AuthUser;
51
+ }, request?: Request) => Promise<void>;
52
+ password?: AuthModulePasswordOptions;
53
+ autoSignIn?: boolean;
54
+ revokeSessionsOnPasswordReset?: boolean;
55
+ onExistingUserSignUp?: (data: {
56
+ user: AuthUser;
57
+ }, request?: Request) => Promise<void>;
58
+ }
59
+ export interface AuthModuleEmailVerificationOptions {
60
+ sendVerificationEmail?: AuthSendVerificationEmail;
61
+ sendOnSignUp?: boolean;
62
+ sendOnSignIn?: boolean;
63
+ autoSignInAfterVerification?: boolean;
64
+ expiresIn?: number;
65
+ beforeEmailVerification?: (user: AuthUser, request?: Request) => Promise<void>;
66
+ afterEmailVerification?: (user: AuthUser, request?: Request) => Promise<void>;
67
+ }
68
+ export interface AuthChangeEmailConfirmationData {
69
+ user: AuthUser;
70
+ newEmail: string;
71
+ url: string;
72
+ token: string;
73
+ }
74
+ export interface AuthModuleChangeEmailOptions {
75
+ enabled: boolean;
76
+ sendChangeEmailConfirmation?: (data: AuthChangeEmailConfirmationData, request?: Request) => Promise<void>;
77
+ updateEmailWithoutVerification?: boolean;
78
+ }
79
+ export interface AuthDeleteAccountVerificationData {
80
+ user: AuthUser;
81
+ url: string;
82
+ token: string;
83
+ }
84
+ export interface AuthModuleDeleteUserOptions {
85
+ enabled?: boolean;
86
+ sendDeleteAccountVerification?: (data: AuthDeleteAccountVerificationData, request?: Request) => Promise<void>;
87
+ beforeDelete?: (user: AuthUser, request?: Request) => Promise<void>;
88
+ afterDelete?: (user: AuthUser, request?: Request) => Promise<void>;
89
+ deleteTokenExpiresIn?: number;
90
+ }
91
+ export interface AuthModuleWorkspaceOptions<Permission extends string = string, Workspace extends BaseWorkspace = BaseWorkspace> {
92
+ defaultRole?: string;
93
+ creatorRole?: string;
94
+ permissions?: readonly Permission[];
95
+ roles?: AuthModuleRoles<NoInfer<Permission>>;
96
+ buildAbility?: BuildWorkspaceAbilityCallback<Permission, Workspace>;
97
+ sendInvitationEmail?: AuthSendWorkspaceInvitationEmail;
98
+ }
99
+ export interface AuthModuleUserOptions<Permission extends string = string, User extends BaseUser = BaseUser> {
100
+ defaultRole?: string;
101
+ adminRoles?: readonly string[];
102
+ permissions?: readonly Permission[];
103
+ roles?: AuthModuleRoles<NoInfer<Permission>>;
104
+ buildAbility?: BuildUserAbilityCallback<Permission, User>;
105
+ changeEmail?: AuthModuleChangeEmailOptions;
106
+ deleteUser?: AuthModuleDeleteUserOptions;
107
+ }
108
+ export interface AuthModuleAccountLinkingOptions {
109
+ enabled?: boolean;
110
+ disableImplicitLinking?: boolean;
111
+ requireLocalEmailVerified?: boolean;
112
+ trustedProviders?: string[] | ((request?: Request) => AuthMaybePromise<string[]>);
113
+ allowDifferentEmails?: boolean;
114
+ allowUnlinkingAll?: boolean;
115
+ updateUserInfoOnLink?: boolean;
116
+ }
117
+ export interface AuthModuleAccountOptions {
118
+ updateAccountOnSignIn?: boolean;
119
+ accountLinking?: AuthModuleAccountLinkingOptions;
120
+ encryptOAuthTokens?: boolean;
121
+ skipStateCookieCheck?: boolean;
122
+ storeStateStrategy?: "cookie" | "database";
123
+ storeAccountCookie?: boolean;
124
+ }
125
+ export interface AuthModuleSessionCookieCacheRefreshOptions {
126
+ updateAge?: number;
127
+ }
128
+ export interface AuthModuleSessionCookieCacheOptions {
129
+ enabled?: boolean;
130
+ maxAge?: number;
131
+ strategy?: "compact" | "jwe" | "jwt";
132
+ refreshCache?: boolean | AuthModuleSessionCookieCacheRefreshOptions;
133
+ version?: string | ((session: Record<string, unknown>, user: Record<string, unknown>) => string) | ((session: Record<string, unknown>, user: Record<string, unknown>) => Promise<string>);
134
+ }
135
+ export interface AuthModuleSessionOptions {
136
+ expiresIn?: number;
137
+ updateAge?: number;
138
+ disableSessionRefresh?: boolean;
139
+ deferSessionRefresh?: boolean;
140
+ cookieCache?: AuthModuleSessionCookieCacheOptions;
141
+ freshAge?: number;
142
+ }
5
143
  export interface AuthModuleMiddlewareOptions {
6
144
  register?: boolean;
7
145
  includeRoutes?: (string | RouteInfo | Type)[];
8
146
  excludeRoutes?: (string | RouteInfo)[];
9
147
  }
10
- export interface AuthModuleOptions extends Omit<BetterAuthOptions, "database"> {
148
+ export interface AuthModuleApiKeyOptions<Permission extends string = string> {
149
+ defaultPermissions?: readonly Permission[];
150
+ allowedPermissions?: readonly Permission[];
151
+ }
152
+ export interface AuthOAuthTokens {
153
+ tokenType?: string;
154
+ accessToken?: string;
155
+ refreshToken?: string;
156
+ accessTokenExpiresAt?: Date;
157
+ refreshTokenExpiresAt?: Date;
158
+ scopes?: string[];
159
+ idToken?: string;
160
+ raw?: Record<string, unknown>;
161
+ }
162
+ export interface AuthOAuthMappedUser {
163
+ id?: never;
164
+ name?: string;
165
+ email?: string | null;
166
+ image?: string;
167
+ emailVerified?: boolean;
168
+ [key: string]: unknown;
169
+ }
170
+ export interface AuthOAuthUserInfo {
171
+ id?: never;
172
+ name?: string;
173
+ email?: string | null;
174
+ image?: string;
175
+ emailVerified: boolean;
176
+ }
177
+ export interface AuthOAuthProfile {
178
+ id?: string | number | null;
179
+ sub?: string | number | null;
180
+ [key: string]: unknown;
181
+ }
182
+ export interface AuthOAuthRefreshContext {
183
+ headers?: Headers;
184
+ request?: Request;
185
+ }
186
+ export interface AuthOAuthClientAssertionContext {
187
+ clientId: string;
188
+ tokenEndpoint: string;
189
+ grantType: "authorization_code" | "refresh_token" | "client_credentials";
190
+ }
191
+ export interface AuthOAuthTokenRequestContext {
192
+ body: URLSearchParams;
193
+ headers: Record<string, string>;
194
+ options: AuthOAuthTokenRequestClientOptions;
195
+ tokenEndpoint: string;
196
+ grantType: AuthOAuthClientAssertionContext["grantType"];
197
+ }
198
+ export interface AuthOAuthTokenRequestClientOptions {
199
+ clientId?: string | string[];
200
+ clientSecret?: string;
201
+ }
202
+ export interface AuthOAuthNoTokenEndpointAuth {
203
+ method: "none";
204
+ }
205
+ export interface AuthOAuthBasicTokenEndpointAuth {
206
+ method: "client_secret_basic";
207
+ }
208
+ export interface AuthOAuthPostTokenEndpointAuth {
209
+ method: "client_secret_post";
210
+ }
211
+ export interface AuthOAuthPrivateKeyJwtTokenEndpointAuth {
212
+ method: "private_key_jwt";
213
+ getClientAssertion: (context: AuthOAuthClientAssertionContext) => AuthMaybePromise<string>;
214
+ }
215
+ export interface AuthOAuthCustomTokenEndpointAuth {
216
+ method: "custom";
217
+ customizeRequest: (context: AuthOAuthTokenRequestContext) => void | Promise<void>;
218
+ }
219
+ export type AuthOAuthTokenEndpointAuth = AuthOAuthNoTokenEndpointAuth | AuthOAuthBasicTokenEndpointAuth | AuthOAuthPostTokenEndpointAuth | AuthOAuthPrivateKeyJwtTokenEndpointAuth | AuthOAuthCustomTokenEndpointAuth;
220
+ export interface AuthSocialProviderUserInfo {
221
+ user: AuthOAuthUserInfo;
222
+ data: Record<string, unknown>;
223
+ }
224
+ export type AuthModuleSocialProviderId = "apple" | "atlassian" | "cognito" | "discord" | "dropbox" | "facebook" | "figma" | "github" | "gitlab" | "google" | "huggingface" | "kakao" | "kick" | "line" | "linear" | "linkedin" | "microsoft" | "naver" | "notion" | "paybin" | "paypal" | "polar" | "railway" | "reddit" | "roblox" | "salesforce" | "slack" | "spotify" | "tiktok" | "twitch" | "twitter" | "vercel" | "vk" | "wechat" | "zoom";
225
+ export interface AuthModuleSocialProvider {
226
+ id: AuthModuleSocialProviderId;
227
+ clientId?: string | string[];
228
+ clientSecret?: string;
229
+ scope?: string[];
230
+ disableDefaultScope?: boolean;
231
+ redirectURI?: string;
232
+ authorizationEndpoint?: string;
233
+ clientKey?: string;
234
+ disableIdTokenSignIn?: boolean;
235
+ verifyIdToken?: (token: string, nonce?: string, context?: unknown) => Promise<boolean>;
236
+ getUserInfo?: (tokens: AuthOAuthTokens) => Promise<AuthSocialProviderUserInfo | null>;
237
+ refreshAccessToken?: (refreshToken: string) => Promise<AuthOAuthTokens>;
238
+ mapProfileToUser?: (profile: Record<string, unknown>) => AuthMaybePromise<AuthOAuthMappedUser>;
239
+ disableImplicitSignUp?: boolean;
240
+ disableSignUp?: boolean;
241
+ prompt?: "select_account" | "consent" | "login" | "none" | "select_account consent";
242
+ responseMode?: "query" | "form_post";
243
+ overrideUserInfoOnSignIn?: boolean;
244
+ requireEmailVerification?: boolean;
245
+ enabled?: boolean;
246
+ appBundleIdentifier?: string;
247
+ audience?: string | string[];
248
+ domain?: string;
249
+ region?: string;
250
+ userPoolId?: string;
251
+ requireClientSecret?: boolean;
252
+ identityProvider?: string;
253
+ permissions?: number;
254
+ accessType?: "offline" | "online" | "legacy";
255
+ fields?: string[];
256
+ configId?: string;
257
+ issuer?: string;
258
+ display?: "page" | "popup" | "touch" | "wap";
259
+ hd?: string;
260
+ includeGrantedScopes?: boolean;
261
+ tenantId?: string;
262
+ authority?: string;
263
+ clientAssertion?: (context: AuthOAuthClientAssertionContext) => AuthMaybePromise<string>;
264
+ profilePhotoSize?: 48 | 64 | 96 | 120 | 240 | 360 | 432 | 504 | 648;
265
+ disableProfilePhoto?: boolean;
266
+ environment?: "sandbox" | "live" | "production";
267
+ requestShippingAddress?: boolean;
268
+ duration?: string;
269
+ loginUrl?: string;
270
+ claims?: string[];
271
+ scheme?: "light" | "dark";
272
+ platformType?: "WebsiteApp";
273
+ lang?: "cn" | "en";
274
+ pkce?: boolean;
275
+ tokenEndpointAuthMethod?: "client_secret_basic" | "client_secret_post" | "none";
276
+ }
277
+ export interface AuthModuleOAuthProvider {
278
+ id: string;
279
+ name?: string;
280
+ accountSubject?: (context: {
281
+ tokens: AuthOAuthTokens;
282
+ profile: AuthOAuthProfile;
283
+ }) => AuthMaybePromise<string | number>;
284
+ discoveryUrl?: string;
285
+ requireIdTokenVerification?: boolean;
286
+ authorizationUrl?: string;
287
+ tokenUrl?: string;
288
+ userInfoUrl?: string;
289
+ endSessionEndpoint?: string;
290
+ postLogoutRedirectURI?: string;
291
+ disableProviderLogout?: boolean;
292
+ clientId: string;
293
+ clientSecret?: string;
294
+ tokenEndpointAuth?: AuthOAuthTokenEndpointAuth;
295
+ scopes?: string[];
296
+ redirectURI?: string;
297
+ responseType?: string;
298
+ responseMode?: "query" | "form_post";
299
+ prompt?: "none" | "login" | "create" | "consent" | "select_account" | "select_account consent" | "login consent";
300
+ pkce?: boolean;
301
+ accessType?: string;
302
+ accessTokenExpiresIn?: number;
303
+ getToken?: (data: {
304
+ code: string;
305
+ redirectURI: string;
306
+ codeVerifier?: string;
307
+ deviceId?: string;
308
+ }) => Promise<AuthOAuthTokens>;
309
+ getUserInfo?: (tokens: AuthOAuthTokens) => Promise<AuthOAuthProfile | null>;
310
+ mapProfileToUser?: (profile: AuthOAuthProfile) => AuthMaybePromise<AuthOAuthMappedUser>;
311
+ authorizationUrlParams?: Record<string, string>;
312
+ tokenUrlParams?: Record<string, string>;
313
+ refreshTokenParams?: Record<string, string> | ((context?: AuthOAuthRefreshContext) => AuthMaybePromise<Record<string, string> | undefined>);
314
+ disableImplicitSignUp?: boolean;
315
+ disableSignUp?: boolean;
316
+ authentication?: "basic" | "post";
317
+ discoveryHeaders?: Record<string, string>;
318
+ authorizationHeaders?: Record<string, string>;
319
+ overrideUserInfo?: boolean;
320
+ requireEmailVerification?: boolean;
321
+ allowIdpInitiated?: boolean;
322
+ disableIdTokenNonceBinding?: boolean;
323
+ }
324
+ export type AuthModuleProvider = AuthModuleSocialProvider | AuthModuleOAuthProvider;
325
+ export interface AuthModuleOptions<UserPermission extends string = string, WorkspacePermission extends string = string, User extends BaseUser = BaseUser, Workspace extends BaseWorkspace = BaseWorkspace> {
326
+ appName?: string;
327
+ baseURL?: string;
11
328
  basePath?: string;
12
- entities: MikroOrmAdapterConfig["entities"];
329
+ secret?: string;
330
+ trustedOrigins?: string[] | ((request?: Request) => AuthMaybePromise<(string | null | undefined)[]>);
331
+ account?: AuthModuleAccountOptions;
332
+ session?: AuthModuleSessionOptions;
333
+ emailAndPassword?: AuthModuleEmailAndPasswordOptions;
334
+ user?: AuthModuleUserOptions<UserPermission, User>;
335
+ emailVerification?: AuthModuleEmailVerificationOptions;
336
+ workspace?: AuthModuleWorkspaceOptions<WorkspacePermission, Workspace>;
337
+ apiKey?: AuthModuleApiKeyOptions<NoInfer<UserPermission | WorkspacePermission>>;
338
+ providers?: readonly AuthModuleProvider[];
339
+ entities: {
340
+ user: EntityClass<User>;
341
+ account: EntityClass<BaseAccount>;
342
+ session: EntityClass<BaseSession>;
343
+ verification: EntityClass<BaseVerification>;
344
+ workspace: EntityClass<Workspace>;
345
+ workspaceInvitation: EntityClass<BaseWorkspaceInvitation>;
346
+ workspaceMember: EntityClass<BaseWorkspaceMember>;
347
+ apiKey: EntityClass<BaseApiKey>;
348
+ };
13
349
  middleware?: AuthModuleMiddlewareOptions;
14
- onAuthenticated?: () => void | Promise<void>;
15
350
  }
@@ -1,8 +1,40 @@
1
- import { type CanActivate, type ExecutionContext } from "@nestjs/common";
2
- import { Reflector } from "@nestjs/core";
1
+ import type { CanActivate, ExecutionContext } from "@nestjs/common";
2
+ import { ModuleRef, Reflector } from "@nestjs/core";
3
+ import type { AuthModuleOptions } from "./auth-module-options.interface.js";
3
4
  export declare class AuthGuard implements CanActivate {
4
5
  protected readonly reflector: Reflector;
5
- constructor(reflector: Reflector);
6
+ private readonly options;
7
+ private readonly moduleRef;
8
+ constructor(reflector: Reflector, options: AuthModuleOptions, moduleRef: ModuleRef);
6
9
  protected isPublic(context: ExecutionContext): boolean;
7
- canActivate(context: ExecutionContext): ReturnType<CanActivate["canActivate"]>;
10
+ protected isAuthenticated(): boolean;
11
+ canActivate(context: ExecutionContext): Promise<boolean>;
12
+ private checkPermissions;
13
+ private checkUserPermission;
14
+ private checkWorkspacePermission;
15
+ private isWorkspaceApiKey;
16
+ private getOrBuildUserAbility;
17
+ private getOrBuildWorkspaceAbility;
18
+ private buildAndCacheUserAbility;
19
+ private buildAndCacheWorkspaceAbility;
20
+ private intersectApiKeyPermissions;
21
+ private resolveUserPermissions;
22
+ private resolveWorkspacePermissions;
23
+ private resolveSubject;
24
+ private isSubjectType;
25
+ private resolveProvider;
26
+ private resolveSubjectFactory;
27
+ private resolveHandlerSelf;
28
+ private getContextId;
29
+ private getRequest;
30
+ private getSubjectFactoryArgs;
31
+ private getRouteArgsMetadata;
32
+ private getHandlerMethodName;
33
+ private createRouteArguments;
34
+ private extractRouteArgument;
35
+ private resolveGraphqlRouteArgument;
36
+ private resolveHttpRouteArgument;
37
+ private getObjectValue;
38
+ private getStringData;
39
+ private getRecord;
8
40
  }