Adding Types to Medusa Configuration Export

[adevinwild]

Hi 👋
Users can customize the platform by exporting a configuration object and it's really great!
However, there is currently no explicit documentation for the configuration object's properties, making it difficult to determine which features are accessible for customization.

I propose adding types by default to the Medusa configuration object in order to give better description for the accessible properties.

Proposal

The addition of JSDoc types to the module is our suggestion.
Objects are exported in the medusa-config.js file. The format suggested is:

/** @type {import('@medusajs/medusa').ConfigModule} */

This will improve TypeScript support and allow developers to work more efficiently.

What do you think about it?

[srindom]

Think this is excellent - we should definitely do this. Is it something you'd be interested in working on?

[adevinwild]

Totally, I would love to contribute to it in order to add it 🙌🏼

[adevinwild]

Yay! 🎉
I've updated the medusa-starter-default since that's where the configuration came from according to my research (CLI , create-medusa-app)

medusajs/medusa-starter-default#37

[olivermrbl]

Thanks for the contribution @adevinwild. I just added a comment on your PR :)

[olivermrbl]

Merged #37

[srindom]

@adevinwild, thanks for contributing! If you are up for it, I think it would also be great to add JSDoc descriptions to the properties here so they are available as you type. Do you want to jump on this too?

[adevinwild]

With pleasure, I will take care of it during the day 👍

[adevinwild]

Hey @srindom
I'm trying to find some info about the database_schema option inside the ConfigModule

Is it a property deprecated ? Default is put to public and is used a bit with some files :
https://github.com/medusajs/medusa/search?q=database_schema

Found some info about it here too :
ad2974a

But it seems that this is no longer emphasized, Is it because the search_pathparameter in a Postgres URL replaces this property?