@alchemy_cms/json_api 3.0.0 → 3.0.1

package/README.md

@@ -61,11 +61,37 @@ const pages = deserializePages(data)
 console.log(pages[0].name) // => Homepage
 ```
 
+## HTTP Caching
+
+Alchemy::JsonApi allows for caching API responses. It respects the caching configuration of your Rails app and of your Alchemy configuration and settings in the pages page layout configuration. Restricted pages are never cached.
+
+By default it sets the `max-age` `Cache-Control` header to 10 minutes (`600` seconds). You can change this by configuring the `Alchemy::JsonApi.page_cache_max_age` setting. It is recommended to set this via an environment variable like this:
+
+```rb
+# config/initializers/alchemy_json_api.rb
+Alchemy::JsonApi.page_cache_max_age = ENV.fetch("ALCHEMY_JSON_API_CACHE_DURATION", 600).to_i
+```
+
+### Edge Caching
+
+Alchemy sets the `must-revalidate` directive if caching is enabled. If your CDN supports it, you can change that to use the much more efficient `stale-while-revalidate` directive by changing the `Alchemy::JsonApi.page_caching_options` setting to any integer value.
+
+```rb
+# config/initializers/alchemy_json_api.rb
+Alchemy::JsonApi.page_caching_options = {
+  stale_while_revalidate: ENV.fetch("ALCHEMY_JSON_API_CACHE_STALE_WHILE_REVALIDATE", 60).to_i
+}
+```
+
+> [!TIP]
+> You can set any caching option that [`ActionController::ConditionalGet#expires_in` supports](https://api.rubyonrails.org/classes/ActionController/ConditionalGet.html#method-i-expires_in), like `stale_if_error`, `public` or `immutable`.
+
 ## Key transforms
 
 If you ever want to change how Alchemy serializes attributes you can set
 
 ```rb
+# config/initializers/alchemy_json_api.rb
 Alchemy::JsonApi.key_transform = :camel_lower
 ```
 

package/dist/alchemy-json_api.js

@@ -1,25 +1,24 @@
-import { deserialize as d } from "./deserialize.js";
+import { deserialize as r } from "./deserialize.js";
 function n(t) {
   const s = [];
   return t.forEach((e) => {
-    var r, i, c;
-    ((r = e.nested_elements) == null ? void 0 : r.length) > 0 && (e.nested_elements = n(
+    e.nested_elements?.length > 0 && (e.nested_elements = n(
       e.nested_elements
-    )), ((i = e.nestedElements) == null ? void 0 : i.length) > 0 && (e.nestedElements = n(e.nestedElements)), ((c = e.essences) == null ? void 0 : c.length) > 0 && (e.essences = e.essences.filter((f) => !f.deprecated)), e.deprecated || s.push(e);
+    )), e.nestedElements?.length > 0 && (e.nestedElements = n(e.nestedElements)), e.essences?.length > 0 && (e.essences = e.essences.filter((i) => !i.deprecated)), e.deprecated || s.push(e);
   }), s;
 }
-function o(t) {
-  const s = d(t);
+function d(t) {
+  const s = r(t);
   return s.elements = n(s.elements), s;
 }
-function l(t) {
-  const s = d(t);
+function f(t) {
+  const s = r(t);
   return s.forEach((e) => {
     e.elements = n(e.elements);
   }), s;
 }
 export {
-  d as deserialize,
-  o as deserializePage,
-  l as deserializePages
+  r as deserialize,
+  d as deserializePage,
+  f as deserializePages
 };

package/dist/deserialize.js

@@ -1,45 +1,44 @@
-import y from "@ungap/structured-clone";
-function A(e, r = {}) {
-  const s = y(e);
-  r || (r = {});
-  const n = s.included || [];
-  return Array.isArray(s.data) ? s.data.map((i) => f(i, n, !1)) : f(
+function y(e, t = {}) {
+  const s = structuredClone(e);
+  t || (t = {});
+  const o = s.included || [];
+  return Array.isArray(s.data) ? s.data.map((i) => f(i, o, !1)) : f(
     s.data,
-    n,
+    o,
     !1
   );
 }
-function f(e, r, s, n) {
-  if (r.cached || (r.cached = {}), e.type in r.cached || (r.cached[e.type] = {}), s && e.id in r.cached[e.type])
-    return r.cached[e.type][e.id];
-  const t = e.attributes || {};
-  if (t.id = e.id, r.cached[e.type][e.id] = t, e.relationships)
+function f(e, t, s, o) {
+  if (t.cached || (t.cached = {}), e.type in t.cached || (t.cached[e.type] = {}), s && e.id in t.cached[e.type])
+    return t.cached[e.type][e.id];
+  const r = e.attributes || {};
+  if (r.id = e.id, t.cached[e.type][e.id] = r, e.relationships)
     for (const c of Object.keys(e.relationships)) {
-      const o = e.relationships[c];
-      if (Array.isArray(o.data)) {
+      const n = e.relationships[c];
+      if (Array.isArray(n.data)) {
         const p = [];
-        o.data.forEach((a) => {
+        n.data.forEach((a) => {
           const h = u(
-            r,
+            t,
             a.type,
             a.id
           );
           p.push(h);
-        }), t[c] = p;
-      } else o && o.data ? t[c] = u(
-        r,
-        o.data.type,
-        o.data.id
-      ) : t[c] = null;
+        }), r[c] = p;
+      } else n && n.data ? r[c] = u(
+        t,
+        n.data.type,
+        n.data.id
+      ) : r[c] = null;
     }
-  return t;
+  return r;
 }
-function u(e, r, s, n) {
+function u(e, t, s, o) {
   let i = null;
-  return e.forEach((t) => {
-    t.type === r && t.id === s && (i = f(t, e, !0));
+  return e.forEach((r) => {
+    r.type === t && r.id === s && (i = f(r, e, !0));
   }), i || (i = { id: s }), i;
 }
 export {
-  A as deserialize
+  y as deserialize
 };

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@alchemy_cms/json_api",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "JSON API deserializer for AlchemyCMS",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AlchemyCMS/alchemy-json_api.git"
   },
+  "engines" : {
+    "node" : ">=20.19.0"
+  },
   "keywords": [
     "AlchemyCMS",
     "json:api",
@@ -23,12 +26,9 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@ungap/structured-clone": "^1.0.1"
-  },
   "devDependencies": {
     "prettier": "^3.3.3",
-    "vite": "^6.3.5",
+    "vite": "^7.0.4",
     "vitest": "^3.2.4"
   },
   "scripts": {