fix(js-client)!: enrich circular link dependencies

[maoberlehner]

Instead of manually setting a flag to stop enriching, we now check if an object has already been enriched. This ensures that all linked objects are enriched, even in cases of circular dependencies.

A WeakSet is used to track enriched objects, ensuring they can be garbage collected when no longer referenced.

BREAKING CHANGE: The client's output is no longer guaranteed to be serializable (e.g., with JSON.stringify). Due to the full resolution of circular dependencies, the resulting object graph may contain cycles.

Fixes WDX-146

[Copilot]

Pull Request Overview

This PR fixes circular link dependency handling in the JavaScript client by replacing manual flag-based cycle prevention with a WeakSet-based tracking system. This ensures all linked objects are enriched while properly handling circular references.

• Replaced _stopResolving flag mechanism with a WeakSet to track enriched objects
• Removed manual object copying (_cleanCopy) to allow proper circular reference handling
• Updated tree traversal to use WeakSet for cycle detection instead of path tracking

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[pkg-pr-new]

Open in StackBlitz

@storyblok/astro

npm i https://pkg.pr.new/@storyblok/astro@301

storyblok

npm i https://pkg.pr.new/storyblok@301

@storyblok/eslint-config

npm i https://pkg.pr.new/@storyblok/eslint-config@301

@storyblok/js

npm i https://pkg.pr.new/@storyblok/js@301

storyblok-js-client

npm i https://pkg.pr.new/storyblok-js-client@301

@storyblok/management-api-client

npm i https://pkg.pr.new/@storyblok/management-api-client@301

@storyblok/nuxt

npm i https://pkg.pr.new/@storyblok/nuxt@301

@storyblok/react

npm i https://pkg.pr.new/@storyblok/react@301

@storyblok/region-helper

npm i https://pkg.pr.new/@storyblok/region-helper@301

@storyblok/richtext

npm i https://pkg.pr.new/@storyblok/richtext@301

@storyblok/svelte

npm i https://pkg.pr.new/@storyblok/svelte@301

@storyblok/vue

npm i https://pkg.pr.new/@storyblok/vue@301

commit: 3b02402

[imranolas]

I do like the solution but given that it is a breaking change it might be worth holding off until we're comfortable bumping all the dependants too

[maoberlehner]

Switched to draft mode because we have to further investigate if this is a change we want to do. Postponing the decision to the new content API client.