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.
npm i --save-dev @item-enonic-types/global
npm i --save-dev @item-enonic-types/lib-menuWe 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:
{
"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:
{
"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.
import type { Article } from "../../site/content-types"; // 1
import { get as getOne, type Content } from "/lib/xp/content"; // 2
type ContentArticle = Content<Article, "my.awesome.project:Article">;
export function get(req: XP.Request): XP.Response { // 3
const content = getOne<ContentArticle>({
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<T>(value: T): asserts value is NonNullable<T> {
if (value === undefined || value === null) {
throw new Error(`${value} is not defined`);
}
}- We import an
type Article = { ... }generated by xp-codegen-plugin. - The standard XP-libraries are mapped to their paths by the change to tsconfig.json.
- We use
XP.RequestandXP.Responseto control the shape of our controller. contentis of the typeContent<Article> | null, but we can "assert" that it is not nullable (or throw an exception here if it is).