TypeScript types for Enonic XP
npm install enonic-types> [!NOTE]
> There now exists official TypeScript-types from Enonic.
> The new purpose of this library will be to provide types for all the libraries that doesn't have official support yet.
You can install individual packages with support for Enonic libraries like this:
You can find the complete list of supported packages on npm.
``bash`
npm i --save-dev @item-enonic-types/global
npm i --save-dev @item-enonic-types/lib-menu
We recommend using starter-tsup as the base of your XP-project.
To add the TypeScript-types you need to update your tsconfig.json with the following:
`json`
{
"compilerOptions": {
"target": "es5",
"strict": true,
"sourceMap": true,
"allowJs": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"strictNullChecks": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"module": "commonjs",
"moduleResolution": "node",
"types": ["@item-enonic-types/global"],
"rootDirs": [
"./src/main/resources",
"./.xp-codegen"
],
"paths": {
"/lib/xp/": ["./node_modules/@enonic-types/lib-"],
"/lib/": [ "./node_modules/@item-enonic-types/lib-" ,"./src/main/resources/lib/*"],
"/site/": ["./src/main/resources/site/" ,"./.xp-codegen/site/*"]
}
},
"include": [
"./.xp-codegen/*/",
"./src/main/resources/*/"
],
"exclude": ["./build/*"]
}
Note that individual packages that are not directly under "/lib/..." needs to be mapped separately.
An example is Freemarker:
`diff`
{
"compilerOptions": {
"paths": {
+ "/lib/tineikt/freemarker": ["./node_modules/@item-enonic-types/lib-freemarker"]
}
}
}
We recommend using this library together with the xp-codegen-plugin Gradle plugin. xp-codegen-plugin will create a TypeScript type for your content-types. Those interfaces will be very useful together with this library.
We have an Enonic service that returns an article by id.
`typescript
import type { Article } from "../../site/content-types"; // 1
import { get as getOne, type Content } from "/lib/xp/content"; // 2
type ContentArticle = Content
export function get(req: XP.Request): XP.Response { // 3
const content = getOne
key: req.params.id!
});
assertIsDefined(content); // 4
const article: Article = content.data;
return {
status: 200,
body: article
}
}
/**
* Create this function in a utilities file of your choice...
*/
function assertIsDefined
if (value === undefined || value === null) {
throw new Error(${value} is not defined);`
}
}
1. We import an type Article = { ... } generated by xp-codegen-plugin.XP.Request
2. The standard XP-libraries are mapped to their paths by the change to tsconfig.json.
3. We use and XP.Response to control the shape of our controller.content
4. is of the type Content
Supported libraries
* CacheLibrary
* CronLibrary
* ExplorerLibrary
* FreeMarkerLibrary
* GraphQLLibrary
* HttpClientLibrary
* MenuLibrary
* MustacheLibrary
* NotificationsLibrary
* QRCodeLibrary
* RecaptchaLibrary
* RouterLibrary
* SqlLibrary
* TestingLibrary
* TextEncodingLibrary
* ThymeleafLibrary
* XsltLibrary