diff --git a/docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md b/docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md index 8ecf946538..360c270f12 100644 --- a/docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md +++ b/docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md @@ -19,11 +19,11 @@ Configuration for the EmailPlugin. interface EmailPluginOptions { templatePath?: string; templateLoader?: TemplateLoader; - transport: - | EmailTransportOptions - | (( - injector?: Injector, - ctx?: RequestContext, + transport: + | EmailTransportOptions + | (( + injector?: Injector, + ctx?: RequestContext, ) => EmailTransportOptions | Promise); handlers: Array>; globalTemplateVars?: { [key: string]: any } | GlobalTemplateVarsFn; @@ -38,44 +38,44 @@ interface EmailPluginOptions { -The path to the location of the email templates. In a default Vendure installation, +The path to the location of the email templates. In a default Vendure installation, the templates are installed to `/vendure/email/templates`. ### templateLoader TemplateLoader`} since="2.0.0" /> -An optional TemplateLoader which can be used to load templates from a custom location or async service. +An optional TemplateLoader which can be used to load templates from a custom location or async service. The default uses the FileBasedTemplateLoader which loads templates from `/vendure/email/templates` ### transport -EmailTransportOptions | (( injector?: Injector, ctx?: RequestContext, ) => EmailTransportOptions | Promise<EmailTransportOptions>)`} /> +EmailTransportOptions | (( injector?: Injector, ctx?: RequestContext, ) => EmailTransportOptions | Promise<EmailTransportOptions>)`} /> Configures how the emails are sent. ### handlers EmailEventHandler<string, any>>`} /> -An array of EmailEventHandlers which define which Vendure events will trigger +An array of EmailEventHandlers which define which Vendure events will trigger emails, and how those emails are generated. ### globalTemplateVars GlobalTemplateVarsFn`} /> -An object containing variables which are made available to all templates. For example, -the storefront URL could be defined here and then used in the "email address verification" -email. Use the GlobalTemplateVarsFn if you need to retrieve variables from Vendure or +An object containing variables which are made available to all templates. For example, +the storefront URL could be defined here and then used in the "email address verification" +email. Use the GlobalTemplateVarsFn if you need to retrieve variables from Vendure or plugin services. ### emailSender EmailSender`} default={`NodemailerEmailSender`} /> -An optional allowed EmailSender, used to allow custom implementations of the send functionality +An optional allowed EmailSender, used to allow custom implementations of the send functionality while still utilizing the existing emailPlugin functionality. ### emailGenerator EmailGenerator`} default={`HandlebarsMjmlGenerator`} /> -An optional allowed EmailGenerator, used to allow custom email generation functionality to +An optional allowed EmailGenerator, used to allow custom email generation functionality to better match with custom email sending functionality. @@ -86,8 +86,8 @@ better match with custom email sending functionality. -Allows you to dynamically load the "globalTemplateVars" key async and access Vendure services -to create the object. This is not a requirement. You can also specify a simple static object if your +Allows you to dynamically load the "globalTemplateVars" key async and access Vendure services +to create the object. This is not a requirement. You can also specify a simple static object if your projects doesn't need to access async or dynamic values. *Example* @@ -112,9 +112,9 @@ EmailPlugin.init({ ``` ```ts title="Signature" -type GlobalTemplateVarsFn = ( - ctx: RequestContext, - injector: Injector, +type GlobalTemplateVarsFn = ( + ctx: RequestContext, + injector: Injector, ) => Promise<{ [key: string]: any }> ``` diff --git a/docs/docs/reference/typescript-api/assets/asset-options.md b/docs/docs/reference/typescript-api/assets/asset-options.md index 4b787c8e13..20edf0b15f 100644 --- a/docs/docs/reference/typescript-api/assets/asset-options.md +++ b/docs/docs/reference/typescript-api/assets/asset-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## AssetOptions - + The AssetOptions define how assets (images and other files) are named and stored, and how preview images are generated. diff --git a/docs/docs/reference/typescript-api/auth/auth-options.md b/docs/docs/reference/typescript-api/auth/auth-options.md index af28c5bddf..dfda6c63ee 100644 --- a/docs/docs/reference/typescript-api/auth/auth-options.md +++ b/docs/docs/reference/typescript-api/auth/auth-options.md @@ -100,9 +100,8 @@ taken from the database. Determines whether new User accounts require verification of their email address. -If set to "true", when registering via the `registerCustomerAccount` mutation, one should *not* set the -`password` property - doing so will result in an error. Instead, the password is set at a later stage -(once the email with the verification token has been opened) via the `verifyCustomerAccount` mutation. +If set to "true", the customer will be required to verify their email address using a verification token +they receive in their email. See the `registerCustomerAccount` mutation for more details on the verification behavior. ### verificationTokenDuration diff --git a/docs/docs/reference/typescript-api/auth/external-authentication-service.md b/docs/docs/reference/typescript-api/auth/external-authentication-service.md index 6dae1b6f3d..4c96002602 100644 --- a/docs/docs/reference/typescript-api/auth/external-authentication-service.md +++ b/docs/docs/reference/typescript-api/auth/external-authentication-service.md @@ -24,10 +24,10 @@ class ExternalAuthenticationService { createCustomerAndUser(ctx: RequestContext, config: { strategy: string; externalIdentifier: string; - verified: boolean; emailAddress: string; - firstName?: string; - lastName?: string; + firstName: string; + lastName: string; + verified?: boolean; }) => Promise; createAdministratorAndUser(ctx: RequestContext, config: { strategy: string; @@ -67,7 +67,7 @@ Looks up a User based on their identifier from an external authentication provider, ensuring this User is associated with an Administrator account. ### createCustomerAndUser -RequestContext, config: { strategy: string; externalIdentifier: string; verified: boolean; emailAddress: string; firstName?: string; lastName?: string; }) => Promise<User>`} /> +RequestContext, config: { strategy: string; externalIdentifier: string; emailAddress: string; firstName: string; lastName: string; verified?: boolean; }) => Promise<User>`} /> If a customer has been successfully authenticated by an external authentication provider, yet cannot be found using `findCustomerUser`, then we need to create a new User and diff --git a/docs/docs/reference/typescript-api/auth/superadmin-credentials.md b/docs/docs/reference/typescript-api/auth/superadmin-credentials.md index e0060276c9..e32fb44f98 100644 --- a/docs/docs/reference/typescript-api/auth/superadmin-credentials.md +++ b/docs/docs/reference/typescript-api/auth/superadmin-credentials.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## SuperadminCredentials - + These credentials will be used to create the Superadmin user & administrator when Vendure first bootstraps. diff --git a/docs/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md b/docs/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md index 2a0108bc68..f2741629dd 100644 --- a/docs/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md +++ b/docs/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md @@ -29,15 +29,15 @@ type DefaultFormConfigHash = { 'product-selector-form-input': Record; 'relation-form-input': Record; 'rich-text-form-input': Record; - 'select-form-input': { - options?: Array<{ value: string; label?: Array> }>; + 'select-form-input': { + options?: Array<{ value: string; label?: Array> }>; }; 'text-form-input': { prefix?: string; suffix?: string }; - 'textarea-form-input': { - spellcheck?: boolean; + 'textarea-form-input': { + spellcheck?: boolean; }; - 'product-multi-form-input': { - selectionMode?: 'product' | 'variant'; + 'product-multi-form-input': { + selectionMode?: 'product' | 'variant'; }; 'combination-mode-form-input': Record; } @@ -107,7 +107,7 @@ type DefaultFormConfigHash = { ### 'select-form-input' - + ### 'text-form-input' @@ -117,12 +117,12 @@ type DefaultFormConfigHash = { ### 'textarea-form-input' - + ### 'product-multi-form-input' - + ### 'combination-mode-form-input' diff --git a/docs/docs/reference/typescript-api/configuration/entity-options.md b/docs/docs/reference/typescript-api/configuration/entity-options.md index 813adab174..6572c4395b 100644 --- a/docs/docs/reference/typescript-api/configuration/entity-options.md +++ b/docs/docs/reference/typescript-api/configuration/entity-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## EntityOptions - + Options relating to the internal handling of entities. diff --git a/docs/docs/reference/typescript-api/configuration/runtime-vendure-config.md b/docs/docs/reference/typescript-api/configuration/runtime-vendure-config.md index 9b2e89e587..a393a278fe 100644 --- a/docs/docs/reference/typescript-api/configuration/runtime-vendure-config.md +++ b/docs/docs/reference/typescript-api/configuration/runtime-vendure-config.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## RuntimeVendureConfig - + This interface represents the VendureConfig object available at run-time, i.e. the user-supplied config values have been merged with the defaultConfig values. diff --git a/docs/docs/reference/typescript-api/configuration/system-options.md b/docs/docs/reference/typescript-api/configuration/system-options.md index 3429e6b986..c24dc5c4f7 100644 --- a/docs/docs/reference/typescript-api/configuration/system-options.md +++ b/docs/docs/reference/typescript-api/configuration/system-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## SystemOptions - + Options relating to system functions. diff --git a/docs/docs/reference/typescript-api/configuration/vendure-config.md b/docs/docs/reference/typescript-api/configuration/vendure-config.md index f0a42aeb3c..592f8e9329 100644 --- a/docs/docs/reference/typescript-api/configuration/vendure-config.md +++ b/docs/docs/reference/typescript-api/configuration/vendure-config.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## VendureConfig - + All possible configuration options are defined by the [`VendureConfig`](https://github.com/vendure-ecommerce/vendure/blob/master/server/src/config/vendure-config.ts) interface. diff --git a/docs/docs/reference/typescript-api/custom-fields/custom-field-type.md b/docs/docs/reference/typescript-api/custom-fields/custom-field-type.md index 689bdfb277..fa0f5d2943 100644 --- a/docs/docs/reference/typescript-api/custom-fields/custom-field-type.md +++ b/docs/docs/reference/typescript-api/custom-fields/custom-field-type.md @@ -28,7 +28,7 @@ boolean | tinyint (m), bool (p), boolean (s) | Boolean datetime | datetime (m,s), timestamp (p) | DateTime relation | many-to-one / many-to-many relation | As specified in config -Additionally, the CustomFieldType also dictates which [configuration options](/reference/typescript-api/custom-fields/#configuration-options) +Additionally, the CustomFieldType also dictates which [configuration options](/reference/typescript-api/custom-fields/#custom-field-config-properties) are available for that custom field. ```ts title="Signature" diff --git a/docs/docs/reference/typescript-api/import-export/import-export-options.md b/docs/docs/reference/typescript-api/import-export/import-export-options.md index 9704f57a3a..30294850af 100644 --- a/docs/docs/reference/typescript-api/import-export/import-export-options.md +++ b/docs/docs/reference/typescript-api/import-export/import-export-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ImportExportOptions - + Options related to importing & exporting data. diff --git a/docs/docs/reference/typescript-api/job-queue/job-queue-options.md b/docs/docs/reference/typescript-api/job-queue/job-queue-options.md index e707dccaf6..2ebccc4fba 100644 --- a/docs/docs/reference/typescript-api/job-queue/job-queue-options.md +++ b/docs/docs/reference/typescript-api/job-queue/job-queue-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## JobQueueOptions - + Options related to the built-in job queue. diff --git a/docs/docs/reference/typescript-api/orders/order-options.md b/docs/docs/reference/typescript-api/orders/order-options.md index 44eef3da65..4f893eda07 100644 --- a/docs/docs/reference/typescript-api/orders/order-options.md +++ b/docs/docs/reference/typescript-api/orders/order-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## OrderOptions - + diff --git a/docs/docs/reference/typescript-api/payment/payment-options.md b/docs/docs/reference/typescript-api/payment/payment-options.md index 0e7ba41713..ba7fce04c4 100644 --- a/docs/docs/reference/typescript-api/payment/payment-options.md +++ b/docs/docs/reference/typescript-api/payment/payment-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## PaymentOptions - + Defines payment-related options in the VendureConfig. diff --git a/docs/docs/reference/typescript-api/products-stock/catalog-options.md b/docs/docs/reference/typescript-api/products-stock/catalog-options.md index 575a6133bf..9c99ba2ce5 100644 --- a/docs/docs/reference/typescript-api/products-stock/catalog-options.md +++ b/docs/docs/reference/typescript-api/products-stock/catalog-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CatalogOptions - + Options related to products and collections. diff --git a/docs/docs/reference/typescript-api/promotions/promotion-options.md b/docs/docs/reference/typescript-api/promotions/promotion-options.md index f39eef57f3..82674168dd 100644 --- a/docs/docs/reference/typescript-api/promotions/promotion-options.md +++ b/docs/docs/reference/typescript-api/promotions/promotion-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## PromotionOptions - + diff --git a/docs/docs/reference/typescript-api/services/collection-service.md b/docs/docs/reference/typescript-api/services/collection-service.md index 74802afd0d..bdafcf1d9d 100644 --- a/docs/docs/reference/typescript-api/services/collection-service.md +++ b/docs/docs/reference/typescript-api/services/collection-service.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## CollectionService - + Contains methods relating to Collection entities. diff --git a/docs/docs/reference/typescript-api/shipping/shipping-options.md b/docs/docs/reference/typescript-api/shipping/shipping-options.md index 8f5eae74ab..c4d029918b 100644 --- a/docs/docs/reference/typescript-api/shipping/shipping-options.md +++ b/docs/docs/reference/typescript-api/shipping/shipping-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## ShippingOptions - + diff --git a/docs/docs/reference/typescript-api/tax/tax-options.md b/docs/docs/reference/typescript-api/tax/tax-options.md index be682d383d..964a4f1f26 100644 --- a/docs/docs/reference/typescript-api/tax/tax-options.md +++ b/docs/docs/reference/typescript-api/tax/tax-options.md @@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription'; ## TaxOptions - + diff --git a/packages/common/src/shared-types.ts b/packages/common/src/shared-types.ts index 89a412f15e..6da6ef3eb7 100644 --- a/packages/common/src/shared-types.ts +++ b/packages/common/src/shared-types.ts @@ -95,7 +95,7 @@ export type ID = string | number; * datetime | datetime (m,s), timestamp (p) | DateTime * relation | many-to-one / many-to-many relation | As specified in config * - * Additionally, the CustomFieldType also dictates which [configuration options](/reference/typescript-api/custom-fields/#configuration-options) + * Additionally, the CustomFieldType also dictates which [configuration options](/reference/typescript-api/custom-fields/#custom-field-config-properties) * are available for that custom field. * * @docsCategory custom-fields