studiocms 0.1.0-beta.24 → 0.1.0-beta.26

package/dist/lib/auth/encryption.js

@@ -1,83 +0,0 @@
-import { CMS_ENCRYPTION_KEY } from "astro:env/server";
-import { createCipheriv, createDecipheriv } from "node:crypto";
-import { DynamicBuffer } from "@oslojs/binary";
-import { decodeBase64 } from "@oslojs/encoding";
-import { Data, Effect } from "effect";
-import { genLogger, pipeLogger } from "../effects/index.js";
-class EncryptionError extends Data.TaggedError("EncryptionError") {
-}
-class Encryption extends Effect.Service()(
-  "studiocms/lib/auth/encryption/Encryption",
-  {
-    effect: genLogger("studiocms/lib/auth/encryption/Encryption.effect")(function* () {
-      const getKey = pipeLogger("studiocms/lib/auth/encryption/Encryption.getKey")(
-        Effect.try({
-          try: () => decodeBase64(CMS_ENCRYPTION_KEY),
-          catch: (cause) => new EncryptionError({
-            message: `An Error occurred while getting the encryption key: ${cause}`
-          })
-        })
-      );
-      const _key = yield* getKey;
-      const _algorithm = "aes-128-gcm";
-      const encrypt = (data) => pipeLogger("studiocms/lib/auth/encryption/Encryption.encrypt")(
-        Effect.try({
-          try: () => {
-            const iv = new Uint8Array(16);
-            crypto.getRandomValues(iv);
-            const cipher = createCipheriv(_algorithm, _key, iv);
-            const encrypted = new DynamicBuffer(0);
-            encrypted.write(iv);
-            encrypted.write(cipher.update(data));
-            encrypted.write(cipher.final());
-            encrypted.write(cipher.getAuthTag());
-            return encrypted.bytes();
-          },
-          catch: (cause) => new EncryptionError({ message: `An error occurred when encrypting data: ${cause}` })
-        })
-      );
-      const encryptToString = (data) => genLogger("studiocms/lib/auth/encryption/Encryption.encryptToString")(function* () {
-        const encodedData = yield* Effect.try({
-          try: () => new TextEncoder().encode(data),
-          catch: (cause) => new EncryptionError({ message: `An error occurred when encrypting data: ${cause}` })
-        });
-        return yield* encrypt(encodedData);
-      });
-      const decrypt = (data) => pipeLogger("studiocms/lib/auth/encryption/Encryption.decrypt")(
-        Effect.try({
-          try: () => {
-            if (data.byteLength < 33) {
-              throw new Error("Invalid data");
-            }
-            const decipher = createDecipheriv(_algorithm, _key, data.slice(0, 16));
-            decipher.setAuthTag(data.slice(data.byteLength - 16));
-            const decrypted = new DynamicBuffer(0);
-            decrypted.write(decipher.update(data.slice(16, data.byteLength - 16)));
-            decrypted.write(decipher.final());
-            return decrypted.bytes();
-          },
-          catch: (cause) => new EncryptionError({ message: `An error occurred when decrypting data: ${cause}` })
-        })
-      );
-      const decryptToString = (data) => genLogger("studiocms/lib/auth/encryption/Encryption.decryptToString")(function* () {
-        const decrypted = yield* decrypt(data);
-        return yield* Effect.try({
-          try: () => new TextDecoder().decode(decrypted),
-          catch: (cause) => new EncryptionError({ message: `An error occurred when decrypting data: ${cause}` })
-        });
-      });
-      return {
-        encrypt,
-        encryptToString,
-        decrypt,
-        decryptToString
-      };
-    })
-  }
-) {
-  static Provide = Effect.provide(this.Default);
-}
-export {
-  Encryption,
-  EncryptionError
-};

package/dist/lib/auth/index.js

@@ -1,12 +0,0 @@
-import { Encryption } from "./encryption.js";
-import { Password } from "./password.js";
-import { Session } from "./session.js";
-import { User } from "./user.js";
-import { VerifyEmail } from "./verify-email.js";
-export {
-  Encryption,
-  Password,
-  Session,
-  User,
-  VerifyEmail
-};

package/dist/lib/auth/password.d.ts

@@ -1,45 +0,0 @@
-import { HttpClient } from '@effect/platform';
-import { Effect } from 'effect';
-import { Scrypt } from './utils/scrypt.js';
-import { CheckIfUnsafe, type CheckIfUnsafeError } from './utils/unsafeCheck.js';
-declare const PasswordError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
-    readonly _tag: "PasswordError";
-} & Readonly<A>;
-export declare class PasswordError extends PasswordError_base<{
-    message: string;
-}> {
-}
-declare const Password_base: Effect.Service.Class<Password, "studiocms/lib/auth/password/Password", {
-    readonly effect: Effect.Effect<{
-        hashPassword: (password: string, _salt?: string) => Effect.Effect<string, import("./utils/scrypt.js").ScryptError, never>;
-        verifyPasswordHash: (hash: string, password: string) => Effect.Effect<boolean, import("./utils/scrypt.js").ScryptError | PasswordError, never>;
-        verifyPasswordStrength: (password: string) => Effect.Effect<string | true, import("@effect/platform/HttpClientError").ResponseError | CheckIfUnsafeError | PasswordError, never>;
-    }, never, HttpClient.HttpClient | Scrypt | CheckIfUnsafe>;
-    readonly dependencies: readonly [import("effect/Layer").Layer<Scrypt, never, never>, import("effect/Layer").Layer<CheckIfUnsafe, never, never>, import("effect/Layer").Layer<HttpClient.HttpClient, never, never>];
-}>;
-/**
- * The `Password` class provides methods for hashing passwords, verifying password hashes,
- * and checking the strength of passwords. It includes functionality for ensuring passwords
- * meet security standards, such as length requirements, avoiding unsafe passwords, and
- * checking against the pwned password database.
- *
- * ### Methods:
- * - `hashPassword`: Hashes a plain text password using a secure algorithm.
- * - `verifyPasswordHash`: Verifies if a plain text password matches a hashed password.
- * - `verifyPasswordStrength`: Checks if a password meets strength requirements, including
- *   length, safety, and absence from the pwned password database.
- *
- * ### Dependencies:
- * - `Scrypt`: Used for password hashing.
- * - `CheckIfUnsafe`: Used to check if a password is a commonly known unsafe password.
- * - `FetchHttpClient`: Used for making HTTP requests to external services, such as the
- *   pwned password database API.
- *
- * ### Notes:
- * - The `constantTimeEqual` function ensures secure string comparison to prevent timing
- *   attacks.
- */
-export declare class Password extends Password_base {
-    static Provide: <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Password>>;
-}
-export {};

package/dist/lib/auth/password.js

@@ -1,113 +0,0 @@
-import crypto from "node:crypto";
-import { FetchHttpClient, HttpClient } from "@effect/platform";
-import { sha1 } from "@oslojs/crypto/sha1";
-import { encodeHexLowerCase } from "@oslojs/encoding";
-import { Data, Effect } from "effect";
-import { genLogger, pipeLogger } from "../effects/index.js";
-import { Scrypt } from "./utils/scrypt.js";
-import { CheckIfUnsafe } from "./utils/unsafeCheck.js";
-class PasswordError extends Data.TaggedError("PasswordError") {
-}
-class Password extends Effect.Service()("studiocms/lib/auth/password/Password", {
-  effect: genLogger("studiocms/lib/auth/password/Password.effect")(function* () {
-    const scrypt = yield* Scrypt;
-    const check = yield* CheckIfUnsafe;
-    const client = yield* HttpClient.HttpClient;
-    const constantTimeEqual = (a, b) => {
-      if (a.length !== b.length) return false;
-      let result = 0;
-      for (let i = 0; i < a.length; i++) {
-        result |= a.charCodeAt(i) ^ b.charCodeAt(i);
-      }
-      return result === 0;
-    };
-    const hashPassword = (password, _salt) => genLogger("studiocms/lib/auth/password/Password.hashPassword")(function* () {
-      const salt = _salt || crypto.randomBytes(16).toString("hex");
-      const hashed = yield* scrypt.run(password + salt);
-      return `gen1.0:${salt}:${hashed.toString("hex")}`;
-    });
-    const verifyPasswordHash = (hash, password) => genLogger("studiocms/lib/auth/password/Password.verifyPasswordHash")(function* () {
-      if (!hash.startsWith("gen1.0:")) {
-        yield* Effect.fail(
-          new PasswordError({
-            message: "Legacy password hashes are not supported. Please reset any legacy passwords."
-          })
-        );
-      }
-      const [_prefix, salt] = hash.split(":", 3);
-      const newHash = yield* hashPassword(password, salt);
-      return constantTimeEqual(hash, newHash);
-    });
-    const verifyPasswordLength = (pass) => pipeLogger("studiocms/lib/auth/password/Password.verifyPasswordLength")(
-      Effect.try({
-        try: () => {
-          if (pass.length < 6 || pass.length > 255) {
-            return "Password must be between 6 and 255 characters long.";
-          }
-          return void 0;
-        },
-        catch: (cause) => new PasswordError({
-          message: `An unknown Error occurred when checking the password length: ${cause}`
-        })
-      })
-    );
-    const verifySafe = (pass) => genLogger("studiocms/lib/auth/password/Password.verifySafe")(function* () {
-      const isUnsafe = yield* check.password(pass);
-      if (isUnsafe) {
-        return "Password must not be a commonly known unsafe password (admin, root, etc.)";
-      }
-      return void 0;
-    });
-    const checkPwnedDB = (pass) => genLogger("studiocms/lib/auth/password/Password.checkPwnedDB")(function* () {
-      const encodedData = new TextEncoder().encode(pass);
-      const sha1Hash = sha1(encodedData);
-      const hashHex = encodeHexLowerCase(sha1Hash);
-      const hashPrefix = hashHex.slice(0, 5);
-      const response = yield* client.get(`https://api.pwnedpasswords.com/range/${hashPrefix}`).pipe(
-        Effect.catchTags({
-          RequestError: () => Effect.succeed({ text: Effect.succeed(""), status: 500 }),
-          ResponseError: () => Effect.succeed({ text: Effect.succeed(""), status: 500 })
-        })
-      );
-      if (response.status >= 400) {
-        return;
-      }
-      const data = yield* response.text;
-      const lines = data.split("\n");
-      for (const line of lines) {
-        const hashSuffix = line.slice(0, 35).toLowerCase();
-        if (hashHex === hashPrefix + hashSuffix) {
-          return 'Password must not be in the <a href="https://haveibeenpwned.com/Passwords" target="_blank">pwned password database</a>.';
-        }
-      }
-      return;
-    });
-    const verifyPasswordStrength = (password) => genLogger("studiocms/lib/auth/password/Password.verifyPasswordStrength")(function* () {
-      const lengthCheck = yield* verifyPasswordLength(password);
-      if (lengthCheck) {
-        return lengthCheck;
-      }
-      const unsafeCheck = yield* verifySafe(password);
-      if (unsafeCheck) {
-        return unsafeCheck;
-      }
-      const pwnedCheck = yield* checkPwnedDB(password);
-      if (pwnedCheck) {
-        return pwnedCheck;
-      }
-      return true;
-    });
-    return {
-      hashPassword,
-      verifyPasswordHash,
-      verifyPasswordStrength
-    };
-  }),
-  dependencies: [Scrypt.Default, CheckIfUnsafe.Default, FetchHttpClient.layer]
-}) {
-  static Provide = Effect.provide(this.Default);
-}
-export {
-  Password,
-  PasswordError
-};

package/dist/lib/auth/session.d.ts

@@ -1,77 +0,0 @@
-import type { APIContext, AstroGlobal } from 'astro';
-import { Effect } from 'effect';
-import type { SessionValidationResult } from './types.js';
-declare const SessionError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
-    readonly _tag: "SessionError";
-} & Readonly<A>;
-export declare class SessionError extends SessionError_base<{
-    message: string;
-}> {
-}
-/**
- * The session expiration time in milliseconds.
- * This value represents 14 days.
- */
-export declare const sessionExpTime: number;
-/**
- * The name of the cookie used to store the authentication session.
- *
- * @constant {string}
- */
-export declare const sessionCookieName = "auth_session";
-declare const Session_base: Effect.Service.Class<Session, "studiocms/lib/auth/session/Session", {
-    readonly effect: Effect.Effect<{
-        generateSessionToken: () => Effect.Effect<string, SessionError, never>;
-        makeExpirationDate: () => Effect.Effect<Date, SessionError, never>;
-        createSession: (token: string, userId: string) => Effect.Effect<{
-            id: string;
-            userId: string;
-            expiresAt: Date;
-        }, import("../../sdk/errors.js").SDKCoreError | SessionError, never>;
-        validateSessionToken: (token: string) => Effect.Effect<SessionValidationResult, import("../../sdk/errors.js").SDKCoreError | SessionError, never>;
-        invalidateSession: (sessionId: string) => Effect.Effect<{
-            status: string;
-            message: string;
-        }, import("../../sdk/errors.js").SDKCoreError, never>;
-        setSessionTokenCookie: (context: APIContext, token: string, expiresAt: Date) => Effect.Effect<void, SessionError, never>;
-        deleteSessionTokenCookie: (context: APIContext | AstroGlobal) => Effect.Effect<void, SessionError, never>;
-        setOAuthSessionTokenCookie: (context: APIContext, key: string, value: string) => Effect.Effect<void, SessionError, never>;
-        createUserSession: (userId: string, context: APIContext) => Effect.Effect<void, import("../../sdk/errors.js").SDKCoreError | SessionError, never>;
-    }, never, never>;
-    readonly dependencies: readonly [];
-}>;
-/**
- * The `Session` class provides a set of methods for managing user sessions, including
- * creating, validating, and invalidating sessions, as well as handling session cookies.
- *
- * This class is built using the `Effect.Service` pattern and relies on the `SDKCore`
- * dependency for database interactions. It includes utility functions for generating
- * session tokens, managing expiration dates, and interacting with session-related
- * cookies in an API context.
- *
- * ### Methods:
- * - `generateSessionToken`: Generates a random session token using base32 encoding.
- * - `makeExpirationDate`: Creates a new expiration date for a session.
- * - `createSession`: Creates a new session for a user and stores it in the database.
- * - `validateSessionToken`: Validates a session token, extending its expiration if valid
- *   or deleting it if expired.
- * - `invalidateSession`: Deletes a session from the database by its ID.
- * - `setSessionTokenCookie`: Sets a session token cookie in the provided API context.
- * - `deleteSessionTokenCookie`: Deletes the session token cookie by setting it with an
- *   empty value and a max age of 0.
- * - `setOAuthSessionTokenCookie`: Sets an OAuth session token cookie in the given API context.
- * - `createUserSession`: Creates a new user session, including generating a token, storing
- *   it in the database, and setting a cookie.
- *
- *
- * ### Usage:
- * This class is designed to be used in the context of a web application where user
- * authentication and session management are required. It provides a robust and
- * extensible framework for handling session-related operations.
- */
-export declare class Session extends Session_base {
-    static Provide: <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, Session>>;
-    static sessionCookieName: string;
-    static sessionExpTime: number;
-}
-export {};

package/dist/lib/auth/session.js

@@ -1,147 +0,0 @@
-import { SDKCoreJs as sdk } from "studiocms:sdk";
-import { sha256 } from "@oslojs/crypto/sha2";
-import { encodeBase32LowerCaseNoPadding, encodeHexLowerCase } from "@oslojs/encoding";
-import { Data, Effect, pipe } from "effect";
-import { genLogger, pipeLogger } from "../effects/logger.js";
-class SessionError extends Data.TaggedError("SessionError") {
-}
-const sessionExpTime = 1e3 * 60 * 60 * 24 * 14;
-const expTimeHalf = sessionExpTime / 2;
-const sessionCookieName = "auth_session";
-class Session extends Effect.Service()("studiocms/lib/auth/session/Session", {
-  effect: genLogger("studiocms/lib/auth/session/Session.effect")(function* () {
-    const generateSessionToken = () => pipeLogger("studiocms/lib/auth/session/Session.generateSessionToken")(
-      Effect.try({
-        try: () => {
-          const data = new Uint8Array(20);
-          const random = crypto.getRandomValues(data);
-          const returnable = encodeBase32LowerCaseNoPadding(random);
-          return returnable;
-        },
-        catch: (cause) => new SessionError({
-          message: `There was an error generating a session token: ${cause}`
-        })
-      })
-    );
-    const makeExpirationDate = () => pipeLogger("studiocms/lib/auth/session/Session.makeExpirationDate")(
-      Effect.try({
-        try: () => new Date(Date.now() + sessionExpTime),
-        catch: (cause) => new SessionError({
-          message: `There was an error generating a session token: ${cause}`
-        })
-      })
-    );
-    const makeSessionId = (token) => pipeLogger("studiocms/lib/auth/session/Session.makeSessionId")(
-      Effect.try({
-        try: () => pipe(new TextEncoder().encode(token), sha256, encodeHexLowerCase),
-        catch: (cause) => new SessionError({
-          message: `There was an error generating a session id: ${cause}`
-        })
-      })
-    );
-    const createSession = (token, userId) => genLogger("studiocms/lib/auth/session/Session.createSession")(function* () {
-      const sessionId = yield* makeSessionId(token);
-      const session = {
-        id: sessionId,
-        userId,
-        expiresAt: new Date(Date.now() + sessionExpTime)
-      };
-      return yield* sdk.AUTH.session.create(session);
-    });
-    const validateSessionToken = (token) => genLogger("studiocms/lib/auth/session/Session.validateSessionToken")(function* () {
-      const sessionId = yield* makeSessionId(token);
-      const nullSession = { session: null, user: null };
-      const result = yield* sdk.AUTH.session.sessionWithUser(sessionId);
-      if (result.length < 1) {
-        return nullSession;
-      }
-      const userSession = result[0];
-      if (!userSession) {
-        return nullSession;
-      }
-      const { user, session } = userSession;
-      if (Date.now() >= session.expiresAt.getTime()) {
-        yield* sdk.AUTH.session.delete(session.id);
-        return nullSession;
-      }
-      if (Date.now() >= session.expiresAt.getTime() - expTimeHalf) {
-        session.expiresAt = new Date(Date.now() + sessionExpTime);
-        yield* sdk.AUTH.session.update(session.id, session.expiresAt);
-      }
-      return { session, user };
-    });
-    const invalidateSession = (sessionId) => pipeLogger("studiocms/lib/auth/session/Session.invalidateSession")(
-      sdk.AUTH.session.delete(sessionId)
-    );
-    const setSessionTokenCookie = (context, token, expiresAt) => pipeLogger("studiocms/lib/auth/session/Session.setSessionTokenCookie")(
-      Effect.try({
-        try: () => context.cookies.set(sessionCookieName, token, {
-          httpOnly: true,
-          sameSite: "lax",
-          secure: import.meta.env.PROD,
-          expires: expiresAt,
-          path: "/"
-        }),
-        catch: (cause) => new SessionError({
-          message: `There was an error setting the session token cookie: ${cause}`
-        })
-      })
-    );
-    const deleteSessionTokenCookie = (context) => pipeLogger("studiocms/lib/auth/session/Session.deleteSessionTokenCookie")(
-      Effect.try({
-        try: () => context.cookies.set(sessionCookieName, "", {
-          httpOnly: true,
-          sameSite: "lax",
-          secure: import.meta.env.PROD,
-          maxAge: 0,
-          path: "/"
-        }),
-        catch: (cause) => new SessionError({
-          message: `There was an error deleting the session token cookie: ${cause}`
-        })
-      })
-    );
-    const setOAuthSessionTokenCookie = (context, key, value) => pipeLogger("studiocms/lib/auth/session/Session.setOAuthSessionTokenCookie")(
-      Effect.try({
-        try: () => context.cookies.set(key, value, {
-          path: "/",
-          secure: import.meta.env.PROD,
-          httpOnly: true,
-          maxAge: 60 * 10,
-          sameSite: "lax"
-        }),
-        catch: (cause) => new SessionError({
-          message: `There was an error setting the session token cookie: ${cause}`
-        })
-      })
-    );
-    const createUserSession = (userId, context) => genLogger("studiocms/lib/auth/session/Session.createUserSession")(function* () {
-      const sessionToken = yield* generateSessionToken();
-      const expiration = yield* makeExpirationDate();
-      yield* createSession(sessionToken, userId);
-      yield* setSessionTokenCookie(context, sessionToken, expiration);
-    });
-    return {
-      generateSessionToken,
-      makeExpirationDate,
-      createSession,
-      validateSessionToken,
-      invalidateSession,
-      setSessionTokenCookie,
-      deleteSessionTokenCookie,
-      setOAuthSessionTokenCookie,
-      createUserSession
-    };
-  }),
-  dependencies: []
-}) {
-  static Provide = Effect.provide(this.Default);
-  static sessionCookieName = sessionCookieName;
-  static sessionExpTime = sessionExpTime;
-}
-export {
-  Session,
-  SessionError,
-  sessionCookieName,
-  sessionExpTime
-};

package/dist/lib/auth/user.d.ts

@@ -1,155 +0,0 @@
-import type { CombinedUserData, tsUsersInsert } from 'studiocms:sdk/types';
-import type { APIContext, AstroGlobal } from 'astro';
-import { Effect } from 'effect';
-import { Password } from './password.js';
-import { Session } from './session.js';
-import type { UserSessionData } from './types.js';
-import { CheckIfUnsafe, type CheckIfUnsafeError } from './utils/unsafeCheck.js';
-declare const UserError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }) => import("effect/Cause").YieldableError & {
-    readonly _tag: "UserError";
-} & Readonly<A>;
-export declare class UserError extends UserError_base<{
-    message: string;
-}> {
-}
-/**
- * The name of the cookie used for linking a new OAuth account.
- * This constant is used to identify the specific cookie that handles
- * the linking process for new OAuth accounts.
- */
-export declare const LinkNewOAuthCookieName = "link-new-o-auth";
-/**
- * An enumeration representing different user permission levels.
- *
- * The permission levels are defined as follows:
- * - visitor: 1
- * - editor: 2
- * - admin: 3
- * - owner: 4
- * - unknown: 0
- */
-export declare enum UserPermissionLevel {
-    visitor = 1,
-    editor = 2,
-    admin = 3,
-    owner = 4,
-    unknown = 0
-}
-/**
- * An array of available permission ranks for users.
- *
- * The permission ranks are defined as a constant tuple and include the following values:
- * - 'owner': The highest level of permission, typically the creator or primary administrator.
- * - 'admin': A high level of permission, usually for users who manage the system.
- * - 'editor': A mid-level permission, for users who can modify content.
- * - 'visitor': A low-level permission, for users who can view content but not modify it.
- * - 'unknown': A default or fallback permission rank for users with undefined roles.
- */
-declare const availablePermissionRanks: readonly ["owner", "admin", "editor", "visitor", "unknown"];
-/**
- * Represents the available permission ranks for a user.
- *
- * This type is derived from the `availablePermissionRanks` array,
- * and it includes all the possible values that a user can have as a permission rank.
- */
-type AvailablePermissionRanks = (typeof availablePermissionRanks)[number];
-/**
- * A mapping of permission ranks to their respective allowed roles.
- *
- * This map defines the hierarchy of permissions, where each rank includes
- * all the roles of the ranks below it. For example, an 'admin' has the roles
- * of both 'owner' and 'admin', while an 'editor' has the roles of 'owner',
- * 'admin', and 'editor'.
- *
- * @property {string[]} owner - The 'owner' rank, which includes only the 'owner' role.
- * @property {string[]} admin - The 'admin' rank, which includes 'owner' and 'admin' roles.
- * @property {string[]} editor - The 'editor' rank, which includes 'owner', 'admin', and 'editor' roles.
- * @property {string[]} visitor - The 'visitor' rank, which includes 'owner', 'admin', 'editor', and 'visitor' roles.
- * @property {string[]} unknown - The 'unknown' rank, which includes all roles: 'owner', 'admin', 'editor', 'visitor', and 'unknown'.
- */
-export declare const permissionRanksMap: Record<AvailablePermissionRanks, string[]>;
-declare const User_base: Effect.Service.Class<User, "studiocms/lib/auth/user/User", {
-    readonly effect: Effect.Effect<{
-        verifyUsernameInput: (username: string) => Effect.Effect<string | true, UserError | CheckIfUnsafeError, never>;
-        createUserAvatar: (email: string) => Effect.Effect<string, UserError, never>;
-        createLocalUser: (name: string, username: string, email: string, password: string) => Effect.Effect<{
-            name: string;
-            password: string | null;
-            email: string | null;
-            url: string | null;
-            username: string;
-            id: string;
-            avatar: string | null;
-            updatedAt: Date | null;
-            createdAt: Date | null;
-            emailVerified: boolean;
-            notifications: string | null;
-        }, import("../effects/smtp.js").SMTPError | import("../../sdk/errors.js").SDKCoreError | import("./utils/scrypt.js").ScryptError | UserError, never>;
-        createOAuthUser: (userFields: tsUsersInsert, oAuthFields: {
-            provider: string;
-            providerUserId: string;
-        }) => Effect.Effect<{
-            name: string;
-            password: string | null;
-            email: string | null;
-            url: string | null;
-            username: string;
-            id: string;
-            avatar: string | null;
-            updatedAt: Date | null;
-            createdAt: Date | null;
-            emailVerified: boolean;
-            notifications: string | null;
-        }, import("../effects/smtp.js").SMTPError | import("../../sdk/errors.js").SDKCoreError, never>;
-        updateUserPassword: (userId: string, password: string) => Effect.Effect<void, import("../../sdk/errors.js").SDKCoreError | import("./utils/scrypt.js").ScryptError, never>;
-        getUserPasswordHash: (userId: string) => Effect.Effect<string, Error | import("../../sdk/errors.js").SDKCoreError, never>;
-        getUserFromEmail: (email: string) => Effect.Effect<import("../../sdk/types/index.js").CombinedUserData | null, import("../../sdk/errors.js").SDKCoreError, never>;
-        getUserData: (context: AstroGlobal | APIContext) => Effect.Effect<UserSessionData, import("../../sdk/errors.js").SDKCoreError | import("./session.js").SessionError | UserError, never>;
-        getUserPermissionLevel: (userData: UserSessionData | CombinedUserData) => Effect.Effect<UserPermissionLevel, UserError, never>;
-        isUserAllowed: (userData: UserSessionData | CombinedUserData, requiredPerms: AvailablePermissionRanks) => Effect.Effect<boolean, UserError, never>;
-    }, never, import("../notifier/index.js").Notifications | CheckIfUnsafe | Password | Session>;
-    readonly dependencies: readonly [import("effect/Layer").Layer<CheckIfUnsafe, never, never>, import("effect/Layer").Layer<Session, never, never>, import("effect/Layer").Layer<Password, never, never>, import("effect/Layer").Layer<import("../notifier/index.js").Notifications, import("../effects/smtp.js").SMTPError | import("effect/Cause").UnknownException, never>];
-}>;
-/**
- * The `User` class provides a set of methods and utilities for managing user authentication,
- * user data, and permissions within the StudioCMS application. It includes functionality for:
- *
- * - Verifying usernames based on length, character restrictions, and safety checks.
- * - Creating user avatars using the Libravatar service.
- * - Creating new users with local credentials or OAuth credentials.
- * - Updating user passwords and retrieving password hashes.
- * - Fetching user data based on email or session context.
- * - Determining user permission levels and checking access permissions.
- *
- * ### Dependencies
- * This class relies on the following services:
- * - `CheckIfUnsafe`: Utility for checking unsafe usernames.
- * - `Session`: Session management service.
- * - `Password`: Password hashing and validation service.
- * - `Notifications`: Notification service for sending admin alerts.
- *
- * ### Methods
- * - `verifyUsernameInput(username: string)`: Verifies if a username meets the required criteria.
- * - `createUserAvatar(email: string)`: Generates a user avatar URL based on the provided email.
- * - `createLocalUser(name: string, username: string, email: string, password: string)`: Creates a new local user.
- * - `createOAuthUser(userFields: tsUsersInsert, oAuthFields: { provider: string; providerUserId: string })`: Creates a new user with OAuth credentials.
- * - `updateUserPassword(userId: string, password: string)`: Updates the password for a user.
- * - `getUserPasswordHash(userId: string)`: Retrieves the password hash for a given user.
- * - `getUserFromEmail(email: string)`: Retrieves a user based on their email address.
- * - `getUserData(context: AstroGlobal | APIContext)`: Retrieves user session data based on the provided context.
- * - `getUserPermissionLevel(userData: UserSessionData | CombinedUserData)`: Retrieves the user's permission level.
- * - `isUserAllowed(userData: UserSessionData | CombinedUserData, requiredPerms: AvailablePermissionRanks)`: Checks if a user has the required permissions.
- *
- * ### Static Properties
- * - `Provide`: Provides the default instance of the `User` service.
- * - `LinkNewOAuthCookieName`: The cookie name used for linking new OAuth accounts.
- * - `UserPermissionLevel`: Enum representing different user permission levels.
- * - `permissionRanksMap`: Mapping of permission ranks to their corresponding levels.
- */
-export declare class User extends User_base {
-    static Provide: <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, import("../effects/smtp.js").SMTPError | import("effect/Cause").UnknownException | E, Exclude<R, User>>;
-    static LinkNewOAuthCookieName: string;
-    static UserPermissionLevel: typeof UserPermissionLevel;
-    static permissionRanksMap: Record<"unknown" | "owner" | "admin" | "editor" | "visitor", string[]>;
-}
-export {};