@adminforth/email-invite 1.0.1

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/tsconfig.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include*/
4
+ "module": "node16", /* Specify what module code is generated. */
5
+ "outDir": "./dist", /* Specify an output folder for all emitted files. */
6
+ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. */
7
+ "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
8
+ "strict": false, /* Enable all strict type-checking options. */
9
+ "skipLibCheck": true, /* Skip type checking all .d.ts files. */
10
+ },
11
+ "exclude": ["node_modules", "dist", "custom"], /* Exclude files from compilation. */
12
+ }
13
+
package/types.ts ADDED
@@ -0,0 +1,31 @@
1
+ import type { EmailAdapter } from "adminforth";
2
+
3
+ export interface PluginOptions {
4
+ /**
5
+ * Field name in auth resource which contains email
6
+ */
7
+ emailField: string;
8
+
9
+ /**
10
+ * From which email to send invite emails
11
+ * e.g. no-reply@example.com
12
+ */
13
+ sendFrom: string;
14
+
15
+ /**
16
+ * Field name in auth resource which contains password
17
+ */
18
+ passwordField: string;
19
+
20
+ /**
21
+ * Email adapter to use for sending emails
22
+ */
23
+ adapter: EmailAdapter;
24
+
25
+ /**
26
+ * Field name in auth resource which stores email confirmation status
27
+ * If provided, email will be marked as confirmed when user sets password via invite
28
+ * e.g. 'email_confirmed'
29
+ */
30
+ emailConfirmedField?: string;
31
+ }