unjwt 0.5.38 → 0.5.40

package/dist/_chunks/jws.d.mts

@@ -0,0 +1,242 @@
+import { C as JWTClaims, R as JWKSet, S as JWTClaimValidationOptions, _ as JWSProtectedHeader, a as ExpiresIn, dt as JWK_Symmetric, it as JWK_Public, l as JWEEncryptOptions, p as StrictOmit, rt as JWK_Private, u as JWEHeaderParameters, v as JWSSignOptions } from "./jwk.mjs";
+import { H3Event } from "h3";
+import { CookieSerializeOptions } from "cookie-es";
+
+//#region src/adapters/h3v1/session/types.d.ts
+interface SessionClaims extends Required<Pick<JWTClaims, "jti" | "iat">>, StrictOmit<JWTClaims, "jti" | "iat"> {}
+type SessionData<T extends Record<string, any> = SessionClaims> = StrictOmit<T, "jti" | "iat" | "exp">;
+type SessionUpdate<T extends Record<string, any> = SessionClaims> = Partial<SessionData<T>> | ((oldData: SessionData<T>) => Partial<SessionData<T>> | undefined);
+interface SessionManager<T extends Record<string, any> = SessionClaims, ConfigMaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  readonly id: string | undefined;
+  readonly createdAt: number;
+  readonly expiresAt: ConfigMaxAge extends ExpiresIn ? number : "exp" extends keyof T ? T["exp"] : number | undefined;
+  readonly data: SessionData<T>;
+  readonly token: string | undefined;
+  update: (update?: SessionUpdate<T>) => Promise<SessionManager<T, ConfigMaxAge> & {
+    readonly id: string;
+  }>;
+  clear: () => Promise<SessionManager<T, ConfigMaxAge>>;
+}
+//#endregion
+//#region src/adapters/h3v1/session/jwe.d.ts
+declare const kGetSessionPromise$1: unique symbol;
+interface SessionJWE<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  id: string | undefined;
+  createdAt: number;
+  expiresAt: MaxAge extends ExpiresIn ? number : T["exp"];
+  data: SessionData<T>;
+  [kGetSessionPromise$1]?: Promise<SessionJWE<T, MaxAge>>;
+}
+interface SessionHooksJWE<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  onRead?: (args: {
+    session: SessionJWE<T, MaxAge>;
+    event: H3Event;
+    config: SessionConfigJWE<T, MaxAge>;
+  }) => void | Promise<void>;
+  onUpdate?: (args: {
+    session: SessionJWE<T, MaxAge>;
+    oldSession: SessionJWE<T, MaxAge>;
+    event: H3Event;
+    config: SessionConfigJWE<T, MaxAge>;
+  }) => void | Promise<void>;
+  onClear?: (args: {
+    session: SessionJWE<T, MaxAge> | undefined;
+    event: H3Event;
+    config: Partial<SessionConfigJWE<T, MaxAge>>;
+  }) => void | Promise<void>;
+  onExpire?: (args: {
+    event: H3Event;
+    error: Error;
+    config: SessionConfigJWE<T, MaxAge>;
+  }) => void | Promise<void>;
+  onError?: (args: {
+    event: H3Event;
+    error: any;
+    config: SessionConfigJWE<T, MaxAge>;
+  }) => void | Promise<void>;
+  onUnsealKeyLookup?: (args: {
+    header: JWEHeaderParameters;
+    event: H3Event;
+    config: SessionConfigJWE<T, MaxAge>;
+  }) => JWK_Symmetric | JWK_Private | Promise<JWK_Symmetric | JWK_Private>;
+}
+interface SessionConfigJWE<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  /** @deprecated use `key` instead */
+  secret?: string | JWK_Symmetric | {
+    privateKey: JWK_Private | JWK_Symmetric;
+    publicKey?: JWK_Public;
+  };
+  /** Shared key used, string for PBES2 or Json Web Key (JWK) */
+  key: string | JWK_Symmetric | JWK_Private | {
+    privateKey: JWK_Private | JWK_Symmetric;
+    publicKey?: JWK_Public;
+  };
+  /** Session lifetime in seconds (used to derive exp from iat) */
+  maxAge?: MaxAge;
+  /** Default is "h3" */
+  name?: string;
+  /** Default is secure, httpOnly, path="/" */
+  cookie?: false | CookieSerializeOptions;
+  /** Default is x-h3-session / x-{name}-session */
+  sessionHeader?: false | string;
+  /** Default is crypto.randomUUID */
+  generateId?: () => string;
+  /** JWE configuration overrides */
+  jwe?: {
+    encryptOptions?: Omit<JWEEncryptOptions, "expiresIn">;
+    decryptOptions?: JWTClaimValidationOptions;
+  };
+  hooks?: SessionHooksJWE<T, MaxAge>;
+}
+type CompatEvent$1 = {
+  request: {
+    headers: Headers;
+  };
+  context: any;
+} | {
+  headers: Headers;
+  context: any;
+};
+/**
+* Create a session manager for the current request.
+*/
+declare function useJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent$1, config: SessionConfigJWE<T, MaxAge>): Promise<SessionManager<T, MaxAge>>;
+/**
+* Get (and lazily initialize) the session for the current request.
+*/
+declare function getJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent$1, config: SessionConfigJWE<T, MaxAge>): Promise<SessionJWE<T, MaxAge>>;
+declare function getJWESessionToken<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent$1, config: SessionConfigJWE<T, MaxAge>): string | undefined;
+/**
+* Update the session (optionally mutating the session data) and re-issue the JWE token.
+*/
+declare function updateJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event, config: SessionConfigJWE<T, MaxAge>, update?: SessionUpdate<T>): Promise<SessionJWE<T, MaxAge>>;
+/**
+* Produce a JWE for the current session.
+* Payload structure:
+* {
+*   jti: string;
+*   iat: number; (seconds)
+*   exp?: number; (seconds)
+*   data: Record<string, any>;
+* }
+*/
+declare function sealJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent$1, config: SessionConfigJWE<T, MaxAge>): Promise<string>;
+/**
+* Decrypt the JWE and return a Session-compatible object.
+*/
+declare function unsealJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent$1, config: SessionConfigJWE<T, MaxAge>, sealed: string): Promise<Partial<SessionJWE<T, MaxAge>>>;
+/**
+* Clear the session (delete from context and drop cookie).
+*/
+declare function clearJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event, config: Partial<SessionConfigJWE<T, MaxAge>>): Promise<void>;
+//#endregion
+//#region src/adapters/h3v1/session/jws.d.ts
+declare const kGetSessionPromise: unique symbol;
+interface SessionJWS<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  id: string | undefined;
+  createdAt: number;
+  expiresAt: MaxAge extends ExpiresIn ? number : T["exp"];
+  data: SessionData<T>;
+  [kGetSessionPromise]?: Promise<SessionJWS<T, MaxAge>>;
+}
+interface SessionHooksJWS<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  onRead?: (args: {
+    session: SessionJWS<T, MaxAge>;
+    event: H3Event;
+    config: SessionConfigJWS<T, MaxAge>;
+  }) => void | Promise<void>;
+  onUpdate?: (args: {
+    session: SessionJWS<T, MaxAge>;
+    oldSession: SessionJWS<T, MaxAge>;
+    event: H3Event;
+    config: SessionConfigJWS<T, MaxAge>;
+  }) => void | Promise<void>;
+  onClear?: (args: {
+    session: SessionJWS<T, MaxAge> | undefined;
+    event: H3Event;
+    config: Partial<SessionConfigJWS<T, MaxAge>>;
+  }) => void | Promise<void>;
+  onExpire?: (args: {
+    event: H3Event;
+    error: Error;
+    config: SessionConfigJWS<T, MaxAge>;
+  }) => void | Promise<void>;
+  onError?: (args: {
+    event: H3Event;
+    error: any;
+    config: SessionConfigJWS<T, MaxAge>;
+  }) => void | Promise<void>;
+  onVerifyKeyLookup?: (args: {
+    header: JWSProtectedHeader;
+    event: H3Event;
+    config: SessionConfigJWS<T, MaxAge>;
+  }) => JWKSet | JWK_Symmetric | JWK_Public | Promise<JWKSet | JWK_Symmetric | JWK_Public>;
+}
+interface SessionConfigJWS<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined> {
+  /**
+  * JWK (private for signing with RS/ES/PS, or symmetric oct) used for signing.
+  */
+  key: JWK_Symmetric | {
+    privateKey: JWK_Private;
+    publicKey: JWK_Public | JWK_Public[] | JWKSet;
+  };
+  /** Session lifetime in seconds (sets exp = iat + maxAge) */
+  maxAge?: MaxAge;
+  /** Default cookie / header name base */
+  name?: string;
+  /** Cookie options (false to disable cookies) */
+  cookie?: false | CookieSerializeOptions;
+  /** Custom header (false to disable header lookup) */
+  sessionHeader?: false | string;
+  /** Custom ID generator (defaults to crypto.randomUUID) */
+  generateId?: () => string;
+  /** JWS customization */
+  jws?: {
+    signOptions?: Omit<JWSSignOptions, "expiresIn">;
+    verifyOptions?: JWTClaimValidationOptions;
+  };
+  hooks?: SessionHooksJWS<T, MaxAge>;
+}
+type CompatEvent = {
+  request: {
+    headers: Headers;
+  };
+  context: any;
+} | {
+  headers: Headers;
+  context: any;
+};
+/**
+* Create a session manager for the current request using JWS (signed only, not encrypted).
+* NOTE: Contents are visible to clients (Base64URL-decoded JSON). Do not store secrets in session data.
+*/
+declare function useJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent, config: SessionConfigJWS<T, MaxAge>): Promise<SessionManager<T, MaxAge>>;
+/**
+* Retrieve (and lazily initialize) the session.
+*/
+declare function getJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent, config: SessionConfigJWS<T, MaxAge>): Promise<SessionJWS<T, MaxAge>>;
+/**
+* Update session data (if provided) and reissue JWS.
+*/
+declare function updateJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event, config: SessionConfigJWS<T, MaxAge>, update?: SessionUpdate<T>): Promise<SessionJWS<T, MaxAge>>;
+/**
+* Sign current session as a compact JWS.
+* Payload claims:
+*  jti, iat, exp?, data, plus optional extraClaims (cannot override reserved)
+*/
+declare function signJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent, config: SessionConfigJWS<T, MaxAge>): Promise<string>;
+/**
+* Verify and parse a compact JWS into a Session structure.
+* Performs:
+*  - cryptographic signature verification
+*  - (optional) standard claim checks if validateJWT true
+*  - ensures jti & iat presence
+*  - enforces maxAge if provided
+*/
+declare function verifyJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event | CompatEvent, config: SessionConfigJWS<T, MaxAge>, token: string): Promise<Partial<SessionJWS<T, MaxAge>>>;
+/**
+* Destroy the session (context + cookie).
+*/
+declare function clearJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined>(event: H3Event, config: Partial<SessionConfigJWS<T, MaxAge>>): Promise<void>;
+//#endregion
+export { SessionUpdate as C, SessionManager as S, unsealJWESession as _, getJWSSession as a, SessionClaims as b, useJWSSession as c, SessionHooksJWE as d, SessionJWE as f, sealJWESession as g, getJWESessionToken as h, clearJWSSession as i, verifyJWSSession as l, getJWESession as m, SessionHooksJWS as n, signJWSSession as o, clearJWESession as p, SessionJWS as r, updateJWSSession as s, SessionConfigJWS as t, SessionConfigJWE as u, updateJWESession as v, SessionData as x, useJWESession as y };