unjwt 0.7.1 → 0.7.3

package/dist/adapters/elysia/index.d.mts

@@ -0,0 +1,244 @@
+import { CompositeKey, ContentEncryptionAlgorithm, DeriveKeyOptions, DeriveKeyReturn, Duration, ExpiresIn, GenerateJWKOptions, GenerateJWKReturn, GenerateKeyAlgorithm, GenerateKeyOptions, GenerateKeyReturn, JOSEPayload, JWEAsymmetricPrivateJWK, JWEAsymmetricPublicJWK, JWEDecryptJWK, JWEDecryptOptions, JWEDecryptResult, JWEEncryptJWK, JWEEncryptOptions, JWEFlattenedSerialization, JWEGeneralRecipient, JWEGeneralSerialization, JWEHeaderParameters, JWEKeyManagementHeaderParameters, JWEMultiDecryptOptions, JWEMultiDecryptResult, JWEMultiEncryptOptions, JWEMultiRecipient, JWEProtectedHeader, JWK, JWKAlgorithm, JWKCacheAdapter, JWKLookupFunction, JWKLookupFunctionHeader, JWKPEMAlgorithm, JWKParameters, JWKSet, JWK_AES_CBC_HMAC, JWK_AES_GCM, JWK_AES_GCM_KW, JWK_AES_KW, JWK_Asymmetric, JWK_Asymmetric_Algorithm, JWK_EC, JWK_ECDH_ES, JWK_ECDSA, JWK_EC_Private, JWK_EC_Public, JWK_HMAC, JWK_OKP, JWK_OKP_Private, JWK_OKP_Public, JWK_OKP_SIGN, JWK_PBES2, JWK_Pair, JWK_Private, JWK_Public, JWK_RSA, JWK_RSA_ENC, JWK_RSA_PSS, JWK_RSA_Private, JWK_RSA_Public, JWK_RSA_SIGN, JWK_Symmetric, JWK_Symmetric_Algorithm, JWK_oct, JWSAlgorithm, JWSAsymmetricPrivateJWK, JWSAsymmetricPublicJWK, JWSFlattenedSerialization, JWSGeneralSerialization, JWSGeneralSignature, JWSHeaderParameters, JWSMultiSignOptions, JWSMultiSigner, JWSMultiVerifyAllOptions, JWSMultiVerifyOptions, JWSMultiVerifyOutcome, JWSMultiVerifyResult, JWSProtectedHeader, JWSSignJWK, JWSSignOptions, JWSVerifyJWK, JWSVerifyOptions, JWSVerifyResult, JWT, JWTClaimValidationOptions, JWTClaims, JoseHeaderParameters, KeyManagementAlgorithm, MaxTokenAge, NotBeforeIn, StrictOmit, UnwrapKeyOptions, UnwrappingKeyFor, WrapKeyOptions, WrapKeyResult, WrappingKeyFor } from "../../_chunks/index.mjs";
+import { deriveJWKFromPassword, exportPEM, generateJWK, importPEM } from "../../core/jwk.mjs";
+import { Elysia } from "elysia";
+interface CookieAttributes {
+  domain?: string;
+  expires?: Date;
+  httpOnly?: boolean;
+  maxAge?: number;
+  path?: string;
+  priority?: "low" | "medium" | "high";
+  sameSite?: boolean | "lax" | "strict" | "none";
+  secure?: boolean;
+  partitioned?: boolean;
+}
+interface ChunkableCookie {
+  value: unknown;
+  set(config: CookieAttributes & {
+    value: string;
+  }): unknown;
+}
+type ChunkableCookieJar = Record<string, ChunkableCookie>;
+type WriteChunkedCookieOptions = CookieAttributes & {
+  chunkMaxLength?: number;
+};
+interface SessionContext {
+  cookie: ChunkableCookieJar;
+  request: {
+    headers: {
+      get(name: string): string | null;
+    };
+  };
+}
+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>>;
+  clear: () => Promise<SessionManager<T, ConfigMaxAge>>;
+}
+/**
+* Explicit return type for the `jwsSession` / `jweSession` plugin factories.
+*
+* Modelling Elysia's generics by hand is required by `isolatedDeclarations`
+* (the factories return an inferred `new Elysia().resolve().macro()` type that
+* cannot otherwise be emitted). `Resolved` is the scoped `Ephemeral.resolve`
+* augmentation — typically `{ [P in ContextKey]: SessionManager }` — so consumers
+* read a typed `ctx[contextKey]`. `GuardName` is the guard macro key (derived
+* from the context key, e.g. `requireSession`), so multiple session plugins on
+* one app each expose a distinct guard rather than colliding. `macroFn` is left
+* `{}`: consumers only need `Metadata.macro` for the `{ [GuardName]: true }`
+* route option.
+*/
+type SessionPlugin<Resolved extends Record<string, unknown>, GuardName extends string = "requireSession"> = Elysia<"", {
+  decorator: {};
+  store: {};
+  derive: {};
+  resolve: {};
+}, {
+  typebox: {};
+  error: {};
+}, {
+  schema: {};
+  standaloneSchema: {};
+  macro: { [M in GuardName]?: boolean };
+  macroFn: {};
+  parser: {};
+  response: {};
+}, {}, {
+  derive: {};
+  resolve: Resolved;
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}, {
+  derive: {};
+  resolve: {};
+  schema: {};
+  standaloneSchema: {};
+  response: {};
+}>;
+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>;
+  token: string | undefined;
+}
+interface SessionHooksJWS<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext> {
+  onRead?: (args: {
+    session: SessionJWS<T, MaxAge> & {
+      id: string;
+      token: string;
+    };
+    context: TContext;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onUpdate?: (args: {
+    session: SessionJWS<T, MaxAge> & {
+      id: string;
+      token: string;
+    };
+    oldSession: SessionJWS<T, MaxAge>;
+    context: TContext;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onClear?: (args: {
+    oldSession: SessionJWS<T, MaxAge> | undefined;
+    context: TContext;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onExpire?: (args: {
+    session: {
+      id: string | undefined;
+      createdAt: number | undefined;
+      expiresAt: number | undefined;
+      token: string;
+    };
+    context: TContext;
+    error: Error;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onError?: (args: {
+    session: SessionJWS<T, MaxAge>;
+    context: TContext;
+    error: any;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onVerifyKeyLookup?: (args: {
+    header: JWKLookupFunctionHeader;
+    context: TContext;
+    config: SessionConfigJWS<T, MaxAge, TContext>;
+  }) => JWKSet | JWSVerifyJWK | Promise<JWKSet | JWSVerifyJWK>;
+}
+interface SessionConfigJWS<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext> {
+  key: JWK_oct<JWK_HMAC> | {
+    privateKey: JWSAsymmetricPrivateJWK;
+    publicKey: JWSAsymmetricPublicJWK | JWSAsymmetricPublicJWK[] | JWKSet;
+  };
+  maxAge?: MaxAge;
+  name?: string;
+  /** Context property the session is exposed under. Default `"session"`. */
+  contextKey?: string;
+  cookie?: false | (CookieAttributes & {
+    chunkMaxLength?: number;
+  });
+  sessionHeader?: false | string;
+  generateId?: () => string;
+  jws?: {
+    signOptions?: Omit<JWSSignOptions, "expiresIn">;
+    verifyOptions?: JWTClaimValidationOptions;
+  };
+  hooks?: SessionHooksJWS<T, MaxAge, TContext>;
+}
+declare function createJWSSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext>(context: TContext, config: SessionConfigJWS<T, MaxAge, TContext>): Promise<SessionManager<T, MaxAge>>;
+declare function jwsSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, K extends string = "session">(config: SessionConfigJWS<T, MaxAge> & (K extends "session" ? {
+  contextKey?: K;
+} : {
+  contextKey: K;
+})): SessionPlugin<{ [P in K]: SessionManager<T, MaxAge> }, `require${Capitalize<K>}`>;
+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>;
+  token: string | undefined;
+}
+interface SessionHooksJWE<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext> {
+  onRead?: (args: {
+    session: SessionJWE<T, MaxAge> & {
+      id: string;
+      token: string;
+    };
+    context: TContext;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onUpdate?: (args: {
+    session: SessionJWE<T, MaxAge> & {
+      id: string;
+      token: string;
+    };
+    oldSession: SessionJWE<T, MaxAge>;
+    context: TContext;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onClear?: (args: {
+    oldSession: SessionJWE<T, MaxAge> | undefined;
+    context: TContext;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onExpire?: (args: {
+    session: {
+      id: string | undefined;
+      createdAt: number | undefined;
+      expiresAt: number | undefined;
+      token: string;
+    };
+    context: TContext;
+    error: Error;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onError?: (args: {
+    session: SessionJWE<T, MaxAge>;
+    context: TContext;
+    error: any;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => void | Promise<void>;
+  onUnsealKeyLookup?: (args: {
+    header: JWEHeaderParameters;
+    context: TContext;
+    config: SessionConfigJWE<T, MaxAge, TContext>;
+  }) => JWEDecryptJWK | Promise<JWEDecryptJWK>;
+}
+interface SessionConfigJWE<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext> {
+  key: string | JWEEncryptJWK | {
+    privateKey: JWEAsymmetricPrivateJWK;
+    publicKey?: JWEAsymmetricPublicJWK;
+  };
+  maxAge?: MaxAge;
+  name?: string;
+  /** Context property the session is exposed under. Default `"session"`. */
+  contextKey?: string;
+  cookie?: false | (CookieAttributes & {
+    chunkMaxLength?: number;
+  });
+  sessionHeader?: false | string;
+  generateId?: () => string;
+  jwe?: {
+    encryptOptions?: Omit<JWEEncryptOptions, "expiresIn">;
+    decryptOptions?: JWTClaimValidationOptions;
+  };
+  hooks?: SessionHooksJWE<T, MaxAge, TContext>;
+}
+declare function createJWESession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, TContext extends SessionContext = SessionContext>(context: TContext, config: SessionConfigJWE<T, MaxAge, TContext>): Promise<SessionManager<T, MaxAge>>;
+declare function jweSession<T extends Record<string, any> = SessionClaims, MaxAge extends ExpiresIn | undefined = ExpiresIn | undefined, K extends string = "session">(config: SessionConfigJWE<T, MaxAge> & (K extends "session" ? {
+  contextKey?: K;
+} : {
+  contextKey: K;
+})): SessionPlugin<{ [P in K]: SessionManager<T, MaxAge> }, `require${Capitalize<K>}`>;
+export { type ChunkableCookie, type ChunkableCookieJar, type CompositeKey, type ContentEncryptionAlgorithm, type CookieAttributes, type DeriveKeyOptions, type DeriveKeyReturn, type Duration, type ExpiresIn, type GenerateJWKOptions, type GenerateJWKReturn, type GenerateKeyAlgorithm, type GenerateKeyOptions, type GenerateKeyReturn, type JOSEPayload, type JWEAsymmetricPrivateJWK, type JWEAsymmetricPublicJWK, type JWEDecryptJWK, type JWEDecryptOptions, type JWEDecryptResult, type JWEEncryptJWK, type JWEEncryptOptions, type JWEFlattenedSerialization, type JWEGeneralRecipient, type JWEGeneralSerialization, type JWEHeaderParameters, type JWEKeyManagementHeaderParameters, type JWEMultiDecryptOptions, type JWEMultiDecryptResult, type JWEMultiEncryptOptions, type JWEMultiRecipient, type JWEProtectedHeader, type JWK, type JWKAlgorithm, type JWKCacheAdapter, type JWKLookupFunction, type JWKLookupFunctionHeader, type JWKPEMAlgorithm, type JWKParameters, type JWKSet, type JWK_AES_CBC_HMAC, type JWK_AES_GCM, type JWK_AES_GCM_KW, type JWK_AES_KW, type JWK_Asymmetric, type JWK_Asymmetric_Algorithm, type JWK_EC, type JWK_ECDH_ES, type JWK_ECDSA, type JWK_EC_Private, type JWK_EC_Public, type JWK_HMAC, type JWK_OKP, type JWK_OKP_Private, type JWK_OKP_Public, type JWK_OKP_SIGN, type JWK_PBES2, type JWK_Pair, type JWK_Private, type JWK_Public, type JWK_RSA, type JWK_RSA_ENC, type JWK_RSA_PSS, type JWK_RSA_Private, type JWK_RSA_Public, type JWK_RSA_SIGN, type JWK_Symmetric, type JWK_Symmetric_Algorithm, type JWK_oct, type JWSAlgorithm, type JWSAsymmetricPrivateJWK, type JWSAsymmetricPublicJWK, type JWSFlattenedSerialization, type JWSGeneralSerialization, type JWSGeneralSignature, type JWSHeaderParameters, type JWSMultiSignOptions, type JWSMultiSigner, type JWSMultiVerifyAllOptions, type JWSMultiVerifyOptions, type JWSMultiVerifyOutcome, type JWSMultiVerifyResult, type JWSProtectedHeader, type JWSSignJWK, type JWSSignOptions, type JWSVerifyJWK, type JWSVerifyOptions, type JWSVerifyResult, type JWT, type JWTClaimValidationOptions, type JWTClaims, type JoseHeaderParameters, type KeyManagementAlgorithm, type MaxTokenAge, type NotBeforeIn, type SessionClaims, type SessionConfigJWE, type SessionConfigJWS, type SessionContext, type SessionData, type SessionHooksJWE, type SessionHooksJWS, type SessionJWE, type SessionJWS, type SessionManager, type SessionPlugin, type SessionUpdate, type UnwrapKeyOptions, type UnwrappingKeyFor, type WrapKeyOptions, type WrapKeyResult, type WrappingKeyFor, type WriteChunkedCookieOptions, createJWESession, createJWSSession, deriveJWKFromPassword, exportPEM, generateJWK, importPEM, jweSession, jwsSession };