@alchemy_cms/json_api 3.0.1 → 5.0.0

package/README.md

@@ -1,106 +1,48 @@
-# Alchemy::JsonApi
+# @alchemy_cms/json_api
 
-A JSON-API based API for AlchemyCMS
+The JavaScript/TypeScript deserializer for [AlchemyCMS](https://github.com/AlchemyCMS/alchemy_cms)'s JSON:API.
 
 ## Installation
 
-### In your Alchemy Rails project
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'alchemy-json_api'
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-
 ```bash
-$ gem install alchemy-json_api
-```
-
-### In your JS/Frontend app
-
-Run this in your application:
-
-```
 npm install @alchemy_cms/json_api --save
 ```
 
-or with the package manager of your choice
+or with the package manager of your choice.
 
 ## Usage
 
-### In your Rails app
-
-Mount the engine in your Alchemy Rails app like this:
-
-```rb
-# config/routes.rb
-mount Alchemy::JsonApi::Engine => "/jsonapi/"
-```
-
-> __NOTE__ Pick any path you like. This will be the **prefix** of your API URLs
+`deserialize` converts a JSON:API response into plain JS objects: each
+resource's attributes are flattened with its `id`, and relationships present in
+`included` become nested objects (absent ones become `{ id }` stubs).
 
-### In your frontend app
+Each included resource is materialized **once** and shared by every reference
+to it, so the result stays proportional to the size of the response even when
+resources reference each other heavily. A consequence is that back-references
+(e.g. a menu node's `parent`, which lists the node among its `children`) are
+real references, and the result may contain **cycles**:
 
-This repo provides an NPM package with deserializers to help you convert the response into JS objects.
+- `structuredClone`, [devalue](https://github.com/sveltejs/devalue) (Nuxt
+  payloads) and Vue/React state handle this fine.
+- `JSON.stringify` does not. If you need JSON, serialize a projection of the
+  fields you need, or use a cycle-aware serializer.
+- Mutating a resource is visible everywhere it is referenced. Copy before
+  mutating.
 
 ```js
-import { deserializePages } from "@alchemy_cms/json_api"
+import { deserialize } from "@alchemy_cms/json_api"
 
-const response = await fetch("/jsonapi/pages.json")
-const data = await response.json()
-const pages = deserializePages(data)
+const response = await fetch("/jsonapi/pages/homepage.json")
+const page = deserialize(await response.json())
 
-console.log(pages[0].name) // => Homepage
+console.log(page.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`.
+`deserializePage` and `deserializePages` still exist as thin, **deprecated**
+aliases for `deserialize`; prefer `deserialize`.
 
 ## 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).
+This package lives in the [`javascript/`](https://github.com/AlchemyCMS/alchemy-json_api/tree/main/javascript)
+directory of the `alchemy-json_api` monorepo. Releases are automated with
+release-please and tagged `package-vX.Y.Z`.

package/dist/alchemy-json_api.js

@@ -1,24 +1,14 @@
-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;
+import e from "./deserialize.js";
+//#region src/alchemyApiDeserializer.ts
+var t = /* @__PURE__ */ new Set();
+function n(e) {
+	t.has(e) || (t.add(e), console.warn(`[@alchemy_cms/json_api] \`${e}\` is deprecated; use \`deserialize\` instead.`));
 }
-function d(t) {
-  const s = r(t);
-  return s.elements = n(s.elements), s;
+function r(t) {
+	return n("deserializePage"), e(t);
 }
-function f(t) {
-  const s = r(t);
-  return s.forEach((e) => {
-    e.elements = n(e.elements);
-  }), s;
+function i(t) {
+	return n("deserializePages"), e(t);
 }
-export {
-  r as deserialize,
-  d as deserializePage,
-  f as deserializePages
-};
+//#endregion
+export { e as deserialize, r as deserializePage, i as deserializePages };

package/dist/alchemyApiDeserializer.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Deserializes a JSON:API page document.
+ *
+ * @deprecated Use `deserialize` instead. `deserializePage` used to strip
+ * deprecated elements, but `deprecated` is an admin-only hint and must not
+ * alter the serialized output, so this is now only a thin wrapper around
+ * `deserialize`.
+ */
+export declare function deserializePage<T = unknown>(pageData: unknown): T;
+/**
+ * Deserializes a collection of JSON:API page documents.
+ *
+ * @deprecated Use `deserialize` instead; see `deserializePage`.
+ */
+export declare function deserializePages<T = unknown>(pagesData: unknown): T[];

package/dist/deserialize.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Deserialize a JSON:API document into plain objects, sharing one object per
+ * resource. The result may contain reference cycles.
+ *
+ * The `document` is a raw API response with no compile-time shape, so the
+ * parameter is `unknown`. The caller names the shape it expects out via `T`;
+ * this function is the boundary that turns the untyped response into it.
+ *
+ * @example
+ *   const product = deserialize<Product>(apiResponse)
+ */
+export declare function deserialize<T = unknown>(document: unknown): T;
+export default deserialize;

package/dist/deserialize.js

@@ -1,44 +1,21 @@
-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 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 r;
-}
-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 {
-  y as deserialize
+//#region src/deserialize.ts
+var e = ({ type: e, id: t }) => `${e}:${t}`, t = ({ id: e }) => ({ id: e }), n = (t) => new Map(t.map((t) => [e(t), t])), r = (n, r, i) => {
+	let o = n.get(e(i));
+	return o ? a(n, r, o) : t(i);
+}, i = (e, t, n) => Array.isArray(n) ? n.map((n) => r(e, t, n)) : n ? r(e, t, n) : null, a = (t, n, r) => {
+	let a = e(r), o = n.get(a);
+	if (o) return o;
+	let s = {
+		...r.attributes,
+		id: r.id
+	};
+	n.set(a, s);
+	for (let [e, a] of Object.entries(r.relationships ?? {})) s[e] = i(t, n, a?.data ?? null);
+	return s;
 };
+function o(e) {
+	let { data: t = null, included: r = [] } = e == null ? {} : structuredClone(e), i = n(r), o = /* @__PURE__ */ new Map(), s = (e) => a(i, o, e);
+	return Array.isArray(t) ? t.map(s) : t ? s(t) : null;
+}
+//#endregion
+export { o as default, o as deserialize };

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from "./alchemyApiDeserializer";
+export * from "./deserialize";

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@alchemy_cms/json_api",
-  "version": "3.0.1",
+  "version": "5.0.0",
   "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"
+  "engines": {
+    "node": ">=20.19.0"
   },
   "keywords": [
     "AlchemyCMS",
@@ -22,18 +22,32 @@
     "Thomas von Deyen"
   ],
   "main": "dist/alchemy-json_api.js",
+  "types": "dist/main.d.ts",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "import": "./dist/alchemy-json_api.js"
+    },
+    "./deserialize": {
+      "types": "./dist/deserialize.d.ts",
+      "import": "./dist/deserialize.js"
+    }
+  },
   "files": [
     "dist"
   ],
   "devDependencies": {
     "prettier": "^3.3.3",
-    "vite": "^7.0.4",
-    "vitest": "^3.2.4"
+    "typescript": "^7.0.2",
+    "vite": "^8.0.0",
+    "vitest": "^4.0.10"
   },
   "scripts": {
-    "build": "vite build",
-    "lint": "prettier --check 'src/**/*.js'",
+    "build": "vite build && tsc -p tsconfig.json",
+    "prepare": "pnpm run build",
+    "lint": "prettier --check 'src/**/*.ts'",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
     "test": "vitest"
   },
   "packageManager": "pnpm@10.12.1"

package/LICENSE

@@ -1,11 +0,0 @@
-Copyright 2020 Martin Meyerhoff, Thomas von Deyen
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.