@consilioweb/payload-support 3.0.0 → 4.0.0

package/dist/index.d.cts

@@ -28,7 +28,19 @@ declare class RateLimiter {
     private readonly windowMs;
     private readonly maxRequests;
     private readonly store;
-    constructor(windowMs: number, maxRequests: number, store?: RateLimitStore);
+    private readonly prefix;
+    /**
+     * @param namespace  Endpoint-scoped prefix for every key this limiter writes.
+     *   The store is SHARED (`rateLimitStore: 'payload'` builds one instance for
+     *   all endpoints), and the raw keys collide across endpoints: `ip` was used
+     *   by both the login and the chatbot limiter — 10 forged chatbot requests
+     *   locked a victim out of the portal for 15 minutes — and `String(user.id)`
+     *   by five different endpoints. Always pass one; it is optional only because
+     *   `RateLimiter` is part of the published API surface.
+     */
+    constructor(windowMs: number, maxRequests: number, store?: RateLimitStore, namespace?: string);
+    /** The key actually written to the store. Exposed for assertions in tests. */
+    scopedKey(key: string): string;
     check(key: string, context?: unknown): Promise<boolean>;
     reset(key: string, context?: unknown): Promise<void>;
 }
@@ -505,14 +517,17 @@ interface SupportSettingsState {
      */
     featuresConfigured: boolean;
 }
-declare function readSupportSettingsState(payload: Payload): Promise<SupportSettingsState>;
-declare function readSupportSettings(payload: Payload): Promise<SupportSettings>;
-declare function readUserPrefs(payload: Payload, userId: string | number): Promise<UserPrefs>;
+declare function readSupportSettingsState(payload: Payload, staffSlug?: string): Promise<SupportSettingsState>;
+declare function readSupportSettings(payload: Payload, staffSlug?: string): Promise<SupportSettings>;
+declare function readUserPrefs(payload: Payload, userId: string | number, staffSlug?: string): Promise<UserPrefs>;
 
 /**
  * POST /api/support/oauth/google
  * Google OAuth — handles both login redirect and callback.
- * Body: { action: 'login' } or { code: string, state: string, cookieState: string }
+ * Body: { action: 'login' } or { code: string, state: string }
+ *
+ * The CSRF state is NOT taken from the body: `action: 'login'` issues it as an
+ * HttpOnly cookie and the callback reads it back from the `Cookie` header.
  */
 interface OAuthGoogleOptions {
     allowedEmailDomains?: string[];

package/dist/index.d.ts

@@ -28,7 +28,19 @@ declare class RateLimiter {
     private readonly windowMs;
     private readonly maxRequests;
     private readonly store;
-    constructor(windowMs: number, maxRequests: number, store?: RateLimitStore);
+    private readonly prefix;
+    /**
+     * @param namespace  Endpoint-scoped prefix for every key this limiter writes.
+     *   The store is SHARED (`rateLimitStore: 'payload'` builds one instance for
+     *   all endpoints), and the raw keys collide across endpoints: `ip` was used
+     *   by both the login and the chatbot limiter — 10 forged chatbot requests
+     *   locked a victim out of the portal for 15 minutes — and `String(user.id)`
+     *   by five different endpoints. Always pass one; it is optional only because
+     *   `RateLimiter` is part of the published API surface.
+     */
+    constructor(windowMs: number, maxRequests: number, store?: RateLimitStore, namespace?: string);
+    /** The key actually written to the store. Exposed for assertions in tests. */
+    scopedKey(key: string): string;
     check(key: string, context?: unknown): Promise<boolean>;
     reset(key: string, context?: unknown): Promise<void>;
 }
@@ -505,14 +517,17 @@ interface SupportSettingsState {
      */
     featuresConfigured: boolean;
 }
-declare function readSupportSettingsState(payload: Payload): Promise<SupportSettingsState>;
-declare function readSupportSettings(payload: Payload): Promise<SupportSettings>;
-declare function readUserPrefs(payload: Payload, userId: string | number): Promise<UserPrefs>;
+declare function readSupportSettingsState(payload: Payload, staffSlug?: string): Promise<SupportSettingsState>;
+declare function readSupportSettings(payload: Payload, staffSlug?: string): Promise<SupportSettings>;
+declare function readUserPrefs(payload: Payload, userId: string | number, staffSlug?: string): Promise<UserPrefs>;
 
 /**
  * POST /api/support/oauth/google
  * Google OAuth — handles both login redirect and callback.
- * Body: { action: 'login' } or { code: string, state: string, cookieState: string }
+ * Body: { action: 'login' } or { code: string, state: string }
+ *
+ * The CSRF state is NOT taken from the body: `action: 'login'` issues it as an
+ * HttpOnly cookie and the callback reads it back from the `Cookie` header.
  */
 interface OAuthGoogleOptions {
     allowedEmailDomains?: string[];