@enterspeed/js-schema-types

Intro

With JavaScript schemas, you can build your schemas in a standard language most developers are already familiar with. This means that you have all the power and flexibility from JavaScript available when you are creating your schemas.

This types package goal is to improve developers experience while working with Enterspeed schemas, by providing types to be used by intellisense.

https://docs.enterspeed.com/reference/js/intro

How to use this package for local schemas development?

1. Install package

npm i @enterspeed/js-schema-types

1. Configure jsconfig.json

{
    "compilerOptions": {
        "strict": true,
        "allowJs": true,
        "checkJs": true,
        "moduleResolution": "node",
        "noEmit": true,
        "target": "ESNext",
        "types": [
            "@enterspeed/js-schema-types"
        ]
    }
}

1. Decorate your export object with corresponding schema type

/** @type {Enterspeed.FullSchema} */
export default {
  triggers: function(context) {
    context.triggers('umbraco', ['page', 'article']);
  },
  actions: function(sourceEntity, context) {
    context.reprocess('anotherSchema').bySchema();
    context.destination('algolia');
  },
  routes: (sourceEntity, context) => context.url(sourceEntity.url),
  properties: function (sourceEntity, context) {
    const p = sourceEntity.properties;
    return {
      title: p.title,
      blocks: context.partial("blocks", p.blocks),
      aboutUsPage: context.reference("page").children('type eq `product`').orderBy({direction: 'asc', propertyName: 'asd' }).limit(2),
    }
  }
}