@vendure/docs 0.0.0-202601161541

package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.md

@@ -0,0 +1,139 @@
+---
+title: "AdminUiConfig"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AdminUiConfig
+
+<GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="221" packageName="@vendure/common" />
+
+This interface describes JSON config file (vendure-ui-config.json) used by the Admin UI.
+The values are loaded at run-time by the Admin UI app, and allow core configuration to be
+managed without the need to re-build the application.
+
+```ts title="Signature"
+interface AdminUiConfig {
+    apiHost: string | 'auto';
+    apiPort: number | 'auto';
+    adminApiPath: string;
+    tokenMethod: 'cookie' | 'bearer';
+    authTokenHeaderKey: string;
+    channelTokenKey: string;
+    defaultLanguage: LanguageCode;
+    defaultLocale?: string;
+    availableLanguages: LanguageCode[];
+    availableLocales: string[];
+    loginUrl?: string;
+    brand?: string;
+    hideVendureBranding?: boolean;
+    hideVersion?: boolean;
+    loginImageUrl?: string;
+    cancellationReasons?: string[];
+}
+```
+
+<div className="members-wrapper">
+
+### apiHost
+
+<MemberInfo kind="property" type={`string | 'auto'`} default={`'auto'`}   />
+
+The hostname of the Vendure server which the admin UI will be making API calls
+to. If set to "auto", the Admin UI app will determine the hostname from the
+current location (i.e. `window.location.hostname`).
+### apiPort
+
+<MemberInfo kind="property" type={`number | 'auto'`} default={`'auto'`}   />
+
+The port of the Vendure server which the admin UI will be making API calls
+to. If set to "auto", the Admin UI app will determine the port from the
+current location (i.e. `window.location.port`).
+### adminApiPath
+
+<MemberInfo kind="property" type={`string`} default={`'admin-api'`}   />
+
+The path to the GraphQL Admin API.
+### tokenMethod
+
+<MemberInfo kind="property" type={`'cookie' | 'bearer'`} default={`'cookie'`}   />
+
+Whether to use cookies or bearer tokens to track sessions.
+Should match the setting of in the server's `tokenMethod` config
+option.
+### authTokenHeaderKey
+
+<MemberInfo kind="property" type={`string`} default={`'vendure-auth-token'`}   />
+
+The header used when using the 'bearer' auth method. Should match the
+setting of the server's `authOptions.authTokenHeaderKey` config option.
+### channelTokenKey
+
+<MemberInfo kind="property" type={`string`} default={`'vendure-token'`}   />
+
+The name of the header which contains the channel token. Should match the
+setting of the server's `apiOptions.channelTokenKey` config option.
+### defaultLanguage
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`} default={`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>.en`}   />
+
+The default language for the Admin UI. Must be one of the
+items specified in the `availableLanguages` property.
+### defaultLocale
+
+<MemberInfo kind="property" type={`string`}  since="2.2.0"  />
+
+The default locale for the Admin UI. The locale affects the formatting of
+currencies & dates. Must be one of the items specified
+in the `availableLocales` property.
+
+If not set, the browser default locale will be used.
+### availableLanguages
+
+<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]`}   />
+
+An array of languages for which translations exist for the Admin UI.
+### availableLocales
+
+<MemberInfo kind="property" type={`string[]`}  since="2.2.0"  />
+
+An array of locales to be used on Admin UI.
+### loginUrl
+
+<MemberInfo kind="property" type={`string`}   />
+
+If you are using an external <a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a> for the Admin API, you can configure
+a custom URL for the login page with this option. On logging out or redirecting an unauthenticated
+user, the Admin UI app will redirect the user to this URL rather than the default username/password
+screen.
+### brand
+
+<MemberInfo kind="property" type={`string`}   />
+
+The custom brand name.
+### hideVendureBranding
+
+<MemberInfo kind="property" type={`boolean`} default={`false`}   />
+
+Option to hide vendure branding.
+### hideVersion
+
+<MemberInfo kind="property" type={`boolean`} default={`false`}   />
+
+Option to hide version.
+### loginImageUrl
+
+<MemberInfo kind="property" type={`string`}  since="1.9.0"  />
+
+A url of a custom image to be used on the login screen, to override the images provided by Vendure's login image server.
+### cancellationReasons
+
+<MemberInfo kind="property" type={`string[]`} default={`['order.cancel-reason-customer-request', 'order.cancel-reason-not-available']`}  since="1.5.0"  />
+
+Allows you to provide default reasons for a refund or cancellation. This will be used in the
+refund/cancel dialog. The values can be literal strings (e.g. "Not in stock") or translation
+tokens (see [Adding Admin UI Translations](/guides/extending-the-admin-ui/adding-ui-translations/)).
+
+
+</div>

package/docs/reference/typescript-api/common/admin-ui/index.md

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

package/docs/reference/typescript-api/common/async-queue.md

@@ -0,0 +1,38 @@
+---
+title: "AsyncQueue"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## AsyncQueue
+
+<GenerationInfo sourceFile="packages/core/src/common/async-queue.ts" sourceLine="13" packageName="@vendure/core" />
+
+A queue class for limiting concurrent async tasks. This can be used e.g. to prevent
+race conditions when working on a shared resource such as writing to a database.
+
+```ts title="Signature"
+class AsyncQueue {
+    constructor(label: string = 'default', concurrency: number = 1)
+    push(task: Task<T>) => Promise<T>;
+}
+```
+
+<div className="members-wrapper">
+
+### constructor
+
+<MemberInfo kind="method" type={`(label: string = 'default', concurrency: number = 1) => AsyncQueue`}   />
+
+
+### push
+
+<MemberInfo kind="method" type={`(task: Task&#60;T&#62;) => Promise&#60;T&#62;`}   />
+
+Pushes a new task onto the queue, upon which the task will either execute immediately or
+(if the number of running tasks is equal to the concurrency limit) enqueue the task to
+be executed at the soonest opportunity.
+
+
+</div>

package/docs/reference/typescript-api/common/bootstrap.md

@@ -0,0 +1,129 @@
+---
+title: "Bootstrap"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## bootstrap
+
+<GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="160" packageName="@vendure/core" />
+
+Bootstraps the Vendure server. This is the entry point to the application.
+
+*Example*
+
+```ts
+import { bootstrap } from '@vendure/core';
+import { config } from './vendure-config';
+
+bootstrap(config).catch(err => {
+  console.log(err);
+  process.exit(1);
+});
+```
+
+### Passing additional options
+
+Since v2.2.0, you can pass additional options to the NestJs application via the `options` parameter.
+For example, to integrate with the [Nest Devtools](https://docs.nestjs.com/devtools/overview), you need to
+pass the `snapshot` option:
+
+```ts
+import { bootstrap } from '@vendure/core';
+import { config } from './vendure-config';
+
+bootstrap(config, {
+  // highlight-start
+  nestApplicationOptions: {
+    snapshot: true,
+  }
+  // highlight-end
+}).catch(err => {
+  console.log(err);
+  process.exit(1);
+});
+```
+
+### Ignoring compatibility errors for plugins
+
+Since v3.1.0, you can ignore compatibility errors for specific plugins by passing the `ignoreCompatibilityErrorsForPlugins` option.
+
+This should be used with caution, only if you are sure that the plugin will still work as expected with the current version of Vendure.
+
+*Example*
+
+```ts
+import { bootstrap } from '@vendure/core';
+import { config } from './vendure-config';
+import { MyPlugin } from './plugins/my-plugin';
+
+bootstrap(config, {
+  // Let's say that `MyPlugin` is not yet compatible with the current version of Vendure
+  // but we know that it will still work as expected, and we are not able to publish
+  // a new version of the plugin right now.
+  ignoreCompatibilityErrorsForPlugins: [MyPlugin],
+});
+```
+
+```ts title="Signature"
+function bootstrap(userConfig: Partial<VendureConfig>, options?: BootstrapOptions): Promise<INestApplication>
+```
+Parameters
+
+### userConfig
+
+<MemberInfo kind="parameter" type={`Partial&#60;<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>&#62;`} />
+
+### options
+
+<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/common/bootstrap#bootstrapoptions'>BootstrapOptions</a>`} />
+
+
+
+## BootstrapOptions
+
+<GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="42" packageName="@vendure/core" since="2.2.0" />
+
+Additional options that can be used to configure the bootstrap process of the
+Vendure server.
+
+```ts title="Signature"
+interface BootstrapOptions {
+    nestApplicationOptions?: NestApplicationOptions;
+    ignoreCompatibilityErrorsForPlugins?: Array<DynamicModule | Type<any>>;
+}
+```
+
+<div className="members-wrapper">
+
+### nestApplicationOptions
+
+<MemberInfo kind="property" type={`NestApplicationOptions`}   />
+
+These options get passed directly to the `NestFactory.create()` method.
+### ignoreCompatibilityErrorsForPlugins
+
+<MemberInfo kind="property" type={`Array&#60;DynamicModule | Type&#60;any&#62;&#62;`} default={`[]`}  since="3.1.0"  />
+
+By default, if a plugin specifies a compatibility range which does not include the current
+Vendure version, the bootstrap process will fail. This option allows you to ignore compatibility
+errors for specific plugins.
+
+This setting should be used with caution, only if you are sure that the plugin will still
+work as expected with the current version of Vendure.
+
+*Example*
+
+```ts
+import { bootstrap } from '@vendure/core';
+import { config } from './vendure-config';
+import { MyPlugin } from './plugins/my-plugin';
+
+bootstrap(config, {
+ ignoreCompatibilityErrorsForPlugins: [MyPlugin],
+});
+```
+
+
+</div>

package/docs/reference/typescript-api/common/currency-code.md

@@ -0,0 +1,174 @@
+---
+title: "CurrencyCode"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## CurrencyCode
+
+<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="1004" packageName="@vendure/common" />
+
+ISO 4217 currency code
+
+```ts title="Signature"
+enum CurrencyCode {
+    AED = 'AED'
+    AFN = 'AFN'
+    ALL = 'ALL'
+    AMD = 'AMD'
+    ANG = 'ANG'
+    AOA = 'AOA'
+    ARS = 'ARS'
+    AUD = 'AUD'
+    AWG = 'AWG'
+    AZN = 'AZN'
+    BAM = 'BAM'
+    BBD = 'BBD'
+    BDT = 'BDT'
+    BGN = 'BGN'
+    BHD = 'BHD'
+    BIF = 'BIF'
+    BMD = 'BMD'
+    BND = 'BND'
+    BOB = 'BOB'
+    BRL = 'BRL'
+    BSD = 'BSD'
+    BTN = 'BTN'
+    BWP = 'BWP'
+    BYN = 'BYN'
+    BZD = 'BZD'
+    CAD = 'CAD'
+    CDF = 'CDF'
+    CHF = 'CHF'
+    CLP = 'CLP'
+    CNY = 'CNY'
+    COP = 'COP'
+    CRC = 'CRC'
+    CUC = 'CUC'
+    CUP = 'CUP'
+    CVE = 'CVE'
+    CZK = 'CZK'
+    DJF = 'DJF'
+    DKK = 'DKK'
+    DOP = 'DOP'
+    DZD = 'DZD'
+    EGP = 'EGP'
+    ERN = 'ERN'
+    ETB = 'ETB'
+    EUR = 'EUR'
+    FJD = 'FJD'
+    FKP = 'FKP'
+    GBP = 'GBP'
+    GEL = 'GEL'
+    GHS = 'GHS'
+    GIP = 'GIP'
+    GMD = 'GMD'
+    GNF = 'GNF'
+    GTQ = 'GTQ'
+    GYD = 'GYD'
+    HKD = 'HKD'
+    HNL = 'HNL'
+    HRK = 'HRK'
+    HTG = 'HTG'
+    HUF = 'HUF'
+    IDR = 'IDR'
+    ILS = 'ILS'
+    INR = 'INR'
+    IQD = 'IQD'
+    IRR = 'IRR'
+    ISK = 'ISK'
+    JMD = 'JMD'
+    JOD = 'JOD'
+    JPY = 'JPY'
+    KES = 'KES'
+    KGS = 'KGS'
+    KHR = 'KHR'
+    KMF = 'KMF'
+    KPW = 'KPW'
+    KRW = 'KRW'
+    KWD = 'KWD'
+    KYD = 'KYD'
+    KZT = 'KZT'
+    LAK = 'LAK'
+    LBP = 'LBP'
+    LKR = 'LKR'
+    LRD = 'LRD'
+    LSL = 'LSL'
+    LYD = 'LYD'
+    MAD = 'MAD'
+    MDL = 'MDL'
+    MGA = 'MGA'
+    MKD = 'MKD'
+    MMK = 'MMK'
+    MNT = 'MNT'
+    MOP = 'MOP'
+    MRU = 'MRU'
+    MUR = 'MUR'
+    MVR = 'MVR'
+    MWK = 'MWK'
+    MXN = 'MXN'
+    MYR = 'MYR'
+    MZN = 'MZN'
+    NAD = 'NAD'
+    NGN = 'NGN'
+    NIO = 'NIO'
+    NOK = 'NOK'
+    NPR = 'NPR'
+    NZD = 'NZD'
+    OMR = 'OMR'
+    PAB = 'PAB'
+    PEN = 'PEN'
+    PGK = 'PGK'
+    PHP = 'PHP'
+    PKR = 'PKR'
+    PLN = 'PLN'
+    PYG = 'PYG'
+    QAR = 'QAR'
+    RON = 'RON'
+    RSD = 'RSD'
+    RUB = 'RUB'
+    RWF = 'RWF'
+    SAR = 'SAR'
+    SBD = 'SBD'
+    SCR = 'SCR'
+    SDG = 'SDG'
+    SEK = 'SEK'
+    SGD = 'SGD'
+    SHP = 'SHP'
+    SLL = 'SLL'
+    SOS = 'SOS'
+    SRD = 'SRD'
+    SSP = 'SSP'
+    STN = 'STN'
+    SVC = 'SVC'
+    SYP = 'SYP'
+    SZL = 'SZL'
+    THB = 'THB'
+    TJS = 'TJS'
+    TMT = 'TMT'
+    TND = 'TND'
+    TOP = 'TOP'
+    TRY = 'TRY'
+    TTD = 'TTD'
+    TWD = 'TWD'
+    TZS = 'TZS'
+    UAH = 'UAH'
+    UGX = 'UGX'
+    USD = 'USD'
+    UYU = 'UYU'
+    UZS = 'UZS'
+    VES = 'VES'
+    VND = 'VND'
+    VUV = 'VUV'
+    WST = 'WST'
+    XAF = 'XAF'
+    XCD = 'XCD'
+    XOF = 'XOF'
+    XPF = 'XPF'
+    YER = 'YER'
+    ZAR = 'ZAR'
+    ZMW = 'ZMW'
+    ZWL = 'ZWL'
+}
+```

package/docs/reference/typescript-api/common/entity-relation-paths.md

@@ -0,0 +1,34 @@
+---
+title: "EntityRelationPaths"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## EntityRelationPaths
+
+<GenerationInfo sourceFile="packages/core/src/common/types/entity-relation-paths.ts" sourceLine="25" packageName="@vendure/core" />
+
+This type allows type-safe access to entity relations using strings with dot notation.
+It works to 2 levels deep.
+
+*Example*
+
+```ts
+type T1 = EntityRelationPaths<Product>;
+```
+In the above example, the type `T1` will be a string union of all relations of the
+`Product` entity:
+
+ * `'featuredAsset'`
+ * `'variants'`
+ * `'variants.options'`
+ * `'variants.featuredAsset'`
+ * etc.
+
+```ts title="Signature"
+type EntityRelationPaths<T extends VendureEntity> = | `customFields.${string}`
+    | PathsToStringProps1<T>
+    | Join<PathsToStringProps2<T>, '.'>
+    | TripleDotPath
+```

package/docs/reference/typescript-api/common/i18n-service.md

@@ -0,0 +1,74 @@
+---
+title: "I18nService"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## I18nService
+
+<GenerationInfo sourceFile="packages/core/src/i18n/i18n.service.ts" sourceLine="44" packageName="@vendure/core" />
+
+
+
+```ts title="Signature"
+class I18nService implements OnModuleInit {
+    addTranslationFile(langKey: string, filePath: string) => void;
+    addTranslation(langKey: string, resources: VendureTranslationResources | any) => void;
+}
+```
+* Implements: <code>OnModuleInit</code>
+
+
+
+<div className="members-wrapper">
+
+### addTranslationFile
+
+<MemberInfo kind="method" type={`(langKey: string, filePath: string) => void`}   />
+
+Add a I18n translation by json file
+### addTranslation
+
+<MemberInfo kind="method" type={`(langKey: string, resources: <a href='/reference/typescript-api/common/i18n-service#venduretranslationresources'>VendureTranslationResources</a> | any) => void`}   />
+
+Add a I18n translation (key-value) resource
+
+
+</div>
+
+
+## VendureTranslationResources
+
+<GenerationInfo sourceFile="packages/core/src/i18n/i18n.service.ts" sourceLine="24" packageName="@vendure/core" />
+
+I18n resources used for translations
+
+```ts title="Signature"
+interface VendureTranslationResources {
+    error: any;
+    errorResult: any;
+    message: any;
+}
+```
+
+<div className="members-wrapper">
+
+### error
+
+<MemberInfo kind="property" type={`any`}   />
+
+
+### errorResult
+
+<MemberInfo kind="property" type={`any`}   />
+
+
+### message
+
+<MemberInfo kind="property" type={`any`}   />
+
+
+
+
+</div>

package/docs/reference/typescript-api/common/id.md

@@ -0,0 +1,17 @@
+---
+title: "ID"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## ID
+
+<GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="79" packageName="@vendure/common" />
+
+An entity ID. Depending on the configured <a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>, it will be either
+a `string` or a `number`;
+
+```ts title="Signature"
+type ID = string | number
+```

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

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

package/docs/reference/typescript-api/common/injectable-strategy.md

@@ -0,0 +1,48 @@
+---
+title: "InjectableStrategy"
+generated: true
+---
+<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
+
+
+## InjectableStrategy
+
+<GenerationInfo sourceFile="packages/core/src/common/types/injectable-strategy.ts" sourceLine="10" packageName="@vendure/core" />
+
+This interface defines the setup and teardown hooks available to the
+various strategies used to configure Vendure.
+
+```ts title="Signature"
+interface InjectableStrategy {
+    init?: (injector: Injector) => void | Promise<void>;
+    destroy?: () => void | Promise<void>;
+}
+```
+
+<div className="members-wrapper">
+
+### init
+
+<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) =&#62; void | Promise&#60;void&#62;`}   />
+
+Defines setup logic to be run during application bootstrap. Receives
+the <a href='/reference/typescript-api/common/injector#injector'>Injector</a> as an argument, which allows application providers
+to be used as part of the setup. This hook will be called on both the
+main server and the worker processes.
+
+*Example*
+
+```ts
+async init(injector: Injector) {
+  const myService = injector.get(MyService);
+  await myService.doSomething();
+}
+```
+### destroy
+
+<MemberInfo kind="property" type={`() =&#62; void | Promise&#60;void&#62;`}   />
+
+Defines teardown logic to be run before application shutdown.
+
+
+</div>