@vendure/docs 0.0.0-202601161541

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.md

@@ -0,0 +1,118 @@
+---
+title: "UiExtensionCompilerOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## UiExtensionCompilerOptions
+
+<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="364" packageName="@vendure/ui-devkit" />
+
+Options to configure how the Admin UI should be compiled.
+
+```ts title="Signature"
+interface UiExtensionCompilerOptions {
+    outputPath: string;
+    extensions: Extension[];
+    ngCompilerPath?: string | undefined;
+    devMode?: boolean;
+    baseHref?: string;
+    watchPort?: number;
+    command?: UiExtensionBuildCommand;
+    additionalProcessArguments?: UiExtensionCompilerProcessArgument[];
+}
+```
+
+<div className="members-wrapper">
+
+### outputPath
+
+<MemberInfo kind="property" type={`string`}   />
+
+The directory into which the sources for the extended Admin UI will be copied.
+### extensions
+
+<MemberInfo kind="property" type={`Extension[]`}   />
+
+An array of objects which configure Angular modules and/or
+translations with which to extend the Admin UI.
+### ngCompilerPath
+
+<MemberInfo kind="property" type={`string | undefined`}  since="2.1.0"  />
+
+Allows you to manually specify the path to the Angular CLI compiler script. This can be useful in scenarios
+where for some reason the built-in start/build scripts are unable to locate the `ng` command.
+
+This option should not usually be required.
+
+*Example*
+
+```ts
+compileUiExtensions({
+    ngCompilerPath: path.join(__dirname, '../../node_modules/@angular/cli/bin/ng.js'),
+    outputPath: path.join(__dirname, '../admin-ui'),
+    extensions: [
+      // ...
+    ],
+})
+```
+### devMode
+
+<MemberInfo kind="property" type={`boolean`} default={`false`}   />
+
+Set to `true` in order to compile the Admin UI in development mode (using the Angular CLI
+[ng serve](https://angular.io/cli/serve) command). When in dev mode, any changes to
+UI extension files will be watched and trigger a rebuild of the Admin UI with live
+reloading.
+### baseHref
+
+<MemberInfo kind="property" type={`string`} default={`'/admin/'`}   />
+
+Allows the baseHref of the compiled Admin UI app to be set. This determines the prefix
+of the app, for example with the default value of `'/admin/'`, the Admin UI app
+will be configured to be served from `http://<host>/admin/`.
+
+Note: if you are using this in conjunction with the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a> then you should
+also set the `route` option to match this value.
+
+*Example*
+
+```ts
+AdminUiPlugin.init({
+  route: 'my-route',
+  port: 5001,
+  app: compileUiExtensions({
+    baseHref: '/my-route/',
+    outputPath: path.join(__dirname, './custom-admin-ui'),
+    extensions: [],
+    devMode: true,
+  }),
+}),
+```
+### watchPort
+
+<MemberInfo kind="property" type={`number`} default={`4200 | undefined`}   />
+
+In watch mode, allows the port of the dev server to be specified. Defaults to the Angular CLI default
+of `4200`.
+### command
+
+<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/ui-devkit/ui-extension-build-command#uiextensionbuildcommand'>UiExtensionBuildCommand</a>`}  since="1.5.0"  />
+
+Internally, the Angular CLI will be invoked as an npm script. By default, the compiler will use Yarn
+to run the script if it is detected, otherwise it will use npm. This setting allows you to explicitly
+set which command to use, including pnpm, rather than relying on the default behavior.
+### additionalProcessArguments
+
+<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument#uiextensioncompilerprocessargument'>UiExtensionCompilerProcessArgument</a>[]`} default={`undefined`}  since="1.5.0"  />
+
+Additional command-line arguments which will get passed to the [ng build](https://angular.io/cli/build)
+command (or [ng serve](https://angular.io/cli/serve) if `devMode = true`).
+
+*Example*
+
+['--disable-host-check'] // to disable host check
+
+
+</div>

package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.md

@@ -0,0 +1,16 @@
+---
+title: "UiExtensionCompilerProcessArgument"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## UiExtensionCompilerProcessArgument
+
+<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="348" packageName="@vendure/ui-devkit" />
+
+Argument to configure process (watch or compile)
+
+```ts title="Signature"
+type UiExtensionCompilerProcessArgument = string | [string, any]
+```

package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.md

@@ -0,0 +1,67 @@
+---
+title: "AdminUiPluginOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AdminUiPluginOptions
+
+<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="44" packageName="@vendure/admin-ui-plugin" />
+
+Configuration options for the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>.
+
+```ts title="Signature"
+interface AdminUiPluginOptions {
+    route: string;
+    port: number;
+    hostname?: string;
+    app?: AdminUiAppConfig | AdminUiAppDevModeConfig;
+    adminUiConfig?: Partial<AdminUiConfig>;
+    compatibilityMode?: boolean;
+}
+```
+
+<div className="members-wrapper">
+
+### route
+
+<MemberInfo kind="property" type={`string`}   />
+
+The route to the Admin UI.
+
+Note: If you are using the `compileUiExtensions` function to compile a custom version of the Admin UI, then
+the route should match the `baseHref` option passed to that function. The default value of `baseHref` is `/admin/`,
+so it only needs to be changed if you set this `route` option to something other than `"admin"`.
+### port
+
+<MemberInfo kind="property" type={`number`}   />
+
+The port on which the server will listen. This port will be proxied by the AdminUiPlugin to the same port that
+the Vendure server is running on.
+### hostname
+
+<MemberInfo kind="property" type={`string`} default={`'localhost'`}   />
+
+The hostname of the server serving the static admin ui files.
+### app
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/admin-ui/admin-ui-app-config#adminuiappconfig'>AdminUiAppConfig</a> | <a href='/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config#adminuiappdevmodeconfig'>AdminUiAppDevModeConfig</a>`}   />
+
+By default, the AdminUiPlugin comes bundles with a pre-built version of the
+Admin UI. This option can be used to override this default build with a different
+version, e.g. one pre-compiled with one or more ui extensions.
+### adminUiConfig
+
+<MemberInfo kind="property" type={`Partial&#60;<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>&#62;`}   />
+
+Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
+for specifying the Vendure GraphQL API host, available UI languages, etc.
+### compatibilityMode
+
+<MemberInfo kind="property" type={`boolean`}  since="3.4.0"  />
+
+
+
+
+</div>

package/docs/reference/core-plugins/admin-ui-plugin/index.md

@@ -0,0 +1,94 @@
+---
+title: "AdminUiPlugin"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AdminUiPlugin
+
+<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="147" packageName="@vendure/admin-ui-plugin" />
+
+:::warning Deprecated
+From Vendure v3.5.0, the Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/guides/extending-the-dashboard/getting-started/).
+The Angular Admin UI will not be maintained after **July 2026**. Until then, we will continue patching critical bugs and security issues.
+Community contributions will always be merged and released.
+:::
+
+This plugin starts a static server for the Admin UI app, and proxies it via the `/admin/` path of the main Vendure server.
+
+The Admin UI allows you to administer all aspects of your store, from inventory management to order tracking. It is the tool used by
+store administrators on a day-to-day basis for the management of the store.
+
+## Installation
+
+`yarn add @vendure/admin-ui-plugin`
+
+or
+
+`npm install @vendure/admin-ui-plugin`
+
+*Example*
+
+```ts
+import { AdminUiPlugin } from '@vendure/admin-ui-plugin';
+
+const config: VendureConfig = {
+  // Add an instance of the plugin to the plugins array
+  plugins: [
+    AdminUiPlugin.init({ port: 3002 }),
+  ],
+};
+```
+
+## Metrics
+
+This plugin also defines a `metricSummary` query which is used by the Admin UI to display the order metrics on the dashboard.
+
+If you are building a stand-alone version of the Admin UI app, and therefore don't need this plugin to server the Admin UI,
+you can still use the `metricSummary` query by adding the `AdminUiPlugin` to the `plugins` array, but without calling the `init()` method:
+
+*Example*
+
+```ts
+import { AdminUiPlugin } from '@vendure/admin-ui-plugin';
+
+const config: VendureConfig = {
+  plugins: [
+    AdminUiPlugin, // <-- no call to .init()
+  ],
+  // ...
+};
+```
+
+```ts title="Signature"
+class AdminUiPlugin implements NestModule {
+    constructor(configService: ConfigService, processContext: ProcessContext)
+    init(options: AdminUiPluginOptions) => Type<AdminUiPlugin>;
+    configure(consumer: MiddlewareConsumer) => ;
+}
+```
+* Implements: <code>NestModule</code>
+
+
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(configService: ConfigService, processContext: <a href='/reference/typescript-api/common/process-context#processcontext'>ProcessContext</a>) => AdminUiPlugin`}   />
+
+
+### init
+
+<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type&#60;<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>&#62;`}   />
+
+Set the plugin options
+### configure
+
+<MemberInfo kind="method" type={`(consumer: MiddlewareConsumer) => `}   />
+
+
+
+
+</div>

package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.md

@@ -0,0 +1,106 @@
+---
+title: "AssetServerOptions"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AssetServerOptions
+
+<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="74" packageName="@vendure/asset-server-plugin" />
+
+The configuration options for the AssetServerPlugin.
+
+```ts title="Signature"
+interface AssetServerOptions {
+    route: string;
+    assetUploadDir: string;
+    assetUrlPrefix?: string | ((ctx: RequestContext, identifier: string) => string);
+    previewMaxWidth?: number;
+    previewMaxHeight?: number;
+    presets?: ImageTransformPreset[];
+    imageTransformStrategy?: ImageTransformStrategy | ImageTransformStrategy[];
+    namingStrategy?: AssetNamingStrategy;
+    previewStrategy?: AssetPreviewStrategy;
+    storageStrategyFactory?: (
+        options: AssetServerOptions,
+    ) => AssetStorageStrategy | Promise<AssetStorageStrategy>;
+    cacheHeader?: CacheConfig | string;
+}
+```
+
+<div className="members-wrapper">
+
+### route
+
+<MemberInfo kind="property" type={`string`}   />
+
+The route to the asset server.
+### assetUploadDir
+
+<MemberInfo kind="property" type={`string`}   />
+
+The local directory to which assets will be uploaded when using the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>.
+### assetUrlPrefix
+
+<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) =&#62; string)`}   />
+
+The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
+function can also be provided to handle more complex cases, such as serving multiple domains
+from a single server. In this case, the function should return a string url prefix.
+
+If not provided, the plugin will attempt to guess based off the incoming
+request and the configured route. However, in all but the simplest cases,
+this guess may not yield correct results.
+### previewMaxWidth
+
+<MemberInfo kind="property" type={`number`} default={`1600`}   />
+
+The max width in pixels of a generated preview image.
+### previewMaxHeight
+
+<MemberInfo kind="property" type={`number`} default={`1600`}   />
+
+The max height in pixels of a generated preview image.
+### presets
+
+<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a>[]`}   />
+
+An array of additional <a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a> objects.
+### imageTransformStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a>[]`} default={`[]`}  since="3.1.0"  />
+
+The strategy or strategies to use to determine the parameters for transforming an image.
+This can be used to implement custom image transformation logic, for example to
+limit transform parameters to a known set of presets.
+
+If multiple strategies are provided, they will be executed in the order in which they are defined.
+If a strategy throws an error, the image transformation will be aborted and the error
+will be logged, with an HTTP 400 response sent to the client.
+### namingStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a>`} default={`<a href='/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy#hashedassetnamingstrategy'>HashedAssetNamingStrategy</a>`}   />
+
+Defines how asset files and preview images are named before being saved.
+### previewStrategy
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`}  since="1.7.0"  />
+
+Defines how previews are generated for a given Asset binary. By default, this uses
+the <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy'>SharpAssetPreviewStrategy</a>
+### storageStrategyFactory
+
+<MemberInfo kind="property" type={`(         options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,     ) =&#62; <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise&#60;<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>&#62;`} default={`() =&#62; <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`}   />
+
+A function which can be used to configure an <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>. This is useful e.g. if you wish to store your assets
+using a cloud storage provider. By default, the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a> is used.
+### cacheHeader
+
+<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/cache-config#cacheconfig'>CacheConfig</a> | string`} default={`'public, max-age=15552000'`}  since="1.9.3"  />
+
+Configures the `Cache-Control` directive for response to control caching in browsers and shared caches (e.g. Proxies, CDNs).
+Defaults to publicly cached for 6 months.
+
+
+</div>

package/docs/reference/core-plugins/asset-server-plugin/cache-config.md

@@ -0,0 +1,36 @@
+---
+title: "CacheConfig"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## CacheConfig
+
+<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="54" packageName="@vendure/asset-server-plugin" />
+
+A configuration option for the Cache-Control header in the AssetServerPlugin asset response.
+
+```ts title="Signature"
+type CacheConfig = {
+    maxAge: number;
+    restriction?: 'public' | 'private';
+}
+```
+
+<div className="members-wrapper">
+
+### maxAge
+
+<MemberInfo kind="property" type={`number`}   />
+
+The max-age=N response directive indicates that the response remains fresh until N seconds after the response is generated.
+### restriction
+
+<MemberInfo kind="property" type={`'public' | 'private'`}   />
+
+The `private` response directive indicates that the response can be stored only in a private cache (e.g. local caches in browsers).
+The `public` response directive indicates that the response can be stored in a shared cache.
+
+
+</div>

package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.md

@@ -0,0 +1,47 @@
+---
+title: "HashedAssetNamingStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## HashedAssetNamingStrategy
+
+<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/hashed-asset-naming-strategy.ts" sourceLine="20" packageName="@vendure/asset-server-plugin" />
+
+An extension of the <a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a> which prefixes file names with
+the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
+the md5 hash of the original file name.
+
+This is an implementation of the technique knows as "hashed directory" file storage,
+and the purpose is to reduce the number of files in a single directory, since a very large
+number of files can lead to performance issues when reading and writing to that directory.
+
+With this strategy, even with 200,000 total assets stored, each directory would
+only contain less than 800 files.
+
+```ts title="Signature"
+class HashedAssetNamingStrategy extends DefaultAssetNamingStrategy {
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
+    generatePreviewFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
+}
+```
+* Extends: <code><a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</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>, originalFileName: string, conflictFileName?: string) => string`}   />
+
+
+
+
+</div>

package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.md

@@ -0,0 +1,21 @@
+---
+title: "ImageTransformMode"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## ImageTransformMode
+
+<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="23" packageName="@vendure/asset-server-plugin" />
+
+Specifies the way in which an asset preview image will be resized to fit in the
+proscribed dimensions:
+
+* crop: crops the image to cover both provided dimensions
+* resize: Preserving aspect ratio, resizes the image to be as large as possible
+while ensuring its dimensions are less than or equal to both those specified.
+
+```ts title="Signature"
+type ImageTransformMode = 'crop' | 'resize'
+```

package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.md

@@ -0,0 +1,57 @@
+---
+title: "ImageTransformPreset"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## ImageTransformPreset
+
+<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="41" packageName="@vendure/asset-server-plugin" />
+
+A configuration option for an image size preset for the AssetServerPlugin.
+
+Presets allow a shorthand way to generate a thumbnail preview of an asset. For example,
+the built-in "tiny" preset generates a 50px x 50px cropped preview, which can be accessed
+by appending the string `preset=tiny` to the asset url:
+
+`http://localhost:3000/assets/some-asset.jpg?preset=tiny`
+
+is equivalent to:
+
+`http://localhost:3000/assets/some-asset.jpg?w=50&h=50&mode=crop`
+
+```ts title="Signature"
+interface ImageTransformPreset {
+    name: string;
+    width: number;
+    height: number;
+    mode: ImageTransformMode;
+}
+```
+
+<div className="members-wrapper">
+
+### name
+
+<MemberInfo kind="property" type={`string`}   />
+
+
+### width
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### height
+
+<MemberInfo kind="property" type={`number`}   />
+
+
+### mode
+
+<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-mode#imagetransformmode'>ImageTransformMode</a>`}   />
+
+
+
+
+</div>