@adminforth/open-signup 1.2.17 → 1.2.19

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { AdminForthPlugin } from "adminforth";
+import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthResource, HttpExtra } from "adminforth";
+import type { PluginOptions } from './types.js';
+export default class OpenSignupPlugin extends AdminForthPlugin {
+    options: PluginOptions;
+    emailField: AdminForthResourceColumn;
+    passwordField: AdminForthResourceColumn;
+    authResource: AdminForthResource;
+    emailConfirmedField?: AdminForthResourceColumn;
+    adminforth: IAdminForth;
+    constructor(options: PluginOptions);
+    modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource): Promise<void>;
+    validateConfigAfterDiscover(adminforth: IAdminForth, resourceConfig: AdminForthResource): void;
+    instanceUniqueRepresentation(pluginOptions: any): string;
+    doLogin(email: string, response: any, extra: HttpExtra): Promise<{
+        error?: string;
+        allowedLogin: boolean;
+        redirectTo?: string;
+    }>;
+    setupEndpoints(server: IHttpServer): void;
+}

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+import { EmailAdapter } from 'adminforth';
+import { type PluginsCommonOptions } from "adminforth";
+export interface PluginOptions extends PluginsCommonOptions {
+    /**
+     * Field name in auth resource which contains email
+     */
+    emailField: string;
+    /**
+     * To work properly, this plugin requires a virtual password field in auth resource,
+     * which will define any constraints which determine the password strength (regex, minLength).
+     * When user will enter passowrd, it will be validated against this field constraints
+     * If you don't need it in backoffice itself, you can add it and set showIn = []
+     */
+    passwordField: string;
+    /**
+     * Non-virtual field name in auth resource which contains password hash
+     */
+    passwordHashField: string;
+    /**
+     * Default which will be assigned to user by default
+     * e.g. can be used to set default role
+     */
+    defaultFieldValues?: {
+        [key: string]: any;
+    };
+    /**
+     * If not set user will not be asked for email confirmation (might be dangerous)
+     */
+    confirmEmails?: {
+        /**
+         * A boolean field in auth resource which will be set to true when email is confirmed.
+         * Must have boolean type.
+         */
+        emailConfirmedField: string;
+        /**
+         * From which email to send password reset emails
+         * e.g. no-reply@example.com
+         * Example.com must be allowed in provider to send emails
+         */
+        sendFrom: string;
+        /**
+         * Adapter to send emails
+         */
+        adapter: EmailAdapter;
+    };
+    /**
+     * Hooks to be executed before and after user is created
+     */
+    hooks?: {
+        beforeUserSave?: any;
+        afterUserSave?: any;
+    };
+    /**
+     * Signup component order inder login button
+     */
+    loginPageComponentOrder?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/open-signup",
-  "version": "1.2.17",
+  "version": "1.2.19",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -26,11 +26,11 @@
     "@aws-sdk/client-ses": "^3.654.0"
   },
   "peerDependencies": {
-    "adminforth": "2.71.1"
+    "adminforth": "3.0.1"
   },
   "devDependencies": {
     "@types/node": "^22.10.7",
-    "adminforth": "2.71.1",
+    "adminforth": "3.0.1",
     "semantic-release": "^24.2.1",
     "semantic-release-slack-bot": "^4.0.2",
     "typescript": "^5.7.3"

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. */