@sqrzro/server 2.0.0-bz.1 → 2.0.0-bz.11

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2023 Richard Carter
+Copyright 2024 Richard Carter
 
 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
 

package/README.md

@@ -1 +1,25 @@
-Square Zero Components
+<div align="center">
+
+<h1>
+    <img src="assets/logo.svg" alt="" width="64" style="margin-bottom: 5px">
+    <br />
+    Square Zero Server
+</h1>
+
+</div>  
+  
+<hr />
+
+## @sqrzro/server/auth
+
+## @sqrzro/server/cache
+
+## @sqrzro/server/db
+
+## @sqrzro/server/forms
+
+## @sqrzro/server/lists
+
+## @sqrzro/server/mail
+
+## @sqrzro/server/url

package/auth.d.ts

@@ -0,0 +1 @@
+export * from './dist/auth/index';

package/auth.js

@@ -0,0 +1 @@
+module.exports = require('./dist/auth/index');

package/cache.d.ts

@@ -0,0 +1 @@
+export * from './dist/cache/index';

package/cache.js

@@ -0,0 +1 @@
+module.exports = require('./dist/cache/index');

package/dist/auth.d.ts

@@ -0,0 +1,100 @@
+import { Errorable } from '@sqrzro/interfaces';
+import { NextRequest, NextResponse } from 'next/server';
+import { AuthClient, Scope } from './schema.js';
+import { Lucia } from 'lucia';
+import 'drizzle-orm/pg-core';
+
+interface LoginFormFields {
+    email: string;
+    password: string;
+}
+interface MFAFormFields {
+    token: string;
+}
+interface PasswordFormFields {
+    email: string;
+}
+interface PasswordResetFormFields {
+    password: string;
+    token: string;
+}
+interface UserObject {
+    id: string;
+    email: string;
+    password?: string | null;
+    role?: number;
+}
+
+declare function handleLogout(): Promise<void>;
+declare function getAllowedRoles(): number[];
+declare function handleLoginForm(formData: LoginFormFields): Promise<Errorable<string>>;
+interface RegisterUserArgs {
+    email: string;
+    password?: string;
+    role?: number;
+}
+declare function registerUser({ email, password, role, }: RegisterUserArgs): Promise<UserObject | null>;
+declare function handlePasswordForm(formData: PasswordFormFields, mailFn: (email: string, token: string) => Promise<boolean>): Promise<Errorable<boolean>>;
+declare function handlePasswordResetForm(formData: PasswordResetFormFields): Promise<Errorable<string | null>>;
+
+declare function getClientByID(id: string): Promise<AuthClient | null>;
+interface RegisterClientArgs {
+    alias: string;
+    id?: string;
+    secret?: string;
+}
+declare function registerClient({ alias, id, secret, }: RegisterClientArgs): Promise<AuthClient | null>;
+declare function handleClientAuth(request: NextRequest): Promise<AuthClient | null>;
+
+declare function checkMFAEnabled(): boolean;
+declare function generateMFA(name: string, email?: string): Promise<string | null>;
+declare function checkUserHasMFA(user: UserObject): Promise<boolean>;
+declare function handleMFAForm(formData: MFAFormFields): Promise<Errorable<boolean>>;
+
+interface ScopeData {
+    allowedRoute?: string;
+    redirectOnAuth?: string;
+    redirectOnUnauth?: string;
+}
+type ScopeObject = Record<Scope, ScopeData>;
+interface DatabaseSessionAttributes {
+    scope: Scope;
+}
+interface DatabaseUserAttributes {
+    email: string;
+    role: number;
+}
+declare module 'lucia' {
+    interface Register {
+        Lucia: typeof lucia;
+        DatabaseSessionAttributes: DatabaseSessionAttributes;
+        DatabaseUserAttributes: DatabaseUserAttributes;
+    }
+}
+declare const lucia: Lucia<DatabaseSessionAttributes, DatabaseUserAttributes>;
+declare function generateID(length?: number): string;
+declare function invalidateSession(id: string): Promise<void>;
+declare function invalidateUserSessions(id: string): Promise<void>;
+declare function createUserSession(id: string, scope?: Scope): Promise<boolean>;
+declare function getSessionID(): string | null;
+declare function checkSessionExists(): boolean;
+declare function getSessionUser(): Promise<{
+    id: string;
+    email: string;
+    role: number;
+} | null>;
+declare function checkRouteAllowed(pathname: string, route?: string): boolean;
+declare function getScopes(): Promise<ScopeObject>;
+declare function getScopeByID(id: Scope): Promise<ScopeData>;
+declare function setScopes(customScopes?: Partial<ScopeObject>): Promise<void>;
+declare function handleSession(request: NextRequest, customScopes?: Partial<ScopeObject>): Promise<NextResponse>;
+
+type PasswordRule = 'lower' | 'min' | 'number' | 'symbol' | 'upper';
+type PasswordRuleObject = Partial<Record<PasswordRule, number>>;
+type PasswordValidityObject = Record<PasswordRule, boolean>;
+declare function hashPassword(password: string): Promise<string>;
+declare function verifyPassword(data?: string, encrypted?: string): Promise<boolean>;
+declare function getPasswordComplexity(password: string, rules?: Partial<PasswordRuleObject>): Promise<Partial<PasswordValidityObject>>;
+declare function checkPasswordComplexity(password: string, rules?: Partial<PasswordRuleObject>): Promise<Partial<boolean>>;
+
+export { type LoginFormFields, type MFAFormFields, type PasswordFormFields, type PasswordResetFormFields, type PasswordRuleObject, type ScopeObject, type UserObject, checkMFAEnabled, checkPasswordComplexity, checkRouteAllowed, checkSessionExists, checkUserHasMFA, createUserSession, generateID, generateMFA, getAllowedRoles, getClientByID, getPasswordComplexity, getScopeByID, getScopes, getSessionID, getSessionUser, handleClientAuth, handleLoginForm, handleLogout, handleMFAForm, handlePasswordForm, handlePasswordResetForm, handleSession, hashPassword, invalidateSession, invalidateUserSessions, lucia, registerClient, registerUser, setScopes, verifyPassword };