npm.io
8.1.0 • Published 6d ago

@item-enonic-types/global

Licence
MIT
Version
8.1.0
Deps
1
Size
4 kB
Vulns
0
Weekly
0
Stars
9

Global types for Enonic XP

npm version Enonic XP8 badge

Types for Enonic XP that are not covered by the official types from Enonic. Use @enonic-types/core for Request, Response and other core types.

Installation

Install @item-enonic-types/global from npm by running:

npm i --save-dev @item-enonic-types/global

Contents

Type Description
CustomSelectorServiceParams The parameters a CustomSelector service is always called with
CustomSelectorServiceResponseBody The response body a CustomSelector service must return
MacroContext The context passed to a macro controller
WebSocketResponse WebSocketResponse from @enonic-types/core, with a typed data field

Usage

Import the types you need:

CustomSelector service
import type { Request, Response } from "@enonic-types/core";
import type {
  CustomSelectorServiceParams,
  CustomSelectorServiceResponseBody,
} from "@item-enonic-types/global";

export function GET(
  req: Request<{ params: Partial<CustomSelectorServiceParams> }>,
): Response<{ body: CustomSelectorServiceResponseBody }> {
  return {
    status: 200,
    body: {
      total: 0,
      count: 0,
      hits: [],
    },
  };
}
Macro
import type { Response } from "@enonic-types/core";
import type { MacroContext } from "@item-enonic-types/global";

type InfoBoxParams = {
  header: string;
};

export function macro(context: MacroContext<InfoBoxParams>): Response {
  return {
    body: `<aside><h2>${context.params.header}</h2>${context.body}</aside>`,
  };
}

Keywords