Default link resolution has wrong types

[flagoon]

Actual Behaviour

Here's the method I'm using for getting data from Contentful:

export type EntriesWithSlug = TypePageSkeleton | TypeBlogPostSkeleton;

export const getEntryBySlug = (contentType) =>
  async (slug) => {
    const entries = await client.getEntries<EntriesWithSlug>({
      content_type: contentType,
      "fields.slug": slug,
      include: 3,
    });

    const entry = entries.items[0];
    return entry;
  };

In documentation, in ADVANCED.md file, is written, that by default, the links will be resolved, and the ones that can't be resolved, will be treated as unresolved. And when checking the Entry in app, the links are resolved, but the return types are treating all links as unresolved.

So I can use something like:

   const someLinkedEntry = entry.fields.linkedEntry.fields.name

But typescript will suggest that linedEntry is unresolved

  const unresolvedEntry = entry.fields.linkedEntry.sys... <- which is wrong

If I use chain modifier, like withoutLinkResolution or withoutUnresolvableLinks the entry data is precisely the same as the types.

Environment

• Language Version: node 20.13.1
• Package Manager Version: pnpm 9.12.3
• Package Version: "contentful": "^11.2.0",
• Which API are you using?: Delivery

[ethan-ozelius-contentful]

Hello, apologies for the extremely delayed response. This issue was raised well before I joined the team that maintains contentful.js.

I'm having a bit of trouble understanding what the ask here is. Typescript cannot know exactly what shape your entries take ahead of time, said another way, typescript doesn't have any visibility into what fields you have added to your content model. So even if I have a content model like:

{
    "sys": {
        "space": { ... },
        "id": "11JCWWgFEGu2pdTVFNpZLd",
        "type": "Entry"
        // ...
    },
    "fields": {
        "name": "Alex Elevante",
        // referenced entry
        "skills": [
            {
                "sys": {
                    "space": {
                       // ...
                    },
                    "id": "4XJ0dfg6SE8lxJb6L5xttL",
                    "type": "Entry",
                    // ...
                },
                "fields": {
                    "skill": "gitlab"
                }
            },
            {
                "sys": {
                    "space": {
                       // ...
                    },
                    "id": "4XJ0dfg6SE8lxJb6L5xttL",
                    "type": "Entry",
                    // ...
                },
                "fields": {
                    "skill": "web development"
                }
            }
        ]
    }
}

Unless I create a specific type, I will be unable to do typescript stuff like:

const originalEntry = client.getEntry('<my_entry_id>')
const linkedEntry: Entry = originalEntry.fields.skills[0].fields.skill

You would have to create something like:

type LinkedEntryType extends Entry {
  fields: {
    skill: string 
  }
}

As a workaround, I'd suggest investigating https://github.com/contentful-userland/cf-content-types-generator which is a separate package to generate types based on your content model.