node_modules ignore

server/node_modules/@strapi/admin/dist/shared/contracts/authentication.d.ts

@@ -0,0 +1,129 @@
+import type { AdminUser, SanitizedAdminUser } from './shared';
+import type { errors } from '@strapi/utils';
+/**
+ * /login - Log in as an admin user
+ */
+export declare namespace Login {
+    interface Request {
+        query: {
+            user: Pick<AdminUser, 'email' | 'password'>;
+        };
+        body: Pick<AdminUser, 'email' | 'password'>;
+    }
+    interface Response {
+        data: {
+            token: string;
+            user: Omit<SanitizedAdminUser, 'permissions'>;
+        };
+        errors?: errors.ApplicationError | errors.NotImplementedError;
+    }
+}
+/**
+ * /renew-token - Renew an admin user's token
+ */
+export declare namespace RenewToken {
+    interface Request {
+        body: {
+            token: string;
+        };
+    }
+    interface Response {
+        data: {
+            token: string;
+        };
+        errors?: errors.ApplicationError | errors.ValidationError<'Invalid token'>;
+    }
+}
+/**
+ * /registration-info - Get the info via a registration token
+ */
+export declare namespace RegistrationInfo {
+    interface Request {
+        query: {
+            registrationToken: string;
+        };
+    }
+    interface Response {
+        data: {
+            email?: string;
+            firstname?: string;
+            lastname?: string;
+        };
+        errors?: errors.ApplicationError | errors.ValidationError<'Invalid registrationToken'>;
+    }
+}
+/**
+ * /register - Register an admin user
+ */
+export declare namespace Register {
+    interface Request {
+        body: {
+            registrationToken: string;
+            userInfo: Pick<AdminUser, 'firstname' | 'lastname' | 'email' | 'password'>;
+        };
+    }
+    interface Response {
+        data: {
+            token: string;
+            user: Omit<SanitizedAdminUser, 'permissions'>;
+        };
+        errors?: errors.ApplicationError | errors.YupValidationError;
+    }
+}
+/**
+ * /register-admin - Register an admin user
+ */
+export declare namespace RegisterAdmin {
+    interface Request {
+        body: Pick<AdminUser, 'email' | 'firstname' | 'lastname' | 'password'>;
+    }
+    interface Response {
+        data: {
+            token: string;
+            user: Omit<SanitizedAdminUser, 'permissions'>;
+        };
+        errors?: errors.ApplicationError | errors.YupValidationError;
+    }
+}
+/**
+ * /forgot-password - Send a password reset email
+ */
+export declare namespace ForgotPassword {
+    interface Request {
+        body: {
+            email: string;
+        };
+    }
+    interface Response {
+    }
+}
+/**
+ * /reset-password - Reset a password
+ */
+export declare namespace ResetPassword {
+    interface Request {
+        body: {
+            resetPasswordToken: string;
+            password: string;
+        };
+    }
+    interface Response {
+        data: {
+            token: string;
+            user: Omit<SanitizedAdminUser, 'permissions'>;
+        };
+    }
+}
+/**
+ * /logout - Log out an admin user
+ */
+export declare namespace Logout {
+    interface Request {
+        query: {
+            token: string;
+        };
+    }
+    interface Response {
+        data: {};
+    }
+}