@alchemy_cms/json_api 2.0.0 → 3.0.1

package/README.md

@@ -13,11 +13,13 @@ gem 'alchemy-json_api'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install alchemy-json_api
 ```
@@ -27,9 +29,11 @@ $ gem install alchemy-json_api
 Run this in your application:
 
 ```
-yarn add "@alchemy_cms/json_api"
+npm install @alchemy_cms/json_api --save
 ```
 
+or with the package manager of your choice
+
 ## Usage
 
 ### In your Rails app
@@ -57,18 +61,46 @@ 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
 ```
 
 It defaults to `:underscore`.
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause).

package/dist/alchemy-json_api.js

@@ -1,132 +1,24 @@
-import structuredClone from '@ungap/structured-clone';
-
-function deserialize(originalResponse, options = {}) {
-  const response = structuredClone(originalResponse);
-  if (!options) {
-    options = {};
-  }
-
-  const included = response.included || [];
-
-  if (Array.isArray(response.data)) {
-    return response.data.map((data) => {
-      return parseJsonApiSimpleResourceData(data, included, false)
-    })
-  } else {
-    return parseJsonApiSimpleResourceData(
-      response.data,
-      included,
-      false)
-  }
+import { deserialize as r } from "./deserialize.js";
+function n(t) {
+  const s = [];
+  return t.forEach((e) => {
+    e.nested_elements?.length > 0 && (e.nested_elements = n(
+      e.nested_elements
+    )), 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 parseJsonApiSimpleResourceData(data, included, useCache, options) {
-  if (!included.cached) {
-    included.cached = {};
-  }
-
-  if (!(data.type in included.cached)) {
-    included.cached[data.type] = {};
-  }
-
-  if (useCache && data.id in included.cached[data.type]) {
-    return included.cached[data.type][data.id]
-  }
-
-  const attributes = data.attributes || {};
-
-  const resource = attributes;
-  resource.id = data.id;
-
-  included.cached[data.type][data.id] = resource;
-
-  if (data.relationships) {
-    for (const relationName of Object.keys(data.relationships)) {
-      const relationRef = data.relationships[relationName];
-
-      if (Array.isArray(relationRef.data)) {
-        const items = [];
-
-        relationRef.data.forEach((relationData) => {
-          const item = findJsonApiIncluded(
-            included,
-            relationData.type,
-            relationData.id);
-
-          items.push(item);
-        });
-
-        resource[relationName] = items;
-      } else if (relationRef && relationRef.data) {
-        resource[relationName] = findJsonApiIncluded(
-          included,
-          relationRef.data.type,
-          relationRef.data.id);
-      } else {
-        resource[relationName] = null;
-      }
-    }
-  }
-
-  return resource
+function d(t) {
+  const s = r(t);
+  return s.elements = n(s.elements), s;
 }
-
-function findJsonApiIncluded(included, type, id, options) {
-  let found = null;
-
-  included.forEach((item) => {
-    if (item.type === type && item.id === id) {
-      found = parseJsonApiSimpleResourceData(item, included, true);
-    }
-  });
-
-  if (!found) {
-    found = { id };
-  }
-
-  return found
+function f(t) {
+  const s = r(t);
+  return s.forEach((e) => {
+    e.elements = n(e.elements);
+  }), s;
 }
-
-// Recursively filters all deprecated elements and essences from collection
-function filterDeprecatedElements(elements) {
-  const els = [];
-
-  elements.forEach((element) => {
-    if (element.nested_elements?.length > 0) {
-      element.nested_elements = filterDeprecatedElements(
-        element.nested_elements
-      );
-    }
-    if (element.nestedElements?.length > 0) {
-      element.nestedElements = filterDeprecatedElements(element.nestedElements);
-    }
-    if (element.essences?.length > 0) {
-      element.essences = element.essences.filter((essence) => {
-        return !essence.deprecated
-      });
-    }
-    if (!element.deprecated) {
-      els.push(element);
-    }
-  });
-
-  return els
-}
-
-// Returns deserialized page without deprecated content
-function deserializePage(pageData) {
-  const page = deserialize(pageData);
-  page.elements = filterDeprecatedElements(page.elements);
-  return page
-}
-
-// Returns deserialized pages without deprecated content
-function deserializePages(pagesData) {
-  const pages = deserialize(pagesData);
-  pages.forEach((page) => {
-    page.elements = filterDeprecatedElements(page.elements);
-  });
-  return pages
-}
-
-export { deserialize, deserializePage, deserializePages };
+export {
+  r as deserialize,
+  d as deserializePage,
+  f as deserializePages
+};

package/dist/deserialize.js

@@ -1,90 +1,44 @@
-import structuredClone from '@ungap/structured-clone';
-
-function deserialize(originalResponse, options = {}) {
-  const response = structuredClone(originalResponse);
-  if (!options) {
-    options = {};
-  }
-
-  const included = response.included || [];
-
-  if (Array.isArray(response.data)) {
-    return response.data.map((data) => {
-      return parseJsonApiSimpleResourceData(data, included, false)
-    })
-  } else {
-    return parseJsonApiSimpleResourceData(
-      response.data,
-      included,
-      false)
-  }
+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,
+    o,
+    !1
+  );
 }
-
-function parseJsonApiSimpleResourceData(data, included, useCache, options) {
-  if (!included.cached) {
-    included.cached = {};
-  }
-
-  if (!(data.type in included.cached)) {
-    included.cached[data.type] = {};
-  }
-
-  if (useCache && data.id in included.cached[data.type]) {
-    return included.cached[data.type][data.id]
-  }
-
-  const attributes = data.attributes || {};
-
-  const resource = attributes;
-  resource.id = data.id;
-
-  included.cached[data.type][data.id] = resource;
-
-  if (data.relationships) {
-    for (const relationName of Object.keys(data.relationships)) {
-      const relationRef = data.relationships[relationName];
-
-      if (Array.isArray(relationRef.data)) {
-        const items = [];
-
-        relationRef.data.forEach((relationData) => {
-          const item = findJsonApiIncluded(
-            included,
-            relationData.type,
-            relationData.id);
-
-          items.push(item);
-        });
-
-        resource[relationName] = items;
-      } else if (relationRef && relationRef.data) {
-        resource[relationName] = findJsonApiIncluded(
-          included,
-          relationRef.data.type,
-          relationRef.data.id);
-      } else {
-        resource[relationName] = null;
-      }
+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 n = e.relationships[c];
+      if (Array.isArray(n.data)) {
+        const p = [];
+        n.data.forEach((a) => {
+          const h = u(
+            t,
+            a.type,
+            a.id
+          );
+          p.push(h);
+        }), r[c] = p;
+      } else n && n.data ? r[c] = u(
+        t,
+        n.data.type,
+        n.data.id
+      ) : r[c] = null;
     }
-  }
-
-  return resource
+  return r;
 }
-
-function findJsonApiIncluded(included, type, id, options) {
-  let found = null;
-
-  included.forEach((item) => {
-    if (item.type === type && item.id === id) {
-      found = parseJsonApiSimpleResourceData(item, included, true);
-    }
-  });
-
-  if (!found) {
-    found = { id };
-  }
-
-  return found
+function u(e, t, s, o) {
+  let i = null;
+  return e.forEach((r) => {
+    r.type === t && r.id === s && (i = f(r, e, !0));
+  }), i || (i = { id: s }), i;
 }
-
-export { deserialize };
+export {
+  y as deserialize
+};

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@alchemy_cms/json_api",
-  "version": "2.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",
@@ -14,6 +17,7 @@
     "headless"
   ],
   "authors": [
+    "Lasse Diercks",
     "Martin Meyerhoff",
     "Thomas von Deyen"
   ],
@@ -22,22 +26,15 @@
   "files": [
     "dist"
   ],
-  "dependencies": {
-    "@ungap/structured-clone": "^1.0.1"
-  },
   "devDependencies": {
-    "@babel/core": "^7.19.0",
-    "@babel/preset-env": "^7.19.0",
-    "@rollup/plugin-babel": "^6.0.4",
-    "babel-jest": "^29.0.2",
-    "jest": "^29.0.2",
     "prettier": "^3.3.3",
-    "rollup": "^4.24.4"
+    "vite": "^7.0.4",
+    "vitest": "^3.2.4"
   },
   "scripts": {
-    "build": "rollup --config",
+    "build": "vite build",
     "lint": "prettier --check 'src/**/*.js'",
-    "test": "jest"
+    "test": "vitest"
   },
-  "browserslist": "> 0.25%, not dead"
+  "packageManager": "pnpm@10.12.1"
 }