chore(docs): Remove generated markdown from source control

.gitignore

@@ -397,3 +397,5 @@ docs/resources/_gen/*
 docs/static/main.js
 docs/static/main.css
 docs/public
+docs/content/docs/api/
+!docs/content/docs/api/_index.md

docs/content/docs/api/_index.md

@@ -2,3 +2,7 @@
 title: "API"
 weight: 10
 ---
+
+# Vendure API Docs
+
+All documentation in this section is auto-generated from the TypeScript source of the Vendure server. Thus it is guaranteed to be accurate and up-to-date.

docs/content/docs/api/assets/_index.md

@@ -1,10 +0,0 @@
----
-title: "assets"
-weight: 10
-date: 2019-01-30T10:57:03.689Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# assets

docs/content/docs/api/assets/asset-naming-strategy.md

@@ -1,27 +0,0 @@
----
-title: "AssetNamingStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.687Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# AssetNamingStrategy
-
-{{< generation-info source="/server/src/config/asset-naming-strategy/asset-naming-strategy.ts">}}
-
-The AssetNamingStrategy determines how file names are generated based on the uploaded source file name,
as well as how to handle naming conflicts.
-
-### generateSourceFileName
-
-{{< member-info kind="method" type="(originalFileName: string, conflictFileName: string) => string" >}}
-
-Given the original file name of the uploaded file, generate a file name to
be stored on the server. Operations like normalization and time-stamping can
be performed in this method.

The output will be checked for a naming conflict with an existing file. If a conflict
exists, this method will be invoked again with the second argument passed in and a new, unique
file name should then be generated. This process will repeat until a unique file name has
been returned.
-
-### generatePreviewFileName
-
-{{< member-info kind="method" type="(sourceFileName: string, conflictFileName: string) => string" >}}
-
-Given the source file name generated in the {@link generateSourceFileName} method, this method
should generate the file name of the preview image.

The same mechanism of checking for conflicts is used as described above.
-

docs/content/docs/api/assets/asset-options.md

@@ -1,39 +0,0 @@
----
-title: "AssetOptions"
-weight: 10
-date: 2019-01-30T10:57:03.833Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# AssetOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-The AssetOptions define how assets (images and other files) are named and stored, and how preview images are generated.
-
-### assetNamingStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//assets/asset-naming-strategy/'>AssetNamingStrategy</a>" >}}
-
-Defines how asset files and preview images are named before being saved.
-
-### assetStorageStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//assets/asset-storage-strategy/'>AssetStorageStrategy</a>" >}}
-
-Defines the strategy used for storing uploaded binary files.
-
-### assetPreviewStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//assets/asset-preview-strategy/'>AssetPreviewStrategy</a>" >}}
-
-Defines the strategy used for creating preview images of uploaded assets.
-
-### uploadMaxFileSize
-
-{{< member-info kind="property" type="number" >}}
-
-The max file size in bytes for uploaded assets.
-

docs/content/docs/api/assets/asset-preview-strategy.md

@@ -1,21 +0,0 @@
----
-title: "AssetPreviewStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.701Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# AssetPreviewStrategy
-
-{{< generation-info source="/server/src/config/asset-preview-strategy/asset-preview-strategy.ts">}}
-
-The AssetPreviewStrategy determines how preview images for assets are created. For image
assets, this would usually typically involve resizing to sensible dimensions. Other file types
could be previewed in a variety of ways, e.g.:
- waveform images generated for audio files
- preview images generated for pdf documents
- watermarks added to preview images
-
-### generatePreviewImage
-
-{{< member-info kind="method" type="(mimeType: string, data: Buffer) => Promise&#60;Buffer&#62;" >}}
-
-
-

docs/content/docs/api/assets/asset-storage-strategy.md

@@ -1,51 +0,0 @@
----
-title: "AssetStorageStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.707Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# AssetStorageStrategy
-
-{{< generation-info source="/server/src/config/asset-storage-strategy/asset-storage-strategy.ts">}}
-
-The AssetPersistenceStrategy determines how Asset files are physically stored
and retrieved.
-
-### writeFileFromBuffer
-
-{{< member-info kind="method" type="(fileName: string, data: Buffer) => Promise&#60;string&#62;" >}}
-
-
-
-### writeFileFromStream
-
-{{< member-info kind="method" type="(fileName: string, data: Stream) => Promise&#60;string&#62;" >}}
-
-
-
-### readFileToBuffer
-
-{{< member-info kind="method" type="(identifier: string) => Promise&#60;Buffer&#62;" >}}
-
-
-
-### readFileToStream
-
-{{< member-info kind="method" type="(identifier: string) => Promise&#60;Stream&#62;" >}}
-
-
-
-### fileExists
-
-{{< member-info kind="method" type="(fileName: string) => Promise&#60;boolean&#62;" >}}
-
-
-
-### toAbsoluteUrl
-
-{{< member-info kind="method" type="(reqest: Request, identifier: string) => string" >}}
-
-
-

docs/content/docs/api/auth/_index.md

@@ -1,10 +0,0 @@
----
-title: "auth"
-weight: 10
-date: 2019-01-30T10:57:03.809Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# auth

docs/content/docs/api/auth/auth-options.md

@@ -1,57 +0,0 @@
----
-title: "AuthOptions"
-weight: 10
-date: 2019-01-30T10:57:03.808Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# AuthOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-The AuthOptions define how authentication is managed.
-
-### disableAuth
-
-{{< member-info kind="property" type="boolean" default="true" >}}
-
-Disable authentication & permissions checks.
NEVER set the to true in production. It exists
only to aid certain development tasks.
-
-### tokenMethod
-
-{{< member-info kind="property" type="'cookie' | 'bearer'" default="'cookie'" >}}
-
-Sets the method by which the session token is delivered and read.

* 'cookie': Upon login, a 'Set-Cookie' header will be returned to the client, setting a
cookie containing the session token. A browser-based client (making requests with credentials)
should automatically send the session cookie with each request.
* 'bearer': Upon login, the token is returned in the response and should be then stored by the
client app. Each request should include the header 'Authorization: Bearer <token>'.
-
-### sessionSecret
-
-{{< member-info kind="property" type="string" default="'session-secret'" >}}
-
-The secret used for signing the session cookies for authenticated users. Only applies when
tokenMethod is set to 'cookie'.

In production applications, this should not be stored as a string in
source control for security reasons, but may be loaded from an external
file not under source control, or from an environment variable, for example.
-
-### authTokenHeaderKey
-
-{{< member-info kind="property" type="string" default="'vendure-auth-token'" >}}
-
-Sets the header property which will be used to send the auth token when using the 'bearer' method.
-
-### sessionDuration
-
-{{< member-info kind="property" type="string | number" default="'7d'" >}}
-
-Session duration, i.e. the time which must elapse from the last authenticted request
after which the user must re-authenticate.

Expressed as a string describing a time span per
[zeit/ms](https://github.com/zeit/ms.js).  Eg: `60`, `'2 days'`, `'10h'`, `'7d'`
-
-### requireVerification
-
-{{< member-info kind="property" type="boolean" >}}
-
-Determines whether new User accounts require verification of their email address.
-
-### verificationTokenDuration
-
-{{< member-info kind="property" type="string | number" default="'7d'" >}}
-
-Sets the length of time that a verification token is valid for, after which the verification token must be refreshed.

Expressed as a string describing a time span per
[zeit/ms](https://github.com/zeit/ms.js).  Eg: `60`, `'2 days'`, `'10h'`, `'7d'`
-

docs/content/docs/api/email/_index.md

@@ -1,10 +0,0 @@
----
-title: "email"
-weight: 10
-date: 2019-01-30T10:57:03.714Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# email

docs/content/docs/api/email/email-options.md

@@ -1,39 +0,0 @@
----
-title: "EmailOptions"
-weight: 10
-date: 2019-01-30T10:57:03.856Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# EmailOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### emailTemplatePath
-
-{{< member-info kind="property" type="string" >}}
-
-Path to the email template files.
-
-### emailTypes
-
-{{< member-info kind="property" type="EmailTypes&#60;EmailType&#62;" >}}
-
-Configuration for the creation and templating of each email type
-
-### generator
-
-{{< member-info kind="property" type="EmailGenerator" >}}
-
-The EmailGenerator uses the EmailContext and template to generate the email body
-
-### transport
-
-{{< member-info kind="property" type="EmailTransportOptions" >}}
-
-Configuration for the transport (email sending) method
-

docs/content/docs/api/email/file-transport-options.md

@@ -1,33 +0,0 @@
----
-title: "FileTransportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.731Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# FileTransportOptions
-
-{{< generation-info source="/server/src/config/email/email-transport-options.ts">}}
-
-Outputs the email as an HTML file for development purposes.
-
-### type
-
-{{< member-info kind="property" type="'file'" >}}
-
-
-
-### outputPath
-
-{{< member-info kind="property" type="string" >}}
-
-
-
-### raw
-
-{{< member-info kind="property" type="boolean" >}}
-
-
-

docs/content/docs/api/email/noop-transport-options.md

@@ -1,21 +0,0 @@
----
-title: "NoopTransportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.736Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# NoopTransportOptions
-
-{{< generation-info source="/server/src/config/email/email-transport-options.ts">}}
-
-Does nothing with the generated email. Mainly intended for use in testing where we don't care about the email transport.
-
-### type
-
-{{< member-info kind="property" type="'none'" >}}
-
-
-

docs/content/docs/api/email/s-m-t-p-transport-options.md

@@ -1,75 +0,0 @@
----
-title: "SMTPTransportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.713Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# SMTPTransportOptions
-
-{{< generation-info source="/server/src/config/email/email-transport-options.ts">}}
-
-A subset of the SMTP transport options of [Nodemailer](https://nodemailer.com/smtp/)
-
-### type
-
-{{< member-info kind="property" type="'smtp'" >}}
-
-
-
-### host
-
-{{< member-info kind="property" type="string" >}}
-
-
-
-### port
-
-{{< member-info kind="property" type="number" >}}
-
-
-
-### auth
-
-{{< member-info kind="property" type="SMTPCredentials" >}}
-
-
-
-### secure
-
-{{< member-info kind="property" type="boolean" >}}
-
-
-
-### ignoreTLS
-
-{{< member-info kind="property" type="boolean" >}}
-
-
-
-### requireTLS
-
-{{< member-info kind="property" type="boolean" >}}
-
-
-
-### name
-
-{{< member-info kind="property" type="string" >}}
-
-
-
-### localAddress
-
-{{< member-info kind="property" type="string" >}}
-
-
-
-### authMethod
-
-{{< member-info kind="property" type="string" >}}
-
-
-

docs/content/docs/api/email/sendmail-transport-options.md

@@ -1,33 +0,0 @@
----
-title: "SendmailTransportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.725Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# SendmailTransportOptions
-
-{{< generation-info source="/server/src/config/email/email-transport-options.ts">}}
-
-Uses the local Sendmail program to send the email.
-
-### type
-
-{{< member-info kind="property" type="'sendmail'" >}}
-
-
-
-### path
-
-{{< member-info kind="property" type="string" >}}
-
-
-
-### newline
-
-{{< member-info kind="property" type="string" >}}
-
-
-

docs/content/docs/api/email/testing-transport-options.md

@@ -1,27 +0,0 @@
----
-title: "TestingTransportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.744Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# TestingTransportOptions
-
-{{< generation-info source="/server/src/config/email/email-transport-options.ts">}}
-
-Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
-
-### type
-
-{{< member-info kind="property" type="'testing'" >}}
-
-
-
-### onSend
-
-{{< member-info kind="property" type="(context: GeneratedEmailContext) =&#62; void" >}}
-
-Callback to be invoked when an email would be sent.
-

docs/content/docs/api/entity-id-strategy.md

@@ -1,33 +0,0 @@
----
-title: "EntityIdStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.751Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# EntityIdStrategy
-
-{{< generation-info source="/server/src/config/entity-id-strategy/entity-id-strategy.ts">}}
-
-The EntityIdStrategy determines how entity IDs are generated and stored in the
database, as well as how they are transformed when being passed from the API to the
service layer.
-
-### primaryKeyType
-
-{{< member-info kind="property" type="PrimaryKeyType" >}}
-
-
-
-### encodeId
-
-{{< member-info kind="property" type="(primaryKey: T) =&#62; string" >}}
-
-
-
-### decodeId
-
-{{< member-info kind="property" type="(id: string) =&#62; T" >}}
-
-
-

docs/content/docs/api/import-export-options.md

@@ -1,21 +0,0 @@
----
-title: "ImportExportOptions"
-weight: 10
-date: 2019-01-30T10:57:03.879Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# ImportExportOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### importAssetsDir
-
-{{< member-info kind="property" type="string" >}}
-
-The directory in which assets to be imported are located.
-

docs/content/docs/api/orders/_index.md

@@ -1,10 +0,0 @@
----
-title: "orders"
-weight: 10
-date: 2019-01-30T10:57:03.758Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# orders

docs/content/docs/api/orders/order-merge-options.md

@@ -1,27 +0,0 @@
----
-title: "OrderMergeOptions"
-weight: 10
-date: 2019-01-30T10:57:03.827Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# OrderMergeOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### mergeStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//orders/order-merge-strategy/'>OrderMergeStrategy</a>" >}}
-
-Defines the strategy used to merge a guest Order and an existing Order when
signing in.
-
-### checkoutMergeStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//orders/order-merge-strategy/'>OrderMergeStrategy</a>" >}}
-
-Defines the strategy used to merge a guest Order and an existing Order when
signing in as part of the checkout flow.
-

docs/content/docs/api/orders/order-merge-strategy.md

@@ -1,21 +0,0 @@
----
-title: "OrderMergeStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.758Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# OrderMergeStrategy
-
-{{< generation-info source="/server/src/config/order-merge-strategy/order-merge-strategy.ts">}}
-
-An OrderMergeStrategy defines what happens when a Customer with an existing Order
signs in with a guest Order, where both Orders may contain differing OrderLines.

Somehow these differing OrderLines need to be reconciled into a single collection
of OrderLines. The OrderMergeStrategy defines the rules governing this reconciliation.
-
-### merge
-
-{{< member-info kind="method" type="(guestOrder: Order, existingOrder: Order) => OrderLine[]" >}}
-
-
-

docs/content/docs/api/orders/order-process-options.md

@@ -1,39 +0,0 @@
----
-title: "OrderProcessOptions"
-weight: 10
-date: 2019-01-30T10:57:03.820Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# OrderProcessOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### transtitions
-
-{{< member-info kind="property" type="Partial&#60;Transitions&#60;T | OrderState&#62;&#62;" >}}
-
-Define how the custom states fit in with the default order
state transitions.
-
-### onTransitionStart
-
-{{< member-info kind="method" type="(fromState: T, toState: T, data: { order: Order }) => boolean | Promise&#60;boolean&#62; | Observable&#60;boolean&#62; | void" >}}
-
-Define logic to run before a state tranition takes place. Returning
false will prevent the transition from going ahead.
-
-### onTransitionEnd
-
-{{< member-info kind="method" type="(fromState: T, toState: T, data: { order: Order }) => void" >}}
-
-Define logic to run after a state transition has taken place.
-
-### onError
-
-{{< member-info kind="method" type="(fromState: T, toState: T, message: string) => void" >}}
-
-Define a custom error handler function for transition errors.
-

docs/content/docs/api/orders/shipping-options.md

@@ -1,27 +0,0 @@
----
-title: "ShippingOptions"
-weight: 10
-date: 2019-01-30T10:57:03.850Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# ShippingOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### shippingEligibilityCheckers
-
-{{< member-info kind="property" type="Array&#60;ShippingEligibilityChecker&#60;any&#62;&#62;" >}}
-
-An array of available ShippingEligibilityCheckers for use in configuring ShippingMethods
-
-### shippingCalculators
-
-{{< member-info kind="property" type="Array&#60;ShippingCalculator&#60;any&#62;&#62;" >}}
-
-An array of available ShippingCalculator for use in configuring ShippingMethods
-

docs/content/docs/api/payment/_index.md

@@ -1,10 +0,0 @@
----
-title: "payment"
-weight: 10
-date: 2019-01-30T10:57:03.862Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# payment

docs/content/docs/api/payment/payment-options.md

@@ -1,21 +0,0 @@
----
-title: "PaymentOptions"
-weight: 10
-date: 2019-01-30T10:57:03.862Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# PaymentOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### paymentMethodHandlers
-
-{{< member-info kind="property" type="Array&#60;PaymentMethodHandler&#60;any&#62;&#62;" >}}
-
-An array of payment methods with which to process payments.
-

docs/content/docs/api/promotions/_index.md

@@ -1,10 +0,0 @@
----
-title: "promotions"
-weight: 10
-date: 2019-01-30T10:57:03.839Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# promotions

docs/content/docs/api/promotions/promotion-options.md

@@ -1,27 +0,0 @@
----
-title: "PromotionOptions"
-weight: 10
-date: 2019-01-30T10:57:03.839Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# PromotionOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### promotionConditions
-
-{{< member-info kind="property" type="Array&#60;PromotionCondition&#60;any&#62;&#62;" >}}
-
-An array of conditions which can be used to construct Promotions
-
-### promotionActions
-
-{{< member-info kind="property" type="Array&#60;PromotionAction&#60;any&#62;&#62;" >}}
-
-An array of actions which can be used to construct Promotions
-

docs/content/docs/api/tax/_index.md

@@ -1,10 +0,0 @@
----
-title: "tax"
-weight: 10
-date: 2019-01-30T10:57:03.769Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# tax

docs/content/docs/api/tax/tax-calculation-strategy.md

@@ -1,21 +0,0 @@
----
-title: "TaxCalculationStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.768Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# TaxCalculationStrategy
-
-{{< generation-info source="/server/src/config/tax/tax-calculation-strategy.ts">}}
-
-Defines how taxes are calculated based on the input price, tax zone and current request context.
-
-### calculate
-
-{{< member-info kind="method" type="(args: TaxCalculationArgs) => TaxCalculationResult" >}}
-
-
-

docs/content/docs/api/tax/tax-options.md

@@ -1,27 +0,0 @@
----
-title: "TaxOptions"
-weight: 10
-date: 2019-01-30T10:57:03.873Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# TaxOptions
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-
-
-### taxZoneStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//tax/tax-zone-strategy/'>TaxZoneStrategy</a>" >}}
-
-Defines the strategy used to determine the applicable Zone used in tax calculations.
-
-### taxCalculationStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api//tax/tax-calculation-strategy/'>TaxCalculationStrategy</a>" >}}
-
-Defines the strategy used for calculating taxes.
-

docs/content/docs/api/tax/tax-zone-strategy.md

@@ -1,21 +0,0 @@
----
-title: "TaxZoneStrategy"
-weight: 10
-date: 2019-01-30T10:57:03.802Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# TaxZoneStrategy
-
-{{< generation-info source="/server/src/config/tax/tax-zone-strategy.ts">}}
-
-Defines how the active Zone is determined for the purposes of calculating taxes.
-
-### determineTaxZone
-
-{{< member-info kind="method" type="(zones: Zone[], channel: Channel, order: Order) => Zone" >}}
-
-
-

docs/content/docs/api/vendure-config.md

@@ -1,153 +0,0 @@
----
-title: "VendureConfig"
-weight: 0
-date: 2019-01-30T10:57:03.886Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# VendureConfig
-
-{{< generation-info source="/server/src/config/vendure-config.ts">}}
-
-All possible configuration options are defined by the
[`VendureConfig`](https://github.com/vendure-ecommerce/vendure/blob/master/server/src/config/vendure-config.ts) interface.

{{% alert %}}
Note on terminology: many of the configuration properties are named "Strategy" - this is because their use follows the
[Strategy Pattern](https://en.wikipedia.org/wiki/Strategy_pattern) of software design.
{{% /alert %}}
-
-### apiPath
-
-{{< member-info kind="property" type="string" >}}
-
-The path to the GraphQL API.
-
-### assetOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//assets/asset-options/'>AssetOptions</a>" >}}
-
-Configuration for the handling of Assets.
-
-### authOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//auth/auth-options/'>AuthOptions</a>" >}}
-
-Configuration for authorization.
-
-### channelTokenKey
-
-{{< member-info kind="property" type="string" >}}
-
-The name of the property which contains the token of the
active channel. This property can be included either in
the request header or as a query string.
-
-### cors
-
-{{< member-info kind="property" type="boolean | CorsOptions" >}}
-
-Set the CORS handling for the server.
-
-### customFields
-
-{{< member-info kind="property" type="CustomFields" >}}
-
-Defines custom fields which can be used to extend the built-in entities.
-
-### dbConnectionOptions
-
-{{< member-info kind="property" type="ConnectionOptions" >}}
-
-The connection options used by TypeORM to connect to the database.
-
-### defaultChannelToken
-
-{{< member-info kind="property" type="string | null" >}}
-
-The token for the default channel. If not specified, a token
will be randomly generated.
-
-### defaultLanguageCode
-
-{{< member-info kind="property" type="LanguageCode" >}}
-
-The default languageCode of the app.
-
-### emailOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//email/email-options/'>EmailOptions</a>&#60;any&#62;" >}}
-
-Configures the handling of transactional emails.
-
-### entityIdStrategy
-
-{{< member-info kind="property" type="<a href='/docs/api///entity-id-strategy/'>EntityIdStrategy</a>&#60;any&#62;" >}}
-
-Defines the strategy used for both storing the primary keys of entities
in the database, and the encoding & decoding of those ids when exposing
entities via the API. The default uses a simple auto-increment integer
strategy.
-
-### hostname
-
-{{< member-info kind="property" type="string" >}}
-
-Set the hostname of the server.
-
-### importExportOptions
-
-{{< member-info kind="property" type="<a href='/docs/api///import-export-options/'>ImportExportOptions</a>" >}}
-
-Configuration settings for data import and export.
-
-### orderMergeOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//orders/order-merge-options/'>OrderMergeOptions</a>" >}}
-
-Define the strategies governing how Orders are merged when an existing
Customer signs in.
-
-### orderProcessOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//orders/order-process-options/'>OrderProcessOptions</a>&#60;any&#62;" >}}
-
-Defines custom states in the order process finite state machine.
-
-### middleware
-
-{{< member-info kind="property" type="Array&#60;{ handler: RequestHandler; route: string }&#62;" >}}
-
-Custom Express middleware for the server.
-
-### paymentOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//payment/payment-options/'>PaymentOptions</a>" >}}
-
-Configures available payment processing methods.
-
-### plugins
-
-{{< member-info kind="property" type="<a href='/docs/api///vendure-plugin/'>VendurePlugin</a>[]" >}}
-
-An array of plugins.
-
-### port
-
-{{< member-info kind="property" type="number" >}}
-
-Which port the Vendure server should listen on.
-
-### promotionOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//promotions/promotion-options/'>PromotionOptions</a>" >}}
-
-Configures the Conditions and Actions available when creating Promotions.
-
-### shippingOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//orders/shipping-options/'>ShippingOptions</a>" >}}
-
-Configures the available checkers and calculators for ShippingMethods.
-
-### silent
-
-{{< member-info kind="property" type="boolean" >}}
-
-When set to true, no application logging will be output to the console.
-
-### taxOptions
-
-{{< member-info kind="property" type="<a href='/docs/api//tax/tax-options/'>TaxOptions</a>" >}}
-
-Configures how taxes are calculated on products.
-

docs/content/docs/api/vendure-plugin.md

@@ -1,45 +0,0 @@
----
-title: "VendurePlugin"
-weight: 10
-date: 2019-01-30T10:57:03.896Z
-generated: true
----
-<!-- This file was generated from the Vendure TypeScript source. Do not modify. Instead, re-run "generate-docs" -->
-
-
-# VendurePlugin
-
-{{< generation-info source="/server/src/config/vendure-plugin/vendure-plugin.ts">}}
-
-A VendurePlugin is a means of configuring and/or extending the functionality of the Vendure server. In its simplest form,
a plugin simply modifies the VendureConfig object. Although such configuration can be directly supplied to the bootstrap
function, using a plugin allows one to abstract away a set of related configuration.

As well as configuring the app, a plugin may also extend the GraphQL schema by extending existing types or adding
entirely new types. Database entities and resolvers can also be defined to handle the extended GraphQL types.
-
-### configure
-
-{{< member-info kind="method" type="(config: Required&#60;<a href='/docs/api///vendure-config/'>VendureConfig</a>&#62;) => Required&#60;<a href='/docs/api///vendure-config/'>VendureConfig</a>&#62; | Promise&#60;Required&#60;VendureConfig&#62;&#62;" >}}
-
-This method is called before the app bootstraps, and can modify the VendureConfig object and perform
other (potentially async) tasks needed.
-
-### onBootstrap
-
-{{< member-info kind="method" type="(inject: InjectorFn) => void | Promise&#60;void&#62;" >}}
-
-This method is called after the app has bootstrapped. In this method, instances of services may be injected
into the plugin. For example, the ProductService can be injected in order to enable operations on Product
entities.
-
-### defineGraphQlTypes
-
-{{< member-info kind="method" type="() => DocumentNode" >}}
-
-The plugin may extend the default Vendure GraphQL schema by implementing this method.
-
-### defineProviders
-
-{{< member-info kind="method" type="() => Array&#60;Type&#60;any&#62;&#62;" >}}
-
-The plugin may define custom providers (including GraphQL resolvers) which can then be injected via the Nest DI container.
-
-### defineEntities
-
-{{< member-info kind="method" type="() => Array&#60;Type&#60;any&#62;&#62;" >}}
-
-The plugin may define custom database entities, which should be defined as classes annotated as per the
TypeORM documentation.
-