configEntries not containing overridden values

[dajinchu]

I would like to be able to get overridden config values in configEntires.

Use case: I have documentProps that contains viewport, which I'd like to set a default in renderer/config.h.ts while being able to override documentProps at a per-page level.

I understand this behavior works by default if I pulled viewport out into its own config and set it in passToClient, but I'd rather have configs logically grouped if possible, then when accessing documentProps I can shallow merge the overridden values.

Is configEntries not meant to include overridden values?

[brillout]

Yes it's on the radar.

Is configEntries not meant to include overridden values?

It only includes values that are loaded. Overriden values aren't loaded (to save loading time).

That's why a new meta property is needed:

export default {
  meta: {
    viewport: {
      cumulative: true
      /* Alternative naming:
      aggregate: true
      override: false
      overridable: false
      */
    }
  }
}

but I'd rather have configs logically grouped if possible, then when accessing documentProps I can shallow merge the overridden values.

I'm not sure I understand your use case, do you mind elaborating?

[brillout]

A week or so is great.

👍 I'll keep you updated how that goes. The duration of this internal refactor isn't easy to predict.

[brillout]

The new internal data structure is implemented (unlocks cumulative and many other things such as reduced cilent-side KBs, Single Route File, ...).

I expect it to now only be a matter of days. ETA sometime next week.

[dajinchu]

Awesome! super excited

[brillout]

Done and pre-released in 0.4.140-commit-710acc9. I hope the delay was ok for you (as always: let me know if something is a blocker).

If you can wait a little bit more, I'll be polishing a couple of internals and then release a new minor. You can use the pre-release in the meantime.

// +config.h.js
export default {
  meta: {
    viewport: {
      cumulative: true
    }
  },
  viewport: [500]
}

Cumulative configs have a couple of minor limitations, let me know if one of these are problematic for you. (I expect the limitations to not be a problem for the vast majority of cumulative configs.)

[brillout]

Released in 0.4.141.

[brillout]

@dajinchu 0.4.169 contains a breaking change about custom configs that are cumulative.

// /pages/+config.js

export default {
  someCumulativeConfig: ['a']
}

// /pages/some-page/+config.js

export default {
  someCumulativeConfig: ['b']
}

Breaking change:

// <= 0.4.168
console.log(pageContext.config.someCumulativeConfig) // prints ['a', 'b']

// >= 0.4.169
console.log(pageContext.config.someCumulativeConfig) // prints [['a'], ['b']]

Thus make sure to apply this change:

- const val = pageContext.config.someCumulativeConfig
+ // @ts-ignore
+ const val: string[] = pageContext.config.someCumulativeConfig.flat()

The @ts-ignore is because the TS type of pageContext.config is now broken for cumulative configs, which is something that is going to be fixed in the next release.

This breaking change is important for many reasons (and given that only few use it didn't seem to justify bumping to 0.5).

As always let me know if you run into any issues, and thank you a lot for sponsoring 💚 it makes a massive difference.

[brillout]

The @ts-ignore is because the TS type of pageContext.config is now broken for cumulative configs, which is something that is going to be fixed in the next release.

@dajinchu Done: see Vike.ConfigResolved at https://vike.dev/meta#typescript. Make sure to upgrade to 0.4.172.