feat: add cookie config

[luke-z]

As this is my first open source pr, I hope I did everything well :)

Types of changes

• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

Currently the strapi token is saved as a session cookie which expires as soon as the browser is closed.

Back in v0, there was a config option which allowed to set the expires property.
With this pull request I have added such a feature.

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes (if not applicable, please state why)

[benjamincanac]

Hi @luke-z,

First of all, thank you for this PR!

Back in the v0 of the module, the expires key was here to tell the module to use sessionStorage instead of cookies. With this new module, we're only using cookies and the default is indeed set as session as stated in the Nuxt 3 useCookie expires documentation, which will behave differently depending on the browser.

To change this behaviour, I would rather only have a cookie key in the options, typed by CookieOptions to configure useCookie composable.

[luke-z]

Hello @benjamincanac

Thank you for the feedback!
It makes more sense to have all the options available.

I changed the config from expires to cookie as you suggested and updated the docs.

[benjamincanac]

@danielroe To confirm with you, is this the right way to get this type? Shouldn't it be #app/composables/cookie?

[luke-z]

I just tried using the type without any import, this results in the build error

error TS4033: Property 'cookie' of exported interface has or is using private name 'CookieOptions'.

[benjamincanac]

With nuxt3 import it resulted into a build error, I've updated it with the #app alias but we still have a warning on build:

WARN  Inlining implicit external #app/composables/cookie                                                                                                                    

'#app/composables/cookie' is imported by src/types/index.ts, but could not be resolved – treating it as an external dependency

I'm gonna wait for Daniel validation on this.

[luke-z]

I put #app in the build.config.ts, which seems to resolve the problem (I am not familiar with unbuild)

externals: ['@nuxt/kit', '@nuxt/schema', 'vue', '#app']

[danielroe]

The #app alias won't work in published libraries, unless those library source files are added in the end user's tsconfig.json include array. So you'll need to use 'nuxt3/dist/app/composables/cookie but add nuxt3 to your externals list in your build config.

(This is a unique point for types. For any runtime import of the cookie composable we should import directly from #app or #imports.)

[benjamincanac]

Thanks a lot @danielroe, it works perfectly!

[luke-z]

Next time I definitely need to go for lint & build, just checking if it works while in dev mode is not a good approach...

Thank you for the improvements & fixes!

const cookie = useCookie<string | null>('strapi_jwt', config.strapi.cookie) looks a lot cleaner :)