@vendure/docs 0.0.0-202601161541

package/docs/reference/graphql-api/shop/queries.md

@@ -0,0 +1,247 @@
+---
+title: "Queries"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+
+## activeChannel
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">The active Channel</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">activeChannel: <a href="/reference/graphql-api/shop/object-types#channel">Channel</a>!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## activeCustomer
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">The active Customer</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">activeCustomer: <a href="/reference/graphql-api/shop/object-types#customer">Customer</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## activeOrder
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">The active Order. Will be <code>null</code> until an Order is created via `addItemToOrder`. Once an Order reaches the</div>
+
+<div class="graphql-code-line top-level comment">state of <code>PaymentAuthorized</code> or `PaymentSettled`, then that Order is no longer considered "active" and this</div>
+
+<div class="graphql-code-line top-level comment">query will once again return `null`.</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">activeOrder: <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## activePaymentMethods
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Get active payment methods</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">activePaymentMethods: [<a href="/reference/graphql-api/shop/object-types#publicpaymentmethod">PublicPaymentMethod</a>]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## activeShippingMethods
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Get active shipping methods</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">activeShippingMethods: [<a href="/reference/graphql-api/shop/object-types#publicshippingmethod">PublicShippingMethod</a>]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## availableCountries
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">An array of supported Countries</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">availableCountries: [<a href="/reference/graphql-api/shop/object-types#country">Country</a>!]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## collection
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns a Collection either by its id or slug. If neither 'id' nor 'slug' is specified, an error will result.</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">collection(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>): <a href="/reference/graphql-api/shop/object-types#collection">Collection</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## collections
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">A list of Collections available to the shop</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">collections(options: <a href="/reference/graphql-api/shop/input-types#collectionlistoptions">CollectionListOptions</a>): <a href="/reference/graphql-api/shop/object-types#collectionlist">CollectionList</a>!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## eligiblePaymentMethods
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns a list of payment methods and their eligibility based on the current active Order</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">eligiblePaymentMethods: [<a href="/reference/graphql-api/shop/object-types#paymentmethodquote">PaymentMethodQuote</a>!]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## eligibleShippingMethods
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns a list of eligible shipping methods based on the current active Order</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">eligibleShippingMethods: [<a href="/reference/graphql-api/shop/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## facet
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns a Facet by its id</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">facet(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#facet">Facet</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## facets
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">A list of Facets available to the shop</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">facets(options: <a href="/reference/graphql-api/shop/input-types#facetlistoptions">FacetListOptions</a>): <a href="/reference/graphql-api/shop/object-types#facetlist">FacetList</a>!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## me
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns information about the current authenticated User</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">me: <a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## nextOrderStates
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns the possible next states that the activeOrder can transition to</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">nextOrderStates: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## order
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns an Order based on the id. Note that in the Shop API, only orders belonging to the</div>
+
+<div class="graphql-code-line top-level comment">currently-authenticated User may be queried.</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">order(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## orderByCode
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Returns an Order based on the order `code`. For guest Orders (i.e. Orders placed by non-authenticated Customers)</div>
+
+<div class="graphql-code-line top-level comment">this query will only return the Order within 2 hours of the Order being placed. This allows an Order confirmation</div>
+
+<div class="graphql-code-line top-level comment">screen to be shown immediately after completion of a guest checkout, yet prevents security risks of allowing</div>
+
+<div class="graphql-code-line top-level comment">general anonymous access to Order data.</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">orderByCode(code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## product
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Get a Product either by id or slug. If neither 'id' nor 'slug' is specified, an error will result.</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">product(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>): <a href="/reference/graphql-api/shop/object-types#product">Product</a></div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## products
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Get a list of Products</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">products(options: <a href="/reference/graphql-api/shop/input-types#productlistoptions">ProductListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productlist">ProductList</a>!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>
+
+## search
+<div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Search Products based on the criteria set by the `SearchInput`</div>
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
+<div class="graphql-code-line ">search(input: <a href="/reference/graphql-api/shop/input-types#searchinput">SearchInput</a>!): <a href="/reference/graphql-api/shop/object-types#searchresponse">SearchResponse</a>!</div>
+
+
+<div class="graphql-code-line top-level">&#125;</div>
+</div>

package/docs/reference/index.mdx

@@ -0,0 +1,38 @@
+---
+title: "Vendure API Reference"
+---
+
+This section contains reference documentation for the various APIs exposed by Vendure.
+
+:::note
+
+All of the information in this section is generated directly from the Vendure source code. You can jump directly
+to the source file using the links below each heading.
+
+:::
+
+![Source links](./links.webp)
+
+
+
+### TypeScript API
+
+These are the classes, interfaces and other TypeScript object which are used when **writing plugins** or custom business logic.
+
+### Core Plugins
+
+These are the TypeScript APIs for the core Vendure plugins.
+
+### GraphQL API
+
+These are the GraphQL APIs you will use to build your storefront (Shop API) or admin integrations (Admin API).
+
+### Dashboard API
+
+These are the React components & hooks you can use when building Dashboard extensions.
+Also see the [Storybook component library](https://storybook.vendure.io) for interactive examples.
+
+### Admin UI API (Deprecated)
+
+These are the Angular components and services you can use when building Admin UI extensions with the deprecated
+Admin UI.

package/docs/reference/typescript-api/_index.md

@@ -0,0 +1,13 @@
+---
+title: "TypeScript API"
+weight: 9
+showtoc: false
+---
+
+# Vendure TypeScript API Docs
+
+The Vendure TypeScript API is used when configuring the server (via the [`VendureConfig`](/reference/typescript-api/configuration/vendure-config/#vendureconfig) object) and when writing plugins that extend the functionality of Vendure core.
+
+:::note
+All documentation in this section is auto-generated from the TypeScript source of the Vendure server.
+:::

package/docs/reference/typescript-api/assets/asset-naming-strategy.md

@@ -0,0 +1,56 @@
+---
+title: "AssetNamingStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AssetNamingStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/asset-naming-strategy/asset-naming-strategy.ts" sourceLine="18" packageName="@vendure/core" />
+
+The AssetNamingStrategy determines how file names are generated based on the uploaded source file name,
+as well as how to handle naming conflicts.
+
+:::info
+
+This is configured via the `assetOptions.assetNamingStrategy` property of
+your VendureConfig.
+
+:::
+
+```ts title="Signature"
+interface AssetNamingStrategy extends InjectableStrategy {
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
+    generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string): string;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### generateSourceFileName
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, 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
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sourceFileName: string, conflictFileName?: string) => string`}   />
+
+Given the source file name generated in the `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.
+
+
+</div>

package/docs/reference/typescript-api/assets/asset-options.md

@@ -0,0 +1,58 @@
+---
+title: "AssetOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AssetOptions
+
+<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="675" packageName="@vendure/core" />
+
+The AssetOptions define how assets (images and other files) are named and stored, and how preview images are generated.
+
+**Note**: If you are using the `AssetServerPlugin`, it is not necessary to configure these options.
+
+```ts title="Signature"
+interface AssetOptions {
+    assetNamingStrategy?: AssetNamingStrategy;
+    assetStorageStrategy?: AssetStorageStrategy;
+    assetPreviewStrategy?: AssetPreviewStrategy;
+    permittedFileTypes?: string[];
+    uploadMaxFileSize?: number;
+}
+```
+
+<div className="members-wrapper">
+
+### assetNamingStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a>`} default={`<a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a>`}   />
+
+Defines how asset files and preview images are named before being saved.
+### assetStorageStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>`} default={`NoAssetStorageStrategy`}   />
+
+Defines the strategy used for storing uploaded binary files.
+### assetPreviewStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`} default={`NoAssetPreviewStrategy`}   />
+
+Defines the strategy used for creating preview images of uploaded assets.
+### permittedFileTypes
+
+<MemberInfo kind="property" type={`string[]`} default={`image, audio, video MIME types plus PDFs`}   />
+
+An array of the permitted file types that may be uploaded as Assets. Each entry
+should be in the form of a valid
+[unique file type specifier](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Unique_file_type_specifiers)
+i.e. either a file extension (".pdf") or a mime type ("image/*", "audio/mpeg" etc.).
+### uploadMaxFileSize
+
+<MemberInfo kind="property" type={`number`} default={`20971520`}   />
+
+The max file size in bytes for uploaded assets.
+
+
+</div>

package/docs/reference/typescript-api/assets/asset-preview-strategy.md

@@ -0,0 +1,45 @@
+---
+title: "AssetPreviewStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AssetPreviewStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/asset-preview-strategy/asset-preview-strategy.ts" sourceLine="25" packageName="@vendure/core" />
+
+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
+
+:::info
+
+This is configured via the `assetOptions.assetPreviewStrategy` property of
+your VendureConfig.
+
+:::
+
+```ts title="Signature"
+interface AssetPreviewStrategy extends InjectableStrategy {
+    generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### generatePreviewImage
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise&#60;Buffer&#62;`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/assets/asset-storage-strategy.md

@@ -0,0 +1,84 @@
+---
+title: "AssetStorageStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AssetStorageStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/asset-storage-strategy/asset-storage-strategy.ts" sourceLine="32" packageName="@vendure/core" />
+
+The AssetPersistenceStrategy determines how Asset files are physically stored
+and retrieved.
+
+:::info
+
+This is configured via the `assetOptions.assetStorageStrategy` property of
+your VendureConfig.
+
+:::
+
+```ts title="Signature"
+interface AssetStorageStrategy extends InjectableStrategy {
+    writeFileFromBuffer(fileName: string, data: Buffer): Promise<string>;
+    writeFileFromStream(fileName: string, data: Stream): Promise<string>;
+    readFileToBuffer(identifier: string): Promise<Buffer>;
+    readFileToStream(identifier: string): Promise<Stream>;
+    deleteFile(identifier: string): Promise<void>;
+    fileExists(fileName: string): Promise<boolean>;
+    toAbsoluteUrl?(request: Request, identifier: string): string;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### writeFileFromBuffer
+
+<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise&#60;string&#62;`}   />
+
+Writes a buffer to the store and returns a unique identifier for that
+file such as a file path or a URL.
+### writeFileFromStream
+
+<MemberInfo kind="method" type={`(fileName: string, data: Stream) => Promise&#60;string&#62;`}   />
+
+Writes a readable stream to the store and returns a unique identifier for that
+file such as a file path or a URL.
+### readFileToBuffer
+
+<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Buffer&#62;`}   />
+
+Reads a file based on an identifier which was generated by the writeFile
+method, and returns the as a Buffer.
+### readFileToStream
+
+<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;Stream&#62;`}   />
+
+Reads a file based on an identifier which was generated by the writeFile
+method, and returns the file as a Stream.
+### deleteFile
+
+<MemberInfo kind="method" type={`(identifier: string) => Promise&#60;void&#62;`}   />
+
+Deletes a file from the storage.
+### fileExists
+
+<MemberInfo kind="method" type={`(fileName: string) => Promise&#60;boolean&#62;`}   />
+
+Check whether a file with the given name already exists. Used to avoid
+naming conflicts before saving the file.
+### toAbsoluteUrl
+
+<MemberInfo kind="method" type={`(request: Request, identifier: string) => string`}   />
+
+Convert an identifier as generated by the writeFile... methods into an absolute
+url (if it is not already in that form). If no conversion step is needed
+(i.e. the identifier is already an absolute url) then this method
+should not be implemented.
+
+
+</div>

package/docs/reference/typescript-api/assets/default-asset-naming-strategy.md

@@ -0,0 +1,39 @@
+---
+title: "DefaultAssetNamingStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## DefaultAssetNamingStrategy
+
+<GenerationInfo sourceFile="packages/core/src/config/asset-naming-strategy/default-asset-naming-strategy.ts" sourceLine="15" packageName="@vendure/core" />
+
+The default strategy normalizes the file names to remove unwanted characters and
+in the case of conflicts, increments a counter suffix.
+
+```ts title="Signature"
+class DefaultAssetNamingStrategy implements AssetNamingStrategy {
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
+    generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string) => string;
+}
+```
+* Implements: <code><a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a></code>
+
+
+
+<div className="members-wrapper">
+
+### generateSourceFileName
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, originalFileName: string, conflictFileName?: string) => string`}   />
+
+
+### generatePreviewFileName
+
+<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sourceFileName: string, conflictFileName?: string) => string`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/assets/index.md

@@ -0,0 +1,5 @@
+---
+title: "Assets"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->