@clerk/shared/dist/types/ssr.d.ts

Internal package utils used by the Clerk SDKs

import { Serializable } from "./utils.js";
import { UserResource } from "./user.js";
import { SessionResource } from "./session.js";
import { OrganizationResource } from "./organization.js";
import { OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from "./organizationMembership.js";
import { ActClaim, JwtPayload, SessionStatusClaim } from "./jwtv2.js";

//#region src/types/ssr.d.ts
/**
 * Options for retrieving a session token.
 */
type ServerGetTokenOptions = {
  /**
   * The name of a JWT template configured in the Clerk Dashboard.
   * If provided, a JWT will be generated using the specified template.
   * If not provided, the raw session token will be returned.
   */
  template?: string;
  /**
   * The expiration time for the token in seconds.
   * If provided, the token will expire after the specified number of seconds.
   * Must be a positive integer.
   */
  expiresInSeconds?: number;
};
/**
 * A function that retrieves a session token or JWT template.
 *
 * @param options - Configuration options for token retrieval
 * @returns A promise that resolves to the token string, or null if no session exists
 */
type ServerGetToken = (options?: ServerGetTokenOptions) => Promise<string | null>;
type InitialState = Serializable<{
  sessionClaims: JwtPayload;
  sessionId: string | undefined;
  sessionStatus: SessionStatusClaim;
  session: SessionResource | undefined;
  actor: ActClaim | undefined;
  userId: string | undefined;
  user: UserResource | undefined;
  orgId: string | undefined;
  orgRole: OrganizationCustomRoleKey | undefined;
  orgSlug: string | undefined;
  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
  organization: OrganizationResource | undefined;
  factorVerificationAge: [number, number];
}>;
//#endregion
export { InitialState, ServerGetToken, ServerGetTokenOptions };