nestjs-authentication 0.4.3 → 0.5.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 (197) hide show
  1. package/CHANGELOG.md +77 -2
  2. package/README.md +108 -0
  3. package/SECURITY.md +15 -0
  4. package/dist/classes/email.password.user.d.ts +13 -0
  5. package/dist/classes/email.password.user.d.ts.map +1 -0
  6. package/dist/classes/email.password.user.js +3 -0
  7. package/dist/classes/email.password.user.js.map +1 -0
  8. package/dist/constants.d.ts +13 -0
  9. package/dist/constants.d.ts.map +1 -1
  10. package/dist/constants.js +14 -1
  11. package/dist/constants.js.map +1 -1
  12. package/dist/context/auth.context.d.ts +38 -0
  13. package/dist/context/auth.context.d.ts.map +1 -0
  14. package/dist/context/auth.context.js +39 -0
  15. package/dist/context/auth.context.js.map +1 -0
  16. package/dist/context/decorators.d.ts +25 -0
  17. package/dist/context/decorators.d.ts.map +1 -0
  18. package/dist/context/decorators.js +38 -0
  19. package/dist/context/decorators.js.map +1 -0
  20. package/dist/context/index.d.ts +5 -0
  21. package/dist/context/index.d.ts.map +1 -0
  22. package/dist/context/index.js +21 -0
  23. package/dist/context/index.js.map +1 -0
  24. package/dist/context/interceptor.d.ts +15 -0
  25. package/dist/context/interceptor.d.ts.map +1 -0
  26. package/dist/context/interceptor.js +51 -0
  27. package/dist/context/interceptor.js.map +1 -0
  28. package/dist/context/service.d.ts +18 -0
  29. package/dist/context/service.d.ts.map +1 -0
  30. package/dist/context/service.js +45 -0
  31. package/dist/context/service.js.map +1 -0
  32. package/dist/encryptor.d.ts +20 -0
  33. package/dist/encryptor.d.ts.map +1 -1
  34. package/dist/encryptor.js +36 -6
  35. package/dist/encryptor.js.map +1 -1
  36. package/dist/encryptors/index.d.ts +3 -0
  37. package/dist/encryptors/index.d.ts.map +1 -0
  38. package/dist/encryptors/index.js +19 -0
  39. package/dist/encryptors/index.js.map +1 -0
  40. package/dist/encryptors/migrating.d.ts +28 -0
  41. package/dist/encryptors/migrating.d.ts.map +1 -0
  42. package/dist/encryptors/migrating.js +72 -0
  43. package/dist/encryptors/migrating.js.map +1 -0
  44. package/dist/encryptors/scrypt.d.ts +42 -0
  45. package/dist/encryptors/scrypt.d.ts.map +1 -0
  46. package/dist/encryptors/scrypt.js +85 -0
  47. package/dist/encryptors/scrypt.js.map +1 -0
  48. package/dist/errors.d.ts +32 -0
  49. package/dist/errors.d.ts.map +1 -0
  50. package/dist/errors.js +63 -0
  51. package/dist/errors.js.map +1 -0
  52. package/dist/guard.d.ts +115 -15
  53. package/dist/guard.d.ts.map +1 -1
  54. package/dist/guard.js +302 -90
  55. package/dist/guard.js.map +1 -1
  56. package/dist/index.d.ts +10 -4
  57. package/dist/index.d.ts.map +1 -1
  58. package/dist/index.js +10 -4
  59. package/dist/index.js.map +1 -1
  60. package/dist/injection.d.ts +3 -0
  61. package/dist/injection.d.ts.map +1 -0
  62. package/dist/injection.js +9 -0
  63. package/dist/injection.js.map +1 -0
  64. package/dist/interfaces/auth.user.d.ts +16 -5
  65. package/dist/interfaces/auth.user.d.ts.map +1 -1
  66. package/dist/interfaces/auth.user.js +6 -0
  67. package/dist/interfaces/auth.user.js.map +1 -1
  68. package/dist/interfaces/encrypt.d.ts +29 -1
  69. package/dist/interfaces/encrypt.d.ts.map +1 -1
  70. package/dist/interfaces/options.d.ts +52 -5
  71. package/dist/interfaces/options.d.ts.map +1 -1
  72. package/dist/interfaces/provider.d.ts +26 -3
  73. package/dist/interfaces/provider.d.ts.map +1 -1
  74. package/dist/module.d.ts +48 -6
  75. package/dist/module.d.ts.map +1 -1
  76. package/dist/module.js +153 -50
  77. package/dist/module.js.map +1 -1
  78. package/dist/providers/auth.provider.d.ts +12 -4
  79. package/dist/providers/auth.provider.d.ts.map +1 -1
  80. package/dist/providers/auth.provider.js +7 -1
  81. package/dist/providers/auth.provider.js.map +1 -1
  82. package/dist/providers/email.password.auth.provider.d.ts +75 -0
  83. package/dist/providers/email.password.auth.provider.d.ts.map +1 -0
  84. package/dist/providers/email.password.auth.provider.js +120 -0
  85. package/dist/providers/email.password.auth.provider.js.map +1 -0
  86. package/dist/providers/memory.user.provider.d.ts +39 -6
  87. package/dist/providers/memory.user.provider.d.ts.map +1 -1
  88. package/dist/providers/memory.user.provider.js +70 -15
  89. package/dist/providers/memory.user.provider.js.map +1 -1
  90. package/dist/scopes/decorators.d.ts +41 -0
  91. package/dist/scopes/decorators.d.ts.map +1 -0
  92. package/dist/scopes/decorators.js +44 -0
  93. package/dist/scopes/decorators.js.map +1 -0
  94. package/dist/scopes/index.d.ts +4 -0
  95. package/dist/scopes/index.d.ts.map +1 -0
  96. package/dist/scopes/index.js +20 -0
  97. package/dist/scopes/index.js.map +1 -0
  98. package/dist/scopes/service.d.ts +32 -0
  99. package/dist/scopes/service.d.ts.map +1 -0
  100. package/dist/scopes/service.js +90 -0
  101. package/dist/scopes/service.js.map +1 -0
  102. package/dist/scopes/utils.d.ts +8 -0
  103. package/dist/scopes/utils.d.ts.map +1 -0
  104. package/dist/scopes/utils.js +29 -0
  105. package/dist/scopes/utils.js.map +1 -0
  106. package/dist/service.d.ts +25 -6
  107. package/dist/service.d.ts.map +1 -1
  108. package/dist/service.js +36 -5
  109. package/dist/service.js.map +1 -1
  110. package/dist/session/index.d.ts +3 -0
  111. package/dist/session/index.d.ts.map +1 -0
  112. package/dist/session/index.js +19 -0
  113. package/dist/session/index.js.map +1 -0
  114. package/dist/session/manager.d.ts +32 -0
  115. package/dist/session/manager.d.ts.map +1 -0
  116. package/dist/session/manager.js +131 -0
  117. package/dist/session/manager.js.map +1 -0
  118. package/dist/session/request.d.ts +14 -0
  119. package/dist/session/request.d.ts.map +1 -0
  120. package/dist/session/request.js +59 -0
  121. package/dist/session/request.js.map +1 -0
  122. package/dist/strategies/emailpassword.d.ts +20 -7
  123. package/dist/strategies/emailpassword.d.ts.map +1 -1
  124. package/dist/strategies/emailpassword.js +42 -19
  125. package/dist/strategies/emailpassword.js.map +1 -1
  126. package/dist/strategies/extract.d.ts +23 -0
  127. package/dist/strategies/extract.d.ts.map +1 -0
  128. package/dist/strategies/extract.js +57 -0
  129. package/dist/strategies/extract.js.map +1 -0
  130. package/dist/strategies/index.d.ts +8 -0
  131. package/dist/strategies/index.d.ts.map +1 -0
  132. package/dist/strategies/index.js +24 -0
  133. package/dist/strategies/index.js.map +1 -0
  134. package/dist/strategies/interfaces.d.ts +65 -0
  135. package/dist/strategies/interfaces.d.ts.map +1 -0
  136. package/dist/{classes/memory.user.js → strategies/interfaces.js} +1 -1
  137. package/dist/strategies/interfaces.js.map +1 -0
  138. package/dist/strategies/jwt.d.ts +87 -15
  139. package/dist/strategies/jwt.d.ts.map +1 -1
  140. package/dist/strategies/jwt.js +140 -9
  141. package/dist/strategies/jwt.js.map +1 -1
  142. package/dist/strategies/passport.d.ts +22 -0
  143. package/dist/strategies/passport.d.ts.map +1 -0
  144. package/dist/strategies/passport.js +90 -0
  145. package/dist/strategies/passport.js.map +1 -0
  146. package/dist/strategies/registry.d.ts +33 -0
  147. package/dist/strategies/registry.d.ts.map +1 -0
  148. package/dist/strategies/registry.js +67 -0
  149. package/dist/strategies/registry.js.map +1 -0
  150. package/dist/strategies/session.d.ts +18 -0
  151. package/dist/strategies/session.d.ts.map +1 -0
  152. package/dist/strategies/session.js +79 -0
  153. package/dist/strategies/session.js.map +1 -0
  154. package/dist/transports/graphql.d.ts +28 -0
  155. package/dist/transports/graphql.d.ts.map +1 -0
  156. package/dist/transports/graphql.js +59 -0
  157. package/dist/transports/graphql.js.map +1 -0
  158. package/dist/transports/http.d.ts +13 -0
  159. package/dist/transports/http.d.ts.map +1 -0
  160. package/dist/transports/http.js +31 -0
  161. package/dist/transports/http.js.map +1 -0
  162. package/dist/transports/index.d.ts +8 -0
  163. package/dist/transports/index.d.ts.map +1 -0
  164. package/dist/transports/index.js +24 -0
  165. package/dist/transports/index.js.map +1 -0
  166. package/dist/transports/interfaces.d.ts +36 -0
  167. package/dist/transports/interfaces.d.ts.map +1 -0
  168. package/dist/transports/interfaces.js +3 -0
  169. package/dist/transports/interfaces.js.map +1 -0
  170. package/dist/transports/registry.d.ts +25 -0
  171. package/dist/transports/registry.d.ts.map +1 -0
  172. package/dist/transports/registry.js +55 -0
  173. package/dist/transports/registry.js.map +1 -0
  174. package/dist/transports/rpc.d.ts +23 -0
  175. package/dist/transports/rpc.d.ts.map +1 -0
  176. package/dist/transports/rpc.js +54 -0
  177. package/dist/transports/rpc.js.map +1 -0
  178. package/dist/transports/utils.d.ts +21 -0
  179. package/dist/transports/utils.d.ts.map +1 -0
  180. package/dist/transports/utils.js +86 -0
  181. package/dist/transports/utils.js.map +1 -0
  182. package/dist/transports/ws.d.ts +31 -0
  183. package/dist/transports/ws.d.ts.map +1 -0
  184. package/dist/transports/ws.js +52 -0
  185. package/dist/transports/ws.js.map +1 -0
  186. package/package.json +101 -58
  187. package/dist/classes/memory.user.d.ts +0 -7
  188. package/dist/classes/memory.user.d.ts.map +0 -1
  189. package/dist/classes/memory.user.js.map +0 -1
  190. package/dist/providers/auth.memory.user.provider.d.ts +0 -15
  191. package/dist/providers/auth.memory.user.provider.d.ts.map +0 -1
  192. package/dist/providers/auth.memory.user.provider.js +0 -30
  193. package/dist/providers/auth.memory.user.provider.js.map +0 -1
  194. package/dist/user.serializer.d.ts +0 -10
  195. package/dist/user.serializer.d.ts.map +0 -1
  196. package/dist/user.serializer.js +0 -53
  197. package/dist/user.serializer.js.map +0 -1
package/dist/module.js CHANGED
@@ -5,24 +5,46 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
5
5
  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
6
  return c > 3 && r && Object.defineProperty(target, key, r), r;
7
7
  };
8
- var __importDefault = (this && this.__importDefault) || function (mod) {
9
- return (mod && mod.__esModule) ? mod : { "default": mod };
8
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
9
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
10
+ return new (P || (P = Promise))(function (resolve, reject) {
11
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
12
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
13
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
14
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
15
+ });
10
16
  };
11
17
  var AuthModule_1;
12
18
  Object.defineProperty(exports, "__esModule", { value: true });
13
19
  exports.AuthModule = void 0;
14
20
  const common_1 = require("@nestjs/common");
15
- const passport_1 = __importDefault(require("passport"));
21
+ const core_1 = require("@nestjs/core");
16
22
  const constants_1 = require("./constants");
23
+ const interceptor_1 = require("./context/interceptor");
24
+ const service_1 = require("./context/service");
17
25
  const encryptor_1 = require("./encryptor");
18
- const service_1 = require("./service");
26
+ const guard_1 = require("./guard");
27
+ const service_2 = require("./scopes/service");
28
+ const service_3 = require("./service");
19
29
  const emailpassword_1 = require("./strategies/emailpassword");
20
30
  const jwt_1 = require("./strategies/jwt");
21
- const user_serializer_1 = require("./user.serializer");
31
+ const registry_1 = require("./strategies/registry");
32
+ const session_1 = require("./strategies/session");
33
+ const registry_2 = require("./transports/registry");
34
+ const isClass = (value) => typeof value === 'function';
35
+ /**
36
+ * The authentication module (global).
37
+ *
38
+ * - `forRoot()` / `forRootAsync()`: configures the module once, in the root module
39
+ * - `registerAuthProviders()`: registers the auth providers (one per namespace)
40
+ *
41
+ * - `registerStrategies()`: registers your own strategies ({@link AuthStrategy})
42
+ *
43
+ * It provides the {@link AuthService}, the {@link AuthContextService}, the {@link AuthStrategyRegistry} with the
44
+ * `emailpassword`, `session` and (when configured) `jwt` strategies, the {@link ENCRYPTOR} (and the default
45
+ * {@link Encryptor}) and the {@link AuthScopes}, and registers the global {@link AuthGuard} and {@link AuthContextInterceptor}.
46
+ */
22
47
  let AuthModule = AuthModule_1 = class AuthModule {
23
- configure(consumer) {
24
- consumer.apply(passport_1.default.initialize()).forRoutes('*');
25
- }
26
48
  static createOptionsProvider(options) {
27
49
  return {
28
50
  provide: constants_1.MODULE_OPTIONS_TOKEN,
@@ -30,14 +52,20 @@ let AuthModule = AuthModule_1 = class AuthModule {
30
52
  };
31
53
  }
32
54
  static createAsyncOptionsProvider(options) {
33
- return Object.assign({ provide: constants_1.MODULE_OPTIONS_TOKEN }, options);
55
+ var _a;
56
+ return {
57
+ provide: constants_1.MODULE_OPTIONS_TOKEN,
58
+ useFactory: options.useFactory,
59
+ inject: (_a = options.inject) !== null && _a !== void 0 ? _a : []
60
+ };
34
61
  }
35
62
  static createAuthServiceProvider() {
36
63
  return {
37
- provide: service_1.AuthService,
38
- useClass: service_1.AuthService
64
+ provide: service_3.AuthService,
65
+ useClass: service_3.AuthService
39
66
  };
40
67
  }
68
+ /** The default implementation, when the `encrypt` option is set. */
41
69
  static createEncryptorProvider() {
42
70
  return {
43
71
  provide: encryptor_1.Encryptor,
@@ -45,6 +73,26 @@ let AuthModule = AuthModule_1 = class AuthModule {
45
73
  useFactory: (options) => options.encrypt !== undefined ? new encryptor_1.Encryptor(options.encrypt) : undefined
46
74
  };
47
75
  }
76
+ /**
77
+ * The {@link ENCRYPTOR}: the `encryptor` option, else the default {@link Encryptor}.
78
+ * With `forRoot()`, an `encryptor` class is a regular class provider.
79
+ */
80
+ static createEncryptorTokenProvider(options) {
81
+ if (options !== undefined && isClass(options.encryptor)) {
82
+ return { provide: constants_1.ENCRYPTOR, useClass: options.encryptor };
83
+ }
84
+ return {
85
+ provide: constants_1.ENCRYPTOR,
86
+ inject: [constants_1.MODULE_OPTIONS_TOKEN, encryptor_1.Encryptor, core_1.ModuleRef],
87
+ useFactory: (opts, encryptor, moduleRef) => __awaiter(this, void 0, void 0, function* () {
88
+ var _a;
89
+ if (isClass(opts.encryptor)) {
90
+ return yield moduleRef.create(opts.encryptor);
91
+ }
92
+ return (_a = opts.encryptor) !== null && _a !== void 0 ? _a : encryptor;
93
+ })
94
+ };
95
+ }
48
96
  static createLocalEmailPasswordStrategyProvider() {
49
97
  return {
50
98
  provide: emailpassword_1.EmailPasswordStrategy,
@@ -54,70 +102,125 @@ let AuthModule = AuthModule_1 = class AuthModule {
54
102
  static createJWTStrategyProvider() {
55
103
  return {
56
104
  provide: jwt_1.JwtStrategy,
57
- inject: [service_1.AuthService, constants_1.MODULE_OPTIONS_TOKEN],
105
+ inject: [service_3.AuthService, constants_1.MODULE_OPTIONS_TOKEN],
58
106
  useFactory: (authService, options) => options.jwt !== undefined ? new jwt_1.JwtStrategy(authService, options.jwt) : undefined
59
107
  };
60
108
  }
61
- static createModule(optionsProvider) {
62
- const encryptorProvider = this.createEncryptorProvider();
63
- const authServiceProvider = this.createAuthServiceProvider();
64
- const localEmailPasswordStrategyProvider = this.createLocalEmailPasswordStrategyProvider();
65
- const jwtStrategyProvider = this.createJWTStrategyProvider();
109
+ /** Registers the `transports` option in {@link AuthTransports}. */
110
+ static createTransportsProvider() {
111
+ return {
112
+ provide: constants_1.MODULE_TRANSPORTS_REGISTER,
113
+ inject: [constants_1.MODULE_OPTIONS_TOKEN],
114
+ useFactory: (options) => {
115
+ var _a;
116
+ registry_2.AuthTransports.register(...((_a = options.transports) !== null && _a !== void 0 ? _a : []));
117
+ return true;
118
+ }
119
+ };
120
+ }
121
+ /** Registers the built-in strategies in the registry. */
122
+ static createStrategiesProvider() {
123
+ return {
124
+ provide: constants_1.MODULE_STRATEGY_REGISTER,
125
+ inject: [registry_1.AuthStrategyRegistry, emailpassword_1.EmailPasswordStrategy, session_1.SessionStrategy, jwt_1.JwtStrategy],
126
+ useFactory: (registry, ...strategies) => {
127
+ strategies.filter((s) => s !== undefined).forEach((s) => registry.register(s));
128
+ return registry;
129
+ }
130
+ };
131
+ }
132
+ static createModule(optionsProvider, imports = [], options) {
133
+ const providers = [
134
+ optionsProvider,
135
+ this.createEncryptorProvider(),
136
+ this.createEncryptorTokenProvider(options),
137
+ this.createAuthServiceProvider(),
138
+ this.createLocalEmailPasswordStrategyProvider(),
139
+ this.createJWTStrategyProvider(),
140
+ this.createTransportsProvider(),
141
+ registry_1.AuthStrategyRegistry,
142
+ session_1.SessionStrategy,
143
+ this.createStrategiesProvider(),
144
+ service_1.AuthContextService,
145
+ service_2.AuthScopes
146
+ ];
66
147
  return {
67
148
  module: AuthModule_1,
149
+ imports: [core_1.DiscoveryModule, ...imports],
68
150
  providers: [
69
- optionsProvider,
70
- encryptorProvider,
71
- authServiceProvider,
72
- localEmailPasswordStrategyProvider,
73
- jwtStrategyProvider,
74
- user_serializer_1.UserSerializer
151
+ ...providers,
152
+ { provide: core_1.APP_GUARD, useClass: guard_1.AuthGuard },
153
+ { provide: core_1.APP_INTERCEPTOR, useClass: interceptor_1.AuthContextInterceptor }
75
154
  ],
76
- exports: [
77
- optionsProvider,
78
- encryptorProvider,
79
- authServiceProvider,
80
- user_serializer_1.UserSerializer,
81
- jwtStrategyProvider,
82
- user_serializer_1.UserSerializer
83
- ]
155
+ exports: providers
84
156
  };
85
157
  }
158
+ /** Configures the module with static options. */
86
159
  static forRoot(options) {
87
- return this.createModule(this.createOptionsProvider(options));
160
+ return this.createModule(this.createOptionsProvider(options), [], options);
88
161
  }
162
+ /** Configures the module with options returned by a factory (e.g. read from a `ConfigService`). */
89
163
  static forRootAsync(options) {
90
- return this.createModule(this.createAsyncOptionsProvider(options));
164
+ var _a;
165
+ return this.createModule(this.createAsyncOptionsProvider(options), (_a = options.imports) !== null && _a !== void 0 ? _a : []);
91
166
  }
92
- static registerAuthProviders(providers) {
93
- const providerRegister = {
94
- provide: constants_1.MODULE_PROVIDER_REGISTER,
167
+ /**
168
+ * Provides strategies ({@link AuthStrategy}) and registers them in the {@link AuthStrategyRegistry}, under their
169
+ * name. A strategy with the name of a built-in one (`jwt`, `emailpassword`, `session`) replaces it.
170
+ *
171
+ * @param providers class, value, factory or existing providers that resolve to an {@link AuthStrategy}
172
+ * @param imports the modules that provide the dependencies of the strategies (if they are not global)
173
+ */
174
+ static registerStrategies(providers, imports = []) {
175
+ const register = {
176
+ provide: Symbol(constants_1.MODULE_STRATEGY_REGISTER),
95
177
  inject: [
96
- service_1.AuthService,
97
- ...providers.map((p) => {
98
- if (p.provide !== undefined) {
99
- return p.provide;
100
- }
101
- else {
102
- return p;
103
- }
104
- })
178
+ registry_1.AuthStrategyRegistry,
179
+ constants_1.MODULE_STRATEGY_REGISTER,
180
+ ...providers.map((p) => (typeof p === 'function' ? p : p.provide))
105
181
  ],
182
+ useFactory: (registry, _builtIn, ...strategies) => {
183
+ strategies.forEach((s) => registry.register(s));
184
+ return registry;
185
+ }
186
+ };
187
+ return {
188
+ module: AuthModule_1,
189
+ imports,
190
+ providers: [...providers, register],
191
+ exports: providers
192
+ };
193
+ }
194
+ /**
195
+ * Provides auth providers ({@link IAuthProvider}) and registers them in the {@link AuthService}.
196
+ * Each one handles the users of its namespace (`getName()`).
197
+ *
198
+ * @param providers class, value, factory or existing providers that resolve to an {@link IAuthProvider}
199
+ * @param imports the modules that provide the dependencies of the providers (if they are not global),
200
+ * e.g. the module of a `UserRepository`
201
+ */
202
+ static registerAuthProviders(providers, imports = []) {
203
+ const providerRegister = {
204
+ provide: constants_1.MODULE_PROVIDER_REGISTER,
205
+ inject: [service_3.AuthService, ...providers.map((p) => (typeof p === 'function' ? p : p.provide))],
106
206
  useFactory: (authService, ...instances) => {
107
- for (const p of instances) {
108
- authService.registerAuthProvider(p);
207
+ for (const instance of instances) {
208
+ authService.registerAuthProvider(instance);
109
209
  }
210
+ return authService;
110
211
  }
111
212
  };
112
213
  return {
113
214
  module: AuthModule_1,
114
- providers: [...providers, providerRegister]
215
+ imports,
216
+ providers: [...providers, providerRegister],
217
+ exports: providers
115
218
  };
116
219
  }
117
220
  };
118
- AuthModule = AuthModule_1 = __decorate([
221
+ exports.AuthModule = AuthModule;
222
+ exports.AuthModule = AuthModule = AuthModule_1 = __decorate([
119
223
  (0, common_1.Global)(),
120
224
  (0, common_1.Module)({})
121
225
  ], AuthModule);
122
- exports.AuthModule = AuthModule;
123
226
  //# sourceMappingURL=module.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"module.js","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,2CAAyG;AACzG,wDAAgC;AAEhC,2CAA6E;AAC7E,2CAAwC;AAExC,uCAAwC;AACxC,8DAAmE;AACnE,0CAA+C;AAC/C,uDAAmD;AAInD,IAAa,UAAU,kBAAvB,MAAa,UAAU;IACnB,SAAS,CAAC,QAA4B;QAClC,QAAQ,CAAC,KAAK,CAAC,kBAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAES,MAAM,CAAC,qBAAqB,CAAC,OAA2B;QAC9D,OAAO;YACH,OAAO,EAAE,gCAAoB;YAC7B,QAAQ,EAAE,OAAO;SACpB,CAAC;IACN,CAAC;IACS,MAAM,CAAC,0BAA0B,CACvC,OAAgC;QAEhC,uBACI,OAAO,EAAE,gCAAoB,IAC1B,OAAO,EACZ;IACN,CAAC;IAES,MAAM,CAAC,yBAAyB;QACtC,OAAO;YACH,OAAO,EAAE,qBAAW;YACpB,QAAQ,EAAE,qBAAW;SACxB,CAAC;IACN,CAAC;IAES,MAAM,CAAC,uBAAuB;QACpC,OAAO;YACH,OAAO,EAAE,qBAAS;YAClB,MAAM,EAAE,CAAC,gCAAoB,CAAC;YAC9B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CACxC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,qBAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACjF,CAAC;IACN,CAAC;IAES,MAAM,CAAC,wCAAwC;QACrD,OAAO;YACH,OAAO,EAAE,qCAAqB;YAC9B,QAAQ,EAAE,qCAAqB;SAClC,CAAC;IACN,CAAC;IAES,MAAM,CAAC,yBAAyB;QACtC,OAAO;YACH,OAAO,EAAE,iBAAW;YACpB,MAAM,EAAE,CAAC,qBAAW,EAAE,gCAAoB,CAAC;YAC3C,UAAU,EAAE,CAAC,WAAwB,EAAE,OAA2B,EAAE,EAAE,CAClE,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,iBAAW,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;SACxF,CAAC;IACN,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,eAAyB;QACzC,MAAM,iBAAiB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QACzD,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAC7D,MAAM,kCAAkC,GAAG,IAAI,CAAC,wCAAwC,EAAE,CAAC;QAC3F,MAAM,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAC7D,OAAO;YACH,MAAM,EAAE,YAAU;YAClB,SAAS,EAAE;gBACP,eAAe;gBACf,iBAAiB;gBACjB,mBAAmB;gBACnB,kCAAkC;gBAClC,mBAAmB;gBACnB,gCAAc;aACjB;YACD,OAAO,EAAE;gBACL,eAAe;gBACf,iBAAiB;gBACjB,mBAAmB;gBACnB,gCAAc;gBACd,mBAAmB;gBACnB,gCAAc;aACjB;SACJ,CAAC;IACN,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,OAA2B;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAgC;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,CAAC,qBAAqB,CAAC,SAAqB;QAC9C,MAAM,gBAAgB,GAAa;YAC/B,OAAO,EAAE,oCAAwB;YACjC,MAAM,EAAE;gBACJ,qBAAW;gBACX,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnB,IAAK,CAAS,CAAC,OAAO,KAAK,SAAS,EAAE;wBAClC,OAAQ,CAAS,CAAC,OAAO,CAAC;qBAC7B;yBAAM;wBACH,OAAO,CAAC,CAAC;qBACZ;gBACL,CAAC,CAAC;aACL;YACD,UAAU,EAAE,CAAC,WAAwB,EAAE,GAAG,SAAc,EAAE,EAAE;gBACxD,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE;oBACvB,WAAW,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;iBACvC;YACL,CAAC;SACJ,CAAC;QACF,OAAO;YACH,MAAM,EAAE,YAAU;YAClB,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,gBAAgB,CAAC;SAC9C,CAAC;IACN,CAAC;CACJ,CAAA;AA9GY,UAAU;IAFtB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,UAAU,CA8GtB;AA9GY,gCAAU"}
1
+ {"version":3,"file":"module.js","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,2CAA+F;AAC/F,uCAAsF;AAEtF,2CAMqB;AACrB,uDAA+D;AAC/D,+CAAuD;AACvD,2CAAwC;AACxC,mCAAoC;AAIpC,8CAA8C;AAC9C,uCAAwC;AACxC,8DAAmE;AAEnE,0CAA+C;AAC/C,oDAA6D;AAC7D,kDAAuD;AACvD,oDAAuD;AAEvD,MAAM,OAAO,GAAG,CAAC,KAAc,EAAsB,EAAE,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC;AAEpF;;;;;;;;;;;GAWG;AAGI,IAAM,UAAU,kBAAhB,MAAM,UAAU;IACT,MAAM,CAAC,qBAAqB,CAAC,OAA2B;QAC9D,OAAO;YACH,OAAO,EAAE,gCAAoB;YAC7B,QAAQ,EAAE,OAAO;SACpB,CAAC;IACN,CAAC;IAES,MAAM,CAAC,0BAA0B,CAAC,OAAgC;;QACxE,OAAO;YACH,OAAO,EAAE,gCAAoB;YAC7B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,MAAA,OAAO,CAAC,MAAM,mCAAI,EAAE;SAC/B,CAAC;IACN,CAAC;IAES,MAAM,CAAC,yBAAyB;QACtC,OAAO;YACH,OAAO,EAAE,qBAAW;YACpB,QAAQ,EAAE,qBAAW;SACxB,CAAC;IACN,CAAC;IAED,oEAAoE;IAC1D,MAAM,CAAC,uBAAuB;QACpC,OAAO;YACH,OAAO,EAAE,qBAAS;YAClB,MAAM,EAAE,CAAC,gCAAoB,CAAC;YAC9B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CACxC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,qBAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;SACjF,CAAC;IACN,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,4BAA4B,CAAC,OAA4B;QACtE,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,OAAO,EAAE,OAAO,EAAE,qBAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO;YACH,OAAO,EAAE,qBAAS;YAClB,MAAM,EAAE,CAAC,gCAAoB,EAAE,qBAAS,EAAE,gBAAS,CAAC;YACpD,UAAU,EAAE,CAAO,IAAwB,EAAE,SAAgC,EAAE,SAAoB,EAAE,EAAE;;gBACnG,IAAI,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1B,OAAO,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAClD,CAAC;gBACD,OAAO,MAAA,IAAI,CAAC,SAAS,mCAAI,SAAS,CAAC;YACvC,CAAC,CAAA;SACJ,CAAC;IACN,CAAC;IAES,MAAM,CAAC,wCAAwC;QACrD,OAAO;YACH,OAAO,EAAE,qCAAqB;YAC9B,QAAQ,EAAE,qCAAqB;SAClC,CAAC;IACN,CAAC;IAES,MAAM,CAAC,yBAAyB;QACtC,OAAO;YACH,OAAO,EAAE,iBAAW;YACpB,MAAM,EAAE,CAAC,qBAAW,EAAE,gCAAoB,CAAC;YAC3C,UAAU,EAAE,CAAC,WAAwB,EAAE,OAA2B,EAAE,EAAE,CAClE,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,iBAAW,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;SACxF,CAAC;IACN,CAAC;IAED,mEAAmE;IACzD,MAAM,CAAC,wBAAwB;QACrC,OAAO;YACH,OAAO,EAAE,sCAA0B;YACnC,MAAM,EAAE,CAAC,gCAAoB,CAAC;YAC9B,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE;;gBACxC,yBAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC,CAAC;gBACvD,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;IACN,CAAC;IAED,yDAAyD;IAC/C,MAAM,CAAC,wBAAwB;QACrC,OAAO;YACH,OAAO,EAAE,oCAAwB;YACjC,MAAM,EAAE,CAAC,+BAAoB,EAAE,qCAAqB,EAAE,yBAAe,EAAE,iBAAW,CAAC;YACnF,UAAU,EAAE,CAAC,QAA8B,EAAE,GAAG,UAAwC,EAAE,EAAE;gBACxF,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/E,OAAO,QAAQ,CAAC;YACpB,CAAC;SACJ,CAAC;IACN,CAAC;IAED,MAAM,CAAC,YAAY,CACf,eAAyB,EACzB,UAA8C,EAAE,EAChD,OAA4B;QAE5B,MAAM,SAAS,GAAG;YACd,eAAe;YACf,IAAI,CAAC,uBAAuB,EAAE;YAC9B,IAAI,CAAC,4BAA4B,CAAC,OAAO,CAAC;YAC1C,IAAI,CAAC,yBAAyB,EAAE;YAChC,IAAI,CAAC,wCAAwC,EAAE;YAC/C,IAAI,CAAC,yBAAyB,EAAE;YAChC,IAAI,CAAC,wBAAwB,EAAE;YAC/B,+BAAoB;YACpB,yBAAe;YACf,IAAI,CAAC,wBAAwB,EAAE;YAC/B,4BAAkB;YAClB,oBAAU;SACb,CAAC;QACF,OAAO;YACH,MAAM,EAAE,YAAU;YAClB,OAAO,EAAE,CAAC,sBAAe,EAAE,GAAG,OAAO,CAAC;YACtC,SAAS,EAAE;gBACP,GAAG,SAAS;gBACZ,EAAE,OAAO,EAAE,gBAAS,EAAE,QAAQ,EAAE,iBAAS,EAAE;gBAC3C,EAAE,OAAO,EAAE,sBAAe,EAAE,QAAQ,EAAE,oCAAsB,EAAE;aACjE;YACD,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAED,iDAAiD;IACjD,MAAM,CAAC,OAAO,CAAC,OAA2B;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED,mGAAmG;IACnG,MAAM,CAAC,YAAY,CAAC,OAAgC;;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CACrB,SAAmC,EACnC,UAAqC,EAAE;QAEvC,MAAM,QAAQ,GAAa;YACvB,OAAO,EAAE,MAAM,CAAC,oCAAwB,CAAC;YACzC,MAAM,EAAE;gBACJ,+BAAoB;gBACpB,oCAAwB;gBACxB,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;aACrE;YACD,UAAU,EAAE,CAAC,QAA8B,EAAE,QAAiB,EAAE,GAAG,UAA0B,EAAE,EAAE;gBAC7F,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,OAAO,QAAQ,CAAC;YACpB,CAAC;SACJ,CAAC;QACF,OAAO;YACH,MAAM,EAAE,YAAU;YAClB,OAAO;YACP,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,QAAQ,CAAC;YACnC,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,qBAAqB,CACxB,SAA8C,EAC9C,UAAqC,EAAE;QAEvC,MAAM,gBAAgB,GAAa;YAC/B,OAAO,EAAE,oCAAwB;YACjC,MAAM,EAAE,CAAC,qBAAW,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;YACzF,UAAU,EAAE,CAAC,WAAwB,EAAE,GAAG,SAAoC,EAAE,EAAE;gBAC9E,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC/B,WAAW,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBAC/C,CAAC;gBACD,OAAO,WAAW,CAAC;YACvB,CAAC;SACJ,CAAC;QACF,OAAO;YACH,MAAM,EAAE,YAAU;YAClB,OAAO;YACP,SAAS,EAAE,CAAC,GAAG,SAAS,EAAE,gBAAgB,CAAC;YAC3C,OAAO,EAAE,SAAS;SACrB,CAAC;IACN,CAAC;CACJ,CAAA;AAlMY,gCAAU;qBAAV,UAAU;IAFtB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,UAAU,CAkMtB"}
@@ -1,12 +1,20 @@
1
1
  import { IAuthProvider, IUserProvider } from '../interfaces/provider';
2
- export declare abstract class AuthProvider<User> implements IAuthProvider<User> {
2
+ /**
3
+ * Base class of an auth provider: finds the user with a {@link IUserProvider}, then checks it.
4
+ *
5
+ * @typeParam User the user
6
+ * @typeParam Data the data given to `loadUser()` (credentials, session or token payload)
7
+ */
8
+ export declare abstract class AuthProvider<User, Data extends object = Partial<User>> implements IAuthProvider<User, Data> {
3
9
  protected readonly providerName: string;
4
10
  protected readonly userProvider: IUserProvider<User>;
5
11
  constructor(providerName: string, userProvider: IUserProvider<User>);
6
12
  getName(): string;
7
13
  getProvider(): IUserProvider<User>;
8
- protected abstract userChecker(data: Partial<User>, user?: User): User | undefined;
9
- protected abstract createUserQuery(data: Partial<User>): Record<string, unknown>;
10
- loadUser(data: Partial<User>): Promise<User | undefined>;
14
+ /** Returns the user if it matches the data (e.g. the password), or `undefined`. */
15
+ protected abstract userChecker(data: Data, user?: User): User | undefined | Promise<User | undefined>;
16
+ /** Returns the query given to {@link IUserProvider.findOne}. */
17
+ protected abstract createUserQuery(data: Data): Record<string, unknown>;
18
+ loadUser(data: Data): Promise<User | undefined>;
11
19
  }
12
20
  //# sourceMappingURL=auth.provider.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"auth.provider.d.ts","sourceRoot":"","sources":["../../src/providers/auth.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEtE,8BAAsB,YAAY,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;IACvD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IAAE,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC;gBAA1E,YAAY,EAAE,MAAM,EAAqB,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC;IAEzG,OAAO,IAAI,MAAM;IAIjB,WAAW,IAAI,aAAa,CAAC,IAAI,CAAC;IAIlC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS;IAElF,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1E,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;CAIjE"}
1
+ {"version":3,"file":"auth.provider.d.ts","sourceRoot":"","sources":["../../src/providers/auth.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEtE;;;;;GAKG;AACH,8BAAsB,YAAY,CAAC,IAAI,EAAE,IAAI,SAAS,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAE,YAAW,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC;IAE1G,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM;IACvC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC;gBADjC,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC;IAGxD,OAAO,IAAI,MAAM;IAIjB,WAAW,IAAI,aAAa,CAAC,IAAI,CAAC;IAIlC,mFAAmF;IACnF,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAErG,gEAAgE;IAChE,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjE,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;CAIxD"}
@@ -10,6 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.AuthProvider = void 0;
13
+ /**
14
+ * Base class of an auth provider: finds the user with a {@link IUserProvider}, then checks it.
15
+ *
16
+ * @typeParam User the user
17
+ * @typeParam Data the data given to `loadUser()` (credentials, session or token payload)
18
+ */
13
19
  class AuthProvider {
14
20
  constructor(providerName, userProvider) {
15
21
  this.providerName = providerName;
@@ -24,7 +30,7 @@ class AuthProvider {
24
30
  loadUser(data) {
25
31
  return __awaiter(this, void 0, void 0, function* () {
26
32
  const user = yield this.userProvider.findOne(this.createUserQuery(data));
27
- return this.userChecker(data, user);
33
+ return yield this.userChecker(data, user);
28
34
  });
29
35
  }
30
36
  }
@@ -1 +1 @@
1
- {"version":3,"file":"auth.provider.js","sourceRoot":"","sources":["../../src/providers/auth.provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,MAAsB,YAAY;IAC9B,YAA+B,YAAoB,EAAqB,YAAiC;QAA1E,iBAAY,GAAZ,YAAY,CAAQ;QAAqB,iBAAY,GAAZ,YAAY,CAAqB;IAAG,CAAC;IAE7G,OAAO;QACH,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAMK,QAAQ,CAAC,IAAmB;;YAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC;KAAA;CACJ;AAnBD,oCAmBC"}
1
+ {"version":3,"file":"auth.provider.js","sourceRoot":"","sources":["../../src/providers/auth.provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA;;;;;GAKG;AACH,MAAsB,YAAY;IAC9B,YACuB,YAAoB,EACpB,YAAiC;QADjC,iBAAY,GAAZ,YAAY,CAAQ;QACpB,iBAAY,GAAZ,YAAY,CAAqB;IACrD,CAAC;IAEJ,OAAO;QACH,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAQK,QAAQ,CAAC,IAAU;;YACrB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9C,CAAC;KAAA;CACJ;AAxBD,oCAwBC"}
@@ -0,0 +1,75 @@
1
+ import { AuthUserPayload } from '../interfaces/auth.user';
2
+ import { IEncryptor } from '../interfaces/encrypt';
3
+ import { IAuthProvider } from '../interfaces/provider';
4
+ /** A value, or a promise of it. */
5
+ export type MaybePromise<T> = T | Promise<T>;
6
+ /** The data given to {@link EmailPasswordAuthProvider.loadUser}: credentials, or a session / token payload. */
7
+ export interface EmailPasswordCredentials {
8
+ email?: string;
9
+ password?: string;
10
+ /** The id of the user (a payload): `sub`, `_id` or `id`. */
11
+ sub?: unknown;
12
+ _id?: unknown;
13
+ id?: unknown;
14
+ namespace?: string;
15
+ [key: string]: unknown;
16
+ }
17
+ /**
18
+ * Options of the {@link EmailPasswordAuthProvider}: how to find and read your users, whatever their shape.
19
+ *
20
+ * @typeParam User your user type
21
+ */
22
+ export interface EmailPasswordAuthProviderOptions<User> {
23
+ /** The namespace of the provider. Default `default`. */
24
+ namespace?: string;
25
+ /** Checks the passwords: the {@link ENCRYPTOR} (inject it), e.g. a {@link ScryptEncryptor}. */
26
+ encryptor: IEncryptor;
27
+ /** Returns the user of an id (from a session or a token), or `undefined`. */
28
+ findById: (id: any) => MaybePromise<User | undefined | null>;
29
+ /** Returns the user of an email (login), or `undefined`. */
30
+ findByEmail: (email: string) => MaybePromise<User | undefined | null>;
31
+ /** Returns the id of a user, stored in the sessions and the tokens. Default: `user._id ?? user.id`. */
32
+ getId?: (user: User) => unknown;
33
+ /** Returns the stored password hash of a user. Default: `user.passwordEncrypted ?? user.passwordHash`. */
34
+ getPasswordHash?: (user: User) => string | undefined | null;
35
+ /**
36
+ * Stores a new password hash, after a successful login when the encryptor says the stored one needs a rehash
37
+ * (see {@link MigratingEncryptor}). Optional.
38
+ */
39
+ updatePasswordHash?: (user: User, passwordHash: string) => MaybePromise<void>;
40
+ }
41
+ /**
42
+ * The auth provider of the users who log in with an email and a password. Your users keep their shape: give the
43
+ * functions that find and read them.
44
+ *
45
+ * ```ts
46
+ * new EmailPasswordAuthProvider<UserEntity>({
47
+ * encryptor,
48
+ * findById: (id) => users.findOneBy({ id }),
49
+ * findByEmail: (email) => users.findOneBy({ email }),
50
+ * getId: (user) => user.id,
51
+ * getPasswordHash: (user) => user.passwordHash
52
+ * });
53
+ * ```
54
+ *
55
+ * - login (`{ email, password }`): `findByEmail()`, then checks the password against the hash with the encryptor
56
+ * (and stores a new hash with `updatePasswordHash()` if the encryptor says it needs a rehash)
57
+ * - session or token payload (`{ sub, namespace }`): `findById()`
58
+ * - the payload of a user is `{ sub: getId(user), namespace }`
59
+ *
60
+ * @typeParam User your user type
61
+ */
62
+ export declare class EmailPasswordAuthProvider<User = any> implements IAuthProvider<User, EmailPasswordCredentials> {
63
+ protected readonly options: Required<Omit<EmailPasswordAuthProviderOptions<User>, 'updatePasswordHash'>> & Pick<EmailPasswordAuthProviderOptions<User>, 'updatePasswordHash'>;
64
+ constructor(options: EmailPasswordAuthProviderOptions<User>);
65
+ getName(): string;
66
+ /** Returns `{ sub: getId(user), namespace }`. */
67
+ serializeUser(user: User): AuthUserPayload;
68
+ loadUser(data: EmailPasswordCredentials): Promise<User | undefined>;
69
+ protected findById(id: unknown): Promise<User | undefined>;
70
+ /** Uses `encryptor.compare()` if implemented, else encrypts the password and compares in constant time. */
71
+ protected checkPassword(user: User, password: string): Promise<boolean>;
72
+ /** Stores a new hash if the encryptor says the stored one needs a rehash and `updatePasswordHash` is set. */
73
+ protected rehashPassword(user: User, password: string): Promise<void>;
74
+ }
75
+ //# sourceMappingURL=email.password.auth.provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email.password.auth.provider.d.ts","sourceRoot":"","sources":["../../src/providers/email.password.auth.provider.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAoB,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,mCAAmC;AACnC,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C,+GAA+G;AAC/G,MAAM,WAAW,wBAAwB;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC,CAAC,IAAI;IAClD,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+FAA+F;IAC/F,SAAS,EAAE,UAAU,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,YAAY,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC;IAC7D,4DAA4D;IAC5D,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC;IACtE,uGAAuG;IACvG,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;IAChC,0GAA0G;IAC1G,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAC5D;;;OAGG;IACH,kBAAkB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CACjF;AAKD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,yBAAyB,CAAC,IAAI,GAAG,GAAG,CAAE,YAAW,aAAa,CAAC,IAAI,EAAE,wBAAwB,CAAC;IACvG,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC,GACpG,IAAI,CAAC,gCAAgC,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC;gBAE3D,OAAO,EAAE,gCAAgC,CAAC,IAAI,CAAC;IAa3D,OAAO,IAAI,MAAM;IAIjB,iDAAiD;IACjD,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,eAAe;IAQpC,QAAQ,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;cAmBzD,QAAQ,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAOhE,2GAA2G;cAC3F,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAc7E,6GAA6G;cAC7F,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAa9E"}
@@ -0,0 +1,120 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.EmailPasswordAuthProvider = void 0;
13
+ const crypto_1 = require("crypto");
14
+ const constants_1 = require("../constants");
15
+ const auth_user_1 = require("../interfaces/auth.user");
16
+ const defaultGetId = (user) => { var _a; return (_a = user === null || user === void 0 ? void 0 : user._id) !== null && _a !== void 0 ? _a : user === null || user === void 0 ? void 0 : user.id; };
17
+ const defaultGetPasswordHash = (user) => { var _a; return (_a = user === null || user === void 0 ? void 0 : user.passwordEncrypted) !== null && _a !== void 0 ? _a : user === null || user === void 0 ? void 0 : user.passwordHash; };
18
+ /**
19
+ * The auth provider of the users who log in with an email and a password. Your users keep their shape: give the
20
+ * functions that find and read them.
21
+ *
22
+ * ```ts
23
+ * new EmailPasswordAuthProvider<UserEntity>({
24
+ * encryptor,
25
+ * findById: (id) => users.findOneBy({ id }),
26
+ * findByEmail: (email) => users.findOneBy({ email }),
27
+ * getId: (user) => user.id,
28
+ * getPasswordHash: (user) => user.passwordHash
29
+ * });
30
+ * ```
31
+ *
32
+ * - login (`{ email, password }`): `findByEmail()`, then checks the password against the hash with the encryptor
33
+ * (and stores a new hash with `updatePasswordHash()` if the encryptor says it needs a rehash)
34
+ * - session or token payload (`{ sub, namespace }`): `findById()`
35
+ * - the payload of a user is `{ sub: getId(user), namespace }`
36
+ *
37
+ * @typeParam User your user type
38
+ */
39
+ class EmailPasswordAuthProvider {
40
+ constructor(options) {
41
+ var _a, _b, _c;
42
+ if (options.encryptor === undefined || options.encryptor === null) {
43
+ throw new Error('EmailPasswordAuthProvider requires an encryptor');
44
+ }
45
+ // `??` and not a spread: an option set to `undefined` keeps its default
46
+ this.options = Object.assign(Object.assign({}, options), { namespace: (_a = options.namespace) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_NAMESPACE, getId: (_b = options.getId) !== null && _b !== void 0 ? _b : defaultGetId, getPasswordHash: (_c = options.getPasswordHash) !== null && _c !== void 0 ? _c : defaultGetPasswordHash });
47
+ }
48
+ getName() {
49
+ return this.options.namespace;
50
+ }
51
+ /** Returns `{ sub: getId(user), namespace }`. */
52
+ serializeUser(user) {
53
+ const id = this.options.getId(user);
54
+ if (id === undefined || id === null) {
55
+ throw new Error(`EmailPasswordAuthProvider "${this.getName()}": the user has no id (set the getId option)`);
56
+ }
57
+ return { sub: id, namespace: this.getName() };
58
+ }
59
+ loadUser(data) {
60
+ return __awaiter(this, void 0, void 0, function* () {
61
+ var _a;
62
+ if (typeof data.password === 'string') {
63
+ const user = typeof data.email === 'string'
64
+ ? yield this.options.findByEmail(data.email)
65
+ : yield this.findById((0, auth_user_1.getPayloadUserId)(data));
66
+ if (user === undefined || user === null || !(yield this.checkPassword(user, data.password))) {
67
+ return undefined;
68
+ }
69
+ yield this.rehashPassword(user, data.password);
70
+ return user;
71
+ }
72
+ const id = (0, auth_user_1.getPayloadUserId)(data);
73
+ if (id !== undefined && id !== null) {
74
+ return yield this.findById(id);
75
+ }
76
+ return typeof data.email === 'string' ? ((_a = (yield this.options.findByEmail(data.email))) !== null && _a !== void 0 ? _a : undefined) : undefined;
77
+ });
78
+ }
79
+ findById(id) {
80
+ return __awaiter(this, void 0, void 0, function* () {
81
+ var _a;
82
+ if (id === undefined || id === null) {
83
+ return undefined;
84
+ }
85
+ return (_a = (yield this.options.findById(id))) !== null && _a !== void 0 ? _a : undefined;
86
+ });
87
+ }
88
+ /** Uses `encryptor.compare()` if implemented, else encrypts the password and compares in constant time. */
89
+ checkPassword(user, password) {
90
+ return __awaiter(this, void 0, void 0, function* () {
91
+ const hash = this.options.getPasswordHash(user);
92
+ if (typeof hash !== 'string' || hash === '') {
93
+ return false;
94
+ }
95
+ const { encryptor } = this.options;
96
+ if (typeof encryptor.compare === 'function') {
97
+ return yield encryptor.compare(password, hash);
98
+ }
99
+ const actual = Buffer.from(yield encryptor.encrypt(password));
100
+ const expected = Buffer.from(hash);
101
+ return actual.length === expected.length && (0, crypto_1.timingSafeEqual)(actual, expected);
102
+ });
103
+ }
104
+ /** Stores a new hash if the encryptor says the stored one needs a rehash and `updatePasswordHash` is set. */
105
+ rehashPassword(user, password) {
106
+ return __awaiter(this, void 0, void 0, function* () {
107
+ const { encryptor, updatePasswordHash, getPasswordHash } = this.options;
108
+ const hash = getPasswordHash(user);
109
+ if (typeof encryptor.needsRehash === 'function' &&
110
+ updatePasswordHash !== undefined &&
111
+ typeof hash === 'string') {
112
+ if (encryptor.needsRehash(hash)) {
113
+ yield updatePasswordHash(user, yield encryptor.encrypt(password));
114
+ }
115
+ }
116
+ });
117
+ }
118
+ }
119
+ exports.EmailPasswordAuthProvider = EmailPasswordAuthProvider;
120
+ //# sourceMappingURL=email.password.auth.provider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"email.password.auth.provider.js","sourceRoot":"","sources":["../../src/providers/email.password.auth.provider.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAAyC;AAEzC,4CAAiD;AACjD,uDAA4E;AA4C5E,MAAM,YAAY,GAAG,CAAC,IAAS,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,mCAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAA,EAAA,CAAC;AAC1D,MAAM,sBAAsB,GAAG,CAAC,IAAS,EAAE,EAAE,WAAC,OAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,iBAAiB,mCAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,CAAA,EAAA,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,yBAAyB;IAIlC,YAAY,OAA+C;;QACvD,IAAI,OAAO,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;QACD,wEAAwE;QACxE,IAAI,CAAC,OAAO,mCACL,OAAO,KACV,SAAS,EAAE,MAAA,OAAO,CAAC,SAAS,mCAAI,6BAAiB,EACjD,KAAK,EAAE,MAAA,OAAO,CAAC,KAAK,mCAAI,YAAY,EACpC,eAAe,EAAE,MAAA,OAAO,CAAC,eAAe,mCAAI,sBAAsB,GACrE,CAAC;IACN,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAClC,CAAC;IAED,iDAAiD;IACjD,aAAa,CAAC,IAAU;QACpB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,OAAO,EAAE,8CAA8C,CAAC,CAAC;QAChH,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;IAClD,CAAC;IAEK,QAAQ,CAAC,IAA8B;;;YACzC,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACpC,MAAM,IAAI,GACN,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;oBAC1B,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;oBAC5C,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAA,4BAAgB,EAAC,IAAI,CAAC,CAAC,CAAC;gBACtD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;oBAC1F,OAAO,SAAS,CAAC;gBACrB,CAAC;gBACD,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC/C,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,EAAE,GAAG,IAAA,4BAAgB,EAAC,IAAI,CAAC,CAAC;YAClC,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;gBAClC,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAA,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,mCAAI,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpH,CAAC;KAAA;IAEe,QAAQ,CAAC,EAAW;;;YAChC,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;gBAClC,OAAO,SAAS,CAAC;YACrB,CAAC;YACD,OAAO,MAAA,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,mCAAI,SAAS,CAAC;QAC1D,CAAC;KAAA;IAED,2GAA2G;IAC3F,aAAa,CAAC,IAAU,EAAE,QAAgB;;YACtD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;YAChD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gBAC1C,OAAO,KAAK,CAAC;YACjB,CAAC;YACD,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACnC,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAC1C,OAAO,MAAM,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACnD,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,IAAA,wBAAe,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClF,CAAC;KAAA;IAED,6GAA6G;IAC7F,cAAc,CAAC,IAAU,EAAE,QAAgB;;YACvD,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACxE,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YACnC,IACI,OAAO,SAAS,CAAC,WAAW,KAAK,UAAU;gBAC3C,kBAAkB,KAAK,SAAS;gBAChC,OAAO,IAAI,KAAK,QAAQ,EAC1B,CAAC;gBACC,IAAI,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9B,MAAM,kBAAkB,CAAC,IAAI,EAAE,MAAM,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACtE,CAAC;YACL,CAAC;QACL,CAAC;KAAA;CACJ;AArFD,8DAqFC"}
@@ -1,10 +1,43 @@
1
- import { MemoryUser } from '../classes/memory.user';
2
1
  import { IUserProvider } from '../interfaces/provider';
3
- export declare class MemoryUserProvider<U extends MemoryUser> implements IUserProvider<U> {
2
+ /** Options of the {@link MemoryUserProvider}: how to read your users. */
3
+ export interface MemoryUserProviderOptions<User> {
4
+ /** Default: `user._id ?? user.id`. */
5
+ getId?: (user: User) => unknown;
6
+ /** Default: `user.email`. */
7
+ getEmail?: (user: User) => string | undefined;
8
+ /** Default: sets `passwordEncrypted` if the user has it, else `passwordHash`. */
9
+ setPasswordHash?: (user: User, passwordHash: string) => void;
10
+ }
11
+ /** Injection token of the options of a {@link MemoryUserProvider} created by dependency injection. */
12
+ export declare const MEMORY_USER_PROVIDER_OPTIONS = "nestjs-authentication:memory-user-provider.options";
13
+ /**
14
+ * Keeps users in memory: for tests, prototypes and a few static users. Your users keep their shape.
15
+ *
16
+ * ```ts
17
+ * const users = new MemoryUserProvider<User>({ getId: (u) => u.id }).registerUser(john);
18
+ * new EmailPasswordAuthProvider<User>({
19
+ * encryptor,
20
+ * findById: (id) => users.findById(id),
21
+ * findByEmail: (email) => users.findByEmail(email),
22
+ * updatePasswordHash: (user, hash) => users.updatePassword(user, hash)
23
+ * });
24
+ * ```
25
+ */
26
+ export declare class MemoryUserProvider<User = any> implements IUserProvider<User> {
4
27
  private readonly users;
5
- findOne<S extends {
6
- [key in keyof U]: any;
7
- }>(data: S): Promise<U | undefined>;
8
- registerUser(user: U): MemoryUserProvider<U>;
28
+ protected readonly getId: (user: User) => unknown;
29
+ protected readonly getEmail: (user: User) => string | undefined;
30
+ protected readonly setPasswordHash: (user: User, passwordHash: string) => void;
31
+ constructor(options?: MemoryUserProviderOptions<User>);
32
+ findById(id: unknown): Promise<User | undefined>;
33
+ findByEmail(email: string): Promise<User | undefined>;
34
+ /** Finds a user by `_id`, or by `email` if the query has no `_id` (see {@link IUserProvider}). */
35
+ findOne(query: Record<string, unknown>): Promise<User | undefined>;
36
+ /** Adds a user, or replaces the user with the same id. */
37
+ registerUser(user: User): this;
38
+ /** Sets the password hash of a user. */
39
+ updatePassword(user: User, passwordHash: string): void;
40
+ /** Removes a user. Returns `true` if it existed. */
41
+ removeUser(user: Partial<User>): boolean;
9
42
  }
10
43
  //# sourceMappingURL=memory.user.provider.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"memory.user.provider.d.ts","sourceRoot":"","sources":["../../src/providers/memory.user.provider.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,qBACa,kBAAkB,CAAC,CAAC,SAAS,UAAU,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC;IAC7E,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;IAE7C,OAAO,CAAC,CAAC,SAAS;SAAG,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG;KAAE,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAYnF,YAAY,CAAC,IAAI,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAI/C"}
1
+ {"version":3,"file":"memory.user.provider.d.ts","sourceRoot":"","sources":["../../src/providers/memory.user.provider.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,yEAAyE;AACzE,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC3C,sCAAsC;IACtC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;IAChC,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,GAAG,SAAS,CAAC;IAC9C,iFAAiF;IACjF,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CAChE;AAED,sGAAsG;AACtG,eAAO,MAAM,4BAA4B,uDAAuD,CAAC;AAEjG;;;;;;;;;;;;GAYG;AACH,qBACa,kBAAkB,CAAC,IAAI,GAAG,GAAG,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;IACtE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgC;IACtD,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC;IAClD,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,GAAG,SAAS,CAAC;IAChE,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;gBAEjB,OAAO,GAAE,yBAAyB,CAAC,IAAI,CAAM;IAcrG,QAAQ,CAAC,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAIhD,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAS3D,kGAAkG;IAC5F,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAOxE,0DAA0D;IAC1D,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAK9B,wCAAwC;IACxC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAItD,oDAAoD;IACpD,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO;CAG3C"}