Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

enonic-types

Package Overview
Dependencies
Maintainers
1
Versions
179
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

enonic-types

TypeScript types for Enonic XP

  • 0.1.28
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
31K
increased by5627.02%
Maintainers
1
Weekly downloads
 
Created
Source

TypeScript types for Enonic XP

npm version

This library contains TypeScript types for Enonic XP.

Code generation

We recommend using this library together with the xp-codegen-plugin Gradle plugin. xp-codegen-plugin will create TypeScript interfaces for your content-types. Those interfaces will be very useful together with this library.

Example

We have an Enonic service that returns an article by id.

import { Request, Response } from "enonic-types/controller";
import { Article } from "../../site/content-types/article/article"; // 1

const contentLib = __non_webpack_require__("/lib/xp/content"); // 2

export function get(req: Request): Response { // 3
  const content = contentLib.get<Article>({ key: req.params.id! });

  if (content !== null) { // 4
    const article: Article = content.data;

    return { status: 200, body: article }
  } else {
    return { status: 404 };
  }
}
  1. We import an interface Article { ... } generated by xp-codegen-plugin.
  2. When we import something with __non_webpack_require__, it will automatically look up the correct interfaces for XP-libraries if __non_webpack_require__ is defined correctly (see below).
  3. We use the imported Request and Response to control the shape of our controller.
  4. content is of the type Content<Article> | null, so we have to do a null check before proceiding.

Declare __non_webpack_require__

Your project should have a types.ts file where you can specify declarations.

If you add (or replace the existing) __non_webpack_require__() function with the following code, it will automatically look up the correct interfaces for Enonic XP-libraries.

type LibMap = import("enonic-types").EnonicLibraryMap;

declare const __non_webpack_require__: <K extends keyof LibMap | string = string>(path: K) => K extends keyof LibMap
  ? LibMap[K]
  : any;

Supported libraries

Keywords

FAQs

Package last updated on 19 Mar 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc