@vendure/docs 0.0.0-202601161541

package/docs/reference/core-plugins/elasticsearch-plugin/index.md

@@ -0,0 +1,193 @@
+---
+title: "ElasticsearchPlugin"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## ElasticsearchPlugin
+
+<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/plugin.ts" sourceLine="225" packageName="@vendure/elasticsearch-plugin" />
+
+This plugin allows your product search to be powered by [Elasticsearch](https://github.com/elastic/elasticsearch) - a powerful Open Source search
+engine. This is a drop-in replacement for the DefaultSearchPlugin which exposes many powerful configuration options enabling your storefront
+to support a wide range of use-cases such as indexing of custom properties, fine control over search index configuration, and to leverage
+advanced Elasticsearch features like spacial search.
+
+## Installation
+
+**Requires Elasticsearch v7.0 < required Elasticsearch version < 7.10 **
+Elasticsearch version 7.10.2 will throw error due to incompatibility with elasticsearch-js client.
+[Check here for more info](https://github.com/elastic/elasticsearch-js/issues/1519).
+
+`yarn add @elastic/elasticsearch @vendure/elasticsearch-plugin`
+
+or
+
+`npm install @elastic/elasticsearch @vendure/elasticsearch-plugin`
+
+Make sure to remove the `DefaultSearchPlugin` if it is still in the VendureConfig plugins array.
+
+Then add the `ElasticsearchPlugin`, calling the `.init()` method with <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>:
+
+*Example*
+
+```ts
+import { ElasticsearchPlugin } from '@vendure/elasticsearch-plugin';
+
+const config: VendureConfig = {
+  // Add an instance of the plugin to the plugins array
+  plugins: [
+    ElasticsearchPlugin.init({
+      host: 'http://localhost',
+      port: 9200,
+    }),
+  ],
+};
+```
+
+## Search API Extensions
+This plugin extends the default search query of the Shop API, allowing richer querying of your product data.
+
+The [SearchResponse](/reference/graphql-api/shop/object-types/#searchresponse) type is extended with information
+about price ranges in the result set:
+```graphql
+extend type SearchResponse {
+    prices: SearchResponsePriceData!
+}
+
+type SearchResponsePriceData {
+    range: PriceRange!
+    rangeWithTax: PriceRange!
+    buckets: [PriceRangeBucket!]!
+    bucketsWithTax: [PriceRangeBucket!]!
+}
+
+type PriceRangeBucket {
+    to: Int!
+    count: Int!
+}
+
+extend input SearchInput {
+    priceRange: PriceRangeInput
+    priceRangeWithTax: PriceRangeInput
+    inStock: Boolean
+}
+
+input PriceRangeInput {
+    min: Int!
+    max: Int!
+}
+```
+
+This `SearchResponsePriceData` type allows you to query data about the range of prices in the result set.
+
+## Example Request & Response
+
+```graphql
+{
+  search (input: {
+    term: "table easel"
+    groupByProduct: true
+    priceRange: {
+      min: 500
+      max: 7000
+    }
+  }) {
+    totalItems
+    prices {
+      range {
+        min
+        max
+      }
+      buckets {
+        to
+        count
+      }
+    }
+    items {
+      productName
+      score
+      price {
+        ...on PriceRange {
+          min
+          max
+        }
+      }
+    }
+  }
+}
+```
+
+```json
+{
+ "data": {
+   "search": {
+     "totalItems": 9,
+     "prices": {
+       "range": {
+         "min": 999,
+         "max": 6396,
+       },
+       "buckets": [
+         {
+           "to": 1000,
+           "count": 1
+         },
+         {
+           "to": 2000,
+           "count": 2
+         },
+         {
+           "to": 3000,
+           "count": 3
+         },
+         {
+           "to": 4000,
+           "count": 1
+         },
+         {
+           "to": 5000,
+           "count": 1
+         },
+         {
+           "to": 7000,
+           "count": 1
+         }
+       ]
+     },
+     "items": [
+       {
+         "productName": "Loxley Yorkshire Table Easel",
+         "score": 30.58831,
+         "price": {
+           "min": 4984,
+           "max": 4984
+         }
+       },
+       // ... truncated
+     ]
+   }
+ }
+}
+```
+
+```ts title="Signature"
+class ElasticsearchPlugin implements OnApplicationBootstrap {
+    init(options: ElasticsearchOptions) => Type<ElasticsearchPlugin>;
+}
+```
+* Implements: <code>OnApplicationBootstrap</code>
+
+
+
+<div className="members-wrapper">
+
+### init
+
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type&#60;<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.md

@@ -0,0 +1,33 @@
+---
+title: "EmailEventHandlerWithAsyncData"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## EmailEventHandlerWithAsyncData
+
+<GenerationInfo sourceFile="packages/email-plugin/src/handler/event-handler.ts" sourceLine="506" packageName="@vendure/email-plugin" />
+
+Identical to the <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> but with a `data` property added to the `event` based on the result
+of the `.loadData()` function.
+
+```ts title="Signature"
+class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent extends EventWithContext = EventWithContext, Event extends EventWithAsyncData<InputEvent, Data> = EventWithAsyncData<InputEvent, Data>> extends EmailEventHandler<T, Event> {
+    constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
+}
+```
+* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;</code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>&#60;InputEvent, Data&#62;, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>&#60;T&#62;, event: Type&#60;InputEvent&#62;) => EmailEventHandlerWithAsyncData`}   />
+
+
+
+
+</div>

package/docs/reference/core-plugins/email-plugin/email-event-handler.md

@@ -0,0 +1,299 @@
+---
+title: "EmailEventHandler"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## EmailEventHandler
+
+<GenerationInfo sourceFile="packages/email-plugin/src/handler/event-handler.ts" sourceLine="150" packageName="@vendure/email-plugin" />
+
+The EmailEventHandler defines how the EmailPlugin will respond to a given event.
+
+A handler is created by creating a new <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a> and calling the `.on()` method
+to specify which event to respond to.
+
+*Example*
+
+```ts
+const confirmationHandler = new EmailEventListener('order-confirmation')
+  .on(OrderStateTransitionEvent)
+  .filter(event => event.toState === 'PaymentSettled')
+  .setRecipient(event => event.order.customer.emailAddress)
+  .setFrom('{{ fromAddress }}')
+  .setSubject(`Order confirmation for #{{ order.code }}`)
+  .setTemplateVars(event => ({ order: event.order }));
+```
+
+This example creates a handler which listens for the `OrderStateTransitionEvent` and if the Order has
+transitioned to the `'PaymentSettled'` state, it will generate and send an email.
+
+The string argument passed into the `EmailEventListener` constructor is used to identify the handler, and
+also to locate the directory of the email template files. So in the example above, there should be a directory
+`<app root>/static/email/templates/order-confirmation` which contains a Handlebars template named `body.hbs`.
+
+## Handling other languages
+
+By default, the handler will respond to all events on all channels and use the same subject ("Order confirmation for #12345" above)
+and body template.
+
+Since v2.0 the `.addTemplate()` method has been **deprecated**. To serve different templates — for example, based on the current
+`languageCode` — implement a custom <a href='/reference/core-plugins/email-plugin/template-loader#templateloader'>TemplateLoader</a> and pass it to `EmailPlugin.init({ templateLoader: new MyTemplateLoader() })`.
+
+The language is typically determined by the `languageCode` property of the event's `ctx` (<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) object, so the
+`loadTemplate()` method can use that to locate the correct template file.
+
+*Example*
+
+```ts
+import { EmailPlugin, TemplateLoader } from '@vendure/email-plugin';
+import { readFileSync } from 'fs';
+import path from 'path';
+
+class CustomLanguageAwareTemplateLoader implements TemplateLoader {
+  constructor(private templateDir: string) {}
+
+  async loadTemplate(_injector, ctx, { type, templateName }) {
+    // e.g. returns the content of "body.de.hbs" or "body.en.hbs" depending on ctx.languageCode
+    const filePath = path.join(this.templateDir, type, `${templateName}.${ctx.languageCode}.hbs`);
+    return readFileSync(filePath, 'utf-8');
+  }
+}
+
+EmailPlugin.init({
+  templateLoader: new CustomLanguageAwareTemplateLoader(path.join(__dirname, '../static/email/templates')),
+  handlers: defaultEmailHandlers,
+});
+```
+
+## Defining a custom handler
+
+Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
+which is executed when the customer requests a quote in your storefront, and in your resolver, you use the <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a> to publish a
+new `QuoteRequestedEvent`.
+
+You now want to email the customer with their quote. Here are the steps you would take to set this up:
+
+### 1. Create a new handler
+
+```ts
+import { EmailEventListener } from `@vendure/email-plugin`;
+import { QuoteRequestedEvent } from `./events`;
+
+const quoteRequestedHandler = new EmailEventListener('quote-requested')
+  .on(QuoteRequestedEvent)
+  .setRecipient(event => event.customer.emailAddress)
+  .setSubject(`Here's the quote you requested`)
+  .setFrom('{{ fromAddress }}')
+  .setTemplateVars(event => ({ details: event.details }));
+```
+
+### 2. Create the email template
+
+Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The path
+segment `quote-requested` must match the string passed to the `EmailEventListener` constructor.
+
+The template would look something like this:
+
+```handlebars
+{{> header title="Here's the quote you requested" }}
+
+<mj-section background-color="#fafafa">
+    <mj-column>
+        <mj-text color="#525252">
+            Thank you for your interest in our products! Here's the details
+            of the quote you recently requested:
+        </mj-text>
+
+        <!-- your custom email layout goes here -->
+    </mj-column>
+</mj-section>
+
+
+{{> footer }}
+```
+
+You can find pre-made templates on the [MJML website](https://mjml.io/templates/).
+
+### 3. Register the handler
+
+Finally, you need to register the handler with the EmailPlugin:
+
+```ts {hl_lines=[8]}
+import { defaultEmailHandlers, EmailPlugin } from '@vendure/email-plugin';
+import { quoteRequestedHandler } from './plugins/quote-plugin';
+
+const config: VendureConfig = {
+  // Add an instance of the plugin to the plugins array
+  plugins: [
+    EmailPlugin.init({
+      handler: [...defaultEmailHandlers, quoteRequestedHandler],
+      // ... etc
+    }),
+  ],
+};
+```
+
+```ts title="Signature"
+class EmailEventHandler<T extends string = string, Event extends EventWithContext = EventWithContext> {
+    constructor(listener: EmailEventListener<T>, event: Type<Event>)
+    filter(filterFn: (event: Event) => boolean) => EmailEventHandler<T, Event>;
+    setRecipient(setRecipientFn: (event: Event) => string) => EmailEventHandler<T, Event>;
+    setLanguageCode(setLanguageCodeFn: (event: Event) => LanguageCode | undefined) => EmailEventHandler<T, Event>;
+    setTemplateVars(templateVarsFn: SetTemplateVarsFn<Event>) => EmailEventHandler<T, Event>;
+    setSubject(defaultSubject: string | SetSubjectFn<Event>) => EmailEventHandler<T, Event>;
+    setFrom(from: string) => EmailEventHandler<T, Event>;
+    setOptionalAddressFields(optionalAddressFieldsFn: SetOptionalAddressFieldsFn<Event>) => ;
+    setMetadata(optionalSetMetadataFn: SetMetadataFn<Event>) => ;
+    setAttachments(setAttachmentsFn: SetAttachmentsFn<Event>) => ;
+    addTemplate(config: EmailTemplateConfig) => EmailEventHandler<T, Event>;
+    loadData(loadDataFn: LoadDataFn<Event, R>) => EmailEventHandlerWithAsyncData<R, T, Event, EventWithAsyncData<Event, R>>;
+    setMockEvent(event: Omit<Event, 'ctx' | 'data'>) => EmailEventHandler<T, Event>;
+}
+```
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>&#60;T&#62;, event: Type&#60;Event&#62;) => EmailEventHandler`}   />
+
+
+### filter
+
+<MemberInfo kind="method" type={`(filterFn: (event: Event) =&#62; boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Defines a predicate function which is used to determine whether the event will trigger an email.
+Multiple filter functions may be defined.
+### setRecipient
+
+<MemberInfo kind="method" type={`(setRecipientFn: (event: Event) =&#62; string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+A function which defines how the recipient email address should be extracted from the incoming event.
+
+The recipient can be a plain email address: `'foobar@example.com'`
+Or with a formatted name (includes unicode support): `'Ноде Майлер <foobar@example.com>'`
+Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
+### setLanguageCode
+
+<MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) =&#62; <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}  since="1.8.0"  />
+
+A function which allows to override the language of the email. If not defined, the language from the context will be used.
+### setTemplateVars
+
+<MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a>&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+A function which returns an object hash of variables which will be made available to the Handlebars template
+and subject line for interpolation.
+### setSubject
+
+<MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a>&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Sets the default subject of the email. The subject string may use Handlebars variables defined by the
+setTemplateVars() method.
+### setFrom
+
+<MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Sets the default from field of the email. The from string may use Handlebars variables defined by the
+setTemplateVars() method.
+### setOptionalAddressFields
+
+<MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a>&#60;Event&#62;) => `}  since="1.1.0"  />
+
+A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields'>OptionalAddressFields</a> to be specified such as "cc" and "bcc".
+### setMetadata
+
+<MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a>&#60;Event&#62;) => `}  since="3.1.0"  />
+
+A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata'>EmailMetadata</a> to be specified for the email. This can be used
+to store arbitrary data about the email which can be used for tracking or other purposes.
+
+It will be exposed in the <a href='/reference/core-plugins/email-plugin/email-send-event#emailsendevent'>EmailSendEvent</a> as `event.metadata`. Here's an example of usage:
+
+- An <a href='/reference/typescript-api/events/event-types#orderstatetransitionevent'>OrderStateTransitionEvent</a> occurs, and the EmailEventListener starts processing it.
+- The EmailEventHandler attaches metadata to the email:
+   ```ts
+   new EmailEventListener(EventType.ORDER_CONFIRMATION)
+     .on(OrderStateTransitionEvent)
+     .setMetadata(event => ({
+       type: EventType.ORDER_CONFIRMATION,
+       orderId: event.order.id,
+     }));
+  ```
+- Then, the EmailPlugin tries to send the email and publishes <a href='/reference/core-plugins/email-plugin/email-send-event#emailsendevent'>EmailSendEvent</a>,
+  passing ctx, emailDetails, error or success, and this metadata.
+- In another part of the server, we have an eventBus that subscribes to EmailSendEvent. We can use
+  `metadata.type` and `metadata.orderId` to identify the related order. For example, we can indicate on the
+   order that the email was successfully sent, or in case of an error, send a notification confirming
+   the order in another available way.
+### setAttachments
+
+<MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a>&#60;Event&#62;) => `}   />
+
+Defines one or more files to be attached to the email. An attachment can be specified
+as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
+
+**Note:** When using the `content` to pass a Buffer or Stream, the raw data will get serialized
+into the job queue. For this reason the total size of all attachments passed as `content` should kept to
+**less than ~50k**. If the attachments are greater than that limit, a warning will be logged and
+errors may result if using the DefaultJobQueuePlugin with certain DBs such as MySQL/MariaDB.
+
+*Example*
+
+```ts
+const testAttachmentHandler = new EmailEventListener('activate-voucher')
+  .on(ActivateVoucherEvent)
+  // ... omitted some steps for brevity
+  .setAttachments(async (event) => {
+    const { imageUrl, voucherCode } = await getVoucherDataForUser(event.user.id);
+    return [
+      {
+        filename: `voucher-${voucherCode}.jpg`,
+        path: imageUrl,
+      },
+    ];
+  });
+```
+### addTemplate
+
+<MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
+templates for channels or languageCodes other than the default.
+### loadData
+
+<MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>&#60;Event, R&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a>&#60;R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a>&#60;Event, R&#62;&#62;`}   />
+
+Allows data to be loaded asynchronously which can then be used as template variables.
+The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
+`inject()` function which can be used to inject any of the providers exported
+by the <a href='/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule'>PluginCommonModule</a>. The return value of the `loadDataFn` will be
+added to the `event` as the `data` property.
+
+*Example*
+
+```ts
+new EmailEventListener('order-confirmation')
+  .on(OrderStateTransitionEvent)
+  .filter(event => event.toState === 'PaymentSettled' && !!event.order.customer)
+  .loadData(({ event, injector }) => {
+    const orderService = injector.get(OrderService);
+    return orderService.getOrderPayments(event.order.id);
+  })
+  .setTemplateVars(event => ({
+    order: event.order,
+    payments: event.data,
+  }))
+  // ...
+```
+### setMockEvent
+
+<MemberInfo kind="method" type={`(event: Omit&#60;Event, 'ctx' | 'data'&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
+from this handler, which is useful when developing the email templates.
+
+
+</div>

package/docs/reference/core-plugins/email-plugin/email-event-listener.md

@@ -0,0 +1,42 @@
+---
+title: "EmailEventListener"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## EmailEventListener
+
+<GenerationInfo sourceFile="packages/email-plugin/src/event-listener.ts" sourceLine="13" packageName="@vendure/email-plugin" />
+
+An EmailEventListener is used to listen for events and set up a <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> which
+defines how an email will be generated from this event.
+
+```ts title="Signature"
+class EmailEventListener<T extends string> {
+    public type: T;
+    constructor(type: T)
+    on(event: Type<Event>) => EmailEventHandler<T, Event>;
+}
+```
+
+<div className="members-wrapper">
+
+### type
+
+<MemberInfo kind="property" type={`T`}   />
+
+
+### constructor
+
+<MemberInfo kind="method" type={`(type: T) => EmailEventListener`}   />
+
+
+### on
+
+<MemberInfo kind="method" type={`(event: Type&#60;Event&#62;) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;T, Event&#62;`}   />
+
+Defines the event to listen for.
+
+
+</div>

package/docs/reference/core-plugins/email-plugin/email-generator.md

@@ -0,0 +1,78 @@
+---
+title: "EmailGenerator"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## EmailGenerator
+
+<GenerationInfo sourceFile="packages/email-plugin/src/generator/email-generator.ts" sourceLine="13" packageName="@vendure/email-plugin" />
+
+An EmailGenerator generates the subject and body details of an email.
+
+```ts title="Signature"
+interface EmailGenerator<T extends string = any, E extends VendureEvent = any> extends InjectableStrategy {
+    onInit?(options: EmailPluginOptions): void | Promise<void>;
+    generate(
+        from: string,
+        subject: string,
+        body: string,
+        templateVars: { [key: string]: any },
+    ): Pick<EmailDetails, 'from' | 'subject' | 'body'>;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### onInit
+
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise&#60;void&#62;`}   />
+
+Any necessary setup can be performed here.
+### generate
+
+<MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick&#60;<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'&#62;`}   />
+
+Given a subject and body from an email template, this method generates the final
+interpolated email text.
+
+
+</div>
+
+
+## HandlebarsMjmlGenerator
+
+<GenerationInfo sourceFile="packages/email-plugin/src/generator/handlebars-mjml-generator.ts" sourceLine="17" packageName="@vendure/email-plugin" />
+
+Uses Handlebars (https://handlebarsjs.com/) to output MJML (https://mjml.io) which is then
+compiled down to responsive email HTML.
+
+```ts title="Signature"
+class HandlebarsMjmlGenerator implements EmailGenerator {
+    onInit(options: InitializedEmailPluginOptions) => ;
+    generate(from: string, subject: string, template: string, templateVars: any) => ;
+}
+```
+* Implements: <code><a href='/reference/core-plugins/email-plugin/email-generator#emailgenerator'>EmailGenerator</a></code>
+
+
+
+<div className="members-wrapper">
+
+### onInit
+
+<MemberInfo kind="method" type={`(options: InitializedEmailPluginOptions) => `}   />
+
+
+### generate
+
+<MemberInfo kind="method" type={`(from: string, subject: string, template: string, templateVars: any) => `}   />
+
+
+
+
+</div>