--- title: "Référence d'API — @nodefony/redis" source: docs/api/redis.md url: https://nodefony.github.io/nodefony-core/docs/api/redis/ --- [Documentation](../../) › [Référence d'API](../) › `@nodefony/redis` > Générée depuis les déclarations de types publiées de `@nodefony/redis` **10.0.0-beta.5** : exactement ce que reçoit une application qui l'installe. Cette page n'existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code. ## `@nodefony/redis` `import { … } from "@nodefony/redis"` — 14 symboles. ### Classes (5) #### `RedisService` ```ts class RedisService extends Service ``` Service Redis Nodefony — orchestre N connexions nommées (par défaut `main`, `publish`, `subscribe`) à partir de la config validée par Zod. - `module: Module` - `constructor(module: Module)` - `log(pci: Pci, severity?: Severity, msgid?: Msgid, msg?: Message): import("nodefony").Pdu` — Émet une entrée de log structurée — point d'entrée central pour TOUT log Nodefony. - `get connections(): Record` — Connexions ouvertes (vide si aucune). - `get keyNamespace(): string` — Cloison des clés de CETTE application, résolue une fois. - `keyPrefix(base: string): string` — Préfixe de clés d'un store, cloisonné par application. - `init(): Promise` — Ouvre toutes les connexions déclarées dans la config (si `enabled`). - `createConnection(name: string): Promise` — Crée et ouvre une connexion nommée. - `getConnection(name: string): Connection` — Connexion par nom (ou `undefined`). - `getClient(name: string): RedisClientType | null` — Client redis brut d'une connexion **utilisable**, ou `null`. - `closeConnections(): Promise` — Ferme toutes les connexions ouvertes (idempotent). - `generateId(): string` #### `RedisSessionStorage` ```ts class RedisSessionStorage implements ISessionStorage ``` Stockage de session **Redis** — branché sur la connexion `main` du `RedisService`. Implémente le contrat unifié `ISessionStorage` consommé par le `SessionsService` de `@nodefony/http`. - `manager: SessionsService` - `idleTimeoutS: number` — Idle timeout en secondes (= TTL Redis natif, glissant via `write`/`touch`). - `constructor(manager: SessionsService)` - `read(id: string): Promise` - `start(id: string): Promise` - `write(id: string, data: ISerializedSession): Promise` - `open(): Promise` - `close(): boolean` - `destroy(id: string): Promise` - `gc(): Promise` — Purge les sessions expirées sur les **deux bornes** NIST/OWASP : idle (inactivité depuis `updatedAt`) ET absolute (âge depuis `createdAt`, jamais prolongé). - `touch(id: string, idleSeconds?: number): Promise` — Prolonge l'idle d'une session (timeout glissant) en repositionnant le TTL natif (`EXPIRE`, O(1)) — SANS réécrire la valeur (touch NIST/OWASP). - `listAll(filter?: ISessionListFilter): Promise` — Énumération admin (capacité optionnelle d'`ISessionStorage`) par **SCAN** non-bloquant (`MATCH :*`, curseur), filtrable par `user`. - `listPage(query: ISessionListQuery): Promise>` — {@inheritDoc ISessionStorage.listPage} - `countSessions(query?: Partial): Promise` — {@inheritDoc ISessionStorage.countSessions} - `countDistinctUsers(query?: Partial): Promise` — {@inheritDoc ISessionStorage.countDistinctUsers} #### `RedisTokenStore` ```ts class RedisTokenStore implements ITokenStore ``` Store de jetons **Redis** (node-redis v6) — implémentation d'`ITokenStore` pour le cluster (source unique cross-pod, denylist hot). - `constructor(resolveClient: () => RedisClientLike | null, now?: () => number, retentionRevokedMs?: number, resolvePrefix?: () => string, notify?: (message: string) => void)` - `static from(service: RedisService, now?: () => number, retentionRevokedMs?: number): RedisTokenStore` — Construit le store depuis un `RedisService` (connexion `main`). - `put(record: IAccessTokenRecord): Promise` — Enregistre (ou remplace) un jeton persistant. - `findById(id: string): Promise` — Recherche par identifiant (`jti`/id public). - `findByHash(secretHash: string): Promise` — Recherche par hash de secret présenté. - `findBySubject(subjectId: string): Promise` — Tous les jetons d'un porteur (console « mes jetons », révocation ciblée). - `listAll(): Promise` — Tous les jetons (PAT + refresh) — vue d'administration cross-porteur. - `listPage(query: ITokenListQuery): Promise>` — {@inheritDoc ITokenStore.listPage} - `countTokens(_query: ITokenListQuery): Promise` — {@inheritDoc ITokenStore.countTokens} - `markUsed(id: string, usage: ITokenUsage): Promise` — Met à jour `lastUsedAt`/IP/UA (no-op si l'id est inconnu). - `revoke(id: string, reason: TokenRevokeReason): Promise` — Révoque un jeton (pose `revokedAt`+`revokedReason`) — idempotent. - `revokeFamily(family: string, reason: TokenRevokeReason): Promise` — Révoque TOUTE la famille de rotation (détection de rejeu, RFC 9700). - `denyJti(jti: string, expiresAt: number): Promise` — Inscrit un `jti` d'access sur la denylist jusqu'à `expiresAt` (epoch ms) — révocation immédiate avant l'`exp` du JWT. - `isJtiDenied(jti: string): Promise` — `true` si le `jti` est denylisté et non encore expiré. - `revokeAllForSubject(subjectId: string, invalidBefore: number): Promise` — Pose le seuil `invalidBefore` (epoch ms) d'un porteur : tout access auto-porté dont `iat < invalidBefore` est rejeté. - `getInvalidBefore(subjectId: string): Promise` — Seuil `invalidBefore` d'un porteur (epoch ms) ou `null` si aucun. - `gc(): Promise` — **No-op** : Redis gère toute l'expiration par TTL natif (refresh par leur `exp`, PAT révoqués par la rétention posée au `revoke`, denylist par `EX`). #### `RedisWebAuthnCredentialStore` ```ts class RedisWebAuthnCredentialStore implements IWebAuthnCredentialStore ``` Store de credentials WebAuthn **Redis** (node-redis v6) — implémentation d'`IWebAuthnCredentialStore` pour le cluster (source unique cross-pod, les passkeys survivent au redémarrage et sont partagées entre process). - `constructor(resolveClient: () => RedisClientLike | null, resolvePrefix?: () => string)` - `static from(service: RedisService): RedisWebAuthnCredentialStore` — Construit le store depuis un `RedisService` (connexion `main`). - `findById(credentialId: string): Promise` — Credential par son id (base64url), ou `null` — résolution à l'authentification. - `findByUser(userId: string): Promise` — Tous les credentials d'un utilisateur — pour `allowCredentials` (authentification ciblée) et l'UX « mes appareils ». - `countByUser(userId: string): Promise` — `SCARD` natif — O(1), aucune lecture de HASH (le plafond ne charge rien). - `save(credential: IWebAuthnCredential): Promise` — Persiste un nouveau credential (fin de la cérémonie d'enregistrement). - `update(credentialId: string, patch: WebAuthnAuthUpdate): Promise` — Met à jour l'état post-authentification (compteur, sauvegarde, UV, usage). - `delete(credentialId: string): Promise` — Révoque un credential (l'utilisateur retire un appareil). - `listPage(query: IWebAuthnListQuery): Promise>` — {@inheritDoc IWebAuthnCredentialStore.listPage} - `countCredentials(_query: IWebAuthnListQuery): Promise` — {@inheritDoc IWebAuthnCredentialStore.countCredentials} #### `default` ```ts class Redis extends Module ``` - `static critical: boolean` — Module optionnel : un échec de son boot ne tue jamais le process (résilience Ph.3). - `constructor(kernel: Kernel)` - `configSchema(): unknown` — JSON Schema de la config redis → data plane admin (config riche Studio). - `onKernelRegister(): Promise` — Valide la config (défauts + `module.options` + surcharge env) au boot via `defineRedisConfig`, et l'expose au container sous `redisConfig` pour que le `RedisService` la consomme sans redupliquer la va … ### Fonctions (3) #### `defineRedisConfig` ```ts function defineRedisConfig(config?: IRedisConfigInput): IRedisConfig ``` Builder type-safe de la configuration de `@nodefony/redis`. #### `redisConfigJsonSchema` ```ts function redisConfigJsonSchema(): unknown ``` JSON Schema introspectable de la config Redis — destiné au formulaire d'édition Studio (futur) et à la documentation générée. #### `registerRedisFrameworkStores` ```ts function registerRedisFrameworkStores(): void ``` Enregistre les fabriques de stores Redis dans les registres de `@nodefony/security`. Idempotent (guards) — rejouable sans effet. ### Constantes (1) #### `redisConfigSchema` ```ts const redisConfigSchema: z.ZodObject<{ enabled: z.ZodDefault; url: z.ZodOptional; globalOptions: z.ZodDefault; port: z.ZodDefault; family: z.ZodDefault, z.ZodLiteral<4>, z.ZodLiteral<6> ]>>; connectTimeout: z.ZodDefault; tls: z. … ``` ### Interfaces (1) #### `RedisClientLike` ```ts interface RedisClientLike ``` Sous-ensemble structural du client `redis` v6 utilisé par le store — permet de tester contre un double déterministe sans serveur (le vrai `RedisClientType` satisfait cette forme par ses méthodes camelCase v6). - `hSet(key: string, fields: Record): Promise` - `hGetAll(key: string): Promise>` - `hDel(key: string, field: string): Promise` - `get(key: string): Promise` - `set(key: string, value: string, options?: { EX?: number; }): Promise` - `del(key: string): Promise` - `exists(key: string): Promise` - `expire(key: string, seconds: number): Promise` - `sAdd(key: string, member: string): Promise` - `sRem(key: string, member: string): Promise` - `sMembers(key: string): Promise` - `scan(cursor: string, options?: { MATCH?: string; COUNT?: number; }): Promise<{ cursor: string; keys: string[]; }>` - `eval(script: string, options: { keys: string[]; arguments: string[]; }): Promise` ### Types (3) #### `IRedisConfig` ```ts type IRedisConfig = z.infer ``` Configuration normalisée et gelée de `@nodefony/redis` (sortie du builder `defineRedisConfig`, lue par le `RedisService`). #### `IRedisConfigInput` ```ts type IRedisConfigInput = z.input ``` Entrée du builder `defineRedisConfig` — tous les champs portant un défaut sont optionnels (l'app ne fournit que ce qu'elle surcharge). #### `IRedisConnectionConfig` ```ts type IRedisConnectionConfig = IRedisConfig["connections"][string] ``` Définition d'une connexion Redis nommée (sous-objet de `connections`). ### Bibliothèques réexportées (1) #### `redis` La bibliothèque `redis`, réexportée telle quelle : sa documentation est la sienne. --- [← Toutes les références d'API](../)