@swell/apps-sdk 1.0.183 → 1.0.184

package/dist/src/cache/html-cache/html-cache.d.ts

@@ -1,26 +1,39 @@
 import type { CacheBackend, CachedEntry } from './html-cache-backend';
 /**
  * Configuration for path-specific cache behavior.
+ *
  * Paths support wildcards:
- *   - * matches any characters except /
- *   - ** matches any characters including /
- * Examples: '/account/*', '/api/**', '*.json'
+ *   - `*` matches any characters except `/`
+ *   - `**` matches any characters including `/`
+ *
+ * Examples: `/account/*`, `/api/**`, `*.json`
+ *
  * First matching rule wins.
  */
 export interface PathRule {
     path: string;
+    /** Time-to-live in seconds */
     ttl?: number;
+    /** Stale-while-revalidate in seconds */
     swr?: number;
+    /** If true, skip caching for this path */
     skip?: boolean;
+    /**
+     * Optional list of allowed Content-Types for caching.
+     *
+     * If provided, responses whose Content-Type starts with one of these values are cacheable.
+     *
+     * If omitted, defaults to only allowing `text/html`.
+     */
     contentTypes?: string[];
 }
 export interface CacheRules {
-    defaults?: {
-        live?: {
+    defaults: {
+        live: {
             ttl: number;
             swr: number;
         };
-        preview?: {
+        preview: {
             ttl: number;
             swr: number;
         };
@@ -28,6 +41,22 @@ export interface CacheRules {
     pathRules?: PathRule[];
 }
 export declare const DEFAULT_CACHE_RULES: CacheRules;
+interface PathRuleInner extends PathRule {
+    regex: RegExp;
+}
+interface CacheRulesInner {
+    defaults: {
+        live: {
+            ttl: number;
+            swr: number;
+        };
+        preview: {
+            ttl: number;
+            swr: number;
+        };
+    };
+    pathRules?: PathRuleInner[];
+}
 type DeploymentMode = 'live' | 'preview';
 export interface CacheResult {
     found: boolean;
@@ -47,8 +76,15 @@ export interface CacheResult {
 export declare class HtmlCache {
     protected epoch: string;
     protected backend: CacheBackend;
-    protected cacheRules: CacheRules;
+    protected cacheRules: CacheRulesInner;
     constructor(epoch: string, backend: CacheBackend, cacheRules?: CacheRules);
+    /**
+     * Converts wildcard pattern to regex and tests against path.
+     *
+     * - `*` matches any characters except `/`
+     * - `**` matches any characters including `/`
+     */
+    protected convertPathToRegex(pattern: string): RegExp;
     get(request: Request): Promise<CacheResult | null>;
     getWithConditionals(request: Request): Promise<CacheResult | null>;
     put(request: Request, response: Response): Promise<void>;
@@ -62,20 +98,15 @@ export declare class HtmlCache {
     protected ifNoneMatchMatches(ifNoneMatch: string | null, etag: string | null): boolean;
     protected quoteETag(value: string): string;
     protected sanitizeClientHeaders(headers: Headers): void;
+    getCacheKeyHeaders(headers: Headers): Headers;
     protected generateVersionHash(headers: Headers): string;
-    protected extractSwellData(headers: Headers): Record<string, unknown>;
+    protected extractSwellData(cookie: string | null): Record<string, unknown>;
     protected isRequestCacheable(request: Request): boolean;
     protected isResponseCacheable(response: Response, matchedRule?: PathRule): boolean;
     protected getDeploymentMode(headers: Headers): DeploymentMode;
     protected getTTLForRequest(request: Request): number;
     protected getSWRForRequest(request: Request): number;
     protected getEntryAge(entry: CachedEntry): number;
-    /**
-     * Converts wildcard pattern to regex and tests against path.
-     * - * matches any characters except /
-     * - ** matches any characters including /
-     */
-    protected pathMatches(pattern: string, path: string): boolean;
     protected normalizeHeaders(headers: Headers): Record<string, string>;
     protected resolvePathRule(request: Request): {
         rule?: PathRule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swell/apps-sdk",
   "type": "module",
-  "version": "1.0.183",
+  "version": "1.0.184",
   "description": "Swell SDK for building isomorphic apps.",
   "author": "Swell",
   "license": "MIT",
@@ -45,7 +45,6 @@
     "json5": "^2.2.3",
     "keyv": "^5.3.4",
     "liquidjs": "^10.21.0",
-    "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
     "qs": "^6.12.3",
     "strftime": "^0.10.3",
@@ -57,19 +56,18 @@
     "@jest/transform": "^29.7.0",
     "@types/color": "^4.2.0",
     "@types/jest": "^29.5.14",
-    "@types/lodash": "^4.17.15",
     "@types/lodash-es": "^4.17.12",
     "@types/qs": "^6.9.15",
     "@types/react": "^18.2.64",
     "@types/react-dom": "^18.2.21",
     "@types/strftime": "^0.9.8",
     "esbuild": "^0.24.2",
-    "esbuild-jest": "^0.5.0",
     "eslint": "^9.19.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-prettier": "^5.2.3",
     "jest": "29.7.0",
+    "jest-esbuild": "^0.4.0",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
     "ts-jest": "^29.2.5",