@adminforth/email-invite 1.1.3 → 1.1.4

package/build.log

@@ -7,5 +7,5 @@ custom/
 custom/SetPassword.vue
 custom/tsconfig.json
 
-sent 14,973 bytes  received 58 bytes  30,062.00 bytes/sec
+sent 14,976 bytes  received 58 bytes  30,068.00 bytes/sec
 total size is 14,761  speedup is 0.98

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthResource, AdminUser, HttpExtra } from "adminforth";
+import type { PluginOptions } from './types.js';
+export default class EmailInvitePlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    authResource: AdminForthResource;
+    emailField: AdminForthResourceColumn;
+    emailConfirmedField?: AdminForthResourceColumn;
+    constructor(options: PluginOptions);
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    handleUserCreation({ resource, adminUser, record, adminforth, extra }: {
+        resource: AdminForthResource;
+        adminUser: AdminUser;
+        record: any;
+        adminforth: IAdminForth;
+        extra?: HttpExtra;
+    }): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    sendInviteEmail({ recordId, resource, record, adminUser, adminforth, extra }: {
+        recordId: any;
+        resource: AdminForthResource;
+        record: any;
+        adminUser: AdminUser;
+        adminforth: IAdminForth;
+        extra?: HttpExtra;
+    }): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    setupEndpoints(server: IHttpServer): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,27 @@
+import type { EmailAdapter } from "adminforth";
+import { type PluginsCommonOptions } from "adminforth";
+export interface PluginOptions extends PluginsCommonOptions {
+    /**
+     * Field name in auth resource which contains email
+     */
+    emailField: string;
+    /**
+     * From which email to send invite emails
+     * e.g. no-reply@example.com
+     */
+    sendFrom: string;
+    /**
+     * Field name in auth resource which contains password
+     */
+    passwordField: string;
+    /**
+     * Email adapter to use for sending emails
+     */
+    adapter: EmailAdapter;
+    /**
+     * Field name in auth resource which stores email confirmation status
+     * If provided, email will be marked as confirmed when user sets password via invite
+     * e.g. 'email_confirmed'
+     */
+    emailConfirmedField?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/email-invite",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/tsconfig.json

@@ -2,6 +2,7 @@
     "compilerOptions": {
       "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
       "module": "node16",                                /* Specify what module code is generated. */
+    "declaration": true,
       "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
       "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
       "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */