lib/auth/types

Interfaces

ExpiringBucket

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:77

Represents a bucket with an expiration mechanism.

ExpiringBucket

Properties

count

count: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:78

The number of items in the bucket.

createdAt

createdAt: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:79

The timestamp when the bucket was created.

---

OAuthAccountsTable

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:16

Represents a table of OAuth accounts.

OAuthAccountsTable

Extends

• tsOAuthAccountsSelect

Properties

provider

provider: string;

The name of the OAuth provider (e.g., Google, Facebook).

Inherited from

tsOAuthAccountsSelect.provider

providerUserId

providerUserId: string;

The unique identifier for the user provided by the OAuth provider.

Inherited from

tsOAuthAccountsSelect.providerUserId

userId

userId: string;

The unique identifier for the user within the application.

Inherited from

tsOAuthAccountsSelect.userId

---

PermissionsTable

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:24

Interface representing a table of user permissions.

Extends

• tsPermissionsSelect

Properties

rank

rank: string;

The rank or role assigned to the user.

Inherited from

tsPermissionsSelect.rank

user

user: string;

The username of the individual.

Inherited from

tsPermissionsSelect.user

---

RefillBucket

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:65

Represents an individual refillable token bucket.

RefillBucket

Properties

count

count: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:66

The current token count in the bucket.

refilledAt

refilledAt: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:67

The last timestamp when tokens were refilled.

---

ThrottlingCounter

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:88

Interface representing a throttling counter.

Properties

timeout

timeout: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:89

The duration (in milliseconds) for which the throttling is applied.

updatedAt

updatedAt: number;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:90

The timestamp (in milliseconds since epoch) when the throttling counter was last updated.

Type Aliases

SessionValidationResult

type SessionValidationResult =
  | UserSession
  | {
  session: null;
  user: null;
};

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:56

Represents the result of a session validation.

This type can either be a valid UserSession or an object indicating an invalid session with both session and user properties set to null.

---

UserSession

type UserSession = {
  session: tsSessionTableSelect;
  user: tsUsersSelect;
};

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:45

Represents a user session which includes user information and session details.

Properties

session

session: tsSessionTableSelect;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:47

The session details.

user

user: tsUsersSelect;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:46

The user information.

---

UserSessionData

type UserSessionData = {
  isLoggedIn: boolean;
  permissionLevel: "owner" | "admin" | "editor" | "visitor" | "unknown";
  user: tsUsersSelect | null;
};

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:33

Represents the session data for a user.

Properties

isLoggedIn

isLoggedIn: boolean;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:34

Indicates whether the user is logged in.

permissionLevel

permissionLevel: "owner" | "admin" | "editor" | "visitor" | "unknown";

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:36

The permission level of the user.

user

user: tsUsersSelect | null;

Defined in: studiocms/packages/studiocms/src/lib/auth/types.ts:35

The user data, or null if no user is logged in.