@enonic-types/lib-schema

Enonic XP lib-schema TS types

TypeScript definitions for lib-schema library of Enonic XP

Install

npm i --save-dev @enonic-types/lib-schema

Use

Require and custom imports

To make require work out of the box, you must install and add the @enonic-types/global types. Aside from providing definitions for XP global objects, e.g. log, app, __, etc, requiring a library by the default path will return typed object.

tsconfig.json

{
  "compilerOptions": {
    "types": [
      "@enonic-types/global"
    ]
  }
}

example.ts

const { 
    createSchema, 
    createComponent, 
    createStyles,
    getSchema,
    getComponent,
    getSite,
    getStyles,
    deleteSchema,
    deleteComponent,
    deleteStyles, 
    updateSchema,
    updateComponent,
    updateSite,
    updateStyles,
    listComponents, 
    listSchemas
} = require('/lib/xp/schema');

More detailed explanation on how it works and how to type custom import function can be found here.

ES6-style import

If you are planning to use import in your code and transpile it with the default tsc TypeScript compiler, you'll need to add proper types mapping to your configuration.

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": "./",
    "paths": {
      "/lib/xp/schema": ["node_modules/@enonic-types/lib-schema"]
    }
  }
}

example.ts

import {
    createSchema,
    createComponent,
    createStyles,
    getSchema,
    getComponent,
    getSite,
    getStyles,
    deleteSchema,
    deleteComponent,
    deleteStyles,
    updateSchema,
    updateComponent,
    updateSite,
    updateStyles,
    listComponents,
    listSchemas
} from '/lib/xp/schema';

Setting baseUrl and paths will allow the tsc to keep the valid paths in the resulting JavaScript files.