Typescript interface generator for Strapi 4 models.
npm i --save @dsolodky/types-4-strapi
yarn add @dsolodky/types-4-strapi
Add t4s to your scripts:
"scripts": {
"develop": "strapi develop",
"start": "strapi start",
"build": "strapi build",
"strapi": "strapi",
"t4s": "t4s"
}
Then run with:
npm run t4s
npm i -g @dsolodky/types-4-strapi
or
yarn install @dsolodky/types-4-strapi
Then run with:
t4s
For some inscrutable reason, Strapi 4 returns objects where all the properties (aside from id
) are wrapped into an attributes
object. The resulting interfaces will look like this:
{
id: number;
attributes: {
username: string;
email: string;
provider: string;
confirmed: boolean;
blocked: boolean;
createdAt: Date;
updatedAt: Date;
}
}
However, for some even more inscrutable reason, sometimes the same object is returned "flattened", without an attributes
object. This is the case, for instance, for the /api/users
endpoint, which returns an array of Users with the following structure:
{
id: number;
username: string;
email: string;
provider: string;
confirmed: boolean;
blocked: boolean;
createdAt: Date;
updatedAt: Date;
}
The same "flat" structure is also required when submitting the body of POST
and PUT
requests. Here is an example using fetch
.
// correct
await fetch('https://project.com/api/users', {
method: 'POST',
body: JSON.stringify({
username: 'Jon Snow',
email: '[email protected]',
}),
});
// incorrect
await fetch('https://project.com/api/users', {
method: 'POST',
body: JSON.stringify({
attributes: {
username: 'Jon Snow',
email: '[email protected]',
},
}),
});
In these cases, you can use the entity types with suffix "Flat":
import {Entity, FlatEntity} from 'types/Entity';
///export FlatEntity = Entity['attributes'];
Content manager (CM) plugin stores its data in flattened way, so in order to let that code to be strongly typed, the CM_XXX types are being generated.